@routr/processor 2.0.5-alpha.15 → 2.0.5-alpha.17

package/dist/alterations.d.ts

@@ -1,11 +1,12 @@
 import { MessageRequest, Route } from "@routr/common";
 export declare const updateRequestURI: (route: Route) => (request: MessageRequest) => MessageRequest;
 export declare const addSelfVia: (route: Route) => (request: MessageRequest) => MessageRequest;
-export declare const addSelfRecordRoute: (route: Route) => (request: MessageRequest) => MessageRequest;
 export declare const addRoute: (route: Route) => (request: MessageRequest) => MessageRequest;
+export declare const applyXHeaders: (route: Route) => (request: MessageRequest) => MessageRequest;
+export declare const addSelfRecordRoute: (request: MessageRequest) => MessageRequest;
 export declare const addXEdgePortRef: (request: MessageRequest) => MessageRequest;
 export declare const removeXEdgePortRef: (request: MessageRequest) => MessageRequest;
 export declare const removeAuthorization: (request: MessageRequest) => MessageRequest;
-export declare const removeRoute: (request: MessageRequest) => MessageRequest;
+export declare const removeRoutes: (request: MessageRequest) => MessageRequest;
 export declare const removeTopVia: (request: MessageRequest) => MessageRequest;
 export declare const decreaseMaxForwards: (request: MessageRequest) => MessageRequest;

package/dist/alterations.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decreaseMaxForwards = exports.removeTopVia = exports.removeRoute = exports.removeAuthorization = exports.removeXEdgePortRef = exports.addXEdgePortRef = exports.addRoute = exports.addSelfRecordRoute = exports.addSelfVia = exports.updateRequestURI = void 0;
+exports.decreaseMaxForwards = exports.removeTopVia = exports.removeRoutes = exports.removeAuthorization = exports.removeXEdgePortRef = exports.addXEdgePortRef = exports.addSelfRecordRoute = exports.applyXHeaders = exports.addRoute = exports.addSelfVia = exports.updateRequestURI = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -20,7 +20,6 @@ exports.decreaseMaxForwards = exports.removeTopVia = exports.removeRoute = expor
  * limitations under the License.
  */
 const common_1 = require("@routr/common");
-const extensions_1 = require("./extensions");
 const updateRequestURI = (route) => {
     return (request) => {
         const req = common_1.Helper.deepCopy(request);
@@ -32,7 +31,7 @@ const updateRequestURI = (route) => {
         }
         req.message.requestUri.host = route.host;
         req.message.requestUri.port = route.port;
-        req.message.requestUri.transport = route.transport;
+        req.message.requestUri.transportParam = route.transport;
         return req;
     };
 };
