Fix getUpdateHandle API (#1320)

* Fixes a mistake in the recently-introduced update
`workflowHandle.getUpdateHandle(...)` API
#1312. It should not
take `workflowId` as an argument since the appropriate `workflowId` is
the one on the `workflowHandle`.

* Also remove `GetWorkflowUpdateHandleOptions` for now.

Author: dandavison

packages/client/src/workflow-client.ts

@@ -165,13 +165,9 @@ export interface WorkflowHandle<T extends Workflow = Workflow> extends BaseWorkf
   ): Promise<WorkflowUpdateHandle<Ret>>;
 
   /**
-   * Get a handle to an Update.
+   * Get a handle to an Update of this Workflow.
    */
-  getUpdateHandle<Ret>(
-    updateId: string,
-    workflowId: string,
-    options?: GetWorkflowUpdateHandleOptions
-  ): WorkflowUpdateHandle<Ret>;
+  getUpdateHandle<Ret>(updateId: string): WorkflowUpdateHandle<Ret>;
 
   /**
    * Query a running or completed Workflow.
@@ -476,7 +472,7 @@ export class WorkflowClient extends BaseClient {
 
   /**
    * Sends a signal to a running Workflow or starts a new one if not already running and immediately signals it.
-   * Useful when you're unsure of the Workflows' run state.
+   * Useful when you're unsure of the Workflow's run state.
    *
    * @returns the runId of the Workflow
    */
@@ -799,10 +795,9 @@ export class WorkflowClient extends BaseClient {
   protected createWorkflowUpdateHandle<Ret>(
     updateId: string,
     workflowId: string,
-    options?: GetWorkflowUpdateHandleOptions,
+    workflowRunId?: string,
     outcome?: temporal.api.update.v1.IOutcome
   ): WorkflowUpdateHandle<Ret> {
-    const workflowRunId = options?.workflowRunId;
     return {
       updateId,
       workflowId,
@@ -1077,7 +1072,7 @@ export class WorkflowClient extends BaseClient {
       return this.createWorkflowUpdateHandle<Ret>(
         output.updateId,
         input.workflowExecution.workflowId,
-        { workflowRunId: output.workflowRunId },
+        output.workflowRunId,
         output.outcome
       );
     };
@@ -1156,12 +1151,8 @@ export class WorkflowClient extends BaseClient {
         );
         return await handle.result();
       },
-      getUpdateHandle<Ret>(
-        updateId: string,
-        workflowId: string,
-        options?: GetWorkflowUpdateHandleOptions
-      ): WorkflowUpdateHandle<Ret> {
-        return this.client.createWorkflowUpdateHandle(updateId, workflowId, options);
+      getUpdateHandle<Ret>(updateId: string): WorkflowUpdateHandle<Ret> {
+        return this.client.createWorkflowUpdateHandle(updateId, workflowId, runId);
       },
       async signal<Args extends any[]>(def: SignalDefinition<Args> | string, ...args: Args): Promise<void> {
         const next = this.client._signalWorkflowHandler.bind(this.client);

packages/test/src/test-integration-update.ts

@@ -69,18 +69,28 @@ test('Update handle can be created from identifiers and used to obtain result',
     const wfHandle = await startWorkflow(workflowWithUpdates);
     const updateHandleFromStartUpdate = await wfHandle.startUpdate(update, { args: ['1'], updateId });
 
-    const updateHandle = wfHandle.getUpdateHandle(updateId, wfHandle.workflowId);
+    // Obtain update handle on workflow handle from start update.
+    const updateHandle = wfHandle.getUpdateHandle(updateId);
     t.deepEqual(await updateHandle.result(), ['1']);
 
+    // Obtain update handle on manually-created workflow handle with no run id.
     t.truthy(updateHandleFromStartUpdate.workflowRunId);
-    const updateHandle2 = wfHandle.getUpdateHandle(updateId, wfHandle.workflowId, {
-      workflowRunId: updateHandleFromStartUpdate.workflowRunId,
-    });
+    const freshWorkflowHandleWithoutRunId = t.context.env.client.workflow.getHandle(wfHandle.workflowId);
+    const updateHandle2 = freshWorkflowHandleWithoutRunId.getUpdateHandle(updateId);
     t.deepEqual(await updateHandle2.result(), ['1']);
 
-    const incorrectRunId = wf.uuid4();
-    const updateHandle3 = wfHandle.getUpdateHandle(updateId, wfHandle.workflowId, { workflowRunId: incorrectRunId });
-    const err = await t.throwsAsync(updateHandle3.result());
+    // Obtain update handle on manually-created workflow handle with run id.
+    const freshWorkflowHandleWithRunId = t.context.env.client.workflow.getHandle(
+      wfHandle.workflowId,
+      updateHandleFromStartUpdate.workflowRunId
+    );
+    const updateHandle3 = freshWorkflowHandleWithRunId.getUpdateHandle(updateId);
+    t.deepEqual(await updateHandle3.result(), ['1']);
+
+    // Obtain update handle on manually-created workflow handle with incorrect run id.
+    const workflowHandleWithIncorrectRunId = t.context.env.client.workflow.getHandle(wfHandle.workflowId, wf.uuid4());
+    const updateHandle4 = workflowHandleWithIncorrectRunId.getUpdateHandle(updateId);
+    const err = await t.throwsAsync(updateHandle4.result());
     t.true(isGrpcServiceError(err) && err.code === grpcStatus.NOT_FOUND);
   });
 });