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(core): atom toString includes debugLabel in dev mode #2659

Merged
merged 2 commits into from
Jul 23, 2024

Conversation

dmaskasky
Copy link
Collaborator

Summary

const anAtom = atom(0)
anAtom.debugLabel = 'countAtom'

console.log(anAtom);
// dev: 'atom1:countAtom'
// prod: 'atom1'

Check List

  • pnpm run prettier for formatting code and docs

Copy link

vercel bot commented Jul 14, 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 Jul 23, 2024 8:53am

Copy link

codesandbox-ci bot commented Jul 14, 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 Jul 14, 2024

LiveCodes Preview in LiveCodes

Latest commit: 8fe2a7c
Last updated: Jul 23, 2024 8:52am (UTC)

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

See documentations for usage instructions.

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.

LGTM

As this conflicts with jotai-devtools hook behavior, can you open a PR there too?
We may need to coordinate the release timing, but the behavioral change is trivial, so we don't need to care much. cc @arjunvegda

@dmaskasky
Copy link
Collaborator Author

LGTM

As this conflicts with jotai-devtools hook behavior, can you open a PR there too? We may need to coordinate the release timing, but the behavioral change is trivial, so we don't need to care much. cc @arjunvegda

jotaijs/jotai-devtools#156

@dai-shi dai-shi added this to the v2.9.1 milestone Jul 14, 2024
toString: () => key,
toString() {
return import.meta.env?.MODE !== 'production' && this.debugLabel
? key + ':' + this.debugLabel
Copy link
Collaborator

Choose a reason for hiding this comment

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

Curious - why add a key with : here if a debugLabel is present? 🤔 Is it to avoid naming collisions?

Copy link
Collaborator Author

@dmaskasky dmaskasky Jul 15, 2024

Choose a reason for hiding this comment

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

Could it be to make similar with useAtomsDevtools.ts#L12?

jotaijs/jotai-devtools#156 (comment)

If we are going to centralize / change logic for useAtomsDevtools.ts#L12 anyways, then does it make sense to consider a different delimiter instead?

Copy link
Member

Choose a reason for hiding this comment

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

@arjunvegda toString must return a unique string as the use case is key={} in React. debugLabel doesn't have to be unique. So, yes, it's to avoid collisions.

@dai-shi
Copy link
Member

dai-shi commented Jul 23, 2024

Size Change: +111 B (+0.13%)

Total Size: 86.9 kB

Filename Size Change
./dist/esm/vanilla.mjs 3.81 kB +32 B (+0.85%)
./dist/system/vanilla.development.js 3.9 kB +27 B (+0.7%)
./dist/system/vanilla.production.js 2.05 kB +1 B (+0.05%)
./dist/umd/vanilla.development.js 4.89 kB +23 B (+0.47%)
./dist/vanilla.js 4.79 kB +28 B (+0.59%)
ℹ️ 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.02 kB
./dist/esm/react/utils.mjs 746 B
./dist/esm/utils.mjs 67 B
./dist/esm/vanilla/utils.mjs 4.95 kB
./dist/index.js 242 B
./dist/react.js 1.06 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.17 kB
./dist/system/react.production.js 715 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.16 kB
./dist/system/vanilla/utils.production.js 3.09 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.18 kB
./dist/umd/react.production.js 786 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.production.js 2.68 kB
./dist/umd/vanilla/utils.development.js 6.07 kB
./dist/umd/vanilla/utils.production.js 3.72 kB
./dist/utils.js 247 B
./dist/vanilla/utils.js 5.94 kB

compressed-size-action

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.

3 participants