fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount #2354

benediktschlager · 2024-01-22T21:48:46Z

Related Issues or Discussions

Fixes downstream issue for https://ui.shadcn.com/
It crashes when cookies are disabled with this exception:

Summary

On Firefox accessing the property localStorage of window results in a DOMException: The operation is insecure.
This PR will handle this case gracefully and fall back to providing no storage implementation. This should be fine as we cannot store anything in a cookie-free browser.

Check List

yarn run prettier for formatting code and docs

vercel · 2024-01-22T21:48:50Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
jotai	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2024 11:16am

codesandbox-ci · 2024-01-22T21:49:17Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 76afd16:

Sandbox	Source
React	Configuration
React TypeScript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
Next.js	Configuration
Next.js with custom Babel config	Configuration
React with custom Babel config	Configuration

dai-shi

Hi! This looks like a nice improvement!
Please check comments.

src/vanilla/utils/atomWithStorage.ts

tests/react/vanilla-utils/atomWithStorage.test.tsx

dai-shi · 2024-01-23T05:36:03Z

On Firefox accessing the property localStorage of window results in a DOMException: The operation is insecure.

On Chrome, it's the same with slightly different message:
DOMException: Failed to read the 'localStorage' property from 'Window': Access is denied for this document.

dai-shi · 2024-01-24T00:06:53Z

@benediktschlager hi, are you still around?

dai-shi · 2024-01-24T10:49:25Z

src/vanilla/utils/atomWithStorage.ts

