Fix crash when screen capture can't keep up

[oscartbeaumont]

Fixes for #835

This PR is preventing the crash but the recording toolbar is never removed when the errors occurs. The error is also never presented to the end-user.

Summary by CodeRabbit

• New Features

  • Added support for a new dependency to enhance media capabilities.

• Bug Fixes

  • Improved error handling and reporting in audio input, audio mixer, camera, and screen capture sources, providing clearer feedback on failures.

• Style

  • Updated code style for import type annotations to use single quotes for consistency.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This change refactors several media pipeline source task implementations to standardize error handling by updating the run method signatures to return Result<(), String> rather than (). Error propagation is now explicit throughout the audio, camera, and screen capture sources. Minor dependency updates and import style changes are also included.

Changes

Cohort / File(s)	Change Summary
Media Pipeline Source Error Handling crates/media/src/pipeline/task.rs, crates/media/src/sources/audio_input.rs, crates/media/src/sources/audio_mixer.rs, crates/media/src/sources/camera.rs, crates/media/src/sources/screen_capture.rs	Updated PipelineSourceTask::run and all its implementations to return Result<(), String>. Error handling in loops and internal functions now propagates errors explicitly. Signature changes for all affected methods and functions.
Pipeline Builder Task Spawning crates/media/src/pipeline/builder.rs	Simplified closure passed to spawn_task by returning the result of task.run directly, matching the updated error-handling signature.
Dependency Updates Cargo.toml, crates/media/Cargo.toml	Updated scap dependency Git commit hash and added a new dependency on kameo version 0.17.2 in the media crate.
Import Style Consistency packages/ui-solid/src/auto-imports.d.ts	Changed double quotes to single quotes in module specifiers for imported icon component type annotations. No functional or signature changes.

Sequence Diagram(s)

sequenceDiagram
    participant Pipeline
    participant SourceTask (run)
    participant Upstream

    Pipeline->>SourceTask (run): Call run(clock, ready_signal, control_signal)
    SourceTask (run)->>SourceTask (run): Execute loop / main logic
    alt Error occurs
        SourceTask (run)-->>Pipeline: Return Err(String)
    else Normal shutdown
        SourceTask (run)-->>Pipeline: Return Ok(())
    end
    Pipeline->>Upstream: Handle result (success or error)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~18 minutes

Possibly related PRs

• CapSoftware/Cap#841: Introduced explicit error propagation in the screen capture source's run method and inner function, directly paralleling the main changes in this PR.

Poem

A hop and a skip, the errors now fly,
With Result in paw, the bugs say goodbye.
Audio and video, screen and the cam,
All now report troubles, as neat as a jam.
Dependencies fresh, and imports aligned—
This bunny approves, with peace of mind! 🐇✨

---

📜 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 5e59b95 and 2a85e98.

⛔ Files ignored due to path filters (1)

• Cargo.lock is excluded by !**/*.lock

📒 Files selected for processing (9)

• Cargo.toml (1 hunks)
• crates/media/Cargo.toml (1 hunks)
• crates/media/src/pipeline/builder.rs (1 hunks)
• crates/media/src/pipeline/task.rs (1 hunks)
• crates/media/src/sources/audio_input.rs (2 hunks)
• crates/media/src/sources/audio_mixer.rs (2 hunks)
• crates/media/src/sources/camera.rs (2 hunks)
• crates/media/src/sources/screen_capture.rs (6 hunks)
• packages/ui-solid/src/auto-imports.d.ts (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-windows-lag-crash

---

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