@signageos/lib 23.8.1 → 23.8.2-master.4405

package/dist/Service/HTTP/middleware/accessLogMiddleware.d.ts

@@ -0,0 +1,20 @@
+import { Request, Response, NextFunction } from 'express';
+export interface AccessLog {
+    method: string;
+    path: string;
+    status: number;
+    remoteAddress?: string;
+    userAgent?: string;
+    requestBytes: number;
+    responseBytes: number;
+    headers: Record<string, string>;
+    referrer?: string;
+    remoteUser?: string;
+    tookSeconds?: number;
+}
+export type LogCallback = (accessLog: AccessLog, req: Request, res: Response) => void;
+type ExtendedRequest = Request & {
+    _startAt?: bigint;
+};
+export declare function accessLogMiddleware(logCallback: LogCallback): (req: ExtendedRequest, res: Response, next: NextFunction) => void;
+export {};

package/dist/Service/HTTP/middleware/accessLogMiddleware.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.accessLogMiddleware = accessLogMiddleware;
+var on_finished_1 = __importDefault(require("on-finished"));
+var basic_auth_1 = __importDefault(require("basic-auth"));
+function accessLogMiddleware(logCallback) {
+    return function (req, res, next) {
+        // record request start time and use it to calculate total time in the end
+        req._startAt = process.hrtime.bigint();
+        (0, on_finished_1.default)(res, function (_err, resFinished) {
+            var accessLog = createAccessLogMessage(req, resFinished);
+            logCallback(accessLog, req, resFinished);
+        });
+        next();
+    };
+}
+/**
+ * @returns A log message in format based on the Nginx combined format
+ * @see https://nginx.org/en/docs/http/ngx_http_log_module.html
+ */
+function createAccessLogMessage(req, res) {
+    var _a, _b, _c;
+    return {
+        method: req.method,
+        path: (_a = req.originalUrl) !== null && _a !== void 0 ? _a : req.url,
+        status: res.statusCode,
+        remoteAddress: getRemoteAddress(req),
+        userAgent: req.get('User-Agent'),
+        requestBytes: parseInt((_b = req.get('Content-Length')) !== null && _b !== void 0 ? _b : '0'),
+        responseBytes: parseInt((_c = res.get('Content-Length')) !== null && _c !== void 0 ? _c : '0'),
+        headers: getHeaders(req),
+        referrer: getReferrer(req),
+        remoteUser: getRemoteUser(req),
+        tookSeconds: getTotalTime(req),
+    };
+}
+function getRemoteAddress(req) {
+    var _a, _b;
+    var xForwardedFor = req.get('X-Forwarded-For');
+    // if the request is coming through a proxy, the original client IP will be in the X-Forwarded-For header
+    // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For
+    if (xForwardedFor) {
+        return xForwardedFor.split(',')[0].trim();
+    }
+    return (_b = (_a = req.ip) !== null && _a !== void 0 ? _a : req.connection.remoteAddress) !== null && _b !== void 0 ? _b : undefined;
+}
+function getHeaders(req) {
+    var HEADERS_TO_LOG = ['cloudfront-viewer-country', 'cloudfront-viewer-asn'];
+    var headers = {};
+    for (var _i = 0, HEADERS_TO_LOG_1 = HEADERS_TO_LOG; _i < HEADERS_TO_LOG_1.length; _i++) {
+        var header = HEADERS_TO_LOG_1[_i];
+        var value = req.get(header);
+        if (value) {
+            headers[header] = value;
+        }
+    }
+    return headers;
+}
+function getReferrer(req) {
+    var _a;
+    // "Referer" is actually mis-spelled but it's the standard according to the spec
+    // "Referrer" is correct spelling and sometimes used instead
+    // https://en.wikipedia.org/wiki/HTTP_referer
+    return (_a = req.get('Referer')) !== null && _a !== void 0 ? _a : req.get('Referrer');
+}
+function getRemoteUser(req) {
+    var _a;
+    var credentials = (0, basic_auth_1.default)(req);
+    return (_a = credentials === null || credentials === void 0 ? void 0 : credentials.name) !== null && _a !== void 0 ? _a : undefined;
+}
+/**
+ * Returns the time between the request coming into the middleware and
+ * when the response has finished being written out to the connection, in seconds.
+ *
+ * @return The time in seconds or 0 on error.
+ */
+function getTotalTime(req) {
+    if (!req._startAt) {
+        // missing request start time
+        return 0;
+    }
+    // time elapsed from request start
+    var ns = process.hrtime.bigint() - req._startAt;
+    // convert to seconds
+    return Number(ns / BigInt(1e9));
+}
+//# sourceMappingURL=accessLogMiddleware.js.map

package/dist/Service/HTTP/middleware/accessLogMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessLogMiddleware.js","sourceRoot":"","sources":["../../../../src/Service/HTTP/middleware/accessLogMiddleware.ts"],"names":[],"mappings":";;;;;AAwBA,kDAYC;AAnCD,4DAAqC;AACrC,0DAA8B;AAsB9B,SAAgB,mBAAmB,CAAC,WAAwB;IAC3D,OAAO,UAAC,GAAoB,EAAE,GAAa,EAAE,IAAkB;QAC9D,0EAA0E;QAC1E,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAEvC,IAAA,qBAAU,EAAC,GAAuC,EAAE,UAAC,IAAI,EAAE,WAAW;YACrE,IAAM,SAAS,GAAG,sBAAsB,CAAC,GAAG,EAAE,WAAuB,CAAC,CAAC;YACvE,WAAW,CAAC,SAAS,EAAE,GAAG,EAAE,WAAuB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,IAAI,EAAE,CAAC;IACR,CAAC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAAC,GAAoB,EAAE,GAAa;;IAClE,OAAO;QACN,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,IAAI,EAAE,MAAA,GAAG,CAAC,WAAW,mCAAI,GAAG,CAAC,GAAG;QAChC,MAAM,EAAE,GAAG,CAAC,UAAU;QACtB,aAAa,EAAE,gBAAgB,CAAC,GAAG,CAAC;QACpC,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC;QAChC,YAAY,EAAE,QAAQ,CAAC,MAAA,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,mCAAI,GAAG,CAAC;QACxD,aAAa,EAAE,QAAQ,CAAC,MAAA,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,mCAAI,GAAG,CAAC;QACzD,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC;QACxB,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC;QAC1B,UAAU,EAAE,aAAa,CAAC,GAAG,CAAC;QAC9B,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC;KAC9B,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAY;;IACrC,IAAM,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAEjD,yGAAyG;IACzG,4EAA4E;IAC5E,IAAI,aAAa,EAAE,CAAC;QACnB,OAAO,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3C,CAAC;IAED,OAAO,MAAA,MAAA,GAAG,CAAC,EAAE,mCAAI,GAAG,CAAC,UAAU,CAAC,aAAa,mCAAI,SAAS,CAAC;AAC5D,CAAC;AAED,SAAS,UAAU,CAAC,GAAY;IAC/B,IAAM,cAAc,GAAG,CAAC,2BAA2B,EAAE,uBAAuB,CAAC,CAAC;IAC9E,IAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,KAAqB,UAAc,EAAd,iCAAc,EAAd,4BAAc,EAAd,IAAc,EAAE,CAAC;QAAjC,IAAM,MAAM,uBAAA;QAChB,IAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9B,IAAI,KAAK,EAAE,CAAC;YACX,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACzB,CAAC;IACF,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,SAAS,WAAW,CAAC,GAAY;;IAChC,gFAAgF;IAChF,4DAA4D;IAC5D,6CAA6C;IAC7C,OAAO,MAAA,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,mCAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,aAAa,CAAC,GAAY;;IAClC,IAAM,WAAW,GAAG,IAAA,oBAAI,EAAC,GAAG,CAAC,CAAC;IAC9B,OAAO,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,mCAAI,SAAS,CAAC;AACvC,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,GAAoB;IACzC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACnB,6BAA6B;QAC7B,OAAO,CAAC,CAAC;IACV,CAAC;IAED,kCAAkC;IAClC,IAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC;IAElD,qBAAqB;IACrB,OAAO,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AACjC,CAAC"}

