-
Notifications
You must be signed in to change notification settings - Fork 685
Closed
Labels
Milestone
Description
Refs: #4546
- anyOS @meganrogge
- anyOS @hediet
- anyOS @connor4312
- anyOS @aiday-mar
Complexity: 4
We now have an internal local rate limit for GitHub Pull Requests and Issues. We also now throw an exception and show an error when the GitHub API rate limit is hit. There are two goals to this test plan item:
- Ensure that the internal rate limit is high enough that you never see an error message about it during normal (if intentionally aggressive) use.
- Hit the GitHub API rate limit and make sure that you see an error message and that if we were running API calls in a loop it stops.
Steps:
- Install the pre-release build of GitHub Pull Requests and Issues.
- Set the log level of the extension to trace (Developer: Set Log Level -> GitHub Pull Request -> Trace)
- Open the output for GitHub Pull Request.
- Make sure you won't need to use the extension for normal work for the next hour.
- Open a folder with a clone of a GitHub repo in VS Code.
- Cause the extension to make lots of GitHub API requests and verify that you never see a notification that says "The GitHub Pull Requests extension is making too many requests to GitHub. This indicates a bug in the extension. Please file an issue on GitHub and include the output from "GitHub Pull Request"." Try to come up with various ways to make the extension make API requests. Some examples:
- Modifying and/or refreshing the queries in the Issues and Pull Requests views. NOTE: hitting "Refresh" on the Pull Requests view repeatedly will cause the rate limit to be hit. This is a known issue! The GitHub Pull Requests extension is making too many requsts to GitHub #4767 In your testing, please find other ways to make lots of requests.
- Refreshing the overview/description of a PR
- Expanding lots of PRs in the Pull Requests view
- Keep repeating step 6 until you hit GitHub's API rate limit. You'll know you've hit it when you see an error notification that says " API call count has exceeded a rate limit." Verify that the output opened in step 3 stops printing at this point. It is expected that it prints again if you run something else from the extension, but it should again error out early with the "API call count has exceeded a rate limit." error.