Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| // 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 = 'b02b0fc72d6cd844ace73aa326582f921bd50bce'; | ||
| const SENTRY_API_SCHEMA_SHA = '149c5eb7c15d8d6637011a32cccfcedc5893fd89'; | ||
|
|
There was a problem hiding this comment.
Bug: The code accesses categoryMap[tag] without verifying the tag exists. An API tag not defined in the root data.tags will cause a build-time crash.
Severity: HIGH
Suggested Fix
Add a defensive check to ensure categoryMap[tag] is defined before attempting to access its apis property. For example: if (categoryMap[tag]) { categoryMap[tag].apis.push({ ... }); }. This prevents the build from crashing if an API uses a tag not declared at the root level.
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
Potential issue: The code populates a `categoryMap` using tags from the root-level
`data.tags`. It then iterates through each API's `apiData.tags` and attempts to access
`categoryMap[tag].apis.push(...)`. If an API operation uses a tag that is not defined in
the root `data.tags`, `categoryMap[tag]` will be `undefined`, causing a "Cannot read
property 'apis' of undefined" runtime error. This will crash the documentation build
process. The OpenAPI specification does not require all operation tags to be defined at
the root level, making this a potential point of failure with schema updates.
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.