Screen capture: break with errors instead of panicking

[Brendonovich]

Summary by CodeRabbit

• Bug Fixes
  • Improved error handling in screen capture sources to provide clearer error messages when failures occur, instead of silently failing or crashing.
  • Errors during screen capture are now reported more consistently, allowing for better troubleshooting and stability.

[coderabbitai]

Walkthrough

The changes revise error handling in the screen capture source implementation, updating the control flow to propagate errors as ControlFlow::Break(Err(String)) instead of logging, panicking, or breaking silently. Function and method signatures are adjusted to reflect this, ensuring error information is consistently returned for upstream handling.

Changes

Cohort / File(s)	Change Summary
Screen Capture Error Handling & Control Flow crates/media/src/sources/screen_capture.rs	Updated error handling to propagate errors as ControlFlow::Break(Err(String)). Adjusted function and method signatures to reflect new error propagation. Errors are now logged explicitly when breaking from loops.

Sequence Diagram(s)

sequenceDiagram
    participant Upstream
    participant ScreenCaptureSource
    participant Capturer

    Upstream->>ScreenCaptureSource: run(clock, ready_signal, control_signal)
    ScreenCaptureSource->>Capturer: get_frame()
    alt Success
        Capturer-->>ScreenCaptureSource: ControlFlow::Continue(Ok(()))
        ScreenCaptureSource-->>Upstream: Continue
    else Error (e.g., channel disconnect, frame drop, capture error)
        Capturer-->>ScreenCaptureSource: ControlFlow::Break(Err(String))
        ScreenCaptureSource-->>Upstream: Break(Err(String))
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Poem

A rabbit hops through code so neat,
Error strings now can't retreat.
No more panics, logs, or breaks—
Just clear control for all our sakes.
With every hop, the flow is right,
Bugs and silence out of sight!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

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

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b21dab0 and 8f7df12.

📒 Files selected for processing (1)

• crates/media/src/sources/screen_capture.rs (6 hunks)

⏰ 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). (2)

• GitHub Check: Build Desktop (x86_64-pc-windows-msvc, windows-latest)
• GitHub Check: Build Desktop (aarch64-apple-darwin, macos-latest)

🔇 Additional comments (6)

crates/media/src/sources/screen_capture.rs (6)

581-583: LGTM! Proper error propagation for disconnected channel.

The error handling correctly returns a descriptive error message when the video transmission channel is disconnected, allowing upstream code to handle the error appropriately.

---

612-612: Excellent improvement replacing panic with error propagation.

The change from panicking to returning an error with actionable guidance is a significant improvement. The error message clearly explains the issue and provides concrete steps users can take to resolve it.

---

645-645: LGTM! Consistent error propagation for capture errors.

The error handling properly formats and propagates the capture error message, maintaining consistency with the new error handling pattern.

---

655-655: Correct signature update to support error propagation.

The closure signature change properly reflects the new error handling pattern, allowing errors to be propagated from the frame capture logic.

---

702-708: Good addition of error logging before breaking.

The conditional error logging ensures that capture errors are recorded in the logs for debugging purposes while still properly propagating the error upstream.

---

852-852: Consistent error handling for macOS implementation.

The CMSampleBufferCapture implementation now follows the same error propagation pattern as AVFrameCapture, ensuring consistency across platforms.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 835-cap-fully-crashes-when-screen-capture-cant-keep-up

---

🪧 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.
• 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.

Support

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

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.

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.