fix(docs): Guard localStorage access in restricted environments - #18917
Open
sentry[bot] wants to merge 1 commit into
Open
fix(docs): Guard localStorage access in restricted environments#18917sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
DESCRIBE YOUR PR
This PR addresses issue DOCS-A43, "TypeError: null is not an object (evaluating 'localStorage.setItem')", which occurred in browsers with restricted storage access like Safari Private Browsing and Android WebViews.
The root cause was unconditional access to
localStoragein several components, which can benullor throw aSecurityErrorupon access in these environments.Changes Made:
isLocalStorageAvailableutility (src/utils.ts): The utility now uses atry/catchblock to robustly check forlocalStorageavailability, correctly handling cases wherewindow.localStorageisnullor throws aSecurityError.isLocalStorageAvailableguard: AlllocalStorage.setItem,localStorage.getItem, andlocalStorage.removeItemcalls in the following components are now wrapped with theisLocalStorageAvailablecheck:src/components/platformSelector/index.tsxsrc/components/TopNavClient.tsxsrc/components/sidebar/MobileSidebarNav.tsxsrc/components/breadcrumbs/index.tsxThis ensures that
localStorageoperations only occur when storage is genuinely available and accessible, preventing crashes and allowing for graceful degradation in restricted contexts.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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-A43
Comment
@sentry <feedback>on this PR to have Autofix iterate on the changes.