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

Migrate state management from nanostores to jotai #1022

Merged
merged 1 commit into from
Feb 1, 2025

Conversation

tszhong0411
Copy link
Owner

@tszhong0411 tszhong0411 commented Feb 1, 2025

Description

Migrate state management from nanostores to jotai.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that doesn't fix a bug or add a feature)
  • Documentation update

Pre-flight Checklist

  • Changes are limited to a single feature, bugfix or chore (split larger changes into separate PRs)
  • pnpm check without any issues
  • I have reviewed contributor guidelines

Summary by CodeRabbit

  • Chores
    • Updated project dependencies to improve underlying state management.
  • Refactor
    • Enhanced dialog interactions across sign-in, profile dropdown, command menu, comments overlay, and sign-in components for more consistent behavior.

Copy link

linear bot commented Feb 1, 2025

APP-36 Switch to Jotai

Copy link

changeset-bot bot commented Feb 1, 2025

⚠️ No Changeset found

Latest commit: 2d7d390

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Feb 1, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 1, 2025 8:34am
honghongme ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 1, 2025 8:34am

Copy link

coderabbitai bot commented Feb 1, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/web/src/components/admin/admin-profile-dropdown.tsx

Oops! Something went wrong! :(

ESLint: 9.19.0

Error: Cannot find package '/node_modules/@tszhong0411/eslint-config/dist/index.js' imported from /eslint.config.mjs
at legacyMainResolve (node:internal/modules/esm/resolve:207:26)
at packageResolve (node:internal/modules/esm/resolve:826:14)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

apps/web/src/app/[locale]/(main)/guestbook/sign-in.tsx

Oops! Something went wrong! :(

ESLint: 9.19.0

Error: Cannot find package '/node_modules/@tszhong0411/eslint-config/dist/index.js' imported from /eslint.config.mjs
at legacyMainResolve (node:internal/modules/esm/resolve:207:26)
at packageResolve (node:internal/modules/esm/resolve:826:14)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

apps/web/src/components/command-menu.tsx

Oops! Something went wrong! :(

ESLint: 9.19.0

Error: Cannot find package '/node_modules/@tszhong0411/eslint-config/dist/index.js' imported from /eslint.config.mjs
at legacyMainResolve (node:internal/modules/esm/resolve:207:26)
at packageResolve (node:internal/modules/esm/resolve:826:14)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

  • 3 others

Walkthrough

The pull request transitions dialog state management from the nanostores library to the Jotai library. It updates the dependency configuration in the package file and revises several components to replace direct state modifications with atom-based functional updates. The change also involves renaming and removal of outdated state utilities in the central dialogs store.

Changes

File(s) Summary of Changes
apps/web/package.json Removed dependency @nanostores/react (^0.8.4) and added jotai (^2.11.3).
apps/web/src/app/[locale]/(main)/guestbook/sign-in.tsx
apps/web/src/components/admin/admin-profile-dropdown.tsx
apps/web/src/components/command-menu.tsx
apps/web/src/components/comments/unauthorized-overlay.tsx
apps/web/src/components/sign-in-dialog.tsx
Replaced nanostores state management with Jotai. Updated import statements to use useSetAtom or useAtom with dialogsAtom. Changed state updates from direct assignments (e.g., setDialogs({ signIn: true })) to functional updates that merge previous state.
apps/web/src/store/dialogs.ts Renamed type from DialogsState to Dialogs and variable dialogs to dialogsAtom. Removed the setDialogs function to reflect the shift to atom-based state management.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant Component
  participant AtomStore
  participant Dialog

  User->>Component: Clicks "Sign In" button
  Component->>AtomStore: Calls setDialogs((dialogs) => ({ ...dialogs, signIn: true }))
  AtomStore-->>Dialog: Updates state (signIn: true)
  Dialog->>User: Renders sign-in dialog
Loading
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
apps/web/src/store/dialogs.ts (1)

1-9: LGTM! Clean migration to jotai.

The migration follows jotai's best practices with proper type definitions and atom naming conventions.

Consider adding a brief JSDoc comment above the atom to document its purpose and usage pattern:

+/**
+ * Atom for managing dialog visibility states across the app.
+ * @example
+ * const setDialogs = useSetAtom(dialogsAtom)
+ * setDialogs((prev) => ({ ...prev, signIn: true }))
+ */
export const dialogsAtom = atom<Dialogs>({
  signIn: false
})
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 018719b and 2d7d390.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (7)
  • apps/web/package.json (1 hunks)
  • apps/web/src/app/[locale]/(main)/guestbook/sign-in.tsx (1 hunks)
  • apps/web/src/components/admin/admin-profile-dropdown.tsx (2 hunks)
  • apps/web/src/components/command-menu.tsx (4 hunks)
  • apps/web/src/components/comments/unauthorized-overlay.tsx (1 hunks)
  • apps/web/src/components/sign-in-dialog.tsx (2 hunks)
  • apps/web/src/store/dialogs.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: TypeScript
  • GitHub Check: ESLint
🔇 Additional comments (9)
apps/web/src/components/comments/unauthorized-overlay.tsx (1)

3-16: LGTM! Proper state update pattern.

The migration correctly uses jotai's functional update pattern to preserve existing state.

apps/web/src/app/[locale]/(main)/guestbook/sign-in.tsx (1)

5-18: LGTM! Consistent implementation.

The migration maintains consistency with other components using the same jotai patterns.

apps/web/src/components/admin/admin-profile-dropdown.tsx (1)

Line range hint 13-34: LGTM! Migration completed successfully.

The component has been properly migrated to use jotai's state management patterns.

apps/web/src/components/sign-in-dialog.tsx (3)

13-13: LGTM! Import changes align with jotai migration.

The imports have been correctly updated to use jotai instead of nanostores.

Also applies to: 18-18


50-50: LGTM! State management correctly migrated to jotai.

The implementation properly uses useAtom hook for accessing and updating the dialog state.


57-60: LGTM! Dialog state updates properly implemented.

The implementation correctly:

  • Uses functional updates to maintain state immutability
  • Preserves other dialog states using spread operator
apps/web/src/components/command-menu.tsx (2)

19-19: LGTM! Import changes align with jotai migration.

The imports have been correctly updated to use jotai's useSetAtom for write-only access to the atom state.

Also applies to: 32-32


49-49: LGTM! Dialog state updates properly implemented.

The implementation correctly:

  • Uses useSetAtom for write-only access to the atom state
  • Implements functional updates to maintain state immutability
  • Preserves other dialog states using spread operator

Also applies to: 93-93

apps/web/package.json (1)

51-51: LGTM! Dependencies updated for jotai migration.

The package.json has been correctly updated to:

  • Remove @nanostores/react dependency
  • Add jotai dependency with appropriate version

@tszhong0411 tszhong0411 merged commit 0abee6b into main Feb 1, 2025
11 checks passed
@tszhong0411 tszhong0411 deleted the app-36-switch-to-jotai branch February 1, 2025 09: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.

1 participant