Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| // DO NOT change variable name unless you change it in the sentry-docs GHA workflow in getsentry/sentry-api-schema. | ||
| const SENTRY_API_SCHEMA_SHA = 'd218ebe064fe5ec8cb383688e80cbf36c0a6a5e8'; | ||
| const SENTRY_API_SCHEMA_SHA = '43a08415e12ae4aa680595d1bef5cd69527156c9'; | ||
|
|
There was a problem hiding this comment.
Bug: The OpenAPI schema fetch logic lacks error handling for HTTP failures and does not validate the response structure, which can crash the build process.
Severity: MEDIUM
Suggested Fix
Implement robust error handling around the fetch call. Check if response.ok is true before calling response.json() to handle non-2xx HTTP statuses. Additionally, wrap the fetch and parsing logic in a try...catch block. Before using the parsed data, validate that required properties like tags and paths exist to prevent runtime errors.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: src/build/resolveOpenAPI.ts#L12
Potential issue: The `resolveOpenAPI` function fetches a JSON schema from a remote URL
but does not handle potential failures. It lacks checks for HTTP errors (like 404 Not
Found) before attempting to parse the response body. Furthermore, downstream code in
`apiCategoriesUncached` directly accesses properties like `data.tags` and `data.paths`
without validating their existence. If the remote file is missing, the network request
fails, or the JSON structure is unexpected, the application will throw a runtime error
during the build process, causing the entire build to fail.
Did we get this right? 👍 / 👎 to inform future reviews.
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.
No description provided.