fix: Fail workflow on WorkflowExecutionAlreadyStartedError (#1068)

Author: bergundy

packages/common/src/errors.ts

@@ -1,3 +1,5 @@
+import { TemporalFailure } from './failure';
+
 /**
  * Thrown from code that receives a value that is unexpected or that it's unable to handle.
  */
@@ -31,7 +33,7 @@ export class IllegalStateError extends Error {
  *  - There is closed Workflow in the `Completed` state with the same Workflow Id and the {@link WorkflowOptions.workflowIdReusePolicy}
  *    is `WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY`
  */
-export class WorkflowExecutionAlreadyStartedError extends Error {
+export class WorkflowExecutionAlreadyStartedError extends TemporalFailure {
   public readonly name: string = 'WorkflowExecutionAlreadyStartedError';
 
   constructor(message: string, public readonly workflowId: string, public readonly workflowType: string) {

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

@@ -0,0 +1,64 @@
+import { randomUUID } from 'crypto';
+import { TestFn } from 'ava';
+import { WorkflowFailedError } from '@temporalio/client';
+import { TestWorkflowEnvironment } from '@temporalio/testing';
+import { bundleWorkflowCode } from '@temporalio/worker';
+import * as workflow from '@temporalio/workflow';
+import { test as anyTest, bundlerOptions, Worker } from './helpers';
+
+interface Context {
+  env: TestWorkflowEnvironment;
+  taskQueue: string;
+  createWorker(): Promise<Worker>;
+}
+
+const test = anyTest as TestFn<Context>;
+
+test.before(async (t) => {
+  const env = await TestWorkflowEnvironment.createLocal();
+  const taskQueue = 'test';
+  const workflowBundle = await bundleWorkflowCode({
+    ...bundlerOptions,
+    workflowsPath: __filename,
+  });
+  async function createWorker() {
+    return await Worker.create({
+      connection: env.nativeConnection,
+      taskQueue,
+      workflowBundle,
+    });
+  }
+  t.context = {
+    env,
+    taskQueue,
+    createWorker,
+  };
+});
+
+test.after.always(async (t) => {
+  await t.context.env.teardown();
+});
+
+export async function parent(): Promise<void> {
+  await workflow.startChild(child, { workflowId: 'child' });
+  await workflow.startChild(child, { workflowId: 'child' });
+}
+
+export async function child(): Promise<void> {
+  await workflow.CancellationScope.current().cancelRequested;
+}
+
+test('Workflow fails if it tries to start a child with an existing workflow ID', async (t) => {
+  const { createWorker, taskQueue, env } = t.context;
+  const worker = await createWorker();
+  await worker.runUntil(async () => {
+    const err = await t.throwsAsync(env.client.workflow.execute(parent, { taskQueue, workflowId: randomUUID() }), {
+      instanceOf: WorkflowFailedError,
+    });
+    t.true(
+      err instanceof WorkflowFailedError &&
+        err.cause?.name === 'TemporalFailure' &&
+        err.cause?.message === 'Workflow execution already started'
+    );
+  });
+});