@trigger.dev/core 0.0.0-v3-prerelease-20250108142426 → 0.0.0-v4-prerelease-20250916125920

package/dist/commonjs/v3/runEngineWorker/workload/http.d.ts

@@ -0,0 +1,317 @@
+import { WorkloadHeartbeatRequestBody, WorkloadRunAttemptCompleteRequestBody, WorkloadRunAttemptStartRequestBody, WorkloadDebugLogRequestBody } from "./schemas.js";
+import { WorkloadClientCommonOptions } from "./types.js";
+type WorkloadHttpClientOptions = WorkloadClientCommonOptions;
+export declare class WorkloadHttpClient {
+    private opts;
+    private apiUrl;
+    private runnerId;
+    private readonly deploymentId;
+    constructor(opts: WorkloadHttpClientOptions);
+    updateApiUrl(apiUrl: string): void;
+    updateRunnerId(runnerId: string): void;
+    defaultHeaders(): Record<string, string>;
+    heartbeatRun(runId: string, snapshotId: string, body?: WorkloadHeartbeatRequestBody): Promise<import("../../zodfetch.js").ApiResult<{
+        ok: true;
+    }>>;
+    suspendRun(runId: string, snapshotId: string): Promise<import("../../zodfetch.js").ApiResult<{
+        ok: true;
+    } | {
+        error: string;
+        ok: false;
+    }>>;
+    continueRunExecution(runId: string, snapshotId: string): Promise<import("../../zodfetch.js").ApiResult<{
+        run: {
+            status: import("../../index.js").TaskRunStatus;
+            id: string;
+            friendlyId: string;
+            attemptNumber?: number | null | undefined;
+        };
+        snapshot: {
+            id: string;
+            createdAt: Date;
+            description: string;
+            friendlyId: string;
+            executionStatus: import("../../index.js").TaskRunExecutionStatus;
+        };
+    }>>;
+    startRunAttempt(runId: string, snapshotId: string, body: WorkloadRunAttemptStartRequestBody): Promise<import("../../zodfetch.js").ApiResult<{
+        run: {
+            status: import("../../index.js").TaskRunStatus;
+            id: string;
+            friendlyId: string;
+            attemptNumber?: number | null | undefined;
+        };
+        snapshot: {
+            id: string;
+            createdAt: Date;
+            description: string;
+            friendlyId: string;
+            executionStatus: import("../../index.js").TaskRunExecutionStatus;
+        };
+    } & {
+        execution: {
+            task: {
+                id: string;
+                filePath: string;
+            } & {
+                [k: string]: unknown;
+            };
+            queue: {
+                name: string;
+                id: string;
+            };
+            environment: {
+                type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
+                id: string;
+                slug: string;
+                branchName?: string | undefined;
+                git?: {
+                    dirty?: boolean | undefined;
+                    source?: "trigger_github_app" | "github_actions" | "local" | undefined;
+                    provider?: string | undefined;
+                    ghUsername?: string | undefined;
+                    ghUserAvatarUrl?: string | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitMessage?: string | undefined;
+                    commitRef?: string | undefined;
+                    commitSha?: string | undefined;
+                    remoteUrl?: string | undefined;
+                    pullRequestNumber?: number | undefined;
+                    pullRequestTitle?: string | undefined;
+                    pullRequestState?: "open" | "closed" | "merged" | undefined;
+                } | undefined;
+            };
+            organization: {
+                name: string;
+                id: string;
+                slug: string;
+            };
+            project: {
+                name: string;
+                id: string;
+                slug: string;
+                ref: string;
+            };
+            machine: {
+                cpu: number;
+                memory: number;
+                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
+                centsPerMs: number;
+            };
+            attempt: {
+                number: number;
+                startedAt: Date;
+            } & {
+                [k: string]: unknown;
+            };
+            run: {
+                payload: string;
+                id: string;
+                payloadType: string;
+                tags: string[];
+                isTest: boolean;
+                createdAt: Date;
+                startedAt: Date;
+                metadata?: Record<string, import("../../../index.js").DeserializedJson> | undefined;
+                idempotencyKey?: string | undefined;
+                maxAttempts?: number | undefined;
+                version?: string | undefined;
+                maxDuration?: number | undefined;
+                priority?: number | undefined;
+                baseCostInCents?: number | undefined;
+                parentTaskRunId?: string | undefined;
+                rootTaskRunId?: string | undefined;
+                durationMs?: number | undefined;
+                costInCents?: number | undefined;
+                region?: string | undefined;
+            } & {
+                traceContext?: Record<string, unknown> | undefined;
+            };
+            batch?: {
+                id: string;
+            } | undefined;
+            deployment?: {
+                id: string;
+                version: string;
+                shortCode: string;
+                runtime: string;
+                runtimeVersion: string;
+                git?: {
+                    dirty?: boolean | undefined;
+                    source?: "trigger_github_app" | "github_actions" | "local" | undefined;
+                    provider?: string | undefined;
+                    ghUsername?: string | undefined;
+                    ghUserAvatarUrl?: string | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitMessage?: string | undefined;
+                    commitRef?: string | undefined;
+                    commitSha?: string | undefined;
+                    remoteUrl?: string | undefined;
+                    pullRequestNumber?: number | undefined;
+                    pullRequestTitle?: string | undefined;
+                    pullRequestState?: "open" | "closed" | "merged" | undefined;
+                } | undefined;
+            } | undefined;
+        };
+    } & {
+        envVars: Record<string, string>;
+    }>>;
+    completeRunAttempt(runId: string, snapshotId: string, body: WorkloadRunAttemptCompleteRequestBody): Promise<import("../../zodfetch.js").ApiResult<{
+        result: {
+            attemptStatus: "RUN_FINISHED" | "RUN_PENDING_CANCEL" | "RETRY_QUEUED" | "RETRY_IMMEDIATELY";
+        } & {
+            run: {
+                status: import("../../index.js").TaskRunStatus;
+                id: string;
+                friendlyId: string;
+                attemptNumber?: number | null | undefined;
+            };
+            snapshot: {
+                id: string;
+                createdAt: Date;
+                description: string;
+                friendlyId: string;
+                executionStatus: import("../../index.js").TaskRunExecutionStatus;
+            };
+        };
+    }>>;
+    getSnapshotsSince(runId: string, snapshotId: string): Promise<import("../../zodfetch.js").ApiResult<{
+        snapshots: {
+            version: "1";
+            run: {
+                status: import("../../index.js").TaskRunStatus;
+                id: string;
+                friendlyId: string;
+                attemptNumber?: number | null | undefined;
+            };
+            snapshot: {
+                id: string;
+                createdAt: Date;
+                description: string;
+                friendlyId: string;
+                executionStatus: import("../../index.js").TaskRunExecutionStatus;
+            };
+            completedWaitpoints: {
+                type: import("../../index.js").WaitpointType;
+                id: string;
+                friendlyId: string;
+                completedAt: Date;
+                outputIsError: boolean;
+                idempotencyKey?: string | undefined;
+                output?: string | undefined;
+                outputType?: string | undefined;
+                index?: number | undefined;
+                completedByTaskRun?: {
+                    id: string;
+                    friendlyId: string;
+                    batch?: {
+                        id: string;
+                        friendlyId: string;
+                    } | undefined;
+                } | undefined;
+                completedAfter?: Date | undefined;
+                completedByBatch?: {
+                    id: string;
+                    friendlyId: string;
+                } | undefined;
+            }[];
+            batch?: {
+                id: string;
+                friendlyId: string;
+            } | undefined;
+            checkpoint?: {
+                type: import("../../index.js").CheckpointTypeEnum;
+                id: string;
+                friendlyId: string;
+                location: string;
+                imageRef?: string | null | undefined;
+                reason?: string | null | undefined;
+            } | undefined;
+        }[];
+    }>>;
+    sendDebugLog(runId: string, body: WorkloadDebugLogRequestBody): Promise<void>;
+    /** @deprecated Not currently used */
+    dequeue(): Promise<import("../../zodfetch.js").ApiResult<{
+        version: "1";
+        environment: {
+            type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
+            id: string;
+        };
+        organization: {
+            id: string;
+        };
+        project: {
+            id: string;
+        };
+        deployment: {
+            id?: string | undefined;
+            friendlyId?: string | undefined;
+            imagePlatform?: string | undefined;
+        };
+        run: {
+            id: string;
+            isTest: boolean;
+            machine: {
+                cpu: number;
+                memory: number;
+                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
+                centsPerMs: number;
+            };
+            traceContext: Record<string, unknown>;
+            friendlyId: string;
+            attemptNumber: number;
+            masterQueue: string;
+        };
+        snapshot: {
+            id: string;
+            createdAt: Date;
+            description: string;
+            friendlyId: string;
+            executionStatus: import("../../index.js").TaskRunExecutionStatus;
+        };
+        completedWaitpoints: {
+            type: import("../../index.js").WaitpointType;
+            id: string;
+            friendlyId: string;
+            completedAt: Date;
+            outputIsError: boolean;
+            idempotencyKey?: string | undefined;
+            output?: string | undefined;
+            outputType?: string | undefined;
+            index?: number | undefined;
+            completedByTaskRun?: {
+                id: string;
+                friendlyId: string;
+                batch?: {
+                    id: string;
+                    friendlyId: string;
+                } | undefined;
+            } | undefined;
+            completedAfter?: Date | undefined;
+            completedByBatch?: {
+                id: string;
+                friendlyId: string;
+            } | undefined;
+        }[];
+        dequeuedAt: Date;
+        backgroundWorker: {
+            id: string;
+            version: string;
+            friendlyId: string;
+        };
+        checkpoint?: {
+            type: import("../../index.js").CheckpointTypeEnum;
+            id: string;
+            location: string;
+            imageRef?: string | null | undefined;
+            reason?: string | null | undefined;
+        } | undefined;
+        workerQueueLength?: number | undefined;
+        image?: string | undefined;
+        placementTags?: {
+            key: string;
+            values?: string[] | undefined;
+        }[] | undefined;
+    }[]>>;
+}
+export {};

