Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Comment on lines
8
to
14
|
|
||
| // 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 = '0026719ede0a1ced5b9fc0b40a76b117becbc11b'; | ||
| const SENTRY_API_SCHEMA_SHA = 'f8e64ed40c9112e1ec6bb667644ae2b6e85a8f59'; | ||
|
|
||
| const activeEnv = process.env.GATSBY_ENV || process.env.NODE_ENV || 'development'; | ||
|
|
There was a problem hiding this comment.
Bug: The resolveOpenAPI function doesn't handle non-200 HTTP responses when fetching the API schema, which can cause the build process to crash on a 404 error.
Severity: HIGH
Suggested Fix
Before calling await response.json(), check the status of the fetch response with if (!response.ok). If the response is not okay, throw a descriptive error message that includes the URL and the status code to clarify that the schema file could not be fetched, possibly due to an invalid commit SHA.
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#L8-L14
Potential issue: The `resolveOpenAPI` function fetches an OpenAPI schema from a raw
GitHub URL but does not check if the HTTP request was successful before attempting to
parse the response as JSON. If the specified commit SHA is invalid or the file is
otherwise unavailable, GitHub will return a 404 response with an HTML body. The
subsequent call to `response.json()` will then fail with a `SyntaxError`, as it tries to
parse HTML. Since this function is executed during the site's build process and the
error is not handled by any callers, this will cause the entire build to crash with a
cryptic error message.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.