@drunkcod/express-kit 0.0.12 → 0.0.14

package/lib/cjs/index.d.ts

@@ -1,6 +1,8 @@
 import type express from 'express';
+import { Timespan } from './stopwatch.js';
 export * from '@drunkcod/express-async';
 export * from './loggable.js';
+export * from './stopwatch.js';
 type AsyncFn<T> = () => Promise<T>;
 type ExpressServer = ReturnType<express.Application['listen']>;
 export type ErrorHandler = (error: Error, request: express.Request, response: express.Response, next: express.NextFunction) => void;
@@ -17,3 +19,4 @@ export declare function closeAsync(server: {
     close: (cb: (error?: Error) => void) => void;
 }): Promise<void>;
 export declare function registerShutdown<Server extends ExpressServer = ExpressServer>(server: Server, shutdown?: () => Promise<void>): void;
+export declare function requestTimingMiddleware(onRequestFinish: (req: express.Request, duration: Timespan) => void): (req: express.Request, res: express.Response, next: express.NextFunction) => void;

package/lib/cjs/index.js

@@ -19,8 +19,11 @@ exports.mergeCallsAsync = mergeCallsAsync;
 exports.listenAsync = listenAsync;
 exports.closeAsync = closeAsync;
 exports.registerShutdown = registerShutdown;
+exports.requestTimingMiddleware = requestTimingMiddleware;
+const stopwatch_js_1 = require("./stopwatch.js");
 __exportStar(require("@drunkcod/express-async"), exports);
 __exportStar(require("./loggable.js"), exports);
