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

package/dist/client.d.ts

@@ -0,0 +1,47 @@
+import { AddRouteRequest, FindRoutesRequest, ILocationService, RemoveRoutesRequest } from "./types";
+import { Route } from "@routr/common";
+/**
+ * Location client
+ */
+export default class Location implements ILocationService {
+    location: any;
+    config: {
+        addr: string;
+    };
+    /**
+     * Create a new Location client.
+     *
+     * @param {object} config - Location client config
+     * @param {string} config.addr - Location service address
+     */
+    constructor(config: {
+        addr: string;
+    });
+    /**
+     * Add a route to the location service.
+     *
+     * @param {AddRouteRequest} request - Add route request
+     * @param {string} request.aor - AOR of the route
+     * @param {Route} request.route - Route to add
+     * @return {Promise<void>}
+     */
+    addRoute(request: AddRouteRequest): Promise<void>;
+    /**
+     * Add a route to the location service.
+     *
+     * @param {FindRoutesResponse} request - Request to find routes
+     * @param {string} request.aor - AOR of the route
+     * @param {Map<string, string>} request.labels - Optional Route labels
+     * @param {string} request.sessionAffinityRef - Optiona session affinity ref
+     * @return {Promise<void>}
+     */
+    findRoutes(request: FindRoutesRequest): Promise<Route[]>;
+    /**
+     * Add a route to the location service.
+     *
+     * @param {RemoveRoutesRequest} request - Remove routes request
+     * @param {string} request.aor - AOR of the route
+     * @return {Promise<void>}
+     */
+    removeRoutes(request: RemoveRoutesRequest): Promise<void>;
+}

package/dist/client.js

@@ -0,0 +1,102 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@routr/common");
+const grpc = __importStar(require("@grpc/grpc-js"));
+const container = (self, request, name) => {
+    return new Promise((resolve, reject) => {
+        self.location[name](request, (err, response) => {
+            if ((err === null || err === void 0 ? void 0 : err.code) === grpc.status.UNAVAILABLE) {
+                return reject(new common_1.ServiceUnavailableError(self.config.addr));
+            }
+            resolve(response);
+        });
+    });
+};
+/**
+ * Location client
+ */
+class Location {
+    /**
+     * Create a new Location client.
+     *
+     * @param {object} config - Location client config
+     * @param {string} config.addr - Location service address
+     */
+    constructor(config) {
+        this.config = config;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.location = new common_1.LOCATION_OBJECT_PROTO.Location(config.addr, grpc.credentials.createInsecure());
+    }
+    /**
+     * Add a route to the location service.
+     *
+     * @param {AddRouteRequest} request - Add route request
+     * @param {string} request.aor - AOR of the route
+     * @param {Route} request.route - Route to add
+     * @return {Promise<void>}
+     */
+    addRoute(request) {
+        return container(this, request, this.addRoute.name);
+    }
+    /**
+     * Add a route to the location service.
+     *
+     * @param {FindRoutesResponse} request - Request to find routes
+     * @param {string} request.aor - AOR of the route
+     * @param {Map<string, string>} request.labels - Optional Route labels
+     * @param {string} request.sessionAffinityRef - Optiona session affinity ref
+     * @return {Promise<void>}
+     */
+    findRoutes(request) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            ((_a = ((yield container(this, request, this.findRoutes.name)))) === null || _a === void 0 ? void 0 : _a.routes) ||
+                []);
+        });
+    }
+    /**
+     * Add a route to the location service.
+     *
+     * @param {RemoveRoutesRequest} request - Remove routes request
+     * @param {string} request.aor - AOR of the route
+     * @return {Promise<void>}
+     */
+    removeRoutes(request) {
+        return container(this, request, this.removeRoutes.name);
+    }
+}
+exports.default = Location;

package/dist/config/get_config.d.ts

@@ -1,4 +1,4 @@
 import { LocationConfig } from "../types";
-import * as E from 'fp-ts/Either';
+import * as E from "fp-ts/Either";
 import { InvalidConfiguration } from "../errors";
 export declare const getConfig: (path: string) => E.Either<InvalidConfiguration, LocationConfig>;

package/dist/config/get_config.js

