Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/build/resolveOpenAPI.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {DeRefedOpenAPI} from './open-api/types';

// 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 = '508ff446e1d2fd83e0073a0f6edbb6230e033476';

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

Comment on lines 12 to 14
Copy link

Choose a reason for hiding this comment

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

Bug: The fetch call in resolveOpenAPI lacks error handling for non-200 responses, which can cause the build process to fail if the remote file is unavailable.
Severity: MEDIUM

Suggested Fix

Check the response.ok property after the fetch call. If the response is not okay, throw a more informative error or handle it gracefully to prevent the build from crashing with an unhandled exception.

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

Potential issue: The `fetch` call in `resolveOpenAPI.ts` to retrieve
`openapi-derefed.json` from GitHub does not handle potential HTTP errors. If the fetch
fails due to network issues, an invalid commit SHA, or GitHub returning a non-200 status
code (e.g., 404, 500), the subsequent call to `response.json()` will throw an unhandled
exception. This will cause the entire static site generation process to fail, preventing
deployment. While this is a build-time failure, it introduces fragility into the build
pipeline.

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

Expand Down
Loading