fastify-txstate 3.0.8 → 3.0.11

package/README.md

@@ -80,4 +80,13 @@ You can authorize more subdomains with the `validOriginHosts` configuration opti
 You can disable these origin checks entirely with the `skipOriginCheck` configuration or `SKIP_ORIGIN_CHECK` environment variable.
 
 # Reverse Proxy
-If your application is behind a reverse proxy, you'll want to set the `trustProxy` configuration to true so that variables like `request.protocol` get set correctly. You can also set the `TRUST_PROXY` environment variable.
+If your application is behind a reverse proxy, you'll want to set the `trustProxy` configuration to true so that variables like `request.protocol` get set correctly. You can also set the `TRUST_PROXY` environment variable. `true` or `1` will translate to `{ trustProxy: true }`; anything else will be passed unchanged as a string.
+
+# Logging
+We try to set up logging well by default, including things like the HTTP traceparent header, and putting the url in both the incoming and outgoing access log entries so that it's easy to grep for certain routes/params.
+
+Development and production logs are different, based on the `NODE_ENV` environment variable. The development logger is designed to be extremely brief and not in JSON format, so that you can see errors clearly.
+
+If you want to manipulate the logging you can import the `devLogger` and `prodLogger` into your project, manipulate them, and pass them into the server constructor configuration.
+
+You can also simply add information to the `reply.extraLogInfo` object and it will automatically appear in the outgoing access log in production.

package/lib/index.js

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FailedValidationError = exports.HttpError = exports.devLogger = void 0;
+exports.FailedValidationError = exports.HttpError = exports.prodLogger = exports.devLogger = void 0;
 const fastify_1 = require("fastify");
 const fs_1 = __importDefault(require("fs"));
 const http_1 = __importDefault(require("http"));
 const http_status_codes_1 = require("http-status-codes");
 exports.devLogger = {
     level: 'info',
-    info: (msg) => console.info(msg.req ? `${msg.req.method} ${msg.req.url}` : msg.res ? `${msg.res.statusCode}` : msg),
+    info: (msg) => console.info(msg.req ? `${msg.req.method} ${msg.req.url}` : msg.res ? `${msg.res.statusCode} - ${msg.responseTime}` : msg),
     error: console.error,
     debug: console.debug,
     fatal: console.error,
@@ -19,6 +19,26 @@ exports.devLogger = {
     silent: (msg) => { },
     child(bindings, options) { return exports.devLogger; }
 };
+exports.prodLogger = {
+    level: 'info',
+    serializers: {
+        req(req) {
+            return {
+                method: req.method,
+                url: req.url,
+                remoteAddress: req.ip,
+                traceparent: req.headers.traceparent
+            };
+        },
+        res(res) {
+            return {
+                statusCode: res.statusCode,
+                url: res.request.url,
+                ...res.extraLogInfo
+            };
+        }
+    }
+};
 class Server {
     constructor(config = {}) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;
@@ -48,10 +68,14 @@ class Server {
         if (typeof config.logger === 'undefined') {
             config.logger = process.env.NODE_ENV === 'development'
                 ? exports.devLogger
-                : { level: 'info' };
+                : exports.prodLogger;
+        }
+        if (process.env.TRUST_PROXY != null) {
+            if (['true', '1'].includes(process.env.TRUST_PROXY))
+                config.trustProxy = true;
+            else
+                config.trustProxy = process.env.TRUST_PROXY;
         }
-        if (process.env.TRUST_PROXY)
-            config.trustProxy = true;
         this.app = (0, fastify_1.fastify)(config);
         if (!config.skipOriginCheck && !process.env.SKIP_ORIGIN_CHECK) {
             this.setValidOrigins([...((_a = config.validOrigins) !== null && _a !== void 0 ? _a : []), ...((_c = (_b = process.env.VALID_ORIGINS) === null || _b === void 0 ? void 0 : _b.split(',')) !== null && _c !== void 0 ? _c : [])]);
@@ -59,6 +83,7 @@ class Server {
             this.setValidOriginSuffixes([...((_g = config.validOriginSuffixes) !== null && _g !== void 0 ? _g : []), ...((_j = (_h = process.env.VALID_ORIGIN_SUFFIXES) === null || _h === void 0 ? void 0 : _h.split(',')) !== null && _j !== void 0 ? _j : [])]);
             this.app.addHook('preHandler', async (req, res) => {
                 var _a;
+                res.extraLogInfo = {};
                 if (!req.headers.origin)
                     return;
                 let passed = this.validOrigins[req.headers.origin];
@@ -126,11 +151,15 @@ class Server {
                 }
             }
         });
-        this.app.get('/health', async (req, res) => {
-            if (this.shuttingDown)
+        this.app.get('/health', { logLevel: 'warn' }, async (req, res) => {
+            if (this.shuttingDown) {
+                res.log.info('Returning 503 on /health because we are shutting down/restarting.');
                 await res.status(503).send('Service is shutting down/restarting.');
-            else if (this.healthMessage)
+            }
+            else if (this.healthMessage) {
+                res.log.info('Returning 500 on health with the message:', this.healthMessage);
                 await res.status(500).send(this.healthMessage);
+            }
             else
                 await res.status(200).send('OK');
         });

package/lib-esm/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { FastifyInstance, FastifyRequest, FastifyReply, FastifyServerOptions } from 'fastify';
+import { FastifyInstance, FastifyRequest, FastifyReply, FastifyServerOptions, FastifyLoggerOptions } from 'fastify';
 import http2 from 'http2';
 declare type ErrorHandler = (error: Error, req: FastifyRequest, res: FastifyReply) => Promise<void>;
 export interface FastifyTxStateOptions extends Partial<FastifyServerOptions> {
@@ -10,6 +10,11 @@ export interface FastifyTxStateOptions extends Partial<FastifyServerOptions> {
     skipOriginCheck?: boolean;
     checkOrigin?: (req: FastifyRequest) => boolean;
 }
+declare module 'fastify' {
+    interface FastifyReply {
+        extraLogInfo: any;
+    }
+}
 export declare const devLogger: {
     level: string;
     info: (msg: any) => void;
@@ -36,6 +41,7 @@ export declare const devLogger: {
     silent: (msg: any) => void;
     child(bindings: any, options?: any): any;
 };
+export declare const prodLogger: FastifyLoggerOptions;
 export default class Server {
     protected https: boolean;
     protected errorHandlers: ErrorHandler[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-txstate",
-  "version": "3.0.8",
+  "version": "3.0.11",
   "description": "A small wrapper for fastify providing a set of common conventions & utility functions we use.",
   "exports": {
     "types": "./lib-esm/index.d.ts",
@@ -21,11 +21,11 @@
   },
   "devDependencies": {
     "@types/chai": "^4.2.14",
-    "@types/mocha": "^9.1.1",
+    "@types/mocha": "^10.0.0",
     "@types/node": "^16.7.2",
     "axios": ">=0.20.0",
     "chai": "^4.2.0",
-    "eslint-config-standard-with-typescript": "^22.0.0",
+    "eslint-config-standard-with-typescript": "^23.0.0",
     "mocha": "^10.0.0",
     "ts-node": "^10.2.1",
     "typescript": "^4.4.2"