feat(core): add atom hooks for atom mount, unmount and improve dev store #2895

dmaskasky · 2024-12-30T07:19:18Z

Summary

Adds hooks u and h to atomState that are called in-place immediately after atom mount changes or the atomState has updated.

Check List

pnpm run prettier for formatting code and docs

vercel · 2024-12-30T07:19:22Z

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 3, 2025 0:54am

codesandbox-ci · 2024-12-30T07:19:49Z

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.

pkg-pr-new · 2024-12-30T07:20:10Z

Open in Stackblitz

More templates

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

commit: fd8dcb2

github-actions · 2024-12-30T07:20:40Z

Preview in LiveCodes

Latest commit: fd8dcb2
Last updated: Jan 3, 2025 12:53am (UTC)

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

See documentations for usage instructions.

src/vanilla/store.ts

dai-shi

Looks good to me. Thanks for the suggestion. This is much cleaner.

I'll merge this when we are ready to release another patch.

dai-shi · 2024-12-30T23:59:58Z

/ecosystem-ci run

github-actions · 2024-12-31T00:02:11Z

Ecosystem CI Output

---- Jotai Ecosystem CI Results ----
{
  "bunshi": "PASS",
  "jotai-devtools": "PASS",
  "jotai-effect": "PASS",
  "jotai-scope": "PASS"
}

dai-shi · 2025-01-02T10:36:10Z

src/vanilla/store.ts

