@hatchet-dev/typescript-sdk 1.7.1 → 1.8.1

package/package.json

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

package/util/workflow-run-ref.js

@@ -94,8 +94,10 @@ class WorkflowRunRef {
                             _f = false;
                             const event = _c;
                             if (event.eventType === dispatcher_1.WorkflowRunEventType.WORKFLOW_RUN_EVENT_TYPE_FINISHED) {
-                                if (event.results.some((r) => !!r.error)) {
-                                    reject(event.results);
+                                if (event.results.some((r) => r.error !== undefined)) {
+                                    // HACK: this might replace intentional empty errors but this is the more common case
+                                    const errors = event.results.map((r) => r.error !== '' ? r.error : 'task was cancelled');
+                                    reject(errors);
                                     return;
                                 }
                                 if (event.results.length === 0) {

package/v1/client/worker/worker-internal.js

@@ -31,6 +31,7 @@ const transformer_1 = require("../../conditions/transformer");
 const step_1 = require("../../../step");
 const apply_namespace_1 = require("../../../util/apply-namespace");
 const context_1 = require("./context");
+const parent_run_context_vars_1 = require("../../parent-run-context-vars");
 class V1Worker {
     constructor(client, options) {
         this.workflow_registry = [];
@@ -253,7 +254,12 @@ class V1Worker {
             catch (e) {
                 throw new hatchet_error_1.default(`Could not register workflow: ${e.message}`);
             }
-            this.registerActionsV1(workflow);
+            if (!durable) {
+                this.registerActionsV1(workflow);
+            }
+            else {
+                this.registerDurableActionsV1(workflow);
+            }
         });
     }
     registerWorkflow(initWorkflow) {
@@ -356,6 +362,12 @@ class V1Worker {
                     return;
                 }
                 const run = () => __awaiter(this, void 0, void 0, function* () {
+                    parent_run_context_vars_1.parentRunContextManager.setContext({
+                        parentId: action.workflowRunId,
+                        parentRunId: action.stepRunId,
+                        childIndex: 0,
+                        desiredWorkerId: this.workerId || '',
+                    });
                     return step(context);
                 });
                 const success = (result) => __awaiter(this, void 0, void 0, function* () {

package/v1/client/worker/worker.js

@@ -60,7 +60,6 @@ class Worker {
                             this.durable = new worker_internal_1.V1Worker(this._v1, opts);
                             yield this.durable.registerWorkflowV1(wf, true);
                         }
-                        this.durable.registerDurableActionsV1(wf.definition);
                     }
                 }
                 else {

package/v1/declaration.d.ts

@@ -30,6 +30,16 @@ export type RunOpts = {
      * values: Priority.LOW, Priority.MEDIUM, Priority.HIGH (1, 2, or 3 )
      */
     priority?: Priority;
+    /**
+     * (optional) if the task run should be run on the same worker.
+     * only used if spawned from within a parent task.
+     */
+    sticky?: boolean;
+    /**
+     * (optional) the child key for the workflow run.
+     * only used if spawned from within a parent task.
+     */
+    childKey?: string;
 };
 /**
  * Helper type to safely extract output types from task results

package/v1/declaration.js

@@ -13,6 +13,7 @@ exports.TaskWorkflowDeclaration = exports.WorkflowDeclaration = exports.BaseWork
 exports.CreateTaskWorkflow = CreateTaskWorkflow;
 exports.CreateWorkflow = CreateWorkflow;
 exports.CreateDurableTaskWorkflow = CreateDurableTaskWorkflow;
+const parent_run_context_vars_1 = require("./parent-run-context-vars");
 const UNBOUND_ERR = new Error('workflow unbound to hatchet client, hint: use client.run instead');
 // eslint-disable-next-line no-shadow
 var Priority;
@@ -41,15 +42,25 @@ 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');
+            }
+            const runOpts = Object.assign(Object.assign({}, options), { parentId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentId, parentStepRunId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentRunId, 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) => ({
-                        workflowName: this.definition.name,
-                        input: inp,
-                        options,
-                    })));
+                    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 = [];
@@ -67,7 +78,7 @@ class BaseWorkflowDeclaration {
                 });
                 return res;
             }
-            const res = yield this.client.admin.runWorkflow(this.definition.name, input, options);
+            const res = yield this.client.admin.runWorkflow(this.definition.name, input, runOpts);
             if (_standaloneTaskName) {
                 res._standaloneTaskName = _standaloneTaskName;
             }

package/v1/examples/child_workflows/workflow.js

@@ -27,7 +27,7 @@ exports.parent = hatchet_client_1.hatchet.task({
         const n = input.N;
         const promises = [];
         for (let i = 0; i < n; i++) {
-            promises.push(ctx.runChild(exports.child, { N: i }));
+            promises.push(exports.child.run({ N: i }));
         }
         const childRes = yield Promise.all(promises);
         const sum = childRes.reduce((acc, curr) => acc + curr.Value, 0);

package/v1/examples/simple/run.js

@@ -13,10 +13,11 @@ exports.extra = extra;
 /* eslint-disable no-console */
 const hatchet_client_1 = require("../hatchet-client");
 const workflow_1 = require("./workflow");
+const workflow_with_child_1 = require("./workflow-with-child");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         // > Running a Task
-        const res = yield workflow_1.simple.run({
+        const res = yield workflow_with_child_1.parent.run({
             Message: 'HeLlO WoRlD',
         }, {
             additionalMetadata: {
@@ -42,11 +43,11 @@ function extra() {
         console.log(results[1].TransformedMessage);
         // !!
         // > Spawning Tasks from within a Task
-        const parent = hatchet_client_1.hatchet.task({
+        const parentTask = hatchet_client_1.hatchet.task({
             name: 'parent',
             fn: (input, ctx) => __awaiter(this, void 0, void 0, function* () {
-                // Simply call ctx.runChild with the task you want to run
-                const child = yield ctx.runChild(workflow_1.simple, {
+                // Simply the task and it will be spawned from the parent task
+                const child = yield workflow_1.simple.run({
                     Message: 'HeLlO WoRlD',
                 });
                 return {
@@ -58,5 +59,9 @@ function extra() {
     });
 }
 if (require.main === module) {
-    main();
+    main()
+        .catch(console.error)
+        .finally(() => {
+        process.exit(0);
+    });
 }

package/v1/examples/sticky/workflow.js

@@ -21,7 +21,7 @@ exports.sticky = hatchet_client_1.hatchet.task({
     sticky: workflows_1.StickyStrategy.SOFT,
     fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         // specify a child workflow to run on the same worker
-        const result = yield ctx.runChild(workflow_1.child, {
+        const result = yield workflow_1.child.run({
             N: 1,
         }, { sticky: true });
         return {

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

@@ -0,0 +1,15 @@
+export interface ParentRunContext {
+    parentId: string;
+    parentRunId: string;
+    desiredWorkerId: string;
+    childIndex?: number;
+}
+export declare class ParentRunContextManager {
+    private storage;
+    constructor();
+    setContext(opts: ParentRunContext): void;
+    setParentRunIdAndIncrementChildIndex(opts: ParentRunContext): void;
+    incrementChildIndex(n: number): void;
+    getContext(): ParentRunContext | undefined;
+}
+export declare const parentRunContextManager: ParentRunContextManager;

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parentRunContextManager = exports.ParentRunContextManager = void 0;
+const async_hooks_1 = require("async_hooks");
+class ParentRunContextManager {
+    constructor() {
+        this.storage = new async_hooks_1.AsyncLocalStorage();
+    }
+    setContext(opts) {
+        this.storage.enterWith(Object.assign({}, opts));
+    }
+    setParentRunIdAndIncrementChildIndex(opts) {
+        var _a;
+        const parentRunContext = this.getContext();
+        if (parentRunContext) {
+            parentRunContext.parentId = opts.parentId;
+            parentRunContext.childIndex = ((_a = parentRunContext.childIndex) !== null && _a !== void 0 ? _a : 0) + 1;
+            this.setContext(parentRunContext);
+        }
+    }
+    incrementChildIndex(n) {
+        var _a;
+        const parentRunContext = this.getContext();
+        if (parentRunContext) {
+            parentRunContext.childIndex = ((_a = parentRunContext.childIndex) !== null && _a !== void 0 ? _a : 0) + n;
+            this.setContext(parentRunContext);
+        }
+    }
+    getContext() {
+        return this.storage.getStore();
+    }
+}
+exports.ParentRunContextManager = ParentRunContextManager;
+// Export a default instance for backward compatibility and convenience
+exports.parentRunContextManager = new ParentRunContextManager();

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.7.1";
+export declare const HATCHET_VERSION = "1.8.1";

package/version.js

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