Skip to content

Bump API schema to c4000718#16617

Closed
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-c4000718
Closed

Bump API schema to c4000718#16617
getsantry[bot] wants to merge 1 commit intomasterfrom
bot/bump-api-schema-to-c4000718

Conversation

@getsantry
Copy link
Contributor

@getsantry getsantry bot commented Feb 27, 2026

No description provided.

@vercel
Copy link

vercel bot commented Feb 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Feb 27, 2026 10:24pm
sentry-docs Ready Ready Preview, Comment Feb 27, 2026 10:24pm

Request Review

@getsantry getsantry bot enabled auto-merge (squash) February 27, 2026 22:13
Comment on lines +11 to 14
const SENTRY_API_SCHEMA_SHA = 'c40007183d071d4ef28a886be883697cc4fde251';

const activeEnv = process.env.GATSBY_ENV || process.env.NODE_ENV || 'development';

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The resolveOpenAPI function does not check if the fetch request for the API schema is successful before parsing the response as JSON, risking a crash.
Severity: MEDIUM

Suggested Fix

Before calling response.json(), add a check to verify the response was successful. If !response.ok, throw a descriptive error to handle the failure gracefully. For example: if (!response.ok) { throw new Error(Failed to fetch API schema: ${response.statusText}); }.

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-L14

Potential issue: The `resolveOpenAPI` function fetches an API schema from a raw content
URL. It directly calls `response.json()` on the fetch response without first checking if
the request was successful via `response.ok`. If the fetch fails for any reason, such as
a network error, an invalid commit SHA, or the file not being present at that commit,
the server will likely return a non-JSON response (e.g., a 404 HTML page). Attempting to
parse this response as JSON will cause an unhandled `SyntaxError`, leading to a crash in
the build process or at runtime.

Did we get this right? 👍 / 👎 to inform future reviews.

@sergical
Copy link
Member

sergical commented Mar 6, 2026

Closing stale PR. The bump-api-schema workflow has been fixed to merge immediately in #16827.

@sergical sergical closed this Mar 6, 2026
auto-merge was automatically disabled March 6, 2026 18:44

Pull request was closed

@sergical sergical deleted the bot/bump-api-schema-to-c4000718 branch March 6, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant