fix(store): do not recompute unmounted atoms eagerly #2849

dai-shi · 2024-12-06T06:52:31Z

Another take for #2845

vercel · 2024-12-06T06:52:35Z

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	Dec 13, 2024 0:26am

codesandbox-ci · 2024-12-06T06:53:02Z

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.

github-actions · 2024-12-06T06:53:40Z

Size Change: +92 B (+0.1%)

Total Size: 90.9 kB

Filename	Size	Change
`./dist/esm/vanilla.mjs`	4.01 kB	+16 B (+0.4%)
`./dist/system/vanilla.development.js`	4.1 kB	+16 B (+0.39%)
`./dist/system/vanilla.production.js`	2.15 kB	+9 B (+0.42%)
`./dist/umd/vanilla.development.js`	5.34 kB	+17 B (+0.32%)
`./dist/umd/vanilla.production.js`	2.86 kB	+19 B (+0.67%)
`./dist/vanilla.js`	5.24 kB	+15 B (+0.29%)

ℹ️ View Unchanged

Filename	Size
`./dist/babel/plugin-debug-label.js`	932 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.19 kB
`./dist/esm/babel/preset.mjs`	1.49 kB
`./dist/esm/index.mjs`	62 B
`./dist/esm/react.mjs`	1.4 kB
`./dist/esm/react/utils.mjs`	746 B
`./dist/esm/utils.mjs`	67 B
`./dist/esm/vanilla/utils.mjs`	5.04 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.1 kB
`./dist/system/babel/plugin-debug-label.production.js`	775 B
`./dist/system/babel/plugin-react-refresh.development.js`	1.29 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`	860 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.25 kB
`./dist/system/vanilla/utils.production.js`	3.14 kB
`./dist/umd/babel/plugin-debug-label.development.js`	1.08 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`	934 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.24 kB
`./dist/umd/vanilla/utils.production.js`	3.78 kB
`./dist/utils.js`	247 B
`./dist/vanilla/utils.js`	6.1 kB

_{compressed-size-action}

github-actions · 2024-12-06T06:53:55Z

Preview in LiveCodes

Latest commit: 1f9a601
Last updated: Dec 13, 2024 12:26am (UTC)

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

See documentations for usage instructions.

dai-shi · 2024-12-06T07:18:22Z

tests/vanilla/memoryleaks.test.ts

+describe('test memory leaks (dependencies)', () => {
+  it('atom only read in write function (without mounting)', async () => {
+    // https://github.com/pmndrs/jotai/discussions/2789
+    let a: PrimitiveAtom<{ count: number; obj: object }> | undefined = atom({
+      count: 0,
+      obj: {},
+    })
+    const b = atom((get) => get(a!).count)
+    const w = atom(null, (get, set) => {
+      const bValue = get(b)
+      set(a!, (prev) => ({ ...prev, count: bValue + 1 }))
+    })
+    const store = createStore()
+    const detector = new LeakDetector(store.get(a).obj)
+    store.set(w)
+    a = undefined
+    expect(await detector.isLeaking()).toBe(false)
+  })
+
+  it('atom only read in write function (with mounting)', async () => {
+    // https://github.com/pmndrs/jotai/discussions/2789
+    let a: PrimitiveAtom<{ count: number; obj: object }> | undefined = atom({
+      count: 0,
+      obj: {},
+    })
+    const b = atom((get) => get(a!).count)
+    const c = atom((get) => get(a!).count)
+    const w = atom(null, (get, set) => {
+      const bValue = get(b)
+      set(a!, (prev) => ({ ...prev, count: bValue + 1 }))
+    })
+    const store = createStore()
+    const detector = new LeakDetector(store.get(a).obj)
+    let unsub: (() => void) | undefined = store.sub(c, () => {}) // mounts c,a
+    store.set(w)
+    unsub()
+    unsub = undefined
+    a = undefined
+    expect(await detector.isLeaking()).toBe(false)
+  })
+})


@dmaskasky Does your branch #2845 pass these tests, right?

