fix: circleci plugin pagination #7770
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
dosubot
bot
added
size:S
d4x1
reviewed
Jul 23, 2024
| @@ -81,7 +82,7 @@ func CollectJobs(taskCtx plugin.SubTaskContext) errors.Error { | |||
| Query: func(reqData *api.RequestData) (url.Values, errors.Error) { | |||
| query := url.Values{} | |||
| if pageToken, ok := reqData.CustomData.(string); ok && pageToken != "" { | |||
| query.Set("page_token", reqData.CustomData.(string)) | |||
| query.Set("page-token", reqData.CustomData.(string)) | |||
There was a problem hiding this comment.
I think query.Set("page-token", pageToken) is more concise.
There was a problem hiding this comment.
Changed. Additionally as pipelines, workflows & jobs all were using the same ApiCollectorArgs functions I moved the 3 of them to shared.go
dosubot
bot
added
size:L
Nickcw6
force-pushed
the
fix/circleci-plugin-pagination
branch
from
4407157
to
eb7d274
Compare
d4x1
approved these changes
Jul 25, 2024
3 tasks
3 tasks
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.
pr-type/bug-fix,pr-type/feature-development, etc.Summary
Fixes CircleCI plugin where pagination of the API responses was not occurring, resulting in incomplete data collection.
page-tokenPageSizeApiCollectorArgto 20, the default page size. Previously this was defaulting to 0 meaning theGetNextPageCustomDataarg was being ignored due to this within theexecfunction.Does this close any open issues?
Closes #7750
Screenshots
Before fix, max 20 rows (per project) present in
_raw_circleci_api_pipelines(ie. 1 page of results):After fix, now 203 rows from across multiple pages:
Other Information