Notification When Recording Fails

[plyght]

fixes #713

[coderabbitai]

📝 Walkthrough

Walkthrough

A new toast notification for recording start failures was introduced, providing user feedback and a shortcut to open settings. The ongoing session store was updated to accept a callback for handling recording start failures, which is invoked when such an error occurs. Main application logic now connects these components.

Changes

File(s)	Change Summary
apps/desktop/src/components/toast/shared.tsx	Added recordingStartFailedToast function for displaying a specific toast on recording errors.
apps/desktop/src/main.tsx	Imported and wired recordingStartFailedToast to session store's failure callback.
packages/utils/src/stores/ongoing-session.ts	Extended store to accept callbacks; invokes onRecordingStartFailed on recording start errors.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OngoingSessionStore
    participant ToastUI
    participant SettingsWindow

    User->>OngoingSessionStore: Start Recording
    OngoingSessionStore->>OngoingSessionStore: Attempt to start session
    OngoingSessionStore-->>OngoingSessionStore: Failure occurs
    OngoingSessionStore->>ToastUI: Call recordingStartFailedToast()
    ToastUI->>User: Show "Recording could not be started" toast with "Open Settings" button
    User->>ToastUI: Click "Open Settings"
    ToastUI->>SettingsWindow: Open settings window
    ToastUI->>ToastUI: Dismiss toast

Loading

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3b5823a and b781f37.

📒 Files selected for processing (3)

• apps/desktop/src/components/toast/shared.tsx (1 hunks)
• apps/desktop/src/main.tsx (2 hunks)
• packages/utils/src/stores/ongoing-session.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.{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".

**/*.{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".

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

• apps/desktop/src/main.tsx
• packages/utils/src/stores/ongoing-session.ts
• apps/desktop/src/components/toast/shared.tsx

🧬 Code Graph Analysis (2)

apps/desktop/src/main.tsx (2)

packages/utils/src/stores/ongoing-session.ts (1)

• createOngoingSessionStore (44-234)

apps/desktop/src/components/toast/shared.tsx (1)

• recordingStartFailedToast (135-157)

apps/desktop/src/components/toast/shared.tsx (2)

packages/ui/src/components/ui/toast.tsx (2)

• sonnerToast (6-6)
• toast (67-86)

packages/ui/src/components/ui/button.tsx (1)

• Button (37-89)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: ci (windows, windows-latest)
• GitHub Check: ci (macos, macos-latest)

🔇 Additional comments (6)

apps/desktop/src/components/toast/shared.tsx (1)

135-157: Well-implemented toast function following established patterns.

The recordingStartFailedToast function correctly follows the same structure and conventions as the existing enhanceFailedToast function. The 5-second duration is appropriate for an error notification, and the settings button provides a clear action path for users to resolve the issue.

apps/desktop/src/main.tsx (2)

11-11: Import properly added.

The import follows the existing pattern and is correctly used in the store callback.

---

48-52: Clean callback integration with appropriate error handling.

The callback structure is correct and provides good separation of concerns. The error parameter is available if you later decide to make the toast message more specific based on the error details.

packages/utils/src/stores/ongoing-session.ts (3)

40-42: Well-defined callback type.

The OngoingSessionCallbacks type is appropriately structured with optional properties, allowing for future extension while maintaining backward compatibility.

---

44-47: Backward-compatible function signature update.

The optional callbacks parameter maintains backward compatibility while enabling the new error handling functionality.

---

141-144: Proper callback invocation with error context.

The callback is correctly guarded with optional chaining and passes the error context, enabling flexible error handling. The comment appropriately explains the purpose.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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:

‼️ 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 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.