package/dist/Service/HTTP/middleware/headersMiddleware.d.ts

@@ -0,0 +1,2 @@
+import { Request, Response, NextFunction } from 'express';
+export declare function getHeadersMiddleware(): (_req: Request, res: Response, next: NextFunction) => void;

package/dist/Service/HTTP/middleware/headersMiddleware.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHeadersMiddleware = getHeadersMiddleware;
+function getDefaultHeaders() {
+    return {
+        'Cache-Control': 'no-store',
+        'X-Frame-Options': 'DENY',
+        'X-Content-Type-Options': 'nosniff',
+        'Strict-Transport-Security': 'max-age=31536000',
+    };
+}
+function getHeadersMiddleware() {
+    return function (_req, res, next) {
+        res.set(getDefaultHeaders());
+        next();
+    };
+}
+//# sourceMappingURL=headersMiddleware.js.map

package/dist/Service/HTTP/middleware/headersMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headersMiddleware.js","sourceRoot":"","sources":["../../../../src/Service/HTTP/middleware/headersMiddleware.ts"],"names":[],"mappings":";;AAWA,oDAKC;AAdD,SAAS,iBAAiB;IACzB,OAAO;QACN,eAAe,EAAE,UAAU;QAC3B,iBAAiB,EAAE,MAAM;QACzB,wBAAwB,EAAE,SAAS;QACnC,2BAA2B,EAAE,kBAAkB;KAC/C,CAAC;AACH,CAAC;AAED,SAAgB,oBAAoB;IACnC,OAAO,UAAC,IAAa,EAAE,GAAa,EAAE,IAAkB;QACvD,GAAG,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC7B,IAAI,EAAE,CAAC;IACR,CAAC,CAAC;AACH,CAAC"}

package/dist/Service/HTTP/routes/app/indexPage.d.ts

@@ -0,0 +1,7 @@
+import { Router } from 'express';
+/**
+ * Serves HTML index page with company logo
+ */
+export declare function routeIndex({ router }: {
+    router: Router;
+}): void;

package/dist/Service/HTTP/routes/app/indexPage.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeIndex = routeIndex;
+var indexContent = "</doctype html>\n<html>\n\t<head>\n\t\t<style>\n\t\t\tbody {\n\t\t\t\twidth: 100vw;\n\t\t\t\theight: 100vh;\n\t\t\t\tbackground-color: #000000;\n\t\t\t\tbackground-image: url('https://2.signageos.io/assets/signageos-logo-square.png');\n\t\t\t\tbackground-repeat: no-repeat;\n\t\t\t\tbackground-position: center center;\n\t\t\t}\n\t\t</style>\n\t</head>\n\t<body></body>\n</html>\n";
+/**
+ * Serves HTML index page with company logo
+ */
+function routeIndex(_a) {
+    var router = _a.router;
+    router.get('/', function (_req, res) { return res.send(indexContent); });
+}
+//# sourceMappingURL=indexPage.js.map

package/dist/Service/HTTP/routes/app/indexPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexPage.js","sourceRoot":"","sources":["../../../../../src/Service/HTTP/routes/app/indexPage.ts"],"names":[],"mappings":";;AAuBA,gCAEC;AAvBD,IAAM,YAAY,GAAG,8XAgBpB,CAAC;AAEF;;GAEG;AACH,SAAgB,UAAU,CAAC,EAA8B;QAA5B,MAAM,YAAA;IAClC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,UAAC,IAAa,EAAE,GAAa,IAAK,OAAA,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,EAAtB,CAAsB,CAAC,CAAC;AAC3E,CAAC"}

package/dist/Service/HTTP/routes/app/router.d.ts

