@hatchet-dev/typescript-sdk 0.4.0 → 0.4.2

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

@@ -3,6 +3,13 @@ import { CreateWorkflowVersionOpts, RateLimitDuration, WorkflowServiceClient } f
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
 import { Api } from '../rest';
+import { WorkflowRunStatus } from '../rest/generated/data-contracts';
+type WorkflowMetricsQuery = {
+    workflowId?: string;
+    workflowName?: string;
+    status?: WorkflowRunStatus;
+    groupKey?: string;
+};
 /**
  * AdminClient is a client for interacting with the Hatchet Admin API. This allows you to configure, trigger,
  * and monitor workflows.
@@ -89,4 +96,13 @@ export declare class AdminClient {
     schedule_workflow(name: string, options?: {
         schedules?: Date[];
     }): void;
+    /**
+     * Get the metrics for a workflow.
+     *
+     * @param workflowId the ID of the workflow to get metrics for
+     * @param workflowName the name of the workflow to get metrics for
+     * @param query an object containing query parameters to filter the metrics
+     */
+    get_workflow_metrics({ workflowId, workflowName, status, groupKey }: WorkflowMetricsQuery): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WorkflowMetrics, any>>;
 }
+export {};

package/clients/admin/admin-client.js

@@ -164,5 +164,32 @@ class AdminClient {
             throw new hatchet_error_1.default(e.message);
         }
     }
+    /**
+     * Get the metrics for a workflow.
+     *
+     * @param workflowId the ID of the workflow to get metrics for
+     * @param workflowName the name of the workflow to get metrics for
+     * @param query an object containing query parameters to filter the metrics
+     */
+    get_workflow_metrics({ workflowId, workflowName, status, groupKey }) {
+        const params = {
+            status,
+            groupKey,
+        };
+        if (workflowName) {
+            this.list_workflows().then((res) => {
+                var _a;
+                const workflow = (_a = res.rows) === null || _a === void 0 ? void 0 : _a.find((row) => row.name === workflowName);
+                if (workflow) {
+                    return this.api.workflowGetMetrics(workflow.metadata.id, params);
+                }
+                throw new Error(`Workflow ${workflowName} not found`);
+            });
+        }
+        else if (workflowId) {
+            return this.api.workflowGetMetrics(workflowId, params);
+        }
+        throw new Error('Must provide either a workflowId or workflowName');
+    }
 }
 exports.AdminClient = AdminClient;

package/clients/dispatcher/action-listener.js

@@ -38,7 +38,7 @@ const sleep_1 = __importDefault(require("../../util/sleep"));
 const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
 const logger_1 = require("../../util/logger");
 const DEFAULT_ACTION_LISTENER_RETRY_INTERVAL = 5000; // milliseconds
