fix: upgrade pino from 6.13.4 to 6.14.0

Snyk has created this PR to upgrade pino from 6.13.4 to 6.14.0.

See this package in npm:
https://www.npmjs.com/package/pino

See this project in Snyk:
https://app.snyk.io/org/davehorton/project/cec90d0e-0ded-433e-a42e-fe78b28ae489?utm_source=github&utm_medium=referral&page=upgrade-pr

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16
+FROM node:17.4-slim
 WORKDIR /opt/app/
 COPY package.json ./
 RUN npm install

app.js

@@ -7,7 +7,7 @@ assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACH
 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, 'missing JAMBONES_SUBNET env var');
+assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_SUBNET env var');
 
 const Srf = require('drachtio-srf');
 const srf = new Srf();
@@ -17,7 +17,7 @@ const opts = {
   level: process.env.JAMBONES_LOGLEVEL || 'info'
 };
 const logger = require('pino')(opts);
-const {LifeCycleEvents} = require('./lib/utils/constants');
+const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./lib/utils/constants');
 const installSrfLocals = require('./lib/utils/install-srf-locals');
 installSrfLocals(srf, logger);
 
@@ -31,6 +31,7 @@ const {
 
 // HTTP
 const express = require('express');
+const helmet = require('helmet');
 const app = express();
 Object.assign(app.locals, {
   logger,
@@ -73,6 +74,8 @@ srf.invite((req, res) => {
 });
 
 // HTTP
+app.use(helmet());
+app.use(helmet.hidePoweredBy());
 app.use(express.urlencoded({ extended: true }));
 app.use(express.json());
 app.use('/', httpRoutes);
@@ -92,6 +95,10 @@ sessionTracker.on('idle', () => {
   }
 });
 
+const getCount = () => sessionTracker.count;
+const healthCheck = require('@jambonz/http-health-check');
+healthCheck({app, logger, path: '/', fn: getCount});
+
 setInterval(() => {
   srf.locals.stats.gauge('fs.sip.calls.count', sessionTracker.count);
 }, 5000);
@@ -113,7 +120,21 @@ function handle(signal) {
   const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
   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);
   srf.locals.disabled = true;
 }
 
+if (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS) {
+  const {clearFiles} = require('./lib/utils/cron-jobs');
+
+  /* cleanup orphaned files or channels every so often */
+  setInterval(async() => {
+    try {
+      await clearFiles();
+    } catch (err) {
+      logger.error({err}, 'app.js: error clearing files');
+    }
+  }, 1000 * 60 * (process.env.JAMBONZ_CLEANUP_INTERVAL_MINS || 60));
+}
+
 module.exports = {srf, logger, disconnect};

bin/k8s-pre-stop-hook.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+const bent = require('bent');
+const getJSON = bent('json');
+const PORT = process.env.HTTP_PORT || 3000;
+
+const sleep = (ms) => {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+(async function() {
+
+  try {
+    do {
+      const obj = await getJSON(`http://127.0.0.1:${PORT}/`);
+      const {calls} = obj;
+      if (calls === 0) {
+        console.log('no calls on the system, we can exit');
+        process.exit(0);
+      }
+      else {
+        console.log(`waiting for ${calls} to exit..`);
+      }
+      await sleep(10000);
+    } while (1);
+  } catch (err) {
+    console.error(err, 'Error querying health endpoint');
+    process.exit(-1);
+  }
+})();

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

@@ -6,7 +6,8 @@ const {CallDirection, CallStatus} = require('../../utils/constants');
 const { v4: uuidv4 } = require('uuid');
 const SipError = require('drachtio-srf').SipError;
 const sysError = require('./error');
-const Requestor = require('../../utils/requestor');
+const HttpRequestor = require('../../utils/http-requestor');
+const WsRequestor = require('../../utils/ws-requestor');
 const dbUtils = require('../../utils/db-utils');
 
 router.post('/', async(req, res) => {
@@ -35,6 +36,8 @@ router.post('/', async(req, res) => {
 
     opts.headers = {
       ...opts.headers,
+      'X-Jambonz-Routing': target.type,
+      'X-Jambonz-FS-UUID': srf.locals.fsUUID,
       'X-Call-Sid': callSid,
       'X-Account-Sid': req.body.account_sid
     };
@@ -69,6 +72,17 @@ router.post('/', async(req, res) => {
         break;
     }
 
+    if (target.type === 'phone' && target.trunk) {
+      const {lookupCarrier} = dbUtils(this.logger, srf);
+      const voip_carrier_sid = await lookupCarrier(req.body.account_sid, target.trunk);
+      this.logger.info(
+        `createCall: selected ${voip_carrier_sid} for requested carrier: ${target.trunk || 'unspecified'})`);
+      if (voip_carrier_sid) {
+        opts.headers['X-Requested-Carrier-Sid'] = voip_carrier_sid;
+      }
+    }
+
+
     /* create endpoint for outdial */
     const ms = getFreeswitch();
     if (!ms) throw new Error('no available Freeswitch for outbound call creation');
@@ -102,11 +116,16 @@ router.post('/', async(req, res) => {
      * attach our requestor and notifier objects
      * these will be used for all http requests we make during this call
      */
-    app.requestor = new Requestor(logger, account.account_sid, app.call_hook, account.webhook_secret);
-    if (app.call_status_hook) {
-      app.notifier = new Requestor(logger, account.account_sid, app.call_status_hook, account.webhook_secret);
+    if ('WS' === app.call_hook?.method) {
+      app.requestor = new WsRequestor(logger, account.account_sid, app.call_hook, account.webhook_secret) ;
+      app.notifier = app.requestor;
+    }
+    else {
+      app.requestor = new HttpRequestor(logger, account.account_sid, app.call_hook, account.webhook_secret);
+      if (app.call_status_hook) app.notifier = new HttpRequestor(logger, account.account_sid, app.call_status_hook,
+        account.webhook_secret);
+      else app.notifier = {request: () => {}};
     }
-    else app.notifier = {request: () => {}};
 
     /* now launch the outdial */
     try {
@@ -120,6 +139,7 @@ router.post('/', async(req, res) => {
             res.status(500).send('Call Failure');
             return;
           }
+          inviteReq.srf = srf;
           /* ok our outbound INVITE is in flight */
 
           const tasks = [restDial];
@@ -151,7 +171,11 @@ router.post('/', async(req, res) => {
         }
       });
       connectStream(dlg.remote.sdp);
-      cs.emit('callStatusChange', {callStatus: CallStatus.InProgress, sipStatus: 200});
+      cs.emit('callStatusChange', {
+        callStatus: CallStatus.InProgress,
+        sipStatus: 200,
+        sipReason: 'OK'
+      });
       restDial.emit('callStatus', 200);
       restDial.emit('connect', dlg);
     }
@@ -162,10 +186,18 @@ router.post('/', async(req, res) => {
         else if (487 === err.status) callStatus = CallStatus.NoAnswer;
         if (sipLogger) sipLogger.info(`REST outdial failed with ${err.status}`);
         else console.log(`REST outdial failed with ${err.status}`);
-        if (cs) cs.emit('callStatusChange', {callStatus, sipStatus: err.status});
+        if (cs) cs.emit('callStatusChange', {
+          callStatus,
+          sipStatus: err.status,
+          sipReason: err.reason
+        });
       }
       else {
-        if (cs) cs.emit('callStatusChange', {callStatus, sipStatus: 500});
+        if (cs) cs.emit('callStatusChange', {
+          callStatus,
+          sipStatus: 500,
+          sipReason: 'Internal Server Error'
+        });
         if (sipLogger) sipLogger.error({err}, 'REST outdial failed');
         else console.error(err);
       }

lib/http-routes/api/index.js

@@ -9,8 +9,4 @@ api.use('/enqueue', require('./enqueue'));
 api.use('/messaging', require('./messaging'));            // inbound SMS
 api.use('/createMessage', require('./create-message'));   // outbound SMS (REST)
 
-// health checks
-api.get('/', (req, res) => res.sendStatus(200));
-api.get('/health', (req, res) => res.sendStatus(200));
-
 module.exports = api;

lib/http-routes/api/messaging.js

@@ -1,5 +1,6 @@
 const router = require('express').Router();
-const Requestor = require('../../utils/requestor');
+const HttpRequestor = require('../../utils/http-requestor');
+const WsRequestor = require('../../utils/ws-requestor');
 const CallInfo = require('../../session/call-info');
 const {CallDirection} = require('../../utils/constants');
 const SmsSession = require('../../session/sms-call-session');
@@ -18,7 +19,17 @@ router.post('/:partner', async(req, res) => {
   const app = req.body.app;
   const account = await lookupAccountBySid(app.accountSid);
   const hook = app.messaging_hook;
-  const requestor = new Requestor(logger, account.account_sid, hook, account.webhook_secret);
+  let requestor;
+
+  if ('WS' === hook?.method) {
+    app.requestor = new WsRequestor(logger, account.account_sid, hook, account.webhook_secret) ;
+    app.notifier = app.requestor;
+  }
+  else {
+    app.requestor = new HttpRequestor(logger, account.account_sid, hook, account.webhook_secret);
+    app.notifier = {request: () => {}};
+  }
+
   const payload = {
     carrier: req.params.partner,
     messageSid: app.messageSid,
@@ -33,7 +44,7 @@ router.post('/:partner', async(req, res) => {
   res.status(200).json({sid: req.body.messageSid});
 
   try {
-    tasks = await requestor.request(hook, payload);
+    tasks = await requestor.request('session:new', hook, payload);
     logger.info({tasks}, 'response from incoming SMS webhook');
   } catch (err) {
     logger.error({err, hook}, 'Error sending incoming SMS message');

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

@@ -12,6 +12,9 @@ function retrieveCallSession(callSid, opts) {
     throw new DbErrorBadRequest('call_status_hook can be updated only when call_hook is also being updated');
   }
   const cs = sessionTracker.get(callSid);
+  if (!cs) {
+    throw new DbErrorUnprocessableRequest('call session is gone');
+  }
 
   if (opts.call_status === CallStatus.Completed && !cs.hasStableDialog) {
     throw new DbErrorUnprocessableRequest('current call state is incompatible with requested action');
@@ -45,8 +48,18 @@ router.post('/:callSid', async(req, res) => {
       logger.info(`updateCall: callSid not found ${callSid}`);
       return res.sendStatus(404);
     }
-    res.sendStatus(202);
-    cs.updateCall(req.body, callSid);
+
+    if (req.body.sip_request) {
+      const response = await cs.updateCall(req.body, callSid);
+      res.status(200).json({
+        status: response.status,
+        reason: response.reason
+      });
+    }
+    else {
+      res.sendStatus(202);
+      cs.updateCall(req.body, callSid);
+    }
   } catch (err) {
     sysError(logger, res, err);
   }

lib/http-routes/index.js

@@ -1,16 +1,23 @@
 const express = require('express');
 const api = require('./api');
 const routes = express.Router();
+const sessionTracker = require('../session/session-tracker');
+
+const readiness = (req, res) => {
+  const logger = req.app.locals.logger;
+  const {count} = sessionTracker;
+  const {srf} = require('../..');
+  const {getFreeswitch} = srf.locals;
+  if (getFreeswitch()) {
+    return res.status(200).json({calls: count});
+  }
+  logger.info('responding to /health check with failure as freeswitch is not up');
+  res.sendStatus(480);
+};
 
 routes.use('/v1', api);
 
-// health checks
-routes.get('/', (req, res) => {
-  res.sendStatus(200);
-});
-
-routes.get('/health', (req, res) => {
-  res.sendStatus(200);
-});
+// health check
+routes.get('/health', readiness);
 
 module.exports = routes;

lib/middleware.js

@@ -1,7 +1,8 @@
 const { v4: uuidv4 } = require('uuid');
 const {CallDirection} = require('./utils/constants');
 const CallInfo = require('./session/call-info');
-const Requestor = require('./utils/requestor');
+const HttpRequestor = require('./utils/http-requestor');
+const WsRequestor = require('./utils/ws-requestor');
 const makeTask = require('./tasks/make_task');
 const parseUri = require('drachtio-srf').parseUri;
 const normalizeJambones = require('./utils/normalize-jambones');
@@ -105,7 +106,7 @@ module.exports = function(srf, logger) {
       }
       else {
         const uri = parseUri(req.uri);
-        const arr = /context-(.*)/.exec(uri.user);
+        const arr = /context-(.*)/.exec(uri?.user);
         if (arr) {
           // this is a transfer from another feature server
           const {retrieveKey, deleteKey} = srf.locals.dbHelpers;
@@ -142,10 +143,18 @@ 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).
       */
-      app.requestor = new Requestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret);
-      if (app.call_status_hook) app.notifier = new Requestor(logger, account_sid, app.call_status_hook,
-        accountInfo.account.webhook_secret);
-      else app.notifier = {request: () => {}};
+      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';
+      }
+      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,
+          accountInfo.account.webhook_secret);
+        else app.notifier = {request: () => {}};
+      }
 
       req.locals.application = app;
       const obj = Object.assign({}, app);
@@ -176,15 +185,16 @@ module.exports = function(srf, logger) {
         return next();
       }
       /* retrieve the application to execute for this inbound call */
-      const params = Object.assign(app.call_hook.method === 'POST' ? {sip: req.msg} : {},
+      const params = Object.assign(['POST', 'WS'].includes(app.call_hook.method) ? {sip: req.msg} : {},
         req.locals.callInfo);
-      const json = await app.requestor.request(app.call_hook, params);
+      const json = await app.requestor.request('session:new', app.call_hook, params);
       app.tasks = normalizeJambones(logger, json).map((tdata) => makeTask(logger, tdata));
       if (0 === app.tasks.length) throw new Error('no application provided');
       next();
     } catch (err) {
-      logger.info({err}, `Error retrieving or parsing application: ${err.message}`);
-      res.send(480, {headers: {'X-Reason': err.message}});
+      logger.info({err}, `Error retrieving or parsing application: ${err?.message}`);
+      res.send(480, {headers: {'X-Reason': err?.message || 'unknown'}});
+      app.requestor.close();
     }
   }
 

lib/session/adulting-call-session.js

@@ -30,15 +30,25 @@ class AdultingCallSession extends CallSession {
     return this.sd.dlg;
   }
 
+  /**
+   * Note: this is not an error.  It is only here to avoid an assert ("no setter for dlg")
+   * when there is a call in Session:_clearResources to null out dlg and ep
+   */
+  set dlg(newDlg) {}
+
   get ep() {
     return this.sd.ep;
   }
 
+  /* see note above */
+  set ep(newEp) {}
+
   get callSid() {
     return this.callInfo.callSid;
   }
 
-
+  _callerHungup() {
+  }
 }
 
 module.exports = AdultingCallSession;

lib/session/call-info.js

@@ -1,7 +1,6 @@
 const {CallDirection, CallStatus} = require('../utils/constants');
 const parseUri = require('drachtio-srf').parseUri;
 const { v4: uuidv4 } = require('uuid');
-
 /**
  * @classdesc Represents the common information for all calls
  * that is provided in call status webhooks
@@ -9,6 +8,7 @@ const { v4: uuidv4 } = require('uuid');
 class CallInfo {
   constructor(opts) {
     let from ;
+    let srf;
     this.direction = opts.direction;
     if (opts.req) {
       const u = opts.req.getParsedHeader('from');
@@ -19,6 +19,7 @@ class CallInfo {
     if (this.direction === CallDirection.Inbound) {
       // inbound call
       const {app, req} = opts;
+      srf = req.srf;
       this.callSid = req.locals.callSid,
       this.accountSid = app.account_sid,
       this.applicationSid = app.application_sid;
@@ -26,6 +27,7 @@ class CallInfo {
       this.to = req.calledNumber;
       this.callId = req.get('Call-ID');
       this.sipStatus = 100;
+      this.sipReason = 'Trying';
       this.callStatus = CallStatus.Trying;
       this.originatingSipIp = req.get('X-Forwarded-For');
       this.originatingSipTrunkName = req.get('X-Originating-Carrier');
@@ -33,6 +35,7 @@ class CallInfo {
     else if (opts.parentCallInfo) {
       // outbound call that is a child of an existing call
       const {req, parentCallInfo, to, callSid} = opts;
+      srf = req.srf;
       this.callSid = callSid || uuidv4();
       this.parentCallSid = parentCallInfo.callSid;
       this.accountSid = parentCallInfo.accountSid;
@@ -43,10 +46,12 @@ class CallInfo {
       this.callId = req.get('Call-ID');
       this.callStatus = CallStatus.Trying,
       this.sipStatus = 100;
+      this.sipReason = 'Trying';
     }
     else if (this.direction === CallDirection.None) {
       // outbound SMS
       const {messageSid, accountSid, applicationSid, res} = opts;
+      srf = res.srf;
       this.messageSid = messageSid;
       this.accountSid = accountSid;
       this.applicationSid = applicationSid;
@@ -55,16 +60,23 @@ class CallInfo {
     else {
       // outbound call triggered by REST
       const {req, callSid, accountSid, applicationSid, to, tag} = opts;
+      srf = req.srf;
       this.callSid = callSid;
       this.accountSid = accountSid;
       this.applicationSid = applicationSid;
       this.callStatus = CallStatus.Trying,
       this.callId = req.get('Call-ID');
       this.sipStatus = 100;
+      this.sipReason = 'Trying';
       this.from = from || req.callingNumber;
       this.to = to;
       if (tag) this._customerData = tag;
     }
+
+    this.localSipAddress = srf.locals.localSipAddress;
+    if (srf.locals.publicIp) {
+      this.publicIp = srf.locals.publicIp;
+    }
   }
 
   /**
@@ -72,9 +84,10 @@ class CallInfo {
    * @param {string} callStatus - current call status
    * @param {number} sipStatus - current sip status
    */
-  updateCallStatus(callStatus, sipStatus) {
+  updateCallStatus(callStatus, sipStatus, sipReason) {
     this.callStatus = callStatus;
     if (sipStatus) this.sipStatus = sipStatus;
+    if (sipReason) this.sipReason = sipReason;
   }
 
   /**
@@ -97,10 +110,12 @@ class CallInfo {
       to: this.to,
       callId: this.callId,
       sipStatus: this.sipStatus,
+      sipReason: this.sipReason,
       callStatus: this.callStatus,
       callerId: this.callerId,
       accountSid: this.accountSid,
-      applicationSid: this.applicationSid
+      applicationSid: this.applicationSid,
+      fsSipAddress: this.localSipAddress
     };
     ['parentCallSid', 'originatingSipIp', 'originatingSipTrunkName'].forEach((prop) => {
       if (this[prop]) obj[prop] = this[prop];
@@ -110,6 +125,13 @@ class CallInfo {
     if (this._customerData) {
       Object.assign(obj, {customerData: this._customerData});
     }
+
+    if (process.env.JAMBONES_API_BASE_URL) {
+      Object.assign(obj, {apiBaseUrl: process.env.JAMBONES_API_BASE_URL});
+    }
+    if (this.publicIp) {
+      Object.assign(obj, {fsPublicIp: this.publicIp});
+    }
     return obj;
   }
 

lib/session/call-session.js

@@ -7,7 +7,8 @@ const sessionTracker = require('./session-tracker');
 const makeTask = require('../tasks/make_task');
 const normalizeJambones = require('../utils/normalize-jambones');
 const listTaskNames = require('../utils/summarize-tasks');
-const Requestor = require('../utils/requestor');
+const HttpRequestor = require('../utils/http-requestor');
+const WsRequestor = require('../utils/ws-requestor');
 const BADPRECONDITIONS = 'preconditions not met';
 const CALLER_CANCELLED_ERR_MSG = 'Response not sent due to unknown transaction';
 
@@ -48,6 +49,7 @@ class CallSession extends Emitter {
     this.taskIdx = 0;
     this.stackIdx = 0;
     this.callGone = false;
+    this.notifiedComplete = false;
 
     this.tmpFiles = new Set();
 
@@ -61,6 +63,8 @@ class CallSession extends Emitter {
     }
 
     this._pool = srf.locals.dbHelpers.pool;
+
+    this.requestor.on('command', this._onCommand.bind(this));
   }
 
   /**
@@ -113,18 +117,27 @@ class CallSession extends Emitter {
   get speechSynthesisVendor() {
     return this.application.speech_synthesis_vendor;
   }
+  set speechSynthesisVendor(vendor) {
+    this.application.speech_synthesis_vendor = vendor;
+  }
   /**
    * default voice to use for speech synthesis if not provided in the app
    */
   get speechSynthesisVoice() {
     return this.application.speech_synthesis_voice;
   }
+  set speechSynthesisVoice(voice) {
+    this.application.speech_synthesis_voice = voice;
+  }
   /**
    * default language to use for speech synthesis if not provided in the app
    */
   get speechSynthesisLanguage() {
     return this.application.speech_synthesis_language;
   }
+  set speechSynthesisLanguage(language) {
+    this.application.speech_synthesis_language = language;
+  }
 
   /**
    * default vendor to use for speech recognition if not provided in the app
@@ -132,12 +145,18 @@ class CallSession extends Emitter {
   get speechRecognizerVendor() {
     return this.application.speech_recognizer_vendor;
   }
+  set speechRecognizerVendor(vendor) {
+    this.application.speech_recognizer_vendor = vendor;
+  }
   /**
  * default language to use for speech recognition if not provided in the app
  */
   get speechRecognizerLanguage() {
     return this.application.speech_recognizer_language;
   }
+  set speechRecognizerLanguage(language) {
+    this.application.speech_recognizer_language = language;
+  }
 
   /**
    * indicates whether the call currently in progress
@@ -203,6 +222,46 @@ class CallSession extends Emitter {
     return this.memberId && this.confName && this.confUuid;
   }
 
+  get isBotModeEnabled() {
+    return this.backgroundGatherTask;
+  }
+
+  async enableBotMode(gather) {
+    try {
+      const t = normalizeJambones(this.logger, [gather]);
+      this.backgroundGatherTask = makeTask(this.logger, t[0]);
+      this.backgroundGatherTask
+        .on('dtmf', this._clearTasks.bind(this))
+        .on('transcription', this._clearTasks.bind(this))
+        .on('timeout', this._clearTasks.bind(this));
+      this.logger.info({gather}, 'CallSession:enableBotMode - starting background gather');
+      const resources = await this._evaluatePreconditions(this.backgroundGatherTask);
+      this.backgroundGatherTask.exec(this, resources)
+        .then(() => {
+          this.logger.info('CallSession:enableBotMode: gather completed');
+          this.backgroundGatherTask && this.backgroundGatherTask.removeAllListeners();
+          this.backgroundGatherTask = null;
+          return;
+        })
+        .catch((err) => {
+          this.logger.info({err}, 'CallSession:enableBotMode: gather threw error');
+          this.backgroundGatherTask && this.backgroundGatherTask.removeAllListeners();
+          this.backgroundGatherTask = null;
+        });
+    } catch (err) {
+      this.logger.info({err, gather}, 'CallSession:enableBotMode - Error creating gather task');
+    }
+  }
+  disableBotMode() {
+    if (this.backgroundGatherTask) {
+      try {
+        this.backgroundGatherTask.removeAllListeners();
+        this.backgroundGatherTask.kill();
+      } catch (err) {}
+      this.backgroundGatherTask = null;
+    }
+  }
+
   setConferenceDetails(memberId, confName, confUuid) {
     assert(!this.memberId && !this.confName && !this.confUuid);
     assert (memberId && confName && confUuid);
@@ -264,6 +323,12 @@ class CallSession extends Emitter {
             region: credential.region
           };
         }
+        else if ('wellsaid' === vendor) {
+          return {
+            speech_credential_sid: credential.speech_credential_sid,
+            api_key: credential.api_key
+          };
+        }
       }
       else {
         writeAlerts({
@@ -282,6 +347,7 @@ class CallSession extends Emitter {
    */
   async exec() {
     this.logger.info({tasks: listTaskNames(this.tasks)}, `CallSession:exec starting ${this.tasks.length} tasks`);
+
     while (this.tasks.length && !this.callGone) {
       const taskNum = ++this.taskIdx;
       const stackNum = this.stackIdx;
@@ -290,12 +356,19 @@ class CallSession extends Emitter {
       try {
         const resources = await this._evaluatePreconditions(task);
         this.currentTask = task;
-        await task.exec(this, resources);
+        if (TaskName.Gather === task.name && this.isBotModeEnabled) {
+          const timeout = task.timeout;
+          this.logger.info(`CallSession:exec skipping #${stackNum}:${taskNum}: ${task.name}`);
+          this.backgroundGatherTask.updateTimeout(timeout);
+        }
+        else {
+          await task.exec(this, resources);
+        }
         this.currentTask = null;
         this.logger.info(`CallSession:exec completed task #${stackNum}:${taskNum}: ${task.name}`);
       } catch (err) {
         this.currentTask = null;
-        if (err.message.includes(BADPRECONDITIONS)) {
+        if (err.message?.includes(BADPRECONDITIONS)) {
           this.logger.info(`CallSession:exec task #${stackNum}:${taskNum}: ${task.name}: ${err.message}`);
         }
         else {
@@ -303,6 +376,16 @@ class CallSession extends Emitter {
           break;
         }
       }
+
+      if (0 === this.tasks.length && this.hasStableDialog && this.requestor instanceof WsRequestor) {
+        try {
+          await this._awaitCommandsOrHangup();
+          if (!this.hasStableDialog || this.callGone) break;
+        } catch (err) {
+          this.logger.info(err, 'CallSession:exec - error waiting for new commands');
+          break;
+        }
+      }
     }
 
     // all done - cleanup
@@ -361,6 +444,11 @@ class CallSession extends Emitter {
       this.currentTask.kill(this);
       this.currentTask = null;
     }
+    if (this.wakeupResolver) {
+      this.wakeupResolver();
+      this.wakeupResolver = null;
+    }
+    this.requestor && this.requestor.close();
   }
 
   /**
@@ -397,29 +485,42 @@ class CallSession extends Emitter {
    */
   async _lccCallHook(opts) {
     const webhooks = [];
-    let sd;
-    if (opts.call_hook) webhooks.push(this.requestor.request(opts.call_hook, this.callInfo.toJSON()));
-    if (opts.child_call_hook) {
-      /* child call hook only allowed from a connected Dial state */
-      const task = this.currentTask;
-      sd = task.sd;
-      if (task && TaskName.Dial === task.name && sd) {
-        webhooks.push(this.requestor.request(opts.child_call_hook, sd.callInfo.toJSON()));
+    let sd, tasks, childTasks;
+
+    if (opts.call_hook || opts.child_call_hook) {
+      if (opts.call_hook) {
+        webhooks.push(this.requestor.request('session:redirect', opts.call_hook, this.callInfo.toJSON()));
       }
+      if (opts.child_call_hook) {
+        /* child call hook only allowed from a connected Dial state */
+        const task = this.currentTask;
+        sd = task.sd;
+        if (task && TaskName.Dial === task.name && sd) {
+          webhooks.push(this.requestor.request('session:redirect', opts.child_call_hook, sd.callInfo.toJSON()));
+        }
+      }
+      const [tasks1, tasks2] = await Promise.all(webhooks);
+      if (opts.call_hook) {
+        tasks = tasks1;
+        if (opts.child_call_hook) childTasks = tasks2;
+      }
+      else childTasks = tasks1;
     }
-    const [tasks1, tasks2] = await Promise.all(webhooks);
-    let tasks, childTasks;
-    if (opts.call_hook) {
-      tasks = tasks1;
-      if (opts.child_call_hook) childTasks = tasks2;
+    else if (opts.parent_call || opts.child_call) {
+      const {parent_call, child_call} = opts;
+      assert.ok(!parent_call || Array.isArray(parent_call), 'CallSession:_lccCallHook - parent_call must be an array');
+      assert.ok(!child_call || Array.isArray(child_call), 'CallSession:_lccCallHook - child_call must be an array');
+      tasks = parent_call;
+      childTasks = child_call;
     }
-    else childTasks = tasks1;
 
     if (childTasks) {
       const {parentLogger} = this.srf.locals;
       const childLogger = parentLogger.child({callId: this.callId, callSid: sd.callSid});
       const t = normalizeJambones(childLogger, childTasks).map((tdata) => makeTask(childLogger, tdata));
       childLogger.info({tasks: listTaskNames(t)}, 'CallSession:_lccCallHook new task list for child call');
+
+      // TODO: if using websockets api, we need a new websocket for the adulting session..
       const cs = await sd.doAdulting({
         logger: childLogger,
         application: this.application,
@@ -467,7 +568,7 @@ class CallSession extends Emitter {
     task.mute(callSid, mute).catch((err) => this.logger.error(err, 'CallSession:_lccMuteStatus'));
   }
 
-  async _lccConfHoldStatus(callSid, opts) {
+  async _lccConfHoldStatus(opts) {
     const task = this.currentTask;
     if (!task || TaskName.Conference !== task.name || !this.isInConference) {
       return this.logger.info('CallSession:_lccConfHoldStatus - invalid command as call is not in conference');
@@ -475,7 +576,7 @@ class CallSession extends Emitter {
     task.doConferenceHold(this, opts);
   }
 
-  async _lccConfMuteStatus(callSid, opts) {
+  async _lccConfMuteStatus(opts) {
     const task = this.currentTask;
     if (!task || TaskName.Conference !== task.name || !this.isInConference) {
       return this.logger.info('CallSession:_lccConfHoldStatus - invalid command as call is not in conference');
@@ -483,6 +584,29 @@ class CallSession extends Emitter {
     task.doConferenceMuteNonModerators(this, opts);
   }
 
+  async _lccSipRequest(opts) {
+    const {sip_request} = opts;
+    const {method, content_type, content, headers = {}} = sip_request;
+    if (!this.hasStableDialog) {
+      this.logger.info('CallSession:_lccSipRequest - invalid command as we do not have a stable call');
+      return;
+    }
+    try {
+      const res = await this.dlg.request({
+        method,
+        headers: {
+          ...headers,
+          'Content-Type': content_type,
+          'Content': content
+        }
+      });
+      this.logger.debug({res}, `CallSession:_lccSipRequest got response to ${method}`);
+      return res;
+    } catch (err) {
+      this.logger.error({err}, `CallSession:_lccSipRequest - error sending ${method}`);
+    }
+  }
+
   /**
    * perform live call control -- whisper to one party or the other on a call
    * @param {array} opts - array of play or say tasks
@@ -553,10 +677,14 @@ class CallSession extends Emitter {
       await this._lccMuteStatus(callSid, opts.mute_status === 'mute');
     }
     else if (opts.conf_hold_status) {
-      await this._lccConfHoldStatus(callSid, opts);
+      await this._lccConfHoldStatus(opts);
     }
     else if (opts.conf_mute_status) {
-      await this._lccConfMuteStatus(callSid, opts);
+      await this._lccConfMuteStatus(opts);
+    }
+    else if (opts.sip_request) {
+      const res = await this._lccSipRequest(opts);
+      return {status: res.status, reason: res.reason};
     }
 
     // whisper may be the only thing we are asked to do, or it may that
@@ -597,6 +725,67 @@ class CallSession extends Emitter {
     this.taskIdx = 0;
   }
 
+  _onCommand({msgid, command, queueCommand, data}) {
+    this.logger.info({msgid, command, queueCommand}, 'CallSession:_onCommand - received command');
+    switch (command) {
+      case 'redirect':
+        if (Array.isArray(data)) {
+          const t = normalizeJambones(this.logger, data)
+            .map((tdata) => makeTask(this.logger, tdata));
+          if (!queueCommand) {
+            this.logger.info({tasks: listTaskNames(t)}, 'CallSession:_onCommand new task list');
+            this.replaceApplication(t);
+          }
+          else {
+            this.logger.info({tasks: listTaskNames(t)}, 'CallSession:_onCommand - queueing tasks');
+            this.tasks.push(...t);
+            this.logger.debug({tasks: listTaskNames(this.tasks)}, 'CallSession:_onCommand - updated task list');
+          }
+        }
+        else this._lccCallHook(data);
+        break;
+
+      case 'call:status':
+        this._lccCallStatus(data);
+        break;
+
+      case 'mute:status':
+        this._lccMuteStatus(this.callSid, data);
+        break;
+
+      case 'conf:mute-status':
+        this._lccConfMuteStatus(data);
+        break;
+
+      case 'conf:hold-status':
+        this._lccConfHoldStatus(data);
+        break;
+
+      case 'listen:status':
+        this._lccListenStatus(data);
+        break;
+
+      case 'whisper':
+        this._lccWhisper(data, this.callSid);
+        break;
+
+      case 'sip:request':
+        this._lccSipRequest(data)
+          .catch((err) => {
+            this.logger.info({err, data}, `CallSession:_onCommand - error sending ${data.method}`);
+          });
+        break;
+
+      default:
+        this.logger.info(`CallSession:_onCommand - invalid command ${command}`);
+    }
+    if (this.wakeupResolver) {
+      this.logger.info('CallSession:_onCommand - got commands, waking up..');
+      this.wakeupResolver();
+      this.wakeupResolver = null;
+    }
+  }
+
   _evaluatePreconditions(task) {
     switch (task.preconditions) {
       case TaskPreconditions.None:
@@ -661,7 +850,11 @@ class CallSession extends Emitter {
     } catch (err) {
       if (err === CALLER_CANCELLED_ERR_MSG) {
         this.logger.error(err, 'caller canceled quickly before we could respond, ending call');
-        this._notifyCallStatusChange({callStatus: CallStatus.NoAnswer, sipStatus: 487});
+        this._notifyCallStatusChange({
+          callStatus: CallStatus.NoAnswer,
+          sipStatus: 487,
+          sipReason: 'Request Terminated'
+        });
         this._callReleased();
       }
       else {
@@ -733,6 +926,7 @@ class CallSession extends Emitter {
       });
     }
     this.tmpFiles.clear();
+    this.requestor && this.requestor.close();
   }
 
   /**
@@ -770,9 +964,10 @@ class CallSession extends Emitter {
       this.dlg.on('destroy', this._callerHungup.bind(this));
       this.wrapDialog(this.dlg);
       this.dlg.callSid = this.callSid;
-      this.emit('callStatusChange', {sipStatus: 200, callStatus: CallStatus.InProgress});
+      this.emit('callStatusChange', {sipStatus: 200, sipReason: 'OK', callStatus: CallStatus.InProgress});
 
       this.dlg.on('modify', this._onReinvite.bind(this));
+      this.dlg.on('refer', this._onRefer.bind(this));
 
       this.logger.debug(`CallSession:propagateAnswer - answered callSid ${this.callSid}`);
     }
@@ -780,14 +975,40 @@ class CallSession extends Emitter {
 
   async _onReinvite(req, res) {
     try {
-      const newSdp = await this.ep.modify(req.body);
-      res.send(200, {body: newSdp});
-      this.logger.info({offer: req.body, answer: newSdp}, 'handling reINVITE');
+      if (this.ep) {
+        const newSdp = await this.ep.modify(req.body);
+        res.send(200, {body: newSdp});
+        this.logger.info({offer: req.body, answer: newSdp}, 'handling reINVITE');
+      }
+      else if (this.currentTask && this.currentTask.name === TaskName.Dial) {
+        this.logger.info('handling reINVITE after media has been released');
+        await this.currentTask.handleReinviteAfterMediaReleased(req, res);
+      }
+      else {
+        this.logger.info('got reINVITE but no endpoint and media has not been released');
+        res.send(488);
+      }
     } catch (err) {
       this.logger.error(err, 'Error handling reinvite');
     }
   }
 
+  /**
+   * Handle incoming REFER if we are in a dial task
+   * @param {*} req
+   * @param {*} res
+   */
+  _onRefer(req, res) {
+    const task = this.currentTask;
+    const sd = task.sd;
+    if (task && TaskName.Dial === task.name && sd) {
+      task.handleRefer(this, req, res);
+    }
+    else {
+      res.send(501);
+    }
+  }
+
   /**
    * create and endpoint if we don't have one; otherwise simply return
    * the current media server and endpoint that are associated with this call
@@ -824,7 +1045,7 @@ class CallSession extends Emitter {
         }
         else {
           this.logger.info({accountSid: this.accountSid, webhook: r[0]}, 'performQueueWebhook: webhook found');
-          this.queueEventHookRequestor = new Requestor(this.logger, this.accountSid,
+          this.queueEventHookRequestor = new HttpRequestor(this.logger, this.accountSid,
             r[0], this.webhook_secret);
           this.queueEventHook = r[0];
         }
@@ -838,7 +1059,7 @@ class CallSession extends Emitter {
     /* send webhook */
     const params =  {...obj, ...this.callInfo.toJSON()};
     this.logger.info({accountSid: this.accountSid, params}, 'performQueueWebhook: sending webhook');
-    this.queueEventHookRequestor.request(this.queueEventHook, params)
+    this.queueEventHookRequestor.request('queue:status', this.queueEventHook, params)
       .catch((err) => {
         this.logger.info({err, accountSid: this.accountSid, obj}, 'Error sending queue notification event');
       });
@@ -927,6 +1148,10 @@ class CallSession extends Emitter {
         this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
         this.logger.debug('CallSession: call terminated by jambones');
         origDestroy();
+        if (this.wakeupResolver) {
+          this.wakeupResolver();
+          this.wakeupResolver = null;
+        }
       }
     };
   }
@@ -953,6 +1178,13 @@ class CallSession extends Emitter {
     });
   }
 
+  async handleReinviteAfterMediaReleased(req, res) {
+    assert(this.dlg && this.dlg.connected && !this.ep);
+    const sdp = await this.dlg.modify(req.body);
+    this.logger.info({sdp}, 'CallSession:handleReinviteAfterMediaReleased - reinvite to A leg returned sdp');
+    res.send(200, {body: sdp});
+  }
+
   /**
    * Called any time call status changes.  This method both invokes the
    * call_status_hook callback as well as updates the realtime database
@@ -962,17 +1194,23 @@ class CallSession extends Emitter {
    * @param {number} sipStatus - current sip status
    * @param {number} [duration] - duration of a completed call, in seconds
    */
-  _notifyCallStatusChange({callStatus, sipStatus, duration}) {
+  _notifyCallStatusChange({callStatus, sipStatus, sipReason, duration}) {
     if (this.callMoved) return;
 
+    /* race condition: we hang up at the same time as the caller */
+    if (callStatus === CallStatus.Completed) {
+      if (this.notifiedComplete) return;
+      this.notifiedComplete = true;
+    }
+
     assert((typeof duration === 'number' && callStatus === CallStatus.Completed) ||
       (!duration && callStatus !== CallStatus.Completed),
     'duration MUST be supplied when call completed AND ONLY when call completed');
 
-    this.callInfo.updateCallStatus(callStatus, sipStatus);
+    this.callInfo.updateCallStatus(callStatus, sipStatus, sipReason);
     if (typeof duration === 'number') this.callInfo.duration = duration;
     try {
-      this.notifier.request(this.call_status_hook, this.callInfo.toJSON());
+      this.notifier.request('call:status', this.call_status_hook, this.callInfo.toJSON());
     } catch (err) {
       this.logger.info(err, `CallSession:_notifyCallStatusChange error sending ${callStatus} ${sipStatus}`);
     }
@@ -982,6 +1220,23 @@ class CallSession extends Emitter {
     this.updateCallStatus(Object.assign({}, this.callInfo.toJSON()), this.serviceUrl)
       .catch((err) => this.logger.error(err, 'redis error'));
   }
+
+  _awaitCommandsOrHangup() {
+    assert(!this.wakeupResolver);
+    return new Promise((resolve, reject) => {
+      this.logger.info('_awaitCommandsOrHangup - waiting...');
+      this.wakeupResolver = resolve;
+    });
+  }
+
+  _clearTasks(evt) {
+    if (this.requestor instanceof WsRequestor) {
+      this.logger.info({evt}, 'CallSession:_clearTasks on event from background gather');
+      try {
+        this.kill();
+      } catch (err) {}
+    }
+  }
 }
 
 module.exports = CallSession;

lib/session/confirm-call-session.js

@@ -30,6 +30,10 @@ class ConfirmCallSession extends CallSession {
   _clearResources() {
   }
 
+  _callerHungup() {
+  }
+
+
 }
 
 module.exports = ConfirmCallSession;

lib/session/inbound-call-session.js

@@ -24,11 +24,19 @@ class InboundCallSession extends CallSession {
     req.once('cancel', this._onCancel.bind(this));
 
     this.on('callStatusChange', this._notifyCallStatusChange.bind(this));
-    this._notifyCallStatusChange({callStatus: CallStatus.Trying, sipStatus: 100});
+    this._notifyCallStatusChange({
+      callStatus: CallStatus.Trying,
+      sipStatus: 100,
+      sipReason: 'Trying'
+    });
   }
 
   _onCancel() {
-    this._notifyCallStatusChange({callStatus: CallStatus.NoAnswer, sipStatus: 487});
+    this._notifyCallStatusChange({
+      callStatus: CallStatus.NoAnswer,
+      sipStatus: 487,
+      sipReason: 'Request Terminated'
+    });
     this._callReleased();
   }
 
@@ -56,7 +64,10 @@ class InboundCallSession extends CallSession {
   _callerHungup() {
     assert(this.dlg.connectTime);
     const duration = moment().diff(this.dlg.connectTime, 'seconds');
-    this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
+    this.emit('callStatusChange', {
+      callStatus: CallStatus.Completed,
+      duration
+    });
     this.logger.debug('InboundCallSession: caller hung up');
     this._callReleased();
     this.req.removeAllListeners('cancel');

lib/session/rest-call-session.js

@@ -22,7 +22,11 @@ class RestCallSession extends CallSession {
     this.ep = ep;
 
     this.on('callStatusChange', this._notifyCallStatusChange.bind(this));
-    this._notifyCallStatusChange({callStatus: CallStatus.Trying, sipStatus: 100});
+    this._notifyCallStatusChange({
+      callStatus: CallStatus.Trying,
+      sipStatus: 100,
+      sipReason: 'Trying'
+    });
   }
 
   /**

lib/tasks/conference.js

@@ -453,7 +453,7 @@ class Conference extends Task {
         this._playSession = null;
         break;
       }
-    } while (!this.killed && !this.conf_hold_status === 'hold');
+    } while (!this.killed && this.conf_hold_status !== 'hold');
   }
 
   /**
@@ -529,7 +529,7 @@ class Conference extends Task {
 
   async _playHook(cs, dlg, hook, allowed = [TaskName.Play, TaskName.Say, TaskName.Pause]) {
     assert(!this._playSession);
-    const json = await cs.application.requestor.request(hook, cs.callInfo);
+    const json = await cs.application.requestor.request('verb:hook', hook, cs.callInfo);
     const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
 
     const allowedTasks = tasks.filter((t) => allowed.includes(t.name));
@@ -586,7 +586,7 @@ class Conference extends Task {
       params.duration = (Date.now() - this.conferenceStartTime.getTime()) / 1000;
       if (!params.time) params.time = (new Date()).toISOString();
       if (!params.members && typeof this.participantCount === 'number') params.members = this.participantCount;
-      cs.application.requestor.request(this.statusHook, Object.assign(params, this.statusParams))
+      cs.application.requestor.request('verb:hook', this.statusHook, Object.assign(params, this.statusParams))
         .catch((err) => this.logger.info(err, 'Conference:notifyConferenceEvent - error'));
     }
   }

lib/tasks/config.js

@@ -0,0 +1,80 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+
+class TaskConfig extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    [
+      'synthesizer',
+      'recognizer',
+      'bargeIn'
+    ].forEach((k) => this[k] = this.data[k] || {});
+
+    if (this.hasBargeIn && this.bargeIn.enable === true) {
+      this.gatherOpts = {
+        verb: 'gather',
+        timeout: 0,
+        bargein: true
+      };
+      [
+        'finishOnKey', 'input', 'numDigits', 'minDigits', 'maxDigits',
+        'interDigitTimeout', 'bargein', 'dtmfBargein', 'minBargeinWordCount', 'actionHook'
+      ].forEach((k) => {
+        if (this.bargeIn[k]) this.gatherOpts[k] = this.bargeIn[k];
+      });
+    }
+    this.preconditions = this.hasBargeIn ? TaskPreconditions.Endpoint : TaskPreconditions.None;
+  }
+
+  get name() { return TaskName.Config; }
+
+  get hasSynthesizer() { return Object.keys(this.synthesizer).length; }
+
+  get hasRecognizer() { return Object.keys(this.recognizer).length; }
+
+  get hasBargeIn() { return Object.keys(this.bargeIn).length; }
+
+  async exec(cs) {
+    await super.exec(cs);
+
+    if (this.hasSynthesizer) {
+      cs.speechSynthesisVendor = this.synthesizer.vendor !== 'default'
+        ? this.synthesizer.vendor
+        : cs.speechSynthesisVendor;
+      cs.speechSynthesisLanguage = this.synthesizer.language !== 'default'
+        ?  this.synthesizer.language
+        : cs.speechSynthesisLanguage;
+      cs.speechSynthesisVoice = this.synthesizer.voice !== 'default'
+        ? this.synthesizer.voice
+        : cs.speechSynthesisVoice;
+      this.logger.info({synthesizer: this.synthesizer}, 'Config: updated synthesizer');
+    }
+    if (this.hasRecognizer) {
+      cs.speechRecognizerVendor = this.recognizer.vendor !== 'default'
+        ? this.recognizer.vendor
+        : cs.speechRecognizerVendor;
+      cs.speechRecognizerLanguage = this.recognizer.language !== 'default'
+        ? this.recognizer.language
+        : cs.speechRecognizerLanguage;
+      this.logger.info({recognizer: this.recognizer}, 'Config: updated recognizer');
+    }
+    if (this.hasBargeIn) {
+      if (this.gatherOpts) {
+        this.logger.debug({opts: this.gatherOpts}, 'Config: enabling bargeIn');
+        cs.enableBotMode(this.gatherOpts);
+      }
+      else {
+        this.logger.debug('Config: disabling bargeIn');
+        cs.disableBotMode();
+      }
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+  }
+}
+
+module.exports = TaskConfig;

lib/tasks/dial.js

@@ -14,6 +14,7 @@ const sessionTracker = require('../session/session-tracker');
 const DtmfCollector = require('../utils/dtmf-collector');
 const dbUtils = require('../utils/db-utils');
 const debug = require('debug')('jambonz:feature-server');
+const {parseUri} = require('drachtio-srf');
 
 function parseDtmfOptions(logger, dtmfCapture) {
   let parentDtmfCollector, childDtmfCollector;
@@ -91,6 +92,7 @@ class TaskDial extends Task {
     this.timeLimit = this.data.timeLimit;
     this.confirmHook = this.data.confirmHook;
     this.confirmMethod = this.data.confirmMethod;
+    this.referHook = this.data.referHook;
     this.dtmfHook = this.data.dtmfHook;
     this.proxy = this.data.proxy;
 
@@ -135,6 +137,11 @@ class TaskDial extends Task {
     return !process.env.ANCHOR_MEDIA_ALWAYS && !this.listenTask && !this.transcribeTask;
   }
 
+  get summary() {
+    if (this.target.length === 1) return `${this.name}{type=${this.target[0].type}}`;
+    else return `${this.name}{${this.target.length} targets}`;
+  }
+
   async exec(cs) {
     await super.exec(cs);
     try {
@@ -147,7 +154,7 @@ class TaskDial extends Task {
           this.epOther.play(this.dialMusic).catch((err) => {});
         }
       }
-      await this._attemptCalls(cs);
+      if (!this.killed) await this._attemptCalls(cs);
       await this.awaitTaskDone();
       this.logger.debug({callSid: this.cs.callSid}, 'Dial:exec task is done, sending actionHook if any');
       await this.performAction(this.results, this.killReason !== KillReason.Replaced);
@@ -161,6 +168,10 @@ class TaskDial extends Task {
 
   async kill(cs, reason) {
     super.kill(cs);
+    if (this.dialMusic && this.epOther) {
+      this.epOther.api('uuid_break', this.epOther.uuid)
+        .catch((err) => this.logger.info(err, 'Error killing dialMusic'));
+    }
     this.killReason = reason || KillReason.Hangup;
     if (this.timerMaxCallDuration) {
       clearTimeout(this.timerMaxCallDuration);
@@ -175,6 +186,7 @@ class TaskDial extends Task {
     this._killOutdials();
     if (this.sd) {
       this.sd.kill();
+      this.sd.removeAllListeners();
       this.sd = null;
     }
     if (this.callSid) sessionTracker.remove(this.callSid);
@@ -235,6 +247,40 @@ class TaskDial extends Task {
     }
   }
 
+  async handleRefer(cs, req, res, callInfo = cs.callInfo) {
+    if (this.referHook) {
+      try {
+        const isChild = !!callInfo.parentCallSid;
+        const referring_call_sid = isChild ? callInfo.callSid : cs.callSid;
+        const referred_call_sid = isChild ? callInfo.parentCallSid : this.sd.callSid;
+
+        const to = parseUri(req.getParsedHeader('Refer-To').uri);
+        const by = parseUri(req.getParsedHeader('Referred-By').uri);
+        this.logger.info({to}, 'refer to parsed');
+        await cs.requestor.request('verb:hook', this.referHook, {
+          ...callInfo,
+          refer_details: {
+            sip_refer_to: req.get('Refer-To'),
+            sip_referred_by: req.get('Referred-By'),
+            sip_user_agent: req.get('User-Agent'),
+            refer_to_user: to.user,
+            referred_by_user: by.user,
+            referring_call_sid,
+            referred_call_sid
+          }
+        });
+        res.send(202);
+        this.logger.info('DialTask:handleRefer - sent 202 Accepted');
+      } catch (err) {
+        res.send(err.statusCode || 501);
+      }
+    }
+    else {
+      this.logger.info('DialTask:handleRefer - got REFER but no referHook, responding 501');
+      res.send(501);
+    }
+  }
+
   _removeHandlers(sd) {
     sd.removeAllListeners('accept');
     sd.removeAllListeners('decline');
@@ -283,7 +329,7 @@ class TaskDial extends Task {
     const match = dtmfDetector.keyPress(key);
     if (match) {
       this.logger.info({callSid}, `Dial:_onInfo triggered dtmf match: ${match}`);
-      requestor.request(this.dtmfHook, {dtmf: match, ...callInfo.toJSON()})
+      requestor.request('verb:hook', this.dtmfHook, {dtmf: match, ...callInfo.toJSON()})
         .catch((err) => this.logger.info(err, 'Dial:_onDtmf - error'));
     }
   }
@@ -362,6 +408,9 @@ class TaskDial extends Task {
             opts.headers['X-Requested-Carrier-Sid'] = voip_carrier_sid;
           }
         }
+
+        if (this.killed) return;
+
         const sd = placeCall({
           logger: this.logger,
           application: cs.application,
@@ -376,8 +425,11 @@ class TaskDial extends Task {
         this.dials.set(sd.callSid, sd);
 
         sd
+          .on('refer', (callInfo, req, res) => this.handleRefer(cs, req, res, callInfo))
           .on('callCreateFail', () => {
+            clearTimeout(this.timerRing);
             this.dials.delete(sd.callSid);
+            sd.removeAllListeners();
             if (this.dials.size === 0 && !this.sd) {
               this.logger.debug('Dial:_attemptCalls - all calls failed after call create err, ending task');
               this.kill(cs);
@@ -419,6 +471,7 @@ class TaskDial extends Task {
           })
           .on('accept', async() => {
             this.logger.debug(`Dial:_attemptCalls - we have a winner: ${sd.callSid}`);
+            clearTimeout(this.timerRing);
             try {
               await this._connectSingleDial(cs, sd);
             } catch (err) {
@@ -427,11 +480,23 @@ class TaskDial extends Task {
           })
           .on('decline', () => {
             this.logger.debug(`Dial:_attemptCalls - declined: ${sd.callSid}`);
+            clearTimeout(this.timerRing);
             this.dials.delete(sd.callSid);
+            sd.removeAllListeners();
             if (this.dials.size === 0 && !this.sd) {
               this.logger.debug('Dial:_attemptCalls - all calls failed after decline, ending task');
               this.kill(cs);
             }
+          })
+          .on('reinvite', (req, res) => {
+            try {
+              cs.handleReinviteAfterMediaReleased(req, res);
+            } catch (err) {
+              this.logger.error(err, 'Error in dial einvite from B leg');
+            }
+          })
+          .on('refer', (callInfo, req, res) => {
+
           })
           .once('adulting', () => {
             /* child call just adulted and got its own session */
@@ -543,8 +608,7 @@ class TaskDial extends Task {
     try {
       const aLegSdp = cs.ep.remote.sdp;
       const bLegSdp = sd.dlg.remote.sdp;
-      this.logger.debug({aLegSdp, bLegSdp}, 'Dial:_releaseMedia - releasing media from freewitch');
-      await Promise.all[sd.releaseMediaToSBC(aLegSdp), cs.releaseMediaToSBC(bLegSdp)];
+      await Promise.all[sd.releaseMediaToSBC(aLegSdp, cs.ep.local.sdp), cs.releaseMediaToSBC(bLegSdp)];
       this.epOther = null;
       this.logger.info('Dial:_releaseMedia - successfully released media from freewitch');
     } catch (err) {
@@ -559,6 +623,12 @@ class TaskDial extends Task {
     await Promise.all([sd.reAnchorMedia(), cs.reAnchorMedia()]);
     this.epOther = cs.ep;
   }
+
+  async handleReinviteAfterMediaReleased(req, res) {
+    const sdp = await this.dlg.modify(req.body);
+    this.logger.info({sdp}, 'Dial:handleReinviteAfterMediaReleased - sent reinvite to B leg');
+    res.send(200, {body: sdp});
+  }
 }
 
 module.exports = TaskDial;

lib/tasks/dialogflow/index.js

@@ -452,8 +452,8 @@ class Dialogflow extends Task {
     this.noinputTimer = setTimeout(this._onNoInput.bind(this, ep, cs), this.noInputTimeout);
   }
 
-  async _performHook(cs, hook, results) {
-    const json = await this.cs.requestor.request(hook, results);
+  async _performHook(cs, hook, results = {}) {
+    const json = await this.cs.requestor.request('verb:hook', hook, {...results, ...cs.callInfo.toJSON()});
     if (json && Array.isArray(json)) {
       const makeTask = require('../make_task');
       const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));

lib/tasks/enqueue.js

@@ -317,7 +317,7 @@ class TaskEnqueue extends Task {
     } catch (err) {
       this.logger.error({err}, `TaskEnqueue:_playHook error retrieving list info for queue ${this.queueName}`);
     }
-    const json = await cs.application.requestor.request(hook, params);
+    const json = await cs.application.requestor.request('verb:hook', hook, params);
     const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
 
     const allowedTasks = tasks.filter((t) => allowed.includes(t.name));

lib/tasks/gather.js

@@ -9,6 +9,7 @@ const {
 
 const makeTask = require('./make_task');
 const assert = require('assert');
+//const GATHER_STABILITY_THRESHOLD =  Number(process.env.JAMBONZ_GATHER_STABILITY_THRESHOLD || 0.7);
 
 class TaskGather extends Task {
   constructor(logger, opts, parentTask) {
@@ -16,20 +17,31 @@ class TaskGather extends Task {
     this.preconditions = TaskPreconditions.Endpoint;
 
     [
-      'finishOnKey', 'hints', 'input', 'numDigits',
-      'partialResultHook',
+      'finishOnKey', 'hints', 'input', 'numDigits', 'minDigits', 'maxDigits',
+      'interDigitTimeout', 'partialResultHook', 'bargein', 'dtmfBargein',
       'speechTimeout', 'timeout', 'say', 'play'
     ].forEach((k) => this[k] = this.data[k]);
 
-    this.timeout = (this.timeout || 5) * 1000;
-    this.interim = this.partialResultCallback;
+    /* when collecting dtmf, bargein on dtmf is true unless explicitly set to false */
+    if (this.dtmfBargein !== false && this.input.includes('digits')) this.dtmfBargein = true;
+
+    /* timeout of zero means no timeout */
+    this.timeout = this.timeout === 0 ? 0 : (this.timeout || 15) * 1000;
+    this.interim = this.partialResultHook || this.bargein;
+    this.listenDuringPrompt = this.data.listenDuringPrompt === false ? false : true;
+    this.minBargeinWordCount = this.data.minBargeinWordCount || 0;
     if (this.data.recognizer) {
       const recognizer = this.data.recognizer;
       this.vendor = recognizer.vendor;
       this.language = recognizer.language;
       this.hints = recognizer.hints || [];
+      this.hintsBoost = recognizer.hintsBoost;
       this.altLanguages = recognizer.altLanguages || [];
 
+      /* vad: if provided, we dont connect to recognizer until voice activity is detected */
+      const {enable, voiceMs = 0, mode = -1} = recognizer.vad || {};
+      this.vad = {enable, voiceMs, mode};
+
       /* aws options */
       this.vocabularyName = recognizer.vocabularyName;
       this.vocabularyFilterName = recognizer.vocabularyFilterName;
@@ -40,6 +52,7 @@ class TaskGather extends Task {
       this.profanityOption = recognizer.profanityOption || 'raw';
       this.requestSnr = recognizer.requestSnr || false;
       this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
+      this.azureServiceEndpoint = recognizer.azureServiceEndpoint;
     }
 
     this.digitBuffer = '';
@@ -47,6 +60,7 @@ class TaskGather extends Task {
 
     if (this.say) this.sayTask = makeTask(this.logger, {say: this.say}, this);
     if (this.play) this.playTask = makeTask(this.logger, {play: this.play}, this);
+    if (!this.sayTask && !this.playTask) this.listenDuringPrompt = false;
 
     this.parentTask = parentTask;
   }
@@ -60,7 +74,23 @@ class TaskGather extends Task {
       (this.playTask && this.playTask.earlyMedia);
   }
 
+  get summary() {
+    let s = `${this.name}{`;
+    if (this.input.length === 2) s += 'inputs=[speech,digits],';
+    else if (this.input.includes('digits')) s += 'inputs=digits';
+    else s += 'inputs=speech,';
+
+    if (this.input.includes('speech')) {
+      s += `vendor=${this.vendor || 'default'},language=${this.language || 'default'}`;
+    }
+    if (this.sayTask) s += ',with nested say task';
+    if (this.playTask) s += ',with nested play task';
+    s += '}';
+    return s;
+  }
+
   async exec(cs, ep) {
+    this.logger.debug('Gather:exec');
     await super.exec(cs);
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
 
@@ -80,29 +110,43 @@ class TaskGather extends Task {
       throw new Error(`no speech-to-text service credentials for ${this.vendor} have been configured`);
     }
 
+    const startListening = (cs, ep) => {
+      this._startTimer();
+      if (this.input.includes('speech') && !this.listenDuringPrompt) {
+        this._initSpeech(cs, ep)
+          .then(() => {
+            this._startTranscribing(ep);
+            return updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid);
+          })
+          .catch(() => {});
+      }
+    };
+
     try {
       if (this.sayTask) {
         this.sayTask.exec(cs, ep);  // kicked off, _not_ waiting for it to complete
         this.sayTask.on('playDone', (err) => {
-          if (!this.killed) this._startTimer();
+          if (err) return this.logger.error({err}, 'Gather:exec Error playing tts');
+          this.logger.debug('Gather: say task completed');
         });
       }
       else if (this.playTask) {
         this.playTask.exec(cs, ep);  // kicked off, _not_ waiting for it to complete
         this.playTask.on('playDone', (err) => {
-          if (!this.killed) this._startTimer();
+          if (err) return this.logger.error({err}, 'Gather:exec Error playing url');
+          if (!this.killed) startListening(cs, ep);
         });
       }
-      else this._startTimer();
+      else startListening(cs, ep);
 
-      if (this.input.includes('speech')) {
+      if (this.input.includes('speech') && this.listenDuringPrompt) {
         await this._initSpeech(cs, ep);
         this._startTranscribing(ep);
         updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid)
           .catch(() => {/*already logged error */});
       }
 
-      if (this.input.includes('digits')) {
+      if (this.input.includes('digits') || this.dtmfBargein) {
         ep.on('dtmf', this._onDtmf.bind(this, cs, ep));
       }
 
@@ -121,22 +165,50 @@ class TaskGather extends Task {
     super.kill(cs);
     this._killAudio(cs);
     this.ep.removeAllListeners('dtmf');
+    clearTimeout(this.interDigitTimer);
     this._resolve('killed');
   }
 
+  updateTimeout(timeout) {
+    this.logger.info(`TaskGather:updateTimout - updating timeout to ${timeout}`);
+    this.timeout = timeout;
+    this._startTimer();
+  }
+
   _onDtmf(cs, ep, evt) {
     this.logger.debug(evt, 'TaskGather:_onDtmf');
-    if (evt.dtmf === this.finishOnKey) this._resolve('dtmf-terminator-key');
+    clearTimeout(this.interDigitTimer);
+    let resolved = false;
+    if (this.dtmfBargein) this._killAudio(cs);
+    if (evt.dtmf === this.finishOnKey && this.input.includes('digits')) {
+      resolved = true;
+      this._resolve('dtmf-terminator-key');
+    }
     else {
       this.digitBuffer += evt.dtmf;
-      if (this.digitBuffer.length === this.numDigits) this._resolve('dtmf-num-digits');
+      const len = this.digitBuffer.length;
+      if (len === this.numDigits || len === this.maxDigits) {
+        resolved = true;
+        this._resolve('dtmf-num-digits');
+      }
+    }
+    if (!resolved && this.interDigitTimeout > 0 && this.digitBuffer.length >= this.minDigits) {
+      /* start interDigitTimer */
+      const ms = this.interDigitTimeout * 1000;
+      this.logger.debug(`starting interdigit timer of ${ms}`);
+      this.interDigitTimer = setTimeout(() => this._resolve('dtmf-interdigit-timeout'), ms);
     }
-    this._killAudio(cs);
   }
 
   async _initSpeech(cs, ep) {
     const opts = {};
 
+    if (this.vad?.enable) {
+      opts.START_RECOGNIZING_ON_VAD = 1;
+      if (this.vad.voiceMs) opts.RECOGNIZER_VAD_VOICE_MS = this.vad.voiceMs;
+      if (this.vad.mode >= 0 && this.vad.mode <= 3) opts.RECOGNIZER_VAD_MODE = this.vad.mode;
+    }
+
     if ('google' === this.vendor) {
       if (this.sttCredentials) opts.GOOGLE_APPLICATION_CREDENTIALS = JSON.stringify(this.sttCredentials.credentials);
       Object.assign(opts, {
@@ -146,8 +218,11 @@ class TaskGather extends Task {
       });
       if (this.hints && this.hints.length > 1) {
         opts.GOOGLE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
+        if (typeof this.hintsBoost === 'number') {
+          opts.GOOGLE_SPEECH_HINTS_BOOST = this.hintsBoost;
+        }
       }
-      if (this.altLanguages && this.altLanguages.length > 1) {
+      if (this.altLanguages && this.altLanguages.length > 0) {
         opts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
       }
       if (this.profanityFilter === true) {
@@ -181,8 +256,9 @@ class TaskGather extends Task {
       if (this.hints && this.hints.length > 1) {
         opts.AZURE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
       }
-      //if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
-      //if (this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
+      if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
+      if (this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
+      if (this.azureServiceEndpoint) opts.AZURE_SERVICE_ENDPOINT = this.azureServiceEndpoint;
       if (this.initialSpeechTimeoutMs > 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = this.initialSpeechTimeoutMs;
       opts.AZURE_USE_OUTPUT_FORMAT_DETAILED = 1;
 
@@ -194,10 +270,15 @@ class TaskGather extends Task {
   }
 
   _startTranscribing(ep) {
+    this.logger.debug({
+      vendor: this.vendor,
+      locale: this.language,
+      interim: this.interim
+    }, 'Gather:_startTranscribing');
     ep.startTranscription({
       vendor: this.vendor,
       locale: this.language,
-      interim: this.partialResultCallback ? true : false,
+      interim: this.interim,
     }).catch((err) => {
       const {writeAlerts, AlertType} = this.cs.srf.locals;
       this.logger.error(err, 'TaskGather:_startTranscribing error');
@@ -211,6 +292,7 @@ class TaskGather extends Task {
   }
 
   _startTimer() {
+    if (0 === this.timeout) return;
     assert(!this._timeoutTimer);
     this.logger.debug(`Gather:_startTimer: timeout ${this.timeout}`);
     this._timeoutTimer = setTimeout(() => this._resolve('timeout'), this.timeout);
@@ -224,6 +306,15 @@ class TaskGather extends Task {
   }
 
   _killAudio(cs) {
+    if (!this.sayTask && !this.playTask && this.bargein) {
+      if (this.ep?.connected && !this.playComplete) {
+        this.logger.debug('Gather:_killAudio: killing playback of any audio');
+        this.playComplete = true;
+        this.ep.api('uuid_break', this.ep.uuid)
+          .catch((err) => this.logger.info(err, 'Error killing audio'));
+      }
+      return;
+    }
     if (this.sayTask && !this.sayTask.killed) {
       this.sayTask.removeAllListeners('playDone');
       this.sayTask.kill(cs);
@@ -239,27 +330,56 @@ class TaskGather extends Task {
   _onTranscription(cs, ep, evt) {
     if ('aws' === this.vendor && Array.isArray(evt) && evt.length > 0) evt = evt[0];
     if ('microsoft' === this.vendor) {
-      const nbest = evt.NBest;
-      const newEvent = {
-        is_final: evt.RecognitionStatus === 'Success',
-        alternatives: [
-          {
-            confidence: nbest[0].Confidence,
-            transcript: nbest[0].Display
-          }
-        ]
-      };
-      evt = newEvent;
+      const final = evt.RecognitionStatus === 'Success';
+      if (final) {
+        const nbest = evt.NBest;
+        evt = {
+          is_final: true,
+          alternatives: [
+            {
+              confidence: nbest[0].Confidence,
+              transcript: nbest[0].Display
+            }
+          ]
+        };
+      }
+      else {
+        evt = {
+          is_final: false,
+          alternatives: [
+            {
+              transcript: evt.Text
+            }
+          ]
+        };
+      }
     }
-    this.logger.debug(evt, 'TaskGather:_onTranscription');
     if (evt.is_final) this._resolve('speech', evt);
-    else if (this.partialResultHook) {
-      this.cs.requestor.request(this.partialResultHook,  Object.assign({speech: evt}, this.cs.callInfo))
-        .catch((err) => this.logger.info(err, 'GatherTask:_onTranscription error'));
+    else {
+      /* google has a measure of stability:
+        https://cloud.google.com/speech-to-text/docs/basics#streaming_responses
+        others do not.
+      */
+      //const isStableEnough = typeof evt.stability === 'undefined' || evt.stability > GATHER_STABILITY_THRESHOLD;
+
+      if (this.bargein && /* isStableEnough && */
+        evt.alternatives[0].transcript.split(' ').length >= this.minBargeinWordCount) {
+        if (!this.playComplete) {
+          this.logger.debug({transcript: evt.alternatives[0].transcript}, 'killing audio due to speech');
+        }
+        this._killAudio(cs);
+      }
+      if (this.partialResultHook) {
+        this.cs.requestor.request(this.partialResultHook,  Object.assign({speech: evt}, this.cs.callInfo));
+      }
     }
   }
   _onEndOfUtterance(cs, ep) {
     this.logger.info('TaskGather:_onEndOfUtterance');
+    if (this.bargein && this.minBargeinWordCount === 0) {
+      this._killAudio(cs);
+    }
+
     if (!this.resolved && !this.killed) {
       this._startTranscribing(ep);
     }
@@ -273,6 +393,7 @@ class TaskGather extends Task {
     if (this.resolved) return;
     this.resolved = true;
     this.logger.debug(`TaskGather:resolve with reason ${reason}`);
+    clearTimeout(this.interDigitTimer);
 
     if (this.ep && this.ep.connected) {
       this.ep.stopTranscription({vendor: this.vendor})
@@ -281,15 +402,25 @@ class TaskGather extends Task {
 
     this._clearTimer();
     if (reason.startsWith('dtmf')) {
-      await this.performAction({digits: this.digitBuffer, reason: 'dtmfDetected'});
+      if (this.parentTask) this.parentTask.emit('dtmf', evt);
+      else {
+        this.emit('dtmf', evt);
+        await this.performAction({digits: this.digitBuffer, reason: 'dtmfDetected'});
+      }
     }
     else if (reason.startsWith('speech')) {
       if (this.parentTask) this.parentTask.emit('transcription', evt);
-      else await this.performAction({speech: evt, reason: 'speechDetected'});
+      else {
+        this.emit('transcription', evt);
+        await this.performAction({speech: evt, reason: 'speechDetected'});
+      }
     }
     else if (reason.startsWith('timeout')) {
       if (this.parentTask) this.parentTask.emit('timeout', evt);
-      else await this.performAction({reason: 'timeout'});
+      else {
+        this.emit('timeout', evt);
+        await this.performAction({reason: 'timeout'});
+      }
     }
     this.notifyTaskDone();
   }

lib/tasks/lex.js

@@ -289,7 +289,7 @@ class Lex extends Task {
   }
 
   async _performHook(cs, hook, results) {
-    const json = await this.cs.requestor.request(hook, results);
+    const json = await this.cs.requestor.request('verb:hook', hook, results);
     if (json && Array.isArray(json)) {
       const makeTask = require('./make_task');
       const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));

lib/tasks/make_task.js

@@ -20,6 +20,9 @@ function makeTask(logger, obj, parent) {
     case TaskName.SipRefer:
       const TaskSipRefer = require('./sip_refer');
       return new TaskSipRefer(logger, data, parent);
+    case TaskName.Config:
+      const TaskConfig = require('./config');
+      return new TaskConfig(logger, data, parent);
     case TaskName.Conference:
       const TaskConference = require('./conference');
       return new TaskConference(logger, data, parent);

lib/tasks/message.js

@@ -42,7 +42,7 @@ class TaskMessage extends Task {
       }
       if (gw) {
         this.logger.info({gw, accountSid}, 'Message:exec - using smpp to send message');
-        url = getSmpp();
+        url = process.env.K8S ? 'http://smpp' : getSmpp();
         relativeUrl = '/sms';
         payload = {
           ...payload,

lib/tasks/rest_dial.js

@@ -48,7 +48,7 @@ class TaskRestDial extends Task {
     cs.setDialog(dlg);
 
     try {
-      const tasks = await cs.requestor.request(this.call_hook, cs.callInfo);
+      const tasks = await cs.requestor.request('verb:hook', this.call_hook, cs.callInfo);
       if (tasks && Array.isArray(tasks)) {
         this.logger.debug({tasks: tasks}, `TaskRestDial: replacing application with ${tasks.length} tasks`);
         cs.replaceApplication(normalizeJambones(this.logger, tasks).map((tdata) => makeTask(this.logger, tdata)));

lib/tasks/say.js

@@ -14,6 +14,14 @@ class TaskSay extends Task {
 
   get name() { return TaskName.Say; }
 
+  get summary() {
+    for (let i = 0; i < this.text.length; i++) {
+      if (this.text[i].startsWith('silence_stream')) continue;
+      return `${this.name}{text=${this.text[i].slice(0, 15)}${this.text[i].length > 15 ? '...' : ''}}`;
+    }
+    return this.text[0];
+  }
+
   async exec(cs, ep) {
     await super.exec(cs);
 
@@ -21,15 +29,20 @@ class TaskSay extends Task {
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, srf);
     const {writeAlerts, AlertType, stats} = srf.locals;
     const {synthAudio} = srf.locals.dbHelpers;
-    const hasVerbLevelTts = this.synthesizer.vendor && this.synthesizer.vendor !== 'default';
-    const vendor = hasVerbLevelTts ? this.synthesizer.vendor : cs.speechSynthesisVendor ;
-    const language = hasVerbLevelTts ? this.synthesizer.language : cs.speechSynthesisLanguage ;
-    const voice = hasVerbLevelTts ? this.synthesizer.voice : cs.speechSynthesisVoice ;
-
+    const vendor = this.synthesizer.vendor && this.synthesizer.vendor !== 'default' ?
+      this.synthesizer.vendor :
+      cs.speechSynthesisVendor;
+    const language = this.synthesizer.language && this.synthesizer.language !== 'default' ?
+      this.synthesizer.language :
+      cs.speechSynthesisLanguage ;
+    const voice =  this.synthesizer.voice && this.synthesizer.voice !== 'default' ?
+      this.synthesizer.voice :
+      cs.speechSynthesisVoice;
+    const engine = this.synthesizer.engine || 'standard';
     const salt = cs.callSid;
     const credentials = cs.getSpeechCredentials(vendor, 'tts');
 
-    this.logger.info({language, voice}, `Task:say - using vendor: ${vendor}`);
+    this.logger.info({vendor, language, voice}, 'TaskSay:exec');
     this.ep = ep;
     try {
       if (!credentials) {
@@ -43,11 +56,14 @@ class TaskSay extends Task {
       // synthesize all of the text elements
       let lastUpdated = false;
       const filepath = (await Promise.all(this.text.map(async(text) => {
+        if (this.killed) return;
+        if (text.startsWith('silence_stream://')) return text;
         const {filePath, servedFromCache} = await synthAudio(stats, {
           text,
           vendor,
           language,
           voice,
+          engine,
           salt,
           credentials
         }).catch((err) => {
@@ -71,14 +87,18 @@ class TaskSay extends Task {
 
       this.logger.debug({filepath}, 'synthesized files for tts');
 
-      while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep.connected) {
+      while (!this.killed && (this.loop === 'forever' || this.loop--) && this.ep?.connected) {
         let segment = 0;
         do {
           if (cs.isInConference) {
             const {memberId, confName, confUuid} = cs;
             await this.playToConfMember(this.ep, memberId, confName, confUuid, filepath[segment]);
           }
-          else await ep.play(filepath[segment]);
+          else {
+            this.logger.debug(`Say:exec sending command to play file ${filepath[segment]}`);
+            await ep.play(filepath[segment]);
+            this.logger.debug(`Say:exec completed play file ${filepath[segment]}`);
+          }
         } while (!this.killed && ++segment < filepath.length);
       }
     } catch (err) {

lib/tasks/sip_decline.js

@@ -19,7 +19,11 @@ class TaskSipDecline extends Task {
     res.send(this.data.status, this.data.reason, {
       headers: this.headers
     });
-    cs.emit('callStatusChange', {callStatus: CallStatus.Failed, sipStatus: this.data.status});
+    cs.emit('callStatusChange', {
+      callStatus: CallStatus.Failed,
+      sipStatus: this.data.status,
+      sipReason: this.data.reason
+    });
   }
 }
 

lib/tasks/sip_refer.js

@@ -51,6 +51,7 @@ class TaskSipRefer extends Task {
     super.kill(cs);
     const {dlg} = cs;
     dlg.off('notify', this.notifyHandler);
+    this.notifyTaskDone();
   }
 
   async _handleNotify(cs, dlg, req, res) {
@@ -65,7 +66,7 @@ class TaskSipRefer extends Task {
         const status = arr[1];
         this.logger.debug(`TaskSipRefer:_handleNotify: call got status ${status}`);
         if (this.eventHook) {
-          await cs.requestor.request(this.eventHook, {event: 'transfer-status', call_status: status});
+          await cs.requestor.request('verb:hook', this.eventHook, {event: 'transfer-status', call_status: status});
         }
         if (status >= 200) {
           await this.performAction({refer_status: 202, final_referred_call_status: status});

lib/tasks/specs.json

@@ -21,6 +21,31 @@
       "referTo"
     ]
   },
+  "config": {
+    "properties": {
+      "synthesizer": "#synthesizer",
+      "recognizer": "#recognizer",
+      "bargeIn": "#bargeIn"
+    },
+    "required": []
+  },
+  "bargeIn": {
+    "properties": {
+      "enable": "boolean",
+      "actionHook": "object|string",
+      "input": "array",
+      "finishOnKey": "string",
+      "numDigits": "number",
+      "minDigits": "number",
+      "maxDigits": "number",
+      "interDigitTimeout": "number",
+      "dtmfBargein": "boolean",
+      "minBargeinWordCount": "number"
+    },
+    "required": [
+      "enable"
+    ]
+  },
   "dequeue": {
     "properties": {
       "name": "string",
@@ -82,8 +107,15 @@
       "finishOnKey": "string",
       "input": "array",
       "numDigits": "number",
+      "minDigits": "number",
+      "maxDigits": "number",
+      "interDigitTimeout": "number",
       "partialResultHook": "object|string",
       "speechTimeout": "number",
+      "listenDuringPrompt": "boolean",
+      "dtmfBargein": "boolean",
+      "bargein": "boolean",
+      "minBargeinWordCount": "number",
       "timeout": "number",
       "recognizer": "#recognizer",
       "play": "#play",
@@ -117,6 +149,7 @@
       "answerOnBridge": "boolean",
       "callerId": "string",
       "confirmHook": "object|string",
+      "referHook": "object|string",
       "dialMusic": "string",
       "dtmfCapture": "object",
       "dtmfHook": "object|string",
@@ -308,7 +341,6 @@
       "earlyMedia": "boolean"
     },
     "required": [
-      "transcriptionHook",
       "recognizer"
     ]
   },
@@ -323,6 +355,7 @@
         "type": "string",
         "enum": ["GET", "POST"]
       },
+      "headers": "object",
       "name": "string",
       "number": "string",
       "sipUri": "string",
@@ -354,6 +387,10 @@
       },
       "language": "string",
       "voice": "string",
+      "engine": {
+        "type": "string",
+        "enum": ["standard", "neural"]
+      },
       "gender": {
         "type": "string",
         "enum": ["MALE", "FEMALE", "NEUTRAL"]
@@ -370,7 +407,9 @@
         "enum": ["google", "aws", "microsoft", "default"]
       },
       "language": "string",
+      "vad": "#vad",
       "hints": "array",
+      "hintsBoost": "number",
       "altLanguages": "array",
       "profanityFilter": "boolean",
       "interim": "boolean",
@@ -424,7 +463,8 @@
         ]
       },
       "requestSnr": "boolean",
-      "initialSpeechTimeoutMs": "number"
+      "initialSpeechTimeoutMs": "number",
+      "azureServiceEndpoint": "string"
     },
     "required": [
       "vendor"
@@ -438,5 +478,15 @@
     "required": [
       "name"
     ]
+  },
+  "vad": {
+    "properties": {
+      "enable": "boolean",
+      "voiceMs": "number",
+      "mode": "number"  
+    },
+    "required": [
+      "enable"
+    ]
   }
 }

lib/tasks/task.js

@@ -42,6 +42,10 @@ class Task extends Emitter {
     return this.cs;
   }
 
+  get summary() {
+    return this.name;
+  }
+
   toJSON() {
     return this.data;
   }
@@ -62,7 +66,9 @@ class Task extends Emitter {
   kill(cs) {
     if (this.cs && !this.cs.isConfirmCallSession) this.logger.debug(`${this.name} is being killed`);
     this._killInProgress = true;
-    // no-op
+
+    /* remove reference to parent task or else entangled parent-child tasks will not be gc'ed */
+    setImmediate(() => this.parentTask = null);
   }
 
   /**
@@ -105,7 +111,7 @@ class Task extends Emitter {
   async performAction(results, expectResponse = true) {
     if (this.actionHook) {
       const params = results ? Object.assign(results, this.cs.callInfo.toJSON()) : this.cs.callInfo.toJSON();
-      const json = await this.cs.requestor.request(this.actionHook, params);
+      const json = await this.cs.requestor.request('verb:hook', this.actionHook, params);
       if (expectResponse && json && Array.isArray(json)) {
         const makeTask = require('./make_task');
         const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));
@@ -118,7 +124,7 @@ class Task extends Emitter {
   }
 
   async performHook(cs, hook, results) {
-    const json = await cs.requestor.request(hook, results);
+    const json = await cs.requestor.request('verb:hook', hook, results);
     if (json && Array.isArray(json)) {
       const makeTask = require('./make_task');
       const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));

lib/tasks/transcribe.js

@@ -11,6 +11,7 @@ class TaskTranscribe extends Task {
   constructor(logger, opts, parentTask) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
+    this.parentTask = parentTask;
 
     this.transcriptionHook = this.data.transcriptionHook;
     this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
@@ -21,8 +22,13 @@ class TaskTranscribe extends Task {
     this.interim = !!recognizer.interim;
     this.separateRecognitionPerChannel = recognizer.separateRecognitionPerChannel;
 
+    /* vad: if provided, we dont connect to recognizer until voice activity is detected */
+    const {enable, voiceMs = 0, mode = -1} = recognizer.vad || {};
+    this.vad = {enable, voiceMs, mode};
+
     /* google-specific options */
     this.hints = recognizer.hints || [];
+    this.hintsBoost = recognizer.hintsBoost;
     this.profanityFilter = recognizer.profanityFilter;
     this.punctuation = !!recognizer.punctuation;
     this.enhancedModel = !!recognizer.enhancedModel;
@@ -45,6 +51,7 @@ class TaskTranscribe extends Task {
     this.profanityOption = recognizer.profanityOption || 'raw';
     this.requestSnr = recognizer.requestSnr || false;
     this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
+    this.azureServiceEndpoint = recognizer.azureServiceEndpoint;
   }
 
   get name() { return TaskName.Transcribe; }
@@ -76,6 +83,7 @@ class TaskTranscribe extends Task {
       await this.awaitTaskDone();
     } catch (err) {
       this.logger.info(err, 'TaskTranscribe:exec - error');
+      this.parentTask && this.parentTask.emit('error', err);
     }
     ep.removeCustomEventListener(GoogleTranscriptionEvents.Transcription);
     ep.removeCustomEventListener(GoogleTranscriptionEvents.NoAudioDetected);
@@ -103,6 +111,12 @@ class TaskTranscribe extends Task {
   async _startTranscribing(cs, ep) {
     const opts = {};
 
+    if (this.vad.enable) {
+      opts.START_RECOGNIZING_ON_VAD = 1;
+      if (this.vad.voiceMs) opts.RECOGNIZER_VAD_VOICE_MS = this.vad.voiceMs;
+      if (this.vad.mode >= 0 && this.vad.mode <= 3) opts.RECOGNIZER_VAD_MODE = this.vad.mode;
+    }
+
     ep.addCustomEventListener(GoogleTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
     ep.addCustomEventListener(GoogleTranscriptionEvents.NoAudioDetected, this._onNoAudio.bind(this, cs, ep));
     ep.addCustomEventListener(GoogleTranscriptionEvents.MaxDurationExceeded,
@@ -126,7 +140,12 @@ class TaskTranscribe extends Task {
       ].forEach((arr) => {
         if (this[arr[0]]) opts[arr[1]] = true;
       });
-      if (this.hints.length > 1) opts.GOOGLE_SPEECH_HINTS = this.hints.join(',');
+      if (this.hints.length > 1) {
+        opts.GOOGLE_SPEECH_HINTS = this.hints.join(',');
+        if (typeof this.hintsBoost === 'number') {
+          opts.GOOGLE_SPEECH_HINTS_BOOST = this.hintsBoost;
+        }
+      }
       if (this.altLanguages.length > 1) opts.GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
       if ('unspecified' !== this.interactionType) {
         opts.GOOGLE_SPEECH_METADATA_INTERACTION_TYPE = this.interactionType;
@@ -193,6 +212,7 @@ class TaskTranscribe extends Task {
       if (this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
       if (this.initialSpeechTimeoutMs > 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = this.initialSpeechTimeoutMs;
       if (this.outputFormat !== 'simple') opts.AZURE_USE_OUTPUT_FORMAT_DETAILED = 1;
+      if (this.azureServiceEndpoint) opts.AZURE_SERVICE_ENDPOINT = this.azureServiceEndpoint;
 
       await ep.set(opts)
         .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with azure'));
@@ -210,25 +230,36 @@ class TaskTranscribe extends Task {
   }
 
   _onTranscription(cs, ep, evt) {
+    this.logger.debug(evt, 'TaskTranscribe:_onTranscription');
     if ('aws' === this.vendor && Array.isArray(evt) && evt.length > 0) evt = evt[0];
     if ('microsoft' === this.vendor) {
       const nbest = evt.NBest;
-      const alternatives = nbest.map((n) => {
+      const alternatives = nbest ? nbest.map((n) => {
         return {
           confidence: n.Confidence,
           transcript: n.Display
         };
-      });
+      }) :
+        [
+          {
+            transcript: evt.DisplayText
+          }
+        ];
+
       const newEvent = {
         is_final: evt.RecognitionStatus === 'Success',
         alternatives
       };
       evt = newEvent;
     }
-    this.logger.debug(evt, 'TaskTranscribe:_onTranscription');
 
-    this.cs.requestor.request(this.transcriptionHook, Object.assign({speech: evt}, this.cs.callInfo))
-      .catch((err) => this.logger.info(err, 'TranscribeTask:_onTranscription error'));
+    if (this.transcriptionHook) {
+      this.cs.requestor.request('verb:hook', this.transcriptionHook, Object.assign({speech: evt}, this.cs.callInfo))
+        .catch((err) => this.logger.info(err, 'TranscribeTask:_onTranscription error'));
+    }
+    if (this.parentTask) {
+      this.parentTask.emit('transcription', evt);
+    }
     if (this.killed) {
       this.logger.debug('TaskTranscribe:_onTranscription exiting after receiving final transcription');
       this._clearTimer();

lib/utils/aws-sns-lifecycle.js

@@ -45,6 +45,7 @@ class SnsNotifier extends Emitter {
           }, 'response from SNS SubscribeURL');
           const data = await this.describeInstance();
           this.lifecycleState = data.AutoScalingInstances[0].LifecycleState;
+          this.emit('SubscriptionConfirmation', {publicIp: this.publicIp});
           break;
 
         case 'Notification':

lib/utils/base-requestor.js

@@ -0,0 +1,75 @@
+const assert = require('assert');
+const Emitter = require('events');
+const crypto = require('crypto');
+const timeSeries = require('@jambonz/time-series');
+let alerter ;
+
+class BaseRequestor extends Emitter {
+  constructor(logger, account_sid, hook, secret) {
+    super();
+    assert(typeof hook === 'object');
+
+    this.logger = logger;
+    this.url = hook.url;
+
+    this.username = hook.username;
+    this.password = hook.password;
+    this.secret = secret;
+    this.account_sid = account_sid;
+
+    const {stats} = require('../../').srf.locals;
+    this.stats = stats;
+
+    if (!alerter) {
+      alerter = timeSeries(logger, {
+        host: process.env.JAMBONES_TIME_SERIES_HOST,
+        commitSize: 50,
+        commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+      });
+    }
+  }
+
+  get Alerter() {
+    return alerter;
+  }
+
+  close() {
+    /* subclass responsibility */
+  }
+
+  _computeSignature(payload, timestamp, secret) {
+    assert(secret);
+    const data = `${timestamp}.${JSON.stringify(payload)}`;
+    return crypto
+      .createHmac('sha256', secret)
+      .update(data, 'utf8')
+      .digest('hex');
+  }
+
+  _generateSigHeader(payload, secret) {
+    const timestamp = Math.floor(Date.now() / 1000);
+    const signature = this._computeSignature(payload, timestamp, secret);
+    const scheme = 'v1';
+    return {
+      'Jambonz-Signature': `t=${timestamp},${scheme}=${signature}`
+    };
+  }
+
+  _isAbsoluteUrl(u) {
+    return typeof u === 'string' &&
+      u.startsWith('https://') || u.startsWith('http://') ||
+      u.startsWith('ws://') || u.startsWith('wss://');
+  }
+  _isRelativeUrl(u) {
+    return typeof u === 'string' && u.startsWith('/');
+  }
+  _roundTrip(startAt) {
+    const diff = process.hrtime(startAt);
+    const time = diff[0] * 1e3 + diff[1] * 1e-6;
+    return time.toFixed(0);
+  }
+
+
+}
+
+module.exports = BaseRequestor;

lib/utils/constants.json

@@ -1,6 +1,8 @@
 {
   "TaskName": {
+    "Cognigy": "cognigy",
     "Conference": "conference",
+    "Config": "config",
     "Dequeue": "dequeue",
     "Dial": "dial",
     "Dialogflow": "dialogflow",
@@ -104,6 +106,16 @@
     "Hangup": "hangup",
     "Replaced": "replaced"
   },
+  "HookMsgTypes": [
+    "session:new",
+    "session:reconnect",
+    "session:redirect",
+    "call:status",
+    "queue:status",
+    "verb:hook",
+    "jambonz:error"
+  ],
   "MAX_SIMRINGS": 10,
-  "BONG_TONE": "tone_stream://v=-7;%(100,0,941.0,1477.0);v=-7;>=2;+=.1;%(1400,0,350,440)"
+  "BONG_TONE": "tone_stream://v=-7;%(100,0,941.0,1477.0);v=-7;>=2;+=.1;%(1400,0,350,440)",
+  "FS_UUID_SET_NAME": "fsUUIDs"
 }

lib/utils/cron-jobs.js

@@ -0,0 +1,52 @@
+const {execSync} = require('child_process');
+const now = Date.now();
+const fsInventory = process.env.JAMBONES_FREESWITCH
+  .split(',')
+  .map((fs) => {
+    const arr = /^([^:]*):([^:]*):([^:]*)(?::([^:]*))?/.exec(fs);
+    const opts = {address: arr[1], port: arr[2], secret: arr[3]};
+    if (arr.length > 4) opts.advertisedAddress = arr[4];
+    if (process.env.NODE_ENV === 'test') opts.listenAddress = '0.0.0.0';
+    return opts;
+  });
+
+const clearChannels = () => {
+  const {logger} = require('../..');
+  const pwd = fsInventory[0].secret;
+  const maxDurationMins = process.env.JAMBONES_FREESWITCH_MAX_CALL_DURATION_MINS || 180;
+
+  const calls = execSync(`/usr/local/freeswitch/bin/fs_cli -p ${pwd} -x "show calls"`, {encoding: 'utf8'})
+    .split('\n')
+    .filter((line) => line.match(/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{8}/))
+    .map((line) => {
+      const arr = line.split(',');
+      const dt = new Date(arr[2]);
+      const duration = (now - dt.getTime()) / 1000;
+      return {
+        uuid: arr[0],
+        time: arr[2],
+        duration
+      };
+    })
+    .filter((c) => c.duration > 60 * maxDurationMins);
+
+  if (calls.length > 0) {
+    logger.debug(`clearChannels: clearing ${calls.length} old calls longer than ${maxDurationMins} mins`);
+    for (const call of calls) {
+      const cmd = `/usr/local/freeswitch/bin/fs_cli -p ${pwd} -x "uuid_kill ${call.uuid}"`;
+      const out = execSync(cmd, {encoding: 'utf8'});
+      logger.debug({out}, 'clearChannels: command output');
+    }
+  }
+  return calls.length;
+};
+
+const clearFiles = () => {
+  const {logger} = require('../..');
+  const out = execSync('find /tmp -name "*.mp3" -mtime +2 -exec rm {} \\;');
+  logger.debug({out}, 'clearFiles: command output');
+};
+
+
+module.exports = {clearChannels, clearFiles};
+

lib/utils/db-utils.js

@@ -36,6 +36,10 @@ const speechMapper = (cred) => {
     obj.api_key = o.api_key;
     obj.region = o.region;
   }
+  else if ('wellsaid' === obj.vendor) {
+    const o = JSON.parse(decrypt(credential));
+    obj.api_key = o.api_key;
+  }
   return obj;
 };
 
@@ -53,6 +57,7 @@ module.exports = (logger, srf) => {
     const haveGoogle = speech.find((s) => s.vendor === 'google');
     const haveAws = speech.find((s) => s.vendor === 'aws');
     const haveMicrosoft = speech.find((s) => s.vendor === 'microsoft');
+    const haveWellsaid = speech.find((s) => s.vendor === 'wellsaid');
     if (!haveGoogle || !haveAws || !haveMicrosoft) {
       const [r3] = await pp.query(sqlSpeechCredentialsForSP, account_sid);
       if (r3.length) {
@@ -68,6 +73,10 @@ module.exports = (logger, srf) => {
           const ms = r3.find((s) => s.vendor === 'microsoft');
           if (ms) speech.push(speechMapper(ms));
         }
+        if (!haveWellsaid) {
+          const wellsaid = r3.find((s) => s.vendor === 'wellsaid');
+          if (wellsaid) speech.push(speechMapper(wellsaid));
+        }
       }
     }
 

lib/utils/http-requestor.js

@@ -0,0 +1,111 @@
+const bent = require('bent');
+const parseUrl = require('parse-url');
+const assert = require('assert');
+const BaseRequestor = require('./base-requestor');
+const {HookMsgTypes} = require('./constants.json');
+const snakeCaseKeys = require('./snakecase-keys');
+
+const toBase64 = (str) => Buffer.from(str || '', 'utf8').toString('base64');
+
+function basicAuth(username, password) {
+  if (!username || !password) return {};
+  const creds = `${username}:${password || ''}`;
+  const header = `Basic ${toBase64(creds)}`;
+  return {Authorization: header};
+}
+
+
+class HttpRequestor extends BaseRequestor {
+  constructor(logger, account_sid, hook, secret) {
+    super(logger, account_sid, hook, secret);
+
+    this.method = hook.method || 'POST';
+    this.authHeader = basicAuth(hook.username, hook.password);
+
+    const u = parseUrl(this.url);
+    const myPort = u.port ? `:${u.port}` : '';
+    const baseUrl = this._baseUrl = `${u.protocol}://${u.resource}${myPort}`;
+
+    this.get = bent(baseUrl, 'GET', 'buffer', 200, 201);
+    this.post = bent(baseUrl, 'POST', 'buffer', 200, 201);
+
+
+    assert(this._isAbsoluteUrl(this.url));
+    assert(['GET', 'POST'].includes(this.method));
+  }
+
+  get baseUrl() {
+    return this._baseUrl;
+  }
+
+  /**
+   * Make an HTTP request.
+   * All requests use json bodies.
+   * All requests expect a 200 statusCode on success
+   * @param {object|string} hook - may be a absolute or relative url, or an object
+   * @param {string} [hook.url] - an absolute or relative url
+   * @param {string} [hook.method] - 'GET' or 'POST'
+   * @param {string} [hook.username] - if basic auth is protecting the endpoint
+   * @param {string} [hook.password] - if basic auth is protecting the endpoint
+   * @param {object} [params] - request parameters
+   */
+  async request(type, hook, params) {
+    assert(HookMsgTypes.includes(type));
+    const payload = params ? snakeCaseKeys(params, ['customerData', 'sip']) : null;
+    const url = hook.url || hook;
+    const method = hook.method || 'POST';
+
+    assert.ok(url, 'HttpRequestor:request url was not provided');
+    assert.ok, (['GET', 'POST'].includes(method), `HttpRequestor:request method must be 'GET' or 'POST' not ${method}`);
+    const {url: urlInfo = hook, method: methodInfo = 'POST'} = hook;  // mask user/pass
+    this.logger.debug({url: urlInfo, method: methodInfo, payload}, `HttpRequestor:request ${method} ${url}`);
+    const startAt = process.hrtime();
+
+    let buf;
+    try {
+      const sigHeader = this._generateSigHeader(payload, this.secret);
+      const headers = {...sigHeader, ...this.authHeader};
+      //this.logger.info({url, headers}, 'send webhook');
+      buf = this._isRelativeUrl(url) ?
+        await this.post(url, payload, headers) :
+        await bent(method, 'buffer', 200, 201, 202)(url, payload, headers);
+    } catch (err) {
+      if (err.statusCode) {
+        this.logger.info({baseUrl: this.baseUrl, url},
+          `web callback returned unexpected status code ${err.statusCode}`);
+      }
+      else {
+        this.logger.error({err, baseUrl: this.baseUrl, url},
+          'web callback returned unexpected error');
+      }
+      let opts = {account_sid: this.account_sid};
+      if (err.code === 'ECONNREFUSED') {
+        opts = {...opts, alert_type: this.Alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url};
+      }
+      else if (err.name === 'StatusError') {
+        opts = {...opts, alert_type: this.Alerter.AlertType.WEBHOOK_STATUS_FAILURE, url, status: err.statusCode};
+      }
+      else {
+        opts = {...opts, alert_type: this.Alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url, detail: err.message};
+      }
+      this.Alerter.writeAlerts(opts).catch((err) => this.logger.info({err, opts}, 'Error writing alert'));
+
+      throw err;
+    }
+    const rtt = this._roundTrip(startAt);
+    if (buf) this.stats.histogram('app.hook.response_time', rtt, ['hook_type:app']);
+
+    if (buf && buf.toString().length > 0) {
+      try {
+        const json = JSON.parse(buf.toString());
+        this.logger.info({response: json}, `HttpRequestor:request ${method} ${url} succeeded in ${rtt}ms`);
+        return json;
+      }
+      catch (err) {
+        //this.logger.debug({err, url, method}, `HttpRequestor:request returned non-JSON content: '${buf.toString()}'`);
+      }
+    }
+  }
+}
+
+module.exports = HttpRequestor;

lib/utils/place-outdial.js

@@ -5,15 +5,10 @@ const {TaskPreconditions, CallDirection} = require('../utils/constants');
 const CallInfo = require('../session/call-info');
 const assert = require('assert');
 const ConfirmCallSession = require('../session/confirm-call-session');
-const selectSbc = require('./select-sbc');
-const Registrar = require('@jambonz/mw-registrar');
 const AdultingCallSession = require('../session/adulting-call-session');
-const registrar = new Registrar({
-  host: process.env.JAMBONES_REDIS_HOST,
-  port: process.env.JAMBONES_REDIS_PORT || 6379
-});
 const deepcopy = require('deepcopy');
 const moment = require('moment');
+const stripCodecs = require('./strip-ancillary-codecs');
 const { v4: uuidv4 } = require('uuid');
 
 class SingleDialer extends Emitter {
@@ -63,7 +58,18 @@ class SingleDialer extends Emitter {
   async exec(srf, ms, opts) {
     opts = opts || {};
     opts.headers = opts.headers || {};
-    opts.headers = {...opts.headers, 'X-Call-Sid': this.callSid};
+    opts.headers = {
+      ...opts.headers,
+      ...(this.target.headers || {}),
+      'X-Jambonz-Routing': this.target.type,
+      'X-Call-Sid': this.callSid
+    };
+    if (srf.locals.fsUUID) {
+      opts.headers = {
+        ...opts.headers,
+        'X-Jambonz-FS-UUID': srf.locals.fsUUID,
+      };
+    }
     this.ms = ms;
     let uri, to;
     try {
@@ -84,7 +90,6 @@ class SingleDialer extends Emitter {
           break;
         case 'user':
           assert(this.target.name);
-          const aor = this.target.name;
           uri = `sip:${this.target.name}`;
           to = this.target.name;
 
@@ -93,16 +98,6 @@ class SingleDialer extends Emitter {
               'X-Override-To': this.target.overrideTo
             });
           }
-
-          // need to send to the SBC registered on
-          const reg = await registrar.query(aor);
-          if (reg) {
-            const sbc = selectSbc(reg.sbcAddress);
-            if (sbc) {
-              this.logger.debug(`SingleDialer:exec retrieved registration details for ${aor}, using sbc at ${sbc}`);
-              this.sbcAddress = sbc;
-            }
-          }
           break;
         case 'sip':
           assert(this.target.sipUri);
@@ -155,6 +150,7 @@ class SingleDialer extends Emitter {
            *  (a) create a CallInfo for this call
            *  (a) create a logger for this call
            */
+          req.srf = srf;
           this.callInfo = new CallInfo({
             direction: CallDirection.Outbound,
             parentCallInfo: this.parentCallInfo,
@@ -168,10 +164,14 @@ class SingleDialer extends Emitter {
             callId: this.callInfo.callId
           });
           this.inviteInProgress = req;
-          this.emit('callStatusChange', {callStatus: CallStatus.Trying, sipStatus: 100});
+          this.emit('callStatusChange', {
+            callStatus: CallStatus.Trying,
+            sipStatus: 100,
+            sipReason: 'Trying'
+          });
         },
         cbProvisional: (prov) => {
-          const status = {sipStatus: prov.status};
+          const status = {sipStatus: prov.status, sipReason: prov.reason};
           if ([180, 183].includes(prov.status) && prov.body) {
             if (status.callStatus !== CallStatus.EarlyMedia) {
               status.callStatus = CallStatus.EarlyMedia;
@@ -186,7 +186,11 @@ class SingleDialer extends Emitter {
       await connectStream(this.dlg.remote.sdp);
       this.dlg.callSid = this.callSid;
       this.inviteInProgress = null;
-      this.emit('callStatusChange', {sipStatus: 200, callStatus: CallStatus.InProgress});
+      this.emit('callStatusChange', {
+        sipStatus: 200,
+        sipReason: 'OK',
+        callStatus: CallStatus.InProgress
+      });
       this.logger.debug(`SingleDialer:exec call connected: ${this.callSid}`);
       const connectTime = this.dlg.connectTime = moment();
 
@@ -194,7 +198,12 @@ class SingleDialer extends Emitter {
       if (this.killed) {
         this.logger.info(`SingleDialer:exec race condition - we were killed as call connected: ${this.callSid}`);
         const duration = moment().diff(connectTime, 'seconds');
-        this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
+        this.emit('callStatusChange', {
+          callStatus: CallStatus.Completed,
+          sipStatus: 487,
+          sipReason: 'Request Terminated',
+          duration
+        });
         if (this.ep) this.ep.destroy();
         return;
       }
@@ -209,20 +218,31 @@ class SingleDialer extends Emitter {
         .on('refresh', () => this.logger.info('SingleDialer:exec - dialog refreshed by uas'))
         .on('modify', async(req, res) => {
           try {
-            const newSdp = await this.ep.modify(req.body);
-            res.send(200, {body: newSdp});
-            this.logger.info({offer: req.body, answer: newSdp}, 'SingleDialer:exec: handling reINVITE');
+            if (this.ep) {
+              const newSdp = await this.ep.modify(req.body);
+              res.send(200, {body: newSdp});
+              this.logger.info({offer: req.body, answer: newSdp}, 'SingleDialer:exec: handling reINVITE');
+            }
+            else {
+              this.logger.info('SingleDialer:exec: handling reINVITE with released media, emit event');
+              this.emit('reinvite', req, res);
+            }
           } catch (err) {
             this.logger.error(err, 'Error handling reinvite');
           }
+        })
+        .on('refer', (req, res) => {
+          this.emit('refer', this.callInfo, req, res);
         });
 
       if (this.confirmHook) this._executeApp(this.confirmHook);
       else this.emit('accept');
     } catch (err) {
+      this.inviteInProgress = null;
       const status = {callStatus: CallStatus.Failed};
       if (err instanceof SipError) {
         status.sipStatus = err.status;
+        status.sipReason = err.reason;
         if (err.status === 487) status.callStatus = CallStatus.NoAnswer;
         else if ([486, 600].includes(err.status)) status.callStatus = CallStatus.Busy;
         this.logger.info(`SingleDialer:exec outdial failure ${err.status}`);
@@ -322,9 +342,10 @@ class SingleDialer extends Emitter {
     return cs;
   }
 
-  async releaseMediaToSBC(remoteSdp) {
+  async releaseMediaToSBC(remoteSdp, localSdp) {
     assert(this.dlg && this.dlg.connected && this.ep && typeof remoteSdp === 'string');
-    await this.dlg.modify(remoteSdp, {
+    const sdp = stripCodecs(this.logger, remoteSdp, localSdp) || remoteSdp;
+    await this.dlg.modify(sdp, {
       headers: {
         'X-Reason': 'release-media'
       }
@@ -344,16 +365,16 @@ class SingleDialer extends Emitter {
     });
   }
 
-  _notifyCallStatusChange({callStatus, sipStatus, duration}) {
+  _notifyCallStatusChange({callStatus, sipStatus, sipReason, duration}) {
     assert((typeof duration === 'number' && callStatus === CallStatus.Completed) ||
       (!duration && callStatus !== CallStatus.Completed),
     'duration MUST be supplied when call completed AND ONLY when call completed');
 
     if (this.callInfo) {
-      this.callInfo.updateCallStatus(callStatus, sipStatus);
+      this.callInfo.updateCallStatus(callStatus, sipStatus, sipReason);
       if (typeof duration === 'number') this.callInfo.duration = duration;
       try {
-        this.requestor.request(this.application.call_status_hook, this.callInfo.toJSON());
+        this.requestor.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,8 +1,9 @@
 const assert = require('assert');
-const noopLogger = {info: () => {}, error: () => {}};
-const {LifeCycleEvents} = require('./constants');
+const { v4: uuidv4 } = require('uuid');
+const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./constants');
 const Emitter = require('events');
 const debug = require('debug')('jambonz:feature-server');
+const noopLogger = {info: () => {}, error: () => {}};
 
 module.exports = (logger) => {
   logger = logger || noopLogger;
@@ -16,6 +17,10 @@ module.exports = (logger) => {
     assert.ok(sbcs.length, 'JAMBONES_SBCS env var is empty or misconfigured');
     logger.info({sbcs}, 'SBC inventory');
   }
+  else if (process.env.K8S && process.env.K8S_SBC_SIP_SERVICE_NAME) {
+    sbcs = [`${process.env.K8S_SBC_SIP_SERVICE_NAME}:5060`];
+    logger.info({sbcs}, 'SBC inventory');
+  }
 
   // listen for SNS lifecycle changes
   let lifecycleEmitter = new Emitter();
@@ -27,6 +32,10 @@ module.exports = (logger) => {
         lifecycleEmitter = await require('./aws-sns-lifecycle')(logger);
 
         lifecycleEmitter
+          .on('SubscriptionConfirmation', ({publicIp}) => {
+            const {srf} = require('../..');
+            srf.locals.publicIp = publicIp;
+          })
           .on(LifeCycleEvents.ScaleIn, () => {
             logger.info('AWS scale-in notification: begin drying up calls');
             dryUpCalls = true;
@@ -67,7 +76,6 @@ module.exports = (logger) => {
     })();
   }
 
-  // send OPTIONS pings to SBCs
   async function pingProxies(srf) {
     if (process.env.NODE_ENV === 'test') return;
 
@@ -90,29 +98,40 @@ module.exports = (logger) => {
       }
     }
   }
+  if (process.env.K8S) {
+    setImmediate(() => {
+      logger.info('disabling OPTIONS pings since we are running as a kubernetes service');
+      const {srf} = require('../..');
+      const {addToSet} = srf.locals.dbHelpers;
+      const uuid = srf.locals.fsUUID = uuidv4();
+      addToSet(FS_UUID_SET_NAME, uuid)
+        .catch((err) => logger.info({err}, `Error adding ${uuid} to set ${FS_UUID_SET_NAME}`));
+    });
+  }
+  else {
+    // OPTIONS ping the SBCs from each feature server every 60 seconds
+    setInterval(() => {
+      const {srf} = require('../..');
+      pingProxies(srf);
+    }, process.env.OPTIONS_PING_INTERVAL || 30000);
 
-  // OPTIONS ping the SBCs from each feature server every 60 seconds
-  setInterval(() => {
-    const {srf} = require('../..');
-    pingProxies(srf);
-  }, process.env.OPTIONS_PING_INTERVAL || 30000);
+    // initial ping once we are up
+    setTimeout(async() => {
 
-  // initial ping once we are up
-  setTimeout(async() => {
-    const {srf} = require('../..');
+      // if SBCs are auto-scaling, monitor them as they come and go
+      const {srf} = require('../..');
+      if (!process.env.JAMBONES_SBCS) {
+        const {monitorSet} = srf.locals.dbHelpers;
+        const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-sip`;
+        await monitorSet(setName, 10, (members) => {
+          sbcs = members;
+          logger.info(`sbc-pinger: SBC roster has changed, list of active SBCs is now ${sbcs}`);
+        });
+      }
 
-    // if SBCs are auto-scaling, monitor them as they come and go
-    if (!process.env.JAMBONES_SBCS) {
-      const {monitorSet} = srf.locals.dbHelpers;
-      const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-sip`;
-      await monitorSet(setName, 10, (members) => {
-        sbcs = members;
-        logger.info(`sbc-pinger: SBC roster has changed, list of active SBCs is now ${sbcs}`);
-      });
-    }
-
-    pingProxies(srf);
-  }, 1000);
+      pingProxies(srf);
+    }, 1000);
+  }
 
   return {
     lifecycleEmitter,

lib/utils/select-sbc.js

@@ -1,13 +0,0 @@
-const CIDRMatcher = require('cidr-matcher');
-const matcher = new CIDRMatcher([process.env.JAMBONES_NETWORK_CIDR]);
-
-module.exports = (sbcList) => {
-  const obj = sbcList
-    .split(',')
-    .map((str) => {
-      const arr = /^(.*)\/(.*):(\d+)$/.exec(str);
-      return {protocol: arr[1], host: arr[2], port: arr[3]};
-    })
-    .find((obj) => 'udp' == obj.protocol && matcher.contains(obj.host));
-  if (obj) return `${obj.host}:${obj.port}`;
-};

lib/utils/strip-ancillary-codecs.js

@@ -0,0 +1,30 @@
+const sdpTransform = require('sdp-transform');
+
+const stripCodecs = (logger, remoteSdp, localSdp) => {
+  try {
+    const sdp = sdpTransform.parse(remoteSdp);
+    const local = sdpTransform.parse(localSdp);
+    const m = local.media
+      .find((m) => 'audio' === m.type);
+    const pt = m.rtp[0].payload;
+
+    /* manipulate on the audio section */
+    const audio = sdp.media.find((m) => 'audio' === m.type);
+
+    /* discard all of the codecs except the first in our 200 OK, and telephony-events */
+    const ptSaves = audio.rtp
+      .filter((r) => r.codec === 'telephone-event' || r.payload === pt)
+      .map((r) => r.payload);
+    const rtp = audio.rtp.filter((r) => ptSaves.includes(r.payload));
+
+    /* reattach the new rtp sections and  stripped payload list */
+    audio.rtp = rtp;
+    audio.payloads = rtp.map((r) => r.payload).join(' ');
+    return sdpTransform.write(sdp);
+  } catch (err) {
+    logger.error({err, remoteSdp, localSdp}, 'strip-ancillary-codecs error');
+  }
+};
+
+module.exports = stripCodecs;
+

lib/utils/summarize-tasks.js

@@ -1,3 +1,3 @@
 module.exports = function(tasks) {
-  return `[${tasks.map((t) => t.name).join(',')}]`;
+  return `[${tasks.map((t) => t.summary).join(',')}]`;
 };

lib/utils/ws-requestor.js

@@ -0,0 +1,276 @@
+const assert = require('assert');
+const BaseRequestor = require('./base-requestor');
+const short = require('short-uuid');
+const {HookMsgTypes} = require('./constants.json');
+const Websocket = require('ws');
+const snakeCaseKeys = require('./snakecase-keys');
+const HttpRequestor = require('./http-requestor');
+const MAX_RECONNECTS = 5;
+const RESPONSE_TIMEOUT_MS = process.env.JAMBONES_WS_API_MSG_RESPONSE_TIMEOUT || 5000;
+
+class WsRequestor extends BaseRequestor {
+  constructor(logger, account_sid, hook, secret) {
+    super(logger, account_sid, hook, secret);
+    this.connections = 0;
+    this.messagesInFlight = new Map();
+    this.maliciousClient = false;
+    this.closedByUs = false;
+
+    assert(this._isAbsoluteUrl(this.url));
+
+    this.on('socket-closed', this._onSocketClosed.bind(this));
+  }
+
+  /**
+   * Send a JSON payload over the websocket.  If this is the first request,
+   * open the websocket.
+   * All requests expect an ack message in response
+   * @param {object|string} hook - may be a absolute or relative url, or an object
+   * @param {string} [hook.url] - an absolute or relative url
+   * @param {string} [hook.method] - 'GET' or 'POST'
+   * @param {string} [hook.username] - if basic auth is protecting the endpoint
+   * @param {string} [hook.password] - if basic auth is protecting the endpoint
+   * @param {object} [params] - request parameters
+   */
+  async request(type, hook, params) {
+    assert(HookMsgTypes.includes(type));
+    const url = hook.url || hook;
+
+    if (this.maliciousClient) {
+      this.logger.info({url: this.url}, 'WsRequestor:request - discarding msg to malicious client');
+      return;
+    }
+
+    if (type === 'session:new') this.call_sid = params.callSid;
+
+    /* if we have an absolute url, and it is http then do a standard webhook */
+    if (this._isAbsoluteUrl(url) && url.startsWith('http')) {
+      this.logger.debug({hook}, 'WsRequestor: sending a webhook (HTTP)');
+      const requestor = new HttpRequestor(this.logger, this.account_sid, hook, this.secret);
+      return requestor.request(type, hook, params);
+    }
+
+    /* connect if necessary */
+    if (!this.ws) {
+      if (this.connections >= MAX_RECONNECTS) {
+        throw new Error(`max attempts connecting to ${this.url}`);
+      }
+      try {
+        const startAt = process.hrtime();
+        await this._connect();
+        const rtt = this._roundTrip(startAt);
+        this.stats.histogram('app.hook.connect_time', rtt, ['hook_type:app']);
+      } catch (err) {
+        this.logger.info({url, err}, 'WsRequestor:request - failed connecting');
+        throw err;
+      }
+    }
+    assert(this.ws);
+
+    /* prepare and send message */
+    const payload = params ? snakeCaseKeys(params, ['customerData', 'sip']) : null;
+    assert.ok(url, 'WsRequestor:request url was not provided');
+
+    const msgid = short.generate();
+    const obj = {
+      type,
+      msgid,
+      call_sid: this.call_sid,
+      hook: type === 'verb:hook' ? url : undefined,
+      data: {...payload}
+    };
+
+    //this.logger.debug({obj}, `websocket: sending (${url})`);
+
+    /* simple notifications */
+    if (['call:status', 'jambonz:error'].includes(type)) {
+      this.ws.send(JSON.stringify(obj), () => {
+        this.logger.debug({obj}, `WsRequestor:request websocket: sent (${url})`);
+      });
+      return;
+    }
+
+    /* messages that require an ack */
+    return new Promise((resolve, reject) => {
+      /* give the far end a reasonable amount of time to ack our message */
+      const timer = setTimeout(() => {
+        const {failure} = this.messagesInFlight.get(msgid);
+        failure && failure(`timeout from far end for msgid ${msgid}`);
+        this.messagesInFlight.delete(msgid);
+      }, RESPONSE_TIMEOUT_MS);
+
+      /* save the message info for reply */
+      const startAt = process.hrtime();
+      this.messagesInFlight.set(msgid, {
+        success: (response) => {
+          clearTimeout(timer);
+          const rtt = this._roundTrip(startAt);
+          this.logger.info({response}, `WsRequestor:request ${url} succeeded in ${rtt}ms`);
+          this.stats.histogram('app.hook.ws_response_time', rtt, ['hook_type:app']);
+          resolve(response);
+        },
+        failure: (err) => {
+          clearTimeout(timer);
+          reject(err);
+        }
+      });
+
+      /* send the message */
+      this.ws.send(JSON.stringify(obj), () => {
+        this.logger.debug({obj}, `WsRequestor:request websocket: sent (${url})`);
+      });
+    });
+  }
+
+  close() {
+    this.logger.info('WsRequestor:close closing socket');
+    this.closedByUs = true;
+    try {
+      if (this.ws) {
+        this.ws.close();
+        this.ws.removeAllListeners();
+      }
+
+      for (const [msgid, obj] of this.messagesInFlight) {
+        obj.failure(`abandoning msgid ${msgid} since we have closed the socket`);
+      }
+      this.messagesInFlight.clear();
+
+    } catch (err) {
+      this.logger.info({err}, 'WsRequestor: Error closing socket');
+    }
+  }
+
+  _connect() {
+    assert(!this.ws);
+    return new Promise((resolve, reject) => {
+      let opts = {
+        followRedirects: true,
+        maxRedirects: 2,
+        handshakeTimeout: 1000,
+        maxPayload: 8096,
+      };
+      if (this.username && this.password) opts = {...opts, auth: `${this.username}:${this.password}`};
+
+      this
+        .once('ready', (ws) => {
+          this.ws = ws;
+          this.removeAllListeners('not-ready');
+          if (this.connections++ > 0) this.request('session:reconnect', this.url);
+          resolve();
+        })
+        .once('not-ready', (err) => {
+          this.removeAllListeners('ready');
+          reject(err);
+        });
+      const ws = new Websocket(this.url, ['ws.jambonz.org'], opts);
+      this._setHandlers(ws);
+    });
+  }
+
+  _setHandlers(ws) {
+    ws
+      .once('open', this._onOpen.bind(this, ws))
+      .once('close', this._onClose.bind(this))
+      .on('message', this._onMessage.bind(this))
+      .once('unexpected-response', this._onUnexpectedResponse.bind(this, ws))
+      .on('error', this._onError.bind(this));
+  }
+
+  _onError(err) {
+    if (this.connections > 0) {
+      this.logger.info({url: this.url, err}, 'WsRequestor:_onError');
+    }
+    else this.emit('not-ready', err);
+  }
+
+  _onOpen(ws) {
+    if (this.ws) this.logger.info({old_ws: this.ws._socket.address()}, 'WsRequestor:_onOpen');
+    assert(!this.ws);
+    this.emit('ready', ws);
+    this.logger.info({url: this.url}, 'WsRequestor - successfully connected');
+  }
+
+  _onClose() {
+    if (this.connections > 0) {
+      this.logger.info({url: this.url}, 'WsRequestor - socket closed unexpectedly from remote side');
+      this.emit('socket-closed');
+    }
+    this.ws && this.ws.removeAllListeners();
+    this.ws = null;
+  }
+
+  _onUnexpectedResponse(ws, req, res) {
+    assert(!this.ws);
+    this.logger.info({
+      headers: res.headers,
+      statusCode: res.statusCode,
+      statusMessage: res.statusMessage
+    }, 'WsRequestor - unexpected response');
+    this.emit('connection-failure');
+    this.emit('not-ready', new Error(`${res.statusCode} ${res.statusMessage}`));
+  }
+
+  _onSocketClosed() {
+    this.ws = null;
+    if (this.connections > 0 && this.connections < MAX_RECONNECTS && !this.closedByUs) {
+      setTimeout(this._connect.bind(this), 500);
+    }
+  }
+
+  _onMessage(content, isBinary) {
+    if (this.isBinary) {
+      this.logger.info({url: this.url}, 'WsRequestor:_onMessage - discarding binary message');
+      this.maliciousClient = true;
+      this.ws.close();
+      return;
+    }
+
+    /* messages must be JSON format */
+    try {
+      const obj = JSON.parse(content);
+      const {type, msgid, command, queueCommand = false, data} = obj;
+
+      this.logger.debug({obj}, 'WsRequestor:request websocket: received');
+      assert.ok(type, 'type property not supplied');
+
+      switch (type) {
+        case 'ack':
+          assert.ok(msgid, 'msgid not supplied');
+          this._recvAck(msgid, data);
+          break;
+
+        case 'command':
+          assert.ok(command, 'command property not supplied');
+          assert.ok(data, 'data property not supplied');
+          this._recvCommand(msgid, command, queueCommand, data);
+          break;
+
+        default:
+          assert.ok(false, `invalid type property: ${type}`);
+      }
+    } catch (err) {
+      this.logger.info({err}, 'WsRequestor:_onMessage - invalid incoming message');
+    }
+  }
+
+  _recvAck(msgid, data) {
+    const obj = this.messagesInFlight.get(msgid);
+    if (!obj) {
+      this.logger.info({url: this.url}, `WsRequestor:_recvAck - ack to unknown msgid ${msgid}, discarding`);
+      return;
+    }
+    this.logger.debug({url: this.url}, `WsRequestor:_recvAck - received response to ${msgid}`);
+    this.messagesInFlight.delete(msgid);
+    const {success} = obj;
+    success && success(data);
+  }
+
+  _recvCommand(msgid, command, queueCommand, data) {
+    // TODO: validate command
+    this.logger.info({msgid, command, queueCommand, data}, 'received command');
+    this.emit('command', {msgid, command, queueCommand, data});
+  }
+}
+
+module.exports = WsRequestor;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "v0.7.1",
+  "version": "v0.7.4",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"
@@ -21,31 +21,36 @@
   },
   "scripts": {
     "start": "node app",
-    "test": "NODE_ENV=test JAMBONES_HOSTING=1 DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 DRACHTIO_SECRET=cymru JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=127.0.0.1 JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=debug ENABLE_METRICS=0 HTTP_PORT=3000 JAMBONES_SBCS=172.38.0.10 JAMBONES_FREESWITCH=127.0.0.1:8022:ClueCon:docker-host JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_NETWORK_CIDR=172.38.0.0/16 node test/ ",
+    "test": "NODE_ENV=test JAMBONES_HOSTING=1 DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 DRACHTIO_SECRET=cymru JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=127.0.0.1 JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=error ENABLE_METRICS=0 HTTP_PORT=3000 JAMBONES_SBCS=172.38.0.10 JAMBONES_FREESWITCH=127.0.0.1:8022:ClueCon:docker-host JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_NETWORK_CIDR=172.38.0.0/16 node test/ ",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
     "jslint": "eslint app.js lib"
   },
   "dependencies": {
+    "@cognigy/socket-client": "^4.5.5",
     "@jambonz/db-helpers": "^0.6.16",
+    "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/mw-registrar": "^0.2.1",
-    "@jambonz/realtimedb-helpers": "^0.4.14",
-    "@jambonz/stats-collector": "^0.1.5",
-    "@jambonz/time-series": "^0.1.5",
-    "aws-sdk": "^2.846.0",
+    "@jambonz/realtimedb-helpers": "^0.4.26",
+    "@jambonz/stats-collector": "^0.1.6",
+    "@jambonz/time-series": "^0.1.6",
+    "aws-sdk": "^2.1073.0",
     "bent": "^7.3.12",
     "cidr-matcher": "^2.1.1",
-    "debug": "^4.3.1",
+    "debug": "^4.3.2",
     "deepcopy": "^2.1.0",
     "drachtio-fsmrf": "^2.0.13",
-    "drachtio-srf": "^4.4.55",
+    "drachtio-srf": "^4.4.61",
     "express": "^4.17.1",
+    "helmet": "^5.0.2",
     "ip": "^1.1.5",
     "moment": "^2.29.1",
-    "parse-url": "^5.0.2",
-    "pino": "^6.11.2",
+    "parse-url": "^5.0.7",
+    "pino": "^6.14.0",
+    "short-uuid": "^4.2.0",
     "to-snake-case": "^1.0.0",
     "uuid": "^8.3.2",
     "verify-aws-sns-signature": "^0.0.6",
+    "ws": "^8.5.0",
     "xml2js": "^0.4.23"
   },
   "devDependencies": {
@@ -55,5 +60,9 @@
     "eslint-plugin-promise": "^4.3.1",
     "nyc": "^15.1.0",
     "tape": "^5.2.2"
+  },
+  "optionalDependencies": {
+    "bufferutil": "^4.0.6",
+    "utf-8-validate": "^5.0.8"
   }
 }

test/docker-compose-testbed.yaml

@@ -9,6 +9,7 @@ networks:
 services:
   mysql:
     image: mysql:5.7
+    platform: linux/x86_64
     ports:
       - "3360:3306"
     environment: 
@@ -123,7 +124,7 @@ services:
         ipv4_address: 172.38.0.63
 
   influxdb:
-    image: influxdb:1.8-alpine
+    image: influxdb:1.8
     ports:
       - "8086:8086"
     networks: