@hatchet-dev/typescript-sdk 0.17.0 → 0.18.0

package/clients/event/event-client.d.ts

@@ -2,6 +2,7 @@ import { Channel, ClientFactory } from 'nice-grpc';
 import { EventsServiceClient } from '../../protoc/events/events';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
+import { retrier } from '../../util/retrier';
 export declare enum LogLevel {
     INFO = "INFO",
     WARN = "WARN",
@@ -18,6 +19,7 @@ export interface EventWithMetadata<T> {
 export declare class EventClient {
     config: ClientConfig;
     client: EventsServiceClient;
+    retrier: typeof retrier;
     logger: Logger;
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory);
     push<T>(type: string, input: T, options?: PushEventOptions): Promise<import("../../protoc/events/events").Event>;

package/clients/event/event-client.js

@@ -30,6 +30,7 @@ class EventClient {
         this.config = config;
         this.client = factory.create(events_1.EventsServiceDefinition, channel);
         this.logger = new logger_1.Logger(`Dispatcher`, config.log_level);
+        this.retrier = retrier_1.retrier;
     }
     push(type, input, options = {}) {
         var _a;
@@ -43,7 +44,7 @@ class EventClient {
                 : undefined,
         };
         try {
-            const e = this.client.push(req);
+            const e = this.retrier(() => __awaiter(this, void 0, void 0, function* () { return this.client.push(req); }), this.logger);
             this.logger.info(`Event pushed: ${namespacedType}`);
             return e;
         }
@@ -74,9 +75,9 @@ class EventClient {
             events,
         };
         try {
-            const e = this.client.bulkPush(req);
+            const res = this.retrier(() => __awaiter(this, void 0, void 0, function* () { return this.client.bulkPush(req); }), this.logger);
             this.logger.info(`Bulk events pushed for type: ${namespacedType}`);
-            return e;
+            return res;
         }
         catch (e) {
             throw new hatchet_error_1.default(e.message);

package/clients/rest/generated/Api.d.ts

@@ -594,7 +594,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @request GET:/api/v1/tenants/{tenant}/workflows
      * @secure
      */
-    workflowList: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<WorkflowList, any>>;
+    workflowList: (tenant: string, query?: {
+        /**
+         * The number to skip
+         * @format int
+         * @default 0
+         */
+        offset?: number;
+        /**
+         * The number to limit by
+         * @format int
+         * @default 50
+         */
+        limit?: number;
+        /** Search by name */
+        name?: string;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<WorkflowList, any>>;
     /**
      * @description Schedule a new workflow run for a tenant
      *
@@ -1223,4 +1238,13 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     workflowRunGetInput: (tenant: string, workflowRun: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<Record<string, any>, any>>;
+    /**
+     * @description Triggers a workflow to check the status of the instance
+     *
+     * @name MonitoringPostRunProbe
+     * @summary Detailed Health Probe For the Instance
+     * @request POST:/api/v1/monitoring/{tenant}/probe
+     * @secure
+     */
+    monitoringPostRunProbe: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
 }

package/clients/rest/generated/Api.js

@@ -551,7 +551,7 @@ class Api extends http_client_1.HttpClient {
          * @request GET:/api/v1/tenants/{tenant}/workflows
          * @secure
          */
-        this.workflowList = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/workflows`, method: 'GET', secure: true, format: 'json' }, params));
+        this.workflowList = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/workflows`, method: 'GET', query: query, secure: true, format: 'json' }, params));
         /**
          * @description Schedule a new workflow run for a tenant
          *
@@ -918,6 +918,15 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.workflowRunGetInput = (tenant, workflowRun, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/workflow-runs/${workflowRun}/input`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Triggers a workflow to check the status of the instance
+         *
+         * @name MonitoringPostRunProbe
+         * @summary Detailed Health Probe For the Instance
+         * @request POST:/api/v1/monitoring/{tenant}/probe
+         * @secure
+         */
+        this.monitoringPostRunProbe = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/monitoring/${tenant}/probe`, method: 'POST', secure: true }, params));
     }
 }
 exports.Api = Api;

package/clients/worker/worker.js

@@ -48,7 +48,7 @@ class Worker {
     registerActions(workflow) {
         var _a;
         const newActions = workflow.steps.reduce((acc, step) => {
-            acc[`${workflow.id}:${step.name}`] = step.run;
+            acc[`${workflow.id}:${step.name.toLowerCase()}`] = step.run;
             return acc;
         }, {});
         const onFailureAction = workflow.onFailure
@@ -59,7 +59,7 @@ class Worker {
         this.action_registry = Object.assign(Object.assign(Object.assign({}, this.action_registry), newActions), onFailureAction);
         this.action_registry =
             ((_a = workflow.concurrency) === null || _a === void 0 ? void 0 : _a.name) && workflow.concurrency.key
-                ? Object.assign(Object.assign({}, this.action_registry), { [`${workflow.id}:${workflow.concurrency.name}`]: workflow.concurrency.key }) : Object.assign({}, this.action_registry);
+                ? Object.assign(Object.assign({}, this.action_registry), { [`${workflow.id}:${workflow.concurrency.name.toLowerCase()}`]: workflow.concurrency.key }) : Object.assign({}, this.action_registry);
     }
     getHandler(workflows) {
         for (const workflow of workflows) {
@@ -165,7 +165,7 @@ class Worker {
         });
     }
     registerAction(actionId, action) {
-        this.action_registry[actionId] = action;
+        this.action_registry[actionId.toLowerCase()] = action;
     }
     handleStartStepRun(action) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -175,6 +175,7 @@ class Worker {
                 this.contexts[action.stepRunId] = context;
                 const step = this.action_registry[actionId];
                 if (!step) {
+                    this.logger.error(`Registered actions: '${Object.keys(this.action_registry).join(', ')}'`);
                     this.logger.error(`Could not find step '${actionId}'`);
                     return;
                 }

package/examples/sticky-trigger.d.ts

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

package/examples/sticky-trigger.js

@@ -0,0 +1,50 @@
+"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 __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = __importDefault(require("../sdk"));
+const hatchet = sdk_1.default.init();
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, e_1, _b, _c;
+        const workflowRunResponse = hatchet.admin.runWorkflow('sticky-workflow', {}, {
+            additionalMetadata: {
+                key: 'value',
+            },
+        });
+        const result = yield workflowRunResponse;
+        try {
+            for (var _d = true, _e = __asyncValues(yield result.stream()), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
+                _c = _f.value;
+                _d = false;
+                const event = _c;
+                console.log('event received', event);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    });
+}
+main();

package/examples/sticky-worker-with-check.d.ts

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

package/examples/sticky-worker-with-check.js

@@ -0,0 +1,109 @@
+"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 });
+const sdk_1 = __importDefault(require("../sdk"));
+const workflow_1 = require("../workflow");
+const hatchet = sdk_1.default.init();
+const workflow = {
+    id: 'sticky-workflow',
+    description: 'test',
+    steps: [
+        {
+            name: 'step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const results = [];
+                const count = 57;
+                hardChildWorkerId = undefined; // we reset this - if we run this multiple times at the same time it will break
+                // eslint-disable-next-line no-plusplus
+                for (let i = 0; i < count; i++) {
+                    const result = yield ctx.spawnWorkflow(childWorkflow, {}, { sticky: true });
+                    results.push(result.result());
+                    const result2 = yield ctx.spawnWorkflow(softChildWorkflow, {}, { sticky: true });
+                    results.push(result2.result());
+                }
+                console.log('Spawned ', count, ' child workflows of each type');
+                console.log('Results:', yield Promise.all(results));
+                return { step1: 'step1 results!' };
+            }),
+        },
+    ],
+};
+let hardChildWorkerId;
+const childWorkflow = {
+    id: 'child-sticky-workflow',
+    description: 'test',
+    sticky: workflow_1.StickyStrategy.HARD,
+    steps: [
+        {
+            name: 'child-step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const workerId = ctx.worker.id();
+                console.log(`1: Worker ID: ${workerId}`);
+                if (!hardChildWorkerId) {
+                    hardChildWorkerId = workerId;
+                }
+                else if (hardChildWorkerId !== workerId) {
+                    throw new Error(`Expected worker ID ${hardChildWorkerId} but got ${workerId}`);
+                }
+                return { childStep1: `${workerId}` };
+            }),
+        },
+        {
+            name: 'child-step2',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const workerId = ctx.worker.id();
+                console.log(`2: Worker ID: ${workerId}`);
+                return { childStep2: `${workerId}` };
+            }),
+        },
+    ],
+};
+const softChildWorkflow = {
+    id: 'child-sticky-workflow-soft',
+    description: 'test',
+    sticky: workflow_1.StickyStrategy.SOFT,
+    steps: [
+        {
+            name: 'child-step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const workerId = ctx.worker.id();
+                console.log(`1: Worker ID: ${workerId}`);
+                return { childStep1: `SOFT ${workerId}` };
+            }),
+        },
+        {
+            name: 'child-step2',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const workerId = ctx.worker.id();
+                console.log(`2: Worker ID: ${workerId}`);
+                return { childStep2: `SOFT ${workerId}` };
+            }),
+        },
+    ],
+};
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker1 = yield hatchet.worker('sticky-worker-1');
+        yield worker1.registerWorkflow(workflow);
+        yield worker1.registerWorkflow(childWorkflow);
+        yield worker1.registerWorkflow(softChildWorkflow);
+        worker1.start();
+        const worker2 = yield hatchet.worker('sticky-worker-2');
+        yield worker2.registerWorkflow(workflow);
+        yield worker2.registerWorkflow(childWorkflow);
+        yield worker2.registerWorkflow(softChildWorkflow);
+        worker2.start();
+    });
+}
+main();

package/index.d.ts

@@ -6,3 +6,4 @@ export * from './clients/rest';
 export * from './clients/admin';
 export * from './util/workflow-run-ref';
 export default Hatchet;
+export { Hatchet };

package/index.js

@@ -14,7 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hatchet = void 0;
 const hatchet_client_1 = require("./clients/hatchet-client");
+Object.defineProperty(exports, "Hatchet", { enumerable: true, get: function () { return hatchet_client_1.HatchetClient; } });
 __exportStar(require("./workflow"), exports);
 __exportStar(require("./step"), exports);
 __exportStar(require("./clients/worker"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -41,6 +41,8 @@
     "worker:simple": "npm run exec -- ./src/examples/simple-worker.ts",
     "worker:affinity": "npm run exec -- ./src/examples/affinity-workers.ts",
     "worker:sticky": "npm run exec -- ./src/examples/sticky-worker.ts",
+    "worker:sticky-with-check": "npm run exec -- ./src/examples/sticky-worker-with-check.ts",
+    "trigger:sticky": "npm run exec -- ./src/examples/sticky-trigger.ts", 
     "worker:on-failure": "npm run exec -- ./src/examples/on-failure.ts",
     "manual:trigger": "npm run exec -- ./src/examples/manual-trigger.ts",
     "manual:meta": "npm run exec -- ./src/examples/stream-by-additional-meta.ts",

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.5.0
+//   protoc-gen-ts_proto  v2.6.0
 //   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.5.0
+//   protoc-gen-ts_proto  v2.6.0
 //   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.5.0
+//   protoc-gen-ts_proto  v2.6.0
 //   protoc               v3.19.1
 // source: google/protobuf/timestamp.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/protoc/workflows/workflows.d.ts

@@ -18,9 +18,12 @@ export declare function workflowKindFromJSON(object: any): WorkflowKind;
 export declare function workflowKindToJSON(object: WorkflowKind): string;
 export declare enum ConcurrencyLimitStrategy {
     CANCEL_IN_PROGRESS = 0,
+    /** DROP_NEWEST - deprecated */
     DROP_NEWEST = 1,
+    /** QUEUE_NEWEST - deprecated */
     QUEUE_NEWEST = 2,
     GROUP_ROUND_ROBIN = 3,
+    CANCEL_NEWEST = 4,
     UNRECOGNIZED = -1
 }
 export declare function concurrencyLimitStrategyFromJSON(object: any): ConcurrencyLimitStrategy;

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.5.0
+//   protoc-gen-ts_proto  v2.6.0
 //   protoc               v3.19.1
 // source: workflows/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -91,9 +91,12 @@ function workflowKindToJSON(object) {
 var ConcurrencyLimitStrategy;
 (function (ConcurrencyLimitStrategy) {
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["CANCEL_IN_PROGRESS"] = 0] = "CANCEL_IN_PROGRESS";
+    /** DROP_NEWEST - deprecated */
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["DROP_NEWEST"] = 1] = "DROP_NEWEST";
+    /** QUEUE_NEWEST - deprecated */
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["QUEUE_NEWEST"] = 2] = "QUEUE_NEWEST";
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["GROUP_ROUND_ROBIN"] = 3] = "GROUP_ROUND_ROBIN";
+    ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["CANCEL_NEWEST"] = 4] = "CANCEL_NEWEST";
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(ConcurrencyLimitStrategy || (exports.ConcurrencyLimitStrategy = ConcurrencyLimitStrategy = {}));
 function concurrencyLimitStrategyFromJSON(object) {
@@ -110,6 +113,9 @@ function concurrencyLimitStrategyFromJSON(object) {
         case 3:
         case 'GROUP_ROUND_ROBIN':
             return ConcurrencyLimitStrategy.GROUP_ROUND_ROBIN;
+        case 4:
+        case 'CANCEL_NEWEST':
+            return ConcurrencyLimitStrategy.CANCEL_NEWEST;
         case -1:
         case 'UNRECOGNIZED':
         default:
@@ -126,6 +132,8 @@ function concurrencyLimitStrategyToJSON(object) {
             return 'QUEUE_NEWEST';
         case ConcurrencyLimitStrategy.GROUP_ROUND_ROBIN:
             return 'GROUP_ROUND_ROBIN';
+        case ConcurrencyLimitStrategy.CANCEL_NEWEST:
+            return 'CANCEL_NEWEST';
         case ConcurrencyLimitStrategy.UNRECOGNIZED:
         default:
             return 'UNRECOGNIZED';

package/util/retrier.js

@@ -14,9 +14,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.retrier = retrier;
 const sleep_1 = __importDefault(require("./sleep"));
-const DEFAULT_RETRY_INTERVAL = 1; // seconds
+const DEFAULT_RETRY_INTERVAL = 0.1; // seconds
 const DEFAULT_RETRY_COUNT = 8;
-const MAX_JITTER = 400; // milliseconds
+const MAX_JITTER = 100; // milliseconds
 function retrier(fn_1, logger_1) {
     return __awaiter(this, arguments, void 0, function* (fn, logger, retries = DEFAULT_RETRY_COUNT, interval = DEFAULT_RETRY_INTERVAL) {
         let lastError;

package/util/workflow-run-ref.js

@@ -43,10 +43,10 @@ function getWorkflowRunId(workflowRunId) {
                 if (e.code && e.code === nice_grpc_1.Status.ALREADY_EXISTS) {
                     throw new DedupeViolationErr(e.details);
                 }
-                throw new Error('Invalid workflowRunId');
+                throw e;
             }
         }
-        throw new Error('Invalid workflowRunId');
+        throw new Error('Invalid workflowRunId: must be a string or a promise');
     });
 }
 class WorkflowRunRef {

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "0.17.0";
+export declare const HATCHET_VERSION = "0.18.0";

package/version.js

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