Mainly Idempotency Key support (#66)

* fix: imports

* feat: added idempotencyKey support

* feat: added displayName to HumanTaskEntry

Author: Sudakatux

src/common/open-api/models/HumanTaskEntry.ts

@@ -11,6 +11,7 @@ export type HumanTaskEntry = {
   createdBy?: string;
   createdOn?: number;
   definitionName?: string;
+  displayName?: string;
   humanTaskDef?: HumanTaskDefinition;
   input?: Record<string, any>;
   output?: Record<string, any>;

src/common/open-api/models/StartWorkflowRequest.ts

@@ -12,6 +12,8 @@ export type StartWorkflowRequest = {
   taskToDomain?: Record<string, string>;
   workflowDef?: WorkflowDef;
   externalInputPayloadStoragePath?: string;
+  idempotencyKey?: string;
+  idempotencyStrategy?: 'FAIL' | 'RETURN_EXISTING';
   priority?: number;
   createdBy?: string;
 };

src/common/open-api/models/SubWorkflowParams.ts

@@ -9,5 +9,7 @@ export type SubWorkflowParams = {
   version?: number;
   taskToDomain?: Record<string, string>;
   workflowDefinition?: WorkflowDef;
+  idempotencyKey?: string;
+  idempotencyStrategy?: 'FAIL' | 'RETURN_EXISTING';
 };
 

src/common/open-api/models/Workflow.ts

@@ -12,6 +12,7 @@ export type Workflow = {
   createdBy?: string;
   updatedBy?: string;
   status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
+  idempotencyKey?: string;
   endTime?: number;
   workflowId?: string;
   parentWorkflowId?: string;

src/core/__test__/MetadataClient.test.ts

@@ -1,5 +1,6 @@
 import { expect, describe, test, jest } from "@jest/globals";
-import { MetadataClient, taskDefinition } from "..";
+import { MetadataClient } from "../metadataClient";
+import { taskDefinition } from "../sdk";
 import { orkesConductorClient, OrkesApiConfig } from "../../orkes";
 
 const playConfig: Partial<OrkesApiConfig> = {

src/core/__test__/executor.test.ts

@@ -99,4 +99,18 @@ describe("Executor", () => {
     expect(workflowStatus.status).toBeTruthy();
     expect(workflowStatus.tasks?.length).toBe(1);
   });
+  test("Should execute a workflow with indempotency key", async () => {
+    const client = await clientPromise;
+    const executor = new WorkflowExecutor(client);
+    const idempotencyKey = uuidv4();
+    const executionId = await executor.startWorkflow({
+      name: name,
+      version: version,
+      idempotencyKey,
+      idempotencyStrategy: "RETURN_EXISTING",
+    });
+
+    const executionDetails = await executor.getWorkflow(executionId!, true);
+    expect(executionDetails.idempotencyKey).toEqual(idempotencyKey);
+  });
 });

src/core/taskClient.ts

@@ -1,4 +1,4 @@
-import { TaskResultStatus } from "../../dist";
+import { TaskResultStatus } from "../core/types";
 import {
   ConductorClient,
   SearchResultTask,