+      return window.localStorage
+    } catch (e) {
+      // Window could be undefined or local storage could be disabled
+      if (e instanceof TypeError || e instanceof DOMException) {


Hmm, this is what I tried in Node.js:

> try { window.localStorage } catch (e) { console.log(e instanceof TypeError) } false undefined > try { window.localStorage } catch (e) { console.log(e instanceof ReferenceError) } true undefined

Maybe, it's not stable. On the other hand, when is the case we want to throw e?

Oh, it seems on node the window instance is not even defined.
I'm wondering under which circumstances the window instance is not defined, but this library is used?
As far as I understand, Jotai only works alongside React?

SSR=Server Side Rendering.

benediktschlager · 2024-01-24T10:50:48Z

Hi @dai-shi, I included your feedback.
Can you check again?
Some non-required steps in the pipeline are failing.
Is this fine, or should I add a as any cast to the test to mute this error?

src/vanilla/utils/atomWithStorage.ts

tests/react/vanilla-utils/atomWithStorage.test.tsx

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>

…ies-are-disabled

dai-shi · 2024-01-24T11:10:58Z

oops, can you run prettier please?

… on mount

tests/react/vanilla-utils/atomWithStorage.test.tsx

dai-shi

Thanks for your contribution!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [jotai](https://togithub.com/pmndrs/jotai) | [`^2.6.0` -> `^2.6.4`](https://renovatebot.com/diffs/npm/jotai/2.6.0/2.6.4) | [![age](https://developer.mend.io/api/mc/badges/age/npm/jotai/2.6.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/jotai/2.6.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/jotai/2.6.0/2.6.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/jotai/2.6.0/2.6.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pmndrs/jotai (jotai)</summary> ### [`v2.6.4`](https://togithub.com/pmndrs/jotai/releases/tag/v2.6.4) [Compare Source](https://togithub.com/pmndrs/jotai/compare/v2.6.3...v2.6.4) Performance improvement! Check it out! ##### What's Changed - refactor: refactoring store and options type by [@ssi02014](https://togithub.com/ssi02014) in [pmndrs/jotai#2360 - refactor: modified Args type by [@ssi02014](https://togithub.com/ssi02014) in [pmndrs/jotai#2367 - Improve performance of recomputeDependents by [@samkline](https://togithub.com/samkline) in [pmndrs/jotai#2363 - fix(vanilla): fix unexpected cache in jotai-scope by [@yf-yang](https://togithub.com/yf-yang) in [pmndrs/jotai#2371 ##### New Contributors - [@ssi02014](https://togithub.com/ssi02014) made their first contribution in [pmndrs/jotai#2360 - [@samkline](https://togithub.com/samkline) made their first contribution in [pmndrs/jotai#2363 - [@yf-yang](https://togithub.com/yf-yang) made their first contribution in [pmndrs/jotai#2371 **Full Changelog**: pmndrs/jotai@v2.6.3...v2.6.4 ### [`v2.6.3`](https://togithub.com/pmndrs/jotai/releases/tag/v2.6.3) [Compare Source](https://togithub.com/pmndrs/jotai/compare/v2.6.2...v2.6.3) Some improvements in core and utils 👏 #### What's Changed - fix: atoms should not remount on recalculations (with async dependencies) by [@dmaskasky](https://togithub.com/dmaskasky) in [pmndrs/jotai#2347 - fix(utils): atomWithReducer for jotai-scope by [@dai-shi](https://togithub.com/dai-shi) in [pmndrs/jotai#2351 - fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount by [@benediktschlager](https://togithub.com/benediktschlager) in [pmndrs/jotai#2354 - feat(vanilla): customizable atom.unstable_is by [@dai-shi](https://togithub.com/dai-shi) in [pmndrs/jotai#2356 #### New Contributors - [@SpringHgui](https://togithub.com/SpringHgui) made their first contribution in [pmndrs/jotai#2320 - [@sakurawen](https://togithub.com/sakurawen) made their first contribution in [pmndrs/jotai#2358 - [@JoltCode](https://togithub.com/JoltCode) made their first contribution in [pmndrs/jotai#2357 - [@benediktschlager](https://togithub.com/benediktschlager) made their first contribution in [pmndrs/jotai#2354 **Full Changelog**: pmndrs/jotai@v2.6.2...v2.6.3 ### [`v2.6.2`](https://togithub.com/pmndrs/jotai/releases/tag/v2.6.2) [Compare Source](https://togithub.com/pmndrs/jotai/compare/v2.6.1...v2.6.2) Some improvements for atomWithStorage. Feedback is welcome. #### What's Changed - fix(vanilla): should mount once with atom creator atom by [@nogaten](https://togithub.com/nogaten) in [pmndrs/jotai#2319 - feat(utils): createJSONStrage options by [@dai-shi](https://togithub.com/dai-shi) in [pmndrs/jotai#2324 - feat(utils): add withStorageValidator by [@dai-shi](https://togithub.com/dai-shi) in [pmndrs/jotai#2336 #### New Contributors - [@L-Qun](https://togithub.com/L-Qun) made their first contribution in [pmndrs/jotai#2318 - [@ahme-dev](https://togithub.com/ahme-dev) made their first contribution in [pmndrs/jotai#2332 - [@nogaten](https://togithub.com/nogaten) made their first contribution in [pmndrs/jotai#2319 **Full Changelog**: pmndrs/jotai@v2.6.1...v2.6.2 ### [`v2.6.1`](https://togithub.com/pmndrs/jotai/releases/tag/v2.6.1) [Compare Source](https://togithub.com/pmndrs/jotai/compare/v2.6.0...v2.6.1) This version has two minor improvements for library authors. It's wonderful to see Jotai ecosystem growing. No major bugs have been reported lately. It's fairly okay to say the current version is pretty stable. #### What's Changed - fix(utils): add init property to the return type of atomWithReset by [@jaesoekjjang](https://togithub.com/jaesoekjjang) in [pmndrs/jotai#2304 - fix(utils): add description for the RESET symbol. by [@MiroslavPetrik](https://togithub.com/MiroslavPetrik) in [pmndrs/jotai#2307 #### New Contributors - [@wherehows](https://togithub.com/wherehows) made their first contribution in [pmndrs/jotai#2270 - [@benson00077](https://togithub.com/benson00077) made their first contribution in [pmndrs/jotai#2284 - [@ioExpander](https://togithub.com/ioExpander) made their first contribution in [pmndrs/jotai#2280 - [@jaesoekjjang](https://togithub.com/jaesoekjjang) made their first contribution in [pmndrs/jotai#2304 **Full Changelog**: pmndrs/jotai@v2.6.0...v2.6.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/likec4/likec4).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

vercel bot deployed to Preview January 22, 2024 21:49 View deployment

benediktschlager force-pushed the fix/utils/atomWithStorage-crashing-when-cookies-are-disabled branch from 6b2b122 to 545e64e Compare January 22, 2024 22:00

vercel bot deployed to Preview January 22, 2024 22:00 View deployment

dai-shi requested changes Jan 23, 2024

View reviewed changes

src/vanilla/utils/atomWithStorage.ts Outdated Show resolved Hide resolved

src/vanilla/utils/atomWithStorage.ts Outdated Show resolved Hide resolved

tests/react/vanilla-utils/atomWithStorage.test.tsx Outdated Show resolved Hide resolved

dai-shi added this to the v2.6.3 milestone Jan 23, 2024

fix(utils): defaultStorage with disabled local storage crashes on mount

007c47f

benediktschlager force-pushed the fix/utils/atomWithStorage-crashing-when-cookies-are-disabled branch from 545e64e to 007c47f Compare January 24, 2024 10:44

vercel bot deployed to Preview January 24, 2024 10:44 View deployment

dai-shi reviewed Jan 24, 2024

View reviewed changes

src/vanilla/utils/atomWithStorage.ts Outdated Show resolved Hide resolved

dai-shi reviewed Jan 24, 2024

View reviewed changes

tests/react/vanilla-utils/atomWithStorage.test.tsx Outdated Show resolved Hide resolved

benediktschlager and others added 2 commits January 24, 2024 12:03

Fix type errors for TS < 4.5

4f09fde

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>

Update src/vanilla/utils/atomWithStorage.ts

cd5054b

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>

vercel bot deployed to Preview January 24, 2024 11:04 View deployment

Merge branch 'main' into fix/utils/atomWithStorage-crashing-when-cook…

3dbd7b8

…ies-are-disabled

vercel bot deployed to Preview January 24, 2024 11:08 View deployment

fixup! fix(utils): defaultStorage with disabled local storage crashes…

e458c0e

… on mount

vercel bot deployed to Preview January 24, 2024 11:14 View deployment

dai-shi reviewed Jan 24, 2024

View reviewed changes

tests/react/vanilla-utils/atomWithStorage.test.tsx Outdated Show resolved Hide resolved

Update tests/react/vanilla-utils/atomWithStorage.test.tsx

76afd16

vercel bot deployed to Preview January 24, 2024 11:16 View deployment

dai-shi approved these changes Jan 24, 2024

View reviewed changes

dai-shi changed the title ~~fix(utils): defaultStorage with disabled local storage crashes on mount~~ fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount Jan 24, 2024

dai-shi merged commit 4f80be9 into pmndrs:main Jan 24, 2024
33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount #2354

fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount #2354

benediktschlager commented Jan 22, 2024

vercel bot commented Jan 22, 2024 •

edited

codesandbox-ci bot commented Jan 22, 2024 •

edited

dai-shi left a comment

dai-shi commented Jan 23, 2024

dai-shi commented Jan 24, 2024

dai-shi Jan 24, 2024

benediktschlager Jan 24, 2024

dai-shi Jan 24, 2024

benediktschlager commented Jan 24, 2024

dai-shi commented Jan 24, 2024

dai-shi left a comment

fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount #2354

fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount #2354

Conversation

benediktschlager commented Jan 22, 2024

Related Issues or Discussions

Summary

Check List

vercel bot commented Jan 22, 2024 • edited

codesandbox-ci bot commented Jan 22, 2024 • edited

dai-shi left a comment

Choose a reason for hiding this comment

dai-shi commented Jan 23, 2024

dai-shi commented Jan 24, 2024

dai-shi Jan 24, 2024

Choose a reason for hiding this comment

benediktschlager Jan 24, 2024

Choose a reason for hiding this comment

dai-shi Jan 24, 2024

Choose a reason for hiding this comment

benediktschlager commented Jan 24, 2024

dai-shi commented Jan 24, 2024

dai-shi left a comment

Choose a reason for hiding this comment

vercel bot commented Jan 22, 2024 •

edited

codesandbox-ci bot commented Jan 22, 2024 •

edited