Bump API schema to 678631a8#18411
Closed
sentry-api-schema-updater[bot] wants to merge 1 commit into
Closed
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 = '626702adb84c4fcf80899cd3ef0512f610279227'; | ||
| const SENTRY_API_SCHEMA_SHA = '678631a8bf4271a3a28fa15e59f4c4c4429a4978'; |
Contributor
There was a problem hiding this comment.
Bug: The code in apiCategoriesUncached directly accesses properties of a fetched OpenAPI schema without null checks, which could cause a build failure if the schema structure changes.
Severity: MEDIUM
Suggested Fix
Add validation and defensive checks when processing the fetched OpenAPI schema. Wrap property access in try-catch blocks or use optional chaining (?.) and nullish coalescing operators (??) to provide default empty values (e.g., (data.tags || []).forEach(...)) to prevent crashes if a required field is missing.
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#L9
Potential issue: The function `apiCategoriesUncached` in `resolveOpenAPI.ts` fetches and
parses an OpenAPI schema. It directly accesses properties on the resulting data object,
such as `data.tags`, without defensive checks. If the schema fetched from the new commit
SHA is missing properties that the code assumes are present (like the `tags` array), the
build process will crash with a `TypeError` when `forEach` is called on `undefined`.
This lack of error handling or validation for the external schema makes the build
process brittle and susceptible to failures from upstream schema changes.
Did we get this right? 👍 / 👎 to inform future reviews.
Collaborator
|
Conflict with newer branch, skipping this |
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.