@devmoods/express-extras 0.33.1 → 0.35.0

package/README.md

@@ -8,13 +8,14 @@ _Extremely opinionated_ set of utilities for cranking out production-ready Node.
 - Thin layer on top of [Express](https://expressjs.com) with better support for `async`/`await`
 - PostgreSQL with transactions and migrations
 - Redis
-- Slack (and Discord) client for sending notifications
+- Slack (and Discord) client for sending operational notifications
+- CLI commands inspired by Django's management commands
 - Delayed jobs with [Faktory](https://contribsys.com/faktory/)
-- Validation of HTTP requests using [JSON Schemas](https://json-schema.org/)
+- Validation of HTTP requests using [JSON Schema](https://json-schema.org/)s
 - Logging helpers to write well-formatted contextual JSON logs to `stdout`
-- Request local context using [AsyncLocalStorage](https://nodejs.org/api/async_context.html)
+- Request local context using [AsyncLocalStorage](https://nodejs.org/api/async_context.html) (e.g. request ids)
 - [RFC 7807 Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) by default
-- Works best with the [PnPM](https://pnpm.io/) package manager
+- Works best with the [pnpm](https://pnpm.io/) package manager
 - Uses [Sentry](https://sentry.io/) for external error monitoring
 - Inspired by [The Twelve-Factor App](https://12factor.net/)
   - Graceful shutdown

package/dist/errors.d.ts

@@ -36,4 +36,4 @@ export interface ErrorHandlerOptions {
  *
  * Composed together with the Sentry error handler.
  */
-export declare function errorHandler({ onError }: ErrorHandlerOptions): import("compose-middleware").ErrorHandler<unknown, unknown, void>;
+export declare function errorHandler({ onError }?: ErrorHandlerOptions): import("compose-middleware").ErrorHandler<unknown, unknown, void>;

package/dist/errors.js

@@ -2,6 +2,7 @@ import { STATUS_CODES } from 'node:http';
 import * as Sentry from '@sentry/node';
 import { errors } from 'compose-middleware';
 import {} from 'express';
+import { getLogger } from './logger.js';
 import { DoesNotExistError, IntegrityError } from './postgres.js';
 export class ApiError extends Error {
 }
@@ -62,7 +63,18 @@ function _errorHandler({ onError }) {
  *
  * Composed together with the Sentry error handler.
  */
-export function errorHandler({ onError }) {
+export function errorHandler({ onError } = {}) {
+    const logger = getLogger();
+    const _defaultErrorHandler = (error) => {
+        if (error instanceof ApiError && error.status < 500) {
+            logger.warn(`${error.status}: ${error.message}`, {
+                reason: error.payload,
+            });
+        }
+        else {
+            logger.error(error);
+        }
+    };
     return errors([
         Sentry.expressErrorHandler({
             shouldHandleError(error) {
@@ -72,6 +84,6 @@ export function errorHandler({ onError }) {
                 return process.env.NODE_ENV === 'production';
             },
         }),
-        _errorHandler({ onError }),
+        _errorHandler({ onError: onError || _defaultErrorHandler }),
     ]);
 }

package/dist/faktory.d.ts

@@ -3,13 +3,16 @@ 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) => undefined | Promise<any>>(fn: T) => {
+    job: <K extends Record<string, any>, T extends (input: K, ctx: JobContext) => 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]): Promise<any>;
+        execute(args: Parameters<T>[0], context: JobContext): Promise<any>;
     };
     queueName: string;
 };
@@ -18,9 +21,11 @@ export interface FaktoryWorkerOptions {
     jobs: unknown[];
     queueName: string;
     faktory?: typeof create;
+    jobContext?: JobContext;
 }
 export declare function useJobId(): string | undefined;
-export declare function createFaktoryWorker({ queueName, jobs, faktory: createFactory, }: FaktoryWorkerOptions): Promise<{
+export declare function createFaktoryWorker({ queueName, jobs, faktory: createFactory, jobContext, }: FaktoryWorkerOptions): Promise<{
     start(): Promise<void>;
     stop(): Promise<void>;
 }>;
+export {};

package/dist/faktory.js

@@ -39,9 +39,9 @@ export function createJobs({ queueName, faktory: createFactory = create, }) {
                 }
                 return jid;
             },
-            async execute(args) {
+            async execute(args, context) {
                 try {
-                    const result = await fn(args);
+                    const result = await fn(args, context);
                     executionCount += 1;
                     return result;
                 }
@@ -61,12 +61,14 @@ export function useJobId() {
         return store.get(JOB_ID);
     }
 }
-export async function createFaktoryWorker({ queueName, jobs, faktory: createFactory = create, }) {
+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);
     for (const job of availableJobs) {
-        faktory.register(job.jobName, job.execute);
+        faktory.register(job.jobName, (...args) => {
+            return job.execute(...args, jobContext);
+        });
     }
     return {
         async start() {

package/dist/listen.js

@@ -95,19 +95,22 @@ export function createExpressServer(app, options = {}) {
     for (const signal of ['SIGTERM', 'SIGINT']) {
         process.on(signal, onSignal);
     }
-    app.get('/health', before(), route(async () => {
-        const timestamp = new Date().toISOString();
-        try {
-            if (stopping) {
-                throw new Error();
+    if (!app.get('__healthAttached')) {
+        app.get('/health', before(), route(async () => {
+            const timestamp = new Date().toISOString();
+            try {
+                if (stopping) {
+                    throw new Error();
+                }
+                const meta = await options.healthCheck?.();
+                return { status: 'ok', meta, timestamp };
             }
-            const meta = await options.healthCheck?.();
-            return { status: 'ok', meta, timestamp };
-        }
-        catch {
-            return [503, { status: 'error', timestamp }];
-        }
-    }));
+            catch {
+                return [503, { status: 'error', timestamp }];
+            }
+        }));
+        app.set('__healthAttached', true);
+    }
     return {
         start() {
             const port = app.get('port') ?? envPort(0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devmoods/express-extras",
-  "version": "0.33.1",
+  "version": "0.35.0",
   "description": "Kubernetes-ready utilities for rapid Node.js application development",
   "type": "module",
   "main": "./dist/index.js",
@@ -33,8 +33,10 @@
     "prettier": "3.3.3",
     "supertest": "7.0.0",
     "ts-node": "10.9.2",
+    "tsx": "^4.19.1",
     "typescript": "5.6.3",
-    "vitest": "^2.1.2"
+    "vitest": "^2.1.2",
+    "vitest-fail-on-console": "^0.7.1"
   },
   "dependencies": {
     "@devmoods/fetch": "^4.0.1",
@@ -60,13 +62,11 @@
     "express-route-parser": "^1.0.5",
     "helmet": "^8.0.0",
     "jsonwebtoken": "^9.0.2",
-    "meow": "^13.2.0",
     "nodemailer": "^6.9.15",
     "pg": "^8.13.0",
     "redis": "^4.7.0",
     "sql-template-strings": "^2.2.2",
-    "uuid": "^10.0.0",
-    "vitest-fail-on-console": "^0.7.1"
+    "uuid": "^10.0.0"
   },
   "prettier": {
     "singleQuote": true
@@ -81,10 +81,10 @@
     "node": ">=20.3.0 <23"
   },
   "scripts": {
-    "start": "node --no-warnings --enable-source-maps --loader ts-node/esm example/src/index.ts --name example",
-    "start:worker": "node --no-warnings --enable-source-maps --loader ts-node/esm example/worker.ts",
+    "start": "pushd example; pnpm run start; popd example;",
+    "start:worker": "pushd example; pnpm run start:worker; popd example;",
     "clean": "rm -rf dist",
-    "lint": "eslint src example",
+    "lint": "eslint src example/src",
     "test": "./test.sh",
     "build": "pnpm run clean && tsc --project tsconfig.build.json",
     "format": "prettier --write '**/*.{js,css,md,ts,tsx}'"