Cancel run added to the SDK

Author: matt-aitken

.changeset/tiny-doors-type.md

@@ -0,0 +1,6 @@
+---
+"@trigger.dev/sdk": patch
+"@trigger.dev/core": patch
+---
+
+Added cancelRun to the SDK

apps/webapp/app/routes/api.v2.runs.$runParam.cancel.ts

@@ -25,7 +25,7 @@ export async function action({ request, params }: ActionFunctionArgs) {
   const parsed = ParamsSchema.safeParse(params);
 
   if (!parsed.success) {
-    return json({ error: "Invalid or Missing runId" }, { status: 400 });
+    return json({ error: "Invalid or Missing run id" }, { status: 400 });
   }
 
   const { runParam } = parsed.data;

docs/v3-openapi.json

@@ -106,6 +106,101 @@
           }
         ]
       }
+    },
+    "/api/v1/runs/{run_id}/cancel": {
+      "post": {
+        "description": "Cancels a run.",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "run_id",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "The ID of an existing run. When you trigger a run you will get an id in the response."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "description": "Confirmation message that the run was canceled."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "enum": ["Invalid or missing run ID", "Failed to create new run"]
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "enum": ["Invalid or Missing API key"]
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Resource not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "enum": ["Run not found"]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "tags": ["run"],
+        "security": [{ "bearerAuth": [] }],
+        "operationId": "replay_run_v1",
+        "x-codeSamples": [
+          {
+            "lang": "typescript",
+            "source": "await cancelRun(existingRun.id);"
+          },
+          {
+            "lang": "sh",
+            "source": "curl --request POST \\\n\t--url https://api.trigger.dev/api/v1/runs/{run_id}/cancel \\\n\t--header 'Authorization: Bearer <token>'"
+          }
+        ]
+      }
     }
   },
   "components": {

docs/v3/rest-cancel-run.mdx

@@ -1,7 +1,4 @@
 ---
-title: "REST API: Cancel run"
-sidebarTitle: "Cancel run"
-description: "Cancel a run using a run id."
+title: "Cancel run"
+openapi: "v3-openapi POST /api/v1/runs/{run_id}/cancel"
 ---
-
-<Snippet file="incomplete-docs.mdx" />

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

@@ -10,7 +10,9 @@ import {
   BatchTriggerTaskResponse,
   CreateUploadPayloadUrlResponseBody,
   ReplayRunResponse,
+  CanceledRunResponse,
 } from "../schemas";
+import { z } from "zod";
 
 export type TriggerOptions = {
   spanParentAsLink?: boolean;
@@ -101,6 +103,18 @@ export class ApiClient {
     );
   }
 
+  cancelRun(runId: string) {
+    return zodfetch(
+      CanceledRunResponse,
+      `${this.baseUrl}/api/v2/runs/${runId}/cancel`,
+      {
+        method: "POST",
+        headers: this.#getHeaders(false),
+      },
+      zodFetchOptions
+    );
+  }
+
   #getHeaders(spanParentAsLink: boolean) {
     const headers: Record<string, string> = {
       "Content-Type": "application/json",

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

@@ -204,3 +204,9 @@ export const ReplayRunResponse = z.object({
 });
 
 export type ReplayRunResponse = z.infer<typeof ReplayRunResponse>;
+
+export const CanceledRunResponse = z.object({
+  message: z.string(),
+});
+
+export type CanceledRunResponse = z.infer<typeof CanceledRunResponse>;

packages/trigger-sdk/src/v3/index.ts

@@ -9,4 +9,4 @@ export type { Context };
 
 export { logger, type LogLevel } from "@trigger.dev/core/v3";
 
-export { replayRun } from "./management";
+export { replayRun, cancelRun } from "./management";

packages/trigger-sdk/src/v3/management.ts

@@ -1,4 +1,4 @@
-import { ReplayRunResponse, apiClientManager } from "@trigger.dev/core/v3";
+import { CanceledRunResponse, ReplayRunResponse, apiClientManager } from "@trigger.dev/core/v3";
 import { apiClientMissingError } from "./shared";
 
 export async function replayRun(runId: string): Promise<ReplayRunResponse> {
@@ -16,3 +16,19 @@ export async function replayRun(runId: string): Promise<ReplayRunResponse> {
 
   return response.data;
 }
+
+export async function cancelRun(runId: string): Promise<CanceledRunResponse> {
+  const apiClient = apiClientManager.client;
+
+  if (!apiClient) {
+    throw apiClientMissingError();
+  }
+
+  const response = await apiClient.cancelRun(runId);
+
+  if (!response.ok) {
+    throw new Error(response.error);
+  }
+
+  return response.data;
+}