@hatchet-dev/typescript-sdk 1.29.1 → 1.29.3

package/clients/dispatcher/heartbeat/heartbeat-severity.d.ts

@@ -1,3 +1,3 @@
 import { FailureSeverity } from '../../../util/failure-severity';
 export declare const MAX_MISSED_HEARTBEATS = 3;
-export declare function classifyHeartbeatFailure(code: number | undefined, missedHeartbeats: number): FailureSeverity;
+export declare function classifyHeartbeatFailure(e: unknown, missedHeartbeats: number): FailureSeverity;

package/clients/dispatcher/heartbeat/heartbeat-severity.js

@@ -6,6 +6,8 @@ const grpc_error_1 = require("../../../util/grpc-error");
 const failure_severity_1 = require("../../../util/failure-severity");
 exports.MAX_MISSED_HEARTBEATS = 3;
 // determines whether to immediately error log or wait for additional errors
-function classifyHeartbeatFailure(code, missedHeartbeats) {
-    return (0, failure_severity_1.classifyRepeatedFailure)((0, grpc_error_1.isConnectionError)(code), missedHeartbeats, exports.MAX_MISSED_HEARTBEATS);
+function classifyHeartbeatFailure(e, missedHeartbeats) {
+    const code = (0, grpc_error_1.getGrpcErrorCode)(e);
+    const isTransient = (0, grpc_error_1.isConnectionError)(code) || (0, grpc_error_1.isTimeoutOrAbortError)(e);
+    return (0, failure_severity_1.classifyRepeatedFailure)(isTransient, missedHeartbeats, exports.MAX_MISSED_HEARTBEATS);
 }

package/clients/dispatcher/heartbeat/heartbeat-worker.js

@@ -20,6 +20,10 @@ const dispatcher_client_1 = require("../dispatcher-client");
 const heartbeat_controller_1 = require("./heartbeat-controller");
 const heartbeat_severity_1 = require("./heartbeat-severity");
 const HEARTBEAT_INTERVAL = 4000;
+// Fail fast on a stalled connection: without a deadline, a heartbeat RPC on a dead
+// TCP connection can hang for 50+ seconds, well past the engine's 30s reassignment
+// window, while setInterval stacks overlapping in-flight requests behind it.
+const HEARTBEAT_TIMEOUT = 5000;
 const postMessage = (message) => {
     worker_threads_1.parentPort === null || worker_threads_1.parentPort === void 0 ? void 0 : worker_threads_1.parentPort.postMessage(message);
 };
@@ -54,7 +58,7 @@ class HeartbeatWorker {
                     yield this.client.heartbeat({
                         workerId: this.workerId,
                         heartbeatAt: new Date(),
-                    });
+                    }, { signal: AbortSignal.timeout(HEARTBEAT_TIMEOUT) });
                     const now = new Date().getTime();
                     const actualInterval = now - this.timeLastHeartbeat;
                     if (actualInterval > HEARTBEAT_INTERVAL * 1.2) {
@@ -88,7 +92,7 @@ class HeartbeatWorker {
                     this.missedHeartbeats += 1;
                     const message = `Failed to send heartbeat: ${(0, hatchet_error_1.getErrorMessage)(e)}`;
                     this.logger.debug(message);
-                    const severity = (0, heartbeat_severity_1.classifyHeartbeatFailure)((0, grpc_error_1.getGrpcErrorCode)(e), this.missedHeartbeats);
+                    const severity = (0, heartbeat_severity_1.classifyHeartbeatFailure)(e, this.missedHeartbeats);
                     if (severity !== 'silent') {
                         postMessage({
                             type: severity,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.29.1",
+  "version": "1.29.3",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [

package/util/config-loader/config-loader.js

@@ -59,7 +59,7 @@ class ConfigLoader {
             port: parseInt(this.env('HATCHET_CLIENT_WORKER_HEALTHCHECK_PORT') || '8001', 10),
         };
         if (!token) {
-            throw new Error('No token provided. Provide it by setting the HATCHET_CLIENT_TOKEN environment variable.');
+            throw new Error('API token is required. Set it via the HATCHET_CLIENT_TOKEN environment variable. For local development, you can run Hatchet embedded via HatchetEmbeddedClient.init() (imported from @hatchet-dev/typescript-sdk/v1/embedded). More docs here: https://docs.hatchet.run/v1/embedded');
         }
         let grpcBroadcastAddress;
         let apiUrl;

package/util/grpc-error.d.ts

@@ -4,6 +4,13 @@
  */
 export declare const CONNECTION_ERROR_CODES: number[];
 export declare function isConnectionError(code: number | undefined): boolean;
+/**
+ * Returns true if `e` is the DOMException thrown when an AbortSignal (e.g. from
+ * AbortSignal.timeout()) fires. This rejects the underlying call directly rather than
+ * surfacing as a gRPC status code, so it needs to be classified as transient separately
+ * from isConnectionError.
+ */
+export declare function isTimeoutOrAbortError(e: unknown): boolean;
 /**
  * Returns the gRPC status code from an unknown value (e.g. from a catch block).
  * Used for checking Status.CANCELLED, Status.UNAVAILABLE, etc.

package/util/grpc-error.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CONNECTION_ERROR_CODES = void 0;
 exports.isConnectionError = isConnectionError;
+exports.isTimeoutOrAbortError = isTimeoutOrAbortError;
 exports.getGrpcErrorCode = getGrpcErrorCode;
 exports.getGrpcErrorDetails = getGrpcErrorDetails;
 const nice_grpc_1 = require("nice-grpc");
@@ -13,6 +14,15 @@ exports.CONNECTION_ERROR_CODES = [nice_grpc_1.Status.UNAVAILABLE, nice_grpc_1.St
 function isConnectionError(code) {
     return code !== undefined && exports.CONNECTION_ERROR_CODES.includes(code);
 }
+/**
+ * Returns true if `e` is the DOMException thrown when an AbortSignal (e.g. from
+ * AbortSignal.timeout()) fires. This rejects the underlying call directly rather than
+ * surfacing as a gRPC status code, so it needs to be classified as transient separately
+ * from isConnectionError.
+ */
+function isTimeoutOrAbortError(e) {
+    return e instanceof DOMException && (e.name === 'TimeoutError' || e.name === 'AbortError');
+}
 /**
  * Returns the gRPC status code from an unknown value (e.g. from a catch block).
  * Used for checking Status.CANCELLED, Status.UNAVAILABLE, etc.

package/v1/examples/e2e-worker.js

@@ -39,12 +39,13 @@ const workflow_18 = require("./run_details/workflow");
 const e2e_workflows_1 = require("./simple/e2e-workflows");
 const workflow_19 = require("./batch_assign/workflow");
 const workflow_20 = require("./streaming/workflow");
-const workflow_21 = require("./timeout/workflow");
-const workflow_22 = require("./webhooks/workflow");
-const workflow_23 = require("./child_index/workflow");
-const workflow_24 = require("./support_agent/workflow");
-const workflow_25 = require("./welcome_email/workflow");
-const workflow_26 = require("./pdf_pipeline/workflow");
+const workflow_21 = require("./subscribe_to_stream/workflow");
+const workflow_22 = require("./timeout/workflow");
+const workflow_23 = require("./webhooks/workflow");
+const workflow_24 = require("./child_index/workflow");
+const workflow_25 = require("./support_agent/workflow");
+const workflow_26 = require("./welcome_email/workflow");
+const workflow_27 = require("./pdf_pipeline/workflow");
 const workflows = [
     workflow_1.bulkChild,
     workflow_1.bulkParentWorkflow,
@@ -96,19 +97,21 @@ const workflows = [
     e2e_workflows_1.helloWorld,
     e2e_workflows_1.helloWorldDurable,
     workflow_20.streamingTask,
-    workflow_21.timeoutTask,
-    workflow_21.refreshTimeoutTask,
-    workflow_22.webhookWorkflow,
-    workflow_23.childIndexChild,
-    workflow_23.childIndexParent,
-    workflow_23.scenarioTask,
-    workflow_23.orchestratorTask,
-    workflow_24.supportAgent,
-    workflow_24.triageTicket,
-    workflow_24.generateReply,
-    workflow_24.escalateTicket,
-    workflow_25.welcomeEmail,
-    workflow_26.pdfPipeline,
+    workflow_21.dagStream,
+    workflow_21.longStream,
+    workflow_22.timeoutTask,
+    workflow_22.refreshTimeoutTask,
+    workflow_23.webhookWorkflow,
+    workflow_24.childIndexChild,
+    workflow_24.childIndexParent,
+    workflow_24.scenarioTask,
+    workflow_24.orchestratorTask,
+    workflow_25.supportAgent,
+    workflow_25.triageTicket,
+    workflow_25.generateReply,
+    workflow_25.escalateTicket,
+    workflow_26.welcomeEmail,
+    workflow_27.pdfPipeline,
     workflow_19.batchSimple,
     workflow_19.batchKeyed,
     workflow_19.batchKeyedFailable,

package/v1/examples/subscribe_to_stream/worker.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/subscribe_to_stream/worker.js

@@ -0,0 +1,25 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet_client_1.hatchet.worker('subscribe-stream-worker', {
+            workflows: [workflow_1.longStream, workflow_1.dagStream],
+            slots: 8,
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

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

@@ -0,0 +1,5 @@
+export declare const STREAM_CHUNKS: string[];
+export declare const PRE_STREAM_SLEEP_MS = 2000;
+export declare const INTER_CHUNK_MS = 50;
+export declare const longStream: import("../..").TaskWorkflowDeclaration<import("../..").UnknownInputType, void, {}, {}, {}, {}>;
+export declare const dagStream: import("../..").WorkflowDeclaration<import("../..").UnknownInputType, {}, {}>;

package/v1/examples/subscribe_to_stream/workflow.js

@@ -0,0 +1,49 @@
+"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.dagStream = exports.longStream = exports.INTER_CHUNK_MS = exports.PRE_STREAM_SLEEP_MS = exports.STREAM_CHUNKS = void 0;
+const sleep_1 = __importDefault(require("../../../util/sleep"));
+const hatchet_client_1 = require("../hatchet-client");
+exports.STREAM_CHUNKS = Array.from({ length: 20 }, (_, i) => `c${String(i).padStart(2, '0')}|`);
+exports.PRE_STREAM_SLEEP_MS = 2000;
+exports.INTER_CHUNK_MS = 50;
+exports.longStream = hatchet_client_1.hatchet.task({
+    name: 'subscribe-stream-long',
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, sleep_1.default)(exports.PRE_STREAM_SLEEP_MS);
+        for (const chunk of exports.STREAM_CHUNKS) {
+            yield ctx.putStream(chunk);
+            yield (0, sleep_1.default)(exports.INTER_CHUNK_MS);
+        }
+    }),
+});
+// An onFailure handler makes the run a DAG. DAG QUEUED->RUNNING used to be
+// published as workflow-run-finished, which hung up stream subscribers as
+// soon as the run started.
+exports.dagStream = hatchet_client_1.hatchet.workflow({
+    name: 'subscribe-stream-dag',
+});
+exports.dagStream.task({
+    name: 'subscribe-stream-dag',
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, sleep_1.default)(exports.PRE_STREAM_SLEEP_MS);
+        for (const chunk of exports.STREAM_CHUNKS) {
+            yield ctx.putStream(chunk);
+        }
+    }),
+});
+exports.dagStream.onFailure({
+    name: 'subscribe-stream-dag-on-failure',
+    fn: () => __awaiter(void 0, void 0, void 0, function* () { }),
+});

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.29.1";
+export declare const HATCHET_VERSION = "1.29.3";

package/version.js

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