Allow WorkerDeploymentOptions without defaultVersioningBehavior when useWorkerVersioning is false

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: mjameswh

packages/core-bridge/src/worker.rs

@@ -553,7 +553,7 @@ mod config {
     pub struct WorkerDeploymentOptions {
         version: WorkerDeploymentVersion,
         use_worker_versioning: bool,
-        default_versioning_behavior: VersioningBehavior,
+        default_versioning_behavior: Option<VersioningBehavior>,
     }
 
     #[derive(TryFromJs)]
@@ -662,7 +662,7 @@ mod config {
             Self {
                 version: val.version.into(),
                 use_worker_versioning: val.use_worker_versioning,
-                default_versioning_behavior: Some(val.default_versioning_behavior.into()),
+                default_versioning_behavior: val.default_versioning_behavior.map(Into::into),
             }
         }
     }

packages/core-bridge/ts/native.ts

@@ -257,7 +257,7 @@ export type PollerBehavior =
 export type WorkerDeploymentOptions = {
   version: WorkerDeploymentVersion;
   useWorkerVersioning: boolean;
-  defaultVersioningBehavior: VersioningBehavior;
+  defaultVersioningBehavior: Option<VersioningBehavior>;
 };
 
 export type WorkerDeploymentVersion = {

packages/test/src/test-worker-deployment-versioning.ts

@@ -13,6 +13,9 @@ import { temporal } from '@temporalio/proto';
 import { Worker } from './helpers';
 import { Context, helpers, makeTestFunction } from './helpers-integration';
 import { unblockSignal, versionQuery } from './workflows';
+import { WorkerOptions } from '@temporalio/worker';
+
+type WorkerDeploymentOptions = NonNullable<WorkerOptions['workerDeploymentOptions']>;
 
 const test = makeTestFunction({ workflowsPath: __filename });
 
@@ -302,7 +305,7 @@ async function testWorkerDeploymentWithDynamicBehavior(
     (event) =>
       event.workflowTaskCompletedEventAttributes &&
       event.workflowTaskCompletedEventAttributes.versioningBehavior ===
-        temporal.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_PINNED
+      temporal.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_PINNED
   );
   assert.ok(hasPinnedVersioningBehavior, 'Expected workflow to use pinned versioning behavior');
 
@@ -360,7 +363,7 @@ test('Workflows can use default versioning behavior', async (t) => {
     (event) =>
       event.workflowTaskCompletedEventAttributes &&
       event.workflowTaskCompletedEventAttributes.versioningBehavior ===
-        temporal.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_PINNED
+      temporal.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_PINNED
   );
   assert.ok(hasPinnedVersioningBehavior, 'Expected workflow to use pinned versioning behavior');
 
@@ -415,7 +418,7 @@ test('Workflow versioningOverride overrides default versioning behavior', async
   const hasPinnedVersioningBehavior = historyPinned.events!.some(
     (event) =>
       event.workflowExecutionStartedEventAttributes?.versioningOverride?.behavior ===
-        temporal.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_PINNED ||
+      temporal.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_PINNED ||
       event.workflowExecutionStartedEventAttributes?.versioningOverride?.pinned != null
   );
   assert.ok(hasPinnedVersioningBehavior, 'Expected workflow to use pinned versioning behavior');
@@ -474,3 +477,52 @@ async function setCurrentDeploymentVersion(
     conflictToken,
   });
 }
+
+///////////////////////////////
+
+/**
+ * Type-level tests for WorkerDeploymentOptions.
+ *
+ * Ensures that:
+ * - When useWorkerVersioning is true, defaultVersioningBehavior is required
+ * - When useWorkerVersioning is false, defaultVersioningBehavior must be absent
+ * - version is always required
+ */
+
+test('WorkerDeploymentOptions with useWorkerVersioning true requires defaultVersioningBehavior', (t) => {
+  const valid: WorkerDeploymentOptions = {
+    version: { buildId: '1.0', deploymentName: 'my-deployment' },
+    useWorkerVersioning: true,
+    defaultVersioningBehavior: 'AUTO_UPGRADE',
+  };
+
+  const validPinned: WorkerDeploymentOptions = {
+    version: { buildId: '1.0', deploymentName: 'my-deployment' },
+    useWorkerVersioning: true,
+    defaultVersioningBehavior: 'PINNED',
+  };
+
+  // @ts-expect-error defaultVersioningBehavior is required when useWorkerVersioning is true
+  const missingBehavior: WorkerDeploymentOptions = {
+    version: { buildId: '1.0', deploymentName: 'my-deployment' },
+    useWorkerVersioning: true,
+  };
+
+  t.pass();
+});
+
+test('WorkerDeploymentOptions with useWorkerVersioning false does not allow defaultVersioningBehavior', (t) => {
+  const _validNoVersioning: WorkerDeploymentOptions = {
+    version: { buildId: '1.0', deploymentName: 'my-deployment' },
+    useWorkerVersioning: false,
+  };
+
+  const invalidWithBehavior: WorkerDeploymentOptions = {
+    version: { buildId: '1.0', deploymentName: 'my-deployment' },
+    useWorkerVersioning: false,
+    // @ts-expect-error defaultVersioningBehavior must not be specified when useWorkerVersioning is false
+    defaultVersioningBehavior: 'AUTO_UPGRADE',
+  };
+
+  t.pass();
+});

packages/worker/src/index.ts

@@ -39,6 +39,7 @@ export { DataConverter, defaultPayloadConverter, State, Worker, WorkerStatus } f
 export {
   CompiledWorkerOptions,
   ReplayWorkerOptions,
+  WorkerDeploymentOptions,
   WorkerOptions,
   WorkerPlugin,
   WorkflowBundle,

packages/worker/src/worker-options.ts

@@ -641,11 +641,21 @@ export type WorkerDeploymentOptions = {
   useWorkerVersioning: boolean;
 
   /**
-   * The default versioning behavior to use for all workflows on this worker. Specifying a default
-   * behavior is required.
+   * The default versioning behavior to use for all workflows on this worker.
+   *
+   * Required if {@link useWorkerVersioning} is `true`; should be left unset otherwise.
    */
-  defaultVersioningBehavior: VersioningBehavior;
-};
+  defaultVersioningBehavior?: VersioningBehavior | undefined;
+} & (
+  | {
+      useWorkerVersioning: true;
+      defaultVersioningBehavior: VersioningBehavior;
+    }
+  | {
+      useWorkerVersioning: false;
+      defaultVersioningBehavior?: undefined;
+    }
+);
 
 // Replay Worker ///////////////////////////////////////////////////////////////////////////////////
 
@@ -1126,21 +1136,29 @@ function toNativeDeploymentOptions(options?: WorkerDeploymentOptions): native.Wo
   if (options === undefined) {
     return null;
   }
+  if (!options.useWorkerVersioning) {
+    return {
+      version: options.version,
+      useWorkerVersioning: false,
+      defaultVersioningBehavior: null,
+    };
+  }
+  const { defaultVersioningBehavior } = options;
   let vb: native.VersioningBehavior;
-  switch (options.defaultVersioningBehavior) {
+  switch (defaultVersioningBehavior) {
     case 'PINNED':
       vb = { type: 'pinned' };
       break;
     case 'AUTO_UPGRADE':
       vb = { type: 'auto-upgrade' };
       break;
     default:
-      options.defaultVersioningBehavior satisfies never;
-      throw new Error(`Unknown versioning behavior: ${options.defaultVersioningBehavior}`);
+      defaultVersioningBehavior satisfies never;
+      throw new Error(`Unknown versioning behavior: ${defaultVersioningBehavior}`);
   }
   return {
     version: options.version,
-    useWorkerVersioning: options.useWorkerVersioning,
+    useWorkerVersioning: true,
     defaultVersioningBehavior: vb,
   };
 }