@hatchet-dev/typescript-sdk 1.30.0 → 1.31.0

package/v1/examples/durable_callback_ordering/workflow.js

@@ -0,0 +1,95 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callbackOrderingRoot = exports.callbackOrderingMid = exports.callbackOrderingLeaf = exports.ROOT_DEFAULTS = void 0;
+const sleep_1 = __importDefault(require("../../../util/sleep"));
+const hatchet_client_1 = require("../hatchet-client");
+const WORKFLOW_PREFIX = 'durable-callback-ordering';
+const EVICTION_POLICY = {
+    ttl: 250,
+    allowCapacityEviction: true,
+    priority: 0,
+};
+exports.ROOT_DEFAULTS = {
+    durables: 4,
+    branches: 8,
+    childDelayMs: 1500,
+    delayStepMs: 3,
+};
+exports.callbackOrderingLeaf = hatchet_client_1.hatchet.task({
+    name: `${WORKFLOW_PREFIX}-leaf`,
+    executionTimeout: '1m',
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, sleep_1.default)(input.delayMs);
+        return { mid: input.mid, branch: input.branch, generation: input.generation };
+    }),
+});
+exports.callbackOrderingMid = hatchet_client_1.hatchet.durableTask({
+    name: `${WORKFLOW_PREFIX}-mid`,
+    executionTimeout: '5m',
+    retries: 0,
+    evictionPolicy: EVICTION_POLICY,
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        // Staggered first-generation children complete out of spawn order, so each
+        // branch's second-generation spawn is emitted in completion order. Replays
+        // after eviction must re-deliver those completions in the recorded order or
+        // the re-emitted spawn sequence diverges from the event log.
+        const branch = (branchIndex) => __awaiter(void 0, void 0, void 0, function* () {
+            const firstDelayMs = input.childDelayMs + (input.branches - branchIndex - 1) * input.delayStepMs;
+            const first = yield exports.callbackOrderingLeaf.run({
+                mid: input.mid,
+                branch: branchIndex,
+                delayMs: firstDelayMs,
+                generation: 1,
+            });
+            const second = yield exports.callbackOrderingLeaf.run({
+                mid: input.mid,
+                branch: first.branch,
+                delayMs: input.childDelayMs,
+                generation: 2,
+            });
+            return second.branch;
+        });
+        const completed = yield Promise.all(Array.from({ length: input.branches }, (_, branchIndex) => branch(branchIndex)));
+        return {
+            mid: input.mid,
+            completedBranches: completed,
+            invocationCount: ctx.invocationCount,
+        };
+    }),
+});
+exports.callbackOrderingRoot = hatchet_client_1.hatchet.durableTask({
+    name: `${WORKFLOW_PREFIX}-root`,
+    executionTimeout: '10m',
+    retries: 0,
+    evictionPolicy: EVICTION_POLICY,
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        const durables = (_a = input.durables) !== null && _a !== void 0 ? _a : exports.ROOT_DEFAULTS.durables;
+        const results = yield Promise.all(Array.from({ length: durables }, (_, midIndex) => {
+            var _a, _b, _c;
+            return exports.callbackOrderingMid.run({
+                mid: midIndex,
+                branches: (_a = input.branches) !== null && _a !== void 0 ? _a : exports.ROOT_DEFAULTS.branches,
+                childDelayMs: (_b = input.childDelayMs) !== null && _b !== void 0 ? _b : exports.ROOT_DEFAULTS.childDelayMs,
+                delayStepMs: (_c = input.delayStepMs) !== null && _c !== void 0 ? _c : exports.ROOT_DEFAULTS.delayStepMs,
+            });
+        }));
+        return {
+            rootInvocationCount: ctx.invocationCount,
+            midInvocationCounts: results.map((item) => item.invocationCount),
+            completedMids: results.map((item) => item.mid),
+        };
+    }),
+});

package/v1/examples/durable_eviction/workflow.d.ts

@@ -13,6 +13,11 @@ export declare const evictableSleepForGracefulTermination: import("../..").TaskW
 export declare const evictableWaitForEvent: import("../..").TaskWorkflowDeclaration<import("../..").JsonObject, {
     status: string;
 }, {}, {}, {}, {}>;
