[ENG-598] Data persistence for tldraw

[trangdoan982]

https://www.loom.com/share/70ce37001ff14852b52930db9f3d27be?sid=b7cf0506-9498-419a-b4cf-31ce95e93e37

Summary by CodeRabbit

• New Features

  • Enhanced editor component with improved file synchronization, automatic saving, and state recovery.
  • Editor now responds to document visibility changes for better state management.

• Bug Fixes

  • Improved error handling during save operations to prevent data loss and ensure file consistency.

• Refactor

  • Updated editor component properties for better integration and maintainability.

• Chores

  • Added new utility functions to support file content updates and data handling.

[linear]

ENG-598 Data persistence for tldraw

[trangdoan982]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce file persistence and editor state management to the Tldraw preview component. The component now receives plugin and file props, implements debounced saving of editor state to file, and manages UI/editor state synchronization. Utility functions for file content replacement and TLData updates are added, and the React root creation is guarded against missing file references.

Changes

File(s)	Change Summary
apps/obsidian/src/components/TldrawView.tsx	Modified createReactRoot to return early if this.file is undefined; passed plugin and file props to TldrawPreviewComponent.
apps/obsidian/src/components/TldrawViewComponent.tsx	Enhanced TldrawPreviewComponent with file persistence, debounced save, editor state management, and updated props interface.
apps/obsidian/src/utils/tldraw.ts	Added replaceBetweenKeywords and updateFileData utility functions; updated imports and closed createCanvas function properly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TldrawPreviewComponent
    participant FileSystem
    participant Plugin

    User->>TldrawPreviewComponent: Edit canvas
    TldrawPreviewComponent->>TldrawPreviewComponent: Debounced save triggered on change
    TldrawPreviewComponent->>FileSystem: Serialize and save editor state between delimiters
    FileSystem-->>TldrawPreviewComponent: Confirm write or return error
    alt Save error
        TldrawPreviewComponent->>FileSystem: Attempt recovery from file
    end
    User->>TldrawPreviewComponent: Visibility changes
    TldrawPreviewComponent->>TldrawPreviewComponent: Update editor focus and pen mode

Loading

Estimated code review effort

3 (~45 minutes)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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.

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

🔭 Outside diff range comments (1)

apps/obsidian/src/components/TldrawView.tsx (1)

136-150: Avoid creating unused React roots to prevent memory leaks.

Creating a React root without rendering it can lead to memory leaks. Consider returning undefined instead of the unrendered root when this.file is not available.

Apply this diff to fix the issue:

 private createReactRoot(entryPoint: Element, store: TLStore) {
+  if (!this.file) return undefined;
   const root = createRoot(entryPoint);
-  if (!this.file) return root;

   root.render(
     <React.StrictMode>
       <TldrawPreviewComponent
         store={store}
         plugin={this.plugin}
         file={this.file}
       />
     </React.StrictMode>,
   );
   return root;
 }

Then update the caller at line 184 to handle the undefined case:

const root = this.createReactRoot(container, this.store);
if (root) {
  this.reactRoot = root;
}

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3b3c292 and 071f3a2.

📒 Files selected for processing (3)

• apps/obsidian/src/components/TldrawView.tsx (1 hunks)
• apps/obsidian/src/components/TldrawViewComponent.tsx (3 hunks)
• apps/obsidian/src/utils/tldraw.ts (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

apps/obsidian/src/utils/tldraw.ts (3)

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/obsidian.mdc:0-0
Timestamp: 2025-07-19T22:34:16.794Z
Learning: Applies to apps/obsidian/package.json : Prefer existing dependencies from package.json when adding or using dependencies in the Obsidian plugin

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#0
File: :0-0
Timestamp: 2025-07-13T16:47:14.352Z
Learning: In the discourse-graph codebase, types.gen.ts contains automatically generated database function type definitions that may have reordered signatures between versions. This reordering is expected behavior from the code generation process and should not be flagged as an issue requiring fixes.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#0
File: :0-0
Timestamp: 2025-07-08T14:51:55.299Z
Learning: DiscourseGraphs maintainers prefer not to add narrowly typed definitions for individual process.env keys to avoid unnecessary coupling.

🧬 Code Graph Analysis (3)

apps/obsidian/src/components/TldrawView.tsx (1)

apps/obsidian/src/components/TldrawViewComponent.tsx (1)

• TldrawPreviewComponent (19-181)

apps/obsidian/src/utils/tldraw.ts (1)

apps/obsidian/src/index.ts (1)

• DiscourseGraphPlugin (25-287)

apps/obsidian/src/components/TldrawViewComponent.tsx (3)

apps/obsidian/src/index.ts (1)

• DiscourseGraphPlugin (25-287)

apps/obsidian/src/utils/tldraw.ts (2)

• updateFileData (136-146)
• replaceBetweenKeywords (126-134)

apps/obsidian/src/constants.ts (3)

• TLDATA_DELIMITER_START (63-64)
• TLDATA_DELIMITER_END (65-66)
• DEFAULT_SAVE_DELAY (72-72)

[mdroidian]

Changes requested in our 1:1, noted by you inline.

[mdroidian]

Good stuff.

RE: IDE linting, if you weren't seeing those lint errors we can postpone fixed them to before merge to main. But in the future let's try to fix new lint warnings that we create on the spot.

RE: package-lock.json
This is slightly concerning, as there were no package.json changes. I'm assuming this was missed from some previous PR? If not, I'd track down where these changes are coming from.

[mdroidian]

@trangdoan982 Just noticed, since we are generating a new uuid on each saveChanges, stringifiedData === lastSavedDataRef.current will always be false.