@routr/registry 2.0.8-alpha.4 → 2.0.8-alpha.41

package/dist/config/get_config.js

@@ -28,7 +28,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConfig = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -46,29 +46,29 @@ exports.getConfig = void 0;
  * limitations under the License.
  */
 const types_1 = require("../types");
-const fs_1 = __importDefault(require("fs"));
 const schema_1 = require("./schema");
 const ajv_1 = __importDefault(require("ajv"));
 const E = __importStar(require("fp-ts/Either"));
 const errors_1 = require("../errors");
+const common_1 = require("@routr/common");
 const ajv = new ajv_1.default();
 const validate = ajv.compile(schema_1.schema);
 const getConfig = (path) => {
     var _a, _b, _c;
-    const c = JSON.parse(fs_1.default.readFileSync(path, "utf8"));
+    const c = common_1.Helper.readConfigFile(path);
     if (!validate(Object.assign({}, c))) {
         return E.left(new errors_1.InvalidSchemaConfiguration(JSON.stringify(validate.errors[0].message)));
     }
     const config = c.spec;
     if (!((_a = config === null || config === void 0 ? void 0 : config.cache) === null || _a === void 0 ? void 0 : _a.provider)) {
         config.cache = {
-            provider: types_1.CACHE_PROVIDER.MEMORY
+            provider: types_1.CacheProvider.MEMORY
         };
     }
-    if (((_b = config === null || config === void 0 ? void 0 : config.cache) === null || _b === void 0 ? void 0 : _b.provider) === types_1.CACHE_PROVIDER.REDIS &&
+    if (((_b = config === null || config === void 0 ? void 0 : config.cache) === null || _b === void 0 ? void 0 : _b.provider) === types_1.CacheProvider.REDIS &&
         !((_c = config === null || config === void 0 ? void 0 : config.cache) === null || _c === void 0 ? void 0 : _c.parameters)) {
         config.cache = {
-            provider: types_1.CACHE_PROVIDER.REDIS,
+            provider: types_1.CacheProvider.REDIS,
             parameters: "host=localhost,port=6379"
         };
     }

package/dist/config/schema.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/envs.d.ts

@@ -0,0 +1,2 @@
+export declare const CONFIG_PATH: string;
+export declare const ENABLE_HEALTHCHECKS: boolean;

package/dist/envs.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENABLE_HEALTHCHECKS = exports.CONFIG_PATH = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const common_1 = require("@routr/common");
+common_1.Assertions.assertEnvsAreSet(["CONFIG_PATH"]);
+exports.CONFIG_PATH = process.env.CONFIG_PATH;
+exports.ENABLE_HEALTHCHECKS = process.env.ENABLE_HEALTHCHECKS !== "false";

package/dist/errors.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvalidSchemaConfiguration = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/request.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPortFromAddress = exports.getHostFromAddress = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -135,6 +135,8 @@ function createRegistrationRequest(params) {
                 methodParam: common_1.Method.REGISTER,
                 secure: params.secure
             },
+            via: [],
+            recordRoute: [],
             messageType: common_1.CommonTypes.MessageType.REQUEST
         }
     };

package/dist/runner.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -26,14 +26,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("./tracer").init("dispatcher");
 const service_1 = __importDefault(require("./service"));
 const get_config_1 = require("./config/get_config");
-const common_1 = require("@routr/common");
 const logger_1 = require("@fonoster/logger");
+const envs_1 = require("./envs");
+const express_1 = __importDefault(require("express"));
+const app = (0, express_1.default)();
+const healthPort = 8080;
 const logger = (0, logger_1.getLogger)({ service: "registry", filePath: __filename });
-common_1.Assertions.assertEnvsAreSet(["CONFIG_PATH"]);
-const config = (0, get_config_1.getConfig)(process.env.CONFIG_PATH);
+const config = (0, get_config_1.getConfig)(envs_1.CONFIG_PATH);
 if (config._tag === "Right") {
     (0, service_1.default)(config.right);
 }
 else {
     logger.error(config.left);
 }