@@ -100,6 +100,8 @@ type AtomState<Value = AnyValue> = {
  n: number
  /** Object to store mounted state of the atom. */
  m?: Mounted // only available if the atom is mounted
+  /** Listener to notify when the atom is mounted or unmounted. */
+  h?: () => void


If you want to change this with another character, we can reconsider.

How about

h?: (action: 'm' | 'u', batch: Batch) => void

'm' | 'u' doesn't look too bad even though it increases the bundle size. I'm hesitant to expose batch here, and looking for an alternative.

We may change 'h' in the future, but as this is considered internal, it's fine.

I'm hesitant to expose batch here, and looking for an alternative.

Its pretty central to syncBatch scheduling.

I'm working on it, and not sure if it's successful, but I feel like reverting this PR... Will see.

Will see.

It failed.

src/vanilla/store.ts

dai-shi · 2025-01-03T00:48:39Z

src/vanilla/store.ts

@@ -100,6 +100,8 @@ type AtomState<Value = AnyValue> = {
  n: number
  /** Object to store mounted state of the atom. */
  m?: Mounted // only available if the atom is mounted
+  /** Listener to notify when the atom is mounted or unmounted. */
+  h?: () => void


We may change 'h' in the future, but as this is considered internal, it's fine.

src/vanilla/store.ts

dai-shi

Much cleaner without Proxy hack.

dmaskasky requested a review from dai-shi December 30, 2024 07:19

dmaskasky marked this pull request as draft December 30, 2024 07:19

vercel bot deployed to Preview December 30, 2024 07:19 View deployment

dmaskasky force-pushed the sync-mount-hook branch from 15151a4 to 81b3e77 Compare December 30, 2024 23:15

vercel bot deployed to Preview December 30, 2024 23:15 View deployment

dmaskasky force-pushed the sync-mount-hook branch from 81b3e77 to a7ffc4e Compare December 30, 2024 23:45

vercel bot deployed to Preview December 30, 2024 23:46 View deployment

dai-shi reviewed Dec 30, 2024

View reviewed changes

src/vanilla/store.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview December 30, 2024 23:56 View deployment

dai-shi reviewed Dec 30, 2024

View reviewed changes

dai-shi marked this pull request as ready for review December 30, 2024 23:59

dai-shi changed the title ~~feat: add hook for atom mount and unmount~~ feat(core): add hook for atom mount and unmount and improve dev store Dec 31, 2024

dai-shi reviewed Jan 2, 2025

View reviewed changes

feat: add hook for atom mount and unmount

3223576

dmaskasky force-pushed the sync-mount-hook branch from aec1ca4 to 3223576 Compare January 2, 2025 15:53

vercel bot deployed to Preview January 2, 2025 15:54 View deployment

dmaskasky changed the title ~~feat(core): add hook for atom mount and unmount and improve dev store~~ feat(core): add atom hooks for atom mount, unmount, and update and improve dev store Jan 2, 2025

dmaskasky mentioned this pull request Jan 2, 2025

introduce atom.onInit hook #2901

Closed

1 task

dai-shi requested changes Jan 3, 2025

View reviewed changes

Apply suggestions from code review

8501f1d

vercel bot deployed to Preview January 3, 2025 00:49 View deployment

Merge branch 'main' into sync-mount-hook

fd8dcb2

dai-shi changed the title ~~feat(core): add atom hooks for atom mount, unmount, and update and improve dev store~~ feat(core): add atom hooks for atom mount, unmount and improve dev store Jan 3, 2025

vercel bot deployed to Preview January 3, 2025 00:54 View deployment

dai-shi approved these changes Jan 3, 2025

View reviewed changes

dai-shi added this to the v2.11.1 milestone Jan 3, 2025

dai-shi merged commit c1f9c3d into pmndrs:main Jan 3, 2025
42 checks passed

dai-shi mentioned this pull request Jan 3, 2025

feat(core): new dev (rev5) methods #2903

Closed

dmaskasky mentioned this pull request Jan 4, 2025

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

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): add atom hooks for atom mount, unmount and improve dev store #2895

feat(core): add atom hooks for atom mount, unmount and improve dev store #2895

dmaskasky commented Dec 30, 2024 •

edited

Loading

vercel bot commented Dec 30, 2024 •

edited

Loading

codesandbox-ci bot commented Dec 30, 2024 •

edited

Loading

pkg-pr-new bot commented Dec 30, 2024 •

edited

Loading

github-actions bot commented Dec 30, 2024 •

edited

Loading

dai-shi left a comment

dai-shi commented Dec 30, 2024

github-actions bot commented Dec 31, 2024

dai-shi Jan 2, 2025

dmaskasky Jan 2, 2025 •

edited

Loading

dai-shi Jan 2, 2025

dai-shi Jan 3, 2025

dmaskasky Jan 3, 2025

dai-shi Jan 3, 2025

dai-shi Jan 3, 2025

dai-shi Jan 3, 2025

dai-shi left a comment

feat(core): add atom hooks for atom mount, unmount and improve dev store #2895

feat(core): add atom hooks for atom mount, unmount and improve dev store #2895

Conversation

dmaskasky commented Dec 30, 2024 • edited Loading

Summary

Check List

vercel bot commented Dec 30, 2024 • edited Loading

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

pkg-pr-new bot commented Dec 30, 2024 • edited Loading

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

Preview in LiveCodes

dai-shi left a comment

Choose a reason for hiding this comment

dai-shi commented Dec 30, 2024

github-actions bot commented Dec 31, 2024

Ecosystem CI Output

dai-shi Jan 2, 2025

Choose a reason for hiding this comment

dmaskasky Jan 2, 2025 • edited Loading

Choose a reason for hiding this comment

dai-shi Jan 2, 2025

Choose a reason for hiding this comment

dai-shi Jan 3, 2025

Choose a reason for hiding this comment

dmaskasky Jan 3, 2025

Choose a reason for hiding this comment

dai-shi Jan 3, 2025

Choose a reason for hiding this comment

dai-shi Jan 3, 2025

Choose a reason for hiding this comment

dai-shi Jan 3, 2025

Choose a reason for hiding this comment

dai-shi left a comment

Choose a reason for hiding this comment

dmaskasky commented Dec 30, 2024 •

edited

Loading

vercel bot commented Dec 30, 2024 •

edited

Loading

codesandbox-ci bot commented Dec 30, 2024 •

edited

Loading

pkg-pr-new bot commented Dec 30, 2024 •

edited

Loading

github-actions bot commented Dec 30, 2024 •

edited

Loading

dmaskasky Jan 2, 2025 •

edited

Loading