test(dependency): Improve test coverage #2759

ts1994tw · 2024-10-02T05:36:54Z

Summary

This pull request enhances the test suite for Jotai's dependency management, particularly focusing on complex scenarios. The following improvement has been made:

New Test Cases

Complex Dependency Chains
- Introduced a test case that verifies Jotai's ability to handle and update complex chains of derived atoms, including async derivations.

Coverage Improvements

Multi-level Derivations: Verifies that updates properly propagate through multiple levels of derived atoms, including async operations.

Check List

pnpm run prettier for formatting code and docs

Appreciated for having me your time on reviewing changes.

vercel · 2024-10-02T05:36:57Z

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	Oct 3, 2024 5:13am

codesandbox-ci · 2024-10-02T05:37:24Z

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-10-02T05:41:09Z

Preview in LiveCodes

Latest commit: cefd207
Last updated: Oct 3, 2024 5:12am (UTC)

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

See documentations for usage instructions.

dai-shi

Thanks for working on this.
Here are some comments.

dai-shi · 2024-10-02T13:19:48Z

tests/vanilla/dependency.test.tsx

+it('handles errors in async atoms', async () => {
+  const errorAtom = atom(async () => {
+    throw new Error('Test error')
+  })
+
+  const store = createStore()
+
+  await expect(store.get(errorAtom)).rejects.toThrow('Test error')
+})


This doesn't seem a dependency test. Maybe move to some other file?

@dai-shi Appreciated for comments.

You're absolutely right, it should be moved out of here. These changes have been removed from this pull request at this moment, after that, this pull request will be goal-focused enough and for dependency test only. Descriptions for this pull request has been updated as well already.

dai-shi · 2024-10-02T13:20:24Z

tests/vanilla/dependency.test.tsx

+  const derived2 = atom((get) => get(derived1) + 1)
+  const asyncDerived = atom(async (get) => {
+    const value = get(derived2)
+    await new Promise((resolve) => setTimeout(resolve, 10))


We don't use timers in the test.
Please do something like this:

jotai/tests/vanilla/dependency.test.tsx

Line 11 in 9bd8ed7

await new Promise<void>((r) => (resolve = r))

@dai-shi Appreciated for indication and 6186a57 is adjustment which follows comment here.

dai-shi · 2024-10-02T13:23:06Z

tests/vanilla/dependency.test.tsx

+  const atoms = new Array(1000).fill(null).map((_, i) => atom(i))
+  const derivedAtom = atom((get) => atoms.reduce((sum, a) => sum + get(a), 0))
+
+  const start = performance.now()


Hmm, I don't think we do performance tests in our unit tests.
Can you try something with ./benchmarks? It's not a test that runs on CI, but you can try more complex cases and share the result in a discussion.

I think the existing benchmark suite also needs some refinement. I did some resource tracking a while back and memory consumption was not lining up with what I thought the tests are testing for

I think the existing benchmark suite also needs some refinement.

I actually agree. Not just refinement, you can create a brand new benchmark suite. We can even delete existing one, if yours covers it. That would be pretty helpful.

@backbone87 Appreciated for sharing detections you noticed before. @dai-shi I prefer to leave this topic aside and it should be independently handled by another clear and goal-focused pull request. These changes have been removed at this moment. 🙇

dai-shi

Thanks for your contribution.

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>

ts1994tw added 3 commits October 2, 2024 14:30

feat: add test for scenario: Error Handling in Async Atoms

8f5079d

feat: add test for scenario: Complex Dependency Chains

d7ccef1

feat: add test for scenario: Performance with Large Number of Atoms

d97976b

vercel bot deployed to Preview October 2, 2024 05:38 View deployment

dai-shi requested changes Oct 2, 2024

View reviewed changes

ts1994tw added 3 commits October 3, 2024 14:10

fix: remove unnecessary test

dcf9aa5

refactor: adjust test for scenario: Complex Dependency Chains

6186a57

fix: remove unnecessary test scenario

cefd207

vercel bot deployed to Preview October 3, 2024 05:13 View deployment

ts1994tw requested review from dai-shi and backbone87 October 3, 2024 05:21

dai-shi approved these changes Oct 3, 2024

View reviewed changes

dai-shi merged commit d5bb477 into pmndrs:main Oct 3, 2024
40 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test(dependency): Improve test coverage #2759

test(dependency): Improve test coverage #2759

ts1994tw commented Oct 2, 2024 •

edited

Loading

vercel bot commented Oct 2, 2024 •

edited

Loading

codesandbox-ci bot commented Oct 2, 2024 •

edited

Loading

github-actions bot commented Oct 2, 2024 •

edited

Loading

dai-shi left a comment

dai-shi Oct 2, 2024

ts1994tw Oct 3, 2024 •

edited

Loading

dai-shi Oct 2, 2024

ts1994tw Oct 3, 2024 •

edited

Loading

dai-shi Oct 2, 2024

backbone87 Oct 2, 2024

dai-shi Oct 2, 2024

ts1994tw Oct 3, 2024 •

edited

Loading

dai-shi left a comment

test(dependency): Improve test coverage #2759

test(dependency): Improve test coverage #2759

Conversation

ts1994tw commented Oct 2, 2024 • edited Loading

Summary

New Test Cases

Coverage Improvements

Check List

vercel bot commented Oct 2, 2024 • edited Loading

codesandbox-ci bot commented Oct 2, 2024 • edited Loading

github-actions bot commented Oct 2, 2024 • edited Loading

Preview in LiveCodes

dai-shi left a comment

Choose a reason for hiding this comment

dai-shi Oct 2, 2024

Choose a reason for hiding this comment

ts1994tw Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

dai-shi Oct 2, 2024

Choose a reason for hiding this comment

ts1994tw Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

dai-shi Oct 2, 2024

Choose a reason for hiding this comment

backbone87 Oct 2, 2024

Choose a reason for hiding this comment

dai-shi Oct 2, 2024

Choose a reason for hiding this comment

ts1994tw Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

dai-shi left a comment

Choose a reason for hiding this comment

ts1994tw commented Oct 2, 2024 •

edited

Loading

vercel bot commented Oct 2, 2024 •

edited

Loading

codesandbox-ci bot commented Oct 2, 2024 •

edited

Loading

github-actions bot commented Oct 2, 2024 •

edited

Loading

ts1994tw Oct 3, 2024 •

edited

Loading

ts1994tw Oct 3, 2024 •

edited

Loading

ts1994tw Oct 3, 2024 •

edited

Loading