chore(docs): document abort signal

[NathanFlurry]

No description provided.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
rivet-site	Ready	Preview, Comment	Dec 23, 2025 10:48pm

3 Skipped Deployments

Project	Deployment	Review	Updated (UTC)
rivet-cloud	Ignored		Dec 23, 2025 10:48pm
rivet-inspector	Ignored	Preview	Dec 23, 2025 10:48pm
rivetkit-serverless	Skipped		Dec 23, 2025 10:48pm

[NathanFlurry]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• chore(docs): document abort signal #3673 👈 (View in Graphite)
• chore(rivetkit): clean up logging configuration #3672
• chore(rivetkit): RIVET_EXPOSE_ERRORS #3671
• chore(rivetkit): specialize context types for better compiler errors #3669
• fix(rivetkit): fix c.client not respecting correct origin #3668
• fix(rivetkit): allow providing no args to createRivetKit #3667
• main

---

How to use the Graphite Merge Queue

Add the label merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[claude]

PR Review: Document Abort Signal

Overview

This PR adds documentation for the abort signal functionality in RivetKit actors, covering both automatic cleanup on actor shutdown and manual cancellation of long-running operations.

Code Quality & Best Practices ✅

Strengths:

• Clear, practical examples that demonstrate real-world use cases
• Proper cross-referencing between related documentation sections
• Consistent with existing documentation style and structure
• Examples follow TypeScript best practices

Observations:

1. Example in actions.mdx (lines 256-262) - The manual cancellation pattern is well-structured, showing how to chain c.abortSignal with a custom AbortController. This is the correct approach for on-demand cancellation.

2. Example in lifecycle.mdx (lines 627-638) - Clean demonstration of automatic cancellation using c.abortSignal directly with fetch.

Potential Issues 🔍

1. Missing Cleanup in actions.mdx Example

   The generate action creates an event listener but doesn't clean it up:

   c.abortSignal.addEventListener("abort", () => controller.abort());

   Recommendation: Add cleanup to prevent memory leaks in long-lived actors:

   const abortHandler = () => controller.abort();
   c.abortSignal.addEventListener("abort", abortHandler);
   
   try {
     const response = await fetch(/* ... */);
     return await response.json();
   } finally {
     c.abortSignal.removeEventListener("abort", abortHandler);
   }

2. Error Handling Missing

   Neither example shows how to handle AbortError exceptions. When a fetch is aborted, it throws an error that should be caught:

   Recommendation: Add error handling examples:

   try {
     const response = await fetch(url, { signal: c.abortSignal });
     return await response.json();
   } catch (err) {
     if (err.name === 'AbortError') {
       // Operation was cancelled - this is expected
       return null; // or throw a UserError with appropriate message
     }
     throw err; // Re-throw unexpected errors
   }

Performance Considerations ⚡

• The examples are lightweight and won't cause performance issues
• The chaining pattern in the manual cancellation example is efficient

Security Concerns 🔒

No security concerns identified. The examples use proper fetch API patterns.

Test Coverage 🧪

This is documentation-only, but consider:

• Verifying that the code examples are tested in the actual codebase
• Ensuring the abort signal behavior is covered by integration tests

Documentation Quality 📝

Strengths:

• Clear section titles that match the content
• Good use of cross-references
• Examples are concise and focused

Minor Suggestions:

1. Consider adding a note about timing - When does c.abortSignal fire? During onSleep, onDestroy, or both? This would help users understand when to expect cancellation.

2. Add a note about cleanup in actions.mdx - Mention that the event listener should ideally be cleaned up to avoid memory leaks in long-lived actors.

3. Consider mentioning AbortError - Users should know that aborted operations throw errors that need handling.

Summary

This is a solid documentation addition that fills an important gap. The examples are clear and demonstrate real-world use cases effectively. The main improvements would be:

1. Add event listener cleanup in the manual cancellation example
2. Include error handling for AbortError
3. Clarify when the abort signal fires

Recommendation: Approve with minor improvements suggested above.

---

Review generated by Claude Code