@@ -1,18 +1,11 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -52,41 +45,51 @@ exports.getConfig = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var types_1 = require("../types");
-var fs_1 = __importDefault(require("fs"));
-var schema_1 = require("./schema");
-var ajv_1 = __importDefault(require("ajv"));
-var E = __importStar(require("fp-ts/Either"));
-var errors_1 = require("../errors");
-var ajv = new ajv_1.default();
-var validate = ajv.compile(schema_1.schema);
-var getConfig = function (path) {
-    var c = JSON.parse(fs_1.default.readFileSync(path, "utf8"));
-    if (!validate(__assign({}, c))) {
+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 ajv = new ajv_1.default();
+const validate = ajv.compile(schema_1.schema);
+const hasBadCombiniation = (backends) => backends.some((b) => b.balancingAlgorithm === types_1.LB_ALGORITHM.ROUND_ROBIN && b.withSessionAffinity);
+const hasBadAlgorithm = (backends) => backends.some((b) => b.balancingAlgorithm !== types_1.LB_ALGORITHM.ROUND_ROBIN &&
+    b.balancingAlgorithm !== types_1.LB_ALGORITHM.LEAST_SESSIONS);
+const getConfig = (path) => {
+    var _a, _b, _c;
+    const c = JSON.parse(fs_1.default.readFileSync(path, "utf8"));
+    if (!validate(Object.assign({}, c))) {
         return E.left(new errors_1.InvalidSchemaConfiguration(JSON.stringify(validate.errors[0].message)));
     }
-    var config = c.spec;
+    const config = c.spec;
     if (config.backends) {
-        config.backends.map(function (b) {
+        config.backends.map((b) => {
             // Setting round-robin by default
             b.balancingAlgorithm = b.balancingAlgorithm
-                ? b.balancingAlgorithm : types_1.LB_ALGORITHM.ROUND_ROBIN;
+                ? b.balancingAlgorithm
+                : types_1.LB_ALGORITHM.ROUND_ROBIN;
             return b;
         });
-        var hasBadCombiniation = config.backends.some(function (b) {
-            return b.balancingAlgorithm === types_1.LB_ALGORITHM.ROUND_ROBIN && b.sessionAffinity;
-        });
-        var hasBadAlgorithm = config.backends.some(function (b) {
-            return b.balancingAlgorithm !== types_1.LB_ALGORITHM.ROUND_ROBIN
-                && b.balancingAlgorithm !== types_1.LB_ALGORITHM.LEAST_SESSIONS;
-        });
-        if (hasBadCombiniation) {
+        if (hasBadCombiniation(config.backends)) {
             return E.left(new errors_1.BadAlgorithmAndAffinityCombination());
         }
-        if (hasBadAlgorithm) {
+        if (hasBadAlgorithm(config.backends)) {
             return E.left(new errors_1.InvalidLoadBalancerAlgorithm());
         }
     }
+    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
+        };
+    }
+    if (((_b = config === null || config === void 0 ? void 0 : config.cache) === null || _b === void 0 ? void 0 : _b.provider) === types_1.CACHE_PROVIDER.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,
+            parameters: "host=localhost,port=6379"
+        };
+    }
     return E.right(config);
 };
 exports.getConfig = getConfig;

package/dist/config/schema.d.ts

@@ -22,6 +22,18 @@ export declare const schema: {
                     description: string;
                     type: string;
                 };
+                cache: {
+                    type: string;
+                    properties: {
+                        provider: {
+                            enum: string[];
+                        };
+                        parameters: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                };
                 backends: {
                     description: string;
                     type: string;
@@ -35,18 +47,9 @@ export declare const schema: {
                         balancingAlgorithm: {
                             enum: string[];
                         };
-                        sessionAffinity: {
+                        withSessionAffinity: {
                             description: string;
                             type: string;
-                            properties: {
-                                enabled: {
-                                    type: string;
-                                };
-                                ref: {
-                                    type: string;
-                                };
-                            };
-                            required: string[];
                         };
                     };
                     required: string[];

package/dist/config/schema.js

@@ -20,60 +20,63 @@ exports.schema = void 0;
  * limitations under the License.
  */
 exports.schema = {
-    "$id": "https://json-schema.org/draft/2020-12/schema",
-    "title": "Location Service configuration",
-    "description": "Configuration for an instance of the Location Service",
-    "type": "object",
-    "properties": {
-        "kind": {
-            "enum": ["Location", "location"]
+    $id: "https://json-schema.org/draft/2020-12/schema",
+    title: "Location Service configuration",
+    description: "Configuration for an instance of the Location Service",
+    type: "object",
+    properties: {
+        kind: {
+            enum: ["Location", "location"]
         },
-        "apiVersion": {
-            "enum": ["v2draft1"]
+        apiVersion: {
+            enum: ["v2draft1"]
         },
-        "metadata": {
-            "description": "Resource metadata",
-            "type": "object"
+        metadata: {
+            description: "Resource metadata",
+            type: "object"
         },
-        "spec": {
-            "description": "Operations spec for Location",
-            "type": "object",
-            "properties": {
-                "bindAddr": {
-                    "description": "Ipv4 interface to accept request on",
-                    "type": "string"
+        spec: {
+            description: "Operations spec for Location",
+            type: "object",
+            properties: {
+                bindAddr: {
+                    description: "Ipv4 interface to accept request on",
+                    type: "string"
                 },
-                "backends": {
-                    "description": "Optional SIP backends",
-                    "type": "array",
-                    "items": {
-                        "type": "object"
-                    },
-                    "properties": {
-                        "ref": {
-                            "type": "string"
+                cache: {
+                    type: "object",
+                    properties: {
+                        provider: {
+                            enum: ["memory", "redis"]
                         },
-                        "balancingAlgorithm": {
-                            "enum": ["ROUND_ROBIN", "LEAST_SESSIONS"]
+                        parameters: {
+                            type: "string"
+                        }
+                    },
+                    required: ["provider"]
+                },
+                backends: {
+                    description: "Optional SIP backends",
+                    type: "array",
+                    items: {
+                        type: "object"
+                    },
+                    properties: {
+                        ref: {
+                            type: "string"
                         },
-                        "sessionAffinity": {
-                            "description": "Optional session affinity",
-                            "type": "object",
-                            "properties": {
-                                "enabled": {
-                                    "type": "boolean"
-                                },
-                                "ref": {
-                                    "type": "string"
-                                }
-                            },
-                            "required": ["ref"]
+                        balancingAlgorithm: {
+                            enum: ["round-robin", "least-sessions"]
                         },
+                        withSessionAffinity: {
+                            description: "Optional session affinity",
+                            type: "boolean"
+                        }
                     },
-                    "required": ["ref"]
-                },
+                    required: ["ref"]
+                }
             }
         }
     },
-    "required": ["kind", "metadata", "spec", "apiVersion"]
+    required: ["kind", "spec", "apiVersion"]
 };

package/dist/errors.d.ts

@@ -1,23 +1,59 @@
-import grpc = require("@grpc/grpc-js");
+import * as grpc from "@grpc/grpc-js";
 export declare type LocationError = UnsupportedSchema | NotRoutesFoundForAOR;
 export declare type InvalidConfiguration = BadAlgorithmAndAffinityCombination | InvalidSchemaConfiguration;
+/**
+ * Error thrown when the location service returns an unsupported schema.
+ */
 export declare class UnsupportedSchema extends Error {
     code: grpc.status;
+    /**
+     * Create a new UnsupportedSchema error.
+     *
+     * @param {string} aor - The AOR that was requested
+     */
     constructor(aor: string);
 }
+/**
+ * Error thrown when the location service returns no routes for the AOR.
+ */
 export declare class NotRoutesFoundForAOR extends Error {
     code: number;
+    /**
+     * Create a new NotRoutesFoundForAOR error.
+     *
+     * @param {string} aor - The AOR that was requested
+     */
     constructor(aor: string);
 }
+/**
+ * Error thrown when the location finds a bad configuration.
+ */
 export declare class InvalidSchemaConfiguration extends Error {
     code: grpc.status;
+    /**
+     * Create a new InvalidSchemaConfiguration error.
+     *
+     * @param {string} msg - Message from the validation error
+     */
     constructor(msg: string);
 }
+/**
+ * Error thrown when the location finds incompatible algorithm and session affinity.
+ */
 export declare class BadAlgorithmAndAffinityCombination extends Error {
     code: grpc.status;
+    /**
+     * Create a new BadAlgorithmAndAffinityCombination error.
+     */
     constructor();
 }
+/**
+ * Error thrown when the location finds an invalid balancing algorithm.
+ */
 export declare class InvalidLoadBalancerAlgorithm extends Error {
     code: grpc.status;
+    /**
+     * Create a new InvalidLoadBalancerAlgorithm error.
+     */
     constructor();
 }

package/dist/errors.js

@@ -1,19 +1,27 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvalidLoadBalancerAlgorithm = exports.BadAlgorithmAndAffinityCombination = exports.InvalidSchemaConfiguration = exports.NotRoutesFoundForAOR = exports.UnsupportedSchema = void 0;
 /*
@@ -34,58 +42,79 @@ exports.InvalidLoadBalancerAlgorithm = exports.BadAlgorithmAndAffinityCombinatio
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var grpc = require("@grpc/grpc-js");
-var UnsupportedSchema = /** @class */ (function (_super) {
-    __extends(UnsupportedSchema, _super);
-    function UnsupportedSchema(aor) {
-        var _this = _super.call(this, "aor " + aor + " has an invalid schema, only \"sip:\" or \"backend:\" are allowed") || this;
-        _this.code = grpc.status.INVALID_ARGUMENT;
+const grpc = __importStar(require("@grpc/grpc-js"));
+/**
+ * Error thrown when the location service returns an unsupported schema.
+ */
+class UnsupportedSchema extends Error {
+    /**
+     * Create a new UnsupportedSchema error.
+     *
+     * @param {string} aor - The AOR that was requested
+     */
+    constructor(aor) {
+        super(`aor ${aor} has an invalid schema, only "sip:" or "backend:" are allowed`);
+        this.code = grpc.status.INVALID_ARGUMENT;
         // Set the prototype explicitly.
-        Object.setPrototypeOf(_this, UnsupportedSchema.prototype);
-        return _this;
+        Object.setPrototypeOf(this, UnsupportedSchema.prototype);
     }
-    return UnsupportedSchema;
-}(Error));
+}
 exports.UnsupportedSchema = UnsupportedSchema;
-var NotRoutesFoundForAOR = /** @class */ (function (_super) {
-    __extends(NotRoutesFoundForAOR, _super);
-    function NotRoutesFoundForAOR(aor) {
-        var _this = _super.call(this, "no routes found for aor " + aor) || this;
-        _this.code = grpc.status.NOT_FOUND;
-        Object.setPrototypeOf(_this, NotRoutesFoundForAOR.prototype);
-        return _this;
+/**
+ * Error thrown when the location service returns no routes for the AOR.
+ */
+class NotRoutesFoundForAOR extends Error {
+    /**
+     * Create a new NotRoutesFoundForAOR error.
+     *
+     * @param {string} aor - The AOR that was requested
+     */
+    constructor(aor) {
+        super(`no routes found for aor: ${aor}`);
+        this.code = grpc.status.NOT_FOUND;
+        Object.setPrototypeOf(this, NotRoutesFoundForAOR.prototype);
     }
-    return NotRoutesFoundForAOR;
-}(Error));
+}
 exports.NotRoutesFoundForAOR = NotRoutesFoundForAOR;
-var InvalidSchemaConfiguration = /** @class */ (function (_super) {
-    __extends(InvalidSchemaConfiguration, _super);
-    function InvalidSchemaConfiguration(msg) {
-        var _this = _super.call(this, msg) || this;
-        _this.code = grpc.status.INVALID_ARGUMENT;
-        Object.setPrototypeOf(_this, InvalidSchemaConfiguration.prototype);
-        return _this;
+/**
+ * Error thrown when the location finds a bad configuration.
+ */
+class InvalidSchemaConfiguration extends Error {
+    /**
+     * Create a new InvalidSchemaConfiguration error.
+     *
+     * @param {string} msg - Message from the validation error
+     */
+    constructor(msg) {
+        super(msg);
+        this.code = grpc.status.INVALID_ARGUMENT;
+        Object.setPrototypeOf(this, InvalidSchemaConfiguration.prototype);
     }
-    return InvalidSchemaConfiguration;
-}(Error));
+}
 exports.InvalidSchemaConfiguration = InvalidSchemaConfiguration;
-var BadAlgorithmAndAffinityCombination = /** @class */ (function (_super) {
-    __extends(BadAlgorithmAndAffinityCombination, _super);
-    function BadAlgorithmAndAffinityCombination() {
-        var _this = _super.call(this, "session affinity can not be combined with round-robin load balancing") || this;
-        Object.setPrototypeOf(_this, BadAlgorithmAndAffinityCombination.prototype);
-        return _this;
+/**
+ * Error thrown when the location finds incompatible algorithm and session affinity.
+ */
+class BadAlgorithmAndAffinityCombination extends Error {
+    /**
+     * Create a new BadAlgorithmAndAffinityCombination error.
+     */
+    constructor() {
+        super("session affinity can not be combined with round-robin load balancing");
+        Object.setPrototypeOf(this, BadAlgorithmAndAffinityCombination.prototype);
     }
-    return BadAlgorithmAndAffinityCombination;
-}(Error));
+}
 exports.BadAlgorithmAndAffinityCombination = BadAlgorithmAndAffinityCombination;
-var InvalidLoadBalancerAlgorithm = /** @class */ (function (_super) {
-    __extends(InvalidLoadBalancerAlgorithm, _super);
-    function InvalidLoadBalancerAlgorithm() {
-        var _this = _super.call(this, "found invalid load balancing algorithm. must be round-robin or least-sessions") || this;
-        Object.setPrototypeOf(_this, BadAlgorithmAndAffinityCombination.prototype);
-        return _this;
+/**
+ * Error thrown when the location finds an invalid balancing algorithm.
+ */
+class InvalidLoadBalancerAlgorithm extends Error {
+    /**
+     * Create a new InvalidLoadBalancerAlgorithm error.
+     */
+    constructor() {
+        super("found invalid load balancing algorithm. must be round-robin or least-sessions");
+        Object.setPrototypeOf(this, BadAlgorithmAndAffinityCombination.prototype);
     }
-    return InvalidLoadBalancerAlgorithm;
-}(Error));
+}
 exports.InvalidLoadBalancerAlgorithm = InvalidLoadBalancerAlgorithm;

package/dist/helper.d.ts

@@ -0,0 +1,2 @@
+import { MessageRequest, Route } from "@routr/common";
+export declare const createRoute: (request: MessageRequest) => Route;