Yes, all tests pass.

dmaskasky · 2024-12-06T08:28:58Z

src/vanilla/store.ts

-      dependents.set(a, getAtomState(a))
+      const aState = getAtomState(a)
+      if (aState.m) {
+        dependents.set(a, aState)


Could you clarify this section? What specific behavior are you aiming to achieve here?

As getMountedOrPendingDependents says, it doesn't return unmounted atoms because for unmounted atoms, we check "dependencies" in readAtomState.

dai-shi · 2024-12-06T08:38:36Z

tests/vanilla/dependency.test.tsx

+it('can cache reading an atom in write function (without mounting)', () => {
+  let aReadCount = 0
+  const a = atom(() => {
+    ++aReadCount
+    return 'a'
+  })
+  const w = atom(null, (get) => get(a))
+  const store = createStore()
+  store.set(w)
+  expect(aReadCount).toBe(1)
+  store.set(w)
+  expect(aReadCount).toBe(1)
+})
+
+it('can cache reading an atom in write function (with mounting)', () => {
+  let aReadCount = 0
+  const a = atom(() => {
+    ++aReadCount
+    return 'a'
+  })
+  const w = atom(null, (get) => get(a))
+  const store = createStore()
+  store.sub(a, () => {}) // mounts a
+  store.set(w)
+  expect(aReadCount).toBe(1)
+  store.set(w)
+  expect(aReadCount).toBe(1)
+})


Does #2845 pass these too?

Yes, #2845 passes all tests.

Let me cherry-pick 753af9f in #2845.

dai-shi · 2024-12-06T11:18:34Z

I guess the two tests

"can cache reading an atom in write function"
"atom only read in write function"

are conflicting. So, it's a trade-off and our design choice.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [jotai](https://github.com/pmndrs/jotai) | dependencies | minor | [`2.9.3` -> `2.11.0`](https://renovatebot.com/diffs/npm/jotai/2.9.3/2.11.0) | --- ### Release Notes <details> <summary>pmndrs/jotai (jotai)</summary> ### [`v2.11.0`](https://github.com/pmndrs/jotai/releases/tag/v2.11.0) [Compare Source](pmndrs/jotai@v2.10.4...v2.11.0) There are no public API changes, but some internal behaviors have been improved. Now, atom updates are batched in a single write, which might provide a performance benefit in certain edge cases. This feature has been requested actually for a long time, and it's finally implemented. See also [#2782](pmndrs/jotai#2782). #### What's Changed - refactor(store): rename pending to batch by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2868 - lazy recomputeDependents by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2827 - fix(store): robust flush batch by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2871 - fix(store): refactor batch priority by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2875 - feat: dev store with unstable_derive by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2852 #### New Contributors - [@rainagalbiati-turngate](https://github.com/rainagalbiati-turngate) made their first contribution in pmndrs/jotai#2882 - [@leweyse](https://github.com/leweyse) made their first contribution in pmndrs/jotai#2883 **Full Changelog**: pmndrs/jotai@v2.10.4...v2.11.0 ### [`v2.10.4`](https://github.com/pmndrs/jotai/releases/tag/v2.10.4) [Compare Source](pmndrs/jotai@v2.10.3...v2.10.4) A minor improvement for some edge cases. (For more information, see [#2789](pmndrs/jotai#2789).) #### What's Changed - fix(store): do not recompute unmounted atoms eagerly by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2849 #### New Contributors - [@rmillio](https://github.com/rmillio) made their first contribution in pmndrs/jotai#2832 - [@sukvvon](https://github.com/sukvvon) made their first contribution in pmndrs/jotai#2851 **Full Changelog**: pmndrs/jotai@v2.10.3...v2.10.4 ### [`v2.10.3`](https://github.com/pmndrs/jotai/releases/tag/v2.10.3) [Compare Source](pmndrs/jotai@v2.10.2...v2.10.3) This fixes various edge cases. Huge thanks to [@dmaskasky](https://github.com/dmaskasky) ! 🎉 #### What's Changed - fix: flushPending in async write by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2804 - fix: flush pending finally everywhere by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2818 - fix: rethrow falsy errors thrown in flushPending by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2820 - fix: setAtom uses stale pending on atom unmount by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2811 - fix: onMount setSelf does not notify listeners by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2815 - refactor(core): Use iterative approach in recompute dependents by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2821 - refactor(store): prefer epoch number comparisons to indicate value change by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2828 **Full Changelog**: pmndrs/jotai@v2.10.2...v2.10.3 ### [`v2.10.2`](https://github.com/pmndrs/jotai/releases/tag/v2.10.2) [Compare Source](pmndrs/jotai@v2.10.1...v2.10.2) Fixed some jotai/utils for a regression in v2.10.0. #### What's Changed - fix(unstable_derive): trap atom methods by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2741 - Throw error on `useAtom(undefined)` or `useAtom(null)` by [@kevinschaich](https://github.com/kevinschaich) in pmndrs/jotai#2778 - fix(utils): make 'loadable' update immediate after resolve by [@e7h4n](https://github.com/e7h4n) in pmndrs/jotai#2790 - fix(utils): make 'unwrap' update immediate after resolve by [@organize](https://github.com/organize) in pmndrs/jotai#2794 #### New Contributors - [@niklasbec](https://github.com/niklasbec) made their first contribution in pmndrs/jotai#2773 - [@romain-trotard](https://github.com/romain-trotard) made their first contribution in pmndrs/jotai#2781 - [@kretajak](https://github.com/kretajak) made their first contribution in pmndrs/jotai#2786 - [@Brokyeom](https://github.com/Brokyeom) made their first contribution in pmndrs/jotai#2798 - [@ryoku4](https://github.com/ryoku4) made their first contribution in pmndrs/jotai#2802 - [@yairEO](https://github.com/yairEO) made their first contribution in pmndrs/jotai#2805 - [@kevinschaich](https://github.com/kevinschaich) made their first contribution in pmndrs/jotai#2778 - [@e7h4n](https://github.com/e7h4n) made their first contribution in pmndrs/jotai#2790 - [@organize](https://github.com/organize) made their first contribution in pmndrs/jotai#2794 **Full Changelog**: pmndrs/jotai@v2.10.1...v2.10.2 ### [`v2.10.1`](https://github.com/pmndrs/jotai/releases/tag/v2.10.1) [Compare Source](pmndrs/jotai@v2.10.0...v2.10.1) This fixes a bug in an extreme edge case. If you find this change breaks something, please report to us. #### What's Changed - fix(core): recompute dependents in edge cases by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2742 #### New Contributors - [@vangie](https://github.com/vangie) made their first contribution in pmndrs/jotai#2753 - [@ts1994tw](https://github.com/ts1994tw) made their first contribution in pmndrs/jotai#2759 - [@KagamiChan](https://github.com/KagamiChan) made their first contribution in pmndrs/jotai#2761 - [@nguyenbry](https://github.com/nguyenbry) made their first contribution in pmndrs/jotai#2762 - [@jaycho46](https://github.com/jaycho46) made their first contribution in pmndrs/jotai#2766 - [@midzdotdev](https://github.com/midzdotdev) made their first contribution in pmndrs/jotai#2767 **Full Changelog**: pmndrs/jotai@v2.10.0...v2.10.1 ### [`v2.10.0`](https://github.com/pmndrs/jotai/releases/tag/v2.10.0) [Compare Source](pmndrs/jotai@v2.9.3...v2.10.0) It comes with another significant internal change to address some edge cases. Since v2.9.0, we've been working on some internal refactors to support more edge cases and clean up the code. Users are encouraged to update to the new versions eventually, but if you're satisfied with the current situation and prefer to avoid temporary instability, you can stick with v2.8.4 for now. #### What's Changed - breaking(core): avoid continuable promise in store api by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2695 #### New Contributors - [@sphinxrave](https://github.com/sphinxrave) made their first contribution in pmndrs/jotai#2653 - [@mxthxngx](https://github.com/mxthxngx) made their first contribution in pmndrs/jotai#2712 - [@hoangvu12](https://github.com/hoangvu12) made their first contribution in pmndrs/jotai#2716 - [@YuHyeonWook](https://github.com/YuHyeonWook) made their first contribution in pmndrs/jotai#2734 **Full Changelog**: pmndrs/jotai@v2.9.3...v2.10.0 </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 [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/380 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>

dmaskasky and others added 3 commits December 4, 2024 23:23

test: it can read in write fns w/o changing deps

6258681

add more tests

f595dd0

a possible fix

1ee3fad

dai-shi commented Dec 6, 2024

View reviewed changes

dmaskasky reviewed Dec 6, 2024

View reviewed changes

dai-shi commented Dec 6, 2024

View reviewed changes

dai-shi added 2 commits December 11, 2024 19:29

revert memory leak test

41358dd

Merge branch 'main' into fix/deep-peek-2

5c3d99f

dai-shi changed the title ~~alternate approach for #2845~~ fix(store): do not recompute unmounted atoms eagerly Dec 11, 2024

dai-shi marked this pull request as ready for review December 11, 2024 10:32

vercel bot deployed to Preview December 11, 2024 10:32 View deployment

dai-shi mentioned this pull request Dec 11, 2024

deep peek in write function #2845

Closed

1 task

dai-shi added this to the v2.10.4 milestone Dec 11, 2024

Merge branch 'main' into fix/deep-peek-2

1f9a601

vercel bot deployed to Preview December 13, 2024 00:26 View deployment

dai-shi merged commit b50caee into main Dec 13, 2024
40 checks passed

dai-shi deleted the fix/deep-peek-2 branch December 13, 2024 00:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(store): do not recompute unmounted atoms eagerly #2849

fix(store): do not recompute unmounted atoms eagerly #2849

dai-shi commented Dec 6, 2024 •

edited

Loading

vercel bot commented Dec 6, 2024 •

edited

Loading

codesandbox-ci bot commented Dec 6, 2024 •

edited

Loading

github-actions bot commented Dec 6, 2024 •

edited

Loading

github-actions bot commented Dec 6, 2024 •

edited

Loading

dai-shi Dec 6, 2024

dmaskasky Dec 6, 2024

dmaskasky Dec 6, 2024

dai-shi Dec 6, 2024 •

edited

Loading

dai-shi Dec 6, 2024

dmaskasky Dec 7, 2024

dai-shi Dec 7, 2024

dai-shi commented Dec 6, 2024

fix(store): do not recompute unmounted atoms eagerly #2849

fix(store): do not recompute unmounted atoms eagerly #2849

Conversation

dai-shi commented Dec 6, 2024 • edited Loading

vercel bot commented Dec 6, 2024 • edited Loading

codesandbox-ci bot commented Dec 6, 2024 • edited Loading

github-actions bot commented Dec 6, 2024 • edited Loading

github-actions bot commented Dec 6, 2024 • edited Loading

Preview in LiveCodes

dai-shi Dec 6, 2024

Choose a reason for hiding this comment

dmaskasky Dec 6, 2024

Choose a reason for hiding this comment

dmaskasky Dec 6, 2024

Choose a reason for hiding this comment

dai-shi Dec 6, 2024 • edited Loading

Choose a reason for hiding this comment

dai-shi Dec 6, 2024

Choose a reason for hiding this comment

dmaskasky Dec 7, 2024

Choose a reason for hiding this comment

dai-shi Dec 7, 2024

Choose a reason for hiding this comment

dai-shi commented Dec 6, 2024

dai-shi commented Dec 6, 2024 •

edited

Loading

vercel bot commented Dec 6, 2024 •

edited

Loading

codesandbox-ci bot commented Dec 6, 2024 •

edited

Loading

github-actions bot commented Dec 6, 2024 •

edited

Loading

github-actions bot commented Dec 6, 2024 •

edited

Loading

dai-shi Dec 6, 2024 •

edited

Loading