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

feat(core): introduce atom.unstable_onInit hook #2905

Merged
merged 20 commits into from
Jan 6, 2025
Merged

Conversation

dmaskasky
Copy link
Collaborator

@dmaskasky dmaskasky commented Jan 4, 2025

Related PRs

#2888
#2801
#2901

Summary

Uses atomState change and mount hooks to schedule effect and cleanup.

Key Points

  1. Introduces atom.unstable_onInit (atom.unstable_onInit = (store: Store) => void) that fires in place when an atomState is first created in the store for that atom. store is passed as params to atom.unstable_onInit.
  2. Updates store.unstable_derive api to add a new callback param, atomOnInit. This is the interceptor for the atom.unstable_onInit api. Since getAtomState is where atom.unstable_onInit is called, we must add atomOnInit to the getAtomState params. atomOnInit accepts a store arg so that the current store is always passed.
  3. Uses atomState.h that fires in-place when an atom has mounted or unmounted, and if an atom has unmounted it schedules a cleanup to run with batch priority 0.5. Batch is a param passed to atomState.h function.
  4. Uses atomState.u that fires in-place when an atom has updated, and if an atom has updated it schedules an effect to run with batch priority 0.5. Batch is a param passed to atomState.u function.
  5. Makes batch and iterable to make flushBatch evaluation agnostic to its shape.

Check List

  • pnpm run prettier for formatting code and docs

@dmaskasky dmaskasky requested a review from dai-shi January 4, 2025 00:52
Copy link

vercel bot commented Jan 4, 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 Jan 6, 2025 3:04am

Copy link

codesandbox-ci bot commented Jan 4, 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 4, 2025

Open in Stackblitz

More templates

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

commit: 51d9e87

Copy link

github-actions bot commented Jan 4, 2025

Size Change: +204 B (+0.22%)

Total Size: 92.5 kB

Filename Size Change
./dist/esm/vanilla.mjs 4.31 kB +2 B (+0.05%)
./dist/system/vanilla.development.js 4.41 kB +5 B (+0.11%)
./dist/system/vanilla.production.js 2.23 kB +22 B (+1%)
./dist/umd/vanilla.development.js 5.79 kB +77 B (+1.35%)
./dist/umd/vanilla.production.js 2.9 kB +22 B (+0.76%)
./dist/vanilla.js 5.67 kB +76 B (+1.36%)
ℹ️ 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 864 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.57 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.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

@dmaskasky dmaskasky changed the title initial commit introduce atom.onInit hook Jan 4, 2025
Copy link

github-actions bot commented Jan 4, 2025

LiveCodes Preview in LiveCodes

Latest commit: 51d9e87
Last updated: Jan 6, 2025 3:04am (UTC)

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

See documentations for usage instructions.

src/vanilla/store.ts Outdated Show resolved Hide resolved
src/vanilla/store.ts Outdated Show resolved Hide resolved
@dmaskasky dmaskasky marked this pull request as draft January 4, 2025 01:05
src/vanilla/store.ts Outdated Show resolved Hide resolved
- move atomSyncEffect to effect.test.ts
- rename to syncEffect
- remove debug statements
- syncEffect mutates batch iterator to insert syncEffect channel
src/vanilla/store.ts Outdated Show resolved Hide resolved
src/vanilla/store.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.

I believe unstable_onInit, .h(batch) and .u(batch) are all good. They are all internal things, so let's change them later if something doesn't work.

One thing I couldn't solve is the cleanup timing on unmount. Feel free to tackle it separately.

@dai-shi dai-shi marked this pull request as ready for review January 5, 2025 23:03
@dai-shi dai-shi added this to the v2.11.1 milestone Jan 5, 2025
@dai-shi dai-shi changed the title introduce atom.onInit hook feat(core): introduce atom.unstable_onInit hook Jan 5, 2025
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.

🎉
Thanks tons for your contribution!

@dai-shi dai-shi merged commit 93f2e16 into main Jan 6, 2025
43 checks passed
@dai-shi dai-shi deleted the partial-sync-effect-6 branch January 6, 2025 03:45
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