Bump search bucket to 240/min and add user repos/starred passthrough#4
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughTwo new GitHub-proxy endpoints were added: ChangesGitHub User Repositories and Starred Endpoints
Sequence DiagramsequenceDiagram
participant Client
participant RouteHandler as Route Handler<br/>(userReposRoutes)
participant Cache as GitHubResourceClient<br/>(fetchCached)
participant GitHub as GitHub API
Client->>RouteHandler: GET /v1/users/{user}/repos?sort=updated&page=1
activate RouteHandler
Note over RouteHandler: Validate username,<br/>whitelist params,<br/>build cache key
RouteHandler->>Cache: fetchCached(cacheKey, upstreamURL, token?, 1h TTL)
activate Cache
alt Cache Hit
Cache-->>RouteHandler: Result.Hit(cachedBody)
RouteHandler-->>Client: 200 OK + Cache-Control: public
else Cache Miss
Cache->>GitHub: GET /users/{user}/repos (with optional token)
activate GitHub
GitHub-->>Cache: 200 + JSON
deactivate GitHub
Cache-->>RouteHandler: Result.StaleFallback(body)
RouteHandler-->>Client: 200 OK + X-Cache-State: stale-fallback
else Upstream Error
Cache->>GitHub: GET /users/{user}/repos
activate GitHub
GitHub-->>Cache: 5xx Error
deactivate GitHub
Cache-->>RouteHandler: Result.UpstreamError
RouteHandler-->>Client: 502 Bad Gateway + github_unreachable
end
deactivate Cache
deactivate RouteHandler
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/main/kotlin/zed/rainxch/githubstore/Plugins.kt (1)
71-78:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winStale function-level comment after rate-limit bump.
The
searchBucketKeydocblock has two stale references following the 60→240 bump and the addition of the new routes:
- Lines 71–72: the route list still reads
/search, /search/explore, /releases, /readme, /user— the newly added/users/{u}/reposand/users/{u}/starredare missing.- Line 74:
"a single 60/min slot"— should now read240/minto match the actual limit.The
register()block comment at lines 170–173 was updated correctly; the function-level companion was not.✏️ Proposed fix
-// Key function for the search bucket (covers /search, /search/explore, -// /releases, /readme, /user — all the upstream-passthrough routes). Behind a -// CDN POP, IP-only keying collapses every user behind one regional POP into -// a single 60/min slot. Keying by a hash of the user's X-GitHub-Token when +// Key function for the search bucket (covers /search, /search/explore, +// /releases, /readme, /user, /users/{u}/repos, /users/{u}/starred — +// all the upstream-passthrough routes). Behind a CDN POP, IP-only keying +// collapses every user behind one regional POP into a single 240/min slot. +// Keying by a hash of the user's X-GitHub-Token when🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/main/kotlin/zed/rainxch/githubstore/Plugins.kt` around lines 71 - 78, Update the stale docblock for the searchBucketKey function: change the rate text from "a single 60/min slot" to "240/min" and add the newly supported routes (`/users/{u}/repos` and `/users/{u}/starred`) to the route list in the comment; ensure the comment still mentions token-hash behavior (HmacSHA256 pepper truncated to 16 hex chars) and that anonymous callers are keyed by IP. Reference the searchBucketKey function and the existing register() comment to mirror the corrected language.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@src/main/kotlin/zed/rainxch/githubstore/Plugins.kt`:
- Around line 71-78: Update the stale docblock for the searchBucketKey function:
change the rate text from "a single 60/min slot" to "240/min" and add the newly
supported routes (`/users/{u}/repos` and `/users/{u}/starred`) to the route list
in the comment; ensure the comment still mentions token-hash behavior
(HmacSHA256 pepper truncated to 16 hex chars) and that anonymous callers are
keyed by IP. Reference the searchBucketKey function and the existing register()
comment to mirror the corrected language.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 0b9316ea-ad50-4462-8ebc-f91dbec75cce
📒 Files selected for processing (5)
CLAUDE.mdsrc/main/kotlin/zed/rainxch/githubstore/Plugins.ktsrc/main/kotlin/zed/rainxch/githubstore/routes/Routing.ktsrc/main/kotlin/zed/rainxch/githubstore/routes/UserReposRoutes.ktsrc/main/kotlin/zed/rainxch/githubstore/routes/UserStarredRoutes.kt
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Two changes addressing the rate-limit prompts seen in the client app, plus two new endpoints for the developer-profile screen.
1. Bump search bucket: 60 → 240 / min
Plugins.kt— the bucket covering/search,/search/explore,/releases,/readme,/user,/users/{u}/repos,/users/{u}/starredwas sized at 60/min when the client made far fewer parallel calls per session. With 90k users, a single details-page open fans out to 3-4 of these endpoints, and the developer-profile screen pulls 2 more.Sizing rationale:
s-maxageon/repo(300s) and tiered cache absorb most repeat reads anyway.2. New passthrough endpoints
GET /v1/users/{username}/repos?type=owner&sort=updated&direction=desc&page=N&per_page=NGET /v1/users/{username}/starred?sort=created&direction=desc&page=N&per_page=NBoth follow the existing
GitHubResourceClient.fetchCachedpattern (edge cache headers, stale-while-revalidate fallback, negative-hit caching, ETag pass-through). Query params are whitelisted to block SSRF via injection.Cache shape:
max-ages-maxage/users/{u}/repos/users/{u}/starredThe OAuth
/user/starred(signed-in viewer's own stars) is NOT proxied — that form requires per-user-session caching that doesn't fit this passthrough model.Out of scope (deferred)
releases-with-apk-onlypre-filter — premature; reconsider after the picker scan ships and we see real fan-out.X-RateLimit-Limit/Remaining/Reset); only client-side UX work remains.Test plan
./gradlew testgreen (no behaviour change to existing routes; bucket size is config).curl -Iand confirm 200 + the documented Cache-Control values.Summary by CodeRabbit
New Features
GET /v1/users/{username}/reposendpoint to retrieve a user's repositories with configurable pagination and sorting.GET /v1/users/{username}/starredendpoint to retrieve a user's starred repositories with configurable pagination and sorting.Performance