feat(vanilla): customizable atom.unstable_is

[dai-shi]

supersedes #2353

• introduce atom.unstable_is
• make default read & write functions stable

[vercel]

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

[codesandbox-ci]

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.

Latest deployment of this branch, based on commit 2b2e3e7:

Sandbox	Source
React	Configuration
React TypeScript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
Next.js	Configuration
Next.js with custom Babel config	Configuration
React with custom Babel config	Configuration

[github-actions]

Size Change: +228 B (0%)

Total Size: 70.3 kB

Filename	Size	Change
dist/system/vanilla.development.js	4.17 kB	+47 B (+1%)
dist/system/vanilla.production.js	2.09 kB	+29 B (+1%)
dist/umd/vanilla.development.js	4.94 kB	+50 B (+1%)
dist/umd/vanilla.production.js	2.25 kB	+54 B (+2%)
dist/vanilla.js	4.86 kB	+48 B (+1%)

ℹ️ View Unchanged

Filename	Size
dist/babel/plugin-debug-label.js	907 B
dist/babel/plugin-react-refresh.js	1.14 kB
dist/babel/preset.js	1.38 kB
dist/index.js	242 B
dist/react.js	1.06 kB
dist/react/utils.js	1.26 kB
dist/system/babel/plugin-debug-label.development.js	1.09 kB
dist/system/babel/plugin-debug-label.production.js	757 B
dist/system/babel/plugin-react-refresh.development.js	1.29 kB
dist/system/babel/plugin-react-refresh.production.js	929 B
dist/system/babel/preset.development.js	1.56 kB
dist/system/babel/preset.production.js	1.13 kB
dist/system/index.development.js	253 B
dist/system/index.production.js	182 B
dist/system/react.development.js	1.18 kB
dist/system/react.production.js	711 B
dist/system/react/utils.development.js	722 B
dist/system/react/utils.production.js	461 B
dist/system/utils.development.js	258 B
dist/system/utils.production.js	188 B
dist/system/vanilla/utils.development.js	4.73 kB
dist/system/vanilla/utils.production.js	2.88 kB
dist/umd/babel/plugin-debug-label.development.js	1.06 kB
dist/umd/babel/plugin-debug-label.production.js	845 B
dist/umd/babel/plugin-react-refresh.development.js	1.28 kB
dist/umd/babel/plugin-react-refresh.production.js	1.01 kB
dist/umd/babel/preset.development.js	1.53 kB
dist/umd/babel/preset.production.js	1.24 kB
dist/umd/index.development.js	381 B
dist/umd/index.production.js	329 B
dist/umd/react.development.js	1.18 kB
dist/umd/react.production.js	785 B
dist/umd/react/utils.development.js	1.43 kB
dist/umd/react/utils.production.js	1.03 kB
dist/umd/utils.development.js	398 B
dist/umd/utils.production.js	343 B
dist/umd/vanilla/utils.development.js	5.64 kB
dist/umd/vanilla/utils.production.js	3.47 kB
dist/utils.js	246 B
dist/vanilla/utils.js	5.5 kB

_{compressed-size-action}

[dai-shi]

I thought about requiring this property rather than making it optional, but as we want to release this as a patch, let's do this.
Eventually, if it makes sense (like moving to class syntax), we can consider changing it a required property.

[yf-yang]

A scenario needs to be considered: A global atom anAtom has two copies copy1 and copy2, it is possible that copy1 internally calls set(copy2, value) (so copy1.is(copy2) should evals to true). Therefore, even with this change, we still needs to add another property in jotai-scope's intercepted copy to mark two copies as having the same original atom.

[dai-shi]

So, does it mean it requires to be is?: (self: Atom<unknown>, target: Atom<unknown>) => boolean and doesn't use this?

[yf-yang]

Well, for the jotai-scope PR, there is no need to do so.
Personally, I think the term should not be called is, as is suggests equality and equality is symmetric, while in this case it is not.
https://doc.rust-lang.org/std/cmp/trait.PartialEq.html

[dai-shi]

Hm, it doesn't seem to add any capability.
If it works, it should work with this too:

Suggested change

	is?: (self: Atom<unknown>, target: Atom<unknown>) => boolean
	is?: (this: Atom<unknown>, target: Atom<unknown>) => boolean

[dai-shi]

I feel like adding unstable_ prefix for now. 🤔

[yf-yang]

I've made jotai-scope work with commit 3185a1. Once this PR is done, I'll give it another try.

[dai-shi]

Can you actually try the csb build in jotaijs/jotai-scope#20 ?

https://ci.codesandbox.io/status/pmndrs/jotai/pr/2356/builds/463536
☝️ Find "Local Install Instructions"

I plan to merge this PR tomorrow, but it depends on other PRs in this repo.

[yf-yang]

Done, ping me when this one get merged.

[dai-shi]

@yf-yang https://www.npmjs.com/package/jotai/v/2.6.3