fastify-txstate 3.1.6 → 3.1.8

package/lib/index.js

@@ -31,11 +31,11 @@ exports.prodLogger = {
             };
         },
         res(res) {
-            var _a;
+            var _a, _b;
             return {
                 statusCode: res.statusCode,
                 url: (_a = res.request) === null || _a === void 0 ? void 0 : _a.url.replace(/token=[\w.]+/, 'token=redacted'),
-                length: res.getHeader('content-length'),
+                length: (_b = res.getHeader) === null || _b === void 0 ? void 0 : _b.call(res, 'content-length'),
                 ...res.extraLogInfo
             };
         }
@@ -78,6 +78,7 @@ class Server {
             else
                 config.trustProxy = process.env.TRUST_PROXY;
         }
+        this.healthCallback = config.checkHealth;
         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 : [])]);
@@ -125,13 +126,13 @@ class Server {
         }
         this.app.addHook('onSend', this.https && process.env.NODE_ENV !== 'development'
             ? async (_, resp) => {
-                resp.removeHeader('X-Powered-By');
+                void resp.removeHeader('X-Powered-By');
                 void resp.header('Strict-Transport-Security', 'max-age=31536000');
                 if (resp.getHeader('content-type') === 'text/html')
                     void resp.type('text/html; charset=utf-8');
             }
             : async (_, resp) => {
-                resp.removeHeader('X-Powered-By');
+                void resp.removeHeader('X-Powered-By');
                 if (resp.getHeader('content-type') === 'text/html')
                     void resp.type('text/html; charset=utf-8');
             });
@@ -160,14 +161,24 @@ class Server {
         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.');
+                void res.status(503);
+                return 'MAINTENANCE';
             }
             else if (this.healthMessage) {
-                res.log.info('Returning 500 on health with the message:', this.healthMessage);
-                await res.status(500).send(this.healthMessage);
+                res.log.info(this.healthMessage);
+                void res.status(500);
+                return this.healthMessage;
             }
-            else
-                await res.status(200).send('OK');
+            else if (this.healthCallback) {
+                const resp = await this.healthCallback();
+                const [status, msg] = typeof resp === 'string' ? [500, resp] : [resp === null || resp === void 0 ? void 0 : resp.status, resp === null || resp === void 0 ? void 0 : resp.message];
+                if (!!msg || !!status) {
+                    res.log.info(resp, 'Health check callback failed.');
+                    void res.status(status !== null && status !== void 0 ? status : 500);
+                    return msg !== null && msg !== void 0 ? msg : 'FAIL';
+                }
+            }
+            return 'OK';
         });
         this.sigHandler = () => {
             this.close().then(() => {

package/lib-esm/index.d.ts

@@ -9,6 +9,14 @@ export interface FastifyTxStateOptions extends Partial<FastifyServerOptions> {
     validOriginSuffixes?: string[];
     skipOriginCheck?: boolean;
     checkOrigin?: (req: FastifyRequest) => boolean;
+    /**
+     * Run an asynchronous function to check the health of the service.
+     *
+     * Return a non-empty error message to trigger unhealthy status.
+     *
+     * Setting a health message with setUnhealthy will override this and prevent it from being executed.
+     */
+    checkHealth?: () => Promise<string | undefined>;
 }
 declare module 'fastify' {
     interface FastifyReply {
@@ -46,6 +54,10 @@ export default class Server {
     protected https: boolean;
     protected errorHandlers: ErrorHandler[];
     protected healthMessage?: string;
+    protected healthCallback?: () => Promise<string | {
+        status?: number;
+        message?: string;
+    } | undefined>;
     protected shuttingDown: boolean;
     protected sigHandler: (signal: any) => void;
     protected validOrigins: Record<string, boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-txstate",
-  "version": "3.1.6",
+  "version": "3.1.8",
   "description": "A small wrapper for fastify providing a set of common conventions & utility functions we use.",
   "exports": {
     "types": "./lib-esm/index.d.ts",