@temporalio/workflow 1.11.3 → 1.11.4

package/src/interfaces.ts

@@ -11,7 +11,8 @@ import {
   Duration,
   VersioningIntent,
 } from '@temporalio/common';
-import { checkExtends, SymbolBasedInstanceOfError } from '@temporalio/common/lib/type-helpers';
+import { SymbolBasedInstanceOfError } from '@temporalio/common/lib/type-helpers';
+import { makeProtoEnumConverters } from '@temporalio/common/lib/internal-workflow/enums-helpers';
 import type { coresdk } from '@temporalio/proto';
 
 /**
@@ -273,16 +274,18 @@ export interface ContinueAsNewOptions {
  *
  * @default {@link ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED}
  */
-export enum ChildWorkflowCancellationType {
+export type ChildWorkflowCancellationType =
+  (typeof ChildWorkflowCancellationType)[keyof typeof ChildWorkflowCancellationType];
+export const ChildWorkflowCancellationType = {
   /**
    * Don't send a cancellation request to the Child.
    */
-  ABANDON = 0,
+  ABANDON: 'ABANDON',
 
   /**
    * Send a cancellation request to the Child. Immediately throw the error.
    */
-  TRY_CANCEL = 1,
+  TRY_CANCEL: 'TRY_CANCEL',
 
   /**
    * Send a cancellation request to the Child. The Child may respect cancellation, in which case an error will be thrown
@@ -292,48 +295,102 @@ export enum ChildWorkflowCancellationType {
    *
    * @default
    */
-  WAIT_CANCELLATION_COMPLETED = 2,
+  WAIT_CANCELLATION_COMPLETED: 'WAIT_CANCELLATION_COMPLETED',
 
   /**
    * Send a cancellation request to the Child. Throw the error once the Server receives the Child cancellation request.
    */
-  WAIT_CANCELLATION_REQUESTED = 3,
-}
-
-checkExtends<coresdk.child_workflow.ChildWorkflowCancellationType, ChildWorkflowCancellationType>();
-checkExtends<ChildWorkflowCancellationType, coresdk.child_workflow.ChildWorkflowCancellationType>();
+  WAIT_CANCELLATION_REQUESTED: 'WAIT_CANCELLATION_REQUESTED',
+} as const;
+
+// ts-prune-ignore-next
+export const [encodeChildWorkflowCancellationType, decodeChildWorkflowCancellationType] = makeProtoEnumConverters<
+  coresdk.child_workflow.ChildWorkflowCancellationType,
+  typeof coresdk.child_workflow.ChildWorkflowCancellationType,
+  keyof typeof coresdk.child_workflow.ChildWorkflowCancellationType,
+  typeof ChildWorkflowCancellationType,
+  ''
+>(
+  {
+    [ChildWorkflowCancellationType.ABANDON]: 0,
+    [ChildWorkflowCancellationType.TRY_CANCEL]: 1,
+    [ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED]: 2,
+    [ChildWorkflowCancellationType.WAIT_CANCELLATION_REQUESTED]: 3,
+  } as const,
+  ''
+);
 
 /**
  * How a Child Workflow reacts to the Parent Workflow reaching a Closed state.
  *
  * @see {@link https://docs.temporal.io/concepts/what-is-a-parent-close-policy/ | Parent Close Policy}
  */
