@routr/location 2.6.2 → 2.7.0

package/dist/client.d.ts

@@ -23,6 +23,7 @@ export default class Location implements ILocationService {
      * @param {AddRouteRequest} request - Add route request
      * @param {string} request.aor - AOR of the route
      * @param {Route} request.route - Route to add
+     * @param {number} request.maxContacts - Max number of contacts to accept
      * @return {Promise<void>}
      */
     addRoute(request: AddRouteRequest): Promise<void>;
@@ -33,7 +34,7 @@ export default class Location implements ILocationService {
      * @param {string} request.aor - AOR of the route
      * @param {Map<string, string>} request.labels - Optional Route labels (reserved for future use)
      * @param {object} request.backend - Optional Route backend (reserved for future use)
-     * @return {Promise<void>}
+     * @return {Promise<Route[]>}
      */
     findRoutes(request: FindRoutesRequest): Promise<Route[]>;
     /**

package/dist/client.js

@@ -33,7 +33,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -58,6 +58,9 @@ const container = (self, request, name) => {
             if ((err === null || err === void 0 ? void 0 : err.code) === grpc.status.UNAVAILABLE) {
                 return reject(new common_1.CommonErrors.ServiceUnavailableError(self.config.addr));
             }
+            else if (err === null || err === void 0 ? void 0 : err.code) {
+                return reject(err);
+            }
             resolve(response);
         });
     });
@@ -83,10 +86,13 @@ class Location {
      * @param {AddRouteRequest} request - Add route request
      * @param {string} request.aor - AOR of the route
      * @param {Route} request.route - Route to add
+     * @param {number} request.maxContacts - Max number of contacts to accept
      * @return {Promise<void>}
      */
     addRoute(request) {
-        return container(this, request, this.addRoute.name);
+        return __awaiter(this, void 0, void 0, function* () {
+            return container(this, request, this.addRoute.name);
+        });
     }
     /**
      * Add a route to the location service.
@@ -95,7 +101,7 @@ class Location {
      * @param {string} request.aor - AOR of the route
      * @param {Map<string, string>} request.labels - Optional Route labels (reserved for future use)
      * @param {object} request.backend - Optional Route backend (reserved for future use)
-     * @return {Promise<void>}
+     * @return {Promise<Route[]>}
      */
     findRoutes(request) {
         var _a, _b;
@@ -113,7 +119,9 @@ class Location {
      * @return {Promise<void>}
      */
     removeRoutes(request) {
-        return container(this, request, this.removeRoutes.name);
+        return __awaiter(this, void 0, void 0, function* () {
+            return container(this, request, this.removeRoutes.name);
+        });
     }
 }
 exports.default = Location;

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) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/config/schema.js

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

package/dist/envs.js

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

package/dist/errors.js

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

package/dist/helper.js

@@ -1,9 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRouteFromLastMessage = exports.createRoute = void 0;
+/*
+ * Copyright (C) 2024 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.
+ */
+/* eslint-disable require-jsdoc */
 const common_1 = require("@routr/common");
 const processor_1 = require("@routr/processor");
-/* eslint-disable require-jsdoc */
 // TODO: Before finalizing this, consider using the old approach of saving the rport
 // and received values (like here:
 //    https://github.com/fonoster/routr/blob/59bc98af86078088aede7e658c0d82a19fa18fa4/mod/registrar/utils.js#L87)

package/dist/index.js

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

package/dist/location.d.ts

@@ -1,5 +1,5 @@
-import { AddRouteRequest, FindRoutesRequest, ILocationService, ILocatorStore, RemoveRoutesRequest } from "./types";
 import { Route } from "@routr/common";
+import { AddRouteRequest, FindRoutesRequest, ILocationService, ILocatorStore, RemoveRoutesRequest } from "./types";
 /**
  * A locator store that uses the location service to find routes for AORs.
  */

package/dist/location.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -27,6 +27,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/* eslint-disable require-jsdoc */
 const errors_1 = require("./errors");
 const common_1 = require("@routr/common");
 const utils_1 = require("./utils");
@@ -50,75 +51,97 @@ class Location {
     }
     /** @inheritdoc */
     addRoute(request) {
-        if (!request.aor.startsWith(AOR_SCHEME.SIP) &&
-            !request.aor.startsWith(AOR_SCHEME.BACKEND)) {
-            throw new errors_1.UnsupportedSchema(request.aor);
-        }
-        return this.store.put(request.aor, request.route);
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!request.aor.startsWith(AOR_SCHEME.SIP) &&
+                !request.aor.startsWith(AOR_SCHEME.BACKEND)) {
+                throw new errors_1.UnsupportedSchema(request.aor);
+            }
+            const existingRoutes = yield this.store.get(request.aor);
+            const routeAlreadyExists = existingRoutes.some((route) => route.user === request.route.user &&
+                route.host === request.route.host &&
+                route.port === request.route.port &&
+                route.transport === request.route.transport);
+            if (!routeAlreadyExists &&
+                request.maxContacts !== -1 &&
+                existingRoutes.length >= request.maxContacts) {
+                throw new common_1.CommonErrors.BadRequestError(`exceeds maximum of ${request.maxContacts} allowed contacts`);
+            }
+            return this.store.put(request.aor, request.route);
+        });
     }
     /** @inheritdoc */
     findRoutes(request) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            let routes = yield this.store.get(`${request.aor}:${request.callId}`);
