-
Notifications
You must be signed in to change notification settings - Fork 179
Add GHES support to the review agent #611
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
brianphillips
wants to merge
4
commits into
sourcebot-dev:main
Choose a base branch
from
brianphillips:ghes-review-agent
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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
Oops, something went wrong.
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 problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Throttle configuration is defined but not actually applied to Octokit
githubAppBaseOptionsincludes athrottleconfig, butgetGithubAppForBaseUrlonly passesbaseUrlintoOctokit.plugin(throttling).defaults(...).App’s constructor doesn’t accept athrottleoption;throttlemust be passed to the underlying Octokit constructor (e.g., viadefaults({ throttle: ... })) for@octokit/plugin-throttlingto use it.Right now, you’re likely getting Octokit’s default throttling behavior instead of the custom
retryCount > 3logic and the secondary-rate-limit “no retry” behavior.Consider wiring the throttle options into the Octokit defaults, e.g.:
This keeps your per-base-URL behavior while ensuring the throttle callbacks are honored.
Also applies to: 70-89
I'll verify the review comment by inspecting the actual code and confirming the behavior of the Octokit throttling plugin.
Length of output: 3944
💡 Result:
Use the throttle option when constructing the Octokit instance (after applying the plugin). Example:
JavaScript (Node)
import and apply plugin:
const { Octokit } = require("@octokit/rest");
const { throttling } = require("@octokit/plugin-throttling");
const MyOctokit = Octokit.plugin(throttling);
pass throttle in the constructor:
const octokit = new MyOctokit({
auth: "token " + process.env.TOKEN,
throttle: {
onRateLimit: (retryAfter, options, octokit) => {
octokit.log.warn(
Rate limit for ${options.method} ${options.url});if (options.request.retryCount === 0) return true; // retry once
},
onSecondaryRateLimit: (retryAfter, options, octokit) => {
octokit.log.warn(
Secondary rate limit for ${options.method} ${options.url});},
// or disable: enabled: false
},
});
Notes: the option key is throttle (not “throttling”), and onRateLimit / onSecondaryRateLimit (or onAbuseLimit on older versions) should return true to retry. [1][2]
Sources:
[1] Octokit docs — Throttling examples and constructor options.
[2] octokit/octokit.js README (throttle option description).
Throttle configuration is defined but not passed to the Octokit instance
At line 81,
Octokit.plugin(throttling).defaults()only receivesbaseUrl, not thethrottleconfig. The throttle callbacks defined in lines 31-47 are passed to theAppconstructor, which doesn't accept athrottleoption—they're ignored.Per the
@octokit/plugin-throttlingAPI, the throttle option must be passed directly to the Octokit instance viadefaults()or the constructor. Without this, the customretryCount > 3logic and secondary rate-limit "no retry" behavior won't execute.Update
getGithubAppForBaseUrlto wire throttle into Octokit.defaults():const OctokitWithBaseUrl = Octokit.plugin(throttling).defaults({ baseUrl: normalizedBaseUrl }); const app = new App({ ...githubAppBaseOptions, Octokit: OctokitWithBaseUrl, });to:
const { throttle, ...appOptions } = githubAppBaseOptions; const OctokitWithBaseUrl = Octokit.plugin(throttling).defaults({ baseUrl: normalizedBaseUrl, ...(throttle ? { throttle } : {}), }); const app = new App({ ...appOptions, Octokit: OctokitWithBaseUrl, });🤖 Prompt for AI Agents