@unito/integration-sdk 2.1.3 → 2.2.1

package/dist/src/index.cjs

@@ -849,38 +849,38 @@ function extractFilters(req, res, next) {
 }
 
 function onFinish(req, res, next) {
-    if (req.originalUrl !== '/health') {
-        res.on('finish', function () {
-            const error = res.locals.error;
-            const durationInNs = Number(process.hrtime.bigint() - res.locals.requestStartTime);
-            const durationInMs = (durationInNs / 1_000_000) | 0;
-            const message = `${req.method} ${req.originalUrl} ${res.statusCode} - ${durationInMs} ms`;
-            const metadata = {
-                duration: durationInNs,
-                // Use reserved and standard attributes of Datadog
-                // https://app.datadoghq.com/logs/pipelines/standard-attributes
-                http: { method: req.method, status_code: res.statusCode, url_details: { path: req.originalUrl } },
-                ...(error
-                    ? {
-                        error: {
-                            kind: error.message,
-                            stack: (error.originalError?.details?.stack ?? error.details?.stack),
-                            message: error.originalError?.message ?? error.message,
-                        },
-                    }
-                    : {}),
-            };
-            if ([404, 429].includes(res.statusCode)) {
-                res.locals.logger.warn(message, metadata);
-            }
-            else if (res.statusCode >= 400) {
-                res.locals.logger.error(message, metadata);
-            }
-            else {
-                res.locals.logger.info(message, metadata);
-            }
-        });
-    }
+    res.on('finish', function () {
+        const logger = res.locals.logger ?? new Logger();
+        const error = res.locals.error;
+        const durationInNs = Number(process.hrtime.bigint() - res.locals.requestStartTime);
+        const durationInMs = (durationInNs / 1_000_000) | 0;
+        const message = `${req.method} ${req.originalUrl} ${res.statusCode} - ${durationInMs} ms`;
+        const metadata = {
+            duration: durationInNs,
+            // Use reserved and standard attributes of Datadog
+            // https://app.datadoghq.com/logs/pipelines/standard-attributes
+            http: { method: req.method, status_code: res.statusCode, url_details: { path: req.originalUrl } },
+            ...(error
+                ? {
+                    error: {
+                        kind: error.message,
+                        stack: (error.originalError?.details?.stack ?? error.details?.stack),
+                        message: error.originalError?.message ?? error.message,
+                    },
+                }
+                : {}),
+        };
+        if ([404, 429].includes(res.statusCode)) {
+            logger.warn(message, metadata);
+        }
+        else if (res.statusCode >= 400) {
+            logger.error(message, metadata);
+        }
+        else if (req.originalUrl !== '/health') {
+            // Don't log successful health check requests
+            logger.info(message, metadata);
+        }
+    });
     next();
 }
 
@@ -975,6 +975,10 @@ function extractOperationDeadline(req, res, next) {
     next();
 }
 
