Skip to content

Preserve error notes#1259

Merged
duckduckhero merged 6 commits intomainfrom
preserve-error-notes
Jul 31, 2025
Merged

Preserve error notes#1259
duckduckhero merged 6 commits intomainfrom
preserve-error-notes

Conversation

@duckduckhero
Copy link
Contributor

No description provided.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 31, 2025

📝 Walkthrough

Walkthrough

The changes introduce improved error handling in the enhancement mutation logic of the desktop editor, ensuring the original enhanced content is restored if an immediate error occurs and providing user feedback via toast notifications. Additionally, the enhancement system prompt now treats level 1 Markdown headings as highly important topics to preserve.

Changes

Cohort / File(s) Change Summary
Enhancement Mutation Error Handling
apps/desktop/src/components/editor-area/index.tsx
Refactored useEnhanceMutation to store and restore original enhanced content on immediate errors, handle error chunks, and display detailed error toasts.
Enhancement System Prompt Update
crates/template/assets/enhance.system.jinja
Updated prompt guideline to treat "# headings" (Markdown H1) as highly important topics to retain, instead of H3 headers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Editor
    participant useEnhanceMutation
    participant SessionStore
    participant Toast

    User->>Editor: Triggers enhancement
    Editor->>useEnhanceMutation: Start mutation
    useEnhanceMutation->>SessionStore: Get current enhanced content
    useEnhanceMutation->>useEnhanceMutation: Store original content in ref
    useEnhanceMutation->>EnhancementAPI: Stream enhancement
    alt Receives "error" chunk before any text delta
        useEnhanceMutation->>useEnhanceMutation: Restore original content from ref
        useEnhanceMutation->>Toast: Show error toast
        useEnhanceMutation-->>Editor: Abort mutation with error
    else Receives normal enhancement
        useEnhanceMutation->>Editor: Update enhanced content
    end
    alt Any error occurs
        useEnhanceMutation->>Toast: Show error toast
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch preserve-error-notes

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

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for 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.

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
Contributor

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2504756 and 9b690b5.

📒 Files selected for processing (2)
  • apps/desktop/src/components/editor-area/index.tsx (4 hunks)
  • crates/template/assets/enhance.system.jinja (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{js,ts,tsx,rs}

⚙️ CodeRabbit Configuration File

**/*.{js,ts,tsx,rs}: 1. No error handling.
2. No unused imports, variables, or functions.
3. For comments, keep it minimal. It should be about "Why", not "What".

Files:

  • apps/desktop/src/components/editor-area/index.tsx
🪛 Biome (2.1.2)
apps/desktop/src/components/editor-area/index.tsx

[error] 465-466: This code will never be reached ...

... because this statement will throw an exception beforehand

(lint/correctness/noUnreachable)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: ci (macos, macos-latest)
  • GitHub Check: ci (windows, windows-latest)
  • GitHub Check: ci
🔇 Additional comments (4)
crates/template/assets/enhance.system.jinja (1)

83-83: LGTM: Improved header importance hierarchy.

Changing from H3 headers to # headings (H1) makes logical sense, as level 1 headings are naturally more important in document hierarchy and should be preserved with higher priority.

apps/desktop/src/components/editor-area/index.tsx (3)

312-314: LGTM: Good setup for content preservation.

Adding getCurrentEnhancedContent and originalContentRef provides a clean mechanism to preserve the current enhanced content before starting a new enhancement process.


325-325: LGTM: Proper content preservation before enhancement.

Storing the original enhanced content before starting the mutation ensures it can be restored if an immediate error occurs.


416-429: LGTM: Comprehensive error feedback for users.

The error toast provides clear user feedback with both the error message and actionable guidance. The error details help with debugging while maintaining user-friendly messaging.

Copy link
Contributor

@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/desktop/src/components/editor-area/index.tsx (1)

312-313: Consider moving this inside the mutation function.

The getCurrentEnhancedContent constant captures the enhanced content at component render time, but it should capture the content when the mutation starts to ensure accuracy.

Move this line inside the mutation function at line 325:

- const getCurrentEnhancedContent = useSession(sessionId, (s) => s.session?.enhanced_memo_html ?? "");
- 
- const originalContentRef = useRef<string>("");
+ const originalContentRef = useRef<string>("");

And update line 325:

- originalContentRef.current = getCurrentEnhancedContent;
+ originalContentRef.current = useSession.getState().session?.enhanced_memo_html ?? "";
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9b690b5 and 47566eb.

📒 Files selected for processing (1)
  • apps/desktop/src/components/editor-area/index.tsx (4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{js,ts,tsx,rs}

⚙️ CodeRabbit Configuration File

**/*.{js,ts,tsx,rs}: 1. No error handling.
2. No unused imports, variables, or functions.
3. For comments, keep it minimal. It should be about "Why", not "What".

Files:

  • apps/desktop/src/components/editor-area/index.tsx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: ci (windows, windows-latest)
  • GitHub Check: ci (macos, macos-latest)
  • GitHub Check: ci
🔇 Additional comments (4)
apps/desktop/src/components/editor-area/index.tsx (4)

314-315: LGTM! Proper use of useRef for content preservation.

The ref will persist the original content across re-renders during the mutation process.


416-429: Improved error feedback with detailed toast notification.

The new error handling provides better user experience with detailed error information and dismissible toast. The error message structure is appropriate for debugging while remaining user-friendly.


460-465: Good error handling with content restoration.

The logic correctly restores the original content when an immediate error occurs (when accumulated content is empty). This preserves the user's work in case of early failures.

Note: The previous unreachable break; statement has been properly removed.


325-325: No stale-content timing issue with originalContentRef assignment

We verified that:

  • getCurrentEnhancedContent is the value returned by useSession on each render.
  • The inline mutationFn passed to useMutation is re-created on every render, so its closure always captures the up-to-date getCurrentEnhancedContent.
  • When enhance is invoked, originalContentRef.current = getCurrentEnhancedContent accurately reads the latest session content at mutation start.

No changes required here.

@duckduckhero duckduckhero merged commit e818d66 into main Jul 31, 2025
8 checks passed
@ComputelessComputer ComputelessComputer deleted the preserve-error-notes branch December 14, 2025 15:23
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