+if (envs_1.ENABLE_HEALTHCHECKS) {
+    app.get("/healthz", (_, res) => {
+        res.send("OK");
+    });
+    app.listen(healthPort, () => {
+        logger.info(`health check endpoint listening on port ${healthPort}`);
+    });
+}

package/dist/sender.d.ts

@@ -1,3 +1,3 @@
-import { ServiceUnavailableError } from "@routr/common";
+import { CommonErrors as CE } from "@routr/common";
 import { RegistrationRequest, SendMessageResponse } from "./types";
-export declare const sendRegisterMessage: (requesterAddr: string) => (request: RegistrationRequest) => Promise<ServiceUnavailableError | SendMessageResponse>;
+export declare const sendRegisterMessage: (requesterAddr: string) => (request: RegistrationRequest) => Promise<CE.ServiceUnavailableError | SendMessageResponse>;

package/dist/sender.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sendRegisterMessage = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -44,14 +44,13 @@ exports.sendRegisterMessage = void 0;
  */
 const grpc = __importStar(require("@grpc/grpc-js"));
 const common_1 = require("@routr/common");
-const common_2 = require("@routr/common");
 const sendRegisterMessage = (requesterAddr) => {
     return (request) => {
-        const client = new common_2.CommonRequester.REQUESTER_PROTO.v2draft1.Requester(requesterAddr, grpc.credentials.createInsecure());
+        const client = new common_1.CommonRequester.REQUESTER_PROTO.v2draft1.Requester(requesterAddr, grpc.credentials.createInsecure());
         return new Promise((resolve, reject) => {
             client.sendMessage(request, (err, response) => {
                 if ((err === null || err === void 0 ? void 0 : err.code) === 14) {
-                    return reject(new common_1.ServiceUnavailableError(requesterAddr));
+                    return reject(new common_1.CommonErrors.ServiceUnavailableError(requesterAddr));
                 }
                 else if (err) {
                     return reject(err);

package/dist/service.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -36,7 +36,6 @@ const types_1 = require("./types");
 const utils_1 = require("./utils");
 const common_1 = require("@routr/common");
 const logger_1 = require("@fonoster/logger");
-const common_2 = require("@routr/common");
 const logger = (0, logger_1.getLogger)({ service: "registry", filePath: __filename });
 const DEFAULT_REGISTRATION_INTERVAL = 60;
 // TODO:
@@ -49,15 +48,15 @@ const DEFAULT_REGISTRATION_INTERVAL = 60;
 function registryService(config) {
     var _a;
     logger.info("starting registry service");
-    const registerInterval = (_a = config.registerInterval) !== null && _a !== void 0 ? _a : DEFAULT_REGISTRATION_INTERVAL;
     const store = (0, utils_1.buildStore)(config);
+    const dataAPI = common_1.CommonConnect.apiClient({ apiAddr: config.apiAddr });
+    const registerInterval = (_a = config.registerInterval) !== null && _a !== void 0 ? _a : DEFAULT_REGISTRATION_INTERVAL;
     // Creates internval to send registration request every X seconds
     setInterval(() => __awaiter(this, void 0, void 0, function* () {
         logger.verbose("starting registration process");
-        let resources = [];
-        const dataAPI = common_1.CommonConnect.dataAPI(config.apiAddr);
+        let trunks = [];
         try {
-            resources = yield (0, utils_1.findTrunks)(dataAPI);
+            trunks = yield (0, utils_1.findTrunks)(dataAPI);
         }
         catch (err) {
             logger.error("failed to retrieve trunks from API", err);
@@ -65,10 +64,10 @@ function registryService(config) {
         }
         // Create a list of trunks in the Store
         const trunksInStore = (yield store.list()).map((r) => r.trunkRef);
-        const registryInvocations = resources
-            .filter((resources) => !trunksInStore.includes(resources.ref))
-            .map((resource) => __awaiter(this, void 0, void 0, function* () {
-            const registrationRequestInput = (0, utils_1.registrationRequestInputFromTrunk)(yield (0, utils_1.convertResourceToTrunk)(dataAPI, resource), config);
+        const registryInvocations = trunks
+            .filter((trunk) => !trunksInStore.includes(trunk.ref))
+            .map((trunk) => __awaiter(this, void 0, void 0, function* () {
+            const registrationRequestInput = (0, utils_1.registrationRequestInputFromTrunk)(trunk, config);
             const request = (0, request_1.default)(registrationRequestInput);
             return (0, sender_1.sendRegisterMessage)(config.requesterAddr)(request);
         }));
@@ -80,7 +79,7 @@ function registryService(config) {
                 logger.error("request rejected", result.reason);
                 return;
             }
-            if (result.value instanceof common_2.ServiceUnavailableError) {
+            if (result.value instanceof common_1.CommonErrors.ServiceUnavailableError) {
                 logger.error("service unavailable", result.value);
                 return;
             }
@@ -88,7 +87,7 @@ function registryService(config) {
             // Makes sure we send register before the last register expires
             const retentionTime = ((_e = (_c = (_b = message.contact) === null || _b === void 0 ? void 0 : _b.expires) !== null && _c !== void 0 ? _c : (_d = message.expires) === null || _d === void 0 ? void 0 : _d.expires) !== null && _e !== void 0 ? _e : types_1.DEFAULT_EXPIRES) - registerInterval;
             // TODO: Refactor to use ResponseType instead of string
-            const status = message.responseType.toString() == "OK"
+            const status = message.responseType == common_1.CommonTypes.ResponseType.OK
                 ? types_1.RegistrationEntryStatus.REGISTERED
                 : types_1.RegistrationEntryStatus.QUARANTINE;
             // Storing trunk in registry with status and retention time

package/dist/tracer.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = void 0;
 /*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/types.d.ts

@@ -2,7 +2,7 @@ import { Method, Transport } from "@routr/common";
 import { SIPMessage } from "@routr/common/src/types";
 export declare const DEFAULT_MAX_FORWARDS = 70;
 export declare const DEFAULT_EXPIRES = 600;
-export declare enum CACHE_PROVIDER {
+export declare enum CacheProvider {
     MEMORY = "memory",
     REDIS = "redis"
 }
@@ -21,7 +21,7 @@ export interface RegistryConfig {
     registerInterval: number;
     methods: Method[];
     cache?: {
-        provider: CACHE_PROVIDER;
+        provider: CacheProvider;
         parameters?: string;
     };
 }

package/dist/types.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegistrationEntryStatus = exports.CACHE_PROVIDER = exports.DEFAULT_EXPIRES = exports.DEFAULT_MAX_FORWARDS = void 0;
+exports.RegistrationEntryStatus = exports.CacheProvider = exports.DEFAULT_EXPIRES = exports.DEFAULT_MAX_FORWARDS = void 0;
 exports.DEFAULT_MAX_FORWARDS = 70;
 exports.DEFAULT_EXPIRES = 600;
-var CACHE_PROVIDER;
-(function (CACHE_PROVIDER) {
-    CACHE_PROVIDER["MEMORY"] = "memory";
-    CACHE_PROVIDER["REDIS"] = "redis";
-})(CACHE_PROVIDER = exports.CACHE_PROVIDER || (exports.CACHE_PROVIDER = {}));
+var CacheProvider;
+(function (CacheProvider) {
+    CacheProvider["MEMORY"] = "memory";
+    CacheProvider["REDIS"] = "redis";
+})(CacheProvider = exports.CacheProvider || (exports.CacheProvider = {}));
 var RegistrationEntryStatus;
 (function (RegistrationEntryStatus) {
     RegistrationEntryStatus["REGISTERED"] = "registered";

package/dist/utils.d.ts

@@ -1,20 +1,18 @@
-import { Transport } from "@routr/common";
 import { CommonConnect as CC } from "@routr/common";
 import MemoryStore from "./memory_store";
 import RedisStore from "./redis_store";
 import { IRegistryStore, RegistryConfig, Trunk } from "./types";
 export declare function getUnregisteredTrunks(store: IRegistryStore): (trunks: Trunk[]) => Promise<Trunk[]>;
-export declare function findTrunks(dataAPI: CC.DataAPI): Promise<CC.Resource[]>;
+export declare function findTrunks(apiClient: CC.APIClient): Promise<CC.Trunk[]>;
 export declare const configFromString: (params: string, allowedKeys: string[]) => Record<string, string | boolean>;
 export declare const buildStore: (config: RegistryConfig) => MemoryStore | RedisStore;
-export declare const convertResourceToTrunk: (dataAPI: CC.DataAPI, resource: CC.Resource) => Promise<Trunk>;
-export declare const registrationRequestInputFromTrunk: (trunk: Trunk, config: RegistryConfig) => {
+export declare const registrationRequestInputFromTrunk: (trunk: CC.Trunk, config: RegistryConfig) => {
     trunkRef: string;
     user: string;
     targetDomain: string;
     targetAddress: string;
     proxyAddress: string;
-    transport: Transport;
+    transport: import("@routr/common").Transport;
     auth: {
         username: string;
         secret: string;

package/dist/utils.js

@@ -12,27 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registrationRequestInputFromTrunk = exports.convertResourceToTrunk = exports.buildStore = exports.configFromString = exports.findTrunks = exports.getUnregisteredTrunks = void 0;
-/*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster
- *
- * This file is part of Routr.
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const common_1 = require("@routr/common");
-const common_2 = require("@routr/common");
+exports.registrationRequestInputFromTrunk = exports.buildStore = exports.configFromString = exports.findTrunks = exports.getUnregisteredTrunks = void 0;
 const memory_store_1 = __importDefault(require("./memory_store"));
 const redis_store_1 = __importDefault(require("./redis_store"));
 const types_1 = require("./types");
@@ -47,13 +27,12 @@ function getUnregisteredTrunks(store) {
 }
 exports.getUnregisteredTrunks = getUnregisteredTrunks;
 // eslint-disable-next-line require-jsdoc
-function findTrunks(dataAPI) {
+function findTrunks(apiClient) {
     return __awaiter(this, void 0, void 0, function* () {
-        return yield dataAPI.findBy({
-            kind: common_2.CommonConnect.KIND.TRUNK,
-            criteria: common_2.CommonConnect.FindCriteria.FIND_TRUNKS_WITH_SEND_REGISTER,
-            parameters: {}
-        });
+        return (yield apiClient.trunks.findBy({
+            fieldName: "sendRegister",
+            fieldValue: "true"
+        })).items;
     });
 }
 exports.findTrunks = findTrunks;
@@ -80,7 +59,7 @@ const configFromString = (params, allowedKeys) => {
 };
 exports.configFromString = configFromString;
 const buildStore = (config) => {
-    if (config.cache.provider === types_1.CACHE_PROVIDER.REDIS) {
+    if (config.cache.provider === types_1.CacheProvider.REDIS) {
         const allowedParameters = ["host", "port", "username", "password", "secure"];
         return new redis_store_1.default((0, exports.configFromString)(config.cache.parameters, allowedParameters));
     }
@@ -89,39 +68,21 @@ const buildStore = (config) => {
     }
 };
 exports.buildStore = buildStore;
-const convertResourceToTrunk = (dataAPI, resource) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c, _d, _e, _f;
-    const metadata = resource.metadata;
-    const trunkSpec = resource.spec;
-    const uri = (_b = (_a = trunkSpec.outbound) === null || _a === void 0 ? void 0 : _a.uris[0]) === null || _b === void 0 ? void 0 : _b.uri;
-    // WARNING: Perhaps we should bring this on a single API call
-    const cred = yield dataAPI.get((_c = trunkSpec.outbound) === null || _c === void 0 ? void 0 : _c.credentialsRef);
-    const usernameAndPassword = cred === null || cred === void 0 ? void 0 : cred.spec.credentials;
-    return {
-        ref: resource.ref,
-        name: resource.metadata.name,
-        region: metadata.region,
-        host: uri.host,
-        port: (_d = uri.port) !== null && _d !== void 0 ? _d : 5060,
-        user: uri.user,
-        credentials: {
-            username: usernameAndPassword === null || usernameAndPassword === void 0 ? void 0 : usernameAndPassword.username,
-            secret: usernameAndPassword === null || usernameAndPassword === void 0 ? void 0 : usernameAndPassword.password
-        },
-        transport: (_f = (_e = uri.transport) === null || _e === void 0 ? void 0 : _e.toLowerCase()) !== null && _f !== void 0 ? _f : common_1.Transport.UDP
-    };
-});
-exports.convertResourceToTrunk = convertResourceToTrunk;
 const registrationRequestInputFromTrunk = (trunk, config) => {
+    var _a, _b;
+    const uri = trunk.uris[0];
     return {
         trunkRef: trunk.ref,
-        user: trunk.user,
-        targetDomain: trunk.host,
-        targetAddress: `${trunk.host}:${trunk.port}`,
+        user: uri.user,
+        targetDomain: uri.host,
+        targetAddress: `${uri.host}:${uri.port}`,
         // TODO: Find closest edgeport instead of [0]
         proxyAddress: config.edgePorts[0].address,
-        transport: trunk.transport,
-        auth: trunk.credentials,
+        transport: uri.transport,
+        auth: {
+            username: (_a = trunk.outboundCredentials) === null || _a === void 0 ? void 0 : _a.username,
+            secret: (_b = trunk.outboundCredentials) === null || _b === void 0 ? void 0 : _b.password
+        },
         methods: config.methods
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/registry",
-  "version": "2.0.8-alpha.4",
+  "version": "2.0.8-alpha.41",
   "description": "Sends trunks registrations and maintains their bindings",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -12,7 +12,8 @@
     "build": "tsc -b tsconfig.json"
   },
   "bin": {
-    "run_registry": "dist/runner.js"
+    "run_registry": "dist/runner.js",
+    "healthcheck_registry": "dist/healthcheck.js"
   },
   "directories": {
     "src": "src",
@@ -25,7 +26,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@grpc/grpc-js": "^1.5.9",
+    "@grpc/grpc-js": "^1.8.4",
     "@opentelemetry/api": "^1.0.4",
     "@opentelemetry/exporter-jaeger": "^1.0.4",
     "@opentelemetry/instrumentation": "^0.27.0",
@@ -34,9 +35,10 @@
     "@opentelemetry/sdk-trace-base": "^1.0.4",
     "@opentelemetry/sdk-trace-node": "^1.0.4",
     "@opentelemetry/semantic-conventions": "^1.0.4",
-    "@routr/common": "^2.0.8-alpha.4",
-    "@routr/processor": "^2.0.8-alpha.4",
+    "@routr/common": "^2.0.8-alpha.41",
+    "@routr/processor": "^2.0.8-alpha.41",
     "ajv": "^6.12.6",
+    "express": "^4.18.2",
     "fp-ts": "^2.11.8",
     "pb-util": "^1.0.3",
     "redis": "^4.0.4",
@@ -50,7 +52,8 @@
     "url": "https://github.com/fonoster/routr/issues"
   },
   "devDependencies": {
+    "@types/express": "^4.17.17",
     "@types/uniqid": "^5.3.2"
   },
-  "gitHead": "320abeb05175976ddfca265096a2ea63004607f4"
+  "gitHead": "52f44320b57824dfea40f48b02b44b9a8e6bdda3"
 }