@@ -0,0 +1,14 @@
+import { Router } from 'express';
+import { DBConnections } from '../../../dbConnections';
+import { ServiceInfo } from '../../httpServerFactory';
+import { TAdditionalStatusDataCallback } from '../../../../HttpStatus/sendStatusResponse';
+export declare function routeApp(args: {
+    router: Router;
+    service: ServiceInfo;
+    connections?: DBConnections;
+    /**
+     * Prevent serving the index page on / path
+     */
+    noRouteIndex?: boolean;
+    additionalStatusDataCallback?: TAdditionalStatusDataCallback;
+}): void;

package/dist/Service/HTTP/routes/app/router.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeApp = routeApp;
+var indexPage_1 = require("./indexPage");
+var status_1 = require("./status");
+function routeApp(args) {
+    if (!args.noRouteIndex) {
+        (0, indexPage_1.routeIndex)(args);
+    }
+    (0, status_1.routeStatus)(args);
+}
+//# sourceMappingURL=router.js.map

package/dist/Service/HTTP/routes/app/router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../../../../../src/Service/HTTP/routes/app/router.ts"],"names":[],"mappings":";;AAOA,4BAcC;AAlBD,yCAAyC;AACzC,mCAAuC;AAGvC,SAAgB,QAAQ,CAAC,IASxB;IACA,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACxB,IAAA,sBAAU,EAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IACD,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;AACnB,CAAC"}

package/dist/Service/HTTP/routes/app/status.d.ts

@@ -0,0 +1,13 @@
+import { Router } from 'express';
+import { DBConnections } from '../../../dbConnections';
+import { ServiceInfo } from '../../httpServerFactory';
+import { TAdditionalStatusDataCallback } from '../../../../HttpStatus/sendStatusResponse';
+/**
+ * Serves some basic human-readable information about the service
+ */
+export declare function routeStatus({ router, service, connections, additionalStatusDataCallback, }: {
+    router: Router;
+    service: ServiceInfo;
+    connections?: DBConnections;
+    additionalStatusDataCallback?: TAdditionalStatusDataCallback;
+}): void;

package/dist/Service/HTTP/routes/app/status.js

@@ -0,0 +1,44 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeStatus = routeStatus;
+var createHttpStatusMiddleware_1 = __importDefault(require("../../../../HttpStatus/createHttpStatusMiddleware"));
+var amqpStatus_1 = require("../../../../HttpStatus/statuses/amqpStatus");
+var redisStatus_1 = require("../../../../HttpStatus/statuses/redisStatus");
+var mongoStatus_1 = require("../../../../HttpStatus/statuses/mongoStatus");
+/**
+ * Serves some basic human-readable information about the service
+ */
+function routeStatus(_a) {
+    var router = _a.router, service = _a.service, connections = _a.connections, additionalStatusDataCallback = _a.additionalStatusDataCallback;
+    var statuses = [];
+    if (connections === null || connections === void 0 ? void 0 : connections.amqp) {
+        var amqpConnections = Object.values(connections.amqp);
+        statuses.push((0, amqpStatus_1.amqpStatus)(amqpConnections, service.uid));
+    }
+    if (connections === null || connections === void 0 ? void 0 : connections.redis) {
+        var redisConnections = Object.values(connections.redis);
+        statuses.push((0, redisStatus_1.redisStatus)(redisConnections, service.uid));
+    }
+    if (connections === null || connections === void 0 ? void 0 : connections.mongodb) {
+        var mongodbConnections = Object.values(connections.mongodb);
+        statuses.push((0, mongoStatus_1.mongoStatus)(mongodbConnections, service.uid));
+    }
+    router.get('/status', createHttpStatusMiddleware_1.default.apply(void 0, __spreadArray([{
+            namespace: service.name,
+            uniqueId: service.uid,
+            additionalStatusDataCallback: additionalStatusDataCallback,
+        }], statuses, false)));
+}
+//# sourceMappingURL=status.js.map

