@devmoods/express-extras 0.19.0 → 0.20.1

package/README.md

@@ -77,7 +77,7 @@ app.get(
   route(async () => {
     const posts = await postgres.query('SELECT * FROM posts LIMIT 10');
     return posts;
-  })
+  }),
 );
 
 app.post(
@@ -100,13 +100,13 @@ app.post(
     const post = { title, content };
 
     await postgres.insert(
-      sql`INSERT INTO posts (title, content) VALUES (${title}, ${content})`
+      sql`INSERT INTO posts (title, content) VALUES (${title}, ${content})`,
     );
 
     slack.postMessage(`New post created with title ${title}`);
 
     return [201, post];
-  })
+  }),
 );
 
 app.use((req, res, next) => {
@@ -118,7 +118,7 @@ app.use(
     shouldHandleError(error) {
       return true;
     },
-  })
+  }),
 );
 
 app.use(
@@ -130,7 +130,7 @@ app.use(
         logger.error(error);
       }
     },
-  })
+  }),
 );
 
 listen(server, {

package/dist/auth.d.ts

@@ -24,6 +24,14 @@ export declare function createAuth<UserModel extends Record<string, any>>({ getU
  * of `req`.
  */
 export declare function parseAuthorizationHeader(req: Request): string | null;
+/**
+ * Extract an access token from the `Request`-object.
+ *
+ * Checks multiple places and uses the first match. Priority:
+ *   1. Request header `Authorization: `
+ *   2. Cookie named `access_token`
+ */
+export declare function extractAccessTokenFromRequest(req: Request): string | null;
 export declare function setAccessTokenCookie(res: Response, token: string | null): void;
 export declare function checkIfPasswordsMatch(realPassword: string, attemptedPassword: string): Promise<boolean>;
 export declare function hashPassword(password: string): Promise<string>;

package/dist/auth.js

@@ -16,6 +16,7 @@ export function createAuthToken(payload, secret = process.env.APP_JWT_SECRET) {
 }
 export function createAuth({ getUserByToken, methods: { emailAndPassword }, filterUser = (x) => x, redis, tokenExpiry = TOKEN_EXPIRES_IN, onResetRequested, onPasswordChanged, }) {
     const useCurrentUser = () => useContext('currentUser');
+    const setCurrentUser = (user) => setContext('currentUser', user);
     const createRouter = () => {
         const router = Router();
         router.get('/me', middleware(), route(() => {
@@ -36,6 +37,8 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                     const token = createAuthToken(filterUser(user));
                     await redis.set(token, '1', { EX: tokenExpiry });
                     setAccessTokenCookie(res, token);
+                    setCurrentUser(user);
+                    logger.info('access token created');
                     return [201, { token }];
                 }
                 catch (error) {
@@ -75,12 +78,14 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                 const { token } = req.params;
                 const email = await redis.get(token);
                 if (!email) {
+                    logger.info('invalid reset token', { token });
                     throw BadRequest('invalid reset token');
                 }
                 const user = await emailAndPassword(email, skipPasswordCheck);
+                setCurrentUser(user);
                 await onPasswordChanged?.(user, await hashPassword(password));
                 await redis.del(token);
-                logger.info('user changed password', { email });
+                logger.info('user changed password');
                 return 200;
             }));
         }
@@ -88,6 +93,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
             const token = req.params.token;
             const email = await redis.get(token);
             if (!email) {
+                logger.info('invalid reset token', { token });
                 throw NotFound();
             }
             return 200;
@@ -110,6 +116,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                     EX: TEMP_TOKEN_EXIRES_IN,
                 });
                 await onResetRequested?.(user, temporaryToken);
+                logger.info('password reset request', { email });
             }
             catch (error) {
                 logger.error(error, 'auth reset failed');
@@ -125,6 +132,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
             const token = createAuthToken(rest);
             await redis.set(token, '1', { EX: tokenExpiry });
             setAccessTokenCookie(res, token);
+            logger.info('refreshed token', { user });
             return { token };
         }));
         return router;
@@ -142,6 +150,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                 const valid = await redis.get(token);
                 if (!valid) {
                     if (!authorize) {
+                        logger.warn('request with invalid access token');
                         return next();
                     }
                     throw new InvalidToken('token expired');
@@ -151,7 +160,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                     throw new Error('Failed to decode token');
                 }
                 const user = await getUserByToken({ ...decoded });