+export declare const MEMO_EVENT_KEY = "durable-eviction:memo-event";
+export declare const evictableMemoThenWaitForEvent: import("../..").TaskWorkflowDeclaration<import("../..").JsonObject, {
+    status: string;
+    memoizedNow: string;
+}, {}, {}, {}, {}>;
 export declare const evictableChildSpawn: import("../..").TaskWorkflowDeclaration<import("../..").JsonObject, {
     child: {
         child_status: string;

package/v1/examples/durable_eviction/workflow.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nonEvictableSleep = exports.capacityEvictableSleep = exports.CAPACITY_SLEEP_SECONDS = exports.evictableChildBulkSpawn = exports.bulkChildTask = exports.multipleEviction = exports.evictableChildSpawn = exports.evictableWaitForEvent = exports.evictableSleepForGracefulTermination = exports.evictableSleep = exports.childTask = exports.EVENT_KEY = exports.LONG_SLEEP_SECONDS = exports.EVICTION_TTL_SECONDS = void 0;
+exports.nonEvictableSleep = exports.capacityEvictableSleep = exports.CAPACITY_SLEEP_SECONDS = exports.evictableChildBulkSpawn = exports.bulkChildTask = exports.multipleEviction = exports.evictableChildSpawn = exports.evictableMemoThenWaitForEvent = exports.MEMO_EVENT_KEY = exports.evictableWaitForEvent = exports.evictableSleepForGracefulTermination = exports.evictableSleep = exports.childTask = exports.EVENT_KEY = exports.LONG_SLEEP_SECONDS = exports.EVICTION_TTL_SECONDS = void 0;
 const sleep_1 = __importDefault(require("../../../util/sleep"));
 const hatchet_client_1 = require("../hatchet-client");
 exports.EVICTION_TTL_SECONDS = 5;
@@ -66,6 +66,20 @@ exports.evictableWaitForEvent = hatchet_client_1.hatchet.durableTask({
         return { status: 'completed' };
     }),
 });