@@ -40,14 +39,15 @@ exports.updateRequestURI = updateRequestURI;
 const addSelfVia = (route) => {
     return (request) => {
         const req = common_1.Helper.deepCopy(request);
-        // If is comming from a different edgeport we the listening point instead
-        // of the endpoint to ensure connectivity is possible.
+        // If is comming from a different edgeport we use the listening point instead
+        // of the endpoint to ensure connectivity.
         const nextHopHost = request.edgePortRef === route.edgePortRef
-            ? route.host : route.listeningPoint.host;
+            ? route.host
+            : route.listeningPoint.host;
         // If the nextHopHost host is local, then use use lp to construct via
         // otherwise, we use the first external ip available.
         const via = common_1.IpUtils.isLocalnet(req.localnets, nextHopHost)
-            ? req.listeningPoint
+            ? route.listeningPoint
             : {
                 // fallback to lp host if there is no external ips
                 host: req.externalIps[0] || req.listeningPoint.host,
@@ -59,32 +59,59 @@ const addSelfVia = (route) => {
     };
 };
 exports.addSelfVia = addSelfVia;
-const addSelfRecordRoute = (route) => {
+const addRoute = (route) => {
     return (request) => {
         const req = common_1.Helper.deepCopy(request);
-        const lp = req.listeningPoint;
+        const lp = route.listeningPoint;
         const r = {
-            name: "Record-Route",
-            value: `<sip:${lp.host}:${lp.port};lr;transport=${lp.transport}>`
+            address: {
+                uri: {
+                    host: lp.host,
+                    port: lp.port,
+                    transportParam: lp.transport,
+                    lrParam: true
+                }
+            }
         };
-        req.message.extensions = [r, ...req.message.extensions];
+        req.message.route = [r, ...req.message.recordRoute];
         return req;
     };
 };
-exports.addSelfRecordRoute = addSelfRecordRoute;
-const addRoute = (route) => {
+exports.addRoute = addRoute;
+const applyXHeaders = (route) => {
     return (request) => {
         const req = common_1.Helper.deepCopy(request);
-        const lp = route.listeningPoint;
-        const r = {
-            name: "Route",
-            value: `<sip:${lp.host}:${lp.port};lr;transport=${lp.transport}>`
-        };
-        req.message.extensions = [r, ...req.message.extensions];
+        if (route.headers && route.headers.length > 0) {
+            const headersToRemove = route.headers
+                .filter((h) => h.action === "remove")
+                .map((h) => h.name);
+            const headersToAdd = route.headers.filter((h) => h.action !== "remove");
+            req.message.extensions = req.message.extensions.filter((h) => !headersToRemove.includes(h.name.toLowerCase()));
+            headersToAdd.forEach((h) => {
+                req.message.extensions.push({ name: h.name, value: h.value });
+            });
+        }
         return req;
     };
 };
-exports.addRoute = addRoute;
+exports.applyXHeaders = applyXHeaders;
+const addSelfRecordRoute = (request) => {
+    const req = common_1.Helper.deepCopy(request);
+    const lp = req.listeningPoint;
+    const r = {
+        address: {
+            uri: {
+                host: lp.host,
+                port: lp.port,
+                transportParam: lp.transport,
+                lrParam: true
+            }
+        }
+    };
+    req.message.recordRoute = [r, ...req.message.recordRoute];
+    return req;
+};
+exports.addSelfRecordRoute = addSelfRecordRoute;
 const addXEdgePortRef = (request) => {
     const req = common_1.Helper.deepCopy(request);
     const r = {
@@ -107,20 +134,29 @@ const removeAuthorization = (request) => {
     return req;
 };
 exports.removeAuthorization = removeAuthorization;
-const removeRoute = (request) => {
+const removeRoutes = (request) => {
     const req = common_1.Helper.deepCopy(request);
-    req.message.extensions = req.message.extensions.filter((ext) => ext.name.toLowerCase() !== "route");
+    req.message.route = req.message.route.filter((r) => {
+        const lp = request.listeningPoint;
+        const route = r.address.uri;
+        return !((route.host === lp.host || request.externalIps.includes(route.host)) &&
+            route.port === lp.port);
+    });
     return req;
 };
-exports.removeRoute = removeRoute;
+exports.removeRoutes = removeRoutes;
 const removeTopVia = (request) => {
     const req = common_1.Helper.deepCopy(request);
     req.message.via.shift();
     return req;
 };
 exports.removeTopVia = removeTopVia;
-const decreaseMaxForwards = (request) => (0, extensions_1.updateHeader)(request, {
-    name: 'Max-Forwards',
-    value: (parseInt((0, extensions_1.getHeaderValue)(request, 'Max-Forwards')) - 1) + ''
-});
+const decreaseMaxForwards = (request) => {
+    const req = common_1.Helper.deepCopy(request);
+    if (req.message.maxForwards) {
+        req.message.maxForwards.maxForwards =
+            req.message.maxForwards.maxForwards - 1;
+    }
+    return req;
+};
 exports.decreaseMaxForwards = decreaseMaxForwards;

package/dist/extensions.d.ts

@@ -1,6 +1,10 @@
 import { MessageRequest } from "@routr/common";
-export declare const getHeaderValue: (request: MessageRequest, name: string) => any;
+export declare const getHeaderValue: (request: MessageRequest, name: string) => string;
 export declare const updateHeader: (request: MessageRequest, header: {
     name: string;
     value: string;
 }) => MessageRequest;
+export declare const addHeader: (request: MessageRequest, header: {
+    name: string;
+    value: string;
+}) => MessageRequest;

package/dist/extensions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateHeader = exports.getHeaderValue = void 0;
+exports.addHeader = exports.updateHeader = exports.getHeaderValue = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -20,7 +20,10 @@ exports.updateHeader = exports.getHeaderValue = void 0;
  * limitations under the License.
  */
 const common_1 = require("@routr/common");
-const getHeaderValue = (request, name) => { var _a; return (_a = request.message.extensions.find((ext) => ext.name.toLowerCase() === name.toLowerCase())) === null || _a === void 0 ? void 0 : _a.value; };
+const getHeaderValue = (request, name) => {
+    var _a;
+    return (_a = request.message.extensions.find((ext) => ext.name.toLowerCase() === name.toLowerCase())) === null || _a === void 0 ? void 0 : _a.value;
+};
 exports.getHeaderValue = getHeaderValue;
 const updateHeader = (request, header) => {
     const r = common_1.Helper.deepCopy(request);
@@ -30,3 +33,9 @@ const updateHeader = (request, header) => {
     return r;
 };
 exports.updateHeader = updateHeader;
+const addHeader = (request, header) => {
+    const r = common_1.Helper.deepCopy(request);
+    r.message.extensions = [...request.message.extensions, header];
+    return r;
+};
+exports.addHeader = addHeader;

package/dist/helper.d.ts

@@ -1,3 +1,11 @@
-import { MessageRequest } from "@routr/common";
+import { MessageRequest, Route } from "@routr/common";
 export declare const isTypeResponse: (request: MessageRequest) => boolean;
 export declare const isTypeRequest: (request: MessageRequest) => boolean;
+/**
+ * A request traversing a second EdgePort would have an updated the requestUri.
+ * Therefore, we are able to re-construct the Route from the request.
+ *
+ * @param {MessageRequest} request - the request
+ * @return {Route} the route
+ */
+export declare function createRouteFromLastMessage(request: MessageRequest): Route;

package/dist/helper.js

@@ -1,7 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTypeRequest = exports.isTypeResponse = void 0;
+exports.createRouteFromLastMessage = exports.isTypeRequest = exports.isTypeResponse = void 0;
+const index_1 = require("./index");
 const isTypeResponse = (request) => request.message.messageType === "responseType";
 exports.isTypeResponse = isTypeResponse;
 const isTypeRequest = (request) => !(0, exports.isTypeResponse)(request);
 exports.isTypeRequest = isTypeRequest;
+/**
+ * A request traversing a second EdgePort would have an updated the requestUri.
+ * Therefore, we are able to re-construct the Route from the request.
+ *
+ * @param {MessageRequest} request - the request
+ * @return {Route} the route
+ */
+function createRouteFromLastMessage(request) {
+    const uri = request.message.requestUri;
+    const sessionCount = index_1.Extensions.getHeaderValue(request, "x-session-count")
+        ? parseInt(index_1.Extensions.getHeaderValue(request, "x-session-count"))
+        : -1;
+    return {
+        edgePortRef: request.edgePortRef,
+        user: uri.user,
+        host: uri.host,
+        port: uri.port,
+        transport: uri.transportParam,
+        registeredOn: Date.now(),
+        sessionCount,
+        expires: index_1.Target.getTargetExpires(request),
+        listeningPoint: request.listeningPoint
+    };
+}
+exports.createRouteFromLastMessage = createRouteFromLastMessage;

package/dist/processor.d.ts

@@ -1,9 +1,22 @@
 import Response from "./response";
 import { ProcessorConfig } from "./types";
-import { MessageRequest } from "@routr/common";
+import { MessageRequest, ServiceInfo } from "@routr/common";
+/**
+ * Processor is a class that handles the processing of a request.
+ */
 export default class Processor {
     config: ProcessorConfig;
-    serviceInfo: any;
+    serviceInfo: ServiceInfo;
+    /**
+     * Construct a new Processor.
+     *
+     * @param {ProcessorConfig} config The processor configuration
+     */
     constructor(config?: ProcessorConfig);
+    /**
+     * Start the processor.
+     *
+     * @param {Function} func - starts listening for incoming messages
+     */
     listen(func: (request: MessageRequest, response: Response) => unknown): void;
 }

package/dist/processor.js

@@ -23,16 +23,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 const response_1 = __importDefault(require("./response"));
 const common_1 = require("@routr/common");
+/**
+ * Processor is a class that handles the processing of a request.
+ */
 class Processor {
+    /**
+     * Construct a new Processor.
+     *
+     * @param {ProcessorConfig} config The processor configuration
+     */
     constructor(config = { bindAddr: "0.0.0.0:51904", name: "" }) {
         this.config = config;
     }
+    /**
+     * Start the processor.
+     *
+     * @param {Function} func - starts listening for incoming messages
+     */
     listen(func) {
         (0, common_1.createService)({
             name: this.config.name,
             bindAddr: this.config.bindAddr,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             service: common_1.PROCESSOR_OBJECT_PROTO.Processor.service,
             handlers: {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 processMessage: (call, callback) => {
                     func(call.request, new response_1.default(callback));
                 }

package/dist/response.d.ts

@@ -1,11 +1,46 @@
 import { MessageRequest } from "@routr/common";
+/**
+ * Response object.
+ */
 export default class Response {
-    callback: any;
-    constructor(callback: Function);
-    sendOk(): void;
+    callback: (call: unknown, response: unknown) => void;
+    /**
+     * Creates a new Response object.
+     *
+     * @param {GrpcCallback} callback - The callback to be called when the response is ready.
+     */
+    constructor(callback: (call: unknown, response: unknown) => void);
+    /**
+     * Sends an OK response.
+     *
+     * @param {object[]} extraHeaders - Optional extra headers to be sent.
+     */
+    sendOk(extraHeaders?: Array<{
+        name: string;
+        value: string;
+    }>): void;
+    /**
+     * Sends a method not allowed response.
+     */
     sendMethodNotAllowed(): void;
+    /**
+     * Sends a not found response.
+     */
     sendNotFound(): void;
+    /**
+     * Sends a not implemented response.
+     */
     sendNotImplemented(): void;
+    /**
+     * Sends a response with a SIP Message.
+     *
+     * @param {MessageRequest} message - The request message. Accepts MessageRequest or a Record.
+     */
     send(message: MessageRequest | Record<string, unknown>): void;
-    sendError(error: any): void;
+    /**
+     * Sends an error response.
+     *
+     * @param {Error} error - The error to be sent.
+     */
+    sendError(error: Error): void;
 }

package/dist/response.js

@@ -1,27 +1,59 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const buildResponse = (code) => {
-    return { message: { responseType: code } };
+const buildResponse = (code, extraHeaders) => {
+    return { message: { responseType: code, extensions: extraHeaders } };
 };
+/**
+ * Response object.
+ */
 class Response {
+    /**
+     * Creates a new Response object.
+     *
+     * @param {GrpcCallback} callback - The callback to be called when the response is ready.
+     */
     constructor(callback) {
         this.callback = callback;
     }
-    sendOk() {
-        this.callback(null, buildResponse(7));
+    /**
+     * Sends an OK response.
+     *
+     * @param {object[]} extraHeaders - Optional extra headers to be sent.
+     */
+    sendOk(extraHeaders) {
+        this.callback(null, buildResponse(7, extraHeaders));
     }
+    /**
+     * Sends a method not allowed response.
+     */
     sendMethodNotAllowed() {
         this.callback(null, buildResponse(21));
     }
+    /**
+     * Sends a not found response.
+     */
     sendNotFound() {
         this.callback(null, buildResponse(20));
     }
+    /**
+     * Sends a not implemented response.
+     */
     sendNotImplemented() {
         this.callback(null, buildResponse(47));
     }
+    /**
+     * Sends a response with a SIP Message.
+     *
+     * @param {MessageRequest} message - The request message. Accepts MessageRequest or a Record.
+     */
     send(message) {
         this.callback(null, message);
     }
+    /**
+     * Sends an error response.
+     *
+     * @param {Error} error - The error to be sent.
+     */
     sendError(error) {
         this.callback(error, null);
     }

package/dist/target.d.ts

@@ -1,4 +1,5 @@
 import { MessageRequest } from "@routr/common";
-export declare const getAOR: (uri: any) => string;
+import { CommonTypes as CT } from "@routr/common";
+export declare const getAOR: (uri: CT.SipURI) => string;
 export declare const getTargetAOR: (request: MessageRequest) => string;
 export declare const getTargetExpires: (request: MessageRequest) => number;

package/dist/target.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTargetExpires = exports.getTargetAOR = exports.getAOR = void 0;
-const getAOR = (uri) => `${uri.secure ? 'sips' : 'sip'}:${uri.user ? uri.user + '@' : ''}${uri.host}`;
+const getAOR = (uri) => `${uri.secure ? "sips" : "sip"}:${uri.user ? uri.user + "@" : ""}${uri.host}`;
 exports.getAOR = getAOR;
 const getTargetAOR = (request) => (0, exports.getAOR)(request.message.to.address.uri);
 exports.getTargetAOR = getTargetAOR;
@@ -10,6 +10,8 @@ const getTargetExpires = (request) => {
     // The expires value in the Contact header takes presendence over the value
     // on the Expires header
     const expires = ((_b = (_a = request.message) === null || _a === void 0 ? void 0 : _a.contact) === null || _b === void 0 ? void 0 : _b.expires) || -1;
-    return expires > -1 ? expires : ((_c = request.message.expires) === null || _c === void 0 ? void 0 : _c.expires) || -1;
+    return expires > -1
+        ? expires
+        : ((_c = request.message.expires) === null || _c === void 0 ? void 0 : _c.expires) || -1;
 };
 exports.getTargetExpires = getTargetExpires;

package/dist/tracer.d.ts

@@ -1 +1,7 @@
+/**
+ * This function registers the instrumentations for the service.
+ *
+ * @param {string} serviceName - The name of the service.
+ * @return {Tracer} The tracer object.
+ */
 export declare function init(serviceName: string): import("@opentelemetry/api").Tracer;

package/dist/tracer.js

@@ -30,20 +30,24 @@ const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
 const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
 const exporter_jaeger_1 = require("@opentelemetry/exporter-jaeger");
 const instrumentation_grpc_1 = require("@opentelemetry/instrumentation-grpc");
+/**
+ * This function registers the instrumentations for the service.
+ *
+ * @param {string} serviceName - The name of the service.
+ * @return {Tracer} The tracer object.
+ */
 function init(serviceName) {
     const provider = new sdk_trace_node_1.NodeTracerProvider({
         resource: new resources_1.Resource({
-            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName,
-        }),
+            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName
+        })
     });
     const exporter = new exporter_jaeger_1.JaegerExporter();
     provider.addSpanProcessor(new sdk_trace_base_1.SimpleSpanProcessor(exporter));
     provider.register();
     (0, instrumentation_1.registerInstrumentations)({
-        instrumentations: [
-            new instrumentation_grpc_1.GrpcInstrumentation(),
-        ],
+        instrumentations: [new instrumentation_grpc_1.GrpcInstrumentation()]
     });
-    return api_1.default.trace.getTracer('routr-tracer');
+    return api_1.default.trace.getTracer("routr-tracer");
 }
 exports.init = init;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/processor",
-  "version": "2.0.5-alpha.15",
+  "version": "2.0.5-alpha.17",
   "description": "Processor server and API",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -12,7 +12,7 @@
     "build": "tsc -b tsconfig.json"
   },
   "dependencies": {
-    "@fonoster/logger": "^0.3.3",
+    "@fonoster/logger": "0.3.17-alpha.2",
     "@grpc/grpc-js": "^1.5.9",
     "@grpc/proto-loader": "^0.6.9",
     "@opentelemetry/api": "^1.0.4",
@@ -23,7 +23,7 @@
     "@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.15",
+    "@routr/common": "^2.0.5-alpha.17",
     "fp-ts": "^2.11.8"
   },
   "directories": {
@@ -43,5 +43,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "3e08aa86f1596252546134bff677d17d7dd54ced"
+  "gitHead": "724e4e690f3cdd960ad6660b602a84876fc444dc"
 }