*: cursor based list api. #436
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds code required to implement cursor based list apis. It also changes the first list api (GetOrgMembers). These api changes are breaking changes, so a related change in the agola web repository is required and should be merged together. Some implementation notes: * Only the gateway list APIs use opaque cursors. * The cursor is provided as a custom X-Agola-Cursor response header. * The provided cursor will be for the next batch of result using the same query options of the first call (limit excluded). * When a cursor is provided all the other query options cannot be provided with the exception of limit. * A default limit is forced if not provided. * The underlying services (configstore, runservice) will continue using explicit list options (start, sort etc...) based api instead of an opaque cursor. * The underlying services (configstore, runservice) will continue to not force any default limit. If a limit isn't provided then all the output results will be provided. This is required since their api must sometimes provide an atomicity in the results (i.e. GetSecrets tree). So doing multiple calls will break this atomicity since they'll execute different db transactions.
Wrap http.Response in custom client Response type so, in future, additional fields (based on http response headers or other http response data) could be added to the response.
Add ListOptions to request list limit and sort direction Add HasMore to Response fetched from an http header.
Add ListOptions to request list limit, sort direction and provide a cursor to start the fetch from. Add Cursor to Response fetched from an http header.
sgotti
force-pushed
the
initial_cursor_based_lists_get_org_members
branch
from
b2dacaf
to
611143c
Compare
sgotti
force-pushed
the
initial_cursor_based_lists_get_org_members
branch
from
611143c
to
e77148b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds code required to implement cursor based list apis.
It also changes the first list api (GetOrgMembers).
These api changes are breaking changes, so a related change in the agola
web repository is required and should be merged together.
Some implementation notes:
using the same query options of the first call (limit excluded).
provided with the exception of limit.
explicit list options (start, sort etc...) based api instead of an
opaque cursor.
force any default limit. If a limit isn't provided then all the output
results will be provided. This is required since their api must
sometimes provide an atomicity in the results (i.e. GetSecrets tree).
So doing multiple calls will break this atomicity since they'll
execute different db transactions.