Ensure Proper Cleanup of Yorkie Initialization Process

[chacha912]

What this PR does / why we need it:

This PR ensures that the Yorkie client and document are correctly detached and deactivated even if the component unmounts before the initialization finishes, preventing potential memory leaks and ensuring resource integrity.

• Added logic to handle cleanup of the Yorkie client if the component unmounts before initialization completes. (Ref: https://react.dev/learn/synchronizing-with-effects#fetching-data)
• Incorporated Yorkie cleanup within the useYorkieDocument hook to ensure comprehensive resource management.

Which issue(s) this PR fixes:

Fixes #203

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

• Refactor

  • Renamed internal variables for consistency and clarity.
  • Improved resource cleanup by introducing a mounted flag.
  • Streamlined hook dependencies for better performance and maintainability.

• Bug Fixes

  • Corrected variable names to prevent potential issues related to typos.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Walkthrough

The changes focus on refining the useYorkieDocument hook by renaming a misspelled variable, introducing a cleanup mechanism using a mounted flag, and updating the structure to remove redundant cleanup functions. The overarching goal is to ensure proper disconnection of clients when they navigate away from collaborative documents, resolving the issue of clients remaining in the list.

Changes

File Path	Change Summary
frontend/src/hooks/useYorkieDocument.ts	Renamed variable, introduced mounted flag for cleanup, adjusted useEffect dependencies, updated exported entities
frontend/src/pages/workspace/document/Index.tsx	Removed cleanUpYorkieDocument from useYorkieDocument hook return value
frontend/src/pages/workspace/document/share/Index.tsx	Removed cleanUpYorkieDocument function call and dependencies

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant App
    participant YorkieServer

    User->>Browser: Navigate to Document
    Browser->>App: Initialize useYorkieDocument Hook
    App->>YorkieServer: Connect to Document (with yorkieDocumentId)
    YorkieServer->>App: Connection Established
    
    User->>Browser: Navigate Back
    Browser->>App: Cleanup Hook
    App->>YorkieServer: Disconnect from Document
    YorkieServer->>App: Disconnection Confirmed

Loading

Assessment against linked issues

Objective (Issue)	Addressed	Explanation
When the user navigates back in the browser, the watch stream should disconnect (#203)	✅
The client should no longer appear in the client list (#203)	✅
Ensure modified useYorkieDocument does not impact other unrelated functionality (#203)	❓	Not detailed in the provided summary, would need more context to fully assess other functionalities

Poem

In the land of code, where rabbits thrive,
We refined the hooks to keep clients alive.
With yorkieDocumentId, no more typos to dread,
A mounted flag for clean exits instead.
Navigate away, no client shall stay,
Yorkie's new tune will brighten our day. 🌸🐇✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1c72c20 and 951a3bd.

Files selected for processing (3)

• frontend/src/hooks/useYorkieDocument.ts (4 hunks)
• frontend/src/pages/workspace/document/Index.tsx (2 hunks)
• frontend/src/pages/workspace/document/share/Index.tsx (2 hunks)

Files skipped from review due to trivial changes (1)

• frontend/src/pages/workspace/document/share/Index.tsx

Additional comments not posted (4)

frontend/src/pages/workspace/document/Index.tsx (1)

19-19: Well-implemented useEffect for resource cleanup.

The useEffect hook is correctly set up to handle the cleanup of the Yorkie client and document when the component unmounts. This is a crucial aspect of resource management in React, especially for external resources like those managed by Yorkie.

Also applies to: 31-31

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

31-31: Effective use of mounted flag to handle component lifecycle.

The introduction of the mounted flag to control the execution flow in asynchronous operations is a good practice. This ensures that state updates and resource cleanups are not attempted on an unmounted component, which is crucial for preventing errors and leaks in React components.

Also applies to: 60-65, 72-74

---

75-75: Correct configuration of useEffect dependencies.

The dependencies for the useEffect hook are well-chosen, ensuring that the hook only re-executes when necessary. This is important for maintaining performance and preventing unnecessary re-initializations.

---

83-83: Good encapsulation of cleanup logic.

Removing cleanUpYorkieDocument from the hook's return values simplifies the interface and ensures that cleanup logic is fully managed within the hook itself, aligning with best practices for resource management.