Skip to content

fix(docs): Handle malformed URI in Table of Contents hash decoding - #19638

Open
sentry[bot] wants to merge 1 commit into
masterfrom
seer/fix-toc-uri-error
Open

sentry[bot] wants to merge 1 commit into
masterfrom
seer/fix-toc-uri-error

Conversation

@sentry

@sentry sentry Bot commented Sep 25, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

This PR addresses an URIError: URI malformed that occurred when the Table of Contents component attempted to decode a URL fragment containing invalid percent-encoding. This typically happened when an unsubstituted documentation template variable, such as #dsn%SENTRY_ENVIRONMENT, was present in the URL hash.

The decodeURIComponent function would throw an error because %S is not a valid hex escape sequence.

Changes:

  • Wrapped the decodeURIComponent call in src/components/tableOfContents.tsx within a try-catch block. If a URIError occurs, it now falls back to using the raw hash value, preventing the application from crashing.
  • Added a new test file src/components/tableOfContents.test.ts to specifically cover cases of valid, invalid, and empty URL fragments, ensuring the decoding logic behaves as expected without throwing errors.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

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

Fixes DOCS-B9J

@sentry <feedback>: Autofix iterates on these changes
@sentry stop iterating: Autofix stops iterating on this run

This PR was automatically generated by Sentry. You can adjust this setting at any time.

@vercel

vercel Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Sep 25, 2026 10:52pm UTC
sentry-docs Ready Ready Preview Sep 25, 2026 10:52pm UTC

Request Review

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — fde8d905 Deployed Sep 25, 2026 by vercel[bot]
Preview – develop-docs — fde8d905 Deployed Sep 25, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants