further fixes for #210

* support google hints as an array of objects containing both hint phrase and boost value

* handle structured hints for non-google STT (#205)

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

@@ -3,7 +3,7 @@ const makeTask = require('../../tasks/make_task');
 const RestCallSession = require('../../session/rest-call-session');
 const CallInfo = require('../../session/call-info');
 const {CallDirection, CallStatus} = require('../../utils/constants');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const SipError = require('drachtio-srf').SipError;
 const sysError = require('./error');
 const HttpRequestor = require('../../utils/http-requestor');
@@ -136,7 +136,7 @@ router.post('/', async(req, res) => {
     }
     else if (!app.notifier) {
       logger.debug('creating null call status hook');
-      app.notifier = {request: () => {}};
+      app.notifier = {request: () => {}, close: () => {}};
     }
 
     /* now launch the outdial */

lib/middleware.js

@@ -1,4 +1,4 @@
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const {CallDirection, AllowedSipRecVerbs} = require('./utils/constants');
 const {parseSiprecPayload} = require('./utils/siprec-utils');
 const CallInfo = require('./session/call-info');
@@ -225,29 +225,30 @@ module.exports = function(srf, logger) {
       * create a requestor that we will use for all http requests we make during the call.
       * also create a notifier for call status events (if not needed, its a no-op).
       */
+
+      /* 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;
       if ('WS' === app.call_hook?.method ||
         app.call_hook?.url.startsWith('ws://') || app.call_hook?.url.startsWith('wss://')) {
-        app.requestor = new WsRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret) ;
-        app.notifier = app.requestor;
-        app.call_hook.method = 'WS';
+        app2.requestor = new WsRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret) ;
+        app2.notifier = app.requestor;
+        app2.call_hook.method = 'WS';
       }
       else {
-        app.requestor = new HttpRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret);
-        if (app.call_status_hook) app.notifier = new HttpRequestor(logger, account_sid, app.call_status_hook,
+        app2.requestor = new HttpRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret);
+        if (app.call_status_hook) app2.notifier = new HttpRequestor(logger, account_sid, app.call_status_hook,
           accountInfo.account.webhook_secret);
-        else app.notifier = {request: () => {}};
+        else app2.notifier = {request: () => {}};
       }
 
-      req.locals.application = app;
-      const obj = Object.assign({}, app);
-      delete obj.requestor;
-      delete obj.notifier;
+      req.locals.application = app2;
+
       // eslint-disable-next-line no-unused-vars
-      const {call_hook, call_status_hook, ...appInfo} = obj;  // mask sensitive data like user/pass on webhook
+      const {call_hook, call_status_hook, ...appInfo} = app;  // mask sensitive data like user/pass on webhook
       logger.info({app: appInfo}, `retrieved application for incoming call to ${req.locals.calledNumber}`);
       req.locals.callInfo = new CallInfo({
         req,
-        app,
+        app: app2,
         direction: CallDirection.Inbound,
         traceId: rootSpan.traceId
       });

lib/session/call-info.js

@@ -1,6 +1,6 @@
 const {CallDirection, CallStatus} = require('../utils/constants');
 const parseUri = require('drachtio-srf').parseUri;
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 /**
  * @classdesc Represents the common information for all calls
  * that is provided in call status webhooks

lib/session/call-session.js

@@ -82,12 +82,18 @@ class CallSession extends Emitter {
 
     this._pool = srf.locals.dbHelpers.pool;
 
+    const handover = (newRequestor) => {
+      this.logger.info(`handover to new base url ${newRequestor.url}`);
+      this.requestor.removeAllListeners();
+      this.application.requestor = newRequestor;
+      this.requestor.on('command', this._onCommand.bind(this));
+      this.requestor.on('connection-dropped', this._onWsConnectionDropped.bind(this));
+      this.requestor.on('handover', handover.bind(this));
+    };
+
     this.requestor.on('command', this._onCommand.bind(this));
     this.requestor.on('connection-dropped', this._onWsConnectionDropped.bind(this));
-    this.requestor.on('handover', (newRequestor) => {
-      this.logger.info(`handover to new base url ${newRequestor.url}`);
-      this.application.requestor = newRequestor;
-    });
+    this.requestor.on('handover', handover.bind(this));
   }
 
   /**
@@ -453,6 +459,10 @@ class CallSession extends Emitter {
 
   async enableBotMode(gather, autoEnable) {
     try {
+      if (this.backgroundGatherTask) {
+        this.logger.info('CallSession:enableBotMode - bot mode currently enabled, ignoring request to start again');
+        return;
+      }
       const t = normalizeJambones(this.logger, [gather]);
       this.backgroundGatherTask = makeTask(this.logger, t[0]);
       this._bargeInEnabled = true;
@@ -1308,6 +1318,7 @@ class CallSession extends Emitter {
     }
     this.tmpFiles.clear();
     this.requestor && this.requestor.close();
+    this.notifier && this.notifier.close();
 
     this.rootSpan && this.rootSpan.end();
   }

lib/tasks/gather.js

@@ -182,6 +182,10 @@ class TaskGather extends Task {
         this.logger.debug('Gather:exec - calling _initSpeech');
         this._initSpeech(cs, ep)
           .then(() => {
+            if (this.killed) {
+              this.logger.info('Gather:exec - task was quickly killed so do not transcribe');
+              return;
+            }
             this._startTranscribing(ep);
             return updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid);
           })
@@ -232,7 +236,13 @@ class TaskGather extends Task {
           }
         });
       }
-      else startListening(cs, ep);
+      else {
+        if (this.killed) {
+          this.logger.info('Gather:exec - task was immediately killed so do not transcribe');
+          return;
+        }
+        startListening(cs, ep);
+      }
 
       if (this.input.includes('speech') && this.listenDuringPrompt) {
         await this._initSpeech(cs, ep);

lib/tasks/message.js

@@ -1,7 +1,7 @@
 const Task = require('./task');
 const {TaskName, TaskPreconditions} = require('../utils/constants');
 const bent = require('bent');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 
 class TaskMessage extends Task {
   constructor(logger, opts) {

lib/tasks/say.js

@@ -105,6 +105,7 @@ class TaskSay extends Task {
     this.loop = this.data.loop || 1;
     this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
     this.synthesizer = this.data.synthesizer || {};
+    this.disableTtsCache = this.data.disableTtsCache;
   }
 
   get name() { return TaskName.Say; }
@@ -185,7 +186,8 @@ class TaskSay extends Task {
             engine,
             model,
             salt,
-            credentials
+            credentials,
+            disableTtsCache : this.disableTtsCache
           });
           this.logger.debug(`file ${filePath}, served from cache ${servedFromCache}`);
           if (filePath) cs.trackTmpFile(filePath);

lib/tasks/specs.json

@@ -122,7 +122,8 @@
       "text": "string|array",
       "loop": "number|string",
       "synthesizer": "#synthesizer",
-      "earlyMedia": "boolean"
+      "earlyMedia": "boolean",
+      "disableTtsCache": "boolean"
     },
     "required": [
       "text"

lib/tasks/task.js

@@ -1,10 +1,11 @@
 const Emitter = require('events');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const debug = require('debug')('jambonz:feature-server');
 const assert = require('assert');
 const {TaskPreconditions} = require('../utils/constants');
 const normalizeJambones = require('../utils/normalize-jambones');
 const WsRequestor = require('../utils/ws-requestor');
+const {TaskName} = require('../utils/constants');
 const {trace} = require('@opentelemetry/api');
 const specs = new Map();
 const _specData = require('./specs');
@@ -157,13 +158,14 @@ class Task extends Emitter {
 
   async performAction(results, expectResponse = true) {
     if (this.actionHook) {
+      const type = this.name === TaskName.Redirect ? 'session:redirect' : 'verb:hook';
       const params = results ? Object.assign(this.cs.callInfo.toJSON(), results) : this.cs.callInfo.toJSON();
-      const span = this.startSpan('verb:hook', {'hook.url': this.actionHook});
+      const span = this.startSpan(type, {'hook.url': this.actionHook});
       const b3 = this.getTracingPropagation('b3', span);
       const httpHeaders = b3 && {b3};
       span.setAttributes({'http.body': JSON.stringify(params)});
       try {
-        const json = await this.cs.requestor.request('verb:hook', this.actionHook, params, httpHeaders);
+        const json = await this.cs.requestor.request(type, this.actionHook, params, httpHeaders);
         span.setAttributes({'http.statusCode': 200});
         span.end();
         if (expectResponse && json && Array.isArray(json)) {

lib/utils/http-requestor.js

@@ -2,6 +2,7 @@ const {Client, Pool} = require('undici');
 const parseUrl = require('parse-url');
 const assert = require('assert');
 const BaseRequestor = require('./base-requestor');
+const WsRequestor = require('./ws-requestor');
 const {HookMsgTypes} = require('./constants.json');
 const snakeCaseKeys = require('./snakecase-keys');
 const pools = new Map();
@@ -31,6 +32,8 @@ class HttpRequestor extends BaseRequestor {
     if (u.port) this._baseUrl = `${u.protocol}://${u.resource}:${u.port}`;
     else this._baseUrl = `${u.protocol}://${u.resource}`;
     this._protocol = u.protocol;
+    this._resource = u.resource;
+    this._port = u.port;
     this._search = u.search;
     this._usePools = process.env.HTTP_POOL && parseInt(process.env.HTTP_POOL);
 
@@ -89,6 +92,18 @@ class HttpRequestor extends BaseRequestor {
     assert.ok, (['GET', 'POST'].includes(method), `HttpRequestor:request method must be 'GET' or 'POST' not ${method}`);
     const startAt = process.hrtime();
 
+    /* if we have an absolute url, and it is ws then do a websocket connection */
+    if (this._isAbsoluteUrl(url) && url.startsWith('ws')) {
+      this.logger.debug({hook}, 'HttpRequestor: switching to websocket connection');
+      const h = typeof hook === 'object' ? hook : {url: hook};
+      const requestor = new WsRequestor(this.logger, this.account_sid, h, this.secret);
+      if (type === 'session:redirect') {
+        this.close();
+        this.emit('handover', requestor);
+      }
+      return requestor.request('session:new', hook, params, httpHeaders);
+    }
+
     let newClient;
     try {
       let client, path, query;
@@ -98,7 +113,7 @@ class HttpRequestor extends BaseRequestor {
       }
       else {
         const u = parseUrl(url);
-        if (u.resource === this._resource && u.protocol === this._protocol) {
+        if (u.resource === this._resource && u.port === this._port && u.protocol === this._protocol) {
           client = this.client;
           path = u.pathname;
           query = u.query;

lib/utils/place-outdial.js

@@ -12,7 +12,7 @@ const deepcopy = require('deepcopy');
 const moment = require('moment');
 const stripCodecs = require('./strip-ancillary-codecs');
 const RootSpan = require('./call-tracer');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 
 class SingleDialer extends Emitter {
   constructor({logger, sbcAddress, target, opts, application, callInfo, accountInfo, rootSpan, startSpan}) {
@@ -412,7 +412,7 @@ class SingleDialer extends Emitter {
       this.callInfo.updateCallStatus(callStatus, sipStatus, sipReason);
       if (typeof duration === 'number') this.callInfo.duration = duration;
       try {
-        this.requestor.request('call:status', this.application.call_status_hook, this.callInfo.toJSON());
+        this.notifier.request('call:status', this.application.call_status_hook, this.callInfo.toJSON());
       } catch (err) {
         this.logger.info(err, `SingleDialer:_notifyCallStatusChange error sending ${callStatus} ${sipStatus}`);
       }

lib/utils/sbc-pinger.js

@@ -1,5 +1,5 @@
 const assert = require('assert');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./constants');
 const Emitter = require('events');
 const debug = require('debug')('jambonz:feature-server');

lib/utils/siprec-utils.js

@@ -1,5 +1,5 @@
 const xmlParser = require('xml2js').parseString;
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const parseUri = require('drachtio-srf').parseUri;
 const transform = require('sdp-transform');
 const debug = require('debug')('jambonz:feature-server');

lib/utils/transcription-utils.js

@@ -188,8 +188,10 @@ module.exports = (logger) => {
           {GOOGLE_SPEECH_SINGLE_UTTERANCE: 0}),
         ...(rOpts.diarization === false &&
           {GOOGLE_SPEECH_SPEAKER_DIARIZATION: 0}),
-        ...(rOpts.hints.length > 0 &&
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
           {GOOGLE_SPEECH_HINTS: rOpts.hints.join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {GOOGLE_SPEECH_HINTS: JSON.stringify(rOpts.hints)}),
         ...(typeof rOpts.hintsBoost === 'number' &&
           {GOOGLE_SPEECH_HINTS_BOOST: rOpts.hintsBoost}),
         ...(rOpts.altLanguages.length > 0 &&
@@ -217,8 +219,10 @@ module.exports = (logger) => {
     else if ('microsoft' === rOpts.vendor) {
       opts = {
         ...opts,
-        ...(rOpts.hints  && rOpts.hints.length > 0 &&
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
           {AZURE_SPEECH_HINTS: rOpts.hints.map((h) => h.trim()).join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {AZURE_SPEECH_HINTS: rOpts.hints.map((h) => h.phrase).join(',')}),
         ...(rOpts.altLanguages && rOpts.altLanguages.length > 0 &&
           {AZURE_SERVICE_ENDPOINT_ID: rOpts.sttCredentials}),
         ...(rOpts.requestSnr && {AZURE_REQUEST_SNR: 1}),
@@ -318,8 +322,10 @@ module.exports = (logger) => {
           {DEEPGRAM_SPEECH_SEARCH: deepgramOptions.search.join(',')},
         ...(deepgramOptions.replace) &&
           {DEEPGRAM_SPEECH_REPLACE: deepgramOptions.replace.join(',')},
-        ...(rOpts.hints.length > 0 &&
-          {DEEPGRAM_SPEECH_KEYWORDS: rOpts.hints.join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
+          {DEEPGRAM_SPEECH_KEYWORDS: rOpts.hints.map((h) => h.trim()).join(',')}),
+        ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
+          {DEEPGRAM_SPEECH_KEYWORDS: rOpts.hints.map((h) => h.phrase).join(',')}),
         ...(deepgramOptions.keywords) &&
           {DEEPGRAM_SPEECH_KEYWORDS: deepgramOptions.keywords.join(',')},
         ...('endpointing' in deepgramOptions) &&

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "v0.7.7",
+  "version": "v0.7.8",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"
@@ -26,7 +26,7 @@
   "dependencies": {
     "@jambonz/db-helpers": "^0.7.3",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/realtimedb-helpers": "^0.6.2",
+    "@jambonz/realtimedb-helpers": "^0.6.3",
     "@jambonz/stats-collector": "^0.1.6",
     "@jambonz/time-series": "^0.2.5",
     "@opentelemetry/api": "^1.2.0",
@@ -42,10 +42,9 @@
     "bent": "^7.3.12",
     "debug": "^4.3.4",
     "deepcopy": "^2.1.0",
-    "drachtio-fsmrf": "^3.0.10",
-    "drachtio-srf": "^4.5.18",
+    "drachtio-fsmrf": "^3.0.16",
+    "drachtio-srf": "^4.5.21",
     "express": "^4.18.2",
-    "helmet": "^5.1.1",
     "ip": "^1.1.8",
     "moment": "^2.29.4",
     "parse-url": "^8.1.0",
@@ -54,7 +53,7 @@
     "short-uuid": "^4.2.0",
     "to-snake-case": "^1.0.0",
     "undici": "^5.11.0",
-    "uuid": "^8.3.2",
+    "uuid-random": "^1.3.2",
     "verify-aws-sns-signature": "^0.1.0",
     "ws": "^8.9.0",
     "xml2js": "^0.4.23"

tracer.js

@@ -22,7 +22,7 @@ module.exports = (serviceName) => {
     });
 
     let exporter;
-    if (process.env.OTEL_EXPORTER_JAEGER_AGENT_HOST) {
+    if (process.env.OTEL_EXPORTER_JAEGER_AGENT_HOST  || process.env.OTEL_EXPORTER_JAEGER_ENDPOINT) {
       exporter = new JaegerExporter();
     }
     else if (process.env.OTEL_EXPORTER_ZIPKIN_URL) {