Eliminate API overfetching in pr commands
#3547
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
This completely rewrites the PR lookup mechanism so that the caller must specify the GraphQL fields to query for each PR. Additionally, this fixes some export problems with `pr view --json`. Features: - Each pr command now gets assigned a concept of a Finder. This makes it easier to stub the PR in tests without having to stub the underlying HTTP calls or git invocations. - `pr view --web` is much faster since it only fetches the "url" field. - `pr diff 123` now skips a whole API call where a whole PR was unnecessarily preloaded just to access its diff in a subsequent call. - PullRequestGraphQL query builder is now used to construct queries. - A bunch of individual commands are now freed of having to know about concepts such as BaseRepo, Branch, Config, or Remotes.
samcoe
reviewed
May 11, 2021
| return &resp.Repository.PullRequest, nil | ||
| } | ||
|
|
||
| func findForBranch(httpClient *http.Client, repo ghrepo.Interface, baseBranch, headBranch string, stateFilters, fields []string) (*api.PullRequest, error) { |
Contributor
There was a problem hiding this comment.
Same comment as findByNumber.
samcoe
approved these changes
May 12, 2021
This was referenced May 18, 2021
This was referenced Jun 7, 2021
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.
This completely rewrites the PR lookup mechanism so that the caller must specify the GraphQL fields to query for each PR. Additionally, this fixes a few export problems with
pr view --json.Features:
Each pr command now gets assigned a concept of a PR "Finder". This makes it easier to stub the PR in tests without having to stub the underlying HTTP calls or git invocations.
pr view --webis much faster since it only fetches the "url" field.pr diff 123now skips a whole API call where a whole PR was unnecessarily preloaded just to access its diff in a subsequent call.PullRequestGraphQL query builder is now used to construct PR queries.
A bunch of individual commands are now freed from having to know about concepts such as BaseRepo, Branch, Config, or Remotes since they were mostly necessary just for the PR lookup.
Speedups:
Downsides
runCommand-style tests are really resistant to transitioning to dependency injection via interfaces, so I've had to make a stopgap hack called RunCommandFinder to be able to inject mock finders into commandsTODO:
pr viewpr checks- fixesgh pr checksdoes not show all checks if n > 100 #3040, closes Enable showing ALL pr checks #3331Fixes #3539, fixes #3497, fixes #2849, fixes #3346, fixes #3561