@routr/common 2.15.0 → 2.15.3

package/dist/helper.d.ts

@@ -16,11 +16,11 @@ export declare const deepCopy: <T>(source: T) => T;
 export declare const getListeningPoint: (listeningPoints: NetInterface[], transport: Transport) => NetInterface;
 /**
  * Reads a file and returns a JSON object or throws an error.
- * The file must be a valid JSON, YAML, or TOML file.
+ * The file must be a valid JSON or YAML file.
  *
  * @param {string} path - The path to the file.
  * @return {object} The JSON object.
- * @throws {Error} If the file is not a valid JSON, YAML, or TOML file.
+ * @throws {Error} If the file is not a valid JSON or YAML file.
  * @throws {Error} If the file does not exist.
  * @throws {Error} If the file is not readable.
  * @throws {Error} If the file is empty.

package/dist/helper.js

@@ -56,7 +56,6 @@ exports.toPascalCase = exports.readConfigFile = exports.getListeningPoint = expo
  * limitations under the License.
  */
 const yaml = __importStar(require("js-yaml"));
-const toml = __importStar(require("toml"));
 const fs_1 = __importDefault(require("fs"));
 const types_1 = require("./types");
 /**
@@ -105,11 +104,11 @@ const getListeningPoint = (listeningPoints, transport) => {
 exports.getListeningPoint = getListeningPoint;
 /**
  * Reads a file and returns a JSON object or throws an error.
- * The file must be a valid JSON, YAML, or TOML file.
+ * The file must be a valid JSON or YAML file.
  *
  * @param {string} path - The path to the file.
  * @return {object} The JSON object.
- * @throws {Error} If the file is not a valid JSON, YAML, or TOML file.
+ * @throws {Error} If the file is not a valid JSON or YAML file.
  * @throws {Error} If the file does not exist.
  * @throws {Error} If the file is not readable.
  * @throws {Error} If the file is empty.
@@ -125,13 +124,6 @@ const readConfigFile = (path) => {
     catch (e) {
         // Ignore
     }
-    // Experimental TOML support
-    try {
-        return toml.parse(content);
-    }
-    catch (e) {
-        // Ignore
-    }
     try {
         return JSON.parse(content);
     }

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import createService, { getObjectProto, LOCATION_OBJECT_PROTO, PROCESSOR_OBJECT_PROTO } from "./service";
+import createService, { getObjectProto, GRPC_SERVING_STATUS, statusMap, LOCATION_OBJECT_PROTO, PROCESSOR_OBJECT_PROTO } from "./service";
 import { HeaderModifier, MessageRequest, MessageResponse, Method, NetInterface, ObjectProto, ProcessorConfig, Route, ServiceInfo, Transport } from "./types";
-export { createService, getObjectProto, HeaderModifier, Route, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
+export { createService, getObjectProto, HeaderModifier, Route, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO, GRPC_SERVING_STATUS, statusMap };
 export * as Auth from "./auth";
 export * as Redis from "./redis";
 export * as Helper from "./helper";

package/dist/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Verifier = exports.Environment = exports.ConnectSchemas = exports.CommonErrors = exports.CommonTypes = exports.CommonResponse = exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.Tracer = exports.IpUtils = exports.Helper = exports.Redis = exports.Auth = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.Method = exports.Transport = exports.getObjectProto = exports.createService = void 0;
+exports.Verifier = exports.Environment = exports.ConnectSchemas = exports.CommonErrors = exports.CommonTypes = exports.CommonResponse = exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.Tracer = exports.IpUtils = exports.Helper = exports.Redis = exports.Auth = exports.statusMap = exports.GRPC_SERVING_STATUS = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.Method = exports.Transport = exports.getObjectProto = exports.createService = void 0;
 /*
  * Copyright (C) 2026 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -55,6 +55,8 @@ exports.Verifier = exports.Environment = exports.ConnectSchemas = exports.Common
 const service_1 = __importStar(require("./service"));
 exports.createService = service_1.default;
 Object.defineProperty(exports, "getObjectProto", { enumerable: true, get: function () { return service_1.getObjectProto; } });
+Object.defineProperty(exports, "GRPC_SERVING_STATUS", { enumerable: true, get: function () { return service_1.GRPC_SERVING_STATUS; } });
+Object.defineProperty(exports, "statusMap", { enumerable: true, get: function () { return service_1.statusMap; } });
 Object.defineProperty(exports, "LOCATION_OBJECT_PROTO", { enumerable: true, get: function () { return service_1.LOCATION_OBJECT_PROTO; } });
 Object.defineProperty(exports, "PROCESSOR_OBJECT_PROTO", { enumerable: true, get: function () { return service_1.PROCESSOR_OBJECT_PROTO; } });
 const types_1 = require("./types");

package/dist/service.d.ts

@@ -1,5 +1,8 @@
 import { ObjectProto, ServiceInfo } from "./types";
 import { ServiceDefinitionNotFoundError } from "./errors";
+import { ServingStatusMap } from "grpc-health-check";
+export declare const GRPC_SERVING_STATUS = "SERVING";
+export declare const statusMap: ServingStatusMap;
 export declare const protoLoadOptions: {
     keepCase: boolean;
     longs: StringConstructor;

package/dist/service.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.protoLoadOptions = void 0;
+exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.protoLoadOptions = exports.statusMap = exports.GRPC_SERVING_STATUS = void 0;
 exports.getObjectProto = getObjectProto;
 exports.default = createService;
 /*
@@ -59,8 +59,10 @@ const protoLoader = __importStar(require("@grpc/proto-loader"));
 const errors_1 = require("./errors");
 const logger_1 = require("@fonoster/logger");
 const grpc_health_check_1 = require("grpc-health-check");
-const common_1 = require("@fonoster/common");
 const logger = (0, logger_1.getLogger)({ service: "common", filePath: __filename });
+exports.GRPC_SERVING_STATUS = "SERVING";
+// By convention, the empty string represents the entire server
+exports.statusMap = { "": "NOT_SERVING" };
 exports.protoLoadOptions = {
     keepCase: false,
     longs: String,
@@ -103,7 +105,7 @@ function getObjectProto(objectProto) {
  */
 function createService(serviceInfo) {
     const cb = () => {
-        healthImpl.setStatus("", common_1.GRPC_SERVING_STATUS);
+        healthImpl.setStatus("", exports.GRPC_SERVING_STATUS);
         logger.info("starting routr service", {
             name: serviceInfo.name,
             bindAddr: serviceInfo.bindAddr
@@ -112,7 +114,7 @@ function createService(serviceInfo) {
     const credentials = grpc.ServerCredentials.createInsecure();
     const server = new grpc.Server();
     server.addService(serviceInfo.service, serviceInfo.handlers);
-    const healthImpl = new grpc_health_check_1.HealthImplementation(common_1.statusMap);
+    const healthImpl = new grpc_health_check_1.HealthImplementation(exports.statusMap);
     // Add the health check service to the server
     healthImpl.addToServer(server);
     server.bindAsync(serviceInfo.bindAddr, credentials, cb);

package/dist/tracer.d.ts

@@ -1,7 +1,20 @@
+import { Tracer } from "@opentelemetry/api";
 /**
- * This function registers the instrumentations for the service.
+ * Whether tracing is on: an OTLP endpoint is configured and the SDK is not disabled.
  *
- * @param {string} serviceName - The name of the service.
+ * @param {NodeJS.ProcessEnv} env - The environment to read.
+ * @return {boolean} True when spans should be exported.
+ */
+export declare function tracingEnabled(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Starts tracing for the service, exporting spans over OTLP/HTTP to the endpoint in the
+ * standard OTEL_EXPORTER_OTLP_* variables. Without one it registers nothing and returns a
+ * no-op tracer. Call it before anything loads @grpc/grpc-js, so the gRPC instrumentation
+ * can propagate the W3C trace context between services. Only the first call in a process
+ * starts tracing (Routr One loads several services).
+ *
+ * @param {string} serviceName - The service's name, unless OTEL_SERVICE_NAME is set.
+ * @param {NodeJS.ProcessEnv} env - The environment to read.
  * @return {Tracer} The tracer object.
  */
-export declare function init(serviceName: string): import("@opentelemetry/api").Tracer;
+export declare function init(serviceName: string, env?: NodeJS.ProcessEnv): Tracer;

package/dist/tracer.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.tracingEnabled = tracingEnabled;
 exports.init = init;
 /*
  * Copyright (C) 2026 by Fonoster Inc (https://fonoster.com)
@@ -24,26 +25,59 @@ exports.init = init;
  */
 const api_1 = __importDefault(require("@opentelemetry/api"));
 const instrumentation_1 = require("@opentelemetry/instrumentation");
+const instrumentation_grpc_1 = require("@opentelemetry/instrumentation-grpc");
 const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
 const resources_1 = require("@opentelemetry/resources");
 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");
+const exporter_trace_otlp_http_1 = require("@opentelemetry/exporter-trace-otlp-http");
+/**
+ * Whether tracing is on: an OTLP endpoint is configured and the SDK is not disabled.
+ *
+ * @param {NodeJS.ProcessEnv} env - The environment to read.
+ * @return {boolean} True when spans should be exported.
+ */
+function tracingEnabled(env = process.env) {
+    if (env.OTEL_SDK_DISABLED === "true")
+        return false;
+    return !!(env.OTEL_EXPORTER_OTLP_ENDPOINT || env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT);
+}
+/**
+ * The traces endpoint, as the OTLP exporter would derive it from process.env.
+ *
+ * @param {NodeJS.ProcessEnv} env - The environment to read.
+ * @return {string} The URL spans are posted to.
+ */
+function tracesUrl(env) {
+    var _a;
+    if (env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT)
+        return env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT;
+    return `${(_a = env.OTEL_EXPORTER_OTLP_ENDPOINT) === null || _a === void 0 ? void 0 : _a.replace(/\/$/, "")}/v1/traces`;
+}
+let started = false;
 /**
- * This function registers the instrumentations for the service.
+ * Starts tracing for the service, exporting spans over OTLP/HTTP to the endpoint in the
+ * standard OTEL_EXPORTER_OTLP_* variables. Without one it registers nothing and returns a
+ * no-op tracer. Call it before anything loads @grpc/grpc-js, so the gRPC instrumentation
+ * can propagate the W3C trace context between services. Only the first call in a process
+ * starts tracing (Routr One loads several services).
  *
- * @param {string} serviceName - The name of the service.
+ * @param {string} serviceName - The service's name, unless OTEL_SERVICE_NAME is set.
+ * @param {NodeJS.ProcessEnv} env - The environment to read.
  * @return {Tracer} The tracer object.
  */
-function init(serviceName) {
+function init(serviceName, env = process.env) {
+    if (started || !tracingEnabled(env))
+        return api_1.default.trace.getTracer("routr-tracer");
+    started = true;
     const provider = new sdk_trace_node_1.NodeTracerProvider({
-        resource: new resources_1.Resource({
-            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName
-        })
+        resource: (0, resources_1.resourceFromAttributes)({
+            [semantic_conventions_1.ATTR_SERVICE_NAME]: env.OTEL_SERVICE_NAME || serviceName
+        }),
+        spanProcessors: [
+            new sdk_trace_base_1.BatchSpanProcessor(new exporter_trace_otlp_http_1.OTLPTraceExporter({ url: tracesUrl(env) }))
+        ]
     });
-    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()]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.15.0",
+  "version": "2.15.3",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -13,18 +13,17 @@
     "postbuild": "cp -a src/protos dist/protos && cp -a src/connect/protos dist/connect/protos"
   },
   "dependencies": {
-    "@fonoster/common": "0.6.0",
     "@fonoster/logger": "0.6.0",
-    "@grpc/grpc-js": "~1.10.1",
+    "@grpc/grpc-js": "~1.14.6",
     "@grpc/proto-loader": "~0.7.10",
-    "@opentelemetry/api": "^1.0.4",
-    "@opentelemetry/exporter-jaeger": "^1.0.4",
-    "@opentelemetry/instrumentation": "^0.27.0",
-    "@opentelemetry/instrumentation-grpc": "^0.27.0",
-    "@opentelemetry/resources": "^1.0.4",
-    "@opentelemetry/sdk-trace-base": "^1.0.4",
-    "@opentelemetry/sdk-trace-node": "^1.0.4",
-    "@opentelemetry/semantic-conventions": "^1.0.4",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.223.0",
+    "@opentelemetry/instrumentation": "^0.223.0",
+    "@opentelemetry/instrumentation-grpc": "^0.223.0",
+    "@opentelemetry/resources": "^2.12.0",
+    "@opentelemetry/sdk-trace-base": "^2.12.0",
+    "@opentelemetry/sdk-trace-node": "^2.12.0",
+    "@opentelemetry/semantic-conventions": "^1.43.0",
     "ajv": "^6.12.6",
     "fp-ts": "^2.11.8",
     "grpc-health-check": "^2.1.0",
@@ -32,7 +31,6 @@
     "js-yaml": "^4.1.1",
     "pb-util": "^1.0.3",
     "phone": "^3.1.68",
-    "toml": "^3.0.0",
     "validator": "^13.15.26"
   },
   "directories": {
@@ -55,5 +53,5 @@
   "devDependencies": {
     "@types/js-yaml": "^4.0.5"
   },
-  "gitHead": "4cfe8529e9325b7a2f32aff615cf3db65c71cf29"
+  "gitHead": "30e73f1331f115b2dd9d02cdfdcf931dbeede36b"
 }