-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Bump API schema to c23d6d90 #14992
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Bump API schema to c23d6d90 #14992
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
||
const activeEnv = process.env.GATSBY_ENV || process.env.NODE_ENV || 'development'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Potential bug: The resolveOpenAPI
function doesn't handle non-200 HTTP responses from fetch
before calling response.json()
, which can cause a crash if the external API returns an error.
-
Description: The
resolveOpenAPI
function fetches an OpenAPI schema from a raw GitHub URL. It directly callsresponse.json()
on the result without first checking if the HTTP request was successful (e.g., viaresponse.ok
). If the fetch fails for any reason, such as a 404 error or a temporary GitHub outage, the response will likely be an HTML error page. Attempting to parse this HTML as JSON will throw aSyntaxError
, causing an unhandled exception. This will crash the documentation build process and also cause server-side rendering failures for API documentation pages, as the function is used in both critical paths. -
Suggested fix: Before calling
await response.json()
, add a check for the response status. If!response.ok
, throw an informative error to prevent the application from crashing due to an attempt to parse a non-JSON response. For example:if (!response.ok) { throw new Error(
Failed to fetch OpenAPI schema: ${response.statusText}); }
.
severity: 0.7, confidence: 0.95
Did we get this right? 👍 / 👎 to inform future reviews.
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
No description provided.