Fix cancelled runs breaking realtime subscriptions

[ericallam]

This fixes an issue with cancelled runs and other runs in an error state that would cause realtime to throw an error because we weren't using the correct schema for the error column. I've also made setting the final run status and error atomic to prevent realtime from closing the subscription too early.

[changeset-bot]

🦋 Changeset detected

Latest commit: a361492

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages

Name	Type
@trigger.dev/core	Patch
@trigger.dev/build	Patch
trigger.dev	Patch
@trigger.dev/sdk	Patch
@internal/redis-worker	Patch
@internal/zod-worker	Patch
@trigger.dev/react-hooks	Patch
@trigger.dev/rsc	Patch
@trigger.dev/database	Patch
@trigger.dev/otlp-importer	Patch
@internal/testcontainers	Patch

Not sure what this means? Click here to learn what changesets are.

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

[coderabbitai]

Walkthrough

This pull request introduces several changes aimed at improving error handling and stability within the task run management system. Key updates include a patch for the @trigger.dev/core package to address issues with cancelled runs, modifications to the FinalizeTaskRunService for streamlined error handling, and adjustments to error representation in the RunSubscription and SubscribeRunRawShape schemas. Additionally, the exampleTask function has been enhanced with error simulation and an extended timeout. Overall, the changes focus on enhancing the reliability and efficiency of task run processes.

Changes

File Path	Change Summary
.changeset/shaggy-donkeys-hammer.md	Introduced a patch for @trigger.dev/core to handle errors during cancelled runs.
apps/webapp/app/v3/services/finalizeTaskRun.server.ts	Modified FinalizeTaskRunService to consolidate error updates into a single database operation; removed finalizeRunError method; improved logging.
packages/core/src/v3/apiClient/runStream.ts	Updated transformRunShape method in RunSubscription to use createJsonErrorObject for error assignment instead of direct assignment.
packages/core/src/v3/schemas/api.ts	Changed SubscribeRunRawShape to use TaskRunError instead of SerializedError for the error field.
references/nextjs-realtime/src/trigger/example.ts	Added error handling logic in exampleTask function to simulate failures and increased timeout from 2000ms to 20000ms.

Possibly related PRs

• fix: cleanup ttl expire run graphile jobs #1373: Involves error handling and state management for task runs, relating to the main PR's focus on stability and reliability.
• Fix several restore and resume bugs #1418: Addresses restoring and resuming task runs, relevant to preventing erroneous states during cancelled runs.
• fix: removing schedule instance no longer crashes #1430: Focuses on preventing crashes during schedule instance deletions, connecting to maintaining stable run states.
• Multiple streams can now be consumed at the same time #1522: Introduces functionality for consuming multiple streams, relating to improving task run handling.
• Triggering docs and adding options to all trigger hooks #1528: Enhances trigger hooks with additional options, indirectly relating to task run handling and error management.

🐇 In the meadow, where bunnies play,
A patch was made to save the day.
With errors tamed and runs so fine,
Stability blooms, like sweet sunshine.
Hops of joy, we celebrate,
For smoother tasks, we now await! 🌼✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/webapp/app/v3/services/finalizeTaskRun.server.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.

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

🧹 Outside diff range and nitpick comments (1)

references/nextjs-realtime/src/trigger/example.ts (1)

18-21: Consider making error simulation deterministic

Using Math.random() to simulate failures introduces non-determinism, which can complicate testing and debugging. Consider using a configurable parameter or dependency injection to control the failure condition for more predictable testing.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9b35cc4 and a361492.

📒 Files selected for processing (5)

• .changeset/shaggy-donkeys-hammer.md (1 hunks)
• apps/webapp/app/v3/services/finalizeTaskRun.server.ts (1 hunks)
• packages/core/src/v3/apiClient/runStream.ts (2 hunks)
• packages/core/src/v3/schemas/api.ts (2 hunks)
• references/nextjs-realtime/src/trigger/example.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .changeset/shaggy-donkeys-hammer.md

🔇 Additional comments (6)

references/nextjs-realtime/src/trigger/example.ts (1)

23-23: Ensure extended timeout aligns with system constraints

The timeout has been increased from 2000ms to 20000ms. Verify that this change does not conflict with any system timeouts or performance expectations.

apps/webapp/app/v3/services/finalizeTaskRun.server.ts (1)

67-73: Consolidating error updates improves efficiency and consistency

Combining the error update with the main database update ensures atomicity and prevents potential issues where the error might be lost if the status update causes the stream to shut down prematurely. This change enhances efficiency and data integrity.

packages/core/src/v3/apiClient/runStream.ts (2)

2-2: Importing createJsonErrorObject for consistent error transformation

The addition of createJsonErrorObject ensures that errors are uniformly formatted across the application. This is a good practice for consistent error handling.

---

351-351: Updating error handling for consistent error representation

Using createJsonErrorObject(row.error) ensures that error objects are consistently structured, improving error handling and debugging processes.

packages/core/src/v3/schemas/api.ts (2)

3-3: Updating import to include TaskRunError

Importing TaskRunError from ./common.js reflects the shift to a more specific error type, aligning with the updated error handling strategy.

---

711-711: Using TaskRunError in SubscribeRunRawShape for improved error clarity

Replacing SerializedError with TaskRunError in the SubscribeRunRawShape schema enhances error specificity and aligns with the new error handling conventions.

[pkg-pr-new]

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1533

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1533

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1533

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1533

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1533

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1533

commit: a361492