-export enum ParentClosePolicy {
+export type ParentClosePolicy = (typeof ParentClosePolicy)[keyof typeof ParentClosePolicy];
+export const ParentClosePolicy = {
+  /**
+   * When the Parent is Closed, the Child is Terminated.
+   *
+   * @default
+   */
+  TERMINATE: 'TERMINATE',
+
+  /**
+   * When the Parent is Closed, nothing is done to the Child.
+   */
+  ABANDON: 'ABANDON',
+
+  /**
+   * When the Parent is Closed, the Child is Cancelled.
+   */
+  REQUEST_CANCEL: 'REQUEST_CANCEL',
+
+  /// Anything below this line has been deprecated
+
   /**
    * If a `ParentClosePolicy` is set to this, or is not set at all, the server default value will be used.
+   *
+   * @deprecated Either leave property `undefined`, or set an explicit policy instead.
    */
-  PARENT_CLOSE_POLICY_UNSPECIFIED = 0,
+  PARENT_CLOSE_POLICY_UNSPECIFIED: undefined, // eslint-disable-line deprecation/deprecation
 
   /**
    * When the Parent is Closed, the Child is Terminated.
    *
-   * @default
+   * @deprecated Use {@link ParentClosePolicy.TERMINATE} instead.
    */
-  PARENT_CLOSE_POLICY_TERMINATE = 1,
+  PARENT_CLOSE_POLICY_TERMINATE: 'TERMINATE', // eslint-disable-line deprecation/deprecation
 
   /**
    * When the Parent is Closed, nothing is done to the Child.
+   *
+   * @deprecated Use {@link ParentClosePolicy.ABANDON} instead.
    */
-  PARENT_CLOSE_POLICY_ABANDON = 2,
+  PARENT_CLOSE_POLICY_ABANDON: 'ABANDON', // eslint-disable-line deprecation/deprecation
 
   /**
    * When the Parent is Closed, the Child is Cancelled.
-   */
-  PARENT_CLOSE_POLICY_REQUEST_CANCEL = 3,
-}
-
-checkExtends<coresdk.child_workflow.ParentClosePolicy, ParentClosePolicy>();
-checkExtends<ParentClosePolicy, coresdk.child_workflow.ParentClosePolicy>();
+   *
+   * @deprecated Use {@link ParentClosePolicy.REQUEST_CANCEL} instead.
+   */
+  PARENT_CLOSE_POLICY_REQUEST_CANCEL: 'REQUEST_CANCEL', // eslint-disable-line deprecation/deprecation
+} as const;
+
+// ts-prune-ignore-next
+export const [encodeParentClosePolicy, decodeParentClosePolicy] = makeProtoEnumConverters<
+  coresdk.child_workflow.ParentClosePolicy,
+  typeof coresdk.child_workflow.ParentClosePolicy,
+  keyof typeof coresdk.child_workflow.ParentClosePolicy,
+  typeof ParentClosePolicy,
+  'PARENT_CLOSE_POLICY_'
+>(
+  {
+    [ParentClosePolicy.TERMINATE]: 1,
+    [ParentClosePolicy.ABANDON]: 2,
+    [ParentClosePolicy.REQUEST_CANCEL]: 3,
+    UNSPECIFIED: 0,
+  } as const,
+  'PARENT_CLOSE_POLICY_'
+);
 
 export interface ChildWorkflowOptions extends CommonWorkflowOptions {
   /**
@@ -346,6 +403,8 @@ export interface ChildWorkflowOptions extends CommonWorkflowOptions {
   /**
    * Task queue to use for Workflow tasks. It should match a task queue specified when creating a
    * `Worker` that hosts the Workflow code.
+   *
+   * By default, a child is scheduled on the same Task Queue as the parent.
    */
   taskQueue?: string;
 

package/src/internals.ts

@@ -24,7 +24,7 @@ import {
   SearchAttributes,
 } from '@temporalio/common';
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
-import { checkExtends } from '@temporalio/common/lib/type-helpers';
+import { makeProtoEnumConverters } from '@temporalio/common/lib/internal-workflow';
 import type { coresdk, temporal } from '@temporalio/proto';
 import { alea, RNG } from './alea';
 import { RootCancellationScope } from './cancellation-scope';
@@ -48,13 +48,26 @@ import pkg from './pkg';
 import { SdkFlag, assertValidFlag } from './flags';
 import { executeWithLifecycleLogging, log } from './logs';
 
-enum StartChildWorkflowExecutionFailedCause {
-  START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED = 0,
-  START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS = 1,
-}
-
-checkExtends<coresdk.child_workflow.StartChildWorkflowExecutionFailedCause, StartChildWorkflowExecutionFailedCause>();
-checkExtends<StartChildWorkflowExecutionFailedCause, coresdk.child_workflow.StartChildWorkflowExecutionFailedCause>();
+const StartChildWorkflowExecutionFailedCause = {
+  WORKFLOW_ALREADY_EXISTS: 'WORKFLOW_ALREADY_EXISTS',
+} as const;
+type StartChildWorkflowExecutionFailedCause =
+  (typeof StartChildWorkflowExecutionFailedCause)[keyof typeof StartChildWorkflowExecutionFailedCause];
+
+const [_encodeStartChildWorkflowExecutionFailedCause, decodeStartChildWorkflowExecutionFailedCause] =
+  makeProtoEnumConverters<
+    coresdk.child_workflow.StartChildWorkflowExecutionFailedCause,
+    typeof coresdk.child_workflow.StartChildWorkflowExecutionFailedCause,
+    keyof typeof coresdk.child_workflow.StartChildWorkflowExecutionFailedCause,
+    typeof StartChildWorkflowExecutionFailedCause,
+    'START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_'
+  >(
+    {
+      [StartChildWorkflowExecutionFailedCause.WORKFLOW_ALREADY_EXISTS]: 1,
+      UNSPECIFIED: 0,
+    } as const,
+    'START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_'
+  );
 
 export interface Stack {
   formatted: string;
@@ -517,10 +530,7 @@ export class Activator implements ActivationHandler {
     if (activation.succeeded) {
       resolve(activation.succeeded.runId);
     } else if (activation.failed) {
-      if (
-        activation.failed.cause !==
-        StartChildWorkflowExecutionFailedCause.START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS
-      ) {
+      if (decodeStartChildWorkflowExecutionFailedCause(activation.failed.cause) !== 'WORKFLOW_ALREADY_EXISTS') {
         throw new IllegalStateError('Got unknown StartChildWorkflowExecutionFailedCause');
       }
       if (!(activation.seq && activation.failed.workflowId && activation.failed.workflowType)) {

package/src/worker-interface.ts

@@ -38,14 +38,14 @@ export function initRuntime(options: WorkflowCreateOptionsInternal): void {
   setActivatorUntyped(activator);
 
   // webpack alias to payloadConverterPath
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const customPayloadConverter = require('__temporal_custom_payload_converter').payloadConverter;
   // The `payloadConverter` export is validated in the Worker
   if (customPayloadConverter != null) {
     activator.payloadConverter = customPayloadConverter;
   }
   // webpack alias to failureConverterPath
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const customFailureConverter = require('__temporal_custom_failure_converter').failureConverter;
   // The `failureConverter` export is validated in the Worker
   if (customFailureConverter != null) {

package/src/workflow.ts

@@ -2,6 +2,8 @@ import {
   ActivityFunction,
   ActivityOptions,
   compileRetryPolicy,
+  encodeActivityCancellationType,
+  encodeWorkflowIdReusePolicy,
   extractWorkflowType,
   HandlerUnfinishedPolicy,
   LocalActivityOptions,
@@ -46,6 +48,8 @@ import {
   UpdateHandlerOptions,
   WorkflowInfo,
   UpdateInfo,
+  encodeChildWorkflowCancellationType,
+  encodeParentClosePolicy,
 } from './interfaces';
 import { LocalActivityDoBackoff } from './errors';
 import { assertInWorkflowContext, getActivator, maybeGetActivator } from './global-attributes';
@@ -179,7 +183,7 @@ function scheduleActivityNextHandler({ options, args, headers, seq, activityType
         startToCloseTimeout: msOptionalToTs(options.startToCloseTimeout),
         scheduleToStartTimeout: msOptionalToTs(options.scheduleToStartTimeout),
         headers,
-        cancellationType: options.cancellationType,
+        cancellationType: encodeActivityCancellationType(options.cancellationType),
         doNotEagerlyExecute: !(options.allowEagerDispatch ?? true),
         versioningIntent: versioningIntentToProto(options.versioningIntent),
       },
@@ -246,7 +250,7 @@ async function scheduleLocalActivityNextHandler({
         scheduleToStartTimeout: msOptionalToTs(options.scheduleToStartTimeout),
         localRetryThreshold: msOptionalToTs(options.localRetryThreshold),
         headers,
-        cancellationType: options.cancellationType,
+        cancellationType: encodeActivityCancellationType(options.cancellationType),
       },
     });
     activator.completions.activity.set(seq, {
@@ -372,9 +376,9 @@ function startChildWorkflowExecutionNextHandler({
         workflowTaskTimeout: msOptionalToTs(options.workflowTaskTimeout),
         namespace: activator.info.namespace, // Not configurable
         headers,
-        cancellationType: options.cancellationType,
-        workflowIdReusePolicy: options.workflowIdReusePolicy,
-        parentClosePolicy: options.parentClosePolicy,
+        cancellationType: encodeChildWorkflowCancellationType(options.cancellationType),
+        workflowIdReusePolicy: encodeWorkflowIdReusePolicy(options.workflowIdReusePolicy),
+        parentClosePolicy: encodeParentClosePolicy(options.parentClosePolicy),
         cronSchedule: options.cronSchedule,
         searchAttributes: options.searchAttributes
           ? mapToPayloads(searchAttributePayloadConverter, options.searchAttributes)