Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| // SENTRY_API_SCHEMA_SHA is used in the sentry-docs GHA workflow in getsentry/sentry-api-schema. | ||
| // 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 = '870543550802cd0ec186a6e1c3f7e21e520b4361'; | ||
| const SENTRY_API_SCHEMA_SHA = '5a0d5fe82ce41ee6933a00d3b80a17a25bb575fc'; |
There was a problem hiding this comment.
Bug: The resolveOpenAPI function doesn't check if the fetch response was successful before parsing it as JSON, which can cause an unhandled error during the build.
Severity: HIGH
Suggested Fix
Before calling await response.json(), add a check for the response status. If !response.ok, throw a new error with a descriptive message, such as "Failed to fetch API schema," to prevent the build from crashing with a cryptic JSON parsing error.
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#L11
Potential issue: The `resolveOpenAPI` function fetches an OpenAPI schema from a GitHub
URL using `fetch`. However, it does not check the HTTP response status via `response.ok`
before attempting to parse the body with `response.json()`. If the request fails (e.g.,
a 404 error if the file at the specified commit SHA doesn't exist), the `fetch` promise
still resolves, but `response.json()` will be called on a non-JSON body, causing a JSON
parsing error. Since this function is called during the build process without error
handling, this will crash the entire build.
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.