@routr/dispatcher 2.0.5-alpha.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Fonoster Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/config/get_config.d.ts

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

package/dist/config/get_config.js

@@ -0,0 +1,57 @@
+"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]; } });
+}) : (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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = void 0;
+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 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))) {
+        return E.left(new Error(JSON.stringify(validate.errors[0].message)));
+    }
+    // convert funcMatch to actual functions
+    var processors = c.spec.processors.map(function (p) {
+        var ref = p.ref, isFallback = p.isFallback, addr = p.addr, methods = p.methods, matchFunc = p.matchFunc;
+        return { ref: ref, isFallback: isFallback, addr: addr, methods: methods, matchFunc: eval("(" + p.matchFunc + ")") };
+    });
+    // Re-insert processors with matchFunc now as a function
+    c.spec.processors = processors;
+    return E.right(c.spec);
+};
+exports.getConfig = getConfig;

package/dist/config/schema.d.ts

@@ -0,0 +1,82 @@
+export declare const schema: {
+    $id: string;
+    title: string;
+    description: string;
+    type: string;
+    properties: {
+        kind: {
+            description: string;
+            type: string;
+        };
+        apiVersion: {
+            description: string;
+            type: string;
+        };
+        metadata: {
+            description: string;
+            type: string;
+            properties: {
+                ref: {
+                    description: string;
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        spec: {
+            description: string;
+            type: string;
+            properties: {
+                bindAddr: {
+                    description: string;
+                    type: string;
+                };
+                middlewares: {
+                    description: string;
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    properties: {
+                        ref: {
+                            type: string;
+                        };
+                        addr: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                };
+                processors: {
+                    description: string;
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    properties: {
+                        ref: {
+                            type: string;
+                        };
+                        isFallback: {
+                            type: string;
+                        };
+                        addr: {
+                            type: string;
+                        };
+                        matchFunc: {
+                            type: string;
+                        };
+                        methods: {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        };
+                    };
+                    required: string[];
+                };
+            };
+        };
+    };
+    required: string[];
+};

package/dist/config/schema.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = 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.schema = {
+    "$id": "https://json-schema.org/draft/2020-12/schema",
+    "title": "Message Dispatcher configuration",
+    "description": "Configuration for a Message Dispatcher instance",
+    "type": "object",
+    "properties": {
+        "kind": {
+            "description": "Resouce type",
+            "type": "string"
+        },
+        "apiVersion": {
+            "description": "Resource version",
+            "type": "string"
+        },
+        "metadata": {
+            "description": "Resource metadata",
+            "type": "object",
+            "properties": {
+                "ref": {
+                    "description": "EdgePort reference",
+                    "type": "string"
+                }
+            },
+            "required": ["ref"]
+        },
+        "spec": {
+            "description": "Operations spec for EdgePort",
+            "type": "object",
+            "properties": {
+                "bindAddr": {
+                    "description": "Ipv4 interface to accept request on",
+                    "type": "string"
+                },
+                "middlewares": {
+                    "description": "Middleware Processors",
+                    "type": "array",
+                    "items": {
+                        "type": "object"
+                    },
+                    "properties": {
+                        "ref": {
+                            "type": "string"
+                        },
+                        "addr": {
+                            "type": "string"
+                        }
+                    },
+                    "required": ["ref", "addr"]
+                },
+                "processors": {
+                    "description": "Message Processors",
+                    "type": "array",
+                    "items": {
+                        "type": "object"
+                    },
+                    "properties": {
+                        "ref": {
+                            "type": "string"
+                        },
+                        "isFallback": {
+                            "type": "boolean"
+                        },
+                        "addr": {
+                            "type": "string"
+                        },
+                        "matchFunc": {
+                            "type": "string"
+                        },
+                        "methods": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    },
+                    "required": ["ref", "addr", "methods", "matchFunc"]
+                }
+            }
+        }
+    },
+    "required": ["kind", "metadata", "spec", "apiVersion"]
+};

package/dist/connections.d.ts

@@ -0,0 +1,10 @@
+import { ProcessorGPRCConnection } from "./types";
+import { ProcessorConfig } from "@routr/common";
+/**
+ * Creates a connection to all the backend processors. The function will
+ * fail if any of the backends is unavailable during initialization.
+ *
+ * @param processors list of backend processors
+ * @returns list of connections
+ */
+export default function connectToBackendProcessors(processors: ProcessorConfig[]): Map<string, ProcessorGPRCConnection>;

package/dist/connections.js

@@ -0,0 +1,63 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from) {
+    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
+        to[j] = from[i];
+    return to;
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var common_1 = require("@routr/common");
+var grpc = require("@grpc/grpc-js");
+/**
+ * Creates a connection to all the backend processors. The function will
+ * fail if any of the backends is unavailable during initialization.
+ *
+ * @param processors list of backend processors
+ * @returns list of connections
+ */
+function connectToBackendProcessors(processors) {
+    var e_1, _a;
+    var procs = __spreadArray([], __read(processors));
+    var connections = new Map();
+    try {
+        for (var procs_1 = __values(procs), procs_1_1 = procs_1.next(); !procs_1_1.done; procs_1_1 = procs_1.next()) {
+            var processor = procs_1_1.value;
+            connections.set(processor.ref, new common_1.PROCESSOR_OBJECT_PROTO.Processor(processor.addr, grpc.credentials.createInsecure()));
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (procs_1_1 && !procs_1_1.done && (_a = procs_1.return)) _a.call(procs_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return connections;
+}
+exports.default = connectToBackendProcessors;

package/dist/errors.d.ts

@@ -0,0 +1,9 @@
+import grpc = require("@grpc/grpc-js");
+export declare class NotMatchingProcessorFound extends Error {
+    code: grpc.status;
+    constructor(ref: string);
+}
+export declare class ProcessorUnavailableError extends Error {
+    code: number;
+    constructor(ref: string);
+}

package/dist/errors.js

@@ -0,0 +1,61 @@
+"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 __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessorUnavailableError = exports.NotMatchingProcessorFound = 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.
+ */
+var grpc = require("@grpc/grpc-js");
+var NotMatchingProcessorFound = /** @class */ (function (_super) {
+    __extends(NotMatchingProcessorFound, _super);
+    function NotMatchingProcessorFound(ref) {
+        var _this = _super.call(this, "not matching processor found for request ref: " + ref) || this;
+        _this.code = grpc.status.NOT_FOUND;
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(_this, NotMatchingProcessorFound.prototype);
+        return _this;
+    }
+    return NotMatchingProcessorFound;
+}(Error));
+exports.NotMatchingProcessorFound = NotMatchingProcessorFound;
+var ProcessorUnavailableError = /** @class */ (function (_super) {
+    __extends(ProcessorUnavailableError, _super);
+    function ProcessorUnavailableError(ref) {
+        var _this = _super.call(this, "processor ref = " + ref + " is unavailable") || this;
+        _this.code = grpc.status.UNAVAILABLE;
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(_this, NotMatchingProcessorFound.prototype);
+        return _this;
+    }
+    return ProcessorUnavailableError;
+}(Error));
+exports.ProcessorUnavailableError = ProcessorUnavailableError;

package/dist/find_processor.d.ts

@@ -0,0 +1,5 @@
+import { MessageRequest, ProcessorConfig } from "@routr/common";
+import { NotMatchingProcessorFound } from "./errors";
+export declare const hasMethod: (config: ProcessorConfig, request: MessageRequest) => boolean;
+export declare const filter: (request: MessageRequest, config: ProcessorConfig) => boolean;
+export declare const findProcessor: (list: Array<ProcessorConfig>) => (request: MessageRequest) => NotMatchingProcessorFound | ProcessorConfig;

package/dist/find_processor.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findProcessor = exports.filter = exports.hasMethod = void 0;
+var errors_1 = require("./errors");
+var hasMethod = function (config, request) {
+    return config.methods.includes(request.method);
+};
+exports.hasMethod = hasMethod;
+// TODO: We need a way to test the matching function
+var filter = function (request, config) {
+    return exports.hasMethod(config, request)
+        && (config.isFallback || config.matchFunc(request));
+};
+exports.filter = filter;
+var findProcessor = function (list) {
+    return function (request) {
+        return list.find(function (config) { return exports.filter(request, config); })
+            || new errors_1.NotMatchingProcessorFound(request.ref);
+    };
+};
+exports.findProcessor = findProcessor;

package/dist/processor.d.ts

@@ -0,0 +1,6 @@
+import { MessageRequest, ProcessorConfig } from "@routr/common";
+import { NotMatchingProcessorFound, ProcessorUnavailableError } from "./errors";
+declare type CallbackErrors = NotMatchingProcessorFound | ProcessorUnavailableError | Error;
+declare type ProcessorCallback = (err: CallbackErrors, reponse?: MessageRequest) => void;
+export default function processor(configList: Array<ProcessorConfig>): (call: any, callback: ProcessorCallback) => void;
+export {};

package/dist/processor.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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 find_processor_1 = require("./find_processor");
+var connections_1 = __importDefault(require("./connections"));
+var errors_1 = require("./errors");
+var grpc = require("@grpc/grpc-js");
+function processor(configList) {
+    var connections = connections_1.default(configList);
+    // Upstream request and callback
+    return function (call, callback) {
+        var request = call.request;
+        var matchResult = find_processor_1.findProcessor(configList)(request);
+        if ('ref' in matchResult) {
+            var conn = connections.get(matchResult.ref);
+            // Connects to downstream processor
+            conn.processMessage(request, function (err, response) {
+                if ((err === null || err === void 0 ? void 0 : err.code) === grpc.status.UNAVAILABLE) {
+                    // We aument the error to indicate which processor failed
+                    callback(new errors_1.ProcessorUnavailableError(matchResult.ref));
+                    return;
+                }
+                callback(err, response);
+            });
+        }
+        else {
+            callback(matchResult);
+        }
+    };
+}
+exports.default = processor;

package/dist/runner.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/runner.js

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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 service_1 = __importDefault(require("./service"));
+var get_config_1 = require("./config/get_config");
+var result = get_config_1.getConfig(process.env.CONFIG_PATH);
+if (result._tag === 'Right') {
+    service_1.default(result.right);
+}
+else {
+    console.log(result.left);
+}

package/dist/service.d.ts

@@ -0,0 +1,2 @@
+import { MessageDispatcherConfig } from "./types";
+export default function MessageDispatcher(config: MessageDispatcherConfig): void;

package/dist/service.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var common_1 = require("@routr/common");
+var util_1 = require("./util");
+function MessageDispatcher(config) {
+    var bindAddr = config.bindAddr, processors = config.processors;
+    common_1.createService(util_1.getServiceInfo(bindAddr, processors));
+}
+exports.default = MessageDispatcher;

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+import { ProcessorConfig } from "@routr/common";
+export interface MessageDispatcherConfig {
+    bindAddr: string;
+    processors: Array<ProcessorConfig>;
+}
+export interface ProcessorGPRCConnection {
+    processMessage: (request: unknown, callback: Function) => void;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util.d.ts

@@ -0,0 +1,2 @@
+import { ProcessorConfig, ServiceInfo } from "@routr/common";
+export declare function getServiceInfo(bindAddr: string, processors: ProcessorConfig[]): ServiceInfo;

package/dist/util.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServiceInfo = 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.
+ */
+var processor_1 = __importDefault(require("./processor"));
+var common_1 = require("@routr/common");
+function getServiceInfo(bindAddr, processors) {
+    return {
+        name: "dispatcher",
+        bindAddr: bindAddr,
+        service: common_1.PROCESSOR_OBJECT_PROTO.Processor.service,
+        handlers: {
+            processMessage: processor_1.default(processors)
+        }
+    };
+}
+exports.getServiceInfo = getServiceInfo;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@routr/dispatcher",
+  "version": "2.0.5-alpha.2",
+  "description": "Receives SIP messages and forwards them to the corresponding Message Processor",
+  "author": "Pedro Sanders <psanders@fonoster.com>",
+  "homepage": "https://github.com/fonoster/routr#readme",
+  "license": "MIT",
+  "main": "dist/dispatcher",
+  "types": "dist/dispatcher",
+  "scripts": {
+    "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
+    "build": "tsc -b tsconfig.json"
+  },
+  "bin": {
+    "run_dispatcher": "dist/runner.js"
+  },
+  "directories": {
+    "src": "src",
+    "test": "test"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@routr/common": "^2.0.5-alpha.2",
+    "ajv": "^6.12.6",
+    "fp-ts": "^2.11.8"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fonoster/routr.git"
+  },
+  "bugs": {
+    "url": "https://github.com/fonoster/routr/issues"
+  },
+  "gitHead": "3570106be9a96cb6672de4a850a377bfa7d9bb3e"
+}