Wrap doc.update to ensure doc.update code is executed only once

[devleejb]

What this PR does / why we need it:
This PR wraps doc.update to ensure that the doc.update code is executed only once, preventing multiple calls to doc.update based on the number of changes.

tr.changes.iterChanges((fromA, toA, _, __, inserted) => {
  const insertText = inserted.toJSON().join("\n");

  // Wrapping doc.update to prevent multiple calls
  this._doc.update((root) => {
    root.content.edit(fromA + adj, toA + adj, insertText);
  });

  adj += insertText.length - (toA - fromA);
});

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

Additional documentation:

Checklist:

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

Summary by CodeRabbit

• Refactor
  • Improved sequence of operations during content editing and selection setting to optimize editor performance.

[coderabbitai]

Walkthrough

The recent changes focus on reordering update logic within two files to optimize the sequence of operations during document and editor updates. In yorkieSync.ts, the iterChanges method is now called within the this._doc.update method. Similarly, in YorkieIntelligenceFeature.tsx, editorStore.doc?.update and editorStore.cmView?.dispatch calls have been reordered, affecting content editing and selection handling workflows.

Changes

File Path	Summary
frontend/src/utils/yorkie/yorkieSync.ts	Reorganized iterChanges within this._doc.update method, affecting the adjustment calculation and text insertion logic.
frontend/src/components/editor/YorkieIntelligenceFeature.tsx	Reordered editorStore.doc?.update and editorStore.cmView?.dispatch calls to affect the sequence of operations during content editing and selection setting.

Poem

In the dance of code, a shift so slight,
Changes weave through day and night,
Sequence tailored, flow refined,
Yorkie’s logic redefined.
Editors now in harmony sing,
With each update, progress we bring.
🌸✨

---

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b26ed69 and d66789e.

Files selected for processing (1)

• frontend/src/utils/yorkie/yorkieSync.ts (1 hunks)

Additional comments not posted (1)

frontend/src/utils/yorkie/yorkieSync.ts (1)

102-106: Ensure proper handling of text adjustments during document updates.

The changes made to wrap iterChanges within this._doc.update are aligned with the PR objectives to ensure the document is updated atomically. However, the calculation of adj (adjustment for text changes) inside the loop might lead to incorrect indexing if multiple changes are processed. This could potentially disrupt the intended text flow in the document.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

frontend/src/components/editor/YorkieIntelligenceFeature.tsx (1)

Line range hint 193-193: Add alt text to image for accessibility.

The image element used in the InputAdornment lacks an alt attribute, which is crucial for screen reader users to understand the content.

- <img src="/yorkie.png" height={20} />
+ <img src="/yorkie.png" alt="Yorkie logo" height={20} />

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d66789e and 4ddce22.

Files selected for processing (1)

• frontend/src/components/editor/YorkieIntelligenceFeature.tsx (1 hunks)

Additional context used

Biome

frontend/src/components/editor/YorkieIntelligenceFeature.tsx

[error] 193-193: Provide a text alternative through the alt, aria-label or aria-labelledby attribute

Meaningful alternative text on elements helps users relying on screen readers to understand content's purpose within a page.

(lint/a11y/useAltText)

Additional comments not posted (1)

frontend/src/components/editor/YorkieIntelligenceFeature.tsx (1)

125-130: Ensure correct sequencing of operations in document update and dispatch.

The reordering of editorStore.doc?.update and editorStore.cmView?.dispatch is crucial to ensure that the state updates in the editor's document are reflected before any UI updates happen. This change helps in maintaining the consistency of the editor state and the view. Ensure that this change is tested thoroughly, especially in scenarios involving rapid updates to the editor content.