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: flushPending in async write #2804

Merged
merged 8 commits into from
Nov 14, 2024
Merged

fix: flushPending in async write #2804

merged 8 commits into from
Nov 14, 2024

Conversation

dai-shi
Copy link
Member

@dai-shi dai-shi commented Nov 10, 2024

We used to have isSync in writeAtomState to conditionally flush pending, but when I did #2463, I removed it. I thought it worked without it, but the behavior wasn't something expected. This PR introduces isSync again in writeAtomSync, and also in mountAtom and unmountAtom.

Copy link

vercel bot commented Nov 10, 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 14, 2024 2:15am

Copy link

codesandbox-ci bot commented Nov 10, 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 Nov 10, 2024

Size Change: +369 B (+0.41%)

Total Size: 89.7 kB

Filename Size Change
./dist/esm/vanilla.mjs 3.78 kB +67 B (+1.8%)
./dist/system/vanilla.development.js 3.86 kB +64 B (+1.69%)
./dist/system/vanilla.production.js 2.03 kB +49 B (+2.47%)
./dist/umd/vanilla.development.js 5.1 kB +78 B (+1.55%)
./dist/umd/vanilla.production.js 2.72 kB +33 B (+1.23%)
./dist/vanilla.js 5 kB +78 B (+1.58%)
ℹ️ 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 863 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.56 kB
./dist/umd/react.production.js 934 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

Copy link

github-actions bot commented Nov 10, 2024

LiveCodes Preview in LiveCodes

Latest commit: 484b5c4
Last updated: Nov 14, 2024 2:15am (UTC)

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

See documentations for usage instructions.

Comment on lines +518 to 520
if (!isSync) {
flushPending(pending)
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Edge case: do we care if this changes the behavior a little bit for subscriber listeners?

const a = atom(0)
const w = atom(null, (get, set) => {
  console.log('before write')
  set(a, v=> v + 1)
  console.log('after write')
})
w.onMount = (setSelf) => {
  setSelf()
  console.log('after setSelf')
}
store.sub(a, () => {
  console.log('a listener fired')
})
store.sub(w, () => {})
/*
  CURRENT:
    1. 'before write'
    2. 'a listener fired'
    3. 'after write'
    4. 'after setSelf'

  NEW:
    1. 'before write'
    2. 'after write'
    3. 'after setSelf'
    4. 'a listener fired'
*/ 

Copy link
Member Author

Choose a reason for hiding this comment

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

Is it why the current test is failing?

Do you know how to make a failing test if we don't have isSync?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it why the current test is failing?

Yes

Do you know how to make a failing test if we don't have isSync?

Thinking on this more...
I think we need to keep this synchronous call to flushPending in set. Some third-party libraries depend on this behavior, so we need some way to call all subscribers.

Copy link
Member Author

Choose a reason for hiding this comment

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

Hm, I was thinking more to the opposite. "NEW" behavior seems more reasonable than "CURRENT" behavior. I'm not sure if I understand those edge cases.

Copy link
Collaborator

@dmaskasky dmaskasky Nov 10, 2024

Choose a reason for hiding this comment

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

Yes, I agree. This is better.

Hmm, it looks like atomWithObservable and atomWithStorage are not failing after all. I no longer think the behavior has changed in any significant way.

* call onmount flushPending in finally block

* temp remove unmount test cases. to be fixed later with pending injection (#2810)

* flushpending everywhere

* Apply suggestions from code review

---------

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>
Copy link
Member Author

@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.

most work is done by @dmaskasky. thanks!

@dai-shi dai-shi merged commit 6ff4eb2 into main Nov 14, 2024
40 checks passed
@dai-shi dai-shi deleted the fix/flush-pending-async branch November 14, 2024 02:20
@dai-shi dai-shi restored the fix/flush-pending-async branch November 14, 2024 02:29
@dai-shi dai-shi deleted the fix/flush-pending-async branch November 14, 2024 02:32
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