@hatchet-dev/typescript-sdk 0.1.14 → 0.1.15

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

@@ -7,6 +7,7 @@ interface GetActionListenerOptions {
     workerName: string;
     services: string[];
     actions: string[];
+    maxRuns?: number;
 }
 export declare class DispatcherClient {
     config: ClientConfig;

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

@@ -28,5 +28,5 @@ export declare class HatchetClient {
     static with_host_port(host: string, port: number, config?: Partial<ClientConfig>, options?: HatchetClientOptions): HatchetClient;
     static init(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosConfig?: AxiosRequestConfig): HatchetClient;
     run(workflow: string | Workflow): Promise<Worker>;
-    worker(workflow: string | Workflow): Promise<Worker>;
+    worker(workflow: string | Workflow, maxRuns?: number): Promise<Worker>;
 }

package/clients/hatchet-client/hatchet-client.js

@@ -114,6 +114,7 @@ class HatchetClient {
     static init(config, options, axiosConfig) {
         return new HatchetClient(config, options, axiosConfig);
     }
+    // @deprecated
     run(workflow) {
         return __awaiter(this, void 0, void 0, function* () {
             const worker = yield this.worker(workflow);
@@ -121,11 +122,12 @@ class HatchetClient {
             return worker;
         });
     }
-    worker(workflow) {
+    worker(workflow, maxRuns) {
         return __awaiter(this, void 0, void 0, function* () {
             const name = typeof workflow === 'string' ? workflow : workflow.id;
             const worker = new worker_1.Worker(this, {
                 name,
+                maxRuns,
             });
             if (typeof workflow !== 'string') {
                 yield worker.registerWorkflow(workflow);

package/clients/worker/worker.d.ts

@@ -16,10 +16,12 @@ export declare class Worker {
     listener: ActionListener | undefined;
     futures: Record<Action['stepRunId'], HatchetPromise<any>>;
     contexts: Record<Action['stepRunId'], Context<any, any>>;
+    maxRuns?: number;
     logger: Logger;
     constructor(client: HatchetClient, options: {
         name: string;
         handleKill?: boolean;
+        maxRuns?: number;
     });
     registerWorkflow(workflow: Workflow): Promise<void>;
     registerAction<T, K>(actionId: string, action: StepRunFunction<T, K>): void;

package/clients/worker/worker.js

@@ -35,6 +35,7 @@ class Worker {
         this.client = client;
         this.name = options.name;
         this.action_registry = {};
+        this.maxRuns = options.maxRuns;
         process.on('SIGTERM', () => this.exitGracefully());
         process.on('SIGINT', () => this.exitGracefully());
         this.killing = false;
@@ -97,7 +98,7 @@ class Worker {
     }
     handleStartStepRun(action) {
         const { actionId } = action;
-        const context = new step_1.Context(action.actionPayload);
+        const context = new step_1.Context(action);
         this.contexts[action.stepRunId] = context;
         const step = this.action_registry[actionId];
         if (!step) {
@@ -146,7 +147,7 @@ class Worker {
     }
     handleStartGroupKeyRun(action) {
         const { actionId } = action;
-        const context = new step_1.Context(action.actionPayload);
+        const context = new step_1.Context(action);
         const key = action.getGroupKeyRunId;
         this.contexts[key] = context;
         this.logger.debug(`Starting group key run ${key}`);
@@ -276,6 +277,7 @@ class Worker {
                         workerName: this.name,
                         services: ['default'],
                         actions: Object.keys(this.action_registry),
+                        maxRuns: this.maxRuns,
                     });
                     const generator = this.listener.actions();
                     this.logger.info(`Worker ${this.name} listening for actions`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.1.14",
+  "version": "0.1.15",
   "description": "Background task orchestration & visibility for developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,8 +31,10 @@
     "worker:simple": "npm run exec -- ./examples/simple-worker.ts",
     "manual:trigger": "npm run exec -- ./examples/manual-trigger.ts",
     "worker:dag": "npm run exec -- ./examples/dag-worker.ts",
-    "worker:concurrency": "npm run exec -- ./examples/concurrency/concurrency-worker.ts",
-    "event:concurrency": "npm run exec -- ./examples/concurrency/concurrency-event.ts",
+    "worker:concurrency": "npm run exec -- ./examples/concurrency/cancel-in-progress/concurrency-worker.ts",
+    "event:concurrency": "npm run exec -- ./examples/concurrency/cancel-in-progress/concurrency-event.ts",
+    "worker:concurrency:rr": "npm run exec -- ./examples/concurrency/group-round-robin/concurrency-worker.ts",
+    "event:concurrency:rr": "npm run exec -- ./examples/concurrency/group-round-robin/concurrency-event.ts",
     "worker:retries": "npm run exec -- ./examples/retries-worker.ts",
     "api": "npm run exec -- ./examples/api.ts",
     "prepublish": "cp package.json dist/package.json;",

package/protoc/dispatcher/dispatcher.d.ts

@@ -53,6 +53,8 @@ export interface WorkerRegisterRequest {
     actions: string[];
     /** (optional) the services for this worker */
     services: string[];
+    /** (optional) the max number of runs this worker can handle */
+    maxRuns?: number | undefined;
 }
 export interface WorkerRegisterResponse {
     /** the tenant id */

package/protoc/dispatcher/dispatcher.js

@@ -253,7 +253,7 @@ function resourceEventTypeToJSON(object) {
 }
 exports.resourceEventTypeToJSON = resourceEventTypeToJSON;
 function createBaseWorkerRegisterRequest() {
-    return { workerName: "", actions: [], services: [] };
+    return { workerName: "", actions: [], services: [], maxRuns: undefined };
 }
 exports.WorkerRegisterRequest = {
     encode(message, writer = _m0.Writer.create()) {
@@ -266,6 +266,9 @@ exports.WorkerRegisterRequest = {
         for (const v of message.services) {
             writer.uint32(26).string(v);
         }
+        if (message.maxRuns !== undefined) {
+            writer.uint32(32).int32(message.maxRuns);
+        }
         return writer;
     },
     decode(input, length) {
@@ -293,6 +296,12 @@ exports.WorkerRegisterRequest = {
                     }
                     message.services.push(reader.string());
                     continue;
+                case 4:
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.maxRuns = reader.int32();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -306,6 +315,7 @@ exports.WorkerRegisterRequest = {
             workerName: isSet(object.workerName) ? globalThis.String(object.workerName) : "",
             actions: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.actions) ? object.actions.map((e) => globalThis.String(e)) : [],
             services: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.services) ? object.services.map((e) => globalThis.String(e)) : [],
+            maxRuns: isSet(object.maxRuns) ? globalThis.Number(object.maxRuns) : undefined,
         };
     },
     toJSON(message) {
@@ -320,17 +330,21 @@ exports.WorkerRegisterRequest = {
         if ((_b = message.services) === null || _b === void 0 ? void 0 : _b.length) {
             obj.services = message.services;
         }
+        if (message.maxRuns !== undefined) {
+            obj.maxRuns = Math.round(message.maxRuns);
+        }
         return obj;
     },
     create(base) {
         return exports.WorkerRegisterRequest.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         const message = createBaseWorkerRegisterRequest();
         message.workerName = (_a = object.workerName) !== null && _a !== void 0 ? _a : "";
         message.actions = ((_b = object.actions) === null || _b === void 0 ? void 0 : _b.map((e) => e)) || [];
         message.services = ((_c = object.services) === null || _c === void 0 ? void 0 : _c.map((e) => e)) || [];
+        message.maxRuns = (_d = object.maxRuns) !== null && _d !== void 0 ? _d : undefined;
         return message;
     },
 };

package/protoc/workflows/workflows.d.ts

@@ -5,6 +5,7 @@ export declare enum ConcurrencyLimitStrategy {
     CANCEL_IN_PROGRESS = 0,
     DROP_NEWEST = 1,
     QUEUE_NEWEST = 2,
+    GROUP_ROUND_ROBIN = 3,
     UNRECOGNIZED = -1
 }
 export declare function concurrencyLimitStrategyFromJSON(object: any): ConcurrencyLimitStrategy;

package/protoc/workflows/workflows.js

@@ -33,6 +33,7 @@ var ConcurrencyLimitStrategy;
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["CANCEL_IN_PROGRESS"] = 0] = "CANCEL_IN_PROGRESS";
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["DROP_NEWEST"] = 1] = "DROP_NEWEST";
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["QUEUE_NEWEST"] = 2] = "QUEUE_NEWEST";
+    ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["GROUP_ROUND_ROBIN"] = 3] = "GROUP_ROUND_ROBIN";
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(ConcurrencyLimitStrategy || (exports.ConcurrencyLimitStrategy = ConcurrencyLimitStrategy = {}));
 function concurrencyLimitStrategyFromJSON(object) {
@@ -46,6 +47,9 @@ function concurrencyLimitStrategyFromJSON(object) {
         case 2:
         case "QUEUE_NEWEST":
             return ConcurrencyLimitStrategy.QUEUE_NEWEST;
+        case 3:
+        case "GROUP_ROUND_ROBIN":
+            return ConcurrencyLimitStrategy.GROUP_ROUND_ROBIN;
         case -1:
         case "UNRECOGNIZED":
         default:
@@ -61,6 +65,8 @@ function concurrencyLimitStrategyToJSON(object) {
             return "DROP_NEWEST";
         case ConcurrencyLimitStrategy.QUEUE_NEWEST:
             return "QUEUE_NEWEST";
+        case ConcurrencyLimitStrategy.GROUP_ROUND_ROBIN:
+            return "GROUP_ROUND_ROBIN";
         case ConcurrencyLimitStrategy.UNRECOGNIZED:
         default:
             return "UNRECOGNIZED";

package/step.d.ts

@@ -1,4 +1,5 @@
 import * as z from 'zod';
+import { Action } from './clients/dispatcher/action-listener';
 export declare const CreateStepSchema: z.ZodObject<{
     name: z.ZodString;
     parents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -26,8 +27,9 @@ interface ContextData<T, K> {
 }
 export declare class Context<T, K> {
     data: ContextData<T, K>;
+    input: T;
     controller: AbortController;
-    constructor(payload: string);
+    constructor(action: Action);
     stepOutput(step: string): string;
     triggeredByEvent(): boolean;
     workflowInput(): T;

package/step.js

@@ -37,10 +37,18 @@ exports.CreateStepSchema = z.object({
     retries: z.number().optional(),
 });
 class Context {
-    constructor(payload) {
+    constructor(action) {
         this.controller = new AbortController();
         try {
-            this.data = JSON.parse(JSON.parse(payload));
+            const data = JSON.parse(JSON.parse(action.actionPayload));
+            this.data = data;
+            // if this is a getGroupKeyRunId, the data is the workflow input
+            if (action.getGroupKeyRunId !== '') {
+                this.input = data;
+            }
+            else {
+                this.input = data.input;
+            }
         }
         catch (e) {
             throw new hatchet_error_1.default(`Could not parse payload: ${e.message}`);
@@ -60,8 +68,7 @@ class Context {
         return ((_a = this.data) === null || _a === void 0 ? void 0 : _a.triggered_by) === 'event';
     }
     workflowInput() {
-        var _a;
-        return (_a = this.data) === null || _a === void 0 ? void 0 : _a.input;
+        return this.input;
     }
     userData() {
         var _a;