package/dist/Service/HTTP/routes/app/status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../../../src/Service/HTTP/routes/app/status.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAaA,kCAqCC;AAjDD,iHAA2F;AAE3F,yEAAwE;AACxE,2EAA0E;AAC1E,2EAA0E;AAK1E;;GAEG;AACH,SAAgB,WAAW,CAAC,EAU3B;QATA,MAAM,YAAA,EACN,OAAO,aAAA,EACP,WAAW,iBAAA,EACX,4BAA4B,kCAAA;IAO5B,IAAM,QAAQ,GAAiB,EAAE,CAAC;IAElC,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,EAAE,CAAC;QACvB,IAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACxD,QAAQ,CAAC,IAAI,CAAC,IAAA,uBAAU,EAAC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,EAAE,CAAC;QACxB,IAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC1D,QAAQ,CAAC,IAAI,CAAC,IAAA,yBAAW,EAAC,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,EAAE,CAAC;QAC1B,IAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC9D,QAAQ,CAAC,IAAI,CAAC,IAAA,yBAAW,EAAC,kBAAkB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,CAAC,GAAG,CACT,SAAS,EACT,oCAA0B,8BACzB;YACC,SAAS,EAAE,OAAO,CAAC,IAAI;YACvB,QAAQ,EAAE,OAAO,CAAC,GAAG;YACrB,4BAA4B,8BAAA;SAC5B,GACE,QAAQ,UAEZ,CAAC;AACH,CAAC"}

package/dist/Service/HTTP/routes/monitoring/aliveness.d.ts

@@ -0,0 +1,20 @@
+import { Router } from 'express';
+export type IsAliveCallback = () => Promise<boolean> | boolean;
+export type AlivenessRouteArgs = {
+    router: Router;
+    /**
+     * Callback to check if service is alive
+     *
+     * This can involve any kind of check that makes sense in the context of a particular service.
+     */
+    isAlive?: IsAliveCallback;
+};
+/**
+ * Runs aliveness check and serves the result
+ *
+ * Responds with 200 if service is alive.
+ * Typically used by Kubernetes aliveness probe.
+ *
+ * If no isAlive callback is provided, the route will always respond with 200 as long as the application didn't freeze.
+ */
+export declare function routeAliveness({ router, isAlive }: AlivenessRouteArgs): void;

package/dist/Service/HTTP/routes/monitoring/aliveness.js

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeAliveness = routeAliveness;
+var http_status_1 = __importDefault(require("http-status"));
+/**
+ * Runs aliveness check and serves the result
+ *
+ * Responds with 200 if service is alive.
+ * Typically used by Kubernetes aliveness probe.
+ *
+ * If no isAlive callback is provided, the route will always respond with 200 as long as the application didn't freeze.
+ */
+function routeAliveness(_a) {
+    var _this = this;
+    var router = _a.router, isAlive = _a.isAlive;
+    router.get('/alive', function (_req, res) { return __awaiter(_this, void 0, void 0, function () {
+        var alive, status_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!isAlive) return [3 /*break*/, 2];
+                    return [4 /*yield*/, isAlive()];
+                case 1:
+                    alive = _a.sent();
+                    status_1 = alive ? http_status_1.default.OK : http_status_1.default.SERVICE_UNAVAILABLE;
+                    res.sendStatus(status_1);
+                    return [3 /*break*/, 3];
+                case 2:
+                    res.sendStatus(http_status_1.default.OK);
+                    _a.label = 3;
+                case 3: return [2 /*return*/];
+            }
+        });
+    }); });
+}
+//# sourceMappingURL=aliveness.js.map

package/dist/Service/HTTP/routes/monitoring/aliveness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aliveness.js","sourceRoot":"","sources":["../../../../../src/Service/HTTP/routes/monitoring/aliveness.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,wCAUC;AAjCD,4DAAqC;AAerC;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,EAAuC;IAAtE,iBAUC;QAVgC,MAAM,YAAA,EAAE,OAAO,aAAA;IAC/C,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAO,IAAa,EAAE,GAAa;;;;;yBACnD,OAAO,EAAP,wBAAO;oBACI,qBAAM,OAAO,EAAE,EAAA;;oBAAvB,KAAK,GAAG,SAAe;oBACvB,WAAS,KAAK,CAAC,CAAC,CAAC,qBAAU,CAAC,EAAE,CAAC,CAAC,CAAC,qBAAU,CAAC,mBAAmB,CAAC;oBACtE,GAAG,CAAC,UAAU,CAAC,QAAM,CAAC,CAAC;;;oBAEvB,GAAG,CAAC,UAAU,CAAC,qBAAU,CAAC,EAAE,CAAC,CAAC;;;;;SAE/B,CAAC,CAAC;AACJ,CAAC"}

