Add user metadata to Yorkie Client initialization

[hackerwins]

What this PR does / why we need it:

Add user metadata to Yorkie Client initialization

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• New Features

  • Enhanced real-time collaboration by integrating user-specific information into client configuration for improved performance and behavior.

• Chores

  • Removed pre-commit linting script to streamline the commit process.
  • Upgraded the core real-time collaboration dependency to a newer version, ensuring better stability and features.

[coderabbitai]

Caution

Review failed

The head commit changed during the review from c13e1b3 to fbffe7b.

Walkthrough

This pull request removes the pre-commit hook script (which handled linting for both frontend and backend) and updates the Yorkie dependency in the frontend. Additionally, the useYorkieDocument hook has been modified to retrieve user data via a new selector so that the Yorkie client can be configured with user metadata. No changes were made to any exported or public entities.

Changes

File(s)	Change Summary
.husky/pre-commit	Removed the pre-commit script that identified changed files in the frontend and backend and enforced linting via npx lint-staged before commits.
frontend/package.json	Updated the yorkie-js-sdk dependency version from 0.5.7 to 0.6.0.
frontend/src/hooks/useYorkieDocument.ts	Added a new selector (selectUser) to retrieve the user's ID. Modified createYorkieClient to accept an options object with conditional metadata including userID.

Sequence Diagram(s)

sequenceDiagram
    participant C as Component
    participant H as useYorkieDocument Hook
    participant S as Redux Store
    participant Y as Yorkie Client

    C->>H: Invoke useYorkieDocument
    H->>S: Retrieve user data (selectUser)
    S-->>H: Return userID (if available)
    H->>Y: Create Yorkie Client with { metadata: { userID } }

Loading

Possibly related PRs

• Update yorkie-js-sdk to v0.5.4 #390: Updates the yorkie-js-sdk dependency version in frontend/package.json, directly related to this PR.
• Update yorkie-js-sdk to 0.4.26 #227: Also updates the yorkie-js-sdk dependency version in frontend/package.json, closely related to the changes made here.
• Add pre-commit hook using husky for linting and formatting #281: Introduces a new pre-commit hook script with similar linting functionality, indicating a direct relationship with the script removal in this PR.

Suggested reviewers

• devleejb

Poem

I'm just a rabbit, hopping in the code,
Pre-commit gone, off the old road.
Dependencies updated with a gentle leap,
And hooks now work while you sleep.
With user metadata sprouting bright,
My furry heart bops with delight,
Happy coding—hop on to new heights!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

frontend/src/hooks/useYorkieDocument.ts (1)

54-64: Consider improving type safety and null handling.

The client initialization with user metadata is well-implemented, but could benefit from some minor improvements:

Consider these enhancements:

-		const userID = userStore.data?.id || "";
+		const userID = userStore.data?.id ?? null;
-		if (userID) {
+		if (userID !== null) {
 			opts.metadata = { userID };
 		}

This makes the null handling more explicit and maintains better type safety.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 323dc68 and 37e93a2.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (3)

• .husky/pre-commit (0 hunks)
• frontend/package.json (1 hunks)
• frontend/src/hooks/useYorkieDocument.ts (3 hunks)

💤 Files with no reviewable changes (1)

• .husky/pre-commit

✅ Files skipped from review due to trivial changes (1)

• frontend/package.json

🔇 Additional comments (2)

frontend/src/hooks/useYorkieDocument.ts (2)

11-11: LGTM!

The import of selectUser is correctly added and follows the existing import pattern.

---

24-24: LGTM!

The userStore selector is correctly implemented, following the same pattern as the existing authStore.

[devleejb]

Thank you for your contribution.