Fix query object state mutation during pagination #11244
Merged
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
Signed-off-by: Babak K. Shandiz <babakks@github.com>
Signed-off-by: Babak K. Shandiz <babakks@github.com>
Signed-off-by: Babak K. Shandiz <babakks@github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR fixes mutation of the original query slice during pagination and adds tests to ensure quoted multi-word keywords are handled correctly across search endpoints and URL generation.
- Refactor formatKeywords to return a new slice instead of mutating the input
- Add pagination test cases for multi-word queries in code, commits, repositories, and issues
- Add a URL-encoding test for quoted multi-word keywords
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pkg/search/query.go | Changed formatKeywords to allocate a new result slice rather than mutating the input |
| pkg/search/searcher_test.go | Added tests for paginating with quoted multi-word queries and URL encoding |
andyfeller
approved these changes
Jul 7, 2025
Comment on lines
151
to
+161
| func formatKeywords(ks []string) []string { | ||
| result := make([]string, len(ks)) | ||
| for i, k := range ks { | ||
| before, after, found := strings.Cut(k, ":") | ||
| if !found { | ||
| ks[i] = quote(k) | ||
| result[i] = quote(k) | ||
| } else { | ||
| ks[i] = fmt.Sprintf("%s:%s", before, quote(after)) | ||
| result[i] = fmt.Sprintf("%s:%s", before, quote(after)) | ||
| } | ||
| } | ||
| return ks | ||
| return result |
There was a problem hiding this comment.
note: just to clarify, this function had a side effect of modifying Query.Keywords field which is used else where. Refactoring this logic to not modify the input avoids the redundant formatting issue.
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.
Fixes #11228
This PR fixes the issue with mutating original query object during pagination API calls. Test cases were added to assert the expected behaviour.
Verifying A/C
Given I have a query that contains a whitespace character, and my query will result in several pages of pagination
When I run the
gh searchcommand (for any subcommand)Then my query should complete without error
I found a simple use case to verify the expected behaviour. It's looking for the abundant Lorem Ipsum phrase with a grouping of words that forces
ghto quote them:This works fine with the changes in this PR, but if we run it with the latest
gh(or on thetrunkbranch) we'll get the following error: