Feature/centralized configs (#310)

* [snyk] fix vulnerabilities

* move all process.env in one config

* update log level in config

* check envs

* fix imports in tests for microsoft, soniox, deepgram

* fix import in gather-test

* fix missing imports

---------

Co-authored-by: Markus Frindt <[email protected]>

app.js

@@ -1,22 +1,26 @@
-const assert = require('assert');
-assert.ok(process.env.JAMBONES_MYSQL_HOST &&
-  process.env.JAMBONES_MYSQL_USER &&
-  process.env.JAMBONES_MYSQL_PASSWORD &&
-  process.env.JAMBONES_MYSQL_DATABASE, 'missing JAMBONES_MYSQL_XXX env vars');
-assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACHTIO_PORT env var');
-assert.ok(process.env.DRACHTIO_SECRET, 'missing DRACHTIO_SECRET env var');
-assert.ok(process.env.JAMBONES_FREESWITCH, 'missing JAMBONES_FREESWITCH env var');
-assert.ok(process.env.JAMBONES_REDIS_HOST, 'missing JAMBONES_REDIS_HOST env var');
-assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_SUBNET env var');
-assert.ok(process.env.ENCRYPTION_SECRET || process.env.JWT_SECRET, 'missing ENCRYPTION_SECRET env var');
+const {
+  DRACHTIO_PORT,
+  DRACHTIO_HOST,
+  DRACHTIO_SECRET,
+  JAMBONES_OTEL_SERVICE_NAME,
+  JAMBONES_LOGLEVEL,
+  JAMBONES_CLUSTER_ID,
+  JAMBONZ_CLEANUP_INTERVAL_MINS,
+  getCleanupIntervalMins,
+  K8S,
+  NODE_ENV,
+  checkEnvs,
+} = require('./lib/config');
+
+checkEnvs();
 
 const Srf = require('drachtio-srf');
 const srf = new Srf();
-const tracer = require('./tracer')(process.env.JAMBONES_OTEL_SERVICE_NAME || 'jambonz-feature-server');
+const tracer = require('./tracer')(JAMBONES_OTEL_SERVICE_NAME);
 const api = require('@opentelemetry/api');
 srf.locals = {...srf.locals, otel: {tracer, api}};
 
-const opts = {level: process.env.JAMBONES_LOGLEVEL || 'info'};
+const opts = {level: JAMBONES_LOGLEVEL};
 const pino = require('pino');
 const logger = pino(opts, pino.destination({sync: false}));
 const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./lib/utils/constants');
@@ -36,19 +40,19 @@ const {
 const InboundCallSession = require('./lib/session/inbound-call-session');
 const SipRecCallSession = require('./lib/session/siprec-call-session');
 
-if (process.env.DRACHTIO_HOST) {
-  srf.connect({host: process.env.DRACHTIO_HOST, port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET });
+if (DRACHTIO_HOST) {
+  srf.connect({host: DRACHTIO_HOST, port: DRACHTIO_PORT, secret: DRACHTIO_SECRET });
   srf.on('connect', (err, hp) => {
     const arr = /^(.*)\/(.*)$/.exec(hp.split(',').pop());
     srf.locals.localSipAddress = `${arr[2]}`;
     logger.info(`connected to drachtio listening on ${hp}, local sip address is ${srf.locals.localSipAddress}`);
   });
 }
 else {
-  logger.info(`listening for drachtio requests on port ${process.env.DRACHTIO_PORT}`);
-  srf.listen({port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET});
+  logger.info(`listening for drachtio requests on port ${DRACHTIO_PORT}`);
+  srf.listen({port: DRACHTIO_PORT, secret: DRACHTIO_SECRET});
 }
-if (process.env.NODE_ENV === 'test') {
+if (NODE_ENV === 'test') {
   srf.on('error', (err) => {
     logger.info(err, 'Error connecting to drachtio');
   });
@@ -113,13 +117,13 @@ function handle(signal) {
   const {removeFromSet} = srf.locals.dbHelpers;
   srf.locals.disabled = true;
   logger.info(`got signal ${signal}`);
-  const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
+  const setName = `${(JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
   if (setName && srf.locals.localSipAddress) {
     logger.info(`got signal ${signal}, removing ${srf.locals.localSipAddress} from set ${setName}`);
     removeFromSet(setName, srf.locals.localSipAddress);
   }
   removeFromSet(FS_UUID_SET_NAME, srf.locals.fsUUID);
-  if (process.env.K8S) {
+  if (K8S) {
     srf.locals.lifecycleEmitter.operationalState = LifeCycleEvents.ScaleIn;
   }
   if (getCount() === 0) {
@@ -128,7 +132,7 @@ function handle(signal) {
   }
 }
 
-if (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS) {
+if (JAMBONZ_CLEANUP_INTERVAL_MINS) {
   const {clearFiles} = require('./lib/utils/cron-jobs');
 
   /* cleanup orphaned files or channels every so often */
@@ -138,7 +142,7 @@ if (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS) {
     } catch (err) {
       logger.error({err}, 'app.js: error clearing files');
     }
-  }, 1000 * 60 * (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS || 60));
+  }, getCleanupIntervalMins());
 }
 
 module.exports = {srf, logger, disconnect};

bin/k8s-pre-stop-hook.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 const bent = require('bent');
 const getJSON = bent('json');
-const PORT = process.env.HTTP_PORT || 3000;
+const {PORT} = require('../lib/config')
 
 const sleep = (ms) => {
   return new Promise((resolve) => setTimeout(resolve, ms));

lib/config.js

@@ -0,0 +1,193 @@
+const assert = require('assert');
+
+const checkEnvs = () => {
+  assert.ok(process.env.JAMBONES_MYSQL_HOST &&
+		process.env.JAMBONES_MYSQL_USER &&
+		process.env.JAMBONES_MYSQL_PASSWORD &&
+		process.env.JAMBONES_MYSQL_DATABASE, 'missing JAMBONES_MYSQL_XXX env vars');
+  assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACHTIO_PORT env var');
+  assert.ok(process.env.DRACHTIO_SECRET, 'missing DRACHTIO_SECRET env var');
+  assert.ok(process.env.JAMBONES_FREESWITCH, 'missing JAMBONES_FREESWITCH env var');
+  assert.ok(process.env.JAMBONES_REDIS_HOST, 'missing JAMBONES_REDIS_HOST env var');
+  assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_SUBNET env var');
+};
+
+const NODE_ENV = process.env.NODE_ENV;
+
+/* database mySQL */
+const JAMBONES_MYSQL_HOST = process.env.JAMBONES_MYSQL_HOST;
+const JAMBONES_MYSQL_USER = process.env.JAMBONES_MYSQL_USER;
+const JAMBONES_MYSQL_PASSWORD = process.env.JAMBONES_MYSQL_PASSWORD;
+const JAMBONES_MYSQL_DATABASE = process.env.JAMBONES_MYSQL_DATABASE;
+const JAMBONES_MYSQL_PORT = parseInt(process.env.JAMBONES_MYSQL_PORT, 10) || 3306;
+const JAMBONES_MYSQL_REFRESH_TTL = process.env.JAMBONES_MYSQL_REFRESH_TTL;
+const JAMBONES_MYSQL_CONNECTION_LIMIT = parseInt(process.env.JAMBONES_MYSQL_CONNECTION_LIMIT, 10) || 10;
+
+/* redis */
+const JAMBONES_REDIS_HOST = process.env.JAMBONES_REDIS_HOST;
+const JAMBONES_REDIS_PORT = parseInt(process.env.JAMBONES_REDIS_PORT, 10) || 6379;
+
+/* gather and hints */
+const JAMBONES_GATHER_EARLY_HINTS_MATCH = process.env.JAMBONES_GATHER_EARLY_HINTS_MATCH;
+const JAMBONZ_GATHER_EARLY_HINTS_MATCH = process.env.JAMBONZ_GATHER_EARLY_HINTS_MATCH;
+const JAMBONES_GATHER_CLEAR_GLOBAL_HINTS_ON_EMPTY_HINTS = process.env.JAMBONES_GATHER_CLEAR_GLOBAL_HINTS_ON_EMPTY_HINTS;
+
+const SMPP_URL = process.env.SMPP_URL;
+
+/* drachtio */
+const DRACHTIO_PORT = process.env.DRACHTIO_PORT;
+const DRACHTIO_HOST = process.env.DRACHTIO_HOST;
+const DRACHTIO_SECRET = process.env.DRACHTIO_SECRET;
+
+/* freeswitch */
+const JAMBONES_API_BASE_URL = process.env.JAMBONES_API_BASE_URL;
+const JAMBONES_FREESWITCH = process.env.JAMBONES_FREESWITCH;
+const JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS = parseInt(process.env.JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS, 10)
+	|| 180;
+
+
+const JAMBONES_SBCS = process.env.JAMBONES_SBCS;
+
+/* websockets */
+const JAMBONES_WS_HANDSHAKE_TIMEOUT_MS = parseInt(process.env.JAMBONES_WS_HANDSHAKE_TIMEOUT_MS, 10) || 1500;
+const JAMBONES_WS_MAX_PAYLOAD = parseInt(process.env.JAMBONES_WS_MAX_PAYLOAD, 10) || 24 * 1024;
+
+const MAX_RECONNECTS = 5;
+const RESPONSE_TIMEOUT_MS = parseInt(process.env.JAMBONES_WS_API_MSG_RESPONSE_TIMEOUT, 10) || 5000;
+
+const JAMBONES_NETWORK_CIDR = process.env.JAMBONES_NETWORK_CIDR;
+const JAMBONES_TIME_SERIES_HOST = process.env.JAMBONES_TIME_SERIES_HOST;
+const JAMBONES_CLUSTER_ID = process.env.JAMBONES_CLUSTER_ID || 'default';
+const JAMBONES_ESL_LISTEN_ADDRESS = process.env.JAMBONES_ESL_LISTEN_ADDRESS;
+
+/* tracing */
+const JAMBONES_OTEL_ENABLED = process.env.JAMBONES_OTEL_ENABLED;
+const JAMBONES_OTEL_SERVICE_NAME = process.env.JAMBONES_OTEL_SERVICE_NAME || 'jambonz-feature-server';
+const OTEL_EXPORTER_JAEGER_AGENT_HOST = process.env.OTEL_EXPORTER_JAEGER_AGENT_HOST;
+const OTEL_EXPORTER_ZIPKIN_URL = process.env.OTEL_EXPORTER_ZIPKIN_URL;
+const OTEL_EXPORTER_COLLECTOR_URL = process.env.OTEL_EXPORTER_COLLECTOR_URL;
+
+const JAMBONES_LOGLEVEL = process.env.JAMBONES_LOGLEVEL || 'info';
+const JAMBONES_INJECT_CONTENT = process.env.JAMBONES_INJECT_CONTENT;
+
+const PORT = parseInt(process.env.HTTP_PORT, 10) || 3000;
+const HTTP_PORT_MAX = parseInt(process.env.HTTP_PORT_MAX, 10);
+
+const K8S = process.env.K8S;
+const K8S_SBC_SIP_SERVICE_NAME = process.env.K8S_SBC_SIP_SERVICE_NAME;
+
+const JAMBONES_SUBNET = process.env.JAMBONES_SUBNET;
+
+/* clean up */
+const JAMBONZ_CLEANUP_INTERVAL_MINS = process.env.JAMBONZ_CLEANUP_INTERVAL_MINS;
+const getCleanupIntervalMins = () => {
+  const interval = parseInt(JAMBONZ_CLEANUP_INTERVAL_MINS, 10) || 60;
+  return 1000 * 60 * interval;
+};
+
+/* speech vendors */
+const AWS_REGION = process.env.AWS_REGION;
+const AWS_ACCESS_KEY_ID = process.env.AWS_ACCESS_KEY_ID;
+const AWS_SECRET_ACCESS_KEY = process.env.AWS_SECRET_ACCESS_KEY;
+const AWS_SNS_PORT = parseInt(process.env.AWS_SNS_PORT, 10) || 3001;
+const AWS_SNS_TOPIC_ARM = process.env.AWS_SNS_TOPIC_ARM;
+const AWS_SNS_PORT_MAX = parseInt(process.env.AWS_SNS_PORT_MAX, 10) || 3005;
+
+const GCP_JSON_KEY = process.env.GCP_JSON_KEY;
+
+const MICROSOFT_REGION = process.env.MICROSOFT_REGION;
+const MICROSOFT_API_KEY = process.env.MICROSOFT_API_KEY;
+
+const SONIOX_API_KEY = process.env.SONIOX_API_KEY;
+
+const DEEPGRAM_API_KEY = process.env.DEEPGRAM_API_KEY;
+
+const ANCHOR_MEDIA_ALWAYS = process.env.ANCHOR_MEDIA_ALWAYS;
+const VMD_HINTS_FILE = process.env.VMD_HINTS_FILE;
+
+/* security, secrets */
+const LEGACY_CRYPTO = !!process.env.LEGACY_CRYPTO;
+const JWT_SECRET = process.env.JWT_SECRET;
+const ENCRYPTION_SECRET = process.env.ENCRYPTION_SECRET;
+
+/* HTTP/1 pool dispatcher */
+const HTTP_POOL = process.env.HTTP_POOL && parseInt(process.env.HTTP_POOL);
+const HTTP_POOLSIZE = parseInt(process.env.HTTP_POOLSIZE, 10) || 10;
+const HTTP_PIPELINING = parseInt(process.env.HTTP_PIPELINING, 10) || 1;
+const HTTP_TIMEOUT = 10000;
+
+const OPTIONS_PING_INTERVAL = parseInt(process.env.OPTIONS_PING_INTERVAL, 10) || 30000;
+
+module.exports = {
+  JAMBONES_MYSQL_HOST,
+  JAMBONES_MYSQL_USER,
+  JAMBONES_MYSQL_PASSWORD,
+  JAMBONES_MYSQL_DATABASE,
+  JAMBONES_MYSQL_REFRESH_TTL,
+  JAMBONES_MYSQL_CONNECTION_LIMIT,
+  JAMBONES_MYSQL_PORT,
+
+  DRACHTIO_PORT,
+  DRACHTIO_HOST,
+  DRACHTIO_SECRET,
+
+  JAMBONES_GATHER_EARLY_HINTS_MATCH,
+  JAMBONZ_GATHER_EARLY_HINTS_MATCH,
+  JAMBONES_GATHER_CLEAR_GLOBAL_HINTS_ON_EMPTY_HINTS,
+  JAMBONES_FREESWITCH,
+  JAMBONES_REDIS_HOST,
+  JAMBONES_REDIS_PORT,
+  SMPP_URL,
+  JAMBONES_NETWORK_CIDR,
+  JAMBONES_API_BASE_URL,
+  JAMBONES_TIME_SERIES_HOST,
+  JAMBONES_INJECT_CONTENT,
+  JAMBONES_ESL_LISTEN_ADDRESS,
+  JAMBONES_SBCS,
+  JAMBONES_OTEL_ENABLED,
+  JAMBONES_OTEL_SERVICE_NAME,
+  OTEL_EXPORTER_JAEGER_AGENT_HOST,
+  OTEL_EXPORTER_ZIPKIN_URL,
+  OTEL_EXPORTER_COLLECTOR_URL,
+
+  JAMBONES_LOGLEVEL,
+  JAMBONES_CLUSTER_ID,
+  PORT,
+  HTTP_PORT_MAX,
+  K8S,
+  K8S_SBC_SIP_SERVICE_NAME,
+  JAMBONES_SUBNET,
+  NODE_ENV,
+  JAMBONZ_CLEANUP_INTERVAL_MINS,
+  getCleanupIntervalMins,
+  checkEnvs,
+
+  AWS_REGION,
+  AWS_ACCESS_KEY_ID,
+  AWS_SECRET_ACCESS_KEY,
+  AWS_SNS_PORT,
+  AWS_SNS_TOPIC_ARM,
+  AWS_SNS_PORT_MAX,
+
+  ANCHOR_MEDIA_ALWAYS,
+  VMD_HINTS_FILE,
+  JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS,
+
+  LEGACY_CRYPTO,
+  JWT_SECRET,
+  ENCRYPTION_SECRET,
+  HTTP_POOL,
+  HTTP_POOLSIZE,
+  HTTP_PIPELINING,
+  HTTP_TIMEOUT,
+  OPTIONS_PING_INTERVAL,
+  RESPONSE_TIMEOUT_MS,
+  JAMBONES_WS_HANDSHAKE_TIMEOUT_MS,
+  JAMBONES_WS_MAX_PAYLOAD,
+  MAX_RECONNECTS,
+  GCP_JSON_KEY,
+  MICROSOFT_REGION,
+  MICROSOFT_API_KEY,
+  SONIOX_API_KEY,
+  DEEPGRAM_API_KEY
+};

lib/middleware.js

@@ -10,6 +10,9 @@ const { normalizeJambones }  = require('@jambonz/verb-specifications');
 const dbUtils = require('./utils/db-utils');
 const RootSpan = require('./utils/call-tracer');
 const listTaskNames = require('./utils/summarize-tasks');
+const {
+  JAMBONES_MYSQL_REFRESH_TTL,
+} = require('./config');
 
 module.exports = function(srf, logger) {
   const {
@@ -242,7 +245,7 @@ module.exports = function(srf, logger) {
       */
 
       /* allow for caching data - when caching treat retrieved data as immutable */
-      const app2 = process.env.JAMBONES_MYSQL_REFRESH_TTL ? JSON.parse(JSON.stringify(app)) : app;
+      const app2 = JAMBONES_MYSQL_REFRESH_TTL ? JSON.parse(JSON.stringify(app)) : app;
       if ('WS' === app.call_hook?.method ||
         app.call_hook?.url.startsWith('ws://') || app.call_hook?.url.startsWith('wss://')) {
         app2.requestor = new WsRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret) ;
@@ -285,7 +288,7 @@ module.exports = function(srf, logger) {
     const {rootSpan, siprec, application:app} = req.locals;
     let span;
     try {
-      if (app.tasks && !process.env.JAMBONES_MYSQL_REFRESH_TTL) {
+      if (app.tasks && !JAMBONES_MYSQL_REFRESH_TTL) {
         app.tasks = normalizeJambones(logger, app.tasks).map((tdata) => makeTask(logger, tdata));
         if (0 === app.tasks.length) throw new Error('no application provided');
         return next();

lib/session/call-info.js

@@ -1,6 +1,7 @@
 const {CallDirection, CallStatus} = require('../utils/constants');
 const parseUri = require('drachtio-srf').parseUri;
 const uuidv4 = require('uuid-random');
+const {JAMBONES_API_BASE_URL} = require('../config');
 /**
  * @classdesc Represents the common information for all calls
  * that is provided in call status webhooks
@@ -146,8 +147,8 @@ class CallInfo {
       Object.assign(obj, {customerData: this._customerData});
     }
 
-    if (process.env.JAMBONES_API_BASE_URL) {
-      Object.assign(obj, {apiBaseUrl: process.env.JAMBONES_API_BASE_URL});
+    if (JAMBONES_API_BASE_URL) {
+      Object.assign(obj, {apiBaseUrl: JAMBONES_API_BASE_URL});
     }
     if (this.publicIp) {
       Object.assign(obj, {fsPublicIp: this.publicIp});

lib/session/call-session.js

@@ -17,6 +17,10 @@ const { normalizeJambones } = require('@jambonz/verb-specifications');
 const listTaskNames = require('../utils/summarize-tasks');
 const HttpRequestor = require('../utils/http-requestor');
 const WsRequestor = require('../utils/ws-requestor');
+const {
+  JAMBONES_INJECT_CONTENT,
+  AWS_REGION
+} = require('../config');
 const BADPRECONDITIONS = 'preconditions not met';
 const CALLER_CANCELLED_ERR_MSG = 'Response not sent due to unknown transaction';
 
@@ -626,7 +630,7 @@ class CallSession extends Emitter {
             speech_credential_sid: credential.speech_credential_sid,
             accessKeyId: credential.access_key_id,
             secretAccessKey: credential.secret_access_key,
-            region: credential.aws_region || process.env.AWS_REGION
+            region: credential.aws_region || AWS_REGION
           };
         }
         else if ('microsoft' === vendor) {
@@ -1199,7 +1203,7 @@ class CallSession extends Emitter {
             this.logger.info({tasks: listTaskNames(t)}, 'CallSession:_onCommand new task list');
             this.replaceApplication(t);
           }
-          else if (process.env.JAMBONES_INJECT_CONTENT) {
+          else if (JAMBONES_INJECT_CONTENT) {
             this._injectTasks(t);
             this.logger.info({tasks: listTaskNames(this.tasks)}, 'CallSession:_onCommand - updated task list');
           }

lib/tasks/dial.js

@@ -15,6 +15,7 @@ const DtmfCollector = require('../utils/dtmf-collector');
 const dbUtils = require('../utils/db-utils');
 const debug = require('debug')('jambonz:feature-server');
 const {parseUri} = require('drachtio-srf');
+const {ANCHOR_MEDIA_ALWAYS} = require('../config');
 
 function parseDtmfOptions(logger, dtmfCapture) {
   let parentDtmfCollector, childDtmfCollector;
@@ -135,7 +136,7 @@ class TaskDial extends Task {
 
   get canReleaseMedia() {
     const keepAnchor = this.data.anchorMedia ||
-    process.env.ANCHOR_MEDIA_ALWAYS ||
+    ANCHOR_MEDIA_ALWAYS ||
     this.listenTask ||
     this.transcribeTask ||
     this.startAmd;