Use more standard enum representation / fix related errors

Author: Sushisource

packages/common/src/worker-deployments.ts

@@ -1,3 +1,6 @@
+import { temporal } from '@temporalio/proto';
+import { makeProtoEnumConverters } from './internal-workflow';
+
 /**
  * Represents the version of a specific worker deployment.
  *
@@ -25,4 +28,23 @@ export function toCanonicalString(version: WorkerDeploymentVersion): string {
  *
  * @experimental Deployment based versioning is experimental and may change in the future.
  */
-export type VersioningBehavior = 'pinned' | 'auto-upgrade';
+export const VersioningBehavior = {
+  PINNED: 'PINNED',
+  AUTO_UPGRADE: 'AUTO_UPGRADE',
+} as const;
+export type VersioningBehavior = (typeof VersioningBehavior)[keyof typeof VersioningBehavior];
+
+export const [encodeVersioningBehavior, decodeVersioningBehavior] = makeProtoEnumConverters<
+  temporal.api.enums.v1.VersioningBehavior,
+  typeof temporal.api.enums.v1.VersioningBehavior,
+  keyof typeof temporal.api.enums.v1.VersioningBehavior,
+  typeof VersioningBehavior,
+  'VERSIONING_BEHAVIOR_'
+>(
+  {
+    [VersioningBehavior.PINNED]: 1,
+    [VersioningBehavior.AUTO_UPGRADE]: 2,
+    UNSPECIFIED: 0,
+  } as const,
+  'VERSIONING_BEHAVIOR_'
+);

packages/core-bridge/src/conversions.rs

@@ -531,8 +531,8 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
             let default_versioning_behavior =
                 js_optional_value_getter!(cx, &dopts, "defaultVersioningBehavior", JsString);
             let default_versioning_behavior = match default_versioning_behavior.as_deref() {
-                Some("pinned") => Some(VersioningBehavior::Pinned),
-                Some("auto-upgrade") => Some(VersioningBehavior::AutoUpgrade),
+                Some("PINNED") => Some(VersioningBehavior::Pinned),
+                Some("AUTO_UPGRADE") => Some(VersioningBehavior::AutoUpgrade),
                 None => None,
                 _ => return cx.throw_error("Invalid default versioning behavior"),
             };

packages/test/src/deployment-versioning-v1/index.ts

@@ -1,7 +1,7 @@
 import { setHandler, condition, defineWorkflowWithOptions } from '@temporalio/workflow';
 import { unblockSignal, versionQuery } from '../workflows';
 
