Workflow authoring support

examples/workflow/authoring/src/activity-sequence.ts

@@ -15,15 +15,15 @@ import { DaprWorkflowClient, WorkflowActivityContext, WorkflowContext, WorkflowR
 
 async function start() {
   // Update the gRPC client and worker to use a local address and port
-  const clientHost = "localhost";
-  const clientPort = "50001"
+  const daprHost = "localhost";
+  const daprPort = "50001";
   const workflowClient = new DaprWorkflowClient({
-    clientHost,
-    clientPort,
+    daprHost,
+    daprPort,
   });
   const workflowRuntime = new WorkflowRuntime({
-    clientHost,
-    clientPort,
+    daprHost,
+    daprPort,
   });
 
   const hello = async (_: WorkflowActivityContext, name: string) => {

examples/workflow/authoring/src/fanout-fanin.ts

@@ -23,15 +23,15 @@ import {
 // Wrap the entire code in an immediately-invoked async function
 async function start() {
   // Update the gRPC client and worker to use a local address and port
-  const clientHost = "localhost";
-  const clientPort = "50001"
+  const daprHost = "localhost";
+  const daprPort = "50001";
   const workflowClient = new DaprWorkflowClient({
-    clientHost,
-    clientPort,
+    daprHost,
+    daprPort,
   });
   const workflowRuntime = new WorkflowRuntime({
-    clientHost,
-    clientPort,
+    daprHost,
+    daprPort,
   });
 
   function getRandomInt(min: number, max: number): number {

examples/workflow/authoring/src/human-interaction.ts

@@ -39,18 +39,18 @@ async function start() {
   }
 
   // Update the gRPC client and worker to use a local address and port
-  const clientHost = "localhost";
-  const clientPort = "50001"
+  const daprHost = "localhost";
+  const daprPort = "50001";
   const workflowClient = new DaprWorkflowClient({
-    clientHost,
-    clientPort,
+    daprHost,
+    daprPort,
   });
   const workflowRuntime = new WorkflowRuntime({
-    clientHost,
-    clientPort,
+    daprHost,
+    daprPort,
   });
 
-  //Activity function that sends an approval request to the manager
+  // Activity function that sends an approval request to the manager
   const sendApprovalRequest = async (_: WorkflowActivityContext, order: Order) => {
     // Simulate some work that takes an amount of time
     await sleep(3000);
@@ -111,7 +111,7 @@ async function start() {
     const id = await workflowClient.scheduleNewWorkflow(purchaseOrderWorkflow, order);
     console.log(`Orchestration scheduled with ID: ${id}`);
 
-    //prompt for approval asynchronously
+    // prompt for approval asynchronously
     promptForApproval(approver, workflowClient, id);
 
     // Wait for orchestration completion

src/types/workflow/WorkflowClientOption.ts

@@ -19,13 +19,13 @@ export type WorkflowClientOptions = {
    * Host location of the Dapr sidecar.
    * Default is 127.0.0.1.
    */
-  clientHost: string;
+  daprHost: string;
 
   /**
-   * Port of the Dapr sidecar.
-   * Default is 4001.
+   * Port of the Dapr sidecar running a gRPC server.
+   * Default is 50001.
    */
-  clientPort: string;
+  daprPort: string;
 
   /**
    * Options related to logging.

src/workflow/client/DaprWorkflowClient.ts

@@ -18,6 +18,7 @@
 import { getFunctionName } from "../internal";
 import { Settings } from "../../utils/Settings.util";
 import { WorkflowClientOptions } from "../../types/workflow/WorkflowClientOption";
+import { GrpcEndpoint } from "../../network/GrpcEndpoint";
 
 /**
  * Class that defines client operations for managing workflow instances.
@@ -33,19 +34,19 @@
    * @param {WorkflowClientOptions | undefined} options - Additional options for configuring DaprWorkflowClient.
    */
   constructor(options: Partial<WorkflowClientOptions> = {}) {
-    const hostAddress = this.generateHostAddress(options);
-    options.daprApiToken = this.generateDaprApiToken(options);
-    this._innerClient = this.buildInnerClient(hostAddress, options);
+    const grpcEndpoint = this.generateEndpoint(options);
+    options.daprApiToken = this.getDaprApiToken(options);
+    this._innerClient = this.buildInnerClient(grpcEndpoint.endpoint, options);
   }
 
-  private generateHostAddress(options: Partial<WorkflowClientOptions>): string {
-    const host = options?.clientHost ?? Settings.getDefaultHost();
-    const port = options?.clientPort ?? Settings.getDefaultGrpcPort();
-    const hostAddress = `${host}:${port}`;
-    return hostAddress;
+  private generateEndpoint(options: Partial<WorkflowClientOptions>): GrpcEndpoint {
+    const host = options?.daprHost ?? Settings.getDefaultHost();
+    const port = options?.daprPort ?? Settings.getDefaultGrpcPort();
+    const uri = `${host}:${port}`;
+    return new GrpcEndpoint(uri);
   }
 
-  private generateDaprApiToken(options: Partial<WorkflowClientOptions>): string | undefined {
+  private getDaprApiToken(options: Partial<WorkflowClientOptions>): string | undefined {
     const daprApiToken = options?.daprApiToken ?? Settings.getDefaultApiToken();
     return daprApiToken;
   }
@@ -53,7 +54,7 @@
   private buildInnerClient(hostAddress: string, options: Partial<WorkflowClientOptions>): TaskHubGrpcClient {
     let innerOptions = options?.grpcOptions;
     if (options.daprApiToken !== undefined && options.daprApiToken !== "") {
       innerOptions = {
         ...innerOptions,
         interceptors: [generateApiTokenClientInterceptors(options), ...(innerOptions?.interceptors ?? [])],
       };
@@ -77,7 +78,7 @@
     startAt?: Date,
   ): Promise<string> {
     if (typeof workflow === "string") {
       return await this._innerClient.scheduleNewOrchestration(workflow, input, instanceId, startAt);
     }
     return await this._innerClient.scheduleNewOrchestration(getFunctionName(workflow), input, instanceId, startAt);
   }
@@ -106,9 +107,9 @@
     workflowInstanceId: string,
     getInputsAndOutputs: boolean,
   ): Promise<WorkflowState | undefined> {
     const state = await this._innerClient.getOrchestrationState(workflowInstanceId, getInputsAndOutputs);
     if (state !== undefined) {
       return new WorkflowState(state);
     }
   }
 
@@ -202,7 +203,7 @@
     if (purgeResult !== undefined) {
       return purgeResult.deletedInstanceCount > 0;
     }
     return false;
   }
 
   /**

src/workflow/runtime/WorkflowRuntime.ts

@@ -21,6 +21,7 @@
 import { getFunctionName } from "../internal";
 import { Settings } from "../../utils/Settings.util";
 import { WorkflowClientOptions } from "../../types/workflow/WorkflowClientOption";
+import { GrpcEndpoint } from "../../network/GrpcEndpoint";
 
 /**
  * Contains methods to register workflows and activities.
@@ -33,19 +34,19 @@
    * @param {WorkflowClientOptions | undefined} options - Additional options for configuring WorkflowRuntime.
    */
   constructor(options: Partial<WorkflowClientOptions> = {}) {
-    const hostAddress = this.generateHostAddress(options);
-    options.daprApiToken = this.generateDaprApiToken(options);
-    this.worker = this.buildInnerWorker(hostAddress, options);
+    const grpcEndpoint = this.generateEndpoint(options);
+    options.daprApiToken = this.getDaprApiToken(options);
+    this.worker = this.buildInnerWorker(grpcEndpoint.endpoint, options);
   }
 
-  private generateHostAddress(options: Partial<WorkflowClientOptions>): string {
-    const host = options?.clientHost ?? Settings.getDefaultHost();
-    const port = options?.clientPort ?? Settings.getDefaultGrpcPort();
-    const hostAddress = `${host}:${port}`;
-    return hostAddress;
+  private generateEndpoint(options: Partial<WorkflowClientOptions>): GrpcEndpoint {
+    const host = options?.daprHost ?? Settings.getDefaultHost();
+    const port = options?.daprPort ?? Settings.getDefaultGrpcPort();
+    const uri = `${host}:${port}`;
+    return new GrpcEndpoint(uri);
   }
 
-  private generateDaprApiToken(options: Partial<WorkflowClientOptions>): string | undefined {
+  private getDaprApiToken(options: Partial<WorkflowClientOptions>): string | undefined {
     const daprApiToken = options?.daprApiToken ?? Settings.getDefaultApiToken();
     return daprApiToken;
   }
@@ -53,7 +54,7 @@
   private buildInnerWorker(hostAddress: string, options: Partial<WorkflowClientOptions>): TaskHubGrpcWorker {
     let innerOptions = options?.grpcOptions;
     if (options.daprApiToken !== undefined && options.daprApiToken !== "") {
       innerOptions = {
         ...innerOptions,
         interceptors: [generateApiTokenClientInterceptors(options), ...(innerOptions?.interceptors ?? [])],
       };
@@ -84,12 +85,12 @@
    * @param {TWorkflow} workflow - The instance of the Workflow class being registered.
    */
   public registerWorkflowWithName(name: string, workflow: TWorkflow): WorkflowRuntime {
     const workflowWrapper = (ctx: OrchestrationContext, input: any): any => {
       const workflowContext = new WorkflowContext(ctx);
       return workflow(workflowContext, input);
     };
     this.worker.addNamedOrchestrator(name, workflowWrapper);
     return this;
   }
 
   /**
@@ -117,13 +118,13 @@
    * @returns {WorkflowRuntime} The current instance of WorkflowRuntime.
    */
   public registerActivityWithName(name: string, fn: TWorkflowActivity<TInput, TOutput>): WorkflowRuntime {
     const activityWrapper = (ctx: ActivityContext, intput: TInput): any => {
       const wfActivityContext = new WorkflowActivityContext(ctx);
       return fn(wfActivityContext, intput);
     };
 
     this.worker.addNamedActivity(name, activityWrapper);
     return this;
   }
 
   /**

test/e2e/workflow/workflow.test.ts

@@ -30,12 +30,12 @@
   beforeEach(async () => {
     // Start a worker, which will connect to the sidecar in a background thread
     workflowClient = new DaprWorkflowClient({
-      clientHost,
-      clientPort,
+      daprHost: clientHost,
+      daprPort: clientPort,
     });
     workflowRuntime = new WorkflowRuntime({
-      clientHost,
-      clientPort,
+      daprHost: clientHost,
+      daprPort: clientPort,
     });
   });
 
@@ -209,7 +209,7 @@
     expect(state?.runtimeStatus).toEqual(WorkflowRuntimeStatus.COMPLETED);
     expect(state?.createdAt).toBeDefined();
     expect(state?.lastUpdatedAt).toBeDefined();
     expect(expectedCompletionSecond).toBeLessThanOrEqual(actualCompletionSecond!);
   }, 31000);
 
   it("should wait for external events with a timeout - true", async () => {