package/dist/commonjs/v3/runEngineWorker/workload/http.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkloadHttpClient = void 0;
+const zod_1 = require("zod");
+const schemas_js_1 = require("./schemas.js");
+const util_js_1 = require("./util.js");
+const zodfetch_js_1 = require("../../zodfetch.js");
+class WorkloadHttpClient {
+    opts;
+    apiUrl;
+    runnerId;
+    deploymentId;
+    constructor(opts) {
+        this.opts = opts;
+        this.apiUrl = opts.workerApiUrl.replace(/\/$/, "");
+        this.deploymentId = opts.deploymentId;
+        this.runnerId = opts.runnerId;
+        if (!this.apiUrl) {
+            throw new Error("apiURL is required and needs to be a non-empty string");
+        }
+        if (!this.deploymentId) {
+            throw new Error("deploymentId is required and needs to be a non-empty string");
+        }
+    }
+    updateApiUrl(apiUrl) {
+        this.apiUrl = apiUrl.replace(/\/$/, "");
+    }
+    updateRunnerId(runnerId) {
+        this.runnerId = runnerId;
+    }
+    defaultHeaders() {
+        return (0, util_js_1.getDefaultWorkloadHeaders)({
+            ...this.opts,
+            runnerId: this.runnerId,
+        });
+    }
+    async heartbeatRun(runId, snapshotId, body) {
+        return (0, zodfetch_js_1.wrapZodFetch)(schemas_js_1.WorkloadHeartbeatResponseBody, `${this.apiUrl}/api/v1/workload-actions/runs/${runId}/snapshots/${snapshotId}/heartbeat`, {
+            method: "POST",
+            headers: {
+                ...this.defaultHeaders(),
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(body ?? {}),
+        });
+    }
+    async suspendRun(runId, snapshotId) {
+        return (0, zodfetch_js_1.wrapZodFetch)(schemas_js_1.WorkloadSuspendRunResponseBody, `${this.apiUrl}/api/v1/workload-actions/runs/${runId}/snapshots/${snapshotId}/suspend`, {
+            method: "GET",
+            headers: {
+                ...this.defaultHeaders(),
+            },
+        });
+    }
+    async continueRunExecution(runId, snapshotId) {
+        return (0, zodfetch_js_1.wrapZodFetch)(schemas_js_1.WorkloadContinueRunExecutionResponseBody, `${this.apiUrl}/api/v1/workload-actions/runs/${runId}/snapshots/${snapshotId}/continue`, {
+            method: "GET",
+            headers: {
+                ...this.defaultHeaders(),
+            },
+        });
+    }
+    async startRunAttempt(runId, snapshotId, body) {
+        return (0, zodfetch_js_1.wrapZodFetch)(schemas_js_1.WorkloadRunAttemptStartResponseBody, `${this.apiUrl}/api/v1/workload-actions/runs/${runId}/snapshots/${snapshotId}/attempts/start`, {
+            method: "POST",
+            headers: {
+                ...this.defaultHeaders(),
+            },
+            body: JSON.stringify(body),
+        });
+    }
+    async completeRunAttempt(runId, snapshotId, body) {
+        return (0, zodfetch_js_1.wrapZodFetch)(schemas_js_1.WorkloadRunAttemptCompleteResponseBody, `${this.apiUrl}/api/v1/workload-actions/runs/${runId}/snapshots/${snapshotId}/attempts/complete`, {
+            method: "POST",
+            headers: {
+                ...this.defaultHeaders(),
+            },
+            body: JSON.stringify(body),
+        });
+    }
+    async getSnapshotsSince(runId, snapshotId) {
+        return (0, zodfetch_js_1.wrapZodFetch)(schemas_js_1.WorkloadRunSnapshotsSinceResponseBody, `${this.apiUrl}/api/v1/workload-actions/runs/${runId}/snapshots/since/${snapshotId}`, {
+            method: "GET",
+            headers: {
+                ...this.defaultHeaders(),
+            },
+        });
+    }
+    async sendDebugLog(runId, body) {
+        try {
+            const res = await (0, zodfetch_js_1.wrapZodFetch)(zod_1.z.unknown(), `${this.apiUrl}/api/v1/workload-actions/runs/${runId}/logs/debug`, {
+                method: "POST",
+                headers: {
+                    ...this.defaultHeaders(),
+                    "Content-Type": "application/json",
+                },
+                body: JSON.stringify(body),
+            });
+            if (!res.success) {
+                console.error("Failed to send debug log", res);
+            }
+        }
+        catch (error) {
+            console.error("Failed to send debug log", { error });
+        }
+    }
+    /** @deprecated Not currently used */
+    async dequeue() {
+        return (0, zodfetch_js_1.wrapZodFetch)(schemas_js_1.WorkloadDequeueFromVersionResponseBody, `${this.apiUrl}/api/v1/workload-actions/deployments/${this.deploymentId}/dequeue`, {
+            method: "GET",
+            headers: {
+                ...this.defaultHeaders(),
+            },
+        });
+    }
+}
+exports.WorkloadHttpClient = WorkloadHttpClient;
+//# sourceMappingURL=http.js.map

package/dist/commonjs/v3/runEngineWorker/workload/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../../../../src/v3/runEngineWorker/workload/http.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,6CAYsB;AAEtB,uCAAsD;AACtD,mDAAiD;AAIjD,MAAa,kBAAkB;IAKT;IAJZ,MAAM,CAAS;IACf,QAAQ,CAAS;IACR,YAAY,CAAS;IAEtC,YAAoB,IAA+B;QAA/B,SAAI,GAAJ,IAAI,CAA2B;QACjD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE9B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IAED,YAAY,CAAC,MAAc;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,cAAc,CAAC,QAAgB;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,cAAc;QACZ,OAAO,IAAA,mCAAyB,EAAC;YAC/B,GAAG,IAAI,CAAC,IAAI;YACZ,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,UAAkB,EAAE,IAAmC;QACvF,OAAO,IAAA,0BAAY,EACjB,0CAA6B,EAC7B,GAAG,IAAI,CAAC,MAAM,iCAAiC,KAAK,cAAc,UAAU,YAAY,EACxF;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,cAAc,EAAE;gBACxB,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;SACjC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAa,EAAE,UAAkB;QAChD,OAAO,IAAA,0BAAY,EACjB,2CAA8B,EAC9B,GAAG,IAAI,CAAC,MAAM,iCAAiC,KAAK,cAAc,UAAU,UAAU,EACtF;YACE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,cAAc,EAAE;aACzB;SACF,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,KAAa,EAAE,UAAkB;QAC1D,OAAO,IAAA,0BAAY,EACjB,qDAAwC,EACxC,GAAG,IAAI,CAAC,MAAM,iCAAiC,KAAK,cAAc,UAAU,WAAW,EACvF;YACE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,cAAc,EAAE;aACzB;SACF,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,KAAa,EACb,UAAkB,EAClB,IAAwC;QAExC,OAAO,IAAA,0BAAY,EACjB,gDAAmC,EACnC,GAAG,IAAI,CAAC,MAAM,iCAAiC,KAAK,cAAc,UAAU,iBAAiB,EAC7F;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,cAAc,EAAE;aACzB;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,KAAa,EACb,UAAkB,EAClB,IAA2C;QAE3C,OAAO,IAAA,0BAAY,EACjB,mDAAsC,EACtC,GAAG,IAAI,CAAC,MAAM,iCAAiC,KAAK,cAAc,UAAU,oBAAoB,EAChG;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,cAAc,EAAE;aACzB;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,KAAa,EAAE,UAAkB;QACvD,OAAO,IAAA,0BAAY,EACjB,kDAAqC,EACrC,GAAG,IAAI,CAAC,MAAM,iCAAiC,KAAK,oBAAoB,UAAU,EAAE,EACpF;YACE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,cAAc,EAAE;aACzB;SACF,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,IAAiC;QACjE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAA,0BAAY,EAC5B,OAAC,CAAC,OAAO,EAAE,EACX,GAAG,IAAI,CAAC,MAAM,iCAAiC,KAAK,aAAa,EACjE;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,GAAG,IAAI,CAAC,cAAc,EAAE;oBACxB,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,CACF,CAAC;YAEF,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;gBACjB,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,qCAAqC;IACrC,KAAK,CAAC,OAAO;QACX,OAAO,IAAA,0BAAY,EACjB,mDAAsC,EACtC,GAAG,IAAI,CAAC,MAAM,wCAAwC,IAAI,CAAC,YAAY,UAAU,EACjF;YACE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,cAAc,EAAE;aACzB;SACF,CACF,CAAC;IACJ,CAAC;CACF;AAhKD,gDAgKC"}