-                setContext('currentUser', user);
+                setCurrentUser(user);
                 next();
             }
             catch (error) {
@@ -190,7 +199,14 @@ export function parseAuthorizationHeader(req) {
     }
     return token;
 }
-function extractAccessTokenFromRequest(req) {
+/**
+ * Extract an access token from the `Request`-object.
+ *
+ * Checks multiple places and uses the first match. Priority:
+ *   1. Request header `Authorization: `
+ *   2. Cookie named `access_token`
+ */
+export function extractAccessTokenFromRequest(req) {
     const authorizationHeader = parseAuthorizationHeader(req);
     if (authorizationHeader) {
         return authorizationHeader;
@@ -226,7 +242,7 @@ export async function checkIfPasswordsMatch(realPassword, attemptedPassword) {
     }
     const validPassword = await bcrypt.compare(attemptedPassword, realPassword);
     if (!validPassword) {
-        throw new Error(`Passwords does not match`);
+        throw new Error(`Passwords do not match`);
     }
     return true;
 }

package/dist/context.d.ts

@@ -10,16 +10,8 @@ export declare function withRequestContext({ getRequestId, }?: RequestContextOpt
  * Return a value from the request context
  */
 export declare function useContext<T>(key: string): T | undefined;
-/**
- * @deprecated
- */
-export declare const getContext: typeof useContext;
 /**
  * Set a value on the request context
  */
-export declare function setContext<T>(key: string, value: T): any;
+export declare function setContext<T>(key: string, value: T): Map<string, any> | undefined;
 export declare function useRequestId(): string | undefined;
-/**
- * @deprecated
- */
-export declare const getRequestId: typeof useRequestId;

package/dist/context.js

@@ -1,14 +1,18 @@
-import { createNamespace } from 'cls-hooked';
+import { AsyncLocalStorage } from 'node:async_hooks';
 import { v4 as uuid } from 'uuid';
-const requestContext = createNamespace('@requestContext');
+const requestContext = new AsyncLocalStorage();
+const REQUEST_ID = 'requestId';
 /**
  * Middleware for setting a `requestId` on the request context.
  */
 export function withRequestContext({ getRequestId = (req) => req.headers['X-Request-ID'], } = {}) {
     return (req, res, next) => {
         const requestId = getRequestId(req) || uuid();
-        requestContext.run(() => {
-            requestContext.set('requestId', requestId);
+        requestContext.run(new Map(), () => {
+            const store = requestContext.getStore();
+            if (store) {
+                store.set(REQUEST_ID, requestId);
+            }
             next();
         });
     };
@@ -17,26 +21,20 @@ export function withRequestContext({ getRequestId = (req) => req.headers['X-Requ
  * Return a value from the request context
  */
 export function useContext(key) {
-    if (requestContext && requestContext.active) {
-        return requestContext.get(key);
+    const store = requestContext.getStore();
+    if (store) {
+        return store.get(key);
     }
 }
-/**
- * @deprecated
- */
-export const getContext = useContext;
 /**
  * Set a value on the request context
  */
 export function setContext(key, value) {
-    if (requestContext && requestContext.active) {
-        return requestContext.set(key, value);
+    const store = requestContext.getStore();
+    if (store) {
+        return store.set(key, value);
     }
 }
 export function useRequestId() {
-    return useContext('requestId');
+    return useContext(REQUEST_ID);
 }
-/**
- * @deprecated
- */
-export const getRequestId = useRequestId;

package/dist/email.js

@@ -15,7 +15,7 @@ export function createEmail({ host, port, user, pass, senderName, senderAddress,
             text: message,
             ...rest,
         });
-        getLogger('core').info('email-sent', { email: result });
+        getLogger('email').info('email-sent', { email: result });
     };
     return { send, transporter };
 }

package/dist/errors.js

@@ -44,8 +44,7 @@ function convertToAPIError(error) {
     return error;
 }
 function _errorHandler({ onError }) {
-    return (err, req, res, next // eslint-disable-line
-    ) => {
+    return (err, req, res, next) => {
         if (!err) {
             err = makeError(500);
         }

package/dist/listen.js

@@ -1,6 +1,6 @@
 import { createTerminus } from '@godaddy/terminus';
 import { getLogger } from './logger.js';
-const logger = getLogger();
+const logger = getLogger('core');
 const READINESS_PERIOD_MS = parseInt(process.env.DM_READINESS_PERIOD_MS || '', 10) || 0;
 const FORCE_EXIT_TIMEOUT = parseInt(process.env.DM_FORCE_EXIT_TIMEOUT || '', 10) || 1000;
 /**

package/dist/logger.d.ts

@@ -18,29 +18,17 @@ export declare function attachSentryClientToLoggers(sentryClient: CreateSentry['
 export declare function setGlobalLoggerContext(getContext: () => LoggerContext): void;
 export type Logger = ReturnType<typeof createLogger>;
 export declare function createLogger({ name, getContext, silent, }: LoggerOptions): {
-    debug(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    info(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    warn(message: string, context?: {
-        [key: string]: any;
-    }): void;
+    debug(message: string, context?: LoggerContext): void;
+    info(message: string, context?: LoggerContext): void;
+    warn(message: string, context?: LoggerContext): void;
     error(error: Error | null, message?: string): void;
     fatal(error: Error | null, message?: string): void;
 };
 export declare function getLogger(name?: string): Logger;
 export declare function getLoggers(): Map<string, {
-    debug(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    info(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    warn(message: string, context?: {
-        [key: string]: any;
-    }): void;
+    debug(message: string, context?: LoggerContext): void;
+    info(message: string, context?: LoggerContext): void;
+    warn(message: string, context?: LoggerContext): void;
     error(error: Error | null, message?: string | undefined): void;
     fatal(error: Error | null, message?: string | undefined): void;
 }>;

package/dist/logger.js

@@ -1,5 +1,14 @@
-import bunyan from 'bunyan';
+import * as os from 'node:os';
 import { useRequestId } from './context.js';
+const LEVELS = {
+    TRACE: 10,
+    DEBUG: 20,
+    INFO: 30,
+    WARN: 40,
+    ERROR: 50,
+    FATAL: 60,
+};
+const LEVELS_TO_NAME = Object.fromEntries(Object.entries(LEVELS).map(([name, level]) => [level, name.toLowerCase()]));
 const _loggers = new Map();
 let _sentryClient;
 export function attachSentryClientToLoggers(sentryClient) {
@@ -19,51 +28,61 @@ export function createLogger({ name, getContext, silent = () => process.env.NODE
     if (_loggers.has(name)) {
         throw new Error(`A logger named ${name} already exists`);
     }
-    const logger = bunyan.createLogger({
-        name,
-        serializers: bunyan.stdSerializers,
-    });
-    _loggers.set(name, logger);
-    if (silent()) {
-        logger.level(bunyan.FATAL + 1);
-    }
-    function getFinalContext() {
+    const hostname = os.hostname();
+    const pid = process.pid;
+    const logLevel = silent() ? LEVELS.FATAL + 1 : LEVELS.INFO;
+    function getFinalContext(context) {
         return {
             ...defaultGetContext(),
             ...getContext?.(),
+            ...context,
         };
     }
-    return {
+    function log(level, message, context) {
+        const payload = JSON.stringify({
+            level: LEVELS_TO_NAME[level],
+            hostname,
+            pid,
+            message,
+            ...context,
+            time: new Date().toISOString(),
+            v: 1,
+        });
+        if (level >= logLevel) {
+            console.log(payload);
+        }
+    }
+    const api = {
         debug(message, context = {}) {
-            return logger.child(getFinalContext(), true).debug(context, message);
+            return log(LEVELS.DEBUG, message, getFinalContext(context));
         },
         info(message, context = {}) {
-            return logger.child(getFinalContext(), true).info(context, message);
+            return log(LEVELS.INFO, message, getFinalContext(context));
         },
         warn(message, context = {}) {
-            return logger.child(getFinalContext(), true).warn(context, message);
+            return log(LEVELS.WARN, message, getFinalContext(context));
         },
         error(error, message) {
-            const context = getFinalContext();
+            const context = getFinalContext({ err: error?.stack });
             if (_sentryClient != null) {
                 _sentryClient.captureException(error, {
                     tags: context,
                 });
             }
-            return logger
-                .child(context, true)
-                .error(error, message || error?.message);
+            return log(LEVELS.ERROR, message || error?.message || '', context);
         },
         fatal(error, message) {
-            const context = getFinalContext();
+            const context = getFinalContext({ err: error });
             if (_sentryClient != null) {
                 _sentryClient.captureException(error, {
                     tags: context,
                 });
             }
-            return logger.child(context, true).fatal(error, message);
+            return log(LEVELS.FATAL, message || error?.message || '', context);
         },
     };
+    _loggers.set(name, api);
+    return api;
 }
 export function getLogger(name = 'default') {
     const logger = _loggers.get(name);

package/dist/middleware.js

@@ -48,9 +48,9 @@ export function before({ cookies = false, helmet: useHelmet = true, json: useJso
 function logRequestDuration() {
     const getDurationInMilliseconds = (start) => {
         const NS_PER_SEC = 1e9;
-        const NS_TO_MS = 1e6;
+        const NS_TO_S = 1e9;
         const diff = process.hrtime(start);
-        return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS;
+        return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_S;
     };
     return (req, res, next) => {
         const start = process.hrtime();
@@ -58,6 +58,7 @@ function logRequestDuration() {
             method: req.method,
             url: req.originalUrl,
             path: req.path,
+            ip: req.ip,
         });
         res.on('finish', () => {
             const duration = getDurationInMilliseconds(start);
@@ -66,6 +67,7 @@ function logRequestDuration() {
                 url: req.originalUrl,
                 path: req.path,
                 duration,
+                status: res.statusCode,
             });
         });
         next();

package/dist/slack.js

@@ -1,6 +1,6 @@
 import { createFetch } from '@devmoods/fetch';
 import { getLogger } from './logger.js';
-const logger = getLogger();
+const logger = getLogger('slack');
 /**
  * Send messages to Slack using Incoming Webhooks
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devmoods/express-extras",
-  "version": "0.19.0",
+  "version": "0.20.1",
   "description": "Kubernetes-ready utilities for rapid Node.js application development",
   "type": "module",
   "main": "./dist/index.js",
@@ -8,6 +8,17 @@
   "bin": {
     "migrate": "bin/migrate"
   },
+  "scripts": {
+    "start": "ts-node --esm example/index.ts",
+    "clean": "rm -rf dist",
+    "lint": "eslint src",
+    "test": "NODE_ENV=test vitest",
+    "build": "pnpm run clean && tsc --project tsconfig.build.json",
+    "prepublishOnly": "pnpm run clean && pnpm run build",
+    "prettier": "prettier --write '**/*.{js,css,md,ts,tsx}'",
+    "import-sort": "import-sort --write '**/*.{js,jsx,ts,tsx}'",
+    "format": "pnpm run import-sort && pnpm run prettier"
+  },
   "author": {
     "name": "hanse",
     "email": "hanse@koren.im"
@@ -51,8 +62,6 @@
     "@sentry/node": "^7.60.1",
     "@types/bcrypt": "^5.0.0",
     "@types/body-parser": "^1.19.2",
-    "@types/bunyan": "^1.8.8",
-    "@types/cls-hooked": "^4.3.4",
     "@types/cookie-parser": "^1.4.3",
     "@types/express": "^4.17.17",
     "@types/jsonwebtoken": "^9.0.2",
@@ -62,8 +71,6 @@
     "ajv": "^8.12.0",
     "bcrypt": "^5.1.0",
     "body-parser": "^1.20.2",
-    "bunyan": "^1.8.15",
-    "cls-hooked": "^4.2.2",
     "compose-middleware": "^5.0.1",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.3.1",
@@ -92,15 +99,5 @@
       "@typescript-eslint/no-shadow": "off",
       "react-hooks/rules-of-hooks": "off"
     }
-  },
-  "scripts": {
-    "start": "ts-node --esm example/index.ts",
-    "clean": "rm -rf dist",
-    "lint": "eslint src",
-    "test": "NODE_ENV=test vitest",
-    "build": "pnpm run clean && tsc --project tsconfig.build.json",
-    "prettier": "prettier --write '**/*.{js,css,md,ts,tsx}'",
-    "import-sort": "import-sort --write '**/*.{js,jsx,ts,tsx}'",
-    "format": "pnpm run import-sort && pnpm run prettier"
   }
-}
+}