-const DEFAULT_ACTION_LISTENER_RETRY_COUNT = 5;
+const DEFAULT_ACTION_LISTENER_RETRY_COUNT = 20;
 // eslint-disable-next-line no-shadow
 var ListenStrategy;
 (function (ListenStrategy) {
@@ -61,9 +61,10 @@ class ActionListener {
                         break;
                     }
                     try {
+                        const listenClient = yield __await(client.getListenClient());
                         try {
-                            for (var _d = true, _e = (e_1 = void 0, __asyncValues(yield __await(client.getListenClient()))), _f; _f = yield __await(_e.next()), _a = _f.done, !_a; _d = true) {
-                                _c = _f.value;
+                            for (var _d = true, listenClient_1 = (e_1 = void 0, __asyncValues(listenClient)), listenClient_1_1; listenClient_1_1 = yield __await(listenClient_1.next()), _a = listenClient_1_1.done, !_a; _d = true) {
+                                _c = listenClient_1_1.value;
                                 _d = false;
                                 const assignedAction = _c;
                                 const action = Object.assign({}, assignedAction);
@@ -73,24 +74,25 @@ class ActionListener {
                         catch (e_1_1) { e_1 = { error: e_1_1 }; }
                         finally {
                             try {
-                                if (!_d && !_a && (_b = _e.return)) yield __await(_b.call(_e));
+                                if (!_d && !_a && (_b = listenClient_1.return)) yield __await(_b.call(listenClient_1));
                             }
                             finally { if (e_1) throw e_1.error; }
                         }
                     }
                     catch (e) {
+                        client.logger.info('Listener error');
                         // if this is a HatchetError, we should throw this error
                         if (e instanceof hatchet_error_1.default) {
                             throw e;
                         }
-                        if (e.code === nice_grpc_1.Status.CANCELLED) {
-                            break;
-                        }
                         if ((yield __await(client.getListenStrategy())) === ListenStrategy.LISTEN_STRATEGY_V2 &&
                             e.code === nice_grpc_1.Status.UNIMPLEMENTED) {
                             client.setListenStrategy(ListenStrategy.LISTEN_STRATEGY_V1);
                         }
                         client.incrementRetries();
+                        client.logger.error(`Listener encountered an error: ${e.message}`);
+                        client.logger.info(`Retrying in ${client.retryInterval}ms...`);
+                        yield __await((0, sleep_1.default)(client.retryInterval));
                     }
                 }
             });
@@ -122,20 +124,7 @@ class ActionListener {
             if (this.heartbeatInterval) {
                 return;
             }
-            // start with a heartbeat
-            try {
-                yield this.client.heartbeat({
-                    workerId: this.workerId,
-                    heartbeatAt: new Date(),
-                });
-            }
-            catch (e) {
-                this.logger.error(`Failed to send heartbeat: ${e.message}`);
-                if (e.code === nice_grpc_1.Status.UNIMPLEMENTED) {
-                    return;
-                }
-            }
-            this.heartbeatInterval = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+            const beat = () => __awaiter(this, void 0, void 0, function* () {
                 try {
                     yield this.client.heartbeat({
                         workerId: this.workerId,
@@ -150,7 +139,10 @@ class ActionListener {
                     }
                     this.logger.error(`Failed to send heartbeat: ${e.message}`);
                 }
-            }), 4000);
+            });
+            // start with a heartbeat
+            beat();
+            this.heartbeatInterval = setInterval(beat, 4000);
         });
     }
     closeHeartbeat() {
@@ -175,20 +167,28 @@ class ActionListener {
             }
             try {
                 if (this.listenStrategy === ListenStrategy.LISTEN_STRATEGY_V1) {
-                    return this.client.listen({
+                    const result = this.client.listen({
                         workerId: this.workerId,
                     });
+                    this.logger.info('Connection established using LISTEN_STRATEGY_V1');
+                    return result;
                 }
                 const res = this.client.listenV2({
                     workerId: this.workerId,
                 });
                 this.heartbeat();
+                this.logger.info('Connection established using LISTEN_STRATEGY_V2');
                 return res;
             }
             catch (e) {
                 this.retries += 1;
-                this.logger.error(`Attempt ${this.retries}: Failed to connect, retrying...`); // Optional: log retry attempt
-                return this.getListenClient();
+                this.logger.error(`Attempt ${this.retries}: Failed to connect, retrying...`);
+                if (e.code === nice_grpc_1.Status.UNAVAILABLE) {
+                    // Connection lost, reset heartbeat interval and retry connection
+                    this.closeHeartbeat();
+                    return this.getListenClient();
+                }
+                throw e;
             }
         });
     }

package/clients/listener/listener-client.js

@@ -91,6 +91,7 @@ const workflowStatusMap = {
     [data_contracts_1.WorkflowRunStatus.CANCELLED]: RunEventType.WORKFLOW_RUN_EVENT_TYPE_CANCELLED,
     [data_contracts_1.WorkflowRunStatus.PENDING]: undefined,
     [data_contracts_1.WorkflowRunStatus.RUNNING]: undefined,
+    [data_contracts_1.WorkflowRunStatus.QUEUED]: undefined,
 };
 class PollingAsyncListener {
     constructor(workflowRunid, client) {

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

@@ -1,4 +1,4 @@
-import { APIMeta, AcceptInviteRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreatePullRequestFromStepRun, CreateTenantInviteRequest, CreateTenantRequest, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, GetStepRunDiffResponse, LinkGithubRepositoryRequest, ListAPIMetaIntegration, ListAPITokensResponse, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, ListPullRequestsResponse, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, PullRequestState, RejectInviteRequest, ReplayEventRequest, RerunStepRunRequest, StepRun, Tenant, TenantInvite, TenantInviteList, TenantMemberList, TriggerWorkflowRunRequest, UpdateTenantInviteRequest, User, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, Worker, WorkerList, Workflow, WorkflowID, WorkflowList, WorkflowRun, WorkflowRunList, WorkflowRunStatusList, WorkflowVersion, WorkflowVersionDefinition } from './data-contracts';
+import { APIMeta, AcceptInviteRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreatePullRequestFromStepRun, CreateSNSIntegrationRequest, CreateTenantInviteRequest, CreateTenantRequest, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, GetStepRunDiffResponse, LinkGithubRepositoryRequest, ListAPIMetaIntegration, ListAPITokensResponse, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, ListPullRequestsResponse, ListSNSIntegrations, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, PullRequestState, RejectInviteRequest, ReplayEventRequest, RerunStepRunRequest, SNSIntegration, StepRun, Tenant, TenantInvite, TenantInviteList, TenantMemberList, TriggerWorkflowRunRequest, UpdateTenantInviteRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, Worker, WorkerList, Workflow, WorkflowID, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunStatus, WorkflowRunStatusList, WorkflowVersion, WorkflowVersionDefinition } from './data-contracts';
 import { HttpClient, RequestParams } from './http-client';
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     /**
@@ -112,6 +112,36 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @request POST:/api/v1/sns/{tenant}/{event}
      */
     snsUpdate: (tenant: string, event: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description List SNS integrations
+     *
+     * @tags SNS
+     * @name SnsList
+     * @summary List SNS integrations
+     * @request GET:/api/v1/tenants/{tenant}/sns
+     * @secure
+     */
+    snsList: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<ListSNSIntegrations, any>>;
+    /**
+     * @description Create SNS integration
+     *
+     * @tags SNS
+     * @name SnsCreate
+     * @summary Create SNS integration
+     * @request POST:/api/v1/tenants/{tenant}/sns
+     * @secure
+     */
+    snsCreate: (tenant: string, data: CreateSNSIntegrationRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<SNSIntegration, any>>;
+    /**
+     * @description Delete SNS integration
+     *
+     * @tags SNS
+     * @name SnsDelete
+     * @summary Delete SNS integration
+     * @request DELETE:/api/v1/sns/{sns}
+     * @secure
+     */
+    snsDelete: (sns: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * @description Gets the current user
      *
@@ -122,6 +152,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     userGetCurrent: (params?: RequestParams) => Promise<import("axios").AxiosResponse<User, any>>;
+    /**
+     * @description Update a user password.
+     *
+     * @tags User
+     * @name UserUpdatePassword
+     * @summary Change user password
+     * @request POST:/api/v1/users/password
+     * @secure
+     */
+    userUpdatePassword: (data: UserChangePasswordRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<User, any>>;
     /**
      * @description Registers a user.
      *
@@ -426,6 +466,21 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     workflowUpdateLinkGithub: (workflow: string, data: LinkGithubRepositoryRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow, any>>;
+    /**
+     * @description Get the metrics for a workflow version
+     *
+     * @tags Workflow
+     * @name WorkflowGetMetrics
+     * @summary Get workflow metrics
+     * @request GET:/api/v1/workflows/{workflow}/metrics
+     * @secure
+     */
+    workflowGetMetrics: (workflow: string, query?: {
+        /** A status of workflow runs to filter by */
+        status?: WorkflowRunStatus;
+        /** A group key to filter metrics by */
+        groupKey?: string;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<WorkflowMetrics, any>>;
     /**
      * @description Create a pull request for a workflow
      *
@@ -509,6 +564,20 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @maxLength 36
          */
         workflowId?: string;
+        /**
+         * The parent workflow run id
+         * @format uuid
+         * @minLength 36
+         * @maxLength 36
+         */
+        parentWorkflowRunId?: string;
+        /**
+         * The parent step run id
+         * @format uuid
+         * @minLength 36
+         * @maxLength 36
+         */
+        parentStepRunId?: string;
     }, params?: RequestParams) => Promise<import("axios").AxiosResponse<WorkflowRunList, any>>;
     /**
      * @description Get a workflow run for a tenant
@@ -553,6 +622,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     stepRunUpdateRerun: (tenant: string, stepRun: string, data: RerunStepRunRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<StepRun, any>>;
+    /**
+     * @description Attempts to cancel a step run
+     *
+     * @tags Step Run
+     * @name StepRunUpdateCancel
+     * @summary Attempts to cancel a step run
+     * @request POST:/api/v1/tenants/{tenant}/step-runs/{step-run}/cancel
+     * @secure
+     */
+    stepRunUpdateCancel: (tenant: string, stepRun: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<StepRun, any>>;
     /**
      * @description Get the schema for a step run
      *

package/clients/rest/generated/Api.js

@@ -126,6 +126,36 @@ class Api extends http_client_1.HttpClient {
          * @request POST:/api/v1/sns/{tenant}/{event}
          */
         this.snsUpdate = (tenant, event, params = {}) => this.request(Object.assign({ path: `/api/v1/sns/${tenant}/${event}`, method: 'POST' }, params));
+        /**
+         * @description List SNS integrations
+         *
+         * @tags SNS
+         * @name SnsList
+         * @summary List SNS integrations
+         * @request GET:/api/v1/tenants/{tenant}/sns
+         * @secure
+         */
+        this.snsList = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/sns`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Create SNS integration
+         *
+         * @tags SNS
+         * @name SnsCreate
+         * @summary Create SNS integration
+         * @request POST:/api/v1/tenants/{tenant}/sns
+         * @secure
+         */
+        this.snsCreate = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/sns`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Delete SNS integration
+         *
+         * @tags SNS
+         * @name SnsDelete
+         * @summary Delete SNS integration
+         * @request DELETE:/api/v1/sns/{sns}
+         * @secure
+         */
+        this.snsDelete = (sns, params = {}) => this.request(Object.assign({ path: `/api/v1/sns/${sns}`, method: 'DELETE', secure: true }, params));
         /**
          * @description Gets the current user
          *
@@ -136,6 +166,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.userGetCurrent = (params = {}) => this.request(Object.assign({ path: `/api/v1/users/current`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Update a user password.
+         *
+         * @tags User
+         * @name UserUpdatePassword
+         * @summary Change user password
+         * @request POST:/api/v1/users/password
+         * @secure
+         */
+        this.userUpdatePassword = (data, params = {}) => this.request(Object.assign({ path: `/api/v1/users/password`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
         /**
          * @description Registers a user.
          *
@@ -393,6 +433,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.workflowUpdateLinkGithub = (workflow, data, params = {}) => this.request(Object.assign({ path: `/api/v1/workflows/${workflow}/link-github`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Get the metrics for a workflow version
+         *
+         * @tags Workflow
+         * @name WorkflowGetMetrics
+         * @summary Get workflow metrics
+         * @request GET:/api/v1/workflows/{workflow}/metrics
+         * @secure
+         */
+        this.workflowGetMetrics = (workflow, query, params = {}) => this.request(Object.assign({ path: `/api/v1/workflows/${workflow}/metrics`, method: 'GET', query: query, secure: true, format: 'json' }, params));
         /**
          * @description Create a pull request for a workflow
          *
@@ -473,6 +523,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.stepRunUpdateRerun = (tenant, stepRun, data, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/step-runs/${stepRun}/rerun`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Attempts to cancel a step run
+         *
+         * @tags Step Run
+         * @name StepRunUpdateCancel
+         * @summary Attempts to cancel a step run
+         * @request POST:/api/v1/tenants/{tenant}/step-runs/{step-run}/cancel
+         * @secure
+         */
+        this.stepRunUpdateCancel = (tenant, stepRun, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/step-runs/${stepRun}/cancel`, method: 'POST', secure: true, format: 'json' }, params));
         /**
          * @description Get the schema for a step run
          *

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

@@ -98,6 +98,8 @@ export interface User {
     email: string;
     /** Whether the user has verified their email address. */
     emailVerified: boolean;
+    /** Whether the user has a password set. */
+    hasPassword?: boolean;
 }
 export interface UserTenantPublic {
     /**
@@ -117,6 +119,12 @@ export interface UserLoginRequest {
     /** The password of the user. */
     password: string;
 }
+export interface UserChangePasswordRequest {
+    /** The password of the user. */
+    password: string;
+    /** The new password for the user. */
+    newPassword: string;
+}
 export interface UserRegisterRequest {
     /** The name of the user. */
     name: string;
@@ -239,6 +247,11 @@ export interface EventWorkflowRunSummary {
      * @format int64
      */
     running?: number;
+    /**
+     * The number of queued runs.
+     * @format int64
+     */
+    queued?: number;
     /**
      * The number of succeeded runs.
      * @format int64
@@ -403,6 +416,20 @@ export interface WorkflowRun {
     startedAt?: string;
     /** @format date-time */
     finishedAt?: string;
+    /**
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
+     */
+    parentId?: string;
+    /**
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
+     */
+    parentStepRunId?: string;
 }
 export interface WorkflowRunList {
     rows?: WorkflowRun[];
@@ -413,7 +440,8 @@ export declare enum WorkflowRunStatus {
     RUNNING = "RUNNING",
     SUCCEEDED = "SUCCEEDED",
     FAILED = "FAILED",
-    CANCELLED = "CANCELLED"
+    CANCELLED = "CANCELLED",
+    QUEUED = "QUEUED"
 }
 export type WorkflowRunStatusList = WorkflowRunStatus[];
 export declare enum JobRunStatus {
@@ -471,6 +499,7 @@ export interface StepRun {
     step?: Step;
     children?: string[];
     parents?: string[];
+    childWorkflowRuns?: string[];
     workerId?: string;
     input?: string;
     output?: string;
@@ -639,3 +668,29 @@ export declare enum LogLineOrderByDirection {
 }
 export type LogLineSearch = string;
 export type LogLineLevelField = LogLineLevel[];
+export interface SNSIntegration {
+    metadata: APIResourceMeta;
+    /**
+     * The unique identifier for the tenant that the SNS integration belongs to.
+     * @format uuid
+     */
+    tenantId: string;
+    /** The Amazon Resource Name (ARN) of the SNS topic. */
+    topicArn: string;
+    /** The URL to send SNS messages to. */
+    ingestUrl?: string;
+}
+export interface ListSNSIntegrations {
+    pagination: PaginationResponse;
+    rows: SNSIntegration[];
+}
+export interface CreateSNSIntegrationRequest {
+    /** The Amazon Resource Name (ARN) of the SNS topic. */
+    topicArn: string;
+}
+export interface WorkflowMetrics {
+    /** The number of runs for a specific group key (passed via filter) */
+    groupKeyRunsCount?: number;
+    /** The total number of concurrency group keys. */
+    groupKeyCount?: number;
+}

package/clients/rest/generated/data-contracts.js

@@ -33,6 +33,7 @@ var WorkflowRunStatus;
     WorkflowRunStatus["SUCCEEDED"] = "SUCCEEDED";
     WorkflowRunStatus["FAILED"] = "FAILED";
     WorkflowRunStatus["CANCELLED"] = "CANCELLED";
+    WorkflowRunStatus["QUEUED"] = "QUEUED";
 })(WorkflowRunStatus || (exports.WorkflowRunStatus = WorkflowRunStatus = {}));
 var JobRunStatus;
 (function (JobRunStatus) {

package/package.json

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

package/step.d.ts

@@ -82,6 +82,7 @@ export declare class Context<T, K> {
     stepOutput(step: string): NextStep;
     triggeredByEvent(): boolean;
     workflowInput(): T;
+    workflowName(): string;
     userData(): K;
     stepName(): string;
     workflowRunId(): string;

package/step.js

@@ -157,6 +157,9 @@ class Context {
     workflowInput() {
         return this.input;
     }
+    workflowName() {
+        return this.action.jobName;
+    }
     userData() {
         var _a;
         return (_a = this.data) === null || _a === void 0 ? void 0 : _a.user_data;