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 = '163c5962e920fc2df12610f98e4376722843222e'; | ||
| const SENTRY_API_SCHEMA_SHA = 'ea4cef1e8603b04dd7e97f80bbedfbdb86566a2c'; |
There was a problem hiding this comment.
Bug: The schema fetch in resolveOpenAPI lacks HTTP status checks, which can cause the build to crash on non-200 responses like 404s by trying to parse HTML.
Severity: MEDIUM
Suggested Fix
Before calling response.json(), add a check to ensure the fetch was successful, for example by verifying response.ok. If the response is not okay, throw an informative error to prevent the JSON parsing attempt and provide a clear reason for the build failure.
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 raw
GitHub URL. It does not check the HTTP response status before attempting to parse the
body as JSON. If the fetch operation results in a non-200 response (e.g., a 404 if the
SHA becomes invalid or a 5xx error from GitHub), the code will try to parse an HTML
error page as JSON, causing the build process to crash with a syntax error. This makes
the build process fragile and dependent on the availability and correctness of an
external resource without proper validation.
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.