add engine version header to core api client requests

Author: nicktrn

apps/webapp/app/routes/api.v1.tasks.$taskId.trigger.ts

@@ -1,5 +1,9 @@
 import { json } from "@remix-run/server-runtime";
-import { generateJWT as internal_generateJWT, TriggerTaskRequestBody } from "@trigger.dev/core/v3";
+import {
+  generateJWT as internal_generateJWT,
+  RunEngineVersionSchema,
+  TriggerTaskRequestBody,
+} from "@trigger.dev/core/v3";
 import { TaskRun } from "@trigger.dev/database";
 import { z } from "zod";
 import { env } from "~/env.server";
@@ -21,6 +25,7 @@ export const HeadersSchema = z.object({
   "x-trigger-span-parent-as-link": z.coerce.number().nullish(),
   "x-trigger-worker": z.string().nullish(),
   "x-trigger-client": z.string().nullish(),
+  "x-trigger-engine-version": RunEngineVersionSchema.nullish(),
   traceparent: z.string().optional(),
   tracestate: z.string().optional(),
 });
@@ -49,6 +54,7 @@ const { action, loader } = createActionApiRoute(
       tracestate,
       "x-trigger-worker": isFromWorker,
       "x-trigger-client": triggerClient,
+      "x-trigger-engine-version": engineVersion,
     } = headers;
 
     const service = new TriggerTaskService();
@@ -74,14 +80,20 @@ const { action, loader } = createActionApiRoute(
 
       const idempotencyKeyExpiresAt = resolveIdempotencyKeyTTL(idempotencyKeyTTL);
 
-      const run = await service.call(params.taskId, authentication.environment, body, {
-        idempotencyKey: idempotencyKey ?? undefined,
-        idempotencyKeyExpiresAt: idempotencyKeyExpiresAt,
-        triggerVersion: triggerVersion ?? undefined,
-        traceContext,
-        spanParentAsLink: spanParentAsLink === 1,
-        oneTimeUseToken,
-      });
+      const run = await service.call(
+        params.taskId,
+        authentication.environment,
+        body,
+        {
+          idempotencyKey: idempotencyKey ?? undefined,
+          idempotencyKeyExpiresAt: idempotencyKeyExpiresAt,
+          triggerVersion: triggerVersion ?? undefined,
+          traceContext,
+          spanParentAsLink: spanParentAsLink === 1,
+          oneTimeUseToken,
+        },
+        engineVersion ?? undefined
+      );
 
       if (!run) {
         return json({ error: "Task not found" }, { status: 404 });

apps/webapp/app/routes/api.v1.tasks.batch.ts

@@ -58,6 +58,7 @@ const { action, loader } = createActionApiRoute(
       "x-trigger-span-parent-as-link": spanParentAsLink,
       "x-trigger-worker": isFromWorker,
       "x-trigger-client": triggerClient,
+      "x-trigger-engine-version": engineVersion,
       "batch-processing-strategy": batchProcessingStrategy,
       traceparent,
       tracestate,
@@ -87,7 +88,11 @@ const { action, loader } = createActionApiRoute(
       resolveIdempotencyKeyTTL(idempotencyKeyTTL) ??
       new Date(Date.now() + 24 * 60 * 60 * 1000 * 30);
 
-    const version = await determineEngineVersion({ environment: authentication.environment });
+    const version = await determineEngineVersion({
+      environment: authentication.environment,
+      version: engineVersion ?? undefined,
+    });
+
     const service =
       version === "V1"
         ? new BatchTriggerV2Service(batchProcessingStrategy ?? undefined)

packages/cli-v3/src/entryPoints/deploy-run-controller.ts

@@ -879,7 +879,10 @@ class ProdWorker {
           this._taskRunProcess = new TaskRunProcess({
             workerManifest: this.workerManifest,
             env,
-            serverWorker: execution.worker,
+            serverWorker: {
+              ...execution.worker,
+              engine: "V1",
+            },
             payload: createAttempt.result.executionPayload,
             messageId: message.lazyPayload.messageId,
           });

packages/cli-v3/src/entryPoints/managed-run-controller.ts

@@ -453,6 +453,7 @@ class ManagedRunController {
         id: "unmanaged",
         contentHash: env.TRIGGER_CONTENT_HASH,
         version: env.TRIGGER_DEPLOYMENT_VERSION,
+        engine: "V2",
       },
       payload: {
         execution,

packages/cli-v3/src/entryPoints/unmanaged-run-controller.ts

@@ -65,6 +65,7 @@ class UnmanagedRunController {
           id: "unmanaged",
           contentHash: env.TRIGGER_CONTENT_HASH,
           version: env.TRIGGER_DEPLOYMENT_VERSION,
+          engine: "V2",
         },
         payload: {
           execution,

packages/core/src/v3/apiClient/index.ts

@@ -692,6 +692,7 @@ export class ApiClient {
       "Content-Type": "application/json",
       Authorization: `Bearer ${this.accessToken}`,
       "trigger-version": VERSION,
+      "x-trigger-engine-version": taskContext.worker?.engine ?? "V1",
       ...Object.entries(additionalHeaders ?? {}).reduce(
         (acc, [key, value]) => {
           if (value !== undefined) {

packages/core/src/v3/schemas/messages.ts

@@ -12,6 +12,7 @@ import {
   EnvironmentType,
   ProdTaskRunExecution,
   ProdTaskRunExecutionPayload,
+  RunEngineVersionSchema,
   RuntimeWait,
   TaskRunExecutionLazyAttemptPayload,
   WaitReason,
@@ -103,6 +104,7 @@ export const ServerBackgroundWorker = z.object({
   id: z.string(),
   version: z.string(),
   contentHash: z.string(),
+  engine: RunEngineVersionSchema.optional(),
 });
 
 export type ServerBackgroundWorker = z.infer<typeof ServerBackgroundWorker>;

packages/core/src/v3/schemas/schemas.ts

@@ -8,6 +8,8 @@ import { MachineConfig, MachinePreset, TaskRunExecution } from "./common.js";
 export const EnvironmentType = z.enum(["PRODUCTION", "STAGING", "DEVELOPMENT", "PREVIEW"]);
 export type EnvironmentType = z.infer<typeof EnvironmentType>;
 
+export const RunEngineVersionSchema = z.enum(["V1", "V2"]);
+
 export const TaskRunExecutionPayload = z.object({
   execution: TaskRunExecution,
   traceContext: z.record(z.unknown()),
@@ -25,6 +27,7 @@ export const ProdTaskRunExecution = TaskRunExecution.extend({
     id: z.string(),
     contentHash: z.string(),
     version: z.string(),
+    type: RunEngineVersionSchema.optional(),
   }),
   machine: MachinePreset.default({ name: "small-1x", cpu: 1, memory: 1, centsPerMs: 0 }),
 });