-            if (routes.length > 0) {
+            const formatLabels = (labelsMap) => {
+                return Array.from(labelsMap)
+                    .sort(([keyA], [keyB]) => keyA.localeCompare(keyB))
+                    .map(([key, value]) => `${key}=${value}`)
+                    .join(";");
+            };
+            const labelString = request.labels ? formatLabels(request.labels) : null;
+            const storeKeyWithLabels = labelString
+                ? `${request.aor}:${request.callId}:${labelString}`
+                : `${request.aor}:${request.callId}`;
+            let routes = yield this.store.get(storeKeyWithLabels);
+            if (routes && routes.length > 0) {
                 return routes;
             }
-            routes = request.labels
-                ? (yield this.store.get(request.aor)).filter((0, utils_1.filterOnlyMatchingLabels)(request.labels))
-                : (_a = (yield this.store.get(request.aor))) !== null && _a !== void 0 ? _a : [];
-            if (request.aor.startsWith(AOR_SCHEME.SIP)) {
-                // Set call to the last route
+            if (labelString) {
+                const storeKey = `${request.aor}:${request.callId}:${labelString}`;
+                routes = yield this.store.get(storeKey);
+                if (!routes || routes.length === 0) {
+                    routes = (yield this.store.get(request.aor)).filter((0, utils_1.filterOnlyMatchingLabels)(request.labels));
+                }
+            }
+            else {
+                routes = (_a = (yield this.store.get(request.aor))) !== null && _a !== void 0 ? _a : [];
+            }
+            const { backend } = request;
+            if (!backend) {
                 this.store.put(`${request.aor}:${request.callId}`, routes[0]);
                 return routes;
             }
-            else if (request.aor.startsWith(AOR_SCHEME.BACKEND)) {
-                const { backend } = request;
-                // If it has not affinity session then get next
-                const r = 
-                // Falls back to round-robin if no session affinity ref is provided
-                backend.withSessionAffinity && request.sessionAffinityRef
-                    ? [yield this.nextWithAffinity(routes, request.sessionAffinityRef)]
-                    : [this.next(routes, backend)];
-                // Next time we will get the route with callId
-                this.store.put(`${request.aor}:${request.callId}`, r[0]);
-                return r;
-            }
-            throw new errors_1.UnsupportedSchema(request.aor);
+            // If it has no affinity session then get next
+            const r = (backend === null || backend === void 0 ? void 0 : backend.withSessionAffinity) && request.sessionAffinityRef
+                ? [yield this.nextWithAffinity(routes, request.sessionAffinityRef)]
+                : [this.next(routes, request)];
+            this.store.put(storeKeyWithLabels, r[0]);
+            return r;
         });
     }
     /** @inheritdoc */
     removeRoutes(request) {
         return this.store.delete(request.aor);
     }
