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 = '42495fc378961e27521a842bf9e6e10e9f864d72'; | ||
| const SENTRY_API_SCHEMA_SHA = 'ffc843e486c3b5984ff90759343e419e76d92b7e'; |
There was a problem hiding this comment.
Bug: The fetch call in resolveOpenAPI lacks error handling. It doesn't check if the response is successful before attempting to parse it as JSON, which will crash on HTTP errors.
Severity: HIGH
Suggested Fix
Before calling await response.json(), add a check to ensure the response was successful, for example: if (!response.ok) { throw new Error(Failed to fetch OpenAPI schema: ${response.statusText}); }. Consider wrapping the fetch operation in a try...catch block to handle network failures and other unexpected errors gracefully.
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 a JSON file from a GitHub URL but
does not validate the HTTP response. If the request fails (e.g., a 404 Not Found or a
5xx server error), the code attempts to parse the response body as JSON. In the case of
a 404 error, GitHub returns an HTML page, causing `response.json()` to throw an
unhandled `SyntaxError`. Since this function is called during the static site generation
and at runtime, this unhandled exception will crash the build process or the running
application, making the documentation site unavailable.
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.