@hatchet-dev/typescript-sdk 1.10.7 → 1.11.0

package/clients/rest/generated/data-contracts.d.ts

@@ -807,6 +807,10 @@ export interface V1Webhook {
     sourceName: V1WebhookSourceName;
     /** The CEL expression to use for the event key. This is used to create the event key from the webhook payload. */
     eventKeyExpression: string;
+    /** The CEL expression to use for the scope. This is used to filter the correct workflow to trigger. */
+    scopeExpression?: string;
+    /** The static payload to use for the webhook. This is used to send a static payload with the webhook. */
+    staticPayload?: object;
     /** The type of authentication to use for the webhook */
     authType: V1WebhookAuthType;
 }
@@ -821,6 +825,10 @@ export interface V1CreateWebhookRequestBase {
     name: string;
     /** The CEL expression to use for the event key. This is used to create the event key from the webhook payload. */
     eventKeyExpression: string;
+    /** The CEL expression to use for the scope. This is used to filter the correct workflow to trigger. */
+    scopeExpression?: string;
+    /** The static payload to use for the webhook. This is used to send a static payload with the webhook. */
+    staticPayload?: object;
 }
 export interface V1WebhookBasicAuth {
     /** The username for basic auth */
@@ -863,6 +871,10 @@ export type V1CreateWebhookRequest = V1CreateWebhookRequestBasicAuth | V1CreateW
 export interface V1UpdateWebhookRequest {
     /** The CEL expression to use for the event key. This is used to create the event key from the webhook payload. */
     eventKeyExpression: string;
+    /** The CEL expression to use for the scope. This is used to filter the correct workflow to trigger. */
+    scopeExpression?: string;
+    /** The static payload to use for the webhook. This is used to send a static payload with the webhook. */
+    staticPayload?: object;
 }
 export interface V1CELDebugRequest {
     /** The CEL expression to evaluate */

package/clients/worker/worker.js

@@ -187,7 +187,7 @@ class V0Worker {
                     return step(context);
                 });
                 const success = (result) => __awaiter(this, void 0, void 0, function* () {
-                    this.logger.info(`Step run ${action.stepRunId} succeeded`);
+                    this.logger.info(`Task run ${action.stepRunId} succeeded`);
                     try {
                         // Send the action event to the dispatcher
                         const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_COMPLETED, false, result || null, action.retryCount);
@@ -212,7 +212,7 @@ class V0Worker {
                     }
                 });
                 const failure = (error) => __awaiter(this, void 0, void 0, function* () {
-                    this.logger.error(`Step run ${action.stepRunId} failed: ${error.message}`);
+                    this.logger.error(`Task run ${action.stepRunId} failed: ${error.message}`);
                     if (error.stack) {
                         this.logger.error(error.stack);
                     }
@@ -255,7 +255,14 @@ class V0Worker {
                     yield future.promise;
                 }
                 catch (e) {
-                    this.logger.error('Could not wait for step run to finish: ', e);
+                    const message = (e === null || e === void 0 ? void 0 : e.message) || String(e);
+                    if (message.includes('Cancelled')) {
+                        this.logger.debug(`Task run ${action.stepRunId} was cancelled`);
+                    }
+                    else {
+                        this.logger.error(`Could not wait for task run ${action.stepRunId} to finish. ` +
+                            `See https://docs.hatchet.run/home/cancellation for best practices on handling cancellation: `, e);
+                    }
                 }
             }
             catch (e) {
@@ -284,7 +291,7 @@ class V0Worker {
                     return step(context);
                 });
                 const success = (result) => {
-                    this.logger.info(`Step run ${action.stepRunId} succeeded`);
+                    this.logger.info(`Task run ${action.stepRunId} succeeded`);
                     try {
                         // Send the action event to the dispatcher
                         const event = this.getGroupKeyActionEvent(action, dispatcher_1.GroupKeyActionEventType.GROUP_KEY_EVENT_TYPE_COMPLETED, result);
@@ -302,7 +309,7 @@ class V0Worker {
                     }
                 };
                 const failure = (error) => {
-                    this.logger.error(`Step run ${key} failed: ${error.message}`);
+                    this.logger.error(`Task run ${key} failed: ${error.message}`);
                     try {
                         // Send the action event to the dispatcher
                         const event = this.getGroupKeyActionEvent(action, dispatcher_1.GroupKeyActionEventType.GROUP_KEY_EVENT_TYPE_FAILED, error);
@@ -366,7 +373,7 @@ class V0Worker {
         return __awaiter(this, void 0, void 0, function* () {
             const { stepRunId } = action;
             try {
-                this.logger.info(`Cancelling step run ${action.stepRunId}`);
+                this.logger.info(`Cancelling task run ${action.stepRunId}`);
                 const future = this.futures[(0, action_listener_1.createActionKey)(action)];
                 const context = this.contexts[(0, action_listener_1.createActionKey)(action)];
                 if (context && context.controller) {
@@ -374,14 +381,15 @@ class V0Worker {
                 }
                 if (future) {
                     future.promise.catch(() => {
-                        this.logger.info(`Cancelled step run ${action.stepRunId}`);
+                        this.logger.info(`Cancelled task run ${action.stepRunId}`);
                     });
                     future.cancel('Cancelled by worker');
                     yield future.promise;
                 }
             }
             catch (e) {
-                this.logger.error('Could not cancel step run: ', e);
+                // Expected: the promise rejects when cancelled
+                this.logger.debug(`Task run ${stepRunId} cancellation completed`);
             }
             finally {
                 delete this.futures[(0, action_listener_1.createActionKey)(action)];

package/package.json

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

package/v1/client/features/metrics.d.ts

@@ -1,6 +1,11 @@
-import { BaseWorkflowDeclaration } from '../..';
-import { Workflow } from '../../../workflow';
 import { HatchetClient } from '../client';
+export type TaskStatusMetrics = {
+    cancelled: number;
+    completed: number;
+    failed: number;
+    queued: number;
+    running: number;
+};
 /**
  * MetricsClient is used to get metrics for workflows
  */
@@ -8,7 +13,13 @@ export declare class MetricsClient {
     tenantId: string;
     api: HatchetClient['api'];
     constructor(client: HatchetClient);
-    getWorkflowMetrics(workflow: string | Workflow | BaseWorkflowDeclaration<any, any>, opts?: Parameters<typeof this.api.workflowGetMetrics>[1]): Promise<import("../../../clients/rest/generated/data-contracts").WorkflowMetrics>;
-    getQueueMetrics(opts?: Parameters<typeof this.api.tenantGetQueueMetrics>[1] & {}): Promise<import("../../../clients/rest/generated/data-contracts").TenantQueueMetrics>;
-    getTaskMetrics(opts?: Parameters<typeof this.api.tenantGetStepRunQueueMetrics>[1]): Promise<import("../../../clients/rest/generated/data-contracts").TenantStepRunQueueMetrics>;
+    /**
+     * Get task/run status metrics for a tenant.
+     *
+     * This backs the dashboard "runs list" status count badges.
+     *
+     * Endpoint: GET /api/v1/stable/tenants/{tenant}/task-metrics
+     */
+    getTaskStatusMetrics(query: Parameters<typeof this.api.v1TaskListStatusMetrics>[1], requestParams?: Parameters<typeof this.api.v1TaskListStatusMetrics>[2]): Promise<TaskStatusMetrics>;
+    getQueueMetrics(opts?: Parameters<typeof this.api.tenantGetStepRunQueueMetrics>[1]): Promise<import("../../../clients/rest/generated/data-contracts").TenantStepRunQueueMetrics>;
 }

package/v1/client/features/metrics.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MetricsClient = void 0;
-const v1_1 = require("../..");
 /**
  * MetricsClient is used to get metrics for workflows
  */
@@ -19,24 +18,24 @@ class MetricsClient {
         this.tenantId = client.tenantId;
         this.api = client.api;
     }
-    getWorkflowMetrics(workflow, opts) {
+    /**
+     * Get task/run status metrics for a tenant.
+     *
+     * This backs the dashboard "runs list" status count badges.
+     *
+     * Endpoint: GET /api/v1/stable/tenants/{tenant}/task-metrics
+     */
+    getTaskStatusMetrics(query, requestParams) {
         return __awaiter(this, void 0, void 0, function* () {
-            const name = (0, v1_1.workflowNameString)(workflow);
-            const { data } = yield this.api.workflowGetMetrics(name, opts);
-            return data;
+            const { data } = yield this.api.v1TaskListStatusMetrics(this.tenantId, query, requestParams);
+            return data.reduce((acc, curr) => {
+                acc[curr.status.toLowerCase()] = curr.count;
+                return acc;
+            }, {});
         });
     }
     getQueueMetrics(opts) {
         return __awaiter(this, void 0, void 0, function* () {
-            // TODO IMPORTANT workflow id is the uuid for the workflow... not its name
-            // const stringWorkflows = opts?.workflows?
-            const { data } = yield this.api.tenantGetQueueMetrics(this.tenantId, Object.assign({}, opts));
-            return data;
-        });
-    }
-    getTaskMetrics(opts) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // TODO what is this...
             const { data } = yield this.api.tenantGetStepRunQueueMetrics(this.tenantId, opts);
             return data;
         });

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

@@ -423,7 +423,7 @@ class V1Worker {
                         if (context.cancelled) {
                             return;
                         }
-                        this.logger.info(`Step run ${action.stepRunId} succeeded`);
+                        this.logger.info(`Task run ${action.stepRunId} succeeded`);
                         // Send the action event to the dispatcher
                         const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_COMPLETED, false, result || null, action.retryCount);
                         yield this.client._v0.dispatcher.sendStepActionEvent(event);
@@ -452,7 +452,7 @@ class V1Worker {
                         if (context.cancelled) {
                             return;
                         }
-                        this.logger.error(`Step run ${action.stepRunId} failed: ${error.message}`);
+                        this.logger.error(`Task run ${action.stepRunId} failed: ${error.message}`);
                         if (error.stack) {
                             this.logger.error(error.stack);
                         }
@@ -493,7 +493,14 @@ class V1Worker {
                     yield future.promise;
                 }
                 catch (e) {
-                    this.logger.error('Could not wait for step run to finish: ', e);
+                    const message = (e === null || e === void 0 ? void 0 : e.message) || String(e);
+                    if (message.includes('Cancelled')) {
+                        this.logger.debug(`Task run ${action.stepRunId} was cancelled`);
+                    }
+                    else {
+                        this.logger.error(`Could not wait for task run ${action.stepRunId} to finish. ` +
+                            `See https://docs.hatchet.run/home/cancellation for best practices on handling cancellation: `, e);
+                    }
                 }
             }
             catch (e) {
@@ -523,7 +530,7 @@ class V1Worker {
                     return step(context);
                 });
                 const success = (result) => {
-                    this.logger.info(`Step run ${action.stepRunId} succeeded`);
+                    this.logger.info(`Task run ${action.stepRunId} succeeded`);
                     try {
                         // Send the action event to the dispatcher
                         const event = this.getGroupKeyActionEvent(action, dispatcher_1.GroupKeyActionEventType.GROUP_KEY_EVENT_TYPE_COMPLETED, result);
@@ -541,7 +548,7 @@ class V1Worker {
                     }
                 };
                 const failure = (error) => {
-                    this.logger.error(`Step run ${key} failed: ${error.message}`);
+                    this.logger.error(`Task run ${key} failed: ${error.message}`);
                     try {
                         // Send the action event to the dispatcher
                         const event = this.getGroupKeyActionEvent(action, dispatcher_1.GroupKeyActionEventType.GROUP_KEY_EVENT_TYPE_FAILED, error);
@@ -605,7 +612,7 @@ class V1Worker {
         return __awaiter(this, void 0, void 0, function* () {
             const { stepRunId } = action;
             try {
-                this.logger.info(`Cancelling step run ${action.stepRunId}`);
+                this.logger.info(`Cancelling task run ${action.stepRunId}`);
                 const future = this.futures[stepRunId];
                 const context = this.contexts[stepRunId];
                 if (context && context.abortController) {
@@ -613,14 +620,15 @@ class V1Worker {
                 }
                 if (future) {
                     future.promise.catch(() => {
-                        this.logger.info(`Cancelled step run ${action.stepRunId}`);
+                        this.logger.info(`Cancelled task run ${action.stepRunId}`);
                     });
                     future.cancel('Cancelled by worker');
                     yield future.promise;
                 }
             }
             catch (e) {
-                this.logger.error('Could not cancel step run: ', e);
+                // Expected: the promise rejects when cancelled
+                this.logger.debug(`Task run ${stepRunId} cancellation completed`);
             }
             finally {
                 delete this.futures[stepRunId];

package/v1/declaration.d.ts

@@ -266,14 +266,14 @@ export declare class BaseWorkflowDeclaration<I extends InputType = UnknownInputT
      * @returns A promise that resolves with the workflow metrics.
      * @throws Error if the workflow is not bound to a Hatchet client.
      */
-    metrics(opts?: Parameters<MetricsClient['getWorkflowMetrics']>[1]): Promise<import("../clients/rest/generated/data-contracts").WorkflowMetrics>;
+    metrics(opts?: Omit<Parameters<MetricsClient['getTaskStatusMetrics']>[0], 'workflows'>): Promise<import("./client/features/metrics").TaskStatusMetrics>;
     /**
      * Get queue metrics for the workflow.
      * @param opts Optional configuration for the metrics request.
      * @returns A promise that resolves with the workflow metrics.
      * @throws Error if the workflow is not bound to a Hatchet client.
      */
-    queueMetrics(opts?: Omit<Parameters<MetricsClient['getQueueMetrics']>[0], 'workflows'>): Promise<import("../clients/rest/generated/data-contracts").TenantQueueMetrics>;
+    taskStatusMetrics(opts?: Omit<Parameters<MetricsClient['getTaskStatusMetrics']>[0], 'workflows'>): Promise<import("./client/features/metrics").TaskStatusMetrics>;
     /**
      * Get the current state of the workflow.
      * @returns A promise that resolves with the workflow state.

package/v1/declaration.js

@@ -166,10 +166,17 @@ class BaseWorkflowDeclaration {
      * @throws Error if the workflow is not bound to a Hatchet client.
      */
     metrics(opts) {
-        if (!this.client) {
-            throw UNBOUND_ERR;
-        }
-        return this.client.metrics.getWorkflowMetrics(this.definition.name, opts);
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.client) {
+                throw UNBOUND_ERR;
+            }
+            const workflow = yield this.client.workflows.get(this.definition.name);
+            return this.client.metrics.getTaskStatusMetrics({
+                since: (opts === null || opts === void 0 ? void 0 : opts.since) || new Date(Date.now() - 24 * 60 * 60 * 1000).toISOString(),
+                until: (opts === null || opts === void 0 ? void 0 : opts.until) || new Date().toISOString(),
+                workflow_ids: [workflow.metadata.id],
+            });
+        });
     }
     /**
      * Get queue metrics for the workflow.
@@ -177,11 +184,18 @@ class BaseWorkflowDeclaration {
      * @returns A promise that resolves with the workflow metrics.
      * @throws Error if the workflow is not bound to a Hatchet client.
      */
-    queueMetrics(opts) {
-        if (!this.client) {
-            throw UNBOUND_ERR;
-        }
-        return this.client.metrics.getQueueMetrics(Object.assign(Object.assign({}, opts), { workflows: [this.definition.name] }));
+    taskStatusMetrics(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.client) {
+                throw UNBOUND_ERR;
+            }
+            const workflow = yield this.client.workflows.get(this.definition.name);
+            return this.client.metrics.getTaskStatusMetrics({
+                since: (opts === null || opts === void 0 ? void 0 : opts.since) || new Date(Date.now() - 24 * 60 * 60 * 1000).toISOString(),
+                until: (opts === null || opts === void 0 ? void 0 : opts.until) || new Date().toISOString(),
+                workflow_ids: [workflow.metadata.id],
+            });
+        });
     }
     /**
      * Get the current state of the workflow.

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.10.7";
+export declare const HATCHET_VERSION = "1.11.0";

package/version.js

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