test : added unit tests for github-rate-limit helpers#2466
Open
tmdeveloper007 wants to merge 1 commit into
Open
test : added unit tests for github-rate-limit helpers#2466tmdeveloper007 wants to merge 1 commit into
tmdeveloper007 wants to merge 1 commit into
Conversation
GSSoC Label Checklist 🏷️@Umbrella-io — please apply the appropriate labels before merging: Difficulty (pick one):
Quality (optional):
Validation (required to score):
|
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
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.
Closes #2461.
Summary of What Has Been Done:
Added a dedicated vitest test file
test/github-rate-limit.test.tsthat pins the behaviour of every export insrc/lib/github-rate-limit.ts:getGitHubRateLimitDetails,throwIfGitHubRateLimited,githubRateLimitResponse, and theGitHubRateLimitErrorclass. Tests use a realResponseconstructed vianew Response(null, { status, headers })so the public surface area (including header parsing) is exercised end-to-end.Changes Made:
test/github-rate-limit.test.ts(15 tests, all passing undernpm test).getGitHubRateLimitDetails:x-ratelimit-remaining: 0→ null (status is the gate).x-ratelimit-remaining: 1→ null (still has budget).x-ratelimit-remaining: 0and a valid reset epoch → fullGitHubRateLimitDetailswith matchingresetAtISO string andresetAtEpoch.x-ratelimit-remaining: 0but missing reset header →resetAt: null, generic message.resetAt: null,resetAtEpoch: null.throwIfGitHubRateLimited:GitHubRateLimitErrorwhosedetailsandmessagematchgetGitHubRateLimitDetails.githubRateLimitResponse:Error, strings,null,undefined.Responsewith the right JSON body for aGitHubRateLimitError(both with and without a reset timestamp).Impact it Made:
Locks the contract between GitHub's rate-limit signal and DevTrack's user-facing 429 response. Future refactors of the helper will surface a test failure rather than a silent security or UX regression. No production code is modified; the change is limited to one new test file.