docs: onCancel

[ericallam]

Summary by CodeRabbit

• Documentation
  • Added a new section detailing the onCancel lifecycle hook, including usage examples and integration with asynchronous operations.
  • Explained how to access the run's output after cancellation using the runPromise parameter.
  • Noted the 30-second completion limit for runPromise within the onCancel hook.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 297aec3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

"""

Walkthrough

The documentation has been updated to include a new section detailing the onCancel lifecycle hook. This section explains how to define and use the onCancel hook, provides examples of handling cancellation signals, demonstrates aborting asynchronous operations, and describes how to use the runPromise parameter to access run outputs after cancellation. It also notes a 30-second timeout for the completion of runPromise within the onCancel hook. No changes were made to code or public API signatures.

Changes

File(s)	Change Summary
docs/upgrade-to-v4.mdx	Added documentation for the onCancel lifecycle hook, usage examples, and behavioral notes.

Poem

In the docs a new tale is spun,
Of hooks that run when tasks are done—
If cancelled mid-hop, don’t despair,
onCancel is waiting, aware!
With signals and promises, all in the mix,
Even a rabbit can handle these tricks.
🐇✨
"""

---

📜 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 ba1fdbc and 297aec3.

📒 Files selected for processing (1)

• docs/upgrade-to-v4.mdx (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/upgrade-to-v4.mdx

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

• GitHub Check: Analyze (javascript-typescript)

---

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/upgrade-to-v4.mdx (3)

173-181: Add onCancel to the global lifecycle hooks overview
While the new ### onCancel section clearly documents how to use the hook, the Global lifecycle hooks snippet above (lines 104–122) still only lists onStart, onSuccess, and onFailure. For consistency, consider adding onCancel there so users see it in the high-level hook index before diving into the dedicated section.

---

183-235: Clarify hook registration scope and callback signature
The example shows tasks.onCancel being registered inside a run function, which may be misunderstood as a global hook but actually only applies to that run. Consider adding a brief note that hooks added within run are scoped per-run. Also, to keep callback signatures consistent with other hooks, prefer destructuring the arguments (e.g. tasks.onCancel(({ ctx, signal }) => { … })) instead of a zero-arity callback.

---

237-270: Enhance runPromise example with full signature and error handling
To mirror the other hook patterns, destructure both signal and runPromise in the callback (e.g. async ({ signal, runPromise }) => { … }). It would also be helpful to demonstrate handling a rejected runPromise (wrap await runPromise in try/catch) to avoid unhandled rejections. Lastly, add a comma in the note for clarity:
“After that point, the process will be killed.” → “After that point, the process will be killed.”

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 13f750a and ba1fdbc.

📒 Files selected for processing (1)

• docs/upgrade-to-v4.mdx (3 hunks)

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

• GitHub Check: Analyze (javascript-typescript)