package/dist/Service/HTTP/routes/monitoring/metrics.d.ts

@@ -0,0 +1,9 @@
+import { Router } from 'express';
+import { IMetricsClient } from '../../../../Metrics/MetricsClient';
+/**
+ * Serves metrics for Prometheus
+ */
+export declare const routeMetrics: ({ router, metricsClient }: {
+    router: Router;
+    metricsClient: IMetricsClient;
+}) => void;

package/dist/Service/HTTP/routes/monitoring/metrics.js

@@ -0,0 +1,59 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeMetrics = void 0;
+/**
+ * Serves metrics for Prometheus
+ */
+var routeMetrics = function (_a) {
+    var router = _a.router, metricsClient = _a.metricsClient;
+    // TODO: Prometheus client shouldn't be on public server. The endpoints shouldn't be reachable from outside
+    router.get('/metrics', function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            try {
+                return [2 /*return*/, metricsClient.serve(res)];
+            }
+            catch (err) {
+                return [2 /*return*/, res.status(500).send("Error scraping prometheus metrics: ".concat(err))];
+            }
+            return [2 /*return*/];
+        });
+    }); });
+};
+exports.routeMetrics = routeMetrics;
+//# sourceMappingURL=metrics.js.map

package/dist/Service/HTTP/routes/monitoring/metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../../../src/Service/HTTP/routes/monitoring/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA;;GAEG;AACI,IAAM,YAAY,GAAG,UAAC,EAA4E;QAA1E,MAAM,YAAA,EAAE,aAAa,mBAAA;IACnD,2GAA2G;IAC3G,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,UAAO,IAAa,EAAE,GAAa;;YACzD,IAAI,CAAC;gBACJ,sBAAO,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,EAAC;YACjC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,sBAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,6CAAsC,GAAG,CAAE,CAAC,EAAC;YAC1E,CAAC;;;SACD,CAAC,CAAC;AACJ,CAAC,CAAC;AATW,QAAA,YAAY,gBASvB"}

package/dist/Service/HTTP/routes/monitoring/readniness.d.ts

@@ -0,0 +1,18 @@
+import { Router } from 'express';
+export interface IsReadyResultObject {
+    ready: boolean;
+    response: any;
+}
+export type IsReadyResult = IsReadyResultObject | boolean;
+export type IsReadyCallback = () => Promise<IsReadyResult> | IsReadyResult;
+export type ReadinessRouteArgs = {
+    router: Router;
+    isReady?: IsReadyCallback;
+};
+/**
+ * Runs readiness check and serves the result
+ *
+ * Responds with 200 if service is ready to serve requests.
+ * Typically used by Kubernetes readiness probe.
+ */
+export declare function routeReadiness({ router, isReady }: ReadinessRouteArgs): void;

package/dist/Service/HTTP/routes/monitoring/readniness.js

@@ -0,0 +1,80 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeReadiness = routeReadiness;
+var http_status_1 = __importDefault(require("http-status"));
+/**
+ * Runs readiness check and serves the result
+ *
+ * Responds with 200 if service is ready to serve requests.
+ * Typically used by Kubernetes readiness probe.
+ */
+function routeReadiness(_a) {
+    var _this = this;
+    var router = _a.router, isReady = _a.isReady;
+    router.get('/ready', function (_req, res) { return __awaiter(_this, void 0, void 0, function () {
+        var result, ready, response, status_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!isReady) return [3 /*break*/, 2];
+                    return [4 /*yield*/, isReady()];
+                case 1:
+                    result = _a.sent();
+                    ready = typeof result === 'boolean' ? result : result.ready;
+                    response = typeof result === 'boolean' ? undefined : result.response;
+                    status_1 = ready ? http_status_1.default.OK : http_status_1.default.SERVICE_UNAVAILABLE;
+                    if (response) {
+                        res.status(status_1).send(response);
+                    }
+                    else {
+                        res.sendStatus(status_1);
+                    }
+                    return [3 /*break*/, 3];
+                case 2:
+                    res.sendStatus(http_status_1.default.OK);
+                    _a.label = 3;
+                case 3: return [2 /*return*/];
+            }
+        });
+    }); });
+}
+//# sourceMappingURL=readniness.js.map