+exports.MEMO_EVENT_KEY = 'durable-eviction:memo-event';
+exports.evictableMemoThenWaitForEvent = hatchet_client_1.hatchet.durableTask({
+    name: 'evictable-memo-then-wait-for-event',
+    executionTimeout: '5m',
+    evictionPolicy: EVICTION_POLICY,
+    fn: (_input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        // now() records a memo node. On replay after eviction, the server
+        // re-delivers that node's completion, which never has a callback waiter
+        // and must not block the event completion queued behind it.
+        const memoizedNow = yield ctx.now();
+        yield ctx.waitForEvent(exports.MEMO_EVENT_KEY, 'true');
+        return { status: 'completed', memoizedNow: memoizedNow.toISOString() };
+    }),
+});
 exports.evictableChildSpawn = hatchet_client_1.hatchet.durableTask({
     name: 'evictable-child-spawn',
     executionTimeout: '5m',

package/v1/examples/e2e-worker.js

@@ -25,29 +25,31 @@ const workflow_4 = require("./concurrency_cancel_newest/workflow");
 const workflow_5 = require("./concurrency_cancel_queued_except_newest/workflow");
 const workflow_6 = require("./concurrency_cancel_queued_except_oldest/workflow");
 const workflow_7 = require("./concurrency_multiple_keys/workflow");
-const workflow_8 = require("./concurrency_workflow_level/workflow");
-const workflow_9 = require("./dag/workflow");
-const workflow_10 = require("./durable/workflow");
-const workflow_11 = require("./durable_event/workflow");
-const workflow_12 = require("./durable_eviction/workflow");
-const workflow_13 = require("./durable_sleep/workflow");
-const workflow_14 = require("./logger/workflow");
-const workflow_15 = require("./non_retryable/workflow");
-const workflow_16 = require("./on_failure/workflow");
-const workflow_17 = require("./idempotency/workflow");
-const workflow_18 = require("./on_event/workflow");
-const workflow_19 = require("./return_exceptions/workflow");
-const workflow_20 = require("./run_details/workflow");
+const workflow_8 = require("./concurrency_shared/workflow");
+const workflow_9 = require("./concurrency_workflow_level/workflow");
+const workflow_10 = require("./dag/workflow");
+const workflow_11 = require("./durable/workflow");
+const workflow_12 = require("./durable_event/workflow");
+const workflow_13 = require("./durable_eviction/workflow");
+const workflow_14 = require("./durable_callback_ordering/workflow");
+const workflow_15 = require("./durable_sleep/workflow");
+const workflow_16 = require("./logger/workflow");
+const workflow_17 = require("./non_retryable/workflow");
+const workflow_18 = require("./on_failure/workflow");
+const workflow_19 = require("./idempotency/workflow");
+const workflow_20 = require("./on_event/workflow");
+const workflow_21 = require("./return_exceptions/workflow");
+const workflow_22 = require("./run_details/workflow");
 const e2e_workflows_1 = require("./simple/e2e-workflows");
-const workflow_21 = require("./batch_assign/workflow");
-const workflow_22 = require("./streaming/workflow");
-const workflow_23 = require("./subscribe_to_stream/workflow");
-const workflow_24 = require("./timeout/workflow");
-const workflow_25 = require("./webhooks/workflow");
-const workflow_26 = require("./child_index/workflow");
-const workflow_27 = require("./support_agent/workflow");
-const workflow_28 = require("./welcome_email/workflow");
-const workflow_29 = require("./pdf_pipeline/workflow");
+const workflow_23 = require("./batch_assign/workflow");
+const workflow_24 = require("./streaming/workflow");
+const workflow_25 = require("./subscribe_to_stream/workflow");
+const workflow_26 = require("./timeout/workflow");
+const workflow_27 = require("./webhooks/workflow");
+const workflow_28 = require("./child_index/workflow");
+const workflow_29 = require("./support_agent/workflow");
+const workflow_30 = require("./welcome_email/workflow");
+const workflow_31 = require("./pdf_pipeline/workflow");
 const workflows = [
     workflow_1.bulkChild,
     workflow_1.bulkParentWorkflow,
@@ -61,74 +63,81 @@ const workflows = [
     workflow_5.concurrencyCancelQueuedExceptNewestWorkflow,
     workflow_6.concurrencyCancelQueuedExceptOldestWorkflow,
     workflow_7.concurrencyMultipleKeysWorkflow,
-    workflow_8.concurrencyWorkflowLevelWorkflow,
-    workflow_9.dag,
-    workflow_10.durableWorkflow,
-    workflow_10.waitForSleepTwice,
-    workflow_10.spawnChildTask,
-    workflow_10.durableWithSpawn,
-    workflow_10.durableWithBulkSpawn,
-    workflow_10.durableSleepEventSpawn,
-    workflow_10.durableWithExplicitSpawn,
-    workflow_10.durableNonDeterminism,
-    workflow_10.durableReplayReset,
-    workflow_10.dagChildWorkflow,
-    workflow_10.durableSpawnDag,
-    workflow_10.waitForEventLookback,
-    workflow_10.waitForOrEventLookback,
-    workflow_10.waitForTwoEventsSecondPushedFirst,
-    workflow_10.errorRaisingTask,
-    workflow_10.errorRaisingDurableParent,
-    workflow_11.durableEvent,
-    workflow_11.durableEventWithFilter,
-    workflow_13.durableSleep,
-    workflow_12.evictableSleep,
-    workflow_12.evictableWaitForEvent,
-    workflow_12.evictableChildSpawn,
-    workflow_12.multipleEviction,
-    workflow_12.nonEvictableSleep,
-    workflow_12.childTask,
-    workflow_12.bulkChildTask,
-    workflow_12.evictableChildBulkSpawn,
-    (0, workflow_14.createLoggingWorkflow)(hatchet_client_1.hatchet),
-    workflow_15.nonRetryableWorkflow,
-    workflow_16.failureWorkflow,
-    workflow_17.idempotentTask,
-    workflow_17.idempotentTaskShortWindow,
-    workflow_18.lower,
-    workflow_19.returnExceptionsTask,
-    workflow_20.runDetailTestWorkflow,
+    workflow_8.concurrencySharedWorkflowA,
+    workflow_8.concurrencySharedWorkflowB,
+    workflow_8.concurrencySharedMixedWorkflow,
+    workflow_9.concurrencyWorkflowLevelWorkflow,
+    workflow_10.dag,
+    workflow_11.durableWorkflow,
+    workflow_11.waitForSleepTwice,
+    workflow_11.spawnChildTask,
+    workflow_11.durableWithSpawn,
+    workflow_11.durableWithBulkSpawn,
+    workflow_11.durableSleepEventSpawn,
+    workflow_11.durableWithExplicitSpawn,
+    workflow_11.durableNonDeterminism,
+    workflow_11.durableReplayReset,
+    workflow_11.dagChildWorkflow,
+    workflow_11.durableSpawnDag,
+    workflow_11.waitForEventLookback,
+    workflow_11.waitForOrEventLookback,
+    workflow_11.waitForTwoEventsSecondPushedFirst,
+    workflow_11.errorRaisingTask,
+    workflow_11.errorRaisingDurableParent,
+    workflow_12.durableEvent,
+    workflow_12.durableEventWithFilter,
+    workflow_14.callbackOrderingLeaf,
+    workflow_14.callbackOrderingMid,
+    workflow_14.callbackOrderingRoot,
+    workflow_15.durableSleep,
+    workflow_13.evictableSleep,
+    workflow_13.evictableWaitForEvent,
+    workflow_13.evictableMemoThenWaitForEvent,
+    workflow_13.evictableChildSpawn,
+    workflow_13.multipleEviction,
+    workflow_13.nonEvictableSleep,
+    workflow_13.childTask,
+    workflow_13.bulkChildTask,
+    workflow_13.evictableChildBulkSpawn,
+    (0, workflow_16.createLoggingWorkflow)(hatchet_client_1.hatchet),
+    workflow_17.nonRetryableWorkflow,
+    workflow_18.failureWorkflow,
+    workflow_19.idempotentTask,
+    workflow_19.idempotentTaskShortWindow,
+    workflow_20.lower,
+    workflow_21.returnExceptionsTask,
+    workflow_22.runDetailTestWorkflow,
     e2e_workflows_1.helloWorld,
     e2e_workflows_1.helloWorldDurable,
-    workflow_22.streamingTask,
-    workflow_23.dagStream,
-    workflow_23.longStream,
-    workflow_24.timeoutTask,
-    workflow_24.refreshTimeoutTask,
-    workflow_25.webhookWorkflow,
-    workflow_26.childIndexChild,
-    workflow_26.childIndexParent,
-    workflow_26.scenarioTask,
-    workflow_26.orchestratorTask,
-    workflow_27.supportAgent,
-    workflow_27.triageTicket,
-    workflow_27.generateReply,
-    workflow_27.escalateTicket,
-    workflow_28.welcomeEmail,
-    workflow_29.pdfPipeline,
-    workflow_21.batchSimple,
-    workflow_21.batchKeyed,
-    workflow_21.batchKeyedFailable,
-    workflow_21.batchKeyedInterval,
-    workflow_21.batchLarge,
-    workflow_21.batchSingle,
-    workflow_21.batchOrdered,
-    workflow_21.batchBroadcast,
-    workflow_21.batchCancel,
-    workflow_21.child,
-    workflow_21.childBatch,
-    workflow_21.batchChildSpawn,
-    workflow_21.batchChildBatchSpawn,
+    workflow_24.streamingTask,
+    workflow_25.dagStream,
+    workflow_25.longStream,
+    workflow_26.timeoutTask,
+    workflow_26.refreshTimeoutTask,
+    workflow_27.webhookWorkflow,
+    workflow_28.childIndexChild,
+    workflow_28.childIndexParent,
+    workflow_28.scenarioTask,
+    workflow_28.orchestratorTask,
+    workflow_29.supportAgent,
+    workflow_29.triageTicket,
+    workflow_29.generateReply,
+    workflow_29.escalateTicket,
+    workflow_30.welcomeEmail,
+    workflow_31.pdfPipeline,
+    workflow_23.batchSimple,
+    workflow_23.batchKeyed,
+    workflow_23.batchKeyedFailable,
+    workflow_23.batchKeyedInterval,
+    workflow_23.batchLarge,
+    workflow_23.batchSingle,
+    workflow_23.batchOrdered,
+    workflow_23.batchBroadcast,
+    workflow_23.batchCancel,
+    workflow_23.child,
+    workflow_23.childBatch,
+    workflow_23.batchChildSpawn,
+    workflow_23.batchChildBatchSpawn,
 ];
 function main() {
     return __awaiter(this, void 0, void 0, function* () {

package/v1/task.d.ts

@@ -11,7 +11,7 @@ export { ConcurrencyLimitStrategy, WorkerLabelComparator };
  */
 export type Concurrency = {
     /**
-     * required the CEL expression to use for concurrency
+     * required: the CEL expression to use for concurrency
      *
      * @example
      * ```
@@ -20,17 +20,38 @@ export type Concurrency = {
      */
     expression: string;
     /**
-     * (optional) the maximum number of concurrent workflow runs
+     * (optional) the maximum number of concurrent runs: a fixed number, or a CEL
+     * expression over task input computing the max runs for that task's concurrency
+     * group. With an expression, a group's effective limit is the value from its most
+     * recently created task.
      *
      * default: 1
+     *
+     * @example
+     * ```
+     * maxRuns: 5
+     * maxRuns: "input.tier == 'premium' ? 10 : 1"
+     * ```
      */
-    maxRuns?: number;
+    maxRuns?: number | string;
     /**
      * (optional) the strategy to use when the concurrency limit is reached
      *
      * default: CANCEL_IN_PROGRESS
      */
     limitStrategy?: ConcurrencyLimitStrategy;
+    /**
+     * (required when isTenantScoped) the strategy name; unique per tenant for tenant-scoped
+     * strategies
+     */
+    name?: string;
+    /**
+     * (optional) when true, the entry defines (or updates in place) a tenant-scoped strategy
+     * shared across workflows, keyed by name: every task declaring the same name consumes
+     * the same concurrency limit. The position in the concurrency list is the chain order,
+     * and chains sharing tenant-scoped strategies must order them consistently.
+     */
+    isTenantScoped?: boolean;
 };
 /**
  * @deprecated use Concurrency instead

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.30.0";
+export declare const HATCHET_VERSION = "1.31.0";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HATCHET_VERSION = void 0;
-exports.HATCHET_VERSION = '1.30.0';
+exports.HATCHET_VERSION = '1.31.0';