Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Not For Merge] BREAKING: unmount async dependencies #2940

Closed
wants to merge 3 commits into from

Conversation

dai-shi
Copy link
Member

@dai-shi dai-shi commented Jan 16, 2025

split from #2920

I thought it's nice to fix memory leak test, but it might not worth the breaking behavior.

We don't plan to merge this for now. We would like to collect more feedback on it, especially the failing test case not only in this repo, but also in the ecosystem. So, one of the purposes of this PR is to run jotai-ecosystem-ci to learn the effect of this breaking behavioral change.


Proposed Change In Behavior

Atom dependencies of async atoms are unmounted and remounted each time the async atom recomputes if they are accessed only after a delay. This will cause any atom.onMount and unmount functions to fire each time.

Example

const countAtom = atom(0)
countAtom.onMount = () => {
  console.log('countAtom mounted')
  return () => {
    console.log('countAtom unmounted')
  }
}

const asyncAtom = atom(async (get) => {
  await Promise.resolve()
  get(countAtom)
})

const store = createStore()

const unsub = store.sub(asyncAtom, () => {}) // mounts asyncAtom
await Promise.resolve()

console.log('set countAtom to 1')
store.set(countAtom, 1)
await Promise.resolve()

console.log('set countAtom to 2')
store.set(countAtom, 2)
await Promise.resolve()

unsub()

Current

set countAtom to 1
set countAtom to 2

New

countAtom mounted
set countAtom to 1
countAtom unmounted
countAtom mounted
set countAtom to 2
countAtom unmounted
countAtom mounted
countAtom unmounted

Copy link

vercel bot commented Jan 16, 2025

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 Feb 1, 2025 2:47am

Copy link

codesandbox-ci bot commented Jan 16, 2025

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.

Copy link

pkg-pr-new bot commented Jan 16, 2025

Open in Stackblitz

More templates

npm i https://pkg.pr.new/jotai@2940

commit: 58977b5

Copy link

github-actions bot commented Jan 16, 2025

Size Change: -158 B (-0.17%)

Total Size: 92.2 kB

Filename Size Change
./dist/esm/vanilla.mjs 4.23 kB -25 B (-0.59%)
./dist/system/vanilla.development.js 4.32 kB -27 B (-0.62%)
./dist/system/vanilla.production.js 2.2 kB -19 B (-0.86%)
./dist/umd/vanilla.development.js 5.7 kB -36 B (-0.63%)
./dist/umd/vanilla.production.js 2.86 kB -15 B (-0.52%)
./dist/vanilla.js 5.58 kB -36 B (-0.64%)
ℹ️ View Unchanged
Filename Size
./dist/babel/plugin-debug-label.js 933 B
./dist/babel/plugin-react-refresh.js 1.14 kB
./dist/babel/preset.js 1.41 kB
./dist/esm/babel/plugin-debug-label.mjs 1 kB
./dist/esm/babel/plugin-react-refresh.mjs 1.2 kB
./dist/esm/babel/preset.mjs 1.49 kB
./dist/esm/index.mjs 62 B
./dist/esm/react.mjs 1.41 kB
./dist/esm/react/utils.mjs 747 B
./dist/esm/utils.mjs 67 B
./dist/esm/vanilla/utils.mjs 5.05 kB
./dist/index.js 242 B
./dist/react.js 1.44 kB
./dist/react/utils.js 1.39 kB
./dist/system/babel/plugin-debug-label.development.js 1.11 kB
./dist/system/babel/plugin-debug-label.production.js 775 B
./dist/system/babel/plugin-react-refresh.development.js 1.3 kB
./dist/system/babel/plugin-react-refresh.production.js 928 B
./dist/system/babel/preset.development.js 1.59 kB
./dist/system/babel/preset.production.js 1.14 kB
./dist/system/index.development.js 252 B
./dist/system/index.production.js 183 B
./dist/system/react.development.js 1.56 kB
./dist/system/react.production.js 865 B
./dist/system/react/utils.development.js 859 B
./dist/system/react/utils.production.js 462 B
./dist/system/utils.development.js 257 B
./dist/system/utils.production.js 187 B
./dist/system/vanilla/utils.development.js 5.26 kB
./dist/system/vanilla/utils.production.js 3.15 kB
./dist/umd/babel/plugin-debug-label.development.js 1.07 kB
./dist/umd/babel/plugin-debug-label.production.js 852 B
./dist/umd/babel/plugin-react-refresh.development.js 1.27 kB
./dist/umd/babel/plugin-react-refresh.production.js 1 kB
./dist/umd/babel/preset.development.js 1.54 kB
./dist/umd/babel/preset.production.js 1.22 kB
./dist/umd/index.development.js 383 B
./dist/umd/index.production.js 328 B
./dist/umd/react.development.js 1.56 kB
./dist/umd/react.production.js 936 B
./dist/umd/react/utils.development.js 1.53 kB
./dist/umd/react/utils.production.js 1.01 kB
./dist/umd/utils.development.js 399 B
./dist/umd/utils.production.js 342 B
./dist/umd/vanilla/utils.development.js 6.25 kB
./dist/umd/vanilla/utils.production.js 3.78 kB
./dist/utils.js 247 B
./dist/vanilla/utils.js 6.11 kB

compressed-size-action

Copy link

github-actions bot commented Jan 16, 2025

LiveCodes Preview in LiveCodes

Latest commit: 58977b5
Last updated: Feb 1, 2025 2:45am (UTC)

Playground Link
React demo https://livecodes.io?x=id/3XGSD3649

See documentations for usage instructions.

@dai-shi dai-shi changed the title breaking: unmount async dependencies [Not For Merge Yet] breaking: unmount async dependencies Jan 16, 2025
@dmaskasky dmaskasky changed the title [Not For Merge Yet] breaking: unmount async dependencies [Not For Merge Yet] BREAKING: unmount async dependencies Jan 17, 2025
@dai-shi dai-shi changed the title [Not For Merge Yet] BREAKING: unmount async dependencies [Not For Merge] BREAKING: unmount async dependencies Feb 4, 2025
@dai-shi
Copy link
Member Author

dai-shi commented Feb 12, 2025

Let's revisit this when we plan v3.

@dai-shi dai-shi closed this Feb 12, 2025
@dai-shi dai-shi deleted the breaking/unmount-async-deps branch February 12, 2025 00:03
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.

1 participant