chore: update additional tests to use new stacktrace comparison

Author: chris-olszewski

packages/test/src/helpers.ts

@@ -3,7 +3,7 @@ import * as net from 'net';
 import path from 'path';
 import * as grpc from '@grpc/grpc-js';
 import asyncRetry from 'async-retry';
-import ava, { TestFn } from 'ava';
+import ava, { TestFn, ExecutionContext } from 'ava';
 import StackUtils from 'stack-utils';
 import { v4 as uuid4 } from 'uuid';
 import { Client, Connection } from '@temporalio/client';
@@ -54,7 +54,7 @@ export async function waitUntil(
   intervalMs: number = 100
 ): Promise<void> {
   const endTime = Date.now() + timeoutMs;
-  for (;;) {
+  for (; ;) {
     if (await condition()) {
       return;
     } else if (Date.now() >= endTime) {
@@ -98,6 +98,21 @@ export function cleanStackTrace(ostack: string): string {
   return normalizedStack ? `${firstLine}\n${normalizedStack}` : firstLine;
 }
 
+/**
+  * Compare stack traces using $CLASS keyword to match any inconsistent identifiers
+  *
+  * As of Node 24.6.0 type names are now present on source mapped stack traces which leads
+  * to different stack traces depending on Node version.
+  * See [f33e0fcc83954f728fcfd2ef6ae59435bc4af059](https://github.com/nodejs/node/commit/f33e0fcc83954f728fcfd2ef6ae59435bc4af059)
+  */
+export function compareFailureStackTrace<T>(t: ExecutionContext<T>, actual: string, expected: string) {
+  const escapedTrace = expected
+    .replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')
+    .replace(/-/g, '\\x2d')
+    .replaceAll('\\$CLASS', '(?:[A-Za-z]+)');
+  t.regex(actual, RegExp(`^${escapedTrace}$`));
+}
+
 function noopTest(): void {
   // eslint: this function body is empty and it's okay.
 }
@@ -168,11 +183,11 @@ export class ByteSkewerPayloadCodec implements PayloadCodec {
 if (inWorkflowContext()) {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  worker.Worker = class {}; // eslint-disable-line import/namespace
+  worker.Worker = class { }; // eslint-disable-line import/namespace
 
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  RealTestWorkflowEnvironment = class {}; // eslint-disable-line import/namespace
+  RealTestWorkflowEnvironment = class { }; // eslint-disable-line import/namespace
 }
 
 export class Worker extends worker.Worker {
@@ -190,15 +205,15 @@ export class TestWorkflowEnvironment extends RealTestWorkflowEnvironment {
       ...opts,
       ...(TESTS_CLI_VERSION
         ? {
-            server: {
-              ...opts?.server,
-              executable: {
-                ...opts?.server?.executable,
-                type: 'cached-download',
-                version: TESTS_CLI_VERSION,
-              },
+          server: {
+            ...opts?.server,
+            executable: {
+              ...opts?.server?.executable,
+              type: 'cached-download',
+              version: TESTS_CLI_VERSION,
             },
-          }
+          },
+        }
         : undefined),
     });
   }
@@ -208,15 +223,15 @@ export class TestWorkflowEnvironment extends RealTestWorkflowEnvironment {
       ...opts,
       ...(TESTS_TIME_SKIPPING_SERVER_VERSION
         ? {
-            server: {
-              ...opts?.server,
-              executable: {
-                ...opts?.server?.executable,
-                type: 'cached-download',
-                version: TESTS_TIME_SKIPPING_SERVER_VERSION,
-              },
+          server: {
+            ...opts?.server,
+            executable: {
+              ...opts?.server?.executable,
+              type: 'cached-download',
+              version: TESTS_TIME_SKIPPING_SERVER_VERSION,
             },
-          }
+          },
+        }
         : undefined),
     });
   }

packages/test/src/test-integration-split-one.ts

@@ -36,7 +36,7 @@ import {
 } from '@temporalio/workflow';
 import { configurableHelpers, createTestWorkflowBundle } from './helpers-integration';
 import * as activities from './activities';
-import { cleanOptionalStackTrace, u8, Worker } from './helpers';
+import { cleanOptionalStackTrace, compareFailureStackTrace, u8, Worker } from './helpers';
 import { configMacro, makeTestFn } from './helpers-integration-multi-codec';
 import * as workflows from './workflows';
 
@@ -204,11 +204,12 @@ test.serial('activity-failure with ApplicationFailure', configMacro, async (t, c
   t.is(err.cause.cause.message, 'Fail me');
   t.is(err.cause.cause.type, 'Error');
   t.deepEqual(err.cause.cause.details, ['details', 123, false]);
-  t.is(
-    cleanOptionalStackTrace(err.cause.cause.stack),
+  compareFailureStackTrace(
+    t,
+    cleanOptionalStackTrace(err.cause.cause.stack)!,
     dedent`
   ApplicationFailure: Fail me
-      at Function.nonRetryable (common/src/failure.ts)
+      at $CLASS.nonRetryable (common/src/failure.ts)
       at throwAnError (test/src/activities/index.ts)
     `
   );
@@ -258,11 +259,12 @@ test.serial('child-workflow-failure', configMacro, async (t, config) => {
       return t.fail('Expected err.cause.cause to be an instance of ApplicationFailure');
     }
     t.is(err.cause.cause.message, 'failure');
-    t.is(
-      cleanOptionalStackTrace(err.cause.cause.stack),
+    compareFailureStackTrace(
+      t,
+      cleanOptionalStackTrace(err.cause.cause.stack)!,
       dedent`
       ApplicationFailure: failure
-          at Function.nonRetryable (common/src/failure.ts)
+          at $CLASS.nonRetryable (common/src/failure.ts)
           at throwAsync (test/src/workflows/throw-async.ts)
     `
     );
@@ -694,8 +696,8 @@ test.serial('Workflow can upsert Search Attributes', configMacro, async (t, conf
   }
   t.true(
     typeof checksum === 'string' &&
-      checksum.includes(`@temporalio/worker@${pkg.version}+`) &&
-      /\+[a-f0-9]{64}$/.test(checksum) // bundle checksum
+    checksum.includes(`@temporalio/worker@${pkg.version}+`) &&
+    /\+[a-f0-9]{64}$/.test(checksum) // bundle checksum
   );
 });
 

packages/test/src/test-interceptors.ts

@@ -12,7 +12,7 @@ import { WorkflowClient, WorkflowFailedError } from '@temporalio/client';
 import { ApplicationFailure, TerminatedFailure } from '@temporalio/common';
 import { DefaultLogger, Runtime } from '@temporalio/worker';
 import { defaultPayloadConverter, WorkflowInfo } from '@temporalio/workflow';
-import { cleanOptionalStackTrace, RUN_INTEGRATION_TESTS, Worker } from './helpers';
+import { cleanOptionalStackTrace, compareFailureStackTrace, RUN_INTEGRATION_TESTS, Worker } from './helpers';
 import { defaultOptions } from './mock-native-worker';
 import {
   continueAsNewToDifferentWorkflow,
@@ -241,11 +241,12 @@ if (RUN_INTEGRATION_TESTS) {
       return;
     }
     t.deepEqual(err.cause.message, 'Expected anything other than 1');
-    t.is(
-      cleanOptionalStackTrace(err.cause.stack),
+    compareFailureStackTrace(
+      t,
+      cleanOptionalStackTrace(err.cause.stack)!,
       dedent`
       ApplicationFailure: Expected anything other than 1
-          at Function.nonRetryable (common/src/failure.ts)
+          at $CLASS.nonRetryable (common/src/failure.ts)
           at Object.continueAsNew (test/src/workflows/interceptor-example.ts)
           at workflow/src/workflow.ts
           at continueAsNewToDifferentWorkflow (test/src/workflows/continue-as-new-to-different-workflow.ts)

packages/test/src/test-nexus-handler.ts

@@ -19,7 +19,7 @@ import {
   convertWorkflowEventLinkToNexusLink,
   convertNexusLinkToWorkflowEventLink,
 } from '@temporalio/nexus/lib/link-converter';
-import { cleanStackTrace, getRandomPort } from './helpers';
+import { cleanStackTrace, compareFailureStackTrace, getRandomPort } from './helpers';
 
 export interface Context {
   httpPort: number;
@@ -314,10 +314,11 @@ test('start Operation Handler errors', async (t) => {
       });
       t.true(err instanceof ApplicationFailure);
       t.is(err.message, '');
-      t.is(
+      compareFailureStackTrace(
+        t,
         cleanStackTrace(err.stack!),
         `ApplicationFailure: deliberate failure
-    at Function.create (common/src/failure.ts)
+    at $CLASS.create (common/src/failure.ts)
     at op (test/src/test-nexus-handler.ts)
     at Object.start (nexus-rpc/src/handler/operation-handler.ts)
     at ServiceRegistry.start (nexus-rpc/src/handler/service-registry.ts)`
@@ -460,10 +461,11 @@ test('cancel Operation Handler errors', async (t) => {
       });
       t.true(err instanceof ApplicationFailure);
       t.is(err.message, '');
-      t.is(
+      compareFailureStackTrace(
+        t,
         cleanStackTrace(err.stack!),
         `ApplicationFailure: deliberate failure
-    at Function.create (common/src/failure.ts)
+    at $CLASS.create (common/src/failure.ts)
     at Object.cancel (test/src/test-nexus-handler.ts)
     at ServiceRegistry.cancel (nexus-rpc/src/handler/service-registry.ts)`
       );

packages/test/src/test-workflows.ts

@@ -22,7 +22,7 @@ import { SdkFlag, SdkFlags } from '@temporalio/workflow/lib/flags';
 import { ReusableVMWorkflow, ReusableVMWorkflowCreator } from '@temporalio/worker/lib/workflow/reusable-vm';
 import { parseWorkflowCode } from '@temporalio/worker/lib/worker';
 import * as activityFunctions from './activities';
-import { cleanStackTrace, REUSE_V8_CONTEXT, u8 } from './helpers';
+import { cleanStackTrace, compareFailureStackTrace, REUSE_V8_CONTEXT, u8 } from './helpers';
 import { ProcessedSignal } from './workflows';
 
 export interface Context {
@@ -172,16 +172,6 @@ function compareCompletion(
   );
 }
 
-// Compare stack traces while handling $CLASS keyword to match any identifier that isn't consistent across Node versions.
-// As of Node 24.6.0 type names are now present on source mapped stack traces
-// See [f33e0fcc83954f728fcfd2ef6ae59435bc4af059](https://github.com/nodejs/node/commit/f33e0fcc83954f728fcfd2ef6ae59435bc4af059)
-function compareFailureStackTrace(t: ExecutionContext<Context>, actual: string, expected: string) {
-  const escapedTrace = expected
-    .replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')
-    .replace(/-/g, '\\x2d')
-    .replaceAll('\\$CLASS', '(?:[A-Za-z]+)');
-  t.regex(actual, RegExp(`^${escapedTrace}$`));
-}
 
 function makeSuccess(
   commands: coresdk.workflow_commands.IWorkflowCommand[] = [makeCompleteWorkflowExecution()],