@routr/location 2.0.5-alpha.2 → 2.0.5-alpha.21

package/dist/types.d.ts

@@ -1,28 +1,22 @@
+import { Route } from "@routr/common";
 export declare enum LB_ALGORITHM {
     ROUND_ROBIN = "round-robin",
     LEAST_SESSIONS = "least-sessions"
 }
+export declare enum CACHE_PROVIDER {
+    MEMORY = "memory",
+    REDIS = "redis"
+}
 export interface ILocationService {
     addRoute(request: AddRouteRequest): Promise<void>;
     findRoutes(request: FindRoutesRequest): Promise<Route[]>;
-    removeRoutes(request: RemoveRouteRequest): Promise<void>;
+    removeRoutes(request: RemoveRoutesRequest): Promise<void>;
 }
 export interface ILocatorStore {
     put(key: string, route: Route): Promise<void>;
     get(key: string): Promise<Route[]>;
     delete(key: string): Promise<void>;
 }
-export interface Route {
-    user: string;
-    host: string;
-    port: number;
-    transport: string;
-    registeredOn: number;
-    sessionCount?: number;
-    expires: number;
-    edgePortRef: string;
-    labels?: Map<string, string>;
-}
 export interface AddRouteRequest {
     aor: string;
     route: Route;
@@ -35,18 +29,26 @@ export interface FindRoutesRequest {
 export interface FindRoutesResponse {
     routes: Array<Route>;
 }
-export interface RemoveRouteRequest {
+export interface RemoveRoutesRequest {
     aor: string;
 }
 export interface Backend {
     ref: string;
     balancingAlgorithm?: LB_ALGORITHM;
-    sessionAffinity?: {
-        enabled: boolean;
-        ref: string;
-    };
+    withSessionAffinity?: boolean;
 }
 export interface LocationConfig {
     bindAddr: string;
     backends?: Backend[];
+    cache?: {
+        provider: CACHE_PROVIDER;
+        parameters?: string;
+    };
+}
+export interface RedisStoreConfig {
+    username?: string;
+    password?: string;
+    host: string;
+    port: number;
+    secure?: boolean;
 }

package/dist/types.js

@@ -1,26 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LB_ALGORITHM = void 0;
-/*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/routr
- *
- * 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.
- */
+exports.CACHE_PROVIDER = exports.LB_ALGORITHM = void 0;
 var LB_ALGORITHM;
 (function (LB_ALGORITHM) {
     LB_ALGORITHM["ROUND_ROBIN"] = "round-robin";
     LB_ALGORITHM["LEAST_SESSIONS"] = "least-sessions";
 })(LB_ALGORITHM = exports.LB_ALGORITHM || (exports.LB_ALGORITHM = {}));
+var CACHE_PROVIDER;
+(function (CACHE_PROVIDER) {
+    CACHE_PROVIDER["MEMORY"] = "memory";
+    CACHE_PROVIDER["REDIS"] = "redis";
+})(CACHE_PROVIDER = exports.CACHE_PROVIDER || (exports.CACHE_PROVIDER = {}));

package/dist/utils.d.ts

@@ -1,9 +1,9 @@
-import { Backend, ILocationService, Route } from "./types";
-import { ServiceInfo } from "@routr/common";
+import { Route, ServiceInfo } from "@routr/common";
+import { ILocationService } from "./types";
 export declare const expiredFilter: (r: Route) => boolean;
 export declare const duplicateFilter: (r1: Route, r2: Route) => boolean;
 export declare const mergeKeyValue: (map: Map<string, string>) => string[];
 export declare const compareArrays: (arr: string[], target: string[]) => boolean;
 export declare const filterOnlyMatchingLabels: (requestLabels: Map<string, string>) => (route: Route) => boolean;
-export declare const hasAffinitySession: (backend: Backend) => boolean;
-export declare function getServiceInfo(bindAddr: string, locator: ILocationService): ServiceInfo;
+export declare const getServiceInfo: (bindAddr: string, locator: ILocationService) => ServiceInfo;
+export declare const configFromString: (params: string, allowedKeys: string[]) => Record<string, string | boolean>;

package/dist/utils.js

@@ -8,67 +8,48 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 (_) 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.getServiceInfo = exports.hasAffinitySession = exports.filterOnlyMatchingLabels = exports.compareArrays = exports.mergeKeyValue = exports.duplicateFilter = exports.expiredFilter = void 0;
-var common_1 = require("@routr/common");
-var errors_1 = require("./errors");
-var expiredFilter = function (r) {
-    return (r.expires - (Date.now() - r.registeredOn) / 1000) > 0;
-};
+exports.configFromString = exports.getServiceInfo = exports.filterOnlyMatchingLabels = exports.compareArrays = exports.mergeKeyValue = exports.duplicateFilter = exports.expiredFilter = void 0;
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/routr
+ *
+ * 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 errors_1 = require("./errors");
+const expiredFilter = (r) => r.expires - (Date.now() - r.registeredOn) / 1000 > 0;
 exports.expiredFilter = expiredFilter;
-var duplicateFilter = function (r1, r2) {
-    return !(r1.host === r2.host && r1.port === r2.port);
-};
+const duplicateFilter = (r1, r2) => !(r1.host === r2.host && r1.port === r2.port);
 exports.duplicateFilter = duplicateFilter;
-var mergeKeyValue = function (map) { return Array.from(map).map(function (l) { return l[0] + l[1]; }); };
+const mergeKeyValue = (map) => Array.from(map).map((l) => l[0] + l[1]);
 exports.mergeKeyValue = mergeKeyValue;
-var compareArrays = function (arr, target) {
-    return target.every(function (v) { return arr.includes(v); }) && arr.length === target.length;
-};
+const compareArrays = (arr, target) => target.every((v) => arr.includes(v)) && arr.length === target.length;
 exports.compareArrays = compareArrays;
-var filterOnlyMatchingLabels = function (requestLabels) {
-    return function (route) { return route.labels
-        ? exports.compareArrays(exports.mergeKeyValue(requestLabels), exports.mergeKeyValue(route.labels))
-        : false; };
-};
+const filterOnlyMatchingLabels = (requestLabels) => (route) => route.labels
+    ? (0, exports.compareArrays)((0, exports.mergeKeyValue)(requestLabels), (0, exports.mergeKeyValue)(route.labels))
+    : false;
 exports.filterOnlyMatchingLabels = filterOnlyMatchingLabels;
-var hasAffinitySession = function (backend) { var _a; return (_a = backend === null || backend === void 0 ? void 0 : backend.sessionAffinity) === null || _a === void 0 ? void 0 : _a.enabled; };
-exports.hasAffinitySession = hasAffinitySession;
-function getServiceInfo(bindAddr, locator) {
-    var _this = this;
+const getServiceInfo = (bindAddr, locator) => {
     return {
         name: "location",
-        bindAddr: bindAddr,
+        bindAddr,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         service: common_1.LOCATION_OBJECT_PROTO.Location.service,
         handlers: {
-            addRoute: function (call, callback) {
+            addRoute: (call, callback) => {
                 try {
                     locator.addRoute(call.request);
                     callback(null, {});
@@ -77,53 +58,52 @@ function getServiceInfo(bindAddr, locator) {
                     callback(e, null);
                 }
             },
-            findRoutes: function (call, callback) { return __awaiter(_this, void 0, void 0, function () {
-                var routes, e_1;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0:
-                            _a.trys.push([0, 2, , 3]);
-                            return [4 /*yield*/, locator.findRoutes(call.request)];
-                        case 1:
-                            routes = _a.sent();
-                            if (routes.length == 0)
-                                throw new errors_1.NotRoutesFoundForAOR(call.request.aor);
-                            callback(null, {
-                                routes: routes
-                            });
-                            return [3 /*break*/, 3];
-                        case 2:
-                            e_1 = _a.sent();
-                            callback(e_1, null);
-                            return [3 /*break*/, 3];
-                        case 3: return [2 /*return*/];
-                    }
-                });
-            }); },
-            removeRoutes: function (call, callback) { return __awaiter(_this, void 0, void 0, function () {
-                var _a, _b, e_2;
-                var _c;
-                return __generator(this, function (_d) {
-                    switch (_d.label) {
-                        case 0:
-                            _d.trys.push([0, 2, , 3]);
-                            _a = callback;
-                            _b = [null];
-                            _c = {};
-                            return [4 /*yield*/, locator.findRoutes(call.request)];
-                        case 1:
-                            _a.apply(void 0, _b.concat([(_c.routes = _d.sent(),
-                                    _c)]));
-                            return [3 /*break*/, 3];
-                        case 2:
-                            e_2 = _d.sent();
-                            callback(e_2, null);
-                            return [3 /*break*/, 3];
-                        case 3: return [2 /*return*/];
-                    }
-                });
-            }); }
+            findRoutes: (call, callback) => __awaiter(void 0, void 0, void 0, function* () {
+                try {
+                    const routes = yield locator.findRoutes(call.request);
+                    if (routes.length === 0)
+                        throw new errors_1.NotRoutesFoundForAOR(call.request.aor);
+                    callback(null, {
+                        routes: routes
+                    });
+                }
+                catch (e) {
+                    callback(e, null);
+                }
+            }),
+            removeRoutes: (call, callback) => __awaiter(void 0, void 0, void 0, function* () {
+                try {
+                    callback(null, {
+                        routes: yield locator.findRoutes(call.request)
+                    });
+                }
+                catch (e) {
+                    callback(e, null);
+                }
+            })
         }
     };
-}
+};
 exports.getServiceInfo = getServiceInfo;
+const configFromString = (params, allowedKeys) => {
+    if (params.length === 0)
+        return {};
+    const parameters = {};
+    params.split(",").forEach((par) => {
+        try {
+            const key = par.split("=")[0];
+            const value = par.split("=")[1];
+            if (allowedKeys.indexOf(key) === -1) {
+                throw new Error(`invalid parameter: ${key}`);
+            }
+            else {
+                parameters[key] = value === "true" ? true : value;
+            }
+        }
+        catch (e) {
+            throw new Error(`invalid parameters string: ${params}; should be something like 'host=localhost,port=6379'`);
+        }
+    });
+    return parameters;
+};
+exports.configFromString = configFromString;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@routr/location",
-  "version": "2.0.5-alpha.2",
+  "version": "2.0.5-alpha.21",
   "description": "Creates and maintains a list of routes to all registered endpoints",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
   "license": "MIT",
-  "main": "dist/location",
-  "types": "dist/location",
+  "main": "dist/index",
+  "types": "dist/index",
   "scripts": {
     "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
     "build": "tsc -b tsconfig.json"
@@ -25,9 +25,21 @@
     "access": "public"
   },
   "dependencies": {
-    "@routr/common": "^2.0.5-alpha.2",
+    "@fonoster/logger": "0.3.17-alpha.2",
+    "@grpc/grpc-js": "^1.5.9",
+    "@opentelemetry/api": "^1.0.4",
+    "@opentelemetry/exporter-jaeger": "^1.0.4",
+    "@opentelemetry/instrumentation": "^0.27.0",
+    "@opentelemetry/instrumentation-grpc": "^0.27.0",
+    "@opentelemetry/resources": "^1.0.4",
+    "@opentelemetry/sdk-trace-base": "^1.0.4",
+    "@opentelemetry/sdk-trace-node": "^1.0.4",
+    "@opentelemetry/semantic-conventions": "^1.0.4",
+    "@routr/common": "^2.0.5-alpha.21",
+    "@routr/processor": "^2.0.5-alpha.21",
     "ajv": "^6.12.6",
-    "fp-ts": "^2.11.8"
+    "fp-ts": "^2.11.8",
+    "redis": "^4.0.4"
   },
   "repository": {
     "type": "git",
@@ -36,5 +48,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "3570106be9a96cb6672de4a850a377bfa7d9bb3e"
+  "gitHead": "904559d8d4694e16d63f553704345a987dc0d93a"
 }

package/dist/locator.d.ts

@@ -1,13 +0,0 @@
-import { AddRouteRequest, Backend, FindRoutesRequest, ILocationService, ILocatorStore, RemoveRouteRequest, Route } from "./types";
-export default class Locator implements ILocationService {
-    private store;
-    private backends;
-    private rrCount;
-    private affinityStore;
-    constructor(store: ILocatorStore, backends?: Map<string, Backend>);
-    addRoute(request: AddRouteRequest): Promise<void>;
-    findRoutes(request: FindRoutesRequest): Promise<Route[]>;
-    removeRoutes(request: RemoveRouteRequest): Promise<void>;
-    private next;
-    private nextWithAffinity;
-}

package/dist/locator.js

@@ -1,152 +0,0 @@
-"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 (_) 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 });
-/*
- * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/routr
- *
- * 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.
- */
-var errors_1 = require("./errors");
-var types_1 = require("./types");
-var utils_1 = require("./utils");
-var Locator = /** @class */ (function () {
-    // Should fail if any backend has sessionAffinity and round-robin
-    function Locator(store, backends) {
-        var _this = this;
-        if (backends === void 0) { backends = new Map(); }
-        this.store = store;
-        this.backends = backends;
-        this.rrCount = new Map();
-        this.affinityStore = new Map();
-        this.backends.forEach(function (value, key) { return _this.rrCount.set(key, 0); });
-    }
-    Locator.prototype.addRoute = function (request) {
-        if (!request.aor.startsWith('sip:') &&
-            !request.aor.startsWith('backend:')) {
-            throw new errors_1.UnsupportedSchema(request.aor);
-        }
-        return this.store.put(request.aor, request.route);
-    };
-    Locator.prototype.findRoutes = function (request) {
-        return __awaiter(this, void 0, void 0, function () {
-            var routes, _a, backend, _b, _c;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
-                    case 0:
-                        if (!request.labels) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.store.get(request.aor)];
-                    case 1:
-                        _a = (_d.sent())
-                            .filter(utils_1.filterOnlyMatchingLabels(request.labels));
-                        return [3 /*break*/, 4];
-                    case 2: return [4 /*yield*/, this.store.get(request.aor)];
-                    case 3:
-                        _a = (_d.sent()) || [];
-                        _d.label = 4;
-                    case 4:
-                        routes = _a;
-                        if (!request.aor.startsWith('sip:')) return [3 /*break*/, 5];
-                        return [2 /*return*/, routes];
-                    case 5:
-                        if (!request.aor.startsWith('backend:')) return [3 /*break*/, 9];
-                        backend = this.backends.get(request.aor);
-                        if (!backend) {
-                            throw new errors_1.NotRoutesFoundForAOR(request.aor);
-                        }
-                        if (!!utils_1.hasAffinitySession(backend)) return [3 /*break*/, 6];
-                        _b = [this.next(routes, backend)];
-                        return [3 /*break*/, 8];
-                    case 6:
-                        _c = this.nextWithAffinity;
-                        return [4 /*yield*/, routes];
-                    case 7:
-                        _b = [_c.apply(this, [_d.sent(), backend.sessionAffinity.ref])];
-                        _d.label = 8;
-                    case 8: 
-                    // If it has not affinity sesssion then get next
-                    return [2 /*return*/, _b];
-                    case 9: throw new errors_1.UnsupportedSchema(request.aor);
-                }
-            });
-        });
-    };
-    Locator.prototype.removeRoutes = function (request) {
-        return this.store.delete(request.aor);
-    };
-    Locator.prototype.next = function (routes, backend) {
-        if (backend.balancingAlgorithm === types_1.LB_ALGORITHM.LEAST_SESSIONS) {
-            return routes.sort(function (r1, r2) { return r1.sessionCount - r2.sessionCount; })[0];
-        }
-        // Continues using round-robin
-        var nextPosition = this.rrCount.get("backend:" + backend.ref);
-        var result = routes[nextPosition];
-        if (nextPosition >= (routes.length - 1)) {
-            // Restarting round-robin counter
-            this.rrCount.set("backend:" + backend.ref, 0);
-        }
-        else {
-            this.rrCount.set("backend:" + backend.ref, nextPosition + 1);
-        }
-        return result;
-    };
-    // Backend with session affinity does not support round-robin
-    Locator.prototype.nextWithAffinity = function (routes, sessionAffinityRef) {
-        var route = this.affinityStore.get(sessionAffinityRef);
-        if (route) {
-            return route;
-        }
-        route = routes.sort(function (r1, r2) { return r1.sessionCount - r2.sessionCount; })[0];
-        this.affinityStore.set(sessionAffinityRef, route);
-        return route;
-    };
-    return Locator;
-}());
-exports.default = Locator;