@temporalio/workflow 1.10.1 → 1.10.3

package/lib/cancellation-scope.d.ts

@@ -11,7 +11,7 @@ export interface CancellationScopeOptions {
     /**
      * Time in milliseconds before the scope cancellation is automatically requested
      */
-    timeout?: number;
+    timeout?: Duration;
     /**
      * If false, prevent outer cancellation from propagating to inner scopes, Activities, timers, and Triggers, defaults to true.
      * (Scope still propagates CancelledFailure thrown from within).
@@ -24,38 +24,56 @@ export interface CancellationScopeOptions {
     parent?: CancellationScope | typeof NO_PARENT;
 }
 /**
- * In the SDK, Workflows are represented internally by a tree of scopes where the `execute` function runs in the root scope.
- * Cancellation propagates from outer scopes to inner ones and is handled by catching {@link CancelledFailure}s
- * thrown by cancellable operations (see below).
+ * Cancellation Scopes provide the mechanic by which a Workflow may gracefully handle incoming requests for cancellation
+ * (e.g. in response to {@link WorkflowHandle.cancel} or through the UI or CLI), as well as request cancelation of
+ * cancellable operations it owns (e.g. Activities, Timers, Child Workflows, etc).
  *
- * Scopes are created using the `CancellationScope` constructor or the static helper methods
- * {@link cancellable}, {@link nonCancellable} and {@link withTimeout}.
+ * Cancellation Scopes form a tree, with the Workflow's main function running in the root scope of that tree.
+ * By default, cancellation propagates down from a parent scope to its children and its cancellable operations.
+ * A non-cancellable scope can receive cancellation requests, but is never effectively considered as cancelled,
+ * thus shieldding its children and cancellable operations from propagation of cancellation requests it receives.
  *
- * When a `CancellationScope` is cancelled, it will propagate cancellation any child scopes and any cancellable
- * operations created within it, such as:
+ * Scopes are created using the `CancellationScope` constructor or the static helper methods {@link cancellable},
+ * {@link nonCancellable} and {@link withTimeout}. `withTimeout` creates a scope that automatically cancels itself after
+ * some duration.
  *
- * - Activities
- * - Child Workflows
- * - Timers (created with the {@link sleep} function)
- * - {@link Trigger}s
- *
- * @example
+ * Cancellation of a cancellable scope results in all operations created directly in that scope to throw a
+ * {@link CancelledFailure} (either directly, or as the `cause` of an {@link ActivityFailure} or a
+ * {@link ChildWorkflowFailure}). Further attempt to create new cancellable scopes or cancellable operations within a
+ * scope that has already been cancelled will also immediately throw a {@link CancelledFailure} exception. It is however
+ * possible to create a non-cancellable scope at that point; this is often used to execute rollback or cleanup
+ * operations. For example:
  *
  * ```ts
- * await CancellationScope.cancellable(async () => {
- *   const promise = someActivity();
- *   CancellationScope.current().cancel(); // Cancels the activity
- *   await promise; // Throws `ActivityFailure` with `cause` set to `CancelledFailure`
- * });
+ * async function myWorkflow(...): Promise<void> {
+ *   try {
+ *     // This activity runs in the root cancellation scope. Therefore, a cancelation request on
+ *     // the Workflow execution (e.g. through the UI or CLI) automatically propagates to this
+ *     // activity. Assuming that the activity properly handle the cancellation request, then the
+ *     // call below will throw an `ActivityFailure` exception, with `cause` sets to an
+ *     // instance of `CancelledFailure`.
+ *     await someActivity();
+ *   } catch (e) {
+ *     if (isCancellation(e)) {
+ *       // Run cleanup activity in a non-cancellable scope
+ *       await CancellationScope.nonCancellable(async () => {
+ *         await cleanupActivity();
+ *       }
+ *     } else {
+ *       throw e;
+ *     }
+ *   }
+ * }
  * ```
  *
- * @example
+ * A cancellable scope may be programatically cancelled by calling {@link cancel|`scope.cancel()`}`. This may be used,
+ * for example, to explicitly request cancellation of an Activity or Child Workflow:
  *
  * ```ts
- * const scope = new CancellationScope();
- * const promise = scope.run(someActivity);
- * scope.cancel(); // Cancels the activity
- * await promise; // Throws `ActivityFailure` with `cause` set to `CancelledFailure`
+ * const cancellableActivityScope = new CancellationScope();
+ * const activityPromise = cancellableActivityScope.run(() => someActivity());
+ * cancellableActivityScope.cancel(); // Cancels the activity
+ * await activityPromise; // Throws `ActivityFailure` with `cause` set to `CancelledFailure`
  * ```
  */
 export declare class CancellationScope {
@@ -65,8 +83,13 @@ export declare class CancellationScope {
      */
     protected readonly timeout?: number;
     /**
-     * If false, prevent outer cancellation from propagating to inner scopes, Activities, timers, and Triggers, defaults to true.
-     * (Scope still propagates CancelledFailure thrown from within)
+     * If false, then this scope will never be considered cancelled, even if a cancellation request is received (either
+     * directly by calling `scope.cancel()` or indirectly by cancelling a cancellable parent scope). This effectively
+     * shields the scope's children and cancellable operations from propagation of cancellation requests made on the
+     * non-cancellable scope.
+     *
+     * Note that the Promise returned by the `run` function of non-cancellable scope may still throw a `CancelledFailure`
+     * if such an exception is thrown from within that scope (e.g. by directly cancelling a cancellable child scope).
      */
     readonly cancellable: boolean;
     /**
@@ -74,11 +97,19 @@ export declare class CancellationScope {
      */
     readonly parent?: CancellationScope;
     /**
-     * Rejected when scope cancellation is requested
+     * A Promise that throws when a cancellable scope receives a cancellation request, either directly
+     * (i.e. `scope.cancel()`), or indirectly (by cancelling a cancellable parent scope).
+     *
+     * Note that a non-cancellable scope may receive cancellation requests, resulting in the `cancelRequested` promise for
+     * that scope to throw, though the scope will not effectively get cancelled (i.e. `consideredCancelled` will still
+     * return `false`, and cancellation will not be propagated to child scopes and contained operations).
      */
     readonly cancelRequested: Promise<never>;
     protected readonly reject: (reason?: any) => void;
     constructor(options?: CancellationScopeOptions);
+    /**
+     * Whether the scope was effectively cancelled. A non-cancellable scope can never be considered cancelled.
+     */
     get consideredCancelled(): boolean;
     /**
      * Activate the scope as current and run  `fn`
@@ -108,7 +139,7 @@ export declare class CancellationScope {
     /** Alias to `new CancellationScope({ cancellable: false }).run(fn)` */
     static nonCancellable<T>(fn: () => Promise<T>): Promise<T>;
     /** Alias to `new CancellationScope({ cancellable: true, timeout }).run(fn)` */
-    static withTimeout<T>(timeout: number, fn: () => Promise<T>): Promise<T>;
+    static withTimeout<T>(timeout: Duration, fn: () => Promise<T>): Promise<T>;
 }
 /**
  * Avoid exposing the storage directly so it doesn't get frozen

package/lib/cancellation-scope.js

@@ -14,7 +14,10 @@ var _CancellationScope_cancelRequested;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerSleepImplementation = exports.RootCancellationScope = exports.disableStorage = exports.CancellationScope = exports.AsyncLocalStorage = void 0;
 const common_1 = require("@temporalio/common");
+const time_1 = require("@temporalio/common/lib/time");
 const stack_helpers_1 = require("./stack-helpers");
+const global_attributes_1 = require("./global-attributes");
+const flags_1 = require("./flags");
 // AsyncLocalStorage is injected via vm module into global scope.
 // In case Workflow code is imported in Node.js context, replace with an empty class.
 exports.AsyncLocalStorage = globalThis.AsyncLocalStorage ?? class {
@@ -22,49 +25,65 @@ exports.AsyncLocalStorage = globalThis.AsyncLocalStorage ?? class {
 /** Magic symbol used to create the root scope - intentionally not exported */
 const NO_PARENT = Symbol('NO_PARENT');
 /**
- * In the SDK, Workflows are represented internally by a tree of scopes where the `execute` function runs in the root scope.
- * Cancellation propagates from outer scopes to inner ones and is handled by catching {@link CancelledFailure}s
- * thrown by cancellable operations (see below).
+ * Cancellation Scopes provide the mechanic by which a Workflow may gracefully handle incoming requests for cancellation
+ * (e.g. in response to {@link WorkflowHandle.cancel} or through the UI or CLI), as well as request cancelation of
+ * cancellable operations it owns (e.g. Activities, Timers, Child Workflows, etc).
  *
- * Scopes are created using the `CancellationScope` constructor or the static helper methods
- * {@link cancellable}, {@link nonCancellable} and {@link withTimeout}.
+ * Cancellation Scopes form a tree, with the Workflow's main function running in the root scope of that tree.
+ * By default, cancellation propagates down from a parent scope to its children and its cancellable operations.
+ * A non-cancellable scope can receive cancellation requests, but is never effectively considered as cancelled,
+ * thus shieldding its children and cancellable operations from propagation of cancellation requests it receives.
  *
- * When a `CancellationScope` is cancelled, it will propagate cancellation any child scopes and any cancellable
- * operations created within it, such as:
+ * Scopes are created using the `CancellationScope` constructor or the static helper methods {@link cancellable},
+ * {@link nonCancellable} and {@link withTimeout}. `withTimeout` creates a scope that automatically cancels itself after
+ * some duration.
  *
- * - Activities
- * - Child Workflows
- * - Timers (created with the {@link sleep} function)
- * - {@link Trigger}s
- *
- * @example
+ * Cancellation of a cancellable scope results in all operations created directly in that scope to throw a
+ * {@link CancelledFailure} (either directly, or as the `cause` of an {@link ActivityFailure} or a
+ * {@link ChildWorkflowFailure}). Further attempt to create new cancellable scopes or cancellable operations within a
+ * scope that has already been cancelled will also immediately throw a {@link CancelledFailure} exception. It is however
+ * possible to create a non-cancellable scope at that point; this is often used to execute rollback or cleanup
+ * operations. For example:
  *
  * ```ts
- * await CancellationScope.cancellable(async () => {
- *   const promise = someActivity();
- *   CancellationScope.current().cancel(); // Cancels the activity
- *   await promise; // Throws `ActivityFailure` with `cause` set to `CancelledFailure`
- * });
+ * async function myWorkflow(...): Promise<void> {
+ *   try {
+ *     // This activity runs in the root cancellation scope. Therefore, a cancelation request on
+ *     // the Workflow execution (e.g. through the UI or CLI) automatically propagates to this
+ *     // activity. Assuming that the activity properly handle the cancellation request, then the
+ *     // call below will throw an `ActivityFailure` exception, with `cause` sets to an
+ *     // instance of `CancelledFailure`.
+ *     await someActivity();
+ *   } catch (e) {
+ *     if (isCancellation(e)) {
+ *       // Run cleanup activity in a non-cancellable scope
+ *       await CancellationScope.nonCancellable(async () => {
+ *         await cleanupActivity();
+ *       }
+ *     } else {
+ *       throw e;
+ *     }
+ *   }
+ * }
  * ```
  *
- * @example
+ * A cancellable scope may be programatically cancelled by calling {@link cancel|`scope.cancel()`}`. This may be used,
+ * for example, to explicitly request cancellation of an Activity or Child Workflow:
  *
  * ```ts
- * const scope = new CancellationScope();
- * const promise = scope.run(someActivity);
- * scope.cancel(); // Cancels the activity
- * await promise; // Throws `ActivityFailure` with `cause` set to `CancelledFailure`
+ * const cancellableActivityScope = new CancellationScope();
+ * const activityPromise = cancellableActivityScope.run(() => someActivity());
+ * cancellableActivityScope.cancel(); // Cancels the activity
+ * await activityPromise; // Throws `ActivityFailure` with `cause` set to `CancelledFailure`
  * ```
  */
 class CancellationScope {
     constructor(options) {
         _CancellationScope_cancelRequested.set(this, false);
-        this.timeout = options?.timeout;
+        this.timeout = (0, time_1.msOptionalToNumber)(options?.timeout);
         this.cancellable = options?.cancellable ?? true;
         this.cancelRequested = new Promise((_, reject) => {
-            // Typescript does not understand that the Promise executor runs synchronously
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore
+            // @ts-expect-error TSC doesn't understand that the Promise executor runs synchronously
             this.reject = (err) => {
                 __classPrivateFieldSet(this, _CancellationScope_cancelRequested, true, "f");
                 reject(err);
@@ -75,12 +94,26 @@ class CancellationScope {
         (0, stack_helpers_1.untrackPromise)(this.cancelRequested.catch(() => undefined));
         if (options?.parent !== NO_PARENT) {
             this.parent = options?.parent || CancellationScope.current();
-            __classPrivateFieldSet(this, _CancellationScope_cancelRequested, __classPrivateFieldGet(this.parent, _CancellationScope_cancelRequested, "f"), "f");
-            this.parent.cancelRequested.catch((err) => {
-                this.reject(err);
-            });
+            if (this.parent.cancellable ||
+                (__classPrivateFieldGet(this.parent, _CancellationScope_cancelRequested, "f") &&
+                    !(0, global_attributes_1.getActivator)().hasFlag(flags_1.SdkFlags.NonCancellableScopesAreShieldedFromPropagation))) {
+                __classPrivateFieldSet(this, _CancellationScope_cancelRequested, __classPrivateFieldGet(this.parent, _CancellationScope_cancelRequested, "f"), "f");
+                (0, stack_helpers_1.untrackPromise)(this.parent.cancelRequested.catch((err) => {
+                    this.reject(err);
+                }));
+            }
+            else {
+                (0, stack_helpers_1.untrackPromise)(this.parent.cancelRequested.catch((err) => {
+                    if (!(0, global_attributes_1.getActivator)().hasFlag(flags_1.SdkFlags.NonCancellableScopesAreShieldedFromPropagation)) {
+                        this.reject(err);
+                    }
+                }));
+            }
         }
     }
+    /**
+     * Whether the scope was effectively cancelled. A non-cancellable scope can never be considered cancelled.
+     */
     get consideredCancelled() {
         return __classPrivateFieldGet(this, _CancellationScope_cancelRequested, "f") && this.cancellable;
     }
@@ -101,12 +134,25 @@ class CancellationScope {
      * Could have been written as anonymous function, made into a method for improved stack traces.
      */
     async runInContext(fn) {
+        let timerScope;
         if (this.timeout) {
-            (0, stack_helpers_1.untrackPromise)(sleep(this.timeout).then(() => this.cancel(), () => {
+            timerScope = new CancellationScope();
+            (0, stack_helpers_1.untrackPromise)(timerScope
+                .run(() => sleep(this.timeout))
+                .then(() => this.cancel(), () => {
                 // scope was already cancelled, ignore
             }));
         }
-        return await fn();
+        try {
+            return await fn();
+        }
+        finally {
+            if (timerScope &&
+                !timerScope.consideredCancelled &&
+                (0, global_attributes_1.getActivator)().hasFlag(flags_1.SdkFlags.NonCancellableScopesAreShieldedFromPropagation)) {
+                timerScope.cancel();
+            }
+        }
     }
     /**
      * Request to cancel the scope and linked children

package/lib/cancellation-scope.js.map

@@ -1 +1 @@
-{"version":3,"file":"cancellation-scope.js","sourceRoot":"","sources":["../src/cancellation-scope.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,+CAAmF;AACnF,mDAAiD;AAEjD,iEAAiE;AACjE,qFAAqF;AACxE,QAAA,iBAAiB,GAAyB,UAAkB,CAAC,iBAAiB,IAAI;CAAQ,CAAC;AAExG,8EAA8E;AAC9E,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAuBtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAa,iBAAiB;IA4B5B,YAAY,OAAkC;QAP9C,6CAAmB,KAAK,EAAC;QAQvB,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,IAAI,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YAC/C,8EAA8E;YAC9E,6DAA6D;YAC7D,aAAa;YACb,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,EAAE;gBACpB,uBAAA,IAAI,sCAAoB,IAAI,MAAA,CAAC;gBAC7B,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,IAAA,8BAAc,EAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACrC,6BAA6B;QAC7B,IAAA,8BAAc,EAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QAC5D,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,iBAAiB,CAAC,OAAO,EAAE,CAAC;YAC7D,uBAAA,IAAI,sCAAoB,uBAAA,IAAI,CAAC,MAAM,0CAAiB,MAAA,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACxC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAW,mBAAmB;QAC5B,OAAO,uBAAA,IAAI,0CAAiB,IAAI,IAAI,CAAC,WAAW,CAAC;IACnD,CAAC;IACD;;;;;;;OAOG;IACH,GAAG,CAAI,EAAoB;QACzB,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAqB,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,YAAY,CAAI,EAAoB;QAClD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAA,8BAAc,EACZ,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CACtB,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EACnB,GAAG,EAAE;gBACH,sCAAsC;YACxC,CAAC,CACF,CACF,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,EAAE,EAAE,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,8BAA8B,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAO;QACZ,+EAA+E;QAC/E,OAAO,OAAO,CAAC,QAAQ,EAAE,IAAK,UAAkB,CAAC,sBAAsB,CAAC,SAAS,CAAC;IACpF,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,WAAW,CAAI,EAAoB;QACxC,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,uEAAuE;IACvE,MAAM,CAAC,cAAc,CAAI,EAAoB;QAC3C,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,WAAW,CAAI,OAAe,EAAE,EAAoB;QACzD,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAnHD,8CAmHC;;AAED,MAAM,OAAO,GAAG,IAAI,yBAAiB,EAAqB,CAAC;AAE3D;;GAEG;AACH,SAAgB,cAAc;IAC5B,OAAO,CAAC,OAAO,EAAE,CAAC;AACpB,CAAC;AAFD,wCAEC;AAED,MAAa,qBAAsB,SAAQ,iBAAiB;IAC1D;QACE,KAAK,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC1D,CAAC;CACF;AARD,sDAQC;AAED,+FAA+F;AAC/F,IAAI,KAAK,GAAG,CAAC,CAAW,EAAiB,EAAE;IACzC,MAAM,IAAI,0BAAiB,CAAC,4CAA4C,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF,SAAgB,2BAA2B,CAAC,EAAgB;IAC1D,KAAK,GAAG,EAAE,CAAC;AACb,CAAC;AAFD,kEAEC"}
+{"version":3,"file":"cancellation-scope.js","sourceRoot":"","sources":["../src/cancellation-scope.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,+CAAmF;AACnF,sDAAiE;AACjE,mDAAiD;AACjD,2DAAmD;AACnD,mCAAmC;AAEnC,iEAAiE;AACjE,qFAAqF;AACxE,QAAA,iBAAiB,GAAyB,UAAkB,CAAC,iBAAiB,IAAI;CAAQ,CAAC;AAExG,8EAA8E;AAC9E,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAuBtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAa,iBAAiB;IAuC5B,YAAY,OAAkC;QAP9C,6CAAmB,KAAK,EAAC;QAQvB,IAAI,CAAC,OAAO,GAAG,IAAA,yBAAkB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,IAAI,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YAC/C,uFAAuF;YACvF,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,EAAE;gBACpB,uBAAA,IAAI,sCAAoB,IAAI,MAAA,CAAC;gBAC7B,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,IAAA,8BAAc,EAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACrC,6BAA6B;QAC7B,IAAA,8BAAc,EAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QAC5D,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,iBAAiB,CAAC,OAAO,EAAE,CAAC;YAC7D,IACE,IAAI,CAAC,MAAM,CAAC,WAAW;gBACvB,CAAC,uBAAA,IAAI,CAAC,MAAM,0CAAiB;oBAC3B,CAAC,IAAA,gCAAY,GAAE,CAAC,OAAO,CAAC,gBAAQ,CAAC,8CAA8C,CAAC,CAAC,EACnF,CAAC;gBACD,uBAAA,IAAI,sCAAoB,uBAAA,IAAI,CAAC,MAAM,0CAAiB,MAAA,CAAC;gBACrD,IAAA,8BAAc,EACZ,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBACxC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACnB,CAAC,CAAC,CACH,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAA,8BAAc,EACZ,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBACxC,IAAI,CAAC,IAAA,gCAAY,GAAE,CAAC,OAAO,CAAC,gBAAQ,CAAC,8CAA8C,CAAC,EAAE,CAAC;wBACrF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACnB,CAAC;gBACH,CAAC,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC5B,OAAO,uBAAA,IAAI,0CAAiB,IAAI,IAAI,CAAC,WAAW,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAI,EAAoB;QACzB,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAqB,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,YAAY,CAAI,EAAoB;QAClD,IAAI,UAAyC,CAAC;QAC9C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,UAAU,GAAG,IAAI,iBAAiB,EAAE,CAAC;YACrC,IAAA,8BAAc,EACZ,UAAU;iBACP,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAiB,CAAC,CAAC;iBACxC,IAAI,CACH,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EACnB,GAAG,EAAE;gBACH,sCAAsC;YACxC,CAAC,CACF,CACJ,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,EAAE,CAAC;QACpB,CAAC;gBAAS,CAAC;YACT,IACE,UAAU;gBACV,CAAC,UAAU,CAAC,mBAAmB;gBAC/B,IAAA,gCAAY,GAAE,CAAC,OAAO,CAAC,gBAAQ,CAAC,8CAA8C,CAAC,EAC/E,CAAC;gBACD,UAAU,CAAC,MAAM,EAAE,CAAC;YACtB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,8BAA8B,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAO;QACZ,+EAA+E;QAC/E,OAAO,OAAO,CAAC,QAAQ,EAAE,IAAK,UAAkB,CAAC,sBAAsB,CAAC,SAAS,CAAC;IACpF,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,WAAW,CAAI,EAAoB;QACxC,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,uEAAuE;IACvE,MAAM,CAAC,cAAc,CAAI,EAAoB;QAC3C,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,WAAW,CAAI,OAAiB,EAAE,EAAoB;QAC3D,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AA9JD,8CA8JC;;AAED,MAAM,OAAO,GAAG,IAAI,yBAAiB,EAAqB,CAAC;AAE3D;;GAEG;AACH,SAAgB,cAAc;IAC5B,OAAO,CAAC,OAAO,EAAE,CAAC;AACpB,CAAC;AAFD,wCAEC;AAED,MAAa,qBAAsB,SAAQ,iBAAiB;IAC1D;QACE,KAAK,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC1D,CAAC;CACF;AARD,sDAQC;AAED,+FAA+F;AAC/F,IAAI,KAAK,GAAG,CAAC,CAAW,EAAiB,EAAE;IACzC,MAAM,IAAI,0BAAiB,CAAC,4CAA4C,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF,SAAgB,2BAA2B,CAAC,EAAgB;IAC1D,KAAK,GAAG,EAAE,CAAC;AACb,CAAC;AAFD,kEAEC"}

package/lib/flags.d.ts

@@ -0,0 +1,18 @@
+export type SdkFlag = {
+    get id(): number;
+    get default(): boolean;
+};
+export declare const SdkFlags: {
+    /**
+     * This flag gates multiple fixes related to cancellation scopes and timers introduced in 1.10.2/1.11.0:
+     * - Cancellation of a non-cancellable scope no longer propagates to children scopes
+     *   (see https://github.com/temporalio/sdk-typescript/issues/1423).
+     * - CancellationScope.withTimeout(fn) now cancel the timer if `fn` completes before expiration
+     *   of the timeout, similar to how `condition(fn, timeout)` works.
+     * - Timers created using setTimeout can now be intercepted.
+     *
+     * @since Introduced in 1.10.2/1.11.0.
+     */
+    readonly NonCancellableScopesAreShieldedFromPropagation: SdkFlag;
+};
+export declare function assertValidFlag(id: number): void;

package/lib/flags.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertValidFlag = exports.SdkFlags = void 0;
+const flagsRegistry = new Map();
+exports.SdkFlags = {
+    /**
+     * This flag gates multiple fixes related to cancellation scopes and timers introduced in 1.10.2/1.11.0:
+     * - Cancellation of a non-cancellable scope no longer propagates to children scopes
+     *   (see https://github.com/temporalio/sdk-typescript/issues/1423).
+     * - CancellationScope.withTimeout(fn) now cancel the timer if `fn` completes before expiration
+     *   of the timeout, similar to how `condition(fn, timeout)` works.
+     * - Timers created using setTimeout can now be intercepted.
+     *
+     * @since Introduced in 1.10.2/1.11.0.
+     */
+    NonCancellableScopesAreShieldedFromPropagation: defineFlag(1, false),
+};
+function defineFlag(id, def) {
+    const flag = { id, default: def };
+    flagsRegistry.set(id, flag);
+    return flag;
+}
+function assertValidFlag(id) {
+    if (!flagsRegistry.has(id))
+        throw new TypeError(`Unknown SDK flag: ${id}`);
+}
+exports.assertValidFlag = assertValidFlag;
+//# sourceMappingURL=flags.js.map

package/lib/flags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flags.js","sourceRoot":"","sources":["../src/flags.ts"],"names":[],"mappings":";;;AAKA,MAAM,aAAa,GAAyB,IAAI,GAAG,EAAE,CAAC;AAEzC,QAAA,QAAQ,GAAG;IACtB;;;;;;;;;OASG;IACH,8CAA8C,EAAE,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC;CAC5D,CAAC;AAEX,SAAS,UAAU,CAAC,EAAU,EAAE,GAAY;IAC1C,MAAM,IAAI,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;IAClC,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC5B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,eAAe,CAAC,EAAU;IACxC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QAAE,MAAM,IAAI,SAAS,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;AAC7E,CAAC;AAFD,0CAEC"}

package/lib/global-overrides.d.ts

@@ -0,0 +1 @@
+export declare function overrideGlobals(): void;

package/lib/global-overrides.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.overrideGlobals = void 0;
+/**
+ * Overrides some global objects to make them deterministic.
+ *
+ * @module
+ */
+const time_1 = require("@temporalio/common/lib/time");
+const cancellation_scope_1 = require("./cancellation-scope");
+const errors_1 = require("./errors");
+const global_attributes_1 = require("./global-attributes");
+const flags_1 = require("./flags");
+const workflow_1 = require("./workflow");
+const stack_helpers_1 = require("./stack-helpers");
+const global = globalThis;
+const OriginalDate = globalThis.Date;
+function overrideGlobals() {
+    // Mock any weak reference because GC is non-deterministic and the effect is observable from the Workflow.
+    // Workflow developer will get a meaningful exception if they try to use these.
+    global.WeakRef = function () {
+        throw new errors_1.DeterminismViolationError('WeakRef cannot be used in Workflows because v8 GC is non-deterministic');
+    };
+    global.FinalizationRegistry = function () {
+        throw new errors_1.DeterminismViolationError('FinalizationRegistry cannot be used in Workflows because v8 GC is non-deterministic');
+    };
+    global.Date = function (...args) {
+        if (args.length > 0) {
+            return new OriginalDate(...args);
+        }
+        return new OriginalDate((0, global_attributes_1.getActivator)().now);
+    };
+    global.Date.now = function () {
+        return (0, global_attributes_1.getActivator)().now;
+    };
+    global.Date.parse = OriginalDate.parse.bind(OriginalDate);
+    global.Date.UTC = OriginalDate.UTC.bind(OriginalDate);
+    global.Date.prototype = OriginalDate.prototype;
+    const timeoutCancelationScopes = new Map();
+    /**
+     * @param ms sleep duration -  number of milliseconds. If given a negative number, value will be set to 1.
+     */
+    global.setTimeout = function (cb, ms, ...args) {
+        ms = Math.max(1, ms);
+        const activator = (0, global_attributes_1.getActivator)();
+        if (activator.hasFlag(flags_1.SdkFlags.NonCancellableScopesAreShieldedFromPropagation)) {
+            // Capture the sequence number that sleep will allocate
+            const seq = activator.nextSeqs.timer;
+            const timerScope = new cancellation_scope_1.CancellationScope({ cancellable: true });
+            const sleepPromise = timerScope.run(() => (0, workflow_1.sleep)(ms));
+            sleepPromise.then(() => {
+                timeoutCancelationScopes.delete(seq);
+                cb(...args);
+            }, () => {
+                timeoutCancelationScopes.delete(seq);
+            });
+            (0, stack_helpers_1.untrackPromise)(sleepPromise);
+            timeoutCancelationScopes.set(seq, timerScope);
+            return seq;
+        }
+        else {
+            const seq = activator.nextSeqs.timer++;
+            // Create a Promise for AsyncLocalStorage to be able to track this completion using promise hooks.
+            new Promise((resolve, reject) => {
+                activator.completions.timer.set(seq, { resolve, reject });
+                activator.pushCommand({
+                    startTimer: {
+                        seq,
+                        startToFireTimeout: (0, time_1.msToTs)(ms),
+                    },
+                });
+            }).then(() => cb(...args), () => undefined /* ignore cancellation */);
+            return seq;
+        }
+    };
+    global.clearTimeout = function (handle) {
+        const activator = (0, global_attributes_1.getActivator)();
+        const timerScope = timeoutCancelationScopes.get(handle);
+        if (timerScope) {
+            timeoutCancelationScopes.delete(handle);
+            timerScope.cancel();
+        }
+        else {
+            activator.nextSeqs.timer++; // Shouldn't increase seq number, but that's the legacy behavior
+            activator.completions.timer.delete(handle);
+            activator.pushCommand({
+                cancelTimer: {
+                    seq: handle,
+                },
+            });
+        }
+    };
+    // activator.random is mutable, don't hardcode its reference
+    Math.random = () => (0, global_attributes_1.getActivator)().random();
+}
+exports.overrideGlobals = overrideGlobals;
+//# sourceMappingURL=global-overrides.js.map

package/lib/global-overrides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-overrides.js","sourceRoot":"","sources":["../src/global-overrides.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,sDAAqD;AACrD,6DAAyD;AACzD,qCAAqD;AACrD,2DAAmD;AACnD,mCAAmC;AACnC,yCAAmC;AACnC,mDAAiD;AAEjD,MAAM,MAAM,GAAG,UAAiB,CAAC;AACjC,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC;AAErC,SAAgB,eAAe;IAC7B,0GAA0G;IAC1G,+EAA+E;IAC/E,MAAM,CAAC,OAAO,GAAG;QACf,MAAM,IAAI,kCAAyB,CAAC,wEAAwE,CAAC,CAAC;IAChH,CAAC,CAAC;IACF,MAAM,CAAC,oBAAoB,GAAG;QAC5B,MAAM,IAAI,kCAAyB,CACjC,qFAAqF,CACtF,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,CAAC,IAAI,GAAG,UAAU,GAAG,IAAe;QACxC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,OAAO,IAAK,YAAoB,CAAC,GAAG,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,YAAY,CAAC,IAAA,gCAAY,GAAE,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC,CAAC;IAEF,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG;QAChB,OAAO,IAAA,gCAAY,GAAE,CAAC,GAAG,CAAC;IAC5B,CAAC,CAAC;IAEF,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1D,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAEtD,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;IAE/C,MAAM,wBAAwB,GAAG,IAAI,GAAG,EAA6B,CAAC;IAEtE;;OAEG;IACH,MAAM,CAAC,UAAU,GAAG,UAAU,EAA2B,EAAE,EAAU,EAAE,GAAG,IAAW;QACnF,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,IAAA,gCAAY,GAAE,CAAC;QACjC,IAAI,SAAS,CAAC,OAAO,CAAC,gBAAQ,CAAC,8CAA8C,CAAC,EAAE,CAAC;YAC/E,uDAAuD;YACvD,MAAM,GAAG,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;YACrC,MAAM,UAAU,GAAG,IAAI,sCAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;YAChE,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAA,gBAAK,EAAC,EAAE,CAAC,CAAC,CAAC;YACrD,YAAY,CAAC,IAAI,CACf,GAAG,EAAE;gBACH,wBAAwB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACrC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;YACd,CAAC,EACD,GAAG,EAAE;gBACH,wBAAwB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvC,CAAC,CACF,CAAC;YACF,IAAA,8BAAc,EAAC,YAAY,CAAC,CAAC;YAC7B,wBAAwB,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;YAC9C,OAAO,GAAG,CAAC;QACb,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACvC,kGAAkG;YAClG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC9B,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;gBAC1D,SAAS,CAAC,WAAW,CAAC;oBACpB,UAAU,EAAE;wBACV,GAAG;wBACH,kBAAkB,EAAE,IAAA,aAAM,EAAC,EAAE,CAAC;qBAC/B;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC,IAAI,CACL,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EACjB,GAAG,EAAE,CAAC,SAAS,CAAC,yBAAyB,CAC1C,CAAC;YACF,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,CAAC,YAAY,GAAG,UAAU,MAAc;QAC5C,MAAM,SAAS,GAAG,IAAA,gCAAY,GAAE,CAAC;QACjC,MAAM,UAAU,GAAG,wBAAwB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,UAAU,EAAE,CAAC;YACf,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACxC,UAAU,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,gEAAgE;YAC5F,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC3C,SAAS,CAAC,WAAW,CAAC;gBACpB,WAAW,EAAE;oBACX,GAAG,EAAE,MAAM;iBACZ;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEF,4DAA4D;IAC5D,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,IAAA,gCAAY,GAAE,CAAC,MAAM,EAAE,CAAC;AAC9C,CAAC;AA3FD,0CA2FC"}

package/lib/interfaces.d.ts

@@ -397,3 +397,7 @@ export type UpdateHandlerOptions<Args extends any[]> = {
     validator?: UpdateValidator<Args>;
     description?: string;
 };
+export interface ActivationCompletion {
+    commands: coresdk.workflow_commands.IWorkflowCommand[];
+    usedInternalFlags: number[];
+}

package/lib/internals.d.ts

@@ -4,8 +4,9 @@ import type { coresdk } from '@temporalio/proto';
 import { RNG } from './alea';
 import { RootCancellationScope } from './cancellation-scope';
 import { QueryInput, SignalInput, UpdateInput, WorkflowExecuteInput, WorkflowInterceptors } from './interceptors';
-import { DefaultSignalHandler, FileLocation, WorkflowInfo, WorkflowCreateOptionsInternal } from './interfaces';
+import { DefaultSignalHandler, FileLocation, WorkflowInfo, WorkflowCreateOptionsInternal, ActivationCompletion } from './interfaces';
 import { type SinkCall } from './sinks';
+import { SdkFlag } from './flags';
 export interface Stack {
     formatted: string;
     structured: FileLocation[];
@@ -158,11 +159,12 @@ export declare class Activator implements ActivationHandler {
     /**
      * Patches we know the status of for this workflow, as in {@link patched}
      */
-    readonly knownPresentPatches: Set<string>;
+    private readonly knownPresentPatches;
     /**
      * Patches we sent to core {@link patched}
      */
-    readonly sentPatches: Set<string>;
+    private readonly sentPatches;
+    private readonly knownFlags;
     /**
      * Buffered sink calls per activation
      */
@@ -182,7 +184,7 @@ export declare class Activator implements ActivationHandler {
      * Prevents commands from being added after Workflow completion.
      */
     pushCommand(cmd: coresdk.workflow_commands.IWorkflowCommand, complete?: boolean): void;
-    getAndResetCommands(): coresdk.workflow_commands.IWorkflowCommand[];
+    concludeActivation(): ActivationCompletion;
     startWorkflowNextHandler({ args }: WorkflowExecuteInput): Promise<any>;
     startWorkflow(activation: coresdk.workflow_activation.IStartWorkflow): void;
     cancelWorkflow(_activation: coresdk.workflow_activation.ICancelWorkflow): void;
@@ -204,6 +206,9 @@ export declare class Activator implements ActivationHandler {
     resolveRequestCancelExternalWorkflow(activation: coresdk.workflow_activation.IResolveRequestCancelExternalWorkflow): void;
     updateRandomSeed(activation: coresdk.workflow_activation.IUpdateRandomSeed): void;
     notifyHasPatch(activation: coresdk.workflow_activation.INotifyHasPatch): void;
+    patchInternal(patchId: string, deprecated: boolean): boolean;
+    addKnownFlags(flags: number[]): void;
+    hasFlag(flag: SdkFlag): boolean;
     removeFromCache(): void;
     /**
      * Transforms failures into a command to be sent to the server.

package/lib/internals.js

@@ -14,6 +14,7 @@ const interfaces_1 = require("./interfaces");
 const stack_helpers_1 = require("./stack-helpers");
 const pkg_1 = __importDefault(require("./pkg"));
 const logs_1 = require("./logs");
+const flags_1 = require("./flags");
 var StartChildWorkflowExecutionFailedCause;
 (function (StartChildWorkflowExecutionFailedCause) {
     StartChildWorkflowExecutionFailedCause[StartChildWorkflowExecutionFailedCause["START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED"] = 0] = "START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED";
@@ -201,6 +202,7 @@ class Activator {
          * Patches we sent to core {@link patched}
          */
         this.sentPatches = new Set();
+        this.knownFlags = new Set();
         /**
          * Buffered sink calls per activation
          */
@@ -262,10 +264,11 @@ class Activator {
             this.completed = true;
         }
     }
-    getAndResetCommands() {
-        const commands = this.commands;
-        this.commands = [];
-        return commands;
+    concludeActivation() {
+        return {
+            commands: this.commands.splice(0),
+            usedInternalFlags: [...this.knownFlags],
+        };
     }
     async startWorkflowNextHandler({ args }) {
         const { workflow } = this;
@@ -598,6 +601,38 @@ class Activator {
         }
         this.knownPresentPatches.add(activation.patchId);
     }
+    patchInternal(patchId, deprecated) {
+        if (this.workflow === undefined) {
+            throw new common_1.IllegalStateError('Patches cannot be used before Workflow starts');
+        }
+        const usePatch = !this.info.unsafe.isReplaying || this.knownPresentPatches.has(patchId);
+        // Avoid sending commands for patches core already knows about.
+        // This optimization enables development of automatic patching tools.
+        if (usePatch && !this.sentPatches.has(patchId)) {
+            this.pushCommand({
+                setPatchMarker: { patchId, deprecated },
+            });
+            this.sentPatches.add(patchId);
+        }
+        return usePatch;
+    }
+    // Called early while handling an activation to register known flags
+    addKnownFlags(flags) {
+        for (const flag of flags) {
+            (0, flags_1.assertValidFlag)(flag);
+            this.knownFlags.add(flag);
+        }
+    }
+    hasFlag(flag) {
+        if (this.knownFlags.has(flag.id)) {
+            return true;
+        }
+        if (!this.info.unsafe.isReplaying && flag.default) {
+            this.knownFlags.add(flag.id);
+            return true;
+        }
+        return false;
+    }
     removeFromCache() {
         throw new common_1.IllegalStateError('removeFromCache activation job should not reach workflow');
     }