Merge pull request #80 from defer-run/add-cancel-execution

.changeset/afraid-candles-enjoy.md

@@ -0,0 +1,5 @@
+---
+"@defer/client": minor
+---
+
+Remove running state

.changeset/brave-jars-yawn.md

@@ -0,0 +1,15 @@
+---
+"@defer/client": minor
+---
+
+Add cancel execution:
+
+```ts
+import { cancelExecution } from "@defer/client";
+
+// ...
+
+const { id } = await cancelExecution(executionId);
+
+// ...
+```

.github/workflows/tests.yml

@@ -11,6 +11,7 @@ jobs:
     name: "Node ${{matrix.node_version}}"
     runs-on: "ubuntu-latest"
     strategy:
+      fail-fast: false
       matrix:
         node-version: [16, 18, 20]
     steps:

package.json

@@ -96,4 +96,4 @@
     "directory": "dist",
     "access": "public"
   }
-}
+}

src/cancelExecution.ts

@@ -0,0 +1,13 @@
+import {
+  cancelExecution as cancelExecution2,
+  CancelExecutionResponse,
+} from "./client.js";
+import { __httpClient } from "./index.js";
+
+export async function cancelExecution(
+  id: string
+): Promise<CancelExecutionResponse> {
+  if (__httpClient) return cancelExecution2(__httpClient, { id });
+
+  return {};
+}

src/client.ts

@@ -18,12 +18,7 @@ export interface FetchExecutionRequest {
   id: string;
 }
 
-export type ExecutionState =
-  | "running"
-  | "created"
-  | "failed"
-  | "succeed"
-  | "started";
+export type ExecutionState = "created" | "failed" | "succeed" | "started";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface FetchExecutionResponse<R = any> {
@@ -37,6 +32,20 @@ export type PoolExecutionRequest = FetchExecutionRequest;
 
 export type PoolExecutionResponse = FetchExecutionResponse;
 
+export type CancelExecutionRequest = FetchExecutionRequest;
+
+export interface CancelExecutionResponse {}
+
+export function cancelExecution(
+  client: HTTPClient,
+  request: CancelExecutionRequest
+): Promise<CancelExecutionResponse> {
+  return client<CancelExecutionResponse>(
+    "POST",
+    `/public/v1/executions/${request.id}/cancel`
+  );
+}
+
 export function enqueueExecution(
   client: HTTPClient,
   request: EnqueueExecutionRequest

src/getExecution.ts

@@ -13,9 +13,8 @@ export async function getExecution(
   if (response)
     return Promise.resolve({
       ...response,
-      // TODO: bump a major and drop `running` state (invalid API state)
-      state: response.state === "started" ? "running" : response.state,
+      state: response.state,
     });
 
-  throw new APIError("execution not found", "");
+  throw new APIError("execution not found", "not found");
 }

src/index.ts

@@ -16,6 +16,7 @@ import { DeferError } from "./errors.js";
 import { HTTPClient, makeHTTPClient } from "./httpClient.js";
 
 export { getExecution } from "./getExecution.js";
+export { cancelExecution } from "./cancelExecution.js";
 
 interface Options {
   accessToken?: string;
@@ -251,7 +252,7 @@ export const defer: Defer = (fn, options) => {
       console.log(`[defer.run][${fn.name}] defer ignore, no token found.`);
 
     const id = randomUUID();
-    __database.set(id, { id: id, state: "running" });
+    __database.set(id, { id: id, state: "started" });
     execLocally(id, fn, functionArguments);
     return { id };
   };
@@ -334,7 +335,7 @@ export const delay: DeferDelay = (deferFn, delay) => {
       console.log(`[defer.run][${fn.name}] defer ignore, no token found.`);
 
     const id = randomUUID();
-    __database.set(id, { id: id, state: "running" });
+    __database.set(id, { id: id, state: "started" });
     execLocally(id, fn, functionArguments);
     return { id };
   };
@@ -403,7 +404,7 @@ export const addMetadata: DeferAddMetadata = (deferFn, metadata) => {
       console.log(`[defer.run][${fn.name}] defer ignore, no token found.`);
 
     const id = randomUUID();
-    __database.set(id, { id: id, state: "running" });
+    __database.set(id, { id: id, state: "started" });
     execLocally(id, fn, functionArguments);
     return { id };
   };
@@ -455,7 +456,7 @@ export const awaitResult: DeferAwaitResult =
       response = await waitExecutionResult(__httpClient, { id: id });
     } else {
       const id = randomUUID();
-      __database.set(id, { id: id, state: "running" });
+      __database.set(id, { id: id, state: "started" });
       response = await execLocally(id, fn, functionArguments);
     }
 

src/next/useDeferRoute.ts

@@ -77,7 +77,7 @@ export const useDeferRoute = <
   return [
     execute,
     {
-      loading: !!status && ["started", "created", "running"].includes(status),
+      loading: !!status && ["started", "created"].includes(status),
       result,
       error,
     },

src/version.ts

@@ -1 +1 @@
-export default "1.7.2";
+export default "unknow";

tests/awaitResult.spec.ts

@@ -31,7 +31,7 @@ describe("awaitResult(deferFn)", () => {
           })
           // second `/runs/:id` call
           .mockImplementationOnce(() => {
-            return { id: "1", state: "running" };
+            return { id: "1", state: "started" };
           })
           // third `/runs/:id` call
           .mockImplementationOnce(() => {