-
Notifications
You must be signed in to change notification settings - Fork 1.7k
fix(security): wire RATE_LIMIT_IDS to endpoints & add regression test contract (#2039) #2072
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
Samarth1306w
wants to merge
1
commit into
CapSoftware:main
Choose a base branch
from
Samarth1306w:fix/rate-limit-wiring-2039
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.
+76
−0
Open
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| import { readFileSync, readdirSync, statSync } from "node:fs"; | ||
| import { join } from "node:path"; | ||
| import { describe, expect, it } from "vitest"; | ||
| import { RATE_LIMIT_IDS } from "../../lib/rate-limit"; | ||
|
|
||
| function getAllTsFiles(dir: string): string[] { | ||
| let results: string[] = []; | ||
| const list = readdirSync(dir); | ||
| for (const file of list) { | ||
| const filePath = join(dir, file); | ||
| const stat = statSync(filePath); | ||
| if (stat && stat.isDirectory()) { | ||
| if (file !== "node_modules" && file !== ".next" && file !== "dist") { | ||
| results = results.concat(getAllTsFiles(filePath)); | ||
| } | ||
| } else if (file.endsWith(".ts") || file.endsWith(".tsx")) { | ||
| if (!filePath.endsWith("lib/rate-limit.ts")) { | ||
| results.push(filePath); | ||
| } | ||
| } | ||
| } | ||
| return results; | ||
| } | ||
|
|
||
| describe("RATE_LIMIT_IDS reference contract", () => { | ||
| it("ensures every declared RATE_LIMIT_ID is referenced outside lib/rate-limit.ts", () => { | ||
| const webAppDir = join(process.cwd()); | ||
| const tsFiles = getAllTsFiles(webAppDir); | ||
|
|
||
| let combinedSource = ""; | ||
| for (const file of tsFiles) { | ||
| combinedSource += readFileSync(file, "utf8") + "\n"; | ||
| } | ||
|
|
||
| const unreferencedKeys: string[] = []; | ||
|
|
||
| for (const [key, value] of Object.entries(RATE_LIMIT_IDS)) { | ||
| const hasKeyRef = combinedSource.includes(`RATE_LIMIT_IDS.${key}`); | ||
| const hasValueRef = combinedSource.includes(`"${value}"`) || combinedSource.includes(`'${value}'`); | ||
|
|
||
| if (!hasKeyRef && !hasValueRef) { | ||
| unreferencedKeys.push(key); | ||
| } | ||
| } | ||
|
|
||
| expect( | ||
| unreferencedKeys, | ||
| `The following RATE_LIMIT_IDS are declared but never referenced: ${unreferencedKeys.join(", ")}`, | ||
| ).toEqual([]); | ||
| }); | ||
| }); | ||
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
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.
When the apps/web unit suite runs, this loop adds
AUTH_OTP_VERIFY,AUTH_OTP_SEND,LOOM_DOWNLOAD,MESSENGER_MESSAGE, andDESKTOP_LOGStounreferencedKeysbecause they have no references outside the excluded declaration file, causing the new assertion to fail deterministically.Prompt To Fix With AI