fix(client): Add missing error handling and interceptors for workflow describe (#484)

* fix(client): Add missing error handling and interceptors for workflow describe

* Update packages/client/src/interceptors.ts

Co-authored-by: Roey Berman <[email protected]>

* Update packages/client/src/interceptors.ts

Co-authored-by: Roey Berman <[email protected]>

* Add Workflow result interceptor to Client

* Revert "Add Workflow result interceptor to Client"

This reverts commit 0df3fd4.

* Remove firstExecutionRunId

Co-authored-by: Loren ☺️ <[email protected]>
Co-authored-by: Roey Berman <[email protected]>
Co-authored-by: Loren 🤓 <[email protected]>

Author: 3 people

packages/client/src/interceptors.ts

@@ -4,10 +4,15 @@
  * @module
  */
 
-import { Next, Headers } from '@temporalio/internal-workflow-common';
+import { Headers, Next } from '@temporalio/internal-workflow-common';
 import { temporal } from '@temporalio/proto';
+import {
+  DescribeWorkflowExecutionResponse,
+  RequestCancelWorkflowExecutionResponse,
+  TerminateWorkflowExecutionResponse,
+  WorkflowExecution,
+} from './types';
 import { CompiledWorkflowOptions } from './workflow-options';
-import { RequestCancelWorkflowExecutionResponse, TerminateWorkflowExecutionResponse, WorkflowExecution } from './types';
 
 export { Next, Headers };
 
@@ -57,6 +62,11 @@ export interface WorkflowCancelInput {
   readonly firstExecutionRunId?: string;
 }
 
+/** Input for WorkflowClientCallsInterceptor.describe */
+export interface WorkflowDescribeInput {
+  readonly workflowExecution: WorkflowExecution;
+}
+
 /**
  * Implement any of these methods to intercept WorkflowClient outbound calls
  */
@@ -94,6 +104,10 @@ export interface WorkflowClientCallsInterceptor {
    * Intercept a service call to requestCancelWorkflowExecution
    */
   cancel?: (input: WorkflowCancelInput, next: Next<this, 'cancel'>) => Promise<RequestCancelWorkflowExecutionResponse>;
+  /**
+   * Intercept a service call to describeWorkflowExecution
+   */
+  describe?: (input: WorkflowDescribeInput, next: Next<this, 'describe'>) => Promise<DescribeWorkflowExecutionResponse>;
 }
 
 interface WorkflowClientCallsInterceptorFactoryInput {

packages/client/src/workflow-client.ts

@@ -43,6 +43,7 @@ import {
   WorkflowCancelInput,
   WorkflowClientCallsInterceptor,
   WorkflowClientInterceptors,
+  WorkflowDescribeInput,
   WorkflowQueryInput,
   WorkflowSignalInput,
   WorkflowSignalWithStartInput,
@@ -711,6 +712,22 @@ export class WorkflowClient {
     }
   }
 
+  /**
+   * Uses given input to make describeWorkflowExecution call to the service
+   *
+   * Used as the final function of the describe interceptor chain
+   */
+  protected async _describeWorkflowHandler(input: WorkflowDescribeInput): Promise<DescribeWorkflowExecutionResponse> {
+    try {
+      return await this.service.describeWorkflowExecution({
+        namespace: this.options.namespace,
+        execution: input.workflowExecution,
+      });
+    } catch (err) {
+      this.rethrowGrpcError(err, input.workflowExecution, 'Failed to describe workflow');
+    }
+  }
+
   /**
    * Create a new workflow handle for new or existing Workflow execution
    */
@@ -722,8 +739,6 @@ export class WorkflowClient {
     runIdForResult,
     ...resultOptions
   }: WorkflowHandleOptions): WorkflowHandle<T> {
-    const namespace = this.options.namespace;
-
     return {
       client: this,
       workflowId,
@@ -748,12 +763,10 @@ export class WorkflowClient {
         });
       },
       async describe() {
-        return this.client.service.describeWorkflowExecution({
-          namespace,
-          execution: {
-            runId,
-            workflowId,
-          },
+        const next = this.client._describeWorkflowHandler.bind(this.client);
+        const fn = interceptors.length ? composeInterceptors(interceptors, 'describe', next) : next;
+        return await fn({
+          workflowExecution: { workflowId, runId },
         });
       },
       async signal<Args extends any[]>(def: SignalDefinition<Args> | string, ...args: Args): Promise<void> {