@pgds/api-interface 1.6.2 → 1.6.4

package/lib/utils/utils.js

@@ -0,0 +1,127 @@
+"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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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.performFatalShutdown = performFatalShutdown;
+exports.setupHealthChecks = setupHealthChecks;
+var restify_errors_1 = require("restify-errors");
+var __1 = require("..");
+var organizationHierarchyRepo_1 = __importDefault(require("../repositories/organizationHierarchyRepo"));
+var server_1 = require("../server/server");
+var logger_1 = require("./logger");
+var util_1 = require("util");
+/**
+ * Attempts a server shut down and exits process if shut down fails.
+ * Only to be used for fatal errors (e.g. Redis errors)
+ * @param err The error that caused the fatal shutdown
+ * @returns Never returns, always throws the original error after attempting shutdown
+ * @throws The original error passed as parameter
+ */
+function performFatalShutdown(err) {
+    return __awaiter(this, void 0, void 0, function () {
+        var logger, inspectedError, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    try {
+                        logger = (0, logger_1.getLogger)();
+                    }
+                    catch (_b) {
+                        /* If error happens before logger is set up, we will get an error while using getLogger, so fallback to console.error */
+                        logger = console;
+                    }
+                    inspectedError = (0, util_1.inspect)(err);
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    logger.error("Redis Client Error: ".concat(err.message), inspectedError);
+                    return [4 /*yield*/, (0, server_1.closeServer)()];
+                case 2:
+                    _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    err_1 = _a.sent();
+                    logger.error("Error while closing server after Redis error: ".concat(err_1.message), inspectedError);
+                    process.exit(1);
+                    return [3 /*break*/, 4];
+                case 4: 
+                /* Will never reach this point, but to satisfy TypeScript's "never" return type */
+                throw err;
+            }
+        });
+    });
+}
+/**
+ * Currently supports redis healthchecks
+ */
+function setupHealthChecks() {
+    var _this = this;
+    /* Restify incorrectly throws an error if next is not a parameter, even if the function is async (and can't use it without trigger the next function twice) */
+    server_1.server.use(function (req, _res, _next) { return __awaiter(_this, void 0, void 0, function () {
+        var healthPaths;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    healthPaths = ["/".concat((0, __1.getApiOptions)().apiVersion, "/healthz"), "/".concat((0, __1.getApiOptions)().apiVersion, "/readyz")];
+                    if (!healthPaths.includes(req.getPath())) return [3 /*break*/, 2];
+                    return [4 /*yield*/, redisHealthCheck()];
+                case 1:
+                    _a.sent();
+                    _a.label = 2;
+                case 2: return [2 /*return*/];
+            }
+        });
+    }); });
+}
+function redisHealthCheck() {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, organizationHierarchyRepo_1.default.isHealthy()];
+                case 1:
+                    if (!(_a.sent())) {
+                        throw new restify_errors_1.InternalServerError("Redis health check failed");
+                    }
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+//# sourceMappingURL=utils.js.map

package/lib/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAeA,oDAuBC;AAKD,8CASC;AApDD,iDAAqD;AACrD,wBAAmC;AACnC,wGAAkF;AAClF,2CAAuD;AACvD,mCAAqC;AACrC,6BAA+B;AAG/B;;;;;;GAMG;AACH,SAAsB,oBAAoB,CAAC,GAAQ;;;;;;oBAGjD,IAAI,CAAC;wBACH,MAAM,GAAG,IAAA,kBAAS,GAAE,CAAC;oBACvB,CAAC;oBAAC,WAAM,CAAC;wBACP,wHAAwH;wBACxH,MAAM,GAAG,OAAO,CAAC;oBACnB,CAAC;oBAEK,cAAc,GAAG,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;;;;oBAGlC,MAAM,CAAC,KAAK,CAAC,8BAAuB,GAAG,CAAC,OAAO,CAAE,EAAE,cAAc,CAAC,CAAC;oBACnE,qBAAM,IAAA,oBAAW,GAAE,EAAA;;oBAAnB,SAAmB,CAAC;;;;oBAEpB,MAAM,CAAC,KAAK,CAAC,wDAAiD,KAAG,CAAC,OAAO,CAAE,EAAE,cAAc,CAAC,CAAC;oBAE7F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;;gBAGlB,kFAAkF;gBAClF,MAAM,GAAG,CAAC;;;;CACX;AAED;;GAEG;AACH,SAAgB,iBAAiB;IAAjC,iBASC;IARC,8JAA8J;IAC9J,eAAM,CAAC,GAAG,CAAC,UAAO,GAAY,EAAE,IAAc,EAAE,KAAW;;;;;oBACnD,WAAW,GAAG,CAAC,WAAI,IAAA,iBAAa,GAAE,CAAC,UAAU,aAAU,EAAE,WAAI,IAAA,iBAAa,GAAE,CAAC,UAAU,YAAS,CAAC,CAAC;yBAEpG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAnC,wBAAmC;oBACrC,qBAAM,gBAAgB,EAAE,EAAA;;oBAAxB,SAAwB,CAAC;;;;;SAE5B,CAAC,CAAC;AACL,CAAC;AAED,SAAe,gBAAgB;;;;wBACvB,qBAAM,mCAAyB,CAAC,SAAS,EAAE,EAAA;;oBAAjD,IAAI,CAAC,CAAC,SAA2C,CAAC,EAAE,CAAC;wBACnD,MAAM,IAAI,oCAAmB,CAAC,2BAA2B,CAAC,CAAC;oBAC7D,CAAC;;;;;CACF"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@pgds/api-interface",
   "description": "Api interface for pgds services",
   "authors": "Florry",
-  "version": "1.6.2",
+  "version": "1.6.4",
   "main": "index.js",
   "types": "types/",
   "scripts": {
@@ -102,4 +102,4 @@
       "**/*.js.map"
     ]
   }
-}
+}