fix(onboarding): Prevent entire docs object from rendering as React child#115876
Draft
sentry[bot] wants to merge 1 commit into
Draft
fix(onboarding): Prevent entire docs object from rendering as React child#115876sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
Contributor
📊 Type Coverage Diff✅ No new type safety issues introduced. Coverage: 93.56% |
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.
This PR addresses an issue where the entire
docsconfiguration object was being passed as a React child, leading to a runtime error: "Objects are not valid as a React child".The root cause was identified as a combination of:
docsobject (specifically for Elixir, but potentially other platforms) not strictly conforming to theDocsinterface, allowing non-step objects to be returned byinstall,configure, orverifyfunctions.OnboardingLayout,Step.tsx, andContentBlocksRendererto handle such malformed inputs.To fix this, the following changes were implemented:
static/app/components/onboarding/gettingStartedDoc/contentBlocks/utils.tsx: Added checks inrenderBlocksto ensurecontentBlocksis an array and eachblockis a valid object with a stringtypeand a registered renderer. Malformed blocks are now skipped.static/app/components/onboarding/gettingStartedDoc/step.tsx: Ensured that thecontentprop passed toContentBlocksRendereris always an array, coercing it to an empty array if it's not.static/app/components/onboarding/gettingStartedDoc/onboardingLayout.tsx: Introduced asafeCallhelper to wrap calls todoc.install,doc.configure, anddoc.verify. This helper ensures that these functions are called only if they exist and that their return values are arrays ofOnboardingSteps. Additionally, a defensive check was added within thesteps.maploop to skip rendering anystepobject that does not have a validtitleortypestring, preventing the entireDocsliteral from being spread into<StyledStep />.These changes make the onboarding rendering process more robust by defensively validating the shape of the
docsconfiguration and ensuring that only valid React nodes orOnboardingStepobjects are processed for rendering.Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
Fixes JEST-28H7