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.

Sign up for GitHub

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

Jump to bottom

fix: onMount setSelf does not notify listeners #2815

Merged
merged 2 commits into from
Nov 17, 2024
Merged

fix: onMount setSelf does not notify listeners #2815

merged 2 commits into from
Nov 17, 2024

Conversation

dmaskasky
Copy link
Collaborator

@dmaskasky dmaskasky commented Nov 14, 2024 •
edited
Loading

Related Bug Reports or Discussions

onMount setSelf does not notify listeners (#2810)

  • adds failing test: when changing the atom value with onMount setSelf, subscribers are not called
  • fixes failing test

Why aren't listeners called when calling setAtom in onMount?

Because the listener is added only after flushPending is called.

Fix: swap the order of flush pending and listeners.add(listener).

Why aren't listeners called when calling setAtom in onUnmount?

Because the listener is deleted before flushPending is called.

There's a logic cycle here:

  1. the listener is deleted before calling unmountAtom, because unmountAtom only processes if atomState.m.l.size === 0
  2. unmountAtom adds the onUnmount pending function
  3. flushPending calls onUnmount pending function
  4. setAtom fires in onUnmount pending function, which updates the atom
  5. subscriber doesn't fire because it was removed in 1

👉 NOTE: This is expected behavior.

Check List

  • pnpm run prettier for formatting code and docs

@vercel Vercel
Copy link

vercel bot commented Nov 14, 2024 •
edited
Loading

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 Nov 17, 2024 9:55am

@codesandbox-ci CodeSandbox CI
Copy link

codesandbox-ci bot commented Nov 14, 2024 •
edited
Loading

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.

@dmaskasky dmaskasky changed the base branch from main to fix/flush-pending-async November 14, 2024 00:18
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 14, 2024 •
edited
Loading

LiveCodes Preview in LiveCodes

Latest commit: 94b0b83
Last updated: Nov 17, 2024 9:54am (UTC)

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

See documentations for usage instructions.

@dmaskasky dmaskasky changed the title Fix/onmount setatom subscribe Fix: onMount setSelf does not notify listeners Nov 14, 2024
@dmaskasky dmaskasky changed the title Fix: onMount setSelf does not notify listeners fix/onmount setatom subscribe Nov 14, 2024
@dmaskasky dmaskasky changed the title fix/onmount setatom subscribe fix/onmount setom subscribe Nov 14, 2024
@dmaskasky dmaskasky changed the title fix/onmount setom subscribe fix/onmount setAtom subscribe Nov 14, 2024
@dmaskasky dmaskasky changed the title fix/onmount setAtom subscribe fix: onMount setSelf does not notify listeners Nov 14, 2024
@dai-shi dai-shi deleted the branch pmndrs:main November 14, 2024 02:20
@dai-shi dai-shi closed this Nov 14, 2024
@dai-shi dai-shi reopened this Nov 14, 2024
@dai-shi dai-shi changed the base branch from fix/flush-pending-async to main November 14, 2024 02:30
@dmaskasky dmaskasky force-pushed the fix/onmount-setatom-subscribe branch from 6d4221c to 371a9bf Compare November 14, 2024 18:42
@dmaskasky dmaskasky requested a review from dai-shi November 14, 2024 18:52
@dmaskasky dmaskasky force-pushed the fix/onmount-setatom-subscribe branch from 371a9bf to 57f6583 Compare November 15, 2024 23:22
@dmaskasky dmaskasky force-pushed the fix/onmount-setatom-subscribe branch from 57f6583 to 97285c5 Compare November 17, 2024 08:20
dai-shi
dai-shi approved these changes Nov 17, 2024
View reviewed changes
Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good. This is something I missed it.
The test is reasonable and the fix is surprisingly simple.

@dai-shi dai-shi added this to the v2.10.3 milestone Nov 17, 2024
@dai-shi dai-shi merged commit c41a6de into pmndrs:main Nov 17, 2024
40 checks passed
@dmaskasky dmaskasky deleted the fix/onmount-setatom-subscribe branch November 17, 2024 10:09
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Dec 23, 2024
@alexandresoro
fix(deps): update dependency jotai to v2.11.0 (#380)
85a056a 
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 [#&#8203;2782](pmndrs/jotai#2782).

#### What's Changed

-   refactor(store): rename pending to batch by [@&#8203;dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2868
-   lazy recomputeDependents by [@&#8203;dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2827
-   fix(store): robust flush batch by [@&#8203;dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2871
-   fix(store): refactor batch priority by [@&#8203;dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2875
-   feat: dev store with unstable_derive by [@&#8203;dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2852

#### New Contributors

-   [@&#8203;rainagalbiati-turngate](https://github.com/rainagalbiati-turngate) made their first contribution in pmndrs/jotai#2882
-   [@&#8203;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 [#&#8203;2789](pmndrs/jotai#2789).)

#### What's Changed

-   fix(store): do not recompute unmounted atoms eagerly by [@&#8203;dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2849

#### New Contributors

-   [@&#8203;rmillio](https://github.com/rmillio) made their first contribution in pmndrs/jotai#2832
-   [@&#8203;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 [@&#8203;dmaskasky](https://github.com/dmaskasky) ! 🎉

#### What's Changed

-   fix: flushPending in async write by [@&#8203;dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2804
-   fix: flush pending finally everywhere by [@&#8203;dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2818
-   fix: rethrow falsy errors thrown in flushPending by [@&#8203;dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2820
-   fix: setAtom uses stale pending on atom unmount by [@&#8203;dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2811
-   fix: onMount setSelf does not notify listeners by [@&#8203;dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2815
-   refactor(core): Use iterative approach in recompute dependents by [@&#8203;dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2821
-   refactor(store): prefer epoch number comparisons to indicate value change by [@&#8203;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 [@&#8203;dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2741
-   Throw error on `useAtom(undefined)` or `useAtom(null)` by [@&#8203;kevinschaich](https://github.com/kevinschaich) in pmndrs/jotai#2778
-   fix(utils): make 'loadable' update immediate after resolve by [@&#8203;e7h4n](https://github.com/e7h4n) in pmndrs/jotai#2790
-   fix(utils): make 'unwrap' update immediate after resolve by [@&#8203;organize](https://github.com/organize) in pmndrs/jotai#2794

#### New Contributors

-   [@&#8203;niklasbec](https://github.com/niklasbec) made their first contribution in pmndrs/jotai#2773
-   [@&#8203;romain-trotard](https://github.com/romain-trotard) made their first contribution in pmndrs/jotai#2781
-   [@&#8203;kretajak](https://github.com/kretajak) made their first contribution in pmndrs/jotai#2786
-   [@&#8203;Brokyeom](https://github.com/Brokyeom) made their first contribution in pmndrs/jotai#2798
-   [@&#8203;ryoku4](https://github.com/ryoku4) made their first contribution in pmndrs/jotai#2802
-   [@&#8203;yairEO](https://github.com/yairEO) made their first contribution in pmndrs/jotai#2805
-   [@&#8203;kevinschaich](https://github.com/kevinschaich) made their first contribution in pmndrs/jotai#2778
-   [@&#8203;e7h4n](https://github.com/e7h4n) made their first contribution in pmndrs/jotai#2790
-   [@&#8203;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 [@&#8203;dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2742

#### New Contributors

-   [@&#8203;vangie](https://github.com/vangie) made their first contribution in pmndrs/jotai#2753
-   [@&#8203;ts1994tw](https://github.com/ts1994tw) made their first contribution in pmndrs/jotai#2759
-   [@&#8203;KagamiChan](https://github.com/KagamiChan) made their first contribution in pmndrs/jotai#2761
-   [@&#8203;nguyenbry](https://github.com/nguyenbry) made their first contribution in pmndrs/jotai#2762
-   [@&#8203;jaycho46](https://github.com/jaycho46) made their first contribution in pmndrs/jotai#2766
-   [@&#8203;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 [@&#8203;dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2695

#### New Contributors

-   [@&#8203;sphinxrave](https://github.com/sphinxrave) made their first contribution in pmndrs/jotai#2653
-   [@&#8203;mxthxngx](https://github.com/mxthxngx) made their first contribution in pmndrs/jotai#2712
-   [@&#8203;hoangvu12](https://github.com/hoangvu12) made their first contribution in pmndrs/jotai#2716
-   [@&#8203;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.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS41Ny40IiwidXBkYXRlZEluVmVyIjoiMzkuODIuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dai-shi dai-shi dai-shi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.10.3
Development

Successfully merging this pull request may close these issues.
2 participants
@dmaskasky @dai-shi