More flexible cursor pagination #926
Conversation
|
Deprecation of old method here #927 |
There was a problem hiding this comment.
made this mostly for testing the pagination, I could move the pagination testing to a seperate file
packages/core/src/utils/cursor-pagination/common-cursor-utils.ts
Outdated
Show resolved
Hide resolved
| column: "id", | ||
| order: "desc", |
There was a problem hiding this comment.
I think the pagination should be generic and support a list of columns, it seems rather easy to do. Whether you make the API be ["X", { columnName: "Y", ordering: ASCENDING/DESCENDING }], or ["X", "-Y"] I'm somewhat indifferent about
The cursor can just be base64 of e.g. a JSON-array like ["columnAValue", "columnBValue"]
packages/core/src/utils/cursor.ts
Outdated
| decodeCursor?: (cursor: Cursor) => OperandValueExpression<DB, TB, C> | ||
| buildCursor?: (record: O) => Cursor |
There was a problem hiding this comment.
These (cursor-build/decode) Should not be necessary, as far as I can tell cursor-encode/decode is only dependent on which columns you have
There was a problem hiding this comment.
Could you explain the use case of having individual sorting on each column? Are they not the same sorting order in 99% of the time?
There was a problem hiding this comment.
Hmm I guess if you have a table where you can sort on each column individually then it's useful.
There was a problem hiding this comment.
That functionality is not what I'm describing. Though it is used quite a few places in e.g. OW4's admin-panel, mostly useful when working directly towards a table.
What I'm talking about here is rather that instead of the users of this API having to specify how to encode/decode the cursor, that should be a part the implementation detail of our CursorPagination-package/module/whatever. That would make the call-locations more focused on intent, instead of technical implementation-details (I think you would call that a leaky abstraction?)
This does reduce what you can implement on top of this, but I think it is better to extend the functionality of CursorPagination rather than making call-locations more complex, and solves the general problem rather than hacking stuff together with tight coupling to e.g. our primary key-usage
There was a problem hiding this comment.
Just fixed default cursor-encode/decode for multiple columns.
There was a problem hiding this comment.
With the current api you cannot order on individual columns when there are multiple columns spesified, as this makes things quite a bit more complex. What do you think about this @junlarsen?
There was a problem hiding this comment.
Take a look at the new test packages/core/src/utils/cursor.e2e-spec.ts to see the current api
This is a suggestion for a more flexible approach to cursorbased pagination. Feedback is very welcome!
The helper function
singleColPaginatedQueryis only for when the cursor consists of one column name.See
packages/core/src/modules/committee/committee-repository.tsandpackages/core/src/modules/interest-group/interest-group-repository.tsfor example usage.If you want custom sorting you have to implement the pagination logic manually for that use case