-defineWorkflowWithOptions({ versioningBehavior: 'auto-upgrade' }, deploymentVersioning);
+defineWorkflowWithOptions({ versioningBehavior: 'AUTO_UPGRADE' }, deploymentVersioning);
 export async function deploymentVersioning(): Promise<string> {
   let doFinish = false;
   setHandler(unblockSignal, () => void (doFinish = true));
@@ -11,7 +11,7 @@ export async function deploymentVersioning(): Promise<string> {
 }
 
 // Dynamic/default workflow handler
-export default defineWorkflowWithOptions({ versioningBehavior: 'pinned' }, _default);
+export default defineWorkflowWithOptions({ versioningBehavior: 'PINNED' }, _default);
 async function _default(): Promise<string> {
   return 'dynamic';
 }

packages/test/src/deployment-versioning-v2/index.ts

@@ -1,7 +1,7 @@
 import { setHandler, condition, defineWorkflowWithOptions } from '@temporalio/workflow';
 import { unblockSignal, versionQuery } from '../workflows';
 
-defineWorkflowWithOptions({ versioningBehavior: 'pinned' }, deploymentVersioning);
+defineWorkflowWithOptions({ versioningBehavior: 'PINNED' }, deploymentVersioning);
 export async function deploymentVersioning(): Promise<string> {
   let doFinish = false;
   setHandler(unblockSignal, () => void (doFinish = true));

packages/test/src/deployment-versioning-v3/index.ts

@@ -1,7 +1,7 @@
 import { setHandler, condition, defineWorkflowWithOptions } from '@temporalio/workflow';
 import { unblockSignal, versionQuery } from '../workflows';
 
-defineWorkflowWithOptions({ versioningBehavior: 'auto-upgrade' }, deploymentVersioning);
+defineWorkflowWithOptions({ versioningBehavior: 'AUTO_UPGRADE' }, deploymentVersioning);
 export async function deploymentVersioning(): Promise<string> {
   let doFinish = false;
   setHandler(unblockSignal, () => void (doFinish = true));

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

@@ -39,7 +39,7 @@ test('Worker deployment based versioning', async (t) => {
     workerDeploymentOptions: {
       useWorkerVersioning: true,
       version: w1DeploymentVersion,
-      defaultVersioningBehavior: 'pinned',
+      defaultVersioningBehavior: 'PINNED',
     },
   });
   const worker1Promise = worker1.run();
@@ -53,7 +53,7 @@ test('Worker deployment based versioning', async (t) => {
     workerDeploymentOptions: {
       useWorkerVersioning: true,
       version: w2DeploymentVersion,
-      defaultVersioningBehavior: 'pinned',
+      defaultVersioningBehavior: 'PINNED',
     },
   });
   const worker2Promise = worker2.run();
@@ -67,7 +67,7 @@ test('Worker deployment based versioning', async (t) => {
     workerDeploymentOptions: {
       useWorkerVersioning: true,
       version: w3DeploymentVersion,
-      defaultVersioningBehavior: 'pinned',
+      defaultVersioningBehavior: 'PINNED',
     },
   });
   const worker3Promise = worker3.run();
@@ -153,7 +153,7 @@ test('Worker deployment based versioning with ramping', async (t) => {
     workerDeploymentOptions: {
       useWorkerVersioning: true,
       version: v1,
-      defaultVersioningBehavior: 'pinned',
+      defaultVersioningBehavior: 'PINNED',
     },
   });
   const worker1Promise = worker1.run();
@@ -167,7 +167,7 @@ test('Worker deployment based versioning with ramping', async (t) => {
     workerDeploymentOptions: {
       useWorkerVersioning: true,
       version: v2,
-      defaultVersioningBehavior: 'pinned',
+      defaultVersioningBehavior: 'PINNED',
     },
   });
   const worker2Promise = worker2.run();
@@ -258,7 +258,7 @@ test('Worker deployment with dynamic workflow on run', async (t) => {
     workerDeploymentOptions: {
       useWorkerVersioning: true,
       version,
-      defaultVersioningBehavior: 'auto-upgrade',
+      defaultVersioningBehavior: 'AUTO_UPGRADE',
     },
   });
 
@@ -310,7 +310,7 @@ test('Workflows can use default versioning behavior', async (t) => {
     workerDeploymentOptions: {
       useWorkerVersioning: true,
       version: workerV1,
-      defaultVersioningBehavior: 'pinned',
+      defaultVersioningBehavior: 'PINNED',
     },
   });
 

packages/workflow/src/interfaces.ts

@@ -13,10 +13,11 @@ import {
   TypedSearchAttributes,
   SearchAttributePair,
   WorkerDeploymentVersion,
+  VersioningBehavior,
 } from '@temporalio/common';
 import { SymbolBasedInstanceOfError } from '@temporalio/common/lib/type-helpers';
 import { makeProtoEnumConverters } from '@temporalio/common/lib/internal-workflow/enums-helpers';
-import type { coresdk, temporal } from '@temporalio/proto';
+import type { coresdk } from '@temporalio/proto';
 
 /**
  * Workflow Execution information
@@ -606,5 +607,5 @@ export type UpdateHandlerOptions<Args extends any[]> = {
 export interface ActivationCompletion {
   commands: coresdk.workflow_commands.IWorkflowCommand[];
   usedInternalFlags: number[];
-  versioningBehavior?: temporal.api.enums.v1.VersioningBehavior;
+  versioningBehavior?: VersioningBehavior;
 }

packages/workflow/src/internals.ts

@@ -29,7 +29,7 @@ import {
 } from '@temporalio/common/lib/converter/payload-search-attributes';
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
 import { makeProtoEnumConverters } from '@temporalio/common/lib/internal-workflow';
-import { coresdk, temporal } from '@temporalio/proto';
+import type { coresdk, temporal } from '@temporalio/proto';
 import { alea, RNG } from './alea';
 import { RootCancellationScope } from './cancellation-scope';
 import { UpdateScope } from './update-scope';
@@ -489,16 +489,10 @@ export class Activator implements ActivationHandler {
   }
 
   concludeActivation(): ActivationCompletion {
-    let versioningBehavior;
-    if (this.versioningBehavior === 'auto-upgrade') {
-      versioningBehavior = temporal.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_AUTO_UPGRADE;
-    } else if (this.versioningBehavior === 'pinned') {
-      versioningBehavior = temporal.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_PINNED;
-    }
     return {
       commands: this.commands.splice(0),
       usedInternalFlags: [...this.knownFlags],
-      versioningBehavior,
+      versioningBehavior: this.versioningBehavior,
     };
   }
 

packages/workflow/src/worker-interface.ts

@@ -3,9 +3,14 @@
  *
  * @module
  */
-import { IllegalStateError, isWorkflowFunctionWithOptions } from '@temporalio/common';
+import {
+  encodeVersioningBehavior,
+  IllegalStateError,
+  isWorkflowFunctionWithOptions,
+  VersioningBehavior,
+} from '@temporalio/common';
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
-import { coresdk } from '@temporalio/proto';
+import { coresdk, temporal } from '@temporalio/proto';
 import { disableStorage } from './cancellation-scope';
 import { disableUpdateStorage } from './update-scope';
 import { WorkflowInterceptorsFactory } from './interceptors';
@@ -209,7 +214,11 @@ export function concludeActivation(): coresdk.workflow_completion.IWorkflowActiv
     }
     return {
       runId: activator.info.runId,
-      successful: { ...activationCompletion, commands },
+      successful: {
+        ...activationCompletion,
+        commands,
+        versioningBehavior: encodeVersioningBehavior(activationCompletion.versioningBehavior),
+      },
     };
   } finally {
     activator.rethrowSynchronously = false;