package/dist/Service/HTTP/routes/monitoring/readniness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readniness.js","sourceRoot":"","sources":["../../../../../src/Service/HTTP/routes/monitoring/readniness.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBA,wCAkBC;AAxCD,4DAAqC;AAgBrC;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,EAAuC;IAAtE,iBAkBC;QAlBgC,MAAM,YAAA,EAAE,OAAO,aAAA;IAC/C,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAO,IAAa,EAAE,GAAa;;;;;yBACnD,OAAO,EAAP,wBAAO;oBACK,qBAAM,OAAO,EAAE,EAAA;;oBAAxB,MAAM,GAAG,SAAe;oBACxB,KAAK,GAAG,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;oBAC5D,QAAQ,GAAG,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAErE,WAAS,KAAK,CAAC,CAAC,CAAC,qBAAU,CAAC,EAAE,CAAC,CAAC,CAAC,qBAAU,CAAC,mBAAmB,CAAC;oBAEtE,IAAI,QAAQ,EAAE,CAAC;wBACd,GAAG,CAAC,MAAM,CAAC,QAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACP,GAAG,CAAC,UAAU,CAAC,QAAM,CAAC,CAAC;oBACxB,CAAC;;;oBAED,GAAG,CAAC,UAAU,CAAC,qBAAU,CAAC,EAAE,CAAC,CAAC;;;;;SAE/B,CAAC,CAAC;AACJ,CAAC"}

package/dist/Service/HTTP/routes/monitoring/router.d.ts

@@ -0,0 +1,10 @@
+import { Router } from 'express';
+import { IMetricsClient } from '../../../../Metrics/MetricsClient';
+import { IsReadyCallback } from './readniness';
+import { IsAliveCallback } from './aliveness';
+export declare function routeMonitoring(args: {
+    router: Router;
+    metricsClient: IMetricsClient;
+    isReady?: IsReadyCallback;
+    isAlive?: IsAliveCallback;
+}): void;

package/dist/Service/HTTP/routes/monitoring/router.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeMonitoring = routeMonitoring;
+var readniness_1 = require("./readniness");
+var aliveness_1 = require("./aliveness");
+var metrics_1 = require("./metrics");
+function routeMonitoring(args) {
+    (0, readniness_1.routeReadiness)(args);
+    (0, aliveness_1.routeAliveness)(args);
+    (0, metrics_1.routeMetrics)(args);
+}
+//# sourceMappingURL=router.js.map

package/dist/Service/HTTP/routes/monitoring/router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../../../../../src/Service/HTTP/routes/monitoring/router.ts"],"names":[],"mappings":";;AAMA,0CASC;AAbD,2CAA+D;AAC/D,yCAA8D;AAC9D,qCAAyC;AAEzC,SAAgB,eAAe,CAAC,IAK/B;IACA,IAAA,2BAAc,EAAC,IAAI,CAAC,CAAC;IACrB,IAAA,0BAAc,EAAC,IAAI,CAAC,CAAC;IACrB,IAAA,sBAAY,EAAC,IAAI,CAAC,CAAC;AACpB,CAAC"}

package/dist/Service/HTTP/server/serverFactory.d.ts

@@ -0,0 +1,10 @@
+import * as http from 'http';
+import { Application } from 'express';
+/**
+ * Create a HTTP server from an Express app running on a given port
+ */
+export declare function createServer(app: Application, port: number): {
+    server: http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    listen(): Promise<void>;
+    close(): Promise<void>;
+};