+function onHealthCheck(_req, res) {
+    res.status(200).json({});
+}
+
 function printErrorMessage(message) {
     console.error();
     console.error(`\x1b[31m Oops! Something went wrong! \x1b[0m`);
@@ -1002,7 +1006,7 @@ class Integration {
      * @param options The {@link Options} to configure the Integration instance. Can be used to override the default port.
      */
     constructor(options = {}) {
-        this.port = options.port || 9200;
+        this.port = options.port || (process.env.PORT ? parseInt(process.env.PORT, 10) : 9200);
         this.handlers = [];
     }
     /**
@@ -1090,6 +1094,7 @@ class Integration {
         });
         // Instantiate application middlewares. These can throw, so they have an implicit dependency on the internal
         // middlewares such as the logger, the correlationId, and the error handling.
+        app.get('/health', onHealthCheck);
         app.use(extractCredentials);
         app.use(extractSecrets);
         app.use(extractFilters);

package/dist/src/integration.js

@@ -14,6 +14,7 @@ import searchMiddleware from './middlewares/search.js';
 import selectsMiddleware from './middlewares/selects.js';
 import relationsMiddleware from './middlewares/relations.js';
 import signalMiddleware from './middlewares/signal.js';
+import healthMiddleware from './middlewares/health.js';
 function printErrorMessage(message) {
     console.error();
     console.error(`\x1b[31m Oops! Something went wrong! \x1b[0m`);
@@ -41,7 +42,7 @@ export default class Integration {
      * @param options The {@link Options} to configure the Integration instance. Can be used to override the default port.
      */
     constructor(options = {}) {
-        this.port = options.port || 9200;
+        this.port = options.port || (process.env.PORT ? parseInt(process.env.PORT, 10) : 9200);
         this.handlers = [];
     }
     /**
@@ -129,6 +130,7 @@ export default class Integration {
         });
         // Instantiate application middlewares. These can throw, so they have an implicit dependency on the internal
         // middlewares such as the logger, the correlationId, and the error handling.
+        app.get('/health', healthMiddleware);
         app.use(credentialsMiddleware);
         app.use(secretsMiddleware);
         app.use(filtersMiddleware);

package/dist/src/middlewares/finish.js

@@ -1,36 +1,37 @@
+import { default as Logger } from '../resources/logger.js';
 function onFinish(req, res, next) {
-    if (req.originalUrl !== '/health') {
-        res.on('finish', function () {
-            const error = res.locals.error;
-            const durationInNs = Number(process.hrtime.bigint() - res.locals.requestStartTime);
-            const durationInMs = (durationInNs / 1_000_000) | 0;
-            const message = `${req.method} ${req.originalUrl} ${res.statusCode} - ${durationInMs} ms`;
-            const metadata = {
-                duration: durationInNs,
-                // Use reserved and standard attributes of Datadog
-                // https://app.datadoghq.com/logs/pipelines/standard-attributes
-                http: { method: req.method, status_code: res.statusCode, url_details: { path: req.originalUrl } },
-                ...(error
-                    ? {
-                        error: {
-                            kind: error.message,
-                            stack: (error.originalError?.details?.stack ?? error.details?.stack),
-                            message: error.originalError?.message ?? error.message,
-                        },
-                    }
-                    : {}),
-            };
-            if ([404, 429].includes(res.statusCode)) {
-                res.locals.logger.warn(message, metadata);
-            }
-            else if (res.statusCode >= 400) {
-                res.locals.logger.error(message, metadata);
-            }
-            else {
-                res.locals.logger.info(message, metadata);
-            }
-        });
-    }
+    res.on('finish', function () {
+        const logger = res.locals.logger ?? new Logger();
+        const error = res.locals.error;
+        const durationInNs = Number(process.hrtime.bigint() - res.locals.requestStartTime);
+        const durationInMs = (durationInNs / 1_000_000) | 0;
+        const message = `${req.method} ${req.originalUrl} ${res.statusCode} - ${durationInMs} ms`;
+        const metadata = {
+            duration: durationInNs,
+            // Use reserved and standard attributes of Datadog
+            // https://app.datadoghq.com/logs/pipelines/standard-attributes
+            http: { method: req.method, status_code: res.statusCode, url_details: { path: req.originalUrl } },
+            ...(error
+                ? {
+                    error: {
+                        kind: error.message,
+                        stack: (error.originalError?.details?.stack ?? error.details?.stack),
+                        message: error.originalError?.message ?? error.message,
+                    },
+                }
+                : {}),
+        };
+        if ([404, 429].includes(res.statusCode)) {
+            logger.warn(message, metadata);
+        }
+        else if (res.statusCode >= 400) {
+            logger.error(message, metadata);
+        }
+        else if (req.originalUrl !== '/health') {
+            // Don't log successful health check requests
+            logger.info(message, metadata);
+        }
+    });
     next();
 }
 export default onFinish;

package/dist/src/middlewares/health.d.ts

@@ -0,0 +1,3 @@
+import { Request, Response } from 'express';
+declare function onHealthCheck(_req: Request, res: Response): void;
+export default onHealthCheck;

package/dist/src/middlewares/health.js

@@ -0,0 +1,4 @@
+function onHealthCheck(_req, res) {
+    res.status(200).json({});
+}
+export default onHealthCheck;

package/dist/test/middlewares/finish.test.js

@@ -46,7 +46,7 @@ describe('finish middleware', () => {
         eventHandler();
         assert.equal(expected, 'works!');
     });
-    it('health', () => {
+    it('health success', () => {
         let expected = '';
         let eventHandler = () => { };
         const request = { originalUrl: '/health' };
@@ -68,4 +68,26 @@ describe('finish middleware', () => {
         eventHandler();
         assert.equal(expected, '');
     });
+    it('health failure', () => {
+        let expected = '';
+        let eventHandler = () => { };
+        const request = { originalUrl: '/health' };
+        const response = {
+            on: (_event, func) => {
+                eventHandler = func;
+            },
+            locals: {
+                requestStartTime: 0n,
+                logger: {
+                    error: (_message) => {
+                        expected = 'works!';
+                    },
+                },
+            },
+            statusCode: 500,
+        };
+        onFinish(request, response, () => { });
+        eventHandler();
+        assert.equal(expected, 'works!');
+    });
 });

package/dist/test/middlewares/health.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/middlewares/health.test.js

@@ -0,0 +1,23 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+import onHealth from '../../src/middlewares/health.js';
+describe('health middleware', () => {
+    it('on GET /health returns 200', () => {
+        const request = { originalUrl: '/' };
+        let actualStatus;
+        let actualBody;
+        const response = {
+            status: (status) => {
+                actualStatus = status;
+                return {
+                    json: (body) => {
+                        actualBody = body;
+                    },
+                };
+            },
+        };
+        onHealth(request, response);
+        assert.deepEqual(actualStatus, 200);
+        assert.deepEqual(actualBody, {});
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-sdk",
-  "version": "2.1.3",
+  "version": "2.2.1",
   "description": "Integration SDK",
   "type": "module",
   "types": "dist/src/index.d.ts",

package/src/integration.ts

@@ -16,6 +16,7 @@ import searchMiddleware from './middlewares/search.js';
 import selectsMiddleware from './middlewares/selects.js';
 import relationsMiddleware from './middlewares/relations.js';
 import signalMiddleware from './middlewares/signal.js';
+import healthMiddleware from './middlewares/health.js';
 
 function printErrorMessage(message: string) {
   console.error();
@@ -52,7 +53,7 @@ export default class Integration {
    * @param options The {@link Options} to configure the Integration instance. Can be used to override the default port.
    */
   constructor(options: Options = {}) {
-    this.port = options.port || 9200;
+    this.port = options.port || (process.env.PORT ? parseInt(process.env.PORT, 10) : 9200);
     this.handlers = [];
   }
 
@@ -147,6 +148,7 @@ export default class Integration {
 
     // Instantiate application middlewares. These can throw, so they have an implicit dependency on the internal
     // middlewares such as the logger, the correlationId, and the error handling.
+    app.get('/health', healthMiddleware);
     app.use(credentialsMiddleware);
     app.use(secretsMiddleware);
     app.use(filtersMiddleware);

package/src/middlewares/finish.ts

@@ -14,39 +14,39 @@ declare global {
 }
 
 function onFinish(req: Request, res: Response, next: NextFunction) {
-  if (req.originalUrl !== '/health') {
-    res.on('finish', function () {
-      const error = res.locals.error;
+  res.on('finish', function () {
+    const logger = res.locals.logger ?? new Logger();
+    const error = res.locals.error;
 
-      const durationInNs = Number(process.hrtime.bigint() - res.locals.requestStartTime);
-      const durationInMs = (durationInNs / 1_000_000) | 0;
+    const durationInNs = Number(process.hrtime.bigint() - res.locals.requestStartTime);
+    const durationInMs = (durationInNs / 1_000_000) | 0;
 
-      const message = `${req.method} ${req.originalUrl} ${res.statusCode} - ${durationInMs} ms`;
-      const metadata: Metadata = {
-        duration: durationInNs,
-        // Use reserved and standard attributes of Datadog
-        // https://app.datadoghq.com/logs/pipelines/standard-attributes
-        http: { method: req.method, status_code: res.statusCode, url_details: { path: req.originalUrl } },
-        ...(error
-          ? {
-              error: {
-                kind: error.message,
-                stack: (error.originalError?.details?.stack ?? error.details?.stack) as string,
-                message: error.originalError?.message ?? error.message,
-              },
-            }
-          : {}),
-      };
+    const message = `${req.method} ${req.originalUrl} ${res.statusCode} - ${durationInMs} ms`;
+    const metadata: Metadata = {
+      duration: durationInNs,
+      // Use reserved and standard attributes of Datadog
+      // https://app.datadoghq.com/logs/pipelines/standard-attributes
+      http: { method: req.method, status_code: res.statusCode, url_details: { path: req.originalUrl } },
+      ...(error
+        ? {
+            error: {
+              kind: error.message,
+              stack: (error.originalError?.details?.stack ?? error.details?.stack) as string,
+              message: error.originalError?.message ?? error.message,
+            },
+          }
+        : {}),
+    };
 
-      if ([404, 429].includes(res.statusCode)) {
-        res.locals.logger.warn(message, metadata);
-      } else if (res.statusCode >= 400) {
-        res.locals.logger.error(message, metadata);
-      } else {
-        res.locals.logger.info(message, metadata);
-      }
-    });
-  }
+    if ([404, 429].includes(res.statusCode)) {
+      logger.warn(message, metadata);
+    } else if (res.statusCode >= 400) {
+      logger.error(message, metadata);
+    } else if (req.originalUrl !== '/health') {
+      // Don't log successful health check requests
+      logger.info(message, metadata);
+    }
+  });
 
   next();
 }

package/src/middlewares/health.ts

@@ -0,0 +1,7 @@
+import { Request, Response } from 'express';
+
+function onHealthCheck(_req: Request, res: Response) {
+  res.status(200).json({});
+}
+
+export default onHealthCheck;

package/test/middlewares/finish.test.ts

@@ -56,7 +56,7 @@ describe('finish middleware', () => {
     assert.equal(expected, 'works!');
   });
 
-  it('health', () => {
+  it('health success', () => {
     let expected = '';
     let eventHandler: () => void = () => {};
 
@@ -81,4 +81,30 @@ describe('finish middleware', () => {
 
     assert.equal(expected, '');
   });
+
+  it('health failure', () => {
+    let expected = '';
+    let eventHandler: () => void = () => {};
+
+    const request = { originalUrl: '/health' } as express.Request;
+    const response = {
+      on: (_event, func: () => void) => {
+        eventHandler = func;
+      },
+      locals: {
+        requestStartTime: 0n,
+        logger: {
+          error: (_message: string) => {
+            expected = 'works!';
+          },
+        },
+      },
+      statusCode: 500,
+    } as express.Response;
+
+    onFinish(request, response, () => {});
+    eventHandler();
+
+    assert.equal(expected, 'works!');
+  });
 });

package/test/middlewares/health.test.ts

@@ -0,0 +1,31 @@
+import { Request, Response } from 'express';
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+
+import onHealth from '../../src/middlewares/health.js';
+
+describe('health middleware', () => {
+  it('on GET /health returns 200', () => {
+    const request = { originalUrl: '/' } as Request;
+
+    let actualStatus;
+    let actualBody;
+
+    const response = {
+      status: (status: number) => {
+        actualStatus = status;
+
+        return {
+          json: (body: object) => {
+            actualBody = body;
+          },
+        };
+      },
+    } as Response;
+
+    onHealth(request, response);
+
+    assert.deepEqual(actualStatus, 200);
+    assert.deepEqual(actualBody, {});
+  });
+});