@hatchet-dev/typescript-sdk 1.19.2-alpha.2 → 1.20.0

package/v1/client/worker/context.js

@@ -30,7 +30,6 @@ const transformer_1 = require("../../conditions/transformer");
 const condition_1 = require("../../../protoc/v1/shared/condition");
 const apply_namespace_1 = require("../../../util/apply-namespace");
 const abort_error_1 = require("../../../util/abort-error");
-const parent_run_context_vars_1 = require("../../parent-run-context-vars");
 const crypto_1 = require("crypto");
 const duration_1 = require("../duration");
 const engine_version_1 = require("./engine-version");
@@ -75,19 +74,10 @@ class ContextWorker {
 }
 exports.ContextWorker = ContextWorker;
 class Context {
-    nextChildIndex(n = 1) {
-        var _a;
-        const ctx = parent_run_context_vars_1.parentRunContextManager.getContext();
-        const idx = (_a = ctx === null || ctx === void 0 ? void 0 : ctx.childIndex) !== null && _a !== void 0 ? _a : this.spawnIndex;
-        parent_run_context_vars_1.parentRunContextManager.incrementChildIndex(n);
-        this.spawnIndex = idx + n;
-        return idx;
-    }
     constructor(action, v1, worker) {
         // @deprecated use ctx.abortController instead
         this.controller = new AbortController();
         this.overridesData = {};
-        /** @deprecated — kept for backward compat; prefer {@link nextChildIndex}. */
         this.spawnIndex = 0;
         this.streamIndex = 0;
         try {
@@ -389,8 +379,8 @@ class Context {
             throw new hatchet_error_1.default(`Cannot run with sticky: workflow ${workflowName} is not registered on the worker`);
         }
         const { workflowRunId, taskRunExternalId } = this.action;
-        const childIndex = this.nextChildIndex();
-        const finalOpts = Object.assign(Object.assign({}, opts), { parentId: workflowRunId, parentTaskRunExternalId: taskRunExternalId, childIndex, childKey: options === null || options === void 0 ? void 0 : options.key, desiredWorkerId: sticky ? this.worker.id() : undefined, _standaloneTaskName: workflow instanceof declaration_1.TaskWorkflowDeclaration ? workflow._standalone_task_name : undefined });
+        const finalOpts = Object.assign(Object.assign({}, opts), { parentId: workflowRunId, parentTaskRunExternalId: taskRunExternalId, childIndex: this.spawnIndex, childKey: options === null || options === void 0 ? void 0 : options.key, desiredWorkerId: sticky ? this.worker.id() : undefined, _standaloneTaskName: workflow instanceof declaration_1.TaskWorkflowDeclaration ? workflow._standalone_task_name : undefined });
+        this.spawnIndex += 1;
         return { workflowName, opts: finalOpts };
     }
     spawn(workflow, input, options) {
@@ -571,12 +561,12 @@ class Context {
                 // `signal` must never be sent over the wire.
                 const optsWithoutSignal = Object.assign({}, opts);
                 delete optsWithoutSignal.signal;
-                const childIndex = this.nextChildIndex();
                 const resp = {
                     workflowName: name,
                     input,
-                    options: Object.assign(Object.assign({}, optsWithoutSignal), { parentId: workflowRunId, parentTaskRunExternalId: taskRunExternalId, childIndex, desiredWorkerId: sticky ? this.worker.id() : undefined }),
+                    options: Object.assign(Object.assign({}, optsWithoutSignal), { parentId: workflowRunId, parentTaskRunExternalId: taskRunExternalId, childIndex: this.spawnIndex, desiredWorkerId: sticky ? this.worker.id() : undefined }),
                 };
+                this.spawnIndex += 1;
                 return resp;
             });
             try {
@@ -624,8 +614,8 @@ class Context {
                 throw new hatchet_error_1.default(`cannot run with sticky: workflow ${name} is not registered on the worker`);
             }
             try {
-                const childIndex = this.nextChildIndex();
-                const resp = yield this.v1.admin.runWorkflow(name, input, Object.assign({ parentId: workflowRunId, parentTaskRunExternalId: taskRunExternalId, childIndex, desiredWorkerId: sticky ? this.worker.id() : undefined }, opts));
+                const resp = yield this.v1.admin.runWorkflow(name, input, Object.assign({ parentId: workflowRunId, parentTaskRunExternalId: taskRunExternalId, childIndex: this.spawnIndex, desiredWorkerId: sticky ? this.worker.id() : undefined }, opts));
+                this.spawnIndex += 1;
                 if (workflow instanceof declaration_1.TaskWorkflowDeclaration) {
                     resp._standaloneTaskName = workflow._standalone_task_name;
                 }
@@ -743,9 +733,18 @@ class DurableContext extends Context {
             }));
         });
     }
