fix: Warn instead of throwing when getting workflowBundle with workflowsPath and bundlerOptions (#833)

NOTE: We now prefer taking the bundle over workflowsPath which is the correct behavior and what users should expect.

Also warning that workflow interceptors are ignored when using a bundle.

Author: bergundy

packages/worker/src/worker-options.ts

@@ -114,8 +114,9 @@ export interface WorkerOptions {
    *
    * See https://docs.temporal.io/typescript/production-deploy#pre-build-code for more information.
    *
-   * When using this option, any Workflow interceptors provided in {@link interceptors} are not used. Instead, provide
-   * them via {@link BundleOptions.workflowInterceptorModules} when calling {@link bundleWorkflowCode}.
+   * When using this option, {@link workflowsPath}, {@link bundlerOptions} and any Workflow interceptors modules
+   * provided in * {@link interceptors} are not used. To use workflow interceptors, pass them via
+   * {@link BundleOptions.workflowInterceptorModules} when calling {@link bundleWorkflowCode}.
    */
   workflowBundle?: WorkflowBundleOption;
 

packages/worker/src/worker.ts

@@ -33,7 +33,6 @@ import {
   optionalTsToMs,
   SearchAttributes,
   tsToMs,
-  ValueError,
 } from '@temporalio/internal-workflow-common';
 import { coresdk, temporal } from '@temporalio/proto';
 import { DeterminismViolationError, SinkCall, WorkflowInfo } from '@temporalio/workflow';
@@ -64,7 +63,7 @@ import pkg from './pkg';
 import { History, Runtime } from './runtime';
 import { closeableGroupBy, mapWithState, mergeMapWithState } from './rxutils';
 import { childSpan, getTracer, instrument } from './tracing';
-import { byteArrayToBuffer, convertToParentWorkflowType, toMB } from './utils';
+import { byteArrayToBuffer, convertToParentWorkflowType } from './utils';
 import {
   addDefaultWorkerOptions,
   CompiledWorkerOptions,
@@ -535,13 +534,29 @@ export class Worker {
     compiledOptions: CompiledWorkerOptions,
     logger: Logger
   ): Promise<WorkflowBundleWithSourceMapAndFilename | undefined> {
-    if (compiledOptions.workflowsPath) {
-      if (compiledOptions.workflowBundle) {
-        throw new ValueError(
-          'You cannot set both WorkerOptions.workflowsPath and .workflowBundle: only one can be used'
+    if (compiledOptions.workflowBundle) {
+      if (compiledOptions.workflowsPath) {
+        logger.warn('Ignoring WorkerOptions.workflowsPath because WorkerOptions.workflowBundle is set');
+      }
+      if (compiledOptions.bundlerOptions) {
+        logger.warn('Ignoring WorkerOptions.bundlerOptions because WorkerOptions.workflowBundle is set');
+      }
+      if (compiledOptions.interceptors?.workflowModules) {
+        logger.warn(
+          'Ignoring WorkerOptions.interceptors.workflowModules because WorkerOptions.workflowBundle is set.\n' +
+            'To use workflow interceptors with a workflowBundle, pass them in the call to bundleWorkflowCode.'
         );
       }
 
+      if (isCodeBundleOption(compiledOptions.workflowBundle)) {
+        return parseWorkflowCode(compiledOptions.workflowBundle.code);
+      } else if (isPathBundleOption(compiledOptions.workflowBundle)) {
+        const code = await fs.readFile(compiledOptions.workflowBundle.codePath, 'utf8');
+        return parseWorkflowCode(code, compiledOptions.workflowBundle.codePath);
+      } else {
+        throw new TypeError('Invalid WorkflowOptions.workflowBundle');
+      }
+    } else if (compiledOptions.workflowsPath) {
       const bundler = new WorkflowCodeBundler({
         logger,
         workflowsPath: compiledOptions.workflowsPath,
@@ -551,21 +566,7 @@ export class Worker {
         webpackConfigHook: compiledOptions.bundlerOptions?.webpackConfigHook,
       });
       const bundle = await bundler.createBundle();
-      logger.info('Workflow bundle created', { size: `${toMB(bundle.code.length)}MB` });
       return parseWorkflowCode(bundle.code);
-    } else if (compiledOptions.workflowBundle) {
-      if (compiledOptions.bundlerOptions) {
-        throw new ValueError('You cannot set both WorkerOptions.workflowBundle and .bundlerOptions');
-      }
-
-      if (isCodeBundleOption(compiledOptions.workflowBundle)) {
-        return parseWorkflowCode(compiledOptions.workflowBundle.code);
-      } else if (isPathBundleOption(compiledOptions.workflowBundle)) {
-        const code = await fs.readFile(compiledOptions.workflowBundle.codePath, 'utf8');
-        return parseWorkflowCode(code, compiledOptions.workflowBundle.codePath);
-      } else {
-        throw new TypeError('Invalid WorkflowOptions.workflowBundle');
-      }
     } else {
       return undefined;
     }

packages/worker/src/workflow/bundler.ts

@@ -7,6 +7,7 @@ import * as unionfs from 'unionfs';
 import util from 'util';
 import webpack from 'webpack';
 import { DefaultLogger, Logger } from '../logger';
+import { toMB } from '../utils';
 
 export const allowedBuiltinModules = ['assert'];
 export const disallowedBuiltinModules = builtinModules.filter((module) => !allowedBuiltinModules.includes(module));
@@ -104,11 +105,14 @@ export class WorkflowCodeBundler {
 
     this.genEntrypoint(vol, entrypointPath);
     const bundleFilePath = await this.bundle(ufs, memoryFs, entrypointPath, distDir);
+    const code = memoryFs.readFileSync(bundleFilePath, 'utf8') as string;
+
+    this.logger.info('Workflow bundle created', { size: `${toMB(code.length)}MB` });
 
     // Cast because the type definitions are inaccurate
     return {
-      sourceMap: 'deprecated: this is no longer in use',
-      code: memoryFs.readFileSync(bundleFilePath, 'utf8') as string,
+      sourceMap: 'deprecated: this is no longer in use\n',
+      code,
     };
   }