@temporalio/workflow 1.10.2 → 1.11.0

package/src/flags.ts

@@ -16,7 +16,26 @@ export const SdkFlags = {
    *
    * @since Introduced in 1.10.2/1.11.0.
    */
-  NonCancellableScopesAreShieldedFromPropagation: defineFlag(1, false),
+  NonCancellableScopesAreShieldedFromPropagation: defineFlag(1, true),
+
+  /**
+   * Prior to 1.11.0, when processing a Workflow activation, the SDK would execute `notifyHasPatch`
+   * and `signalWorkflow` jobs in distinct phases, before other types of jobs. The primary reason
+   * behind that multi-phase algorithm was to avoid the possibility that a Workflow execution might
+   * complete before all incoming signals have been dispatched (at least to the point that the
+   * _synchronous_ part of the handler function has been executed).
+   *
+   * This flag replaces that multi-phase algorithm with a simpler one where jobs are simply sorted as
+   * `(signals and updates) -> others`, but without processing them as distinct batches (i.e. without
+   * leaving/reentering the VM context between each group, which automatically triggers the execution
+   * of all outstanding microtasks). That single-phase approach resolves a number of quirks of the
+   * former algorithm, and yet still satisfies to the original requirement of ensuring that every
+   * `signalWorkflow` jobs - and now `doUpdate` jobs as well - have been given a proper chance to
+   * execute before the Workflow main function might completes.
+   *
+   * @since Introduced in 1.11.0. This change is not rollback-safe.
+   */
+  ProcessWorkflowActivationJobsAsSingleBatch: defineFlag(2, true),
 } as const;
 
 function defineFlag(id: number, def: boolean): SdkFlag {

package/src/index.ts

@@ -92,11 +92,11 @@ export {
   ContinueAsNew,
   ContinueAsNewOptions,
   EnhancedStackTrace,
-  FileLocation,
-  FileSlice,
+  StackTraceFileLocation,
+  StackTraceFileSlice,
   ParentClosePolicy,
   ParentWorkflowInfo,
-  SDKInfo,
+  StackTraceSDKInfo,
   StackTrace,
   UnsafeWorkflowInfo,
   WorkflowInfo,

package/src/interfaces.ts

@@ -3,6 +3,7 @@ import {
   RetryPolicy,
   TemporalFailure,
   CommonWorkflowOptions,
+  HandlerUnfinishedPolicy,
   SearchAttributes,
   SignalDefinition,
   UpdateDefinition,
@@ -190,6 +191,23 @@ export interface UnsafeWorkflowInfo {
   readonly isReplaying: boolean;
 }
 
+/**
+ * Information about a workflow update.
+ *
+ * @experimental
+ */
+export interface UpdateInfo {
+  /**
+   *  A workflow-unique identifier for this update.
+   */
+  readonly id: string;
+
+  /**
+   *  The update type name.
+   */
+  readonly name: string;
+}
+
 export interface ParentWorkflowInfo {
   workflowId: string;
   runId: string;
@@ -365,7 +383,7 @@ export type RequiredChildWorkflowOptions = Required<Pick<ChildWorkflowOptions, '
 
 export type ChildWorkflowOptionsWithDefaults = ChildWorkflowOptions & RequiredChildWorkflowOptions;
 
-export interface SDKInfo {
+export interface StackTraceSDKInfo {
   name: string;
   version: string;
 }
@@ -373,26 +391,26 @@ export interface SDKInfo {
 /**
  * Represents a slice of a file starting at lineOffset
  */
-export interface FileSlice {
+export interface StackTraceFileSlice {
   /**
-   * slice of a file with `\n` (newline) line terminator.
+   * Only used possible to trim the file without breaking syntax highlighting.
    */
-  content: string;
+  line_offset: number;
   /**
-   * Only used possible to trim the file without breaking syntax highlighting.
+   * slice of a file with `\n` (newline) line terminator.
    */
-  lineOffset: number;
+  content: string;
 }
 
 /**
  * A pointer to a location in a file
  */
-export interface FileLocation {
+export interface StackTraceFileLocation {
   /**
    * Path to source file (absolute or relative).
    * When using a relative path, make sure all paths are relative to the same root.
    */
-  filePath?: string;
+  file_path?: string;
   /**
    * If possible, SDK should send this, required for displaying the code location.
    */
@@ -405,24 +423,28 @@ export interface FileLocation {
    * Function name this line belongs to (if applicable).
    * Used for falling back to stack trace view.
    */
-  functionName?: string;
+  function_name?: string;
+  /**
+   * Flag to mark this as internal SDK code and hide by default in the UI.
+   */
+  internal_code: boolean;
 }
 
 export interface StackTrace {
-  locations: FileLocation[];
+  locations: StackTraceFileLocation[];
 }
 
 /**
  * Used as the result for the enhanced stack trace query
  */
 export interface EnhancedStackTrace {
-  sdk: SDKInfo;
+  sdk: StackTraceSDKInfo;
   /**
    * Mapping of file path to file contents.
    * SDK may choose to send no, some or all sources.
    * Sources might be trimmed, and some time only the file(s) of the top element of the trace will be sent.
    */
-  sources: Record<string, FileSlice[]>;
+  sources: Record<string, StackTraceFileSlice[]>;
   stacks: StackTrace[];
 }
 
@@ -431,6 +453,7 @@ export interface WorkflowCreateOptions {
   randomnessSeed: number[];
   now: number;
   patches: string[];
+  sdkFlags: number[];
   showStackTraceSources: boolean;
 }
 
@@ -473,12 +496,16 @@ export type QueryHandlerOptions = { description?: string };
 /**
  * A description of a signal handler.
  */
-export type SignalHandlerOptions = { description?: string };
+export type SignalHandlerOptions = { description?: string; unfinishedPolicy?: HandlerUnfinishedPolicy };
 
 /**
  * A validator and description of an update handler.
  */
-export type UpdateHandlerOptions<Args extends any[]> = { validator?: UpdateValidator<Args>; description?: string };
+export type UpdateHandlerOptions<Args extends any[]> = {
+  validator?: UpdateValidator<Args>;
+  description?: string;
+  unfinishedPolicy?: HandlerUnfinishedPolicy;
+};
 
 export interface ActivationCompletion {
   commands: coresdk.workflow_commands.IWorkflowCommand[];