@devmoods/express-extras 0.26.2 → 0.27.0

package/dist/__tests__/__migrations__/1_a.js

@@ -1,3 +1,4 @@
+import {} from '../../postgres.js';
 export async function up(query) {
     await query('CREATE TABLE baz (id serial primary key)');
     await query('CREATE TABLE foo (id serial primary key)');

package/dist/auth.d.ts

@@ -7,7 +7,7 @@ export declare function createAuthToken(payload: any, secret?: string): string;
 /**
  * Decode the given JWT token.
  */
-export declare function decodeAuthToken(token: string): {
+export declare function decodeAuthToken(token: string, secret?: string): {
     [x: string]: any;
     iss?: string | undefined;
     sub?: string | undefined;

package/dist/auth.js

@@ -29,9 +29,10 @@ export function createAuthToken(payload, secret = AUTH_SECRET) {
 /**
  * Decode the given JWT token.
  */
-export function decodeAuthToken(token) {
+export function decodeAuthToken(token, secret = AUTH_SECRET) {
     try {
-        const decoded = jwt.verify(token.trim(), AUTH_SECRET);
+        const decoded = jwt.verify(token.trim(), secret);
+        /* c8 ignore next 3 */
         if (typeof decoded === 'string') {
             throw new Error('decoded value not an object');
         }

package/dist/cache.js

@@ -1,3 +1,4 @@
+import {} from './redis.js';
 export function createRedisCacheAdapter(redis) {
     return {
         async get(key) {

package/dist/context.js

@@ -1,4 +1,5 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
+import {} from 'express';
 import { v4 as uuid } from 'uuid';
 const requestContext = new AsyncLocalStorage();
 const REQUEST_ID = 'requestId';

package/dist/email.d.ts

@@ -13,4 +13,5 @@ export interface SendEmailOptions extends nodemailer.SendMailOptions {
 export declare function createEmail({ host, port, user, pass, senderName, senderAddress, }: EmailOptions): {
     send: ({ to, subject, message, ...rest }: SendEmailOptions) => Promise<void>;
     transporter: nodemailer.Transporter<import("nodemailer/lib/smtp-transport/index.js").SentMessageInfo>;
+    readonly outbox: Record<string, any>[];
 };

package/dist/email.js

@@ -1,5 +1,6 @@
 import * as nodemailer from 'nodemailer';
 import { getLogger } from './logger.js';
+const logger = getLogger('email');
 export function createEmail({ host, port, user, pass, senderName, senderAddress, }) {
     const transporter = nodemailer.createTransport({
         host,
@@ -7,15 +8,27 @@ export function createEmail({ host, port, user, pass, senderName, senderAddress,
         secure: false,
         auth: { user, pass },
     });
+    const outbox = [];
     const send = async ({ to, subject, message, ...rest }) => {
-        const result = await transporter.sendMail({
+        const payload = {
             from: `${senderName} <${senderAddress}>`,
             to,
             subject,
             text: message,
             ...rest,
-        });
-        getLogger('email').info('email-sent', { email: result });
+        };
+        const result = await transporter.sendMail(payload);
+        outbox.push(payload);
+        if (outbox.length > 5) {
+            outbox.shift();
+        }
+        logger.info('email-sent', { email: result });
+    };
+    return {
+        send,
+        transporter,
+        get outbox() {
+            return outbox;
+        },
     };
-    return { send, transporter };
 }

package/dist/errors.js

@@ -1,6 +1,6 @@
-import { STATUS_CODES } from 'node:http';
 import * as Sentry from '@sentry/node';
 import { errors } from 'compose-middleware';
+import { STATUS_CODES } from 'node:http';
 import { DoesNotExistError, IntegrityError } from './postgres.js';
 export class ApiError extends Error {
 }
@@ -20,14 +20,15 @@ export function makeError(status, detail, payload) {
 }
 export function mapToProblem(error) {
     if (error instanceof ApiError) {
-        const statusMessage = STATUS_CODES[error.status || '500'];
+        const status = error.status || 500;
+        const statusMessage = STATUS_CODES[status];
         return {
             type: `/api/problems/${statusMessage
                 .toLocaleLowerCase()
                 .replace(/ /g, '-')}`,
             title: statusMessage,
-            detail: error.message,
-            status: error.status,
+            detail: error.message || '',
+            status,
             ...error.payload,
         };
     }
@@ -35,6 +36,7 @@ export function mapToProblem(error) {
         type: 'internal-error',
         title: 'Internal Server Error',
         status: 500,
+        detail: '',
     };
 }
 function convertToAPIError(error) {
@@ -48,9 +50,6 @@ function convertToAPIError(error) {
 }
 function _errorHandler({ onError }) {
     return (err, req, res, next) => {
-        if (!err) {
-            err = makeError(500);
-        }
         onError?.(err);
         const apiError = convertToAPIError(err);
         const problem = mapToProblem(apiError);

package/dist/faktory.d.ts

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

package/dist/faktory.js

@@ -5,12 +5,12 @@ import { getLogger } from './logger.js';
 import { startTimer } from './utils.js';
 const logger = getLogger('faktory');
 const JOB_ID = 'jobId';
-export function createJobs({ queueName }) {
-    const faktory = create();
+export function createJobs({ queueName, faktory: createFactory = create, }) {
+    const faktory = createFactory();
     function job(fn) {
         const jobName = fn.name;
         let executionCount = 0;
-        if (jobName == null) {
+        if (!jobName) {
             throw new Error('Can not create job without a name');
         }
         return {
@@ -35,7 +35,9 @@ export function createJobs({ queueName }) {
                         jobName,
                         args: JSON.stringify(args),
                     });
+                    throw error;
                 }
+                return jid;
             },
             async execute(args) {
                 try {
@@ -59,8 +61,8 @@ export function useJobId() {
         return store.get(JOB_ID);
     }
 }
-export async function createFaktoryWorker({ queueName, jobs, }) {
-    const faktory = create();
+export async function createFaktoryWorker({ queueName, jobs, faktory: createFactory = create, }) {
+    const faktory = createFactory();
     const filter = (j) => !!Object.prototype.hasOwnProperty.call(j, '$job');
     const availableJobs = jobs.filter(filter);
     for (const job of availableJobs) {
@@ -99,5 +101,8 @@ export async function createFaktoryWorker({ queueName, jobs, }) {
                 process.exit(1);
             }
         },
+        async stop() {
+            return faktory.stop();
+        },
     };
 }

package/dist/listen.d.ts

@@ -2,9 +2,7 @@
 import type * as http from 'node:http';
 /**
  * Listen on the given port and setup proper signal
- * handlers for terminating the process properly.
- *
- * Kubernetes friendly.
+ * handlers for terminating the process gracefully.
  */
 export declare function listen(server: http.Server, options: {
     port: number;

package/dist/listen.js

@@ -6,9 +6,7 @@ const READINESS_PERIOD_MS = readEnv.number('READINESS_PERIOD_MS', 0);
 const FORCE_EXIT_TIMEOUT = readEnv.number('FORCE_EXIT_TIMEOUT', 5000);
 /**
  * Listen on the given port and setup proper signal
- * handlers for terminating the process properly.
- *
- * Kubernetes friendly.
+ * handlers for terminating the process gracefully.
  */
 export function listen(server, options) {
     createTerminus(server, {

package/dist/logger.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
+import type { Duplex } from 'node:stream';
 import type { CreateSentry } from './sentry.js';
 export type LoggerContext = Record<string, any>;
 export interface LoggerOptions {
@@ -14,7 +15,7 @@ export interface LoggerOptions {
      * Defaults to `process.env.NODE_ENV === 'test'`
      */
     silent?: () => boolean;
-    output?: NodeJS.WriteStream;
+    output?: Duplex;
 }
 export declare function attachSentryClientToLoggers(sentryClient: CreateSentry['client']): void;
 export declare function setGlobalLoggerContext(getContext: () => LoggerContext): void;

package/dist/logger.js

@@ -24,7 +24,7 @@ function defaultGetContext() {
         ..._globalGetContext?.(),
     };
 }
-export function createLogger({ name, getContext, silent = () => process.env.NODE_ENV === 'test', output = process.stdout, }) {
+export function createLogger({ name, getContext, silent = () => false, output = process.stdout, }) {
     if (_loggers.has(name)) {
         throw new Error(`A logger named ${name} already exists`);
     }

package/dist/migrate.d.ts

@@ -10,6 +10,7 @@ interface MigrationFileAPI {
     down(fn: any): Promise<string> | Promise<void> | string | void;
 }
 export declare function cli(): Promise<void>;
+export declare function runCli(input: string[], flags: Record<string, any>, showHelp?: () => void): Promise<number>;
 export interface MigratorOptions {
     postgres?: ReturnType<typeof createPostgres>;
     migrationTableName?: string;

package/dist/migrate.js

@@ -14,8 +14,29 @@ Usage
         description: 'PostgreSQL migration tool',
         importMeta: import.meta,
     });
-    const verbose = !cli.flags.silent;
-    const args = cli.input.slice();
+    let exitCode = 0;
+    try {
+        exitCode = await runCli(cli.input, cli.flags, () => cli.showHelp());
+    }
+    catch (error) {
+        if (error instanceof CliError) {
+            exitCode = error.code;
+        }
+    }
+    finally {
+        process.exit(exitCode);
+    }
+}
+class CliError extends Error {
+    constructor(message, code) {
+        super(message);
+        this.code = code;
+        this.code = code;
+    }
+}
+export async function runCli(input, flags, showHelp) {
+    const verbose = !flags.silent;
+    const args = input.slice();
     const action = args.shift();
     function isValidAction(action) {
         return action != null && ['init', 'up', 'down', 'create'].includes(action);
@@ -24,8 +45,8 @@ Usage
     async function run(action, ...args) {
         try {
             if (!isValidAction(action)) {
-                cli.showHelp();
-                return;
+                showHelp?.();
+                throw new CliError(`Invalid action ${action}`, 2);
             }
             switch (action) {
                 case 'up':
@@ -43,20 +64,19 @@ Usage
                     break;
                 }
                 case 'create': {
-                    const createdMigration = await migrator.create(args[0], cli.flags.typescript ? 'ts' : 'sql');
+                    const createdMigration = await migrator.create(args[0], flags.typescript ? 'ts' : 'sql');
                     migrator.log(chalk.green('Created migration', createdMigration));
                     break;
                 }
             }
+            return 0;
         }
         catch (error) {
             console.error(chalk.red(error.message));
-        }
-        finally {
-            process.exit(0);
+            throw new CliError(error.message, 1);
         }
     }
-    run(action, ...args);
+    return run(action, ...args);
 }
 export class Migrator {
     constructor({ postgres = createPostgres(), pathToMigrations = path.resolve(process.cwd(), 'db', 'migrations'), migrationTableName = 'migrations', verbose = true, } = {}) {
@@ -136,9 +156,6 @@ export class Migrator {
             for (const migration of pendingMigrations) {
                 this.log('Running migration', migration.filename);
                 const migrator = await this.readMigrationFile(migration.filename);
-                if (!migrator.up || !migrator.down) {
-                    throw new Error('Migrations must export both an up() and a down() function.');
-                }
                 if (migrator.useTransaction !== false) {
                     await this.postgres.transaction(async (tx) => {
                         await this.migrate(tx, migrator, direction);
@@ -166,9 +183,6 @@ export class Migrator {
             }
             this.log('Rolling back migration', migrationToRollback.filename);
             const migrator = await this.readMigrationFile(migrationToRollback.filename);
-            if (!migrator.up || !migrator.down) {
-                throw new Error('Migrations must export both an up() and a down() function.');
-            }
             if (migrator.useTransaction !== false) {
                 await this.postgres.transaction(async (tx) => {
                     await this.migrate(tx, migrator, 'down');
@@ -182,6 +196,7 @@ export class Migrator {
                 });
             }
             return await this.getCurrentVersion();
+            /* c8 ignore next 2 */
         }
         throw new Error(`Invalid direction ${direction}`);
     }
@@ -216,6 +231,7 @@ export class Migrator {
             else {
                 await returnValue;
             }
+            /* c8 ignore next 3 */
         }
         catch (error) {
             throw new Error(`Migration failed: ${error.message}`);
@@ -230,7 +246,7 @@ export class Migrator {
     }
     async getMigrations() {
         const files = await fs.readdir(this.pathToMigrations);
-        return (files || [])
+        return files
             .map((filename) => filename.match(this.filenameRegExp))
             .filter(notNullOrUndefined)
             .map(([filename, version, name]) => ({

package/dist/postgres.js

@@ -1,4 +1,4 @@
-import pg from 'pg';
+import pg, {} from 'pg';
 import { SQL } from 'sql-template-strings';
 import { readEnv } from './utils.js';
 export class DoesNotExistError extends Error {
@@ -38,6 +38,7 @@ export class Connection {
         const result = await this.client.query(text, values);
         if (result.rows) {
             return result.rows;
+            /* c8 ignore next 2*/
         }
         return [];
     }
@@ -68,9 +69,11 @@ export class Transaction extends Connection {
  *
  * @param config
  */
-export function createPostgres({ onError = () => { }, url = readEnv('POSTGRES_URL'), ...config } = {}) {
+export function createPostgres({ onError, url = readEnv('POSTGRES_URL'), ...config } = {}) {
     const pool = new pg.Pool({ connectionString: url, ...config });
-    pool.on('error', onError);
+    if (onError) {
+        pool.on('error', onError);
+    }
     async function withConnection(callback) {
         const client = await pool.connect();
         try {
@@ -106,6 +109,7 @@ export function createPostgres({ onError = () => { }, url = readEnv('POSTGRES_UR
         catch (error) {
             await client.query('ROLLBACK');
             throw error;
+            /* c8 ignore next 3 */
         }
         finally {
             client.release();

package/dist/redis.d.ts

@@ -1,7 +1,7 @@
 import { createClient } from 'redis';
 export interface RedisOptions {
     url?: string;
-    onError: (error: Error) => void;
+    onError?: (error: Error) => void;
 }
 export type RedisClient = ReturnType<typeof createClient>;
-export declare function createRedis({ url, onError, }: RedisOptions): RedisClient;
+export declare function createRedis({ url, onError, }?: RedisOptions): RedisClient;

package/dist/redis.js

@@ -1,7 +1,9 @@
 import { createClient } from 'redis';
 import { readEnv } from './utils.js';
-export function createRedis({ url = readEnv('REDIS_URL', ''), onError, }) {
+export function createRedis({ url = readEnv('REDIS_URL', ''), onError, } = {}) {
     const client = createClient({ url });
-    client.on('error', onError);
+    if (onError) {
+        client.on('error', onError);
+    }
     return client;
 }

package/dist/sentry.js

@@ -1,4 +1,5 @@
 import * as Sentry from '@sentry/node';
+import {} from 'express';
 import { attachSentryClientToLoggers } from './logger.js';
 import { readEnv } from './utils.js';
 /**

package/dist/validate.js

@@ -1,4 +1,5 @@
-import _Ajv from 'ajv';
+import _Ajv, {} from 'ajv';
+import {} from 'express';
 import { BadRequest } from './errors.js';
 const Ajv = _Ajv;
 export function validateBody(schema) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devmoods/express-extras",
-  "version": "0.26.2",
+  "version": "0.27.0",
   "description": "Kubernetes-ready utilities for rapid Node.js application development",
   "type": "module",
   "main": "./dist/index.js",
@@ -32,6 +32,7 @@
     "@typescript-eslint/parser": "^6.4.1",
     "@vitest/coverage-v8": "^0.34.2",
     "@vitest/expect": "^0.34.2",
+    "@vitest/runner": "^0.34.3",
     "chalk": "^5.3.0",
     "eslint": "^8.47.0",
     "eslint-plugin-jsx-a11y": "^6.7.1",