add cursor based pagination - #91
Open
yannickbetou-dku wants to merge 6 commits into
Open
Conversation
yannickbetou-dku
added
bug
…ginate-using-cusor
…--api-connect-cannot-paginate-using-cusor' into bug/dss14-sc-337638--api-connect-cannot-paginate-using-cusor
Comment on lines
31
to
61
| @@ -34,17 +40,23 @@ def configure_paging(self, config=None, skip_key=None, | |||
| if next_page_url_base: | |||
| next_page_url_base = next_page_url_base.strip('/') | |||
| self.next_page_url_base = next_page_url_base | |||
| elif self.pagination_type == "cursor": | |||
| self.cursor_next_token_path = config.get("cursor_next_token_path", cursor_next_token_path) | |||
| self.cursor_query_param = config.get("cursor_query_param", cursor_query_param) | |||
| self.cursor_initial_token = config.get("cursor_initial_token", cursor_initial_token) | |||
| elif self.pagination_type in ["offset", "page"]: | |||
| self.skip_key = config.get("skip_key", skip_key) | |||
| logger.info("configure_paging: self.pagination_type='{}', self.next_page_key='{}', self.next_page_url_base='{}', self.skip_key='{}'".format( | |||
| self.pagination_type, self.next_page_key, self.next_page_url_base, self.skip_key | |||
| logger.info("configure_paging: self.pagination_type='{}', self.next_page_key='{}', self.next_page_url_base='{}', self.skip_key='{}', self.cursor_next_token_path='{}', self.cursor_query_param='{}', self.cursor_initial_token='{}'".format( | |||
| self.pagination_type, self.next_page_key, self.next_page_url_base, self.skip_key, self.cursor_next_token_path, self.cursor_query_param, self.cursor_initial_token | |||
| )) | |||
| if self.pagination_type == "next_page": | |||
| self.update_next_page = self.update_next_page_link | |||
| elif self.pagination_type == "offset": | |||
| self.update_next_page = self.update_next_page_offset | |||
| elif self.pagination_type == "page": | |||
| self.update_next_page = self.update_next_page_per_page | |||
| elif self.pagination_type == "cursor": | |||
| self.update_next_page = self.update_next_page_cursor | |||
| else: | |||
| self.update_next_page = self.update_next_page_default | |||
Contributor
There was a problem hiding this comment.
Nit: for readability, I would split this method into smaller ones since there are only if .. elif in the implementation
Contributor
Author
There was a problem hiding this comment.
I rationalized a bit the method but I'm not sur splitting it would make it a lot clearer.
|
|
||
| if self.cursor_next_token_path and self.cursor_query_param: | ||
| self.cursor_query_param_value = extract_key_using_json_path(data, self.cursor_next_token_path) | ||
| logger.info("update_next_page_cursor:{}".format({self.cursor_query_param_value})) |
Contributor
Author
There was a problem hiding this comment.
It's consistent with the other pagination type, I would agree conceptually but it was useful when debugging the issue initially
| return ret | ||
| if self.pagination_type == "cursor": | ||
| ret = (self.cursor_query_param_value is not None) and (self.cursor_query_param_value != "") | ||
| logger.info("has_next_page:cursor_next_token_path={} cursor_query_param={} cursor_query_param_value={} -> {}".format( |
Contributor
There was a problem hiding this comment.
Same, I would put debug
Contributor
Author
There was a problem hiding this comment.
same than previous
Comment on lines
+92
to
+94
| cursor_next_token_path = endpoint.get("cursor_next_token_path") | ||
| cursor_query_param = endpoint.get("cursor_query_param") | ||
| cursor_initial_token = format_template(endpoint.get("cursor_initial_token"), **self.presets_variables) |
Contributor
There was a problem hiding this comment.
Is there a reason why only intital_token supports variables and the others don't?
Contributor
Author
There was a problem hiding this comment.
I do not see how it would be useful for the others, initial token has a good chance to be stored within contextual variables.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
sc-337638