@hatchet-dev/typescript-sdk 0.15.1-alpha6 → 0.15.2

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

@@ -1,5 +1,5 @@
 import { Channel, ClientFactory } from 'nice-grpc';
-import { DispatcherClient as PbDispatcherClient, StepActionEvent, GroupKeyActionEvent, OverridesData, DeepPartial } from '../../protoc/dispatcher';
+import { DispatcherClient as PbDispatcherClient, StepActionEvent, GroupKeyActionEvent, OverridesData, DeepPartial, RuntimeInfo } from '../../protoc/dispatcher';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
 import { ActionListener } from './action-listener';
@@ -16,6 +16,7 @@ export declare class DispatcherClient {
     client: PbDispatcherClient;
     logger: Logger;
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory);
+    getRuntimeInfo(): RuntimeInfo;
     getActionListener(options: GetActionListenerOptions): Promise<ActionListener>;
     sendStepActionEvent(in_: StepActionEvent): Promise<import("../../protoc/dispatcher").ActionEventResponse>;
     sendGroupKeyActionEvent(in_: GroupKeyActionEvent): Promise<import("../../protoc/dispatcher").ActionEventResponse>;

package/clients/dispatcher/dispatcher-client.js

@@ -17,6 +17,7 @@ const dispatcher_1 = require("../../protoc/dispatcher");
 const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
 const logger_1 = require("../../util/logger");
 const retrier_1 = require("../../util/retrier");
