fix to add custom stt endpoint to session speech credentials object

.github/workflows/build.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 16
+          node-version: 14
       - run: npm ci
       - run: npm run jslint
       - run: docker pull drachtio/sipp

Dockerfile

@@ -1,4 +1,4 @@
-FROM --platform=linux/amd64 node:18.12.1-alpine3.16 as base
+FROM --platform=linux/amd64 node:18.8.0-alpine as base
 
 RUN apk --update --no-cache add --virtual .builds-deps build-base python3
 

app.js

@@ -15,6 +15,7 @@ const tracer = require('./tracer')(process.env.JAMBONES_OTEL_SERVICE_NAME || 'ja
 const api = require('@opentelemetry/api');
 srf.locals = {...srf.locals, otel: {tracer, api}};
 
+const PORT = process.env.HTTP_PORT || 3000;
 const opts = {level: process.env.JAMBONES_LOGLEVEL || 'info'};
 const pino = require('pino');
 const logger = pino(opts, pino.destination({sync: false}));
@@ -32,6 +33,17 @@ const {
   invokeWebCallback
 } = require('./lib/middleware')(srf, logger);
 
+// HTTP
+const express = require('express');
+const helmet = require('helmet');
+const app = express();
+Object.assign(app.locals, {
+  logger,
+  srf
+});
+
+const httpRoutes = require('./lib/http-routes');
+
 const InboundCallSession = require('./lib/session/inbound-call-session');
 const SipRecCallSession = require('./lib/session/siprec-call-session');
 
@@ -70,6 +82,20 @@ srf.invite(async(req, res) => {
   session.exec();
 });
 
+// HTTP
+app.use(helmet());
+app.use(helmet.hidePoweredBy());
+app.use(express.urlencoded({ extended: true }));
+app.use(express.json());
+app.use('/', httpRoutes);
+app.use((err, req, res, next) => {
+  logger.error(err, 'burped error');
+  res.status(err.status || 500).json({msg: err.message});
+});
+const httpServer = app.listen(PORT);
+
+logger.info(`listening for HTTP requests on port ${PORT}, serviceUrl is ${srf.locals.serviceUrl}`);
+
 const sessionTracker = srf.locals.sessionTracker = require('./lib/session/session-tracker');
 sessionTracker.on('idle', () => {
   if (srf.locals.lifecycleEmitter.operationalState === LifeCycleEvents.ScaleIn) {
@@ -77,30 +103,19 @@ sessionTracker.on('idle', () => {
     srf.locals.lifecycleEmitter.scaleIn();
   }
 });
+
 const getCount = () => sessionTracker.count;
 const healthCheck = require('@jambonz/http-health-check');
-let httpServer;
-
-const createHttpListener = require('./lib/utils/http-listener');
-createHttpListener(logger, srf)
-  .then(({server, app}) => {
-    httpServer = server;
-    healthCheck({app, logger, path: '/', fn: getCount});
-    return {server, app};
-  })
-  .catch((err) => {
-    logger.error(err, 'Error creating http listener');
-  });
-
+healthCheck({app, logger, path: '/', fn: getCount});
 
 setInterval(() => {
   srf.locals.stats.gauge('fs.sip.calls.count', sessionTracker.count);
-}, 20000);
+}, 5000);
 
 const disconnect = () => {
   return new Promise ((resolve) => {
-    httpServer?.on('close', resolve);
-    httpServer?.close();
+    httpServer.on('close', resolve);
+    httpServer.close();
     srf.disconnect();
     srf.locals.mediaservers.forEach((ms) => ms.disconnect());
   });

data/example-voicemail-greetings.json

@@ -48,5 +48,5 @@
     "ens posarem en contacto",
     "ara no estem disponibles",
     "no hi som"
-  ]
+  ],
 }

lib/http-routes/api/create-call.js

@@ -41,8 +41,7 @@ router.post('/', async(req, res) => {
       'X-Jambonz-Routing': target.type,
       'X-Jambonz-FS-UUID': srf.locals.fsUUID,
       'X-Call-Sid': callSid,
-      'X-Account-Sid': accountSid,
-      ...(restDial.fromHost && {'X-Preferred-From-Host': restDial.fromHost})
+      'X-Account-Sid': accountSid
     };
 
     switch (target.type) {

lib/session/call-session.js

@@ -551,9 +551,7 @@ class CallSession extends Emitter {
             api_key: credential.api_key,
             region: credential.region,
             use_custom_stt: credential.use_custom_stt,
-            custom_stt_endpoint: credential.custom_stt_endpoint,
-            use_custom_tts: credential.use_custom_tts,
-            custom_tts_endpoint: credential.custom_tts_endpoint
+            custom_stt_endpoint: credential.custom_stt_endpoint
           };
         }
         else if ('wellsaid' === vendor) {
@@ -1163,12 +1161,7 @@ class CallSession extends Emitter {
     // need to allocate an endpoint
     try {
       if (!this.ms) this.ms = this.getMS();
-      const ep = await this.ms.createEndpoint({
-        headers: {
-          'X-Jambones-Call-ID': this.callId,
-        },
-        remoteSdp: this.req.body
-      });
+      const ep = await this.ms.createEndpoint({remoteSdp: this.req.body});
       //ep.cs = this;
       this.ep = ep;
       ep.set({
@@ -1468,8 +1461,7 @@ class CallSession extends Emitter {
       headers: {
         'Refer-To': referTo,
         'Referred-By': `sip:${this.srf.locals.localSipAddress}`,
-        'X-Retain-Call-Sid': this.callSid,
-        'X-Account-Sid': this.accountSid
+        'X-Retain-Call-Sid': this.callSid
       }
     });
     if ([200, 202].includes(res.status)) {

lib/tasks/config.js

@@ -146,11 +146,7 @@ class TaskConfig extends Task {
   _onAmdEvent(cs, evt) {
     this.logger.info({evt}, 'Config:_onAmdEvent');
     const {actionHook} = this.data.amd;
-    this.performHook(cs, actionHook, evt)
-      .catch((err) => {
-        this.logger.error({err}, 'Config:_onAmdEvent - error calling actionHook');
-      });
-
+    this.performHook(cs, actionHook, evt);
   }
 }
 

lib/tasks/dial.js

@@ -689,10 +689,7 @@ class TaskDial extends Task {
   _onAmdEvent(cs, evt) {
     this.logger.info({evt}, 'Dial:_onAmdEvent');
     const {actionHook} = this.data.amd;
-    this.performHook(cs, actionHook, evt)
-      .catch((err) => {
-        this.logger.error({err}, 'Dial:_onAmdEvent - error calling actionHook');
-      });
+    this.performHook(cs, actionHook, evt);
   }
 }
 

lib/tasks/gather.js

@@ -83,7 +83,6 @@ class TaskGather extends Task {
       this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
       this.azureServiceEndpoint = recognizer.azureServiceEndpoint;
       this.azureSttEndpointId = recognizer.azureSttEndpointId;
-      this.azureAudioLogging = recognizer.audioLogging;
     }
     else {
       this.hints = [];
@@ -143,14 +142,6 @@ class TaskGather extends Task {
       this.logger.debug({hints: this.hints, hintsBoost: this.hintsBoost},
         'Gather:exec - applying global sttHints');
     }
-    if (process.env.JAMBONZ_GATHER_EARLY_HINTS_MATCH &&
-      !this.isContinuousAsr &&
-      this.hints.length > 0 && this.hints.length <= 10) {
-      this.earlyHintsMatch = true;
-      this.interim = true;
-      this.logger.debug('Gather:exec - early hints match enabled');
-    }
-
     if (cs.hasAltLanguages) {
       this.altLanguages = this.altLanguages.concat(cs.altLanguages);
       this.logger.debug({altLanguages: this.altLanguages},
@@ -390,7 +381,6 @@ class TaskGather extends Task {
       else {
         opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = '';
       }
-      if (this.azureAudioLogging) opts.AZURE_AUDIO_LOGGING = 1;
       if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
       if (this.profanityOption && this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
       if (this.azureServiceEndpoint) opts.AZURE_SERVICE_ENDPOINT = this.azureServiceEndpoint;
@@ -534,15 +524,6 @@ class TaskGather extends Task {
       }
     }
 
-    if (this.earlyHintsMatch && evt.is_final === false) {
-      const transcript = evt.alternatives[0].transcript?.toLowerCase();
-      if (this.hints.find((h) => h.toLowerCase() === transcript)) {
-        this.logger.debug({evt}, 'Gather:_onTranscription: early hint match');
-        this._resolve('speech', evt);
-        return;
-      }
-    }
-
     /* count words for bargein feature */
     const words = evt.alternatives[0].transcript.split(' ').length;
     const bufferedWords = this._bufferedTranscripts.reduce((count, e) => {

lib/tasks/rest_dial.js

@@ -11,7 +11,6 @@ class TaskRestDial extends Task {
     super(logger, opts);
 
     this.from = this.data.from;
-    this.fromHost = this.data.fromHost;
     this.to = this.data.to;
     this.call_hook = this.data.call_hook;
     this.timeout = this.data.timeout || 60;

lib/tasks/say.js

@@ -164,10 +164,6 @@ class TaskSay extends Task {
           'tts.voice': voice
         });
         try {
-          if (vendor === 'microsoft' && this.synthesizer.azureServiceEndpoint) {
-            credentials.use_custom_tts = true;
-            credentials.custom_tts_endpoint = this.synthesizer.azureServiceEndpoint;
-          }
           const {filePath, servedFromCache} = await synthAudio(stats, {
             text,
             vendor,

lib/tasks/specs.json

@@ -341,7 +341,6 @@
       "call_hook": "object|string",
       "call_status_hook": "object|string",
       "from": "string",
-      "fromHost": "string",
       "speech_synthesis_vendor": "string",
       "speech_synthesis_voice": "string",
       "speech_synthesis_language": "string",
@@ -388,7 +387,6 @@
         "enum": ["GET", "POST"]
       },
       "headers": "object",
-      "from": "#dialFrom",
       "name": "string",
       "number": "string",
       "sipUri": "string",
@@ -402,14 +400,6 @@
       "type"
     ]
   },
-  "dialFrom": {
-    "properties": {
-      "user": "string",
-      "host": "string"
-    },
-    "required": [
-    ]
-  },
   "auth": {
     "properties": {
       "username": "string",
@@ -435,8 +425,7 @@
       "gender": {
         "type": "string",
         "enum": ["MALE", "FEMALE", "NEUTRAL"]
-      },
-      "azureServiceEndpoint": "string"
+      }
     },
     "required": [
       "vendor"
@@ -510,8 +499,7 @@
       "azureServiceEndpoint": "string",
       "azureSttEndpointId": "string",
       "asrDtmfTerminationDigit": "string",
-      "asrTimeout": "number",
-      "audioLogging": "boolean"
+      "asrTimeout": "number"
     },
     "required": [
       "vendor"

lib/tasks/task.js

@@ -336,9 +336,6 @@ class Task extends Emitter {
         }
         required = required.filter((item) => item !== dKey);
       }
-      else if (dKey === '_') {
-        /* no op: allow arbitrary info to be carried here, used by conference e.g in transfer */
-      }
       else throw new Error(`${name}: unknown property ${dKey}`);
     }
     if (required.length > 0) throw new Error(`${name}: missing value for ${required}`);

lib/tasks/transcribe.js

@@ -55,7 +55,6 @@ class TaskTranscribe extends Task {
     this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
     this.azureServiceEndpoint = recognizer.azureServiceEndpoint;
     this.azureSttEndpointId = recognizer.azureSttEndpointId;
-    this.azureAudioLogging = recognizer.audioLogging;
   }
 
   get name() { return TaskName.Transcribe; }
@@ -250,7 +249,6 @@ class TaskTranscribe extends Task {
       }
       if (this.altLanguages.length > 0) opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
       else opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = '';
-      if (this.azureAudioLogging) opts.AZURE_AUDIO_LOGGING = 1;
       if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
       if (this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
       if (this.initialSpeechTimeoutMs > 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = this.initialSpeechTimeoutMs;

lib/utils/amd-utils.js

@@ -273,46 +273,26 @@ module.exports = (logger) => {
     amd
       .on(AmdEvents.NoSpeechDetected, (evt) => {
         task.emit('amd', {type: AmdEvents.NoSpeechDetected, ...evt});
-        try {
-          ep.connected && ep.stopTranscription({vendor, bugname});
-        } catch (err) {
-          logger.info({err}, 'Error stopping transcription');
-        }
+        ep.stopTranscription({vendor, bugname});
       })
       .on(AmdEvents.HumanDetected, (evt) => {
         task.emit('amd', {type: AmdEvents.HumanDetected, ...evt});
-        try {
-          ep.connected && ep.stopTranscription({vendor, bugname});
-        } catch (err) {
-          logger.info({err}, 'Error stopping transcription');
-        }
+        ep.stopTranscription({vendor, bugname});
       })
       .on(AmdEvents.MachineDetected, (evt) => {
         task.emit('amd', {type: AmdEvents.MachineDetected, ...evt});
       })
       .on(AmdEvents.DecisionTimeout, (evt) => {
         task.emit('amd', {type: AmdEvents.DecisionTimeout, ...evt});
-        try {
-          ep.connected && ep.stopTranscription({vendor, bugname});
-        } catch (err) {
-          logger.info({err}, 'Error stopping transcription');
-        }
+        ep.stopTranscription({vendor, bugname});
       })
       .on(AmdEvents.ToneTimeout, (evt) => {
         //task.emit('amd', {type: AmdEvents.ToneTimeout, ...evt});
-        try {
-          ep.connected && ep.execute('avmd_stop').catch((err) => logger.info(err, 'Error stopping avmd'));
-        } catch (err) {
-          logger.info({err}, 'Error stopping avmd');
-        }
+        ep.execute('avmd_stop').catch((err) => logger.info(err, 'Error stopping avmd'));
       })
       .on(AmdEvents.MachineStoppedSpeaking, () => {
         task.emit('amd', {type: AmdEvents.MachineStoppedSpeaking});
-        try {
-          ep.connected && ep.stopTranscription({vendor, bugname});
-        } catch (err) {
-          logger.info({err}, 'Error stopping transcription');
-        }
+        ep.stopTranscription({vendor, bugname});
       });
 
     /* start transcribing, and also listening for beep */

lib/utils/aws-sns-lifecycle.js

@@ -1,7 +1,7 @@
 const Emitter = require('events');
 const bent = require('bent');
 const assert = require('assert');
-const PORT = process.env.AWS_SNS_PORT || 3010;
+const PORT = process.env.AWS_SNS_PORT || 3001;
 const {LifeCycleEvents} = require('./constants');
 const express = require('express');
 const app = express();
@@ -21,26 +21,6 @@ class SnsNotifier extends Emitter {
 
     this.logger = logger;
   }
-  _doListen(logger, app, port, resolve) {
-    return app.listen(port, () => {
-      this.snsEndpoint = `http://${this.publicIp}:${port}`;
-      logger.info(`SNS lifecycle server listening on http://localhost:${port}`);
-      resolve(app);
-    });
-  }
-
-  _handleErrors(logger, app, resolve, reject, e) {
-    if (e.code === 'EADDRINUSE' &&
-      process.env.AWS_SNS_PORT_MAX &&
-      e.port < process.env.AWS_SNS_PORT_MAX) {
-
-      logger.info(`SNS lifecycle server failed to bind port on ${e.port}, will try next port`);
-      const server = this._doListen(logger, app, ++e.port, resolve);
-      server.on('error', this._handleErrors.bind(this, logger, app, resolve, reject));
-      return;
-    }
-    reject(e);
-  }
 
   async _handlePost(req, res) {
     try {
@@ -104,9 +84,11 @@ class SnsNotifier extends Emitter {
       this.logger.debug('SnsNotifier: retrieving instance data');
       this.instanceId = await getString('http://169.254.169.254/latest/meta-data/instance-id');
       this.publicIp = await getString('http://169.254.169.254/latest/meta-data/public-ipv4');
+      this.snsEndpoint = `http://${this.publicIp}:${PORT}`;
       this.logger.info({
         instanceId: this.instanceId,
-        publicIp: this.publicIp
+        publicIp: this.publicIp,
+        snsEndpoint: this.snsEndpoint
       }, 'retrieved AWS instance data');
 
       // start listening
@@ -118,10 +100,7 @@ class SnsNotifier extends Emitter {
         this.logger.error(err, 'burped error');
         res.status(err.status || 500).json({msg: err.message});
       });
-      return new Promise((resolve, reject) => {
-        const server = this._doListen(this.logger, app, PORT, resolve);
-        server.on('error', this._handleErrors.bind(this, this.logger, app, resolve, reject));
-      });
+      app.listen(PORT);
 
     } catch (err) {
       this.logger.error({err}, 'Error retrieving AWS instance metadata');

lib/utils/db-utils.js

@@ -23,30 +23,25 @@ AND vc.name = ?`;
 
 const speechMapper = (cred) => {
   const {credential, ...obj} = cred;
-  try {
-    if ('google' === obj.vendor) {
-      obj.service_key = decrypt(credential);
-    }
-    else if ('aws' === obj.vendor) {
-      const o = JSON.parse(decrypt(credential));
-      obj.access_key_id = o.access_key_id;
-      obj.secret_access_key = o.secret_access_key;
-      obj.aws_region = o.aws_region;
-    }
-    else if ('microsoft' === obj.vendor) {
-      const o = JSON.parse(decrypt(credential));
-      obj.api_key = o.api_key;
-      obj.region = o.region;
-      obj.use_custom_stt = o.use_custom_stt;
-      obj.custom_stt_endpoint = o.custom_stt_endpoint;
-      obj.use_custom_tts = o.use_custom_tts;
-      obj.custom_tts_endpoint = o.custom_tts_endpoint;
-    }
-    else if ('wellsaid' === obj.vendor) {
-      const o = JSON.parse(decrypt(credential));
-      obj.api_key = o.api_key;
-    }
-  } catch (err) {
+  if ('google' === obj.vendor) {
+    obj.service_key = decrypt(credential);
+  }
+  else if ('aws' === obj.vendor) {
+    const o = JSON.parse(decrypt(credential));
+    obj.access_key_id = o.access_key_id;
+    obj.secret_access_key = o.secret_access_key;
+    obj.aws_region = o.aws_region;
+  }
+  else if ('microsoft' === obj.vendor) {
+    const o = JSON.parse(decrypt(credential));
+    obj.api_key = o.api_key;
+    obj.region = o.region;
+    obj.use_custom_stt = o.use_custom_stt;
+    obj.custom_stt_endpoint = o.custom_stt_endpoint;
+  }
+  else if ('wellsaid' === obj.vendor) {
+    const o = JSON.parse(decrypt(credential));
+    obj.api_key = o.api_key;
   }
   return obj;
 };

lib/utils/http-listener.js

@@ -1,45 +0,0 @@
-
-const express = require('express');
-const httpRoutes = require('../http-routes');
-const PORT = process.env.HTTP_PORT || 3000;
-
-const doListen = (logger, app, port, resolve) => {
-  const server = app.listen(port, () => {
-    const {srf} = app.locals;
-    logger.info(`listening for HTTP requests on port ${PORT}, serviceUrl is ${srf.locals.serviceUrl}`);
-    resolve({server, app});
-  });
-  return server;
-};
-const handleErrors = (logger, app, resolve, reject, e) => {
-  if (e.code === 'EADDRINUSE' &&
-    process.env.HTTP_PORT_MAX &&
-    e.port < process.env.HTTP_PORT_MAX) {
-
-    logger.info(`HTTP server failed to bind port on ${e.port}, will try next port`);
-    const server = doListen(logger, app, ++e.port, resolve);
-    server.on('error', handleErrors.bind(null, logger, app, resolve, reject));
-    return;
-  }
-  logger.info({err: e, port: PORT}, 'httpListener error');
-  reject(e);
-};
-
-const createHttpListener = (logger, srf) => {
-  const app = express();
-  app.locals = {...app.locals, logger, srf};
-  app.use(express.urlencoded({ extended: true }));
-  app.use(express.json());
-  app.use('/', httpRoutes);
-  app.use((err, _req, res, _next) => {
-    logger.error(err, 'burped error');
-    res.status(err.status || 500).json({msg: err.message});
-  });
-  return new Promise((resolve, reject) => {
-    const server = doListen(logger, app, PORT, resolve);
-    server.on('error', handleErrors.bind(null, logger, app, resolve, reject));
-  });
-};
-
-
-module.exports = createHttpListener;

lib/utils/place-outdial.js

@@ -21,7 +21,6 @@ class SingleDialer extends Emitter {
 
     this.logger = logger;
     this.target = target;
-    this.from = target.from || {};
     this.sbcAddress = sbcAddress;
     this.opts = opts;
     this.application = application;
@@ -67,8 +66,6 @@ class SingleDialer extends Emitter {
     opts.headers = {
       ...opts.headers,
       ...(this.target.headers || {}),
-      ...(this.from.user && {'X-Preferred-From-User': this.from.user}),
-      ...(this.from.host && {'X-Preferred-From-Host': this.from.host}),
       'X-Jambonz-Routing': this.target.type,
       'X-Call-Sid': this.callSid,
       ...(this.applicationSid && {'X-Application-Sid': this.applicationSid})

lib/utils/ws-requestor.js

@@ -69,7 +69,7 @@ class WsRequestor extends BaseRequestor {
       this.connectInProgress = true;
       this.logger.debug(`WsRequestor:request(${this.id}) - connecting since we do not have a connection`);
       if (this.connections >= MAX_RECONNECTS) {
-        return Promise.reject(`max attempts connecting to ${this.url}`);
+        throw new Error(`max attempts connecting to ${this.url}`);
       }
       try {
         const startAt = process.hrtime();
@@ -79,7 +79,7 @@ class WsRequestor extends BaseRequestor {
       } catch (err) {
         this.logger.info({url, err}, 'WsRequestor:request - failed connecting');
         this.connectInProgress = false;
-        return Promise.reject(err);
+        throw err;
       }
     }
     assert(this.ws);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "v0.7.7",
+  "version": "v0.7.6",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"
@@ -24,11 +24,11 @@
     "jslint": "eslint app.js lib"
   },
   "dependencies": {
+    "@jambonz/db-helpers": "^0.6.18",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/db-helpers": "^0.7.3",
-    "@jambonz/realtimedb-helpers": "^0.5.9",
+    "@jambonz/realtimedb-helpers": "^0.4.32",
     "@jambonz/stats-collector": "^0.1.6",
-    "@jambonz/time-series": "^0.2.5",
+    "@jambonz/time-series": "^0.2.1",
     "@opentelemetry/api": "^1.1.0",
     "@opentelemetry/exporter-jaeger": "^1.3.1",
     "@opentelemetry/exporter-trace-otlp-http": "^0.27.0",