fix: prevent circular reference errors on task indexing when using schemaTask #2383

ericallam · 2025-08-13T10:05:07Z

No description provided.

…hemaTask

changeset-bot · 2025-08-13T10:05:11Z

🦋 Changeset detected

Latest commit: 19b6e35

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

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 · 2025-08-13T10:05:52Z

Walkthrough

Added a changeset file marking a patch release for Trigger.dev, documenting a fix to prevent circular reference errors during task indexing with schemaTask.
Updated registerTaskMetadata in standardResourceCatalog to:
- Destructure and exclude schema from task metadata.
- Store schema separately in _taskSchemas via set(task.id, schema) when present.
- Change conditional from task.schema to schema.
- Ensure manifests/listing exclude schema; retrieval now via getTaskSchema(id).
No changes to exported/public API signatures.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

✨ 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/schema-task-circular-reference

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

🪧 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.
- 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.
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 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/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
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: 1

🔭 Outside diff range comments (1)

packages/core/src/v3/resource-catalog/standardResourceCatalog.ts (1)

82-102: Keep updates symmetrical: ignore schema/id in metadata updates and sync schema map

updateTaskMetadata can accidentally re-introduce schema into TaskMetadata or let callers mutate id inside the stored metadata. Strip schema and id from updates; merge fns separately (as you already do), and keep the schema map in sync when schema is provided in updates.

Apply this diff:

   updateTaskMetadata(id: string, updates: Partial<TaskMetadataWithFunctions>): void {
     const existingMetadata = this._taskMetadata.get(id);
 
-    if (existingMetadata) {
-      this._taskMetadata.set(id, {
-        ...existingMetadata,
-        ...updates,
-      });
-    }
+    // Prevent schema and fns from being merged into TaskMetadata and ignore id updates
+    const { fns: fnsUpdates, schema: schemaUpdate, id: _ignoredId, ...metadataUpdates } = updates;
+    if (existingMetadata) {
+      this._taskMetadata.set(id, {
+        ...existingMetadata,
+        ...metadataUpdates,
+      });
+    }
 
-    if (updates.fns) {
+    if (fnsUpdates) {
       const existingFunctions = this._taskFunctions.get(id);
 
       if (existingFunctions) {
         this._taskFunctions.set(id, {
           ...existingFunctions,
-          ...updates.fns,
+          ...fnsUpdates,
         });
       }
     }
+
+    // Keep schema storage in sync when updates include it
+    if (schemaUpdate !== undefined) {
+      if (schemaUpdate) {
+        this._taskSchemas.set(id, schemaUpdate);
+      } else {
+        this._taskSchemas.delete(id);
+      }
+    }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cd6a0b3 and 19b6e35.

📒 Files selected for processing (2)

.changeset/clean-beans-run.md (1 hunks)
packages/core/src/v3/resource-catalog/standardResourceCatalog.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
No default exports, use function declarations

Files:

packages/core/src/v3/resource-catalog/standardResourceCatalog.ts

{packages/core,apps/webapp}/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

We use zod a lot in packages/core and in the webapp

Files:

packages/core/src/v3/resource-catalog/standardResourceCatalog.ts

🧠 Learnings (6)

📓 Common learnings

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-07-18T17:50:25.014Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : When implementing schema tasks, use `schemaTask` from `trigger.dev/sdk/v3` and validate payloads as shown.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-07-18T17:50:25.014Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : ALWAYS generate Trigger.dev tasks using the `task` function from `trigger.dev/sdk/v3` and export them as shown in the correct pattern.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-07-18T17:50:25.014Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : You MUST use `trigger.dev/sdk/v3` when writing Trigger.dev tasks.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-07-18T17:50:25.014Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : When implementing scheduled (cron) tasks, use `schedules.task` from `trigger.dev/sdk/v3` and follow the shown patterns.