-    waitForEvent(key, expression, payloadSchema) {
+    waitForEvent(key, expression, payloadSchema, scope, lookbackWindow) {
         return __awaiter(this, void 0, void 0, function* () {
-            const res = yield this.waitFor({ eventKey: key, expression });
+            const now = yield this.now();
+            const considerEventsSince = lookbackWindow
+                ? new Date(now.getTime() - (0, duration_1.durationToMs)(lookbackWindow)).toISOString()
+                : undefined;
+            const res = yield this.waitFor({
+                eventKey: key,
+                expression,
+                scope,
+                considerEventsSince,
+            });
             // The engine returns an object like:
             // {"CREATE": {"signal_key_1": [{"id": ..., "data": {...}}]}}
             // Since we have a single match, the list will only have one item.
@@ -806,13 +805,12 @@ class DurableContext extends Context {
             workflowName = workflow.name;
         }
         workflowName = (0, apply_namespace_1.applyNamespace)(workflowName, this.v1.config.namespace).toLowerCase();
-        const childIndex = this.nextChildIndex();
         const triggerOpts = {
             name: workflowName,
             input: JSON.stringify(input || {}),
             parentId: this.action.workflowRunId,
             parentTaskRunExternalId: this.action.taskRunExternalId,
-            childIndex,
+            childIndex: this.spawnIndex,
             childKey: options === null || options === void 0 ? void 0 : options.key,
             additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
                 ? JSON.stringify(options.additionalMetadata)
@@ -821,6 +819,7 @@ class DurableContext extends Context {
             priority: options === null || options === void 0 ? void 0 : options.priority,
             desiredWorkerLabels: {},
         };
+        this.spawnIndex += 1;
         return { workflowName, triggerOpts };
     }
     /**

package/v1/conditions/index.js

@@ -50,7 +50,7 @@ function Render(action, conditions) {
         if ('eventKey' in conditionOrObj) {
             return [
                 ...acc,
-                new user_event_condition_1.UserEventCondition(conditionOrObj.eventKey, conditionOrObj.expression || '', undefined, action),
+                new user_event_condition_1.UserEventCondition(conditionOrObj.eventKey, conditionOrObj.expression || '', undefined, action, conditionOrObj.scope, conditionOrObj.considerEventsSince),
             ];
         }
         if ('parent' in conditionOrObj) {

package/v1/conditions/transformer.js

@@ -29,6 +29,10 @@ function conditionsToPb(conditions, namespace) {
             userEventConditions.push({
                 base: Object.assign(Object.assign({}, baseToPb(condition.base)), { expression: condition.expression || '' }),
                 userEventKey: (0, apply_namespace_1.applyNamespace)(condition.eventKey, namespace),
+                eventScope: condition.scope,
+                considerEventsSince: condition.considerEventsSince
+                    ? new Date(condition.considerEventsSince)
+                    : undefined,
             });
         }
         else if (condition instanceof parent_condition_1.ParentCondition) {

package/v1/conditions/user-event-condition.d.ts

@@ -20,6 +20,14 @@ export interface UserEvent {
      * If not specified, the eventKey will be used as the default identifier.
      */
     readableDataKey?: string;
+    /**
+     An optional scope to filter events. If provided, only events with a matching scope will be considered when looking for matches. This is required if `lookback_window` is provided (if you wish to consider events that were pushed before the wait was established as valid).
+    */
+    scope?: string;
+    /**
+    An optional ISO-formatted date string indicating how far back to look for matching events when the condition is first evaluated.
+     */
+    considerEventsSince?: string;
 }
 /**
  * Represents a condition that is triggered based on a specific user event.
@@ -46,5 +54,7 @@ export interface UserEvent {
 export declare class UserEventCondition extends Condition {
     eventKey: string;
     expression: string;
-    constructor(eventKey: string, expression: string, readableDataKey?: string, action?: Action);
+    scope?: string;
+    considerEventsSince?: string;
+    constructor(eventKey: string, expression: string, readableDataKey?: string, action?: Action, scope?: string, considerEventsSince?: string);
 }

package/v1/conditions/user-event-condition.js

@@ -25,7 +25,7 @@ const base_1 = require("./base");
  * );
  */
 class UserEventCondition extends base_1.Condition {
-    constructor(eventKey, expression, readableDataKey, action) {
+    constructor(eventKey, expression, readableDataKey, action, scope, considerEventsSince) {
         super({
             readableDataKey: readableDataKey || eventKey,
             action,
@@ -34,6 +34,8 @@ class UserEventCondition extends base_1.Condition {
         });
         this.eventKey = eventKey;
         this.expression = expression;
+        this.scope = scope;
+        this.considerEventsSince = considerEventsSince;
     }
 }
 exports.UserEventCondition = UserEventCondition;

package/v1/declaration.js

@@ -63,7 +63,9 @@ class BaseWorkflowDeclaration {
             if (!this.client) {
                 throw UNBOUND_ERR;
             }
+            // set the parent run context
             const parentRunContext = parent_run_context_vars_1.parentRunContextManager.getContext();
+            parent_run_context_vars_1.parentRunContextManager.incrementChildIndex(Array.isArray(input) ? input.length : 1);
             if (!parentRunContext && ((options === null || options === void 0 ? void 0 : options.childKey) || (options === null || options === void 0 ? void 0 : options.sticky))) {
                 this.client.admin.logger.warn('ignoring childKey or sticky because run is not being spawned from a parent task');
             }
@@ -77,21 +79,20 @@ class BaseWorkflowDeclaration {
                     : undefined,
                 warn: (message) => this.client.admin.logger.warn(message),
             });
-            // Snapshot childIndex before incrementing — shared with Context.spawnIndex
-            // via parentRunContextManager so both spawning APIs produce unique indices.
-            const baseChildIndex = parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.childIndex;
-            const inputCount = Array.isArray(input) ? input.length : 1;
-            parent_run_context_vars_1.parentRunContextManager.incrementChildIndex(inputCount);
-            const runOpts = Object.assign(Object.assign({}, (options !== null && options !== void 0 ? options : {})), { parentId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentId, parentTaskRunExternalId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentTaskRunExternalId, childIndex: baseChildIndex, sticky: (options === null || options === void 0 ? void 0 : options.sticky) ? parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.desiredWorkerId : undefined, childKey: options === null || options === void 0 ? void 0 : options.childKey });
+            parent_run_context_vars_1.parentRunContextManager.incrementChildIndex(Array.isArray(input) ? input.length : 1);
+            const runOpts = Object.assign(Object.assign({}, (options !== null && options !== void 0 ? options : {})), { parentId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentId, parentTaskRunExternalId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentTaskRunExternalId, childIndex: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.childIndex, sticky: (options === null || options === void 0 ? void 0 : options.sticky) ? parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.desiredWorkerId : undefined, childKey: options === null || options === void 0 ? void 0 : options.childKey });
             if (Array.isArray(input)) {
                 let resp = [];
                 for (let i = 0; i < input.length; i += 500) {
                     const batch = input.slice(i, i + 500);
-                    const batchResp = yield this.client.admin.runWorkflows(batch.map((inp, batchIdx) => ({
-                        workflowName: this.definition.name,
-                        input: inp,
-                        options: Object.assign(Object.assign({}, runOpts), { childIndex: (baseChildIndex !== null && baseChildIndex !== void 0 ? baseChildIndex : 0) + i + batchIdx }),
-                    })));
+                    const batchResp = yield this.client.admin.runWorkflows(batch.map((inp) => {
+                        var _a;
+                        return ({
+                            workflowName: this.definition.name,
+                            input: inp,
+                            options: Object.assign(Object.assign({}, runOpts), { childIndex: ((_a = runOpts.childIndex) !== null && _a !== void 0 ? _a : 0) + i }),
+                        });
+                    }));
                     resp = resp.concat(batchResp);
                 }
                 const res = [];

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

@@ -52,6 +52,25 @@ export declare const durableReplayReset: import("../..").TaskWorkflowDeclaration
     sleep_2_duration: number;
     sleep_3_duration: number;
 }, {}, {}, {}, {}>;
+export declare const LOOKBACK_WINDOW: "1m";
+export declare const waitForEventLookback: import("../..").TaskWorkflowDeclaration<{
+    scope: string;
+}, {
+    elapsed: number;
+    event: any;
+}, {}, {}, {}, {}>;
+export declare const waitForOrEventLookback: import("../..").TaskWorkflowDeclaration<{
+    scope: string;
+}, {
+    elapsed: number;
+}, {}, {}, {}, {}>;
+export declare const waitForTwoEventsSecondPushedFirst: import("../..").TaskWorkflowDeclaration<{
+    scope: string;
+}, {
+    elapsed: number;
+    event1: any;
+    event2: any;
+}, {}, {}, {}, {}>;
 export declare const memoNowCaching: import("../..").TaskWorkflowDeclaration<import("../..").JsonObject, {
     start_time: string;
 }, {}, {}, {}, {}>;

package/v1/examples/durable/workflow.js

@@ -12,10 +12,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.durableSpawnDag = exports.dagChildWorkflow = exports.memoNowCaching = exports.durableReplayReset = exports.REPLAY_RESET_MEMOIZED_MAX_SECONDS = exports.REPLAY_RESET_SLEEP_SECONDS = exports.durableNonDeterminism = exports.durableWithExplicitSpawn = exports.durableSleepEventSpawn = exports.durableWithBulkSpawn = exports.durableWithSpawn = exports.spawnChildTask = exports.waitForSleepTwice = exports.durableWorkflow = exports.SLEEP_TIME = exports.SLEEP_TIME_SECONDS = exports.EVENT_KEY = void 0;
+exports.durableSpawnDag = exports.dagChildWorkflow = exports.memoNowCaching = exports.waitForTwoEventsSecondPushedFirst = exports.waitForOrEventLookback = exports.waitForEventLookback = exports.LOOKBACK_WINDOW = exports.durableReplayReset = exports.REPLAY_RESET_MEMOIZED_MAX_SECONDS = exports.REPLAY_RESET_SLEEP_SECONDS = exports.durableNonDeterminism = exports.durableWithExplicitSpawn = exports.durableSleepEventSpawn = exports.durableWithBulkSpawn = exports.durableWithSpawn = exports.spawnChildTask = exports.waitForSleepTwice = exports.durableWorkflow = exports.SLEEP_TIME = exports.SLEEP_TIME_SECONDS = exports.EVENT_KEY = void 0;
 const conditions_1 = require("../../conditions");
 const non_determinism_error_1 = require("../../../util/errors/non-determinism-error");
 const sleep_1 = __importDefault(require("../../../util/sleep"));
+const duration_1 = require("../../client/duration");
 const hatchet_client_1 = require("../hatchet-client");
 exports.EVENT_KEY = 'durable-example:event';
 exports.SLEEP_TIME_SECONDS = 2;
@@ -223,6 +224,46 @@ exports.durableReplayReset = hatchet_client_1.hatchet.durableTask({
         };
     }),
 });
+exports.LOOKBACK_WINDOW = '1m';
+exports.waitForEventLookback = hatchet_client_1.hatchet.durableTask({
+    name: 'wait-for-event-lookback',
+    executionTimeout: '10m',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const start = Date.now();
+        const event = yield ctx.waitForEvent(exports.EVENT_KEY, undefined, undefined, input.scope, exports.LOOKBACK_WINDOW);
+        return {
+            elapsed: (Date.now() - start) / 1000,
+            event,
+        };
+    }),
+});
+exports.waitForOrEventLookback = hatchet_client_1.hatchet.durableTask({
+    name: 'wait-for-or-event-lookback',
+    executionTimeout: '10m',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const start = Date.now();
+        const now = yield ctx.now();
+        const considerEventsSince = new Date(now.getTime() - (0, duration_1.durationToMs)(exports.LOOKBACK_WINDOW)).toISOString();
+        yield ctx.waitFor((0, conditions_1.Or)(new conditions_1.SleepCondition(exports.SLEEP_TIME), new conditions_1.UserEventCondition(exports.EVENT_KEY, '', undefined, undefined, input.scope, considerEventsSince)));
+        return {
+            elapsed: (Date.now() - start) / 1000,
+        };
+    }),
+});
+exports.waitForTwoEventsSecondPushedFirst = hatchet_client_1.hatchet.durableTask({
+    name: 'wait-for-two-events-second-pushed-first',
+    executionTimeout: '10m',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const start = Date.now();
+        const event1 = yield ctx.waitForEvent('key1', undefined, undefined, input.scope, exports.LOOKBACK_WINDOW);
+        const event2 = yield ctx.waitForEvent('key2', undefined, undefined, input.scope, exports.LOOKBACK_WINDOW);
+        return {
+            elapsed: (Date.now() - start) / 1000,
+            event1,
+            event2,
+        };
+    }),
+});
 exports.memoNowCaching = hatchet_client_1.hatchet.durableTask({
     name: 'memo-now-caching',
     executionTimeout: '10m',

package/v1/examples/e2e-worker.js

@@ -63,6 +63,9 @@ const workflows = [
     workflow_8.durableReplayReset,
     workflow_8.dagChildWorkflow,
     workflow_8.durableSpawnDag,
+    workflow_8.waitForEventLookback,
+    workflow_8.waitForOrEventLookback,
+    workflow_8.waitForTwoEventsSecondPushedFirst,
     workflow_9.durableEvent,
     workflow_9.durableEventWithFilter,
     workflow_11.durableSleep,

package/v1/parent-run-context-vars.d.ts

@@ -1,4 +1,4 @@
-import type { DurableContext } from './client/worker/context';
+import { DurableContext } from './client/worker/context';
 export interface ParentRunContext {
     parentId: string;
     /**

package/v1/parent-run-context-vars.js

@@ -26,7 +26,8 @@ class ParentRunContextManager {
         var _a;
         const parentRunContext = this.getContext();
         if (parentRunContext) {
-            this.setContext(Object.assign(Object.assign({}, parentRunContext), { childIndex: ((_a = parentRunContext.childIndex) !== null && _a !== void 0 ? _a : 0) + n }));
+            parentRunContext.childIndex = ((_a = parentRunContext.childIndex) !== null && _a !== void 0 ? _a : 0) + n;
+            this.setContext(parentRunContext);
         }
     }
     getContext() {

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.19.2-alpha.2";
+export declare const HATCHET_VERSION = "1.20.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.19.2-alpha.2';
+exports.HATCHET_VERSION = '1.20.0';