+__exportStar(require("./stopwatch.js"), exports);
 function onceAsync(fn) {
     let p;
     return () => {
@@ -78,3 +81,10 @@ function registerShutdown(server, shutdown) {
     process.on('SIGINT', onShutdown);
     process.on('SIGTERM', onShutdown);
 }
+function requestTimingMiddleware(onRequestFinish) {
+    return (req, res, next) => {
+        const s = stopwatch_js_1.Stopwatch.startNew();
+        res.on('finish', () => onRequestFinish(req, s.elapsed));
+        next();
+    };
+}

package/lib/cjs/loggable.js

@@ -24,9 +24,7 @@ function asLoggableCause(cause) {
         return asLoggableCause(cause.toJSON());
     if (cause instanceof Error) {
         const { message, stack, cause: innerCause, ...rest } = cause;
-        return innerCause
-            ? { message, stack, cause: asLoggableCause(innerCause), ...rest }
-            : { message, stack, ...rest };
+        return innerCause ? { message, stack, cause: asLoggableCause(innerCause), ...rest } : { message, stack, ...rest };
     }
     if ((0, argis_1.hasOwn)(cause, 'cause')) {
         const { cause: innerCause, ...rest } = cause;
@@ -37,7 +35,7 @@ function asLoggableCause(cause) {
 function asLoggableError(error) {
     if (error instanceof Error)
         return asLoggableCause(error);
-    const r = (error && typeof error === 'object') ? asLoggableCause(error) : { message: error };
+    const r = error && typeof error === 'object' ? asLoggableCause(error) : { message: error };
     Error.captureStackTrace(r, asLoggableError);
     return Object.defineProperty(r, 'stack', { enumerable: true });
 }

package/lib/cjs/stopwatch.d.ts

@@ -0,0 +1,21 @@
+export declare class Stopwatch {
+    #private;
+    private constructor();
+    static startNew(): Stopwatch;
+    get elapsed(): Timespan;
+}
+export declare class Timespan {
+    #private;
+    constructor(value: bigint);
+    get hours(): number;
+    get minutes(): number;
+    get seconds(): number;
+    get milliseconds(): number;
+    static fromSeconds(seconds: number): Timespan;
+    static fromMilliseconds(ms: number): Timespan;
+    get totalMinutes(): number;
+    get totalSeconds(): number;
+    get totalMilliseconds(): number;
+    toString(): string;
+    toDuration(): string;
+}

package/lib/cjs/stopwatch.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Timespan = exports.Stopwatch = void 0;
+class Stopwatch {
+    #startedAt;
+    constructor() {
+        this.#startedAt = process.hrtime.bigint();
+    }
+    static startNew() {
+        return new Stopwatch();
+    }
+    get elapsed() {
+        return new Timespan(process.hrtime.bigint() - this.#startedAt);
+    }
+}
+exports.Stopwatch = Stopwatch;
+class Timespan {
+    #value;
+    constructor(value) {
+        this.#value = value;
+    }
+    get hours() {
+        return Number(this.#value / 1000000000n / 60n / 60n);
+    }
+    get minutes() {
+        return Number((this.#value / 1000000000n / 60n) % 60n);
+    }
+    get seconds() {
+        return Number((this.#value / 1000000000n) % 60n);
+    }
+    get milliseconds() {
+        return Number((this.#value / 1000000n) % 1000n);
+    }
+    static fromSeconds(seconds) {
+        return new Timespan(BigInt(seconds * 1e9));
+    }
+    static fromMilliseconds(ms) {
+        return new Timespan(BigInt(ms * 1e6));
+    }
+    get totalMinutes() {
+        return Number(this.#value) * (1e-9 / 60.0);
+    }
+    get totalSeconds() {
+        return Number(this.#value) * 1e-9;
+    }
+    get totalMilliseconds() {
+        return Number(this.#value) * 1e-6;
+    }
+    toString() {
+        const { hours, minutes, seconds, milliseconds } = this;
+        const padz = (x) => (x < 10 ? '0' + x : x);
+        return `${padz(hours)}:${padz(minutes)}:${padz(seconds)}.${('00' + milliseconds).slice(-3)}`;
+    }
+    toDuration() {
+        return `${this.totalSeconds}s`;
+    }
+}
+exports.Timespan = Timespan;

package/lib/index.d.ts

@@ -1,6 +1,8 @@
 import type express from 'express';
+import { Timespan } from './stopwatch.js';
 export * from '@drunkcod/express-async';
 export * from './loggable.js';
+export * from './stopwatch.js';
 type AsyncFn<T> = () => Promise<T>;
 type ExpressServer = ReturnType<express.Application['listen']>;
 export type ErrorHandler = (error: Error, request: express.Request, response: express.Response, next: express.NextFunction) => void;
@@ -17,3 +19,4 @@ export declare function closeAsync(server: {
     close: (cb: (error?: Error) => void) => void;
 }): Promise<void>;
 export declare function registerShutdown<Server extends ExpressServer = ExpressServer>(server: Server, shutdown?: () => Promise<void>): void;
+export declare function requestTimingMiddleware(onRequestFinish: (req: express.Request, duration: Timespan) => void): (req: express.Request, res: express.Response, next: express.NextFunction) => void;

package/lib/index.js

@@ -1,5 +1,7 @@
+import { Stopwatch } from './stopwatch.js';
 export * from '@drunkcod/express-async';
 export * from './loggable.js';
+export * from './stopwatch.js';
 export function onceAsync(fn) {
     let p;
     return () => {
@@ -57,3 +59,10 @@ export function registerShutdown(server, shutdown) {
     process.on('SIGINT', onShutdown);
     process.on('SIGTERM', onShutdown);
 }
+export function requestTimingMiddleware(onRequestFinish) {
+    return (req, res, next) => {
+        const s = Stopwatch.startNew();
+        res.on('finish', () => onRequestFinish(req, s.elapsed));
+        next();
+    };
+}

package/lib/loggable.js

@@ -1,4 +1,4 @@
-import { hasOwn } from "@drunkcod/argis";
+import { hasOwn } from '@drunkcod/argis';
 export function at(message) {
     const old = Error.stackTraceLimit;
     try {
@@ -19,9 +19,7 @@ function asLoggableCause(cause) {
         return asLoggableCause(cause.toJSON());
     if (cause instanceof Error) {
         const { message, stack, cause: innerCause, ...rest } = cause;
-        return innerCause
-            ? { message, stack, cause: asLoggableCause(innerCause), ...rest }
-            : { message, stack, ...rest };
+        return innerCause ? { message, stack, cause: asLoggableCause(innerCause), ...rest } : { message, stack, ...rest };
     }
     if (hasOwn(cause, 'cause')) {
         const { cause: innerCause, ...rest } = cause;
@@ -32,7 +30,7 @@ function asLoggableCause(cause) {
 export function asLoggableError(error) {
     if (error instanceof Error)
         return asLoggableCause(error);
-    const r = (error && typeof error === 'object') ? asLoggableCause(error) : { message: error };
+    const r = error && typeof error === 'object' ? asLoggableCause(error) : { message: error };
     Error.captureStackTrace(r, asLoggableError);
     return Object.defineProperty(r, 'stack', { enumerable: true });
 }

package/lib/stopwatch.d.ts

@@ -0,0 +1,21 @@
+export declare class Stopwatch {
+    #private;
+    private constructor();
+    static startNew(): Stopwatch;
+    get elapsed(): Timespan;
+}
+export declare class Timespan {
+    #private;
+    constructor(value: bigint);
+    get hours(): number;
+    get minutes(): number;
+    get seconds(): number;
+    get milliseconds(): number;
+    static fromSeconds(seconds: number): Timespan;
+    static fromMilliseconds(ms: number): Timespan;
+    get totalMinutes(): number;
+    get totalSeconds(): number;
+    get totalMilliseconds(): number;
+    toString(): string;
+    toDuration(): string;
+}

package/lib/stopwatch.js

@@ -0,0 +1,53 @@
+export class Stopwatch {
+    #startedAt;
+    constructor() {
+        this.#startedAt = process.hrtime.bigint();
+    }
+    static startNew() {
+        return new Stopwatch();
+    }
+    get elapsed() {
+        return new Timespan(process.hrtime.bigint() - this.#startedAt);
+    }
+}
+export class Timespan {
+    #value;
+    constructor(value) {
+        this.#value = value;
+    }
+    get hours() {
+        return Number(this.#value / 1000000000n / 60n / 60n);
+    }
+    get minutes() {
+        return Number((this.#value / 1000000000n / 60n) % 60n);
+    }
+    get seconds() {
+        return Number((this.#value / 1000000000n) % 60n);
+    }
+    get milliseconds() {
+        return Number((this.#value / 1000000n) % 1000n);
+    }
+    static fromSeconds(seconds) {
+        return new Timespan(BigInt(seconds * 1e9));
+    }
+    static fromMilliseconds(ms) {
+        return new Timespan(BigInt(ms * 1e6));
+    }
+    get totalMinutes() {
+        return Number(this.#value) * (1e-9 / 60.0);
+    }
+    get totalSeconds() {
+        return Number(this.#value) * 1e-9;
+    }
+    get totalMilliseconds() {
+        return Number(this.#value) * 1e-6;
+    }
+    toString() {
+        const { hours, minutes, seconds, milliseconds } = this;
+        const padz = (x) => (x < 10 ? '0' + x : x);
+        return `${padz(hours)}:${padz(minutes)}:${padz(seconds)}.${('00' + milliseconds).slice(-3)}`;
+    }
+    toDuration() {
+        return `${this.totalSeconds}s`;
+    }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@drunkcod/express-kit",
   "type": "module",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Express4 utility things",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -40,7 +40,7 @@
   ],
   "dependencies": {
     "@drunkcod/argis": "^0.0.7",
-    "@drunkcod/express-async": "^0.0.11"
+    "@drunkcod/express-async": "^0.0.13"
   },
   "devDependencies": {
     "@drunkcod/ts-jest-esm": "^0.0.1",