Change: Fix endless loop in GitHubAsyncRESTClient.get_all #1076
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
Conventional Commits Report
🚀 Conventional commits found. |
y0urself
previously approved these changes
Dec 16, 2024
|
I think you need to adjust the tests ... |
|
@y0urself Adjusted my line of code instead to match the unit test and not the unit test. I think it's little cleaner to not expects empty |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1076 +/- ##
=======================================
Coverage 90.31% 90.31%
=======================================
Files 108 108
Lines 7187 7188 +1
Branches 815 815
=======================================
+ Hits 6491 6492 +1
Misses 491 491
Partials 205 205 ☔ View full report in Codecov by Sentry. |
y0urself
approved these changes
Dec 16, 2024
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
This PR fixes an endless loop in
GitHubAsyncRESTClient.get_all, caused by unexpected behavior of httpx.Why
In the current release httpx doesn't merge the params of the URL and the ones in
params, butparamswill replace the URL. This causes us to request the first page over and over again, becauseparams=paramswill replacepageparameter, which is part of the string that_get_next_urlreturns.This has been introduced by encode/httpx#3433. Because this seems to be expected behavior (debatable IMHO), I opted to work around this instead of just pinning the httpx version to the previously working one.
You can confirm this fix by using e.g. download-artifact and using this branch for pontos. Without this fix, it'll take forever and at some point likely exceed out API quota.
References
Jira: https://jira.greenbone.net/browse/VTA-630
Checklist