@devmoods/express-extras 0.35.0 → 0.36.0

package/dist/faktory.d.ts

@@ -1,31 +1,28 @@
-import { create } from 'faktory-worker';
+import { create, type WorkerOptions } from 'faktory-worker';
 export interface JobsOptions {
     queueName: string;
     faktory?: typeof create;
 }
-interface JobContext {
-    [key: string]: any;
-}
-export declare function createJobs({ queueName, faktory: createFactory, }: JobsOptions): {
-    job: <K extends Record<string, any>, T extends (input: K, ctx: JobContext) => undefined | Promise<any>>(fn: T) => {
+export type JobContext = Record<string, any>;
+export declare function createJobs<GlobalContext extends JobContext>({ queueName, faktory: createFactory, }: JobsOptions): {
+    job: <K extends Record<string, any>, T extends (input: K, ctx: GlobalContext) => undefined | Promise<any>>(fn: T) => {
         $job: boolean;
         jobName: string;
         readonly executionCount: number;
         delay(args?: Parameters<T>[0]): Promise<`${string}-${string}-${string}-${string}-${string}`>;
-        execute(args: Parameters<T>[0], context: JobContext): Promise<any>;
+        execute(args: Parameters<T>[0], context: GlobalContext): Promise<any>;
     };
     queueName: string;
 };
 export type Job = ReturnType<ReturnType<typeof createJobs>['job']>;
-export interface FaktoryWorkerOptions {
+export interface FaktoryWorkerOptions<GlobalContext> {
     jobs: unknown[];
     queueName: string;
     faktory?: typeof create;
-    jobContext?: JobContext;
+    jobContext?: GlobalContext;
 }
 export declare function useJobId(): string | undefined;
-export declare function createFaktoryWorker({ queueName, jobs, faktory: createFactory, jobContext, }: FaktoryWorkerOptions): Promise<{
-    start(): Promise<void>;
+export declare function createFaktoryWorker<GlobalContext>({ queueName, jobs, faktory: createFactory, jobContext, }: FaktoryWorkerOptions<GlobalContext>): Promise<{
+    start(workerOptions?: WorkerOptions): Promise<void>;
     stop(): Promise<void>;
 }>;
-export {};

package/dist/faktory.js

@@ -61,7 +61,7 @@ export function useJobId() {
         return store.get(JOB_ID);
     }
 }
-export async function createFaktoryWorker({ queueName, jobs, faktory: createFactory = create, jobContext = {}, }) {
+export async function createFaktoryWorker({ queueName, jobs, faktory: createFactory = create, jobContext, }) {
     const faktory = createFactory();
     const filter = (j) => !!Object.prototype.hasOwnProperty.call(j, '$job');
     const availableJobs = jobs.filter(filter);
@@ -71,7 +71,7 @@ export async function createFaktoryWorker({ queueName, jobs, faktory: createFact
         });
     }
     return {
-        async start() {
+        async start(workerOptions = {}) {
             try {
                 logger.info('faktory started', {
                     queueName,
@@ -96,6 +96,7 @@ export async function createFaktoryWorker({ queueName, jobs, faktory: createFact
                 });
                 await faktory.work({
                     queues: [queueName],
+                    ...workerOptions,
                 });
             }
             catch (error) {

package/dist/listen.d.ts

@@ -7,7 +7,7 @@ interface StoppableServer extends Server {
 export declare function stoppable(server: Server, grace?: number): StoppableServer;
 interface ExpressServerOptions {
     onShutdown?(): Promise<void> | void;
-    healthCheck?(): Promise<unknown>;
+    healthCheck?(type?: 'live' | 'ready'): Promise<unknown>;
 }
 export declare function createExpressServer(app: Application, options?: ExpressServerOptions): {
     start(): Promise<void>;

package/dist/listen.js

@@ -6,6 +6,7 @@ import {} from 'express';
 import { getLogger } from './logger.js';
 import { before, route } from './middleware.js';
 import { envPort, readEnv } from './utils.js';
+import { validateQuery } from './validate.js';
 const logger = getLogger('http');
 const READINESS_PERIOD = readEnv.number('READINESS_PERIOD_MS', 0);
 const GRACE_PERIOD = readEnv.number('GRACE_PERIOD_MS', 20000);
@@ -96,16 +97,23 @@ export function createExpressServer(app, options = {}) {
         process.on(signal, onSignal);
     }
     if (!app.get('__healthAttached')) {
-        app.get('/health', before(), route(async () => {
+        app.get('/health', before(), validateQuery({
+            type: 'object',
+            properties: {
+                type: { type: 'string', enum: ['live', 'ready'] },
+            },
+        }), route(async (req) => {
             const timestamp = new Date().toISOString();
             try {
                 if (stopping) {
                     throw new Error();
                 }
-                const meta = await options.healthCheck?.();
-                return { status: 'ok', meta, timestamp };
+                const type = req.query.type;
+                const meta = await options.healthCheck?.(type);
+                return { status: 'ok', type, meta, timestamp };
             }
-            catch {
+            catch (error) {
+                logger.error(error, 'Failed health check');
                 return [503, { status: 'error', timestamp }];
             }
         }));

package/dist/redis.js

@@ -2,8 +2,10 @@ import { createClient } from 'redis';
 import { readEnv } from './utils.js';
 export function createRedis({ url = readEnv('REDIS_URL', ''), onError, } = {}) {
     const client = createClient({ url });
-    if (onError) {
-        client.on('error', onError);
-    }
+    // Always attach a listener even if
+    // onError is not provided.
+    client.on('error', (error) => {
+        onError?.(error);
+    });
     return client;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devmoods/express-extras",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "description": "Kubernetes-ready utilities for rapid Node.js application development",
   "type": "module",
   "main": "./dist/index.js",