cancel cursor actor on drop

[Brendonovich]

Summary by CodeRabbit

• New Features
  • None.
• Refactor
  • Streamlined the cursor recording shutdown logic for cleaner, more reliable termination.
• Reliability
  • Improves consistency of stopping behavior during heavy usage or app shutdown.
• Notes
  • No user-facing behavior changes expected.

[coderabbitai]

Walkthrough

The stop mechanism in CursorActor was switched from CancellationToken to DropGuard. The stop field type, initialization, and stop() implementation were updated accordingly, and the necessary import for DropGuard was added. No method signatures changed beyond the internal field type.

Changes

Cohort / File(s)	Summary
Cursor stop mechanism refactor crates/recording/src/cursor.rs	Replaced CancellationToken with DropGuard for the CursorActor stop field; updated initialization via stop_token.drop_guard(), stop() to drop(self.stop), and imports to include DropGuard.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant App
  participant CursorActor
  participant StopToken as StopToken (source)
  participant DropGuard

  App->>CursorActor: new(stop_token)
  CursorActor->>StopToken: create drop_guard()
  StopToken-->>CursorActor: DropGuard
  note over CursorActor,DropGuard: Stop mechanism now uses DropGuard instead of CancellationToken

  App->>CursorActor: stop()
  CursorActor->>DropGuard: drop(self.stop)
  note right of CursorActor: Dropping guard triggers stop path

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my whiskers, click “stop” with delight,
A guard now drops—clean exit, tight.
No cancel calls, just softly glide,
The cursor rests, a calmer ride.
Thump-thump! I hop through refactors neat—
Carrot-compact, concise, complete. 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "cancel cursor actor on drop" accurately and concisely describes the main change in the diff, which replaces the CancellationToken-based stop mechanism with a DropGuard so the cursor actor is cancelled on drop; it is directly related to the changes in crates/recording/src/cursor.rs and is specific enough for scanability.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch cursor-capture-drop-guard

---

📜 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 1ca1fa7 and 221b910.

📒 Files selected for processing (1)

• crates/recording/src/cursor.rs (3 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

{crates,apps/cli,apps/desktop/src-tauri}/**/*.rs

📄 CodeRabbit inference engine (AGENTS.md)

{crates,apps/cli,apps/desktop/src-tauri}/**/*.rs: Rust code must be formatted with rustfmt and adhere to workspace clippy lints
Rust module files should use snake_case names

Files:

• crates/recording/src/cursor.rs

{crates,apps/cli,apps/desktop/src-tauri}/**/{src,tests}/**/*.rs

📄 CodeRabbit inference engine (AGENTS.md)

Rust tests should live in src (inline/unit) or tests (integration) directories

Files:

• crates/recording/src/cursor.rs

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

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

🔇 Additional comments (4)

crates/recording/src/cursor.rs (4)

7-7: LGTM! DropGuard import added correctly.

The import of DropGuard alongside the existing CancellationToken is appropriate for the transition to the new stop mechanism.

---

27-27: LGTM! Field type updated to DropGuard.

The change from CancellationToken to DropGuard aligns with the new cancellation mechanism.

---

32-35: LGTM! Stop method correctly uses drop semantics.

The implementation correctly uses drop(self.stop) instead of the previous cancel() call, which properly triggers cancellation when the DropGuard is dropped.

---

183-183: LGTM! Initialization uses drop_guard correctly.

The field initialization correctly uses stop_token.drop_guard() to create the DropGuard instance that will signal cancellation when dropped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}