Avoid exceeding the GitHub REST API rate limit #150
Merged
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
There was a recent uptick of problems with the `limit-access-to-actor` feature because it uses an unauthenticated REST API call (and the rate limiting is based on IP, i.e. hosted GitHub build agents will run into this _a lot_). The symptom looks like this: Error: API rate limit exceeded for 172.176.196.48. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) Let's imitate how `actions/checkout` uses authenticated REST API calls (see https://github.com/actions/checkout/blob/v3.3.0/action.yml#L24): add an "input" variable with the correct default (and users are expected to never _actually_ to provide that variable). Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
dscho
force-pushed
the
use-github-token
branch
from
fd0fecd
to
b4f2b23
Compare
mxschmitt
reviewed
Jan 9, 2023
src/helpers.js
Outdated
| shell: true, | ||
| env: { | ||
| ...process.env, | ||
| HOMEBREW_GITHUB_API_TOKEN: core.getInput('github-token') |
There was a problem hiding this comment.
Suggested change
| HOMEBREW_GITHUB_API_TOKEN: core.getInput('github-token') | |
| ...(core.getInput('github-token') ? { HOMEBREW_GITHUB_API_TOKEN: core.getInput('github-token') } : undefined) |
was thinking about that maybe. Otherwise it does not get forwarded. So the user can set it on his own as well.
There was a problem hiding this comment.
I was under the impression that spawn() ignores env keys with undefined values? Let me try this.
There was a problem hiding this comment.
we are spreading with undefined, which means that nothing gets spreaded inside the existing ...process.env object. aka. a noop.
There was a problem hiding this comment.
Yep, if the env object contains a key whose value is undefined, it isn't set:
$ node -e "const { spawn } = require('child_process'); const proc = spawn('set -x; env | grep HOMEBREW_GITHUB_API_TOKEN >&2', { shell: true, env: { HOMEBREW_GITHUB_API_TOKEN: undefined } }); proc.stdout.on('data', (data) => { process.stdout.write(data); }); proc.stderr.on('data', (data) => { process.stderr.write(data); });"
+ grep HOMEBREW_GITHUB_API_TOKEN
+ envHowever, I guess the problem here is that core.getInput() would maybe always return a string? How about this instead, then?
Suggested change
| HOMEBREW_GITHUB_API_TOKEN: core.getInput('github-token') | |
| HOMEBREW_GITHUB_API_TOKEN: core.getInput('github-token') || undefined |
mxschmitt
approved these changes
Jan 9, 2023
This fixes mxschmitt#69 Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
dscho
force-pushed
the
use-github-token
branch
from
b4f2b23
to
0172c1d
Compare
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.
There was a recent uptick of probems with symptoms like this:
Let's follow that advice and use authenticated REST API requests.