fix: Revert all breaking changes since 1.0.1, deprecate sourceMap (#827)

Author: bergundy

package-lock.json

@@ -18,6 +18,8 @@
     "@temporalio/internal-non-workflow-common": "file:../internal-non-workflow-common",
     "@temporalio/internal-workflow-common": "file:../internal-workflow-common",
     "@temporalio/proto": "file:../proto",
+    "@types/long": "^5.0.0",
+    "long": "^5.2.0",
     "ms": "^2.1.3",
     "protobufjs": "^7.0.0",
     "uuid": "^8.3.2"

packages/client/package.json

@@ -1,6 +1,7 @@
 import type { SearchAttributes } from '@temporalio/internal-workflow-common';
 import { temporal } from '@temporalio/proto';
 import type * as grpc from '@grpc/grpc-js';
+import Long from 'long';
 
 export interface WorkflowExecution {
   workflowId: string;
@@ -30,7 +31,7 @@ export interface WorkflowExecutionDescription {
   runId: string;
   taskQueue: string;
   status: { code: temporal.api.enums.v1.WorkflowExecutionStatus; name: WorkflowExecutionStatusName };
-  historyLength: number;
+  historyLength: Long;
   startTime: Date;
   executionTime?: Date;
   closeTime?: Date;

packages/client/src/types.ts

@@ -853,9 +853,10 @@ export class WorkflowClient {
             code: raw.workflowExecutionInfo!.status!,
             name: workflowStatusCodeToName(raw.workflowExecutionInfo!.status!),
           },
-          // Safe to convert to number
+          // Technically safe to convert to number, unfortunately this was overlooked when this was originally
+          // implemented.
           // Max history length is 50k, which is much less than Number.MAX_SAFE_INTEGER
-          historyLength: raw.workflowExecutionInfo!.historyLength!.toNumber(),
+          historyLength: raw.workflowExecutionInfo!.historyLength!,
           startTime: tsToDate(raw.workflowExecutionInfo!.startTime!),
           executionTime: optionalTsToDate(raw.workflowExecutionInfo!.executionTime),
           closeTime: optionalTsToDate(raw.workflowExecutionInfo!.closeTime),

packages/client/src/workflow-client.ts

@@ -665,15 +665,23 @@ export function runIntegrationTests(codec?: PayloadCodec): void {
       CustomDoubleField: [3.14],
     });
     const { searchAttributes } = await workflow.describe();
-    t.deepEqual(searchAttributes, {
-      BinaryChecksums: [`@temporalio/worker@${pkg.version}`],
+    const { BinaryChecksums, ...rest } = searchAttributes;
+    t.deepEqual(rest, {
       CustomBoolField: [true],
       CustomIntField: [], // clear
       CustomKeywordField: ['durable code'],
       CustomTextField: ['is useful'],
       CustomDatetimeField: [date],
       CustomDoubleField: [3.14],
     });
+    t.true(BinaryChecksums?.length === 1);
+    const [checksum] = BinaryChecksums ?? ['invalid'];
+    console.log(checksum);
+    t.true(
+      typeof checksum === 'string' &&
+        checksum.startsWith(`@temporalio/worker@${pkg.version}+`) &&
+        /\+[a-f0-9]{64}$/.test(checksum) // bundle checksum
+    );
   });
 
   test('Workflow can read WorkflowInfo', async (t) => {

packages/test/src/integration-tests.ts

@@ -1,6 +1,6 @@
 import { ApplicationFailure, defaultPayloadConverter, WorkflowClient, WorkflowFailedError } from '@temporalio/client';
 import { temporal } from '@temporalio/proto';
-import { bundleWorkflowCode, Worker, WorkflowBundle } from '@temporalio/worker';
+import { bundleWorkflowCode, Worker, WorkflowBundleWithSourceMap as WorkflowBundle } from '@temporalio/worker';
 import { isCancellation } from '@temporalio/workflow';
 import anyTest, { TestInterface } from 'ava';
 import { firstValueFrom, Subject } from 'rxjs';

packages/test/src/test-local-activities.ts

@@ -34,7 +34,9 @@ export {
   ReplayWorkerOptions,
   WorkerOptions,
   WorkflowBundleOption,
+  WorkflowBundle,
   WorkflowBundlePath,
+  WorkflowBundlePathWithSourceMap, // eslint-disable-line deprecation/deprecation
 } from './worker-options';
 export { WorkflowInboundLogInterceptor, workflowLogAttributes } from './workflow-log-interceptor';
-export { BundleOptions, bundleWorkflowCode, WorkflowBundle } from './workflow/bundler';
+export { BundleOptions, bundleWorkflowCode, WorkflowBundleWithSourceMap } from './workflow/bundler';

packages/worker/src/index.ts

@@ -9,7 +9,7 @@ import { Runtime } from './runtime';
 import { InjectedSinks } from './sinks';
 import { GiB } from './utils';
 import { LoggerSinks } from './workflow-log-interceptor';
-import { WorkflowBundle } from './workflow/bundler';
+import { WorkflowBundleWithSourceMap } from './workflow/bundler';
 import * as v8 from 'v8';
 import * as os from 'os';
 
@@ -18,7 +18,27 @@ export type { WebpackConfiguration };
 export interface WorkflowBundlePath {
   codePath: string;
 }
-export type WorkflowBundleOption = WorkflowBundle | WorkflowBundlePath;
+
+/**
+ * Note this no longer contains a source map.
+ * The name was preserved to avoid breaking backwards compatibility.
+ *
+ * @deprecated
+ */
+export interface WorkflowBundlePathWithSourceMap {
+  codePath: string;
+  sourceMapPath: string;
+}
+
+export interface WorkflowBundle {
+  code: string;
+}
+
+export type WorkflowBundleOption =
+  | WorkflowBundle
+  | WorkflowBundleWithSourceMap
+  | WorkflowBundlePath
+  | WorkflowBundlePathWithSourceMap; // eslint-disable-line deprecation/deprecation
 
 export function isCodeBundleOption(bundleOpt: WorkflowBundleOption): bundleOpt is WorkflowBundle {
   const opt = bundleOpt as any; // Cast to access properties without TS complaining

packages/worker/src/worker-options.ts

@@ -72,10 +72,11 @@ import {
   isCodeBundleOption,
   isPathBundleOption,
   ReplayWorkerOptions,
+  WorkflowBundle,
   WorkerOptions,
 } from './worker-options';
 import { WorkflowCodecRunner } from './workflow-codec-runner';
-import { WorkflowBundle, WorkflowCodeBundler } from './workflow/bundler';
+import { WorkflowCodeBundler } from './workflow/bundler';
 import { Workflow, WorkflowCreator } from './workflow/interface';
 import { ThreadedVMWorkflowCreator } from './workflow/threaded-vm';
 import { VMWorkflowCreator } from './workflow/vm';
@@ -132,6 +133,8 @@ export type ActivityTaskWithContext = ContextAware<{
   base64TaskToken: string;
 }>;
 
+type CompiledWorkerOptionsWithBuildId = CompiledWorkerOptions & { buildId: string };
+
 export interface NativeWorkerLike {
   initiateShutdown: Promisify<OmitFirstParam<typeof native.workerInitiateShutdown>>;
   finalizeShutdown(): Promise<void>;
@@ -145,22 +148,15 @@ export interface NativeWorkerLike {
 }
 
 export interface WorkerConstructor {
-  create(
-    connection: NativeConnection,
-    options: CompiledWorkerOptions,
-    bundle?: WorkflowBundle
-  ): Promise<NativeWorkerLike>;
-  createReplay(options: CompiledWorkerOptions, history: History, bundle: WorkflowBundle): Promise<NativeWorkerLike>;
+  create(connection: NativeConnection, options: CompiledWorkerOptionsWithBuildId): Promise<NativeWorkerLike>;
+  createReplay(options: CompiledWorkerOptionsWithBuildId, history: History): Promise<NativeWorkerLike>;
 }
 
 function isOptionsWithBuildId<T extends CompiledWorkerOptions>(options: T): options is T & { buildId: string } {
   return options.buildId != null;
 }
 
-function addBuildIdIfMissing<T extends CompiledWorkerOptions>(
-  options: T,
-  bundleCode?: string
-): T & { buildId: string } {
+function addBuildIdIfMissing(options: CompiledWorkerOptions, bundleCode?: string): CompiledWorkerOptionsWithBuildId {
   if (isOptionsWithBuildId(options)) {
     return options;
   }
@@ -178,24 +174,19 @@ export class NativeWorker implements NativeWorkerLike {
 
   public static async create(
     connection: NativeConnection,
-    options: CompiledWorkerOptions,
-    bundle?: WorkflowBundle
+    options: CompiledWorkerOptionsWithBuildId
   ): Promise<NativeWorkerLike> {
     const runtime = Runtime.instance();
-    const nativeWorker = await runtime.registerWorker(
-      extractNativeClient(connection),
-      addBuildIdIfMissing(options, bundle?.code)
-    );
+    const nativeWorker = await runtime.registerWorker(extractNativeClient(connection), options);
     return new NativeWorker(runtime, nativeWorker);
   }
 
   public static async createReplay(
-    options: CompiledWorkerOptions,
-    history: History,
-    bundle: WorkflowBundle
+    options: CompiledWorkerOptionsWithBuildId,
+    history: History
   ): Promise<NativeWorkerLike> {
     const runtime = Runtime.instance();
-    const nativeWorker = await runtime.createReplayWorker(addBuildIdIfMissing(options, bundle.code), history);
+    const nativeWorker = await runtime.createReplayWorker(options, history);
     return new NativeWorker(runtime, nativeWorker);
   }
 
@@ -426,7 +417,7 @@ export class Worker {
     const connection = options.connection ?? (await InternalNativeConnection.connect());
     let nativeWorker: NativeWorkerLike;
     try {
-      nativeWorker = await nativeWorkerCtor.create(connection, compiledOptions);
+      nativeWorker = await nativeWorkerCtor.create(connection, addBuildIdIfMissing(compiledOptions, bundle?.code));
     } catch (err) {
       // We just created this connection, close it
       if (!options.connection) {
@@ -439,7 +430,7 @@ export class Worker {
   }
 
   protected static async createWorkflowCreator(
-    workflowBundle: WorkflowBundleWithSourceMap,
+    workflowBundle: WorkflowBundleWithSourceMapAndFilename,
     compiledOptions: CompiledWorkerOptions
   ): Promise<WorkflowCreator> {
     if (compiledOptions.debugMode) {
@@ -499,7 +490,10 @@ export class Worker {
       throw new TypeError('ReplayWorkerOptions must contain workflowsPath or workflowBundle');
     }
     const workflowCreator = await this.createWorkflowCreator(bundle, compiledOptions);
-    const replayWorker = await nativeWorkerCtor.createReplay(compiledOptions, history, bundle);
+    const replayWorker = await nativeWorkerCtor.createReplay(
+      addBuildIdIfMissing(compiledOptions, bundle.code),
+      history
+    );
     const constructedWorker = new this(replayWorker, workflowCreator, compiledOptions);
 
     const runPromise = constructedWorker.run();
@@ -540,7 +534,7 @@ export class Worker {
   protected static async getOrCreateBundle(
     compiledOptions: CompiledWorkerOptions,
     logger: Logger
-  ): Promise<WorkflowBundleWithSourceMap | undefined> {
+  ): Promise<WorkflowBundleWithSourceMapAndFilename | undefined> {
     if (compiledOptions.workflowsPath) {
       if (compiledOptions.workflowBundle) {
         throw new ValueError(
@@ -561,7 +555,7 @@ export class Worker {
       return parseWorkflowCode(bundle.code);
     } else if (compiledOptions.workflowBundle) {
       if (compiledOptions.bundlerOptions) {
-        throw new ValueError(`You cannot set both WorkerOptions.workflowBundle and .bundlerOptions`);
+        throw new ValueError('You cannot set both WorkerOptions.workflowBundle and .bundlerOptions');
       }
 
       if (isCodeBundleOption(compiledOptions.workflowBundle)) {
@@ -1652,13 +1646,13 @@ export class Worker {
   }
 }
 
-export interface WorkflowBundleWithSourceMap {
+export interface WorkflowBundleWithSourceMapAndFilename {
   code: string;
   sourceMap: RawSourceMap;
   filename: string;
 }
 
-export function parseWorkflowCode(code: string, codePath?: string): WorkflowBundleWithSourceMap {
+export function parseWorkflowCode(code: string, codePath?: string): WorkflowBundleWithSourceMapAndFilename {
   const sourceMappingUrlDataRegex = /\s*\n[/][/][#]\s+sourceMappingURL=data:(?:[^,]*;)base64,([0-9A-Za-z+/=]+)\s*$/;
   const sourceMapMatcher = code.match(sourceMappingUrlDataRegex);
   if (!sourceMapMatcher) throw new Error("Can't extract inlined source map from the provided Workflow Bundle");

packages/worker/src/worker.ts

@@ -26,7 +26,12 @@ export function moduleMatches(userModule: string, modules: string[]): boolean {
   return modules.some((module) => userModule === module || userModule.startsWith(`${module}/`));
 }
 
-export interface WorkflowBundle {
+export interface WorkflowBundleWithSourceMap {
+  /**
+   * Source maps are generated inline - this is no longer used
+   * @deprecated
+   */
+  sourceMap: string;
   code: string;
 }
 
@@ -65,7 +70,7 @@ export class WorkflowCodeBundler {
   /**
    * @return a {@link WorkflowBundle} containing bundled code, including inlined source map
    */
-  public async createBundle(): Promise<WorkflowBundle> {
+  public async createBundle(): Promise<WorkflowBundleWithSourceMap> {
     const vol = new memfs.Volume();
     const ufs = new unionfs.Union();
 
@@ -102,6 +107,7 @@ export class WorkflowCodeBundler {
 
     // Cast because the type definitions are inaccurate
     return {
+      sourceMap: 'deprecated: this is no longer in use',
       code: memoryFs.readFileSync(bundleFilePath, 'utf8') as string,
     };
   }
@@ -333,7 +339,7 @@ export interface BundleOptions {
  * When using with {@link Worker.runReplayHistory}, make sure to pass the same interceptors and payload converter used
  * when the history was generated.
  */
-export async function bundleWorkflowCode(options: BundleOptions): Promise<WorkflowBundle> {
+export async function bundleWorkflowCode(options: BundleOptions): Promise<WorkflowBundleWithSourceMap> {
   const bundler = new WorkflowCodeBundler(options);
   return await bundler.createBundle();
 }

packages/worker/src/workflow/bundler.ts

@@ -13,7 +13,7 @@ import { coresdk } from '@temporalio/proto';
 import { IllegalStateError, SinkCall } from '@temporalio/workflow';
 import { Worker as NodeWorker } from 'worker_threads';
 import { UnexpectedError } from '../errors';
-import { WorkflowBundleWithSourceMap } from '../worker';
+import { WorkflowBundleWithSourceMapAndFilename } from '../worker';
 import { Workflow, WorkflowCreateOptions, WorkflowCreator } from './interface';
 import { WorkerThreadInput, WorkerThreadRequest } from './workflow-worker-thread/input';
 import { WorkerThreadOutput, WorkerThreadResponse } from './workflow-worker-thread/output';
@@ -119,7 +119,7 @@ export class WorkerThreadClient {
 }
 
 export interface ThreadedVMWorkflowCreatorOptions {
-  workflowBundle: WorkflowBundleWithSourceMap;
+  workflowBundle: WorkflowBundleWithSourceMapAndFilename;
   threadPoolSize: number;
   isolateExecutionTimeoutMs: number;
 }

packages/worker/src/workflow/threaded-vm.ts

@@ -11,7 +11,7 @@ import vm from 'vm';
 import v8 from 'v8';
 import { partition } from '../utils';
 import { Workflow, WorkflowCreateOptions, WorkflowCreator } from './interface';
-import { WorkflowBundleWithSourceMap } from '../worker';
+import { WorkflowBundleWithSourceMapAndFilename } from '../worker';
 
 interface ActivationContext {
   isReplaying: boolean;
@@ -213,7 +213,7 @@ export class VMWorkflowCreator implements WorkflowCreator {
    */
   public static async create<T extends typeof VMWorkflowCreator>(
     this: T,
-    workflowBundle: WorkflowBundleWithSourceMap,
+    workflowBundle: WorkflowBundleWithSourceMapAndFilename,
     isolateExecutionTimeoutMs: number
   ): Promise<InstanceType<T>> {
     const script = new vm.Script(workflowBundle.code, { filename: workflowBundle.filename });

packages/worker/src/workflow/vm.ts

@@ -1,4 +1,4 @@
-import { WorkflowBundleWithSourceMap } from '../../worker';
+import { WorkflowBundleWithSourceMapAndFilename } from '../../worker';
 import { WorkflowCreateOptions } from '../interface';
 
 /**
@@ -7,7 +7,7 @@ import { WorkflowCreateOptions } from '../interface';
 export interface Init {
   type: 'init';
   isolateExecutionTimeoutMs: number;
-  workflowBundle: WorkflowBundleWithSourceMap;
+  workflowBundle: WorkflowBundleWithSourceMapAndFilename;
 }
 
 /**