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

fix(utils): make 'loadable' update immediate after resolve #2790

Merged
merged 3 commits into from
Nov 11, 2024

Conversation

e7h4n
Copy link
Contributor

@e7h4n e7h4n commented Oct 31, 2024

Summary

This commit aims to update the Loadable state derived from loadable immediately after the Promise resolves.

The original code used the following approach to update the loadable cache, which resulted in a delay of one tick for the cache update:

export function loadable<Value>(anAtom: Atom<Value>): Atom<Loadable<Value>> {
  return memo1(() => {
    // ...
    const derivedAtom = atom(
      (get, { setSelf }) => {
        get(refreshAtom);
        // ...
        promise
          .then(
              // ...
          )
          .finally(setSelf); // <---------- Note that here, .finally is applied to the Promise derived from .then(), not the original promise itself.
        // ...
      },
      (_get, set) => {
        set(refreshAtom, (c) => c + 1);
      },
    );
    // ...
    return atom((get) => get(derivedAtom));
  }, anAtom);
}

The use of .finally as shown above causes the following case to fail:

const delayPromise = new Promise((r) => setTimeout(r, 10));
const store = createStore();
const asyncAtom = atom(delayPromise);
const loadableAtom = loadable(asyncAtom);

await store.get(asyncAtom);

expect(store.get(loadableAtom).state).toBe('hasData'); // <---- Error: it's still loading, although asyncAtom has been resolved.

To resolve this issue, setSelf needs to be executed within the .then() callback.

Check List

  • Ran pnpm run prettier for formatting code and documentation.

Copy link

vercel bot commented Oct 31, 2024

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 11, 2024 11:06am

Copy link

codesandbox-ci bot commented Oct 31, 2024

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

github-actions bot commented Oct 31, 2024

LiveCodes Preview in LiveCodes

Latest commit: 2d1b390
Last updated: Nov 11, 2024 11:05am (UTC)

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

See documentations for usage instructions.

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.

This is nice catch!

src/vanilla/utils/loadable.ts Show resolved Hide resolved
tests/vanilla/utils/loadable.test.ts Outdated Show resolved Hide resolved
tests/vanilla/utils/loadable.test.ts Outdated Show resolved Hide resolved
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.

LGTM. I'll merge this when we prepare the next version.

@dai-shi dai-shi merged commit c883763 into pmndrs:main Nov 11, 2024
39 checks passed
dmaskasky pushed a commit to dmaskasky/jotai that referenced this pull request Nov 14, 2024
* fix(utils): make 'loadable' update immediate after resolve

* fix comments in pmndrs#2790

---------

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>
alexandresoro pushed a commit to alexandresoro/ouca-backend that referenced this pull request Dec 23, 2024
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants