feat: add health and metrics api on typescript sdk worker (#2457)

* feat: add health and metrics api on typescript sdk worker

add: prom-client to fetch metrics data
add: track health status of worker across different states

* refactor: keep prom-client as optional dependency

* refactor: remove async import of prom-client

* chore: update package version for ts sdk

* fix: lint

* fix: lint, const enum

---------

Co-authored-by: mrkaye97 <[email protected]>

Author: jishnundth

sdks/typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.9.8",
+  "version": "1.10.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -91,5 +91,8 @@
     "yaml": "^2.7.1",
     "zod": "^3.24.2"
   },
+  "optionalDependencies": {
+    "prom-client": "^15.1.3"
+  },
   "packageManager": "[email protected]"
 }

sdks/typescript/pnpm-lock.yaml

@@ -10,9 +10,15 @@ const ClientTLSConfigSchema = z.object({
   server_name: z.string().optional(),
 });
 
+const HealthcheckConfigSchema = z.object({
+  enabled: z.boolean().optional().default(false),
+  port: z.number().optional().default(8001),
+});
+
 export const ClientConfigSchema = z.object({
   token: z.string(),
   tls_config: ClientTLSConfigSchema,
+  healthcheck: HealthcheckConfigSchema.optional(),
   host_port: z.string(),
   api_url: z.string(),
   log_level: z.enum(['OFF', 'DEBUG', 'INFO', 'WARN', 'ERROR']).optional(),

sdks/typescript/src/clients/hatchet-client/client-config.ts

@@ -6,3 +6,6 @@ tls_config:
   key_file: 'TLS_KEY_FILE_YAML'
   ca_file: 'TLS_ROOT_CA_FILE_YAML'
   server_name: 'TLS_SERVER_NAME_YAML'
+healthcheck:
+  enabled: true
+  port: 8005

sdks/typescript/src/clients/hatchet-client/fixtures/.hatchet.yaml

@@ -25,6 +25,10 @@ describe('Client', () => {
           server_name: 'TLS_SERVER_NAME',
           tls_strategy: 'tls',
         },
+        healthcheck: {
+          enabled: true,
+          port: 8002,
+        },
       },
       {
         credentials: ChannelCredentials.createInsecure(),
@@ -47,6 +51,10 @@ describe('Client', () => {
           ca_file: 'TLS_ROOT_CA_FILE',
           server_name: 'TLS_SERVER_NAME',
         },
+        healthcheck: {
+          enabled: true,
+          port: 8002,
+        },
       })
     );
   });
@@ -78,6 +86,10 @@ describe('Client', () => {
           server_name: 'TLS_SERVER_NAME',
           tls_strategy: 'tls',
         },
+        healthcheck: {
+          enabled: false,
+          port: 8003,
+        },
       },
       {
         config_path: './fixtures/.hatchet.yaml',
@@ -101,6 +113,10 @@ describe('Client', () => {
           ca_file: 'TLS_ROOT_CA_FILE',
           server_name: 'TLS_SERVER_NAME',
         },
+        healthcheck: {
+          enabled: false,
+          port: 8003,
+        },
       })
     );
   });

sdks/typescript/src/clients/hatchet-client/hatchet-client.test.ts

@@ -8,6 +8,8 @@ fdescribe('ConfigLoader', () => {
     process.env.HATCHET_CLIENT_TLS_KEY_FILE = 'TLS_KEY_FILE';
     process.env.HATCHET_CLIENT_TLS_ROOT_CA_FILE = 'TLS_ROOT_CA_FILE';
     process.env.HATCHET_CLIENT_TLS_SERVER_NAME = 'TLS_SERVER_NAME';
+    process.env.HATCHET_CLIENT_WORKER_HEALTHCHECK_ENABLED = 'true';
+    process.env.HATCHET_CLIENT_WORKER_HEALTHCHECK_PORT = '8001';
   });
 
   it('should load from environment variables', () => {
@@ -27,6 +29,10 @@ fdescribe('ConfigLoader', () => {
         ca_file: 'TLS_ROOT_CA_FILE',
         server_name: 'TLS_SERVER_NAME',
       },
+      healthcheck: {
+        enabled: true,
+        port: 8001,
+      },
     });
   });
 
@@ -75,6 +81,10 @@ fdescribe('ConfigLoader', () => {
         ca_file: 'TLS_ROOT_CA_FILE_YAML',
         server_name: 'TLS_SERVER_NAME_YAML',
       },
+      healthcheck: {
+        enabled: true,
+        port: 8002,
+      },
     });
   });
 
@@ -97,6 +107,10 @@ fdescribe('ConfigLoader', () => {
         ca_file: 'TLS_ROOT_CA_FILE_YAML',
         server_name: 'TLS_SERVER_NAME_YAML',
       },
+      healthcheck: {
+        enabled: true,
+        port: 8002,
+      },
     });
   });
 });

sdks/typescript/src/util/config-loader/config-loader.test.ts

@@ -17,7 +17,9 @@ type EnvVars =
   | 'HATCHET_CLIENT_TLS_ROOT_CA_FILE'
   | 'HATCHET_CLIENT_TLS_SERVER_NAME'
   | 'HATCHET_CLIENT_LOG_LEVEL'
-  | 'HATCHET_CLIENT_NAMESPACE';
+  | 'HATCHET_CLIENT_NAMESPACE'
+  | 'HATCHET_CLIENT_WORKER_HEALTHCHECK_ENABLED'
+  | 'HATCHET_CLIENT_WORKER_HEALTHCHECK_PORT';
 
 type TLSStrategy = 'tls' | 'mtls';
 
@@ -46,6 +48,12 @@ export class ConfigLoader {
 
     const token = override?.token ?? yaml?.token ?? this.env('HATCHET_CLIENT_TOKEN');
 
+    const healthCheckConfig = override?.healthcheck ??
+      yaml?.healthcheck ?? {
+        enabled: this.env('HATCHET_CLIENT_WORKER_HEALTHCHECK_ENABLED') === 'true',
+        port: parseInt(this.env('HATCHET_CLIENT_WORKER_HEALTHCHECK_PORT') || '8001', 10),
+      };
+
     if (!token) {
       throw new Error(
         'No token provided. Provide it by setting the HATCHET_CLIENT_TOKEN environment variable.'
@@ -91,6 +99,7 @@ export class ConfigLoader {
       host_port: grpcBroadcastAddress,
       api_url: apiUrl,
       tls_config: tlsConfig,
+      healthcheck: healthCheckConfig,
       log_level:
         override?.log_level ??
         yaml?.log_level ??

sdks/typescript/src/util/config-loader/config-loader.ts

@@ -6,3 +6,6 @@ tls_config:
   key_file: 'TLS_KEY_FILE_YAML'
   ca_file: 'TLS_ROOT_CA_FILE_YAML'
   server_name: 'TLS_SERVER_NAME_YAML'
+healthcheck:
+  enabled: true
+  port: 8002