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 = 'd218ebe064fe5ec8cb383688e80cbf36c0a6a5e8'; | ||
| const SENTRY_API_SCHEMA_SHA = '6465c0aff4f3485a73f7e97f4c39474229f47418'; |
There was a problem hiding this comment.
Bug: The OpenAPI schema fetching and processing logic in resolveOpenAPI.ts lacks error handling and validation, making the build process brittle and prone to crashing.
Severity: HIGH
Suggested Fix
Add a check for response.ok after the fetch call to handle non-successful HTTP statuses. Wrap the data processing logic in apiCategoriesUncached with defensive checks to ensure properties like data.tags, data.paths, and categoryMap[tag] exist before they are accessed. This will prevent crashes from both network failures and unexpected schema structures.
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 and parses an OpenAPI schema
without proper error handling or data validation. If the fetch operation fails (e.g.,
due to an invalid SHA returning a 404 error), the code attempts to parse a non-JSON
response, causing a `SyntaxError` that crashes the build process. Additionally, even
with a valid JSON response, the `apiCategoriesUncached` function assumes a specific
schema structure. It can crash with a runtime error if an API endpoint in `data.paths`
references a `tag` not defined in `data.tags`, or if properties like `data.tags` or
`apiData.tags` are missing.
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.