Skip to content

fix(search): Handle invalid JSON in localStorage for search platforms#17892

Draft
sentry[bot] wants to merge 1 commit into
masterfrom
seer/fix-search-localstorage-json
Draft

fix(search): Handle invalid JSON in localStorage for search platforms#17892
sentry[bot] wants to merge 1 commit into
masterfrom
seer/fix-search-localstorage-json

Conversation

@sentry
Copy link
Copy Markdown
Contributor

@sentry sentry Bot commented May 26, 2026

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

This PR addresses an unhandled SyntaxError that occurred when the localStorage entry for search platforms (sentry-docs-search-platforms) contained invalid JSON. Previously, the JSON.parse call on line 102 of src/components/search/index.tsx would throw an error if the stored value was not valid JSON (e.g., "zzzz"), leading to a component crash.

The fix involves wrapping the JSON.parse call in a try/catch block. If a SyntaxError occurs, the invalid localStorage entry is removed, preventing the crash and allowing the component to function correctly with default values. This approach aligns with how similar JSON.parse operations are handled in other components like src/components/banner/index.tsx.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

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.

EXTRA RESOURCES

@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment May 26, 2026 9:51pm
sentry-docs Ready Ready Preview, Comment May 26, 2026 9:51pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants