Use requested PageSize and return correct NextPageToken in ListDeployments #6972
Conversation
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
dnr
approved these changes
Dec 12, 2024
| @@ -367,8 +373,7 @@ func (d *DeploymentClientImpl) ListDeployments( | |||
| deployments = append(deployments, deploymentListInfo) | |||
There was a problem hiding this comment.
nit: while we're here, let's change this loop to make(..., len(persistenceResp.Executions) and assign by index?
tests/deployment_test.go
Outdated
| @@ -309,6 +309,24 @@ func (s *DeploymentSuite) verifyDeploymentListInfo(expectedDeploymentListInfo *d | |||
| return true | |||
| } | |||
|
|
|||
| func (s *DeploymentSuite) listDeploymentsAllPages(ctx context.Context, request *workflowservice.ListDeploymentsRequest) ([]*deploymentpb.DeploymentListInfo, error) { | |||
There was a problem hiding this comment.
Suggested change
| func (s *DeploymentSuite) listDeploymentsAllPages(ctx context.Context, request *workflowservice.ListDeploymentsRequest) ([]*deploymentpb.DeploymentListInfo, error) { | |
| func (s *DeploymentSuite) listDeploymentsAll(ctx context.Context, request *workflowservice.ListDeploymentsRequest) ([]*deploymentpb.DeploymentListInfo, error) { |
akin to io.ReadAll?
tests/deployment_test.go
Outdated
Comment on lines
316
to
319
| for { | ||
| if !(resp == nil || len(resp.NextPageToken) > 0) { | ||
| break | ||
| } |
There was a problem hiding this comment.
Suggested change
| for { | |
| if !(resp == nil || len(resp.NextPageToken) > 0) { | |
| break | |
| } | |
| for resp == nil || len(resp.NextPageToken) > 0 { |
bergundy
pushed a commit
that referenced
this pull request
Dec 17, 2024
…ments (#6972) ## What changed? Previously, `request.PageSize` was ignored and visibility max allowed page size was always used. Now, we use `request.PageSize` appropriately and also return an updated NextPageToken. ## Why? So that the list can be paginated. ## How did you test it? Added a unit test for this. Confirmed the test fails with the buggy code (static NextPageToken) ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) -->
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.
What changed?
Previously,
request.PageSizewas ignored and visibility max allowed page size was always used. Now, we userequest.PageSizeappropriately and also return an updated NextPageToken.Why?
So that the list can be paginated.
How did you test it?
Added a unit test for this. Confirmed the test fails with the buggy code (static NextPageToken)
Potential risks
Documentation
Is hotfix candidate?