+const version_1 = require("../../version");
 const action_listener_1 = require("./action-listener");
 class DispatcherClient {
     constructor(config, channel, factory) {
@@ -24,10 +25,18 @@ class DispatcherClient {
         this.client = factory.create(dispatcher_1.DispatcherDefinition, channel);
         this.logger = new logger_1.Logger(`Dispatcher`, config.log_level);
     }
+    getRuntimeInfo() {
+        return {
+            sdkVersion: version_1.HATCHET_VERSION,
+            language: dispatcher_1.SDKS.TYPESCRIPT,
+            languageVersion: process.version,
+            os: process.platform,
+        };
+    }
     getActionListener(options) {
         return __awaiter(this, void 0, void 0, function* () {
             // Register the worker
-            const registration = yield this.client.register(Object.assign(Object.assign({}, options), { labels: options.labels ? mapLabels(options.labels) : undefined }));
+            const registration = yield this.client.register(Object.assign(Object.assign({}, options), { labels: options.labels ? mapLabels(options.labels) : undefined, runtimeInfo: this.getRuntimeInfo() }));
             return new action_listener_1.ActionListener(this, registration.workerId);
         });
     }

package/clients/event/event-client.js

@@ -84,20 +84,22 @@ class EventClient {
     }
     putLog(stepRunId, log, level) {
         const createdAt = new Date();
-        // retrier(
-        //   async () =>
-        //     this.client.putLog({
-        //       stepRunId,
-        //       createdAt,
-        //       message: log,
-        //       level: level || LogLevel.INFO,
-        //     }),
-        //   this.logger
-        // ).catch((e: any) => {
-        //   // log a warning, but this is not a fatal error
-        //   console.error(e);
-        //   // this.logger.warn(`Could not put log: ${e.message.substring(0, 100)}`);
-        // });
+        if (log.length > 1000) {
+            this.logger.warn(`log is too long, skipping: ${log.length} characters`);
+            return;
+        }
+        //  fire and forget the log
+        this.client
+            .putLog({
+            stepRunId,
+            createdAt,
+            message: log,
+            level: level || LogLevel.INFO,
+        })
+            .catch((e) => {
+            // log a warning, but this is not a fatal error
+            this.logger.warn(`Could not put log: ${e.message}`);
+        });
     }
     putStream(stepRunId, data) {
         const createdAt = new Date();

package/clients/listener/child-listener-client.js

@@ -38,8 +38,6 @@ const events_1 = require("events");
 const dispatcher_1 = require("../../protoc/dispatcher");
 const abort_controller_x_1 = require("abort-controller-x");
 const sleep_1 = __importDefault(require("../../util/sleep"));
-const DEFAULT_EVENT_LISTENER_RETRY_INTERVAL = 5; // seconds
-const DEFAULT_EVENT_LISTENER_RETRY_COUNT = 20;
 class Streamable {
     constructor(listener, id) {
         this.responseEmitter = new events_1.EventEmitter();
@@ -71,11 +69,13 @@ class GrpcPooledListener {
     init() {
         return __awaiter(this, arguments, void 0, function* (retries = 0) {
             var _a, e_1, _b, _c;
-            if (retries > DEFAULT_EVENT_LISTENER_RETRY_COUNT)
-                return;
+            let retryCount = retries;
+            const MAX_RETRY_INTERVAL = 5000; // 5 seconds in milliseconds
+            const BASE_RETRY_INTERVAL = 100; // 0.1 seconds in milliseconds
             if (retries > 0) {
-                this.client.logger.info(`Retrying in ... ${DEFAULT_EVENT_LISTENER_RETRY_INTERVAL} seconds`);
-                yield (0, sleep_1.default)(DEFAULT_EVENT_LISTENER_RETRY_INTERVAL * 1000);
+                const backoffTime = Math.min(BASE_RETRY_INTERVAL * 2 ** (retries - 1), MAX_RETRY_INTERVAL);
+                this.client.logger.info(`Retrying in ... ${backoffTime / 1000} seconds`);
+                yield (0, sleep_1.default)(backoffTime);
             }
             try {
                 this.client.logger.debug('Initializing child-listener');
@@ -90,17 +90,12 @@ class GrpcPooledListener {
                         _c = _f.value;
                         _d = false;
                         const event = _c;
+                        retryCount = 0;
                         const emitter = this.subscribers[event.workflowRunId];
                         if (emitter) {
                             emitter.responseEmitter.emit('response', event);
                             if (event.eventType === dispatcher_1.WorkflowRunEventType.WORKFLOW_RUN_EVENT_TYPE_FINISHED) {
                                 delete this.subscribers[event.workflowRunId];
-                                if (Object.keys(this.subscribers).length === 0) {
-                                    // FIXME it would be better to cleanup on parent complete
-                                    this.client.logger.debug('All subscriptions finished, cleaning up listener');
-                                    this.signal.abort();
-                                    this.onFinish();
-                                }
                             }
                         }
                     }
@@ -124,10 +119,9 @@ class GrpcPooledListener {
             finally {
                 // it is possible the server hangs up early,
                 // restart the listener if we still have subscribers
-                this.client.logger.debug('Child listener finally');
-                if (Object.keys(this.subscribers).length !== 0) {
-                    this.init(retries + 1);
-                }
+                this.client.logger.debug(`Child listener loop exited with ${Object.keys(this.subscribers).length} subscribers`);
+                this.client.logger.debug(`Restarting child listener retry ${retryCount + 1}`);
+                this.init(retryCount + 1);
             }
         });
     }

package/clients/worker/handler.js

@@ -79,15 +79,13 @@ class WebhookHandler {
     expressHandler({ secret }) {
         return (req, res) => {
             if (req.method === 'GET') {
-                res.sendStatus(200);
-                res.send(okMessage);
+                res.sendStatus(200).send(okMessage);
                 return;
             }
             if (req.method === 'PUT') {
                 this.getHealthcheckResponse(req.body, req.headers['x-hatchet-signature'], secret)
                     .then((resp) => {
-                    res.sendStatus(200);
-                    res.json(resp);
+                    res.sendStatus(200).json(resp);
                 })
                     .catch((err) => {
                     res.sendStatus(500);
@@ -96,11 +94,14 @@ class WebhookHandler {
                 return;
             }
             if (req.method !== 'POST') {
-                res.sendStatus(405);
-                res.json({ error: 'Method not allowed' });
+                res.sendStatus(405).json({ error: 'Method not allowed' });
                 return;
             }
-            this.handle(req.body, req.headers['x-hatchet-signature'], secret)
+            let action = req.body;
+            if (typeof action !== 'string') {
+                action = JSON.stringify(action);
+            }
+            this.handle(action, req.headers['x-hatchet-signature'], secret)
                 .then(() => {
                 res.sendStatus(200);
             })

package/examples/on-failure.js

@@ -13,36 +13,41 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const sdk_1 = __importDefault(require("../sdk"));
-const hatchet = sdk_1.default.init({
-    log_level: 'OFF',
-});
-const sleep = (ms) => new Promise((resolve) => {
-    setTimeout(resolve, ms);
-});
+const hatchet = sdk_1.default.init();
+// ❓ OnFailure Step
+// This workflow will fail because the step will throw an error
+// we define an onFailure step to handle this case
 const workflow = {
+    // ... normal workflow definition
     id: 'on-failure-example',
     description: 'test',
     on: {
         event: 'user:create',
     },
+    // ,
     steps: [
         {
-            name: 'dag-step1',
+            name: 'step1',
             run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-                console.log('Starting Step 1!');
-                yield sleep(1000);
+                // 👀 this step will always throw an error
                 throw new Error('Step 1 failed');
             }),
         },
     ],
+    // 👀 After the workflow fails, this special step will run
     onFailure: {
         name: 'on-failure-step',
         run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-            console.log('Starting On Failure Step!');
+            // 👀 we can do things like perform cleanup logic
+            // or notify a user here
             return { onFailure: 'step' };
         }),
     },
 };
+// ‼️
+// ❓ OnFailure With Details
+// Coming soon to TypeScript! https://github.com/hatchet-dev/hatchet-typescript/issues/447
+// ‼️
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         const worker = yield hatchet.worker('example-worker', 1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.15.1-alpha6",
+  "version": "0.15.2",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -17,7 +17,8 @@
   "scripts": {
     "build": "echo 'build hatchet sdk with `npn run tsc:build` to ensure it is not build during the publish step' && exit 0",
     "prepare": "npm run build",
-    "tsc:build": "tsc && resolve-tspaths",
+    "dump-version": "node -e \"console.log('export const HATCHET_VERSION = \\'' + require('./package.json').version + '\\';');\" > src/version.ts",
+    "tsc:build": "npm run dump-version && tsc && resolve-tspaths",
     "test:unit": "jest --testMatch='**/*.test.ts'",
     "test:e2e": "jest --testMatch='**/*.e2e.ts'",
     "test:unit:watch": "jest --testMatch='**/*.test.ts' --watch",
@@ -57,8 +58,8 @@
     "worker:logger": "npm run exec -- ./src/examples/logger.ts",
     "api": "npm run exec -- ./src/examples/api.ts",
     "prepublish": "cp package.json dist/package.json;",
-    "publish:ci": "rm -rf ./dist && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks",
-    "publish:ci:alpha": "rm -rf ./dist && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks --tag alpha",
+    "publish:ci": "rm -rf ./dist && npm run dump-version && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks",
+    "publish:ci:alpha": "rm -rf ./dist && npm run dump-version && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks --tag alpha",
     "generate-docs": "typedoc"
   },
   "keywords": [],

package/protoc/dispatcher/dispatcher.d.ts

@@ -1,6 +1,15 @@
 import { BinaryReader, BinaryWriter } from '@bufbuild/protobuf/wire';
 import { type CallContext, type CallOptions } from 'nice-grpc-common';
 export declare const protobufPackage = "";
+export declare enum SDKS {
+    UNKNOWN = 0,
+    GO = 1,
+    PYTHON = 2,
+    TYPESCRIPT = 3,
+    UNRECOGNIZED = -1
+}
+export declare function sDKSFromJSON(object: any): SDKS;
+export declare function sDKSToJSON(object: SDKS): string;
 export declare enum ActionType {
     START_STEP_RUN = 0,
     CANCEL_STEP_RUN = 1,
@@ -59,6 +68,13 @@ export interface WorkerLabels {
     strValue?: string | undefined;
     intValue?: number | undefined;
 }
+export interface RuntimeInfo {
+    sdkVersion?: string | undefined;
+    language?: SDKS | undefined;
+    languageVersion?: string | undefined;
+    os?: string | undefined;
+    extra?: string | undefined;
+}
 export interface WorkerRegisterRequest {
     /** the name of the worker */
     workerName: string;
@@ -74,6 +90,8 @@ export interface WorkerRegisterRequest {
     };
     /** (optional) webhookId is the id of the webhook that the worker is associated with (if any) */
     webhookId?: string | undefined;
+    /** (optional) information regarding the runtime environment of the worker */
+    runtimeInfo?: RuntimeInfo | undefined;
 }
 export interface WorkerRegisterRequest_LabelsEntry {
     key: string;
@@ -274,6 +292,7 @@ export interface ReleaseSlotRequest {
 export interface ReleaseSlotResponse {
 }
 export declare const WorkerLabels: MessageFns<WorkerLabels>;
+export declare const RuntimeInfo: MessageFns<RuntimeInfo>;
 export declare const WorkerRegisterRequest: MessageFns<WorkerRegisterRequest>;
 export declare const WorkerRegisterRequest_LabelsEntry: MessageFns<WorkerRegisterRequest_LabelsEntry>;
 export declare const WorkerRegisterResponse: MessageFns<WorkerRegisterResponse>;