-    // eslint-disable-next-line require-jsdoc
-    next(routes, backend) {
+    next(routes, request) {
         var _a;
-        if (backend.balancingAlgorithm === common_1.CommonTypes.LoadBalancingAlgorithm.LEAST_SESSIONS) {
+        const { backend } = request;
+        const ref = (backend === null || backend === void 0 ? void 0 : backend.ref) || request.aor;
+        if ((backend === null || backend === void 0 ? void 0 : backend.balancingAlgorithm) === common_1.CommonTypes.LoadBalancingAlgorithm.LEAST_SESSIONS) {
             return routes.sort((r1, r2) => r1.sessionCount - r2.sessionCount)[0];
         }
         // Continues using round-robin
-        const nextPosition = (_a = this.rrCount.get(`${AOR_SCHEME.BACKEND}${backend.ref}`)) !== null && _a !== void 0 ? _a : 0;
+        const nextPosition = (_a = this.rrCount.get(ref)) !== null && _a !== void 0 ? _a : 0;
         const result = routes[nextPosition];
         if (nextPosition >= routes.length - 1) {
             // Restarting round-robin counter
-            this.rrCount.set(`${AOR_SCHEME.BACKEND}${backend.ref}`, 0);
+            this.rrCount.set(ref, 0);
         }
         else {
-            this.rrCount.set(`${AOR_SCHEME.BACKEND}${backend.ref}`, nextPosition + 1);
+            this.rrCount.set(ref, nextPosition + 1);
         }
         return result;
     }
     // Backend with session affinity does not support round-robin
-    // eslint-disable-next-line require-jsdoc
-    nextWithAffinity(routes, sessionAffinityHeader) {
+    nextWithAffinity(routes, sessionAffinityRef) {
         return __awaiter(this, void 0, void 0, function* () {
-            const route = yield this.store.get(sessionAffinityHeader);
+            const route = yield this.store.get(sessionAffinityRef);
             if (route.length > 0) {
                 return route[0];
             }
             const r = routes.sort((r1, r2) => r1.sessionCount - r2.sessionCount)[0];
-            this.store.put(sessionAffinityHeader, r);
+            this.store.put(sessionAffinityRef, r);
             return r;
         });
     }

package/dist/runner.js

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

package/dist/service.js

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

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) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr

package/dist/types.d.ts

@@ -12,6 +12,7 @@ export interface ILocatorStore {
 export interface AddRouteRequest {
     aor: string;
     route: Route;
+    maxContacts: number;
 }
 export interface FindRoutesRequest {
     aor: string;
@@ -27,7 +28,7 @@ export interface RemoveRoutesRequest {
     aor: string;
 }
 export interface Backend {
-    ref: string;
+    ref?: string;
     balancingAlgorithm: CT.LoadBalancingAlgorithm;
     withSessionAffinity: boolean;
 }

package/dist/utils.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.configFromString = exports.getServiceInfo = exports.filterOnlyMatchingLabels = exports.compareArrays = exports.mergeKeyValue = exports.duplicateFilter = exports.expiredFilter = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
  *
  * This file is part of Routr
@@ -32,7 +32,7 @@ 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;
-const duplicateFilter = (r1, r2) => !(r1.host === r2.host && r1.port === r2.port);
+const duplicateFilter = (r1, r2) => !(r1.host === r2.host && r1.port === r2.port && r1.transport === r2.transport);
 exports.duplicateFilter = duplicateFilter;
 const mergeKeyValue = (map) => Array.from(map).map((l) => l[0] + l[1]);
 exports.mergeKeyValue = mergeKeyValue;
@@ -49,23 +49,22 @@ const getServiceInfo = (bindAddr, locator) => {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         service: common_1.LOCATION_OBJECT_PROTO.Location.service,
         handlers: {
-            addRoute: (call, callback) => {
+            addRoute: (call, callback) => __awaiter(void 0, void 0, void 0, function* () {
                 try {
-                    locator.addRoute(call.request);
+                    yield locator.addRoute(call.request);
                     callback(null, {});
                 }
                 catch (e) {
                     callback(e, null);
                 }
-            },
+            }),
             findRoutes: (call, callback) => __awaiter(void 0, void 0, void 0, function* () {
                 try {
                     const routes = yield locator.findRoutes(call.request);
-                    if (routes.length === 0)
+                    if (routes.length === 0) {
                         throw new errors_1.NotRoutesFoundForAOR(call.request.aor);
-                    callback(null, {
-                        routes: routes
-                    });
+                    }
+                    callback(null, { routes });
                 }
                 catch (e) {
                     callback(e, null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/location",
-  "version": "2.6.2",
+  "version": "2.7.0",
   "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",
@@ -35,8 +35,8 @@
     "@opentelemetry/sdk-trace-base": "^1.0.4",
     "@opentelemetry/sdk-trace-node": "^1.0.4",
     "@opentelemetry/semantic-conventions": "^1.0.4",
-    "@routr/common": "^2.6.1",
-    "@routr/processor": "^2.6.2",
+    "@routr/common": "^2.7.0",
+    "@routr/processor": "^2.7.0",
     "ajv": "^6.12.6",
     "fp-ts": "^2.11.8",
     "redis": "^4.0.4"
@@ -48,5 +48,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "87f2724c378af3b3b3a4ae22b91dfa63201161d3"
+  "gitHead": "46d067f61a0797fbab905073f70c7ab319979d1d"
 }