@hatchet-dev/typescript-sdk 1.24.0 → 1.24.2

package/README.md

@@ -32,7 +32,7 @@ pnpm add @hatchet-dev/typescript-sdk
 
 ## Quick Start
 
-For examples of how to use the Hatchet TypeScript SDK, including worker setup and task execution, please see our [official documentation](https://docs.hatchet.run/home/setup).
+For examples of how to use the Hatchet TypeScript SDK, including worker setup and task execution, please see our [official documentation](https://docs.hatchet.run/v1).
 
 ## Features
 

package/clients/listeners/durable-listener/durable-listener-client.d.ts

@@ -37,6 +37,8 @@ export interface DurableTaskEventLogEntryResult {
     durableTaskExternalId: string;
     nodeId: number;
     payload: Record<string, unknown> | undefined;
+    isFailure: boolean;
+    errorMessage: string | undefined;
 }
 export interface WaitForEvent {
     kind: 'waitFor';

package/clients/listeners/durable-listener/durable-listener-client.js

@@ -95,13 +95,15 @@ const WORKER_STATUS_POLL_INTERVAL_MS = 1000;
 function eventLogEntryResultFromProto(proto) {
     var _a, _b, _c, _d;
     let payload;
-    if (proto.payload && proto.payload.length > 0) {
+    if (!proto.isFailure && proto.payload && proto.payload.length > 0) {
         payload = JSON.parse(new TextDecoder().decode(proto.payload));
     }
     return {
         durableTaskExternalId: (_b = (_a = proto.ref) === null || _a === void 0 ? void 0 : _a.durableTaskExternalId) !== null && _b !== void 0 ? _b : '',
         nodeId: (_d = (_c = proto.ref) === null || _c === void 0 ? void 0 : _c.nodeId) !== null && _d !== void 0 ? _d : 0,
         payload,
+        isFailure: proto.isFailure,
+        errorMessage: proto.errorMessage,
     };
 }
 function ackKey(taskExtId, invocationCount) {
@@ -185,7 +187,9 @@ class DurableListenerClient {
     }
     _connect() {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             this.logger.info('durable event listener connecting...');
+            (_a = this._receiveAbort) === null || _a === void 0 ? void 0 : _a.abort();
             this._requestQueue = [];
             this._receiveAbort = new AbortController();
             this._enqueueRequest({
@@ -246,12 +250,15 @@ class DurableListenerClient {
     }
     _requestIterator() {
         return __asyncGenerator(this, arguments, function* _requestIterator_1() {
-            while (this._running) {
-                while (this._requestQueue.length > 0) {
-                    yield yield __await(this._requestQueue.shift());
+            const queue = this._requestQueue;
+            const { signal } = this._receiveAbort;
+            while (this._running && !signal.aborted) {
+                while (queue.length > 0) {
+                    yield yield __await(queue.shift());
                 }
                 yield __await(new Promise((resolve) => {
                     this._requestNotify = resolve;
+                    signal.addEventListener('abort', () => resolve(), { once: true });
                 }));
                 this._requestNotify = undefined;
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.24.0",
+  "version": "1.24.2",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -15,8 +15,22 @@
     "type": "git",
     "url": "https://github.com/hatchet-dev/hatchet.git"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": [
+    "typescript",
+    "hatchet",
+    "workflow",
+    "orchestration",
+    "background-tasks",
+    "job-queue",
+    "task-scheduling"
+  ],
+  "author": "Hatchet <contact@hatchet.run>",
+  "contributors": [
+    "Alexander Belanger <alexander@hatchet.run>",
+    "Matt Kaye <matt@hatchet.run>",
+    "Gabe Ruttner <gabe@hatchet.run>",
+    "Mohammed Nafees <nafees@hatchet.run>"
+  ],
   "license": "MIT",
   "devDependencies": {
     "@aws-sdk/client-s3": "^3.1042.0",

package/protoc/dispatcher/dispatcher.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: dispatcher/dispatcher.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/protoc/events/events.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: events/events.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/protoc/google/protobuf/timestamp.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: google/protobuf/timestamp.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/protoc/v1/dispatcher.d.ts

@@ -43,6 +43,8 @@ export interface DurableTaskEventWaitForAckResponse {
 export interface DurableTaskEventLogEntryCompletedResponse {
     ref: DurableEventLogEntryRef | undefined;
     payload: Uint8Array;
+    isFailure: boolean;
+    errorMessage?: string | undefined;
 }
 export interface DurableTaskEvictInvocationRequest {
     invocationCount: number;

package/protoc/v1/dispatcher.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: v1/dispatcher.proto
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -619,7 +619,7 @@ exports.DurableTaskEventWaitForAckResponse = {
     },
 };
 function createBaseDurableTaskEventLogEntryCompletedResponse() {
-    return { ref: undefined, payload: new Uint8Array(0) };
+    return { ref: undefined, payload: new Uint8Array(0), isFailure: false, errorMessage: undefined };
 }
 exports.DurableTaskEventLogEntryCompletedResponse = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -629,6 +629,12 @@ exports.DurableTaskEventLogEntryCompletedResponse = {
         if (message.payload.length !== 0) {
             writer.uint32(18).bytes(message.payload);
         }
+        if (message.isFailure !== false) {
+            writer.uint32(24).bool(message.isFailure);
+        }
+        if (message.errorMessage !== undefined) {
+            writer.uint32(34).string(message.errorMessage);
+        }
         return writer;
     },
     decode(input, length) {
@@ -652,6 +658,20 @@ exports.DurableTaskEventLogEntryCompletedResponse = {
                     message.payload = reader.bytes();
                     continue;
                 }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.isFailure = reader.bool();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.errorMessage = reader.string();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -664,6 +684,16 @@ exports.DurableTaskEventLogEntryCompletedResponse = {
         return {
             ref: isSet(object.ref) ? exports.DurableEventLogEntryRef.fromJSON(object.ref) : undefined,
             payload: isSet(object.payload) ? bytesFromBase64(object.payload) : new Uint8Array(0),
+            isFailure: isSet(object.isFailure)
+                ? globalThis.Boolean(object.isFailure)
+                : isSet(object.is_failure)
+                    ? globalThis.Boolean(object.is_failure)
+                    : false,
+            errorMessage: isSet(object.errorMessage)
+                ? globalThis.String(object.errorMessage)
+                : isSet(object.error_message)
+                    ? globalThis.String(object.error_message)
+                    : undefined,
         };
     },
     toJSON(message) {
@@ -674,19 +704,27 @@ exports.DurableTaskEventLogEntryCompletedResponse = {
         if (message.payload.length !== 0) {
             obj.payload = base64FromBytes(message.payload);
         }
+        if (message.isFailure !== false) {
+            obj.isFailure = message.isFailure;
+        }
+        if (message.errorMessage !== undefined) {
+            obj.errorMessage = message.errorMessage;
+        }
         return obj;
     },
     create(base) {
         return exports.DurableTaskEventLogEntryCompletedResponse.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a;
+        var _a, _b, _c;
         const message = createBaseDurableTaskEventLogEntryCompletedResponse();
         message.ref =
             object.ref !== undefined && object.ref !== null
                 ? exports.DurableEventLogEntryRef.fromPartial(object.ref)
                 : undefined;
         message.payload = (_a = object.payload) !== null && _a !== void 0 ? _a : new Uint8Array(0);
+        message.isFailure = (_b = object.isFailure) !== null && _b !== void 0 ? _b : false;
+        message.errorMessage = (_c = object.errorMessage) !== null && _c !== void 0 ? _c : undefined;
         return message;
     },
 };

package/protoc/v1/shared/condition.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: v1/shared/condition.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/protoc/v1/shared/trigger.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: v1/shared/trigger.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/protoc/v1/workflows.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: v1/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/protoc/workflows/workflows.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: workflows/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/v1/client/worker/context.js

@@ -894,6 +894,9 @@ class DurableContext extends Context {
             });
             const results = yield Promise.all(ack.runEntries.map((entry) => this.withEvictionWait('runChild', `workflow:bulk-child`, () => __awaiter(this, void 0, void 0, function* () {
                 const result = yield this._durableListener.waitForCallback(this.action.taskRunExternalId, this.invocationCount, entry.branchId, entry.nodeId, { signal: this.abortController.signal });
+                if (result.isFailure) {
+                    throw new hatchet_error_1.default(result.errorMessage || 'child task failed');
+                }
                 return (result.payload || {});
             }))));
             return results;

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

@@ -82,6 +82,17 @@ export declare const memoNowCaching: import("../..").TaskWorkflowDeclaration<imp
     start_time: string;
 }, {}, {}, {}, {}>;
 export declare const dagChildWorkflow: import("../..").WorkflowDeclaration<import("../..").UnknownInputType, {}, {}>;
+export declare const errorRaisingTask: import("../..").TaskWorkflowDeclaration<{
+    error_message: string;
+}, never, {}, {}, {}, {}>;
+export declare const errorRaisingDurableParent: import("../..").TaskWorkflowDeclaration<{
+    error_message: string;
+}, {
+    child_raised: boolean;
+    child_error_str: string | null;
+    child_run_external_id: string;
+    parent_run_external_id: string;
+}, {}, {}, {}, {}>;
 export declare const durableSpawnDag: import("../..").TaskWorkflowDeclaration<import("../..").JsonObject, {
     sleep_duration: number;
     sleep_duration_ms: number;

package/v1/examples/durable/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.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;
+exports.durableSpawnDag = exports.errorRaisingDurableParent = exports.errorRaisingTask = 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 v4_1 = require("zod/v4");
 const conditions_1 = require("../../conditions");
 const non_determinism_error_1 = require("../../../util/errors/non-determinism-error");
@@ -301,6 +301,35 @@ exports.dagChildWorkflow.task({
         return { result: 'child2' };
     }),
 });
+// --- Error propagation test ---
+exports.errorRaisingTask = hatchet_client_1.hatchet.task({
+    name: 'error-raising-task',
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        throw new Error(input.error_message);
+    }),
+});
+exports.errorRaisingDurableParent = hatchet_client_1.hatchet.durableTask({
+    name: 'error-raising-durable-parent',
+    executionTimeout: '30s',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        let childRaised = false;
+        let childErrorStr = null;
+        const ref = yield exports.errorRaisingTask.runNoWait(input);
+        try {
+            yield ref.output;
+        }
+        catch (e) {
+            childRaised = true;
+            childErrorStr = e instanceof Error ? e.message : String(e);
+        }
+        return {
+            child_raised: childRaised,
+            child_error_str: childErrorStr,
+            child_run_external_id: yield ref.runId,
+            parent_run_external_id: ctx.workflowRunId(),
+        };
+    }),
+});
 exports.durableSpawnDag = hatchet_client_1.hatchet.durableTask({
     name: 'durable-spawn-dag',
     executionTimeout: '10s',

package/v1/examples/e2e-worker.js

@@ -70,6 +70,8 @@ const workflows = [
     workflow_8.waitForEventLookback,
     workflow_8.waitForOrEventLookback,
     workflow_8.waitForTwoEventsSecondPushedFirst,
+    workflow_8.errorRaisingTask,
+    workflow_8.errorRaisingDurableParent,
     workflow_9.durableEvent,
     workflow_9.durableEventWithFilter,
     workflow_11.durableSleep,

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.24.0";
+export declare const HATCHET_VERSION = "1.24.2";

package/version.js

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