proper shut down in K8S (#254)

* when clearing stack on background gather (bargein), search to see if there is a config further down the stack that turns bargein off, and if so clear only down to there (#220)

* avoid clearing the stack twice when a background gather bargein occurs

* fix bug from prev commit

.github/workflows/build.yml

@@ -1,16 +1,15 @@
 name: CI
 
-on:
-  push:
+on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: lts/*
       - run: npm ci
       - run: npm run jslint
       - run: docker pull drachtio/sipp
@@ -20,3 +19,5 @@ jobs:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_REGION: ${{ secrets.AWS_REGION }}
+          MICROSOFT_REGION: ${{ secrets.MICROSOFT_REGION }}
+          MICROSOFT_API_KEY: ${{ secrets.MICROSOFT_API_KEY }}

.github/workflows/docker-publish.yml

@@ -20,7 +20,7 @@ jobs:
     if: github.event_name == 'push'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Build image
         run: docker build . --file Dockerfile --tag $IMAGE_NAME

.gitignore

@@ -40,4 +40,5 @@ examples/*
 ecosystem.config.js
 .vscode
 test/credentials/*.json
-run-tests.sh
+run-tests.sh
+run-coverage.sh

Dockerfile

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

app.js

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

data/example-voicemail-greetings.json

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

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

@@ -3,7 +3,7 @@ const makeTask = require('../../tasks/make_task');
 const RestCallSession = require('../../session/rest-call-session');
 const CallInfo = require('../../session/call-info');
 const {CallDirection, CallStatus} = require('../../utils/constants');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const SipError = require('drachtio-srf').SipError;
 const sysError = require('./error');
 const HttpRequestor = require('../../utils/http-requestor');
@@ -41,7 +41,8 @@ router.post('/', async(req, res) => {
       'X-Jambonz-Routing': target.type,
       'X-Jambonz-FS-UUID': srf.locals.fsUUID,
       'X-Call-Sid': callSid,
-      'X-Account-Sid': accountSid
+      'X-Account-Sid': accountSid,
+      ...(restDial.fromHost && {'X-Preferred-From-Host': restDial.fromHost})
     };
 
     switch (target.type) {
@@ -135,7 +136,7 @@ router.post('/', async(req, res) => {
     }
     else if (!app.notifier) {
       logger.debug('creating null call status hook');
-      app.notifier = {request: () => {}};
+      app.notifier = {request: () => {}, close: () => {}};
     }
 
     /* now launch the outdial */

lib/http-routes/api/messaging.js

@@ -34,6 +34,7 @@ router.post('/:partner', async(req, res) => {
     carrier: req.params.partner,
     messageSid: app.messageSid,
     accountSid: app.accountSid,
+    serviceProviderSid: account.service_provider_sid,
     applicationSid: app.applicationSid,
     from: req.body.from,
     to: req.body.to,

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

@@ -41,7 +41,7 @@ function retrieveCallSession(callSid, opts) {
 router.post('/:callSid', async(req, res) => {
   const logger = req.app.locals.logger;
   const callSid = req.params.callSid;
-  logger.debug({body: req.body}, 'got upateCall request');
+  logger.debug({body: req.body}, 'got updateCall request');
   try {
     const cs = retrieveCallSession(callSid, req.body);
     if (!cs) {

lib/middleware.js

@@ -1,4 +1,4 @@
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const {CallDirection, AllowedSipRecVerbs} = require('./utils/constants');
 const {parseSiprecPayload} = require('./utils/siprec-utils');
 const CallInfo = require('./session/call-info');
@@ -118,6 +118,7 @@ module.exports = function(srf, logger) {
     const {span} = rootSpan.startChildSpan('lookupAccountDetails');
     try {
       req.locals.accountInfo = await lookupAccountDetails(account_sid);
+      req.locals.service_provider_sid = req.locals.accountInfo?.account?.service_provider_sid;
       span.end();
       if (!req.locals.accountInfo.account.is_active) {
         logger.info(`Account is inactive or suspended ${account_sid}`);
@@ -224,29 +225,32 @@ module.exports = function(srf, logger) {
       * create a requestor that we will use for all http requests we make during the call.
       * also create a notifier for call status events (if not needed, its a no-op).
       */
+
+      /* allow for caching data - when caching treat retrieved data as immutable */
+      const app2 = process.env.JAMBONES_MYSQL_REFRESH_TTL ? JSON.parse(JSON.stringify(app)) : app;
       if ('WS' === app.call_hook?.method ||
         app.call_hook?.url.startsWith('ws://') || app.call_hook?.url.startsWith('wss://')) {
-        app.requestor = new WsRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret) ;
-        app.notifier = app.requestor;
-        app.call_hook.method = 'WS';
+        app2.requestor = new WsRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret) ;
+        app2.notifier = app.requestor;
+        app2.call_hook.method = 'WS';
       }
       else {
-        app.requestor = new HttpRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret);
-        if (app.call_status_hook) app.notifier = new HttpRequestor(logger, account_sid, app.call_status_hook,
+        app2.requestor = new HttpRequestor(logger, account_sid, app.call_hook, accountInfo.account.webhook_secret);
+        if (app.call_status_hook) app2.notifier = new HttpRequestor(logger, account_sid, app.call_status_hook,
           accountInfo.account.webhook_secret);
-        else app.notifier = {request: () => {}};
+        else app2.notifier = {request: () => {}};
       }
 
-      req.locals.application = app;
-      const obj = Object.assign({}, app);
-      delete obj.requestor;
-      delete obj.notifier;
+      req.locals.application = app2;
+
       // eslint-disable-next-line no-unused-vars
-      const {call_hook, call_status_hook, ...appInfo} = obj;  // mask sensitive data like user/pass on webhook
-      logger.info({app: appInfo}, `retrieved application for incoming call to ${req.locals.calledNumber}`);
+      const {call_hook, call_status_hook, ...appInfo} = app;  // mask sensitive data like user/pass on webhook
+      // eslint-disable-next-line no-unused-vars
+      const {requestor, notifier, ...loggable} = appInfo;
+      logger.info({app: loggable}, `retrieved application for incoming call to ${req.locals.calledNumber}`);
       req.locals.callInfo = new CallInfo({
         req,
-        app,
+        app: app2,
         direction: CallDirection.Inbound,
         traceId: rootSpan.traceId
       });
@@ -273,7 +277,9 @@ module.exports = function(srf, logger) {
       }
       /* retrieve the application to execute for this inbound call */
       const params = Object.assign(['POST', 'WS'].includes(app.call_hook.method) ? {sip: req.msg} : {},
-        req.locals.callInfo, {
+        req.locals.callInfo,
+        {service_provider_sid: req.locals.service_provider_sid},
+        {
           defaults: {
             synthesizer: {
               vendor: app.speech_synthesis_vendor,

lib/session/call-info.js

@@ -1,6 +1,6 @@
 const {CallDirection, CallStatus} = require('../utils/constants');
 const parseUri = require('drachtio-srf').parseUri;
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 /**
  * @classdesc Represents the common information for all calls
  * that is provided in call status webhooks
@@ -11,6 +11,7 @@ class CallInfo {
     let srf;
     this.direction = opts.direction;
     this.traceId = opts.traceId;
+    this.callTerminationBy = undefined;
     if (opts.req) {
       const u = opts.req.getParsedHeader('from');
       const uri = parseUri(u.uri);
@@ -119,7 +120,7 @@ class CallInfo {
       applicationSid: this.applicationSid,
       fsSipAddress: this.localSipAddress
     };
-    ['parentCallSid', 'originatingSipIp', 'originatingSipTrunkName'].forEach((prop) => {
+    ['parentCallSid', 'originatingSipIp', 'originatingSipTrunkName', 'callTerminationBy'].forEach((prop) => {
       if (this[prop]) obj[prop] = this[prop];
     });
     if (typeof this.duration === 'number') obj.duration = this.duration;

lib/session/call-session.js

@@ -83,6 +83,10 @@ class CallSession extends Emitter {
 
     this.requestor.on('command', this._onCommand.bind(this));
     this.requestor.on('connection-dropped', this._onWsConnectionDropped.bind(this));
+    this.requestor.on('handover', (newRequestor) => {
+      this.logger.info(`handover to new base url ${newRequestor.url}`);
+      this.application.requestor = newRequestor;
+    });
   }
 
   /**
@@ -286,6 +290,18 @@ class CallSession extends Emitter {
     return this._globalAltLanguages;
   }
 
+  set globalSttPunctuation(punctuate) {
+    this._globalSttPunctuation = punctuate;
+  }
+
+  get globalSttPunctuation() {
+    return this._globalSttPunctuation;
+  }
+
+  hasGlobalSttPunctuation() {
+    return this._globalSttPunctuation !== undefined;
+  }
+
   async notifyRecordOptions(opts) {
     const {action} = opts;
     this.logger.debug({opts}, 'CallSession:notifyRecordOptions');
@@ -433,14 +449,18 @@ class CallSession extends Emitter {
 
   async enableBotMode(gather, autoEnable) {
     try {
+      if (this.backgroundGatherTask) {
+        this.logger.info('CallSession:enableBotMode - bot mode currently enabled, ignoring request to start again');
+        return;
+      }
       const t = normalizeJambones(this.logger, [gather]);
       this.backgroundGatherTask = makeTask(this.logger, t[0]);
       this._bargeInEnabled = true;
       this.backgroundGatherTask
-        .once('dtmf', this._clearTasks.bind(this))
-        .once('vad', this._clearTasks.bind(this))
-        .once('transcription', this._clearTasks.bind(this))
-        .once('timeout', this._clearTasks.bind(this));
+        .once('dtmf', this._clearTasks.bind(this, this.backgroundGatherTask))
+        .once('vad', this._clearTasks.bind(this, this.backgroundGatherTask))
+        .once('transcription', this._clearTasks.bind(this, this.backgroundGatherTask))
+        .once('timeout', this._clearTasks.bind(this, this.backgroundGatherTask));
       this.logger.info({gather}, 'CallSession:enableBotMode - starting background gather');
       const resources = await this._evaluatePreconditions(this.backgroundGatherTask);
       const {span, ctx} = this.rootSpan.startChildSpan(`background-gather:${this.backgroundGatherTask.summary}`);
@@ -537,7 +557,11 @@ class CallSession extends Emitter {
           return {
             speech_credential_sid: credential.speech_credential_sid,
             api_key: credential.api_key,
-            region: credential.region
+            region: credential.region,
+            use_custom_stt: credential.use_custom_stt,
+            custom_stt_endpoint: credential.custom_stt_endpoint,
+            use_custom_tts: credential.use_custom_tts,
+            custom_tts_endpoint: credential.custom_tts_endpoint
           };
         }
         else if ('wellsaid' === vendor) {
@@ -572,13 +596,19 @@ class CallSession extends Emitter {
       this.logger.info(`CallSession:exec starting task #${stackNum}:${taskNum}: ${task.name}`);
       try {
         const resources = await this._evaluatePreconditions(task);
+        let skip = false;
         this.currentTask = task;
         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);
+          if (this.backgroundGatherTask.updateTaskInProgress(task)) {
+            this.logger.info(`CallSession:exec skipping #${stackNum}:${taskNum}: ${task.name}`);
+            skip = true;
+          }
+          else {
+            this.logger.info('CallSession:exec disabling bot mode to start gather with new options');
+            this.disableBotMode();
+          }
         }
-        else {
+        if (!skip) {
           const {span, ctx} = this.rootSpan.startChildSpan(`verb:${task.summary}`);
           task.span = span;
           task.ctx = ctx;
@@ -626,6 +656,7 @@ class CallSession extends Emitter {
     this._onTasksDone();
     this._clearResources();
 
+
     if (!this.isConfirmCallSession && !this.isSmsCallSession) sessionTracker.remove(this.callSid);
   }
 
@@ -968,14 +999,32 @@ class CallSession extends Emitter {
     }
   }
 
-  kill() {
+  kill(onBackgroundGatherBargein = false) {
     if (this.isConfirmCallSession) this.logger.debug('CallSession:kill (ConfirmSession)');
     else this.logger.info('CallSession:kill');
     if (this.currentTask) {
       this.currentTask.kill(this);
       this.currentTask = null;
     }
-    this.tasks = [];
+    if (onBackgroundGatherBargein) {
+      /* search for a config with bargein disabled */
+      while (this.tasks.length) {
+        const t = this.tasks[0];
+        if (t.name === TaskName.Config && t.bargeIn?.enable === false) {
+          /* found it, clear to that point and remove the disable
+            because we likely already received a partial transcription
+            and we don't want to kill the background gather before we
+            get the full transcription.
+          */
+          delete t.bargeIn.enable;
+          this._bargeInEnabled = false;
+          this.logger.info('CallSession:kill - found bargein disabled in the stack, clearing to that point');
+          break;
+        }
+        this.tasks.shift();
+      }
+    }
+    else this.tasks = [];
     this.taskIdx = 0;
   }
 
@@ -1146,7 +1195,12 @@ class CallSession extends Emitter {
     // need to allocate an endpoint
     try {
       if (!this.ms) this.ms = this.getMS();
-      const ep = await this.ms.createEndpoint({remoteSdp: this.req.body});
+      const ep = await this.ms.createEndpoint({
+        headers: {
+          'X-Jambones-Call-ID': this.callId,
+        },
+        remoteSdp: this.req.body
+      });
       //ep.cs = this;
       this.ep = ep;
       ep.set({
@@ -1176,6 +1230,7 @@ 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.callInfo.callTerminationBy = 'caller';
         this._notifyCallStatusChange({
           callStatus: CallStatus.NoAnswer,
           sipStatus: 487,
@@ -1253,6 +1308,7 @@ class CallSession extends Emitter {
     }
     this.tmpFiles.clear();
     this.requestor && this.requestor.close();
+    this.notifier && this.notifier.close();
 
     this.rootSpan && this.rootSpan.end();
   }
@@ -1290,7 +1346,8 @@ class CallSession extends Emitter {
       this.dlg = await this.srf.createUAS(this.req, this.res, {
         headers: {
           'X-Trace-ID': this.req.locals.traceId,
-          'X-Call-Sid': this.req.locals.callSid
+          'X-Call-Sid': this.req.locals.callSid,
+          ...(this.applicationSid && {'X-Application-Sid': this.applicationSid})
         },
         localSdp: this.ep.local.sdp
       });
@@ -1444,7 +1501,8 @@ class CallSession extends Emitter {
       headers: {
         'Refer-To': referTo,
         'Referred-By': `sip:${this.srf.locals.localSipAddress}`,
-        'X-Retain-Call-Sid': this.callSid
+        'X-Retain-Call-Sid': this.callSid,
+        'X-Account-Sid': this.accountSid
       }
     });
     if ([200, 202].includes(res.status)) {
@@ -1482,8 +1540,9 @@ class CallSession extends Emitter {
         dlg.connected = false;
         dlg.destroy = origDestroy;
         const duration = moment().diff(this.dlg.connectTime, 'seconds');
+        this.callInfo.callTerminationBy = 'jambonz';
         this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
-        this.logger.debug('CallSession: call terminated by jambones');
+        this.logger.debug('CallSession: call terminated by jambonz');
         this.rootSpan.setAttributes({'call.termination': 'hangup by jambonz'});
         origDestroy().catch((err) => this.logger.info({err}, 'CallSession - error destroying dialog'));
         if (this.wakeupResolver) {
@@ -1532,7 +1591,7 @@ class CallSession extends Emitter {
    * @param {number} sipStatus - current sip status
    * @param {number} [duration] - duration of a completed call, in seconds
    */
-  _notifyCallStatusChange({callStatus, sipStatus, sipReason, duration}) {
+  async _notifyCallStatusChange({callStatus, sipStatus, sipReason, duration}) {
     if (this.callMoved) return;
 
     /* race condition: we hang up at the same time as the caller */
@@ -1552,7 +1611,7 @@ class CallSession extends Emitter {
     try {
       const b3 = this.b3;
       const httpHeaders = b3 && {b3};
-      this.notifier.request('call:status', this.call_status_hook, this.callInfo.toJSON(), httpHeaders);
+      await this.notifier.request('call:status', this.call_status_hook, this.callInfo.toJSON(), httpHeaders);
       span.end();
     } catch (err) {
       span.end();
@@ -1573,11 +1632,12 @@ class CallSession extends Emitter {
     });
   }
 
-  _clearTasks(evt) {
-    if (this.requestor instanceof WsRequestor) {
+  _clearTasks(backgroundGather, evt) {
+    if (this.requestor instanceof WsRequestor && !backgroundGather.cleared) {
       this.logger.info({evt}, 'CallSession:_clearTasks on event from background gather');
       try {
-        this.kill();
+        backgroundGather.cleared = true;
+        this.kill(true);
       } catch (err) {}
     }
   }

lib/session/inbound-call-session.js

@@ -34,6 +34,7 @@ class InboundCallSession extends CallSession {
 
   _onCancel() {
     this.rootSpan.setAttributes({'call.termination': 'caller abandoned'});
+    this.callInfo.callTerminationBy = 'caller';
     this._notifyCallStatusChange({
       callStatus: CallStatus.NoAnswer,
       sipStatus: 487,
@@ -69,6 +70,7 @@ class InboundCallSession extends CallSession {
     assert(this.dlg.connectTime);
     const duration = moment().diff(this.dlg.connectTime, 'seconds');
     this.rootSpan.setAttributes({'call.termination': 'hangup by caller'});
+    this.callInfo.callTerminationBy = 'caller';
     this.emit('callStatusChange', {
       callStatus: CallStatus.Completed,
       duration

lib/session/rest-call-session.js

@@ -44,6 +44,7 @@ class RestCallSession extends CallSession {
    * This is invoked when the called party hangs up, in order to calculate the call duration.
    */
   _callerHungup() {
+    this.callInfo.callTerminationBy = 'caller';
     const duration = moment().diff(this.dlg.connectTime, 'seconds');
     this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
     this.logger.debug('RestCallSession: called party hung up');

lib/session/siprec-call-session.js

@@ -36,7 +36,8 @@ class SipRecCallSession extends InboundCallSession {
         headers: {
           'Content-Type': 'application/sdp',
           'X-Trace-ID': this.req.locals.traceId,
-          'X-Call-Sid': this.req.locals.callSid
+          'X-Call-Sid': this.req.locals.callSid,
+          ...(this.applicationSid && {'X-Application-Sid': this.applicationSid})
         },
         localSdp: combinedSdp
       });

lib/tasks/config.js

@@ -26,7 +26,7 @@ class TaskConfig extends Task {
       });
     }
     if (this.bargeIn.sticky) this.autoEnable = true;
-    this.preconditions = (this.bargeIn.enable || this.record?.action) ?
+    this.preconditions = (this.bargeIn.enable || this.record?.action || this.data.amd) ?
       TaskPreconditions.Endpoint :
       TaskPreconditions.None;
   }
@@ -54,13 +54,20 @@ class TaskConfig extends Task {
     return  `${this.name}{${phrase.join(',')}`;
   }
 
-  async exec(cs) {
+  async exec(cs, {ep} = {}) {
     await super.exec(cs);
 
     if (this.data.amd) {
       this.startAmd = cs.startAmd;
       this.stopAmd = cs.stopAmd;
       this.on('amd', this._onAmdEvent.bind(this, cs));
+
+      try {
+        this.ep = ep;
+        this.startAmd(cs, ep, this, this.data.amd);
+      } catch (err) {
+        this.logger.info({err}, 'Config:exec - Error calling startAmd');
+      }
     }
 
     if (this.hasSynthesizer) {
@@ -98,6 +105,9 @@ class TaskConfig extends Task {
         this.logger.info({altLanguages: this.recognizer.altLanguages}, 'Config: updated altLanguages');
         cs.altLanguages = this.recognizer.altLanguages;
       }
+      if ('punctuation' in this.recognizer) {
+        cs.globalSttPunctuation = this.recognizer.punctuation;
+      }
       this.logger.info({
         recognizer: this.recognizer,
         isContinuousAsr: cs.isContinuousAsr
@@ -130,12 +140,17 @@ class TaskConfig extends Task {
 
   async kill(cs) {
     super.kill(cs);
+    if (this.ep && this.stopAmd) this.stopAmd(this.ep, this);
   }
 
   _onAmdEvent(cs, evt) {
     this.logger.info({evt}, 'Config:_onAmdEvent');
     const {actionHook} = this.data.amd;
-    this.performHook(cs, actionHook, evt);
+    this.performHook(cs, actionHook, evt)
+      .catch((err) => {
+        this.logger.error({err}, 'Config:_onAmdEvent - error calling actionHook');
+      });
+
   }
 }
 

lib/tasks/dial.js

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

lib/tasks/gather.js

@@ -82,6 +82,8 @@ class TaskGather extends Task {
       this.requestSnr = recognizer.requestSnr || false;
       this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
       this.azureServiceEndpoint = recognizer.azureServiceEndpoint;
+      this.azureSttEndpointId = recognizer.azureSttEndpointId;
+      this.azureAudioLogging = recognizer.audioLogging;
     }
     else {
       this.hints = [];
@@ -146,6 +148,9 @@ class TaskGather extends Task {
       this.logger.debug({altLanguages: this.altLanguages},
         'Gather:exec - applying altLanguages');
     }
+    if (cs.hasGlobalSttPunctuation) {
+      this.punctuation = cs.globalSttPunctuation;
+    }
     if (!this.isContinuousAsr && cs.isContinuousAsr) {
       this.isContinuousAsr = true;
       this.asrTimeout = cs.asrTimeout * 1000;
@@ -155,6 +160,14 @@ class TaskGather extends Task {
         asrDtmfTerminationDigit: this.asrDtmfTerminationDigit
       }, 'Gather:exec - enabling continuous ASR since it is turned on for the session');
     }
+    if (process.env.JAMBONZ_GATHER_EARLY_HINTS_MATCH &&
+      !this.isContinuousAsr &&
+      this.hints.length > 0 && this.hints.length <= 10) {
+      this.earlyHintsMatch = true;
+      this.interim = true;
+      this.logger.debug('Gather:exec - early hints match enabled');
+    }
+
     this.ep = ep;
     if ('default' === this.vendor || !this.vendor) this.vendor = cs.speechRecognizerVendor;
     if ('default' === this.language || !this.language) this.language = cs.speechRecognizerLanguage;
@@ -173,10 +186,15 @@ class TaskGather extends Task {
 
     const startListening = (cs, ep) => {
       this._startTimer();
-      if (this.isContinuousAsr && 0 === this.timeout) this._startAsrTimer();
+      // dont start asr timer until we have a transcription
+      //if (this.isContinuousAsr && 0 === this.timeout) this._startAsrTimer();
       if (this.input.includes('speech') && !this.listenDuringPrompt) {
         this._initSpeech(cs, ep)
           .then(() => {
+            if (this.killed) {
+              this.logger.info('Gather:exec - task was quickly killed so do not transcribe');
+              return;
+            }
             this._startTranscribing(ep);
             return updateSpeechCredentialLastUsed(this.sttCredentials.speech_credential_sid);
           })
@@ -209,7 +227,13 @@ class TaskGather extends Task {
           if (!this.killed) startListening(cs, ep);
         });
       }
-      else startListening(cs, ep);
+      else {
+        if (this.killed) {
+          this.logger.info('Gather:exec - task was immediately killed so do not transcribe');
+          return;
+        }
+        startListening(cs, ep);
+      }
 
       if (this.input.includes('speech') && this.listenDuringPrompt) {
         await this._initSpeech(cs, ep);
@@ -246,10 +270,15 @@ class TaskGather extends Task {
     this._resolve('killed');
   }
 
-  updateTimeout(timeout) {
-    this.logger.info(`TaskGather:updateTimeout - updating timeout to ${timeout}`);
+  updateTaskInProgress(opts) {
+    if (!this.needsStt && opts.input.includes('speech')) {
+      this.logger.info('TaskGather:updateTaskInProgress - adding speech to a background gather');
+      return false; // this needs be handled by killing the background gather and starting a new one
+    }
+    const {timeout} = opts;
     this.timeout = timeout;
     this._startTimer();
+    return true;
   }
 
   _onDtmf(cs, ep, evt) {
@@ -298,7 +327,7 @@ class TaskGather extends Task {
     }
 
     if ('google' === this.vendor) {
-      this.bugname = 'google_trancribe';
+      this.bugname = 'google_transcribe';
       if (this.sttCredentials) opts.GOOGLE_APPLICATION_CREDENTIALS = JSON.stringify(this.sttCredentials.credentials);
       [
         ['enhancedModel', 'GOOGLE_SPEECH_USE_ENHANCED'],
@@ -310,6 +339,7 @@ class TaskGather extends Task {
         ['diarization', 'GOOGLE_SPEECH_PROFANITY_FILTER']
       ].forEach((arr) => {
         if (this[arr[0]]) opts[arr[1]] = true;
+        else if (this[arr[0]] === false) opts[arr[1]] = false;
       });
       if (this.hints.length > 0) {
         opts.GOOGLE_SPEECH_HINTS = this.hints.join(',');
@@ -335,7 +365,7 @@ class TaskGather extends Task {
       ep.addCustomEventListener(GoogleTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
     }
     else if (['aws', 'polly'].includes(this.vendor)) {
-      this.bugname = 'aws_trancribe';
+      this.bugname = 'aws_transcribe';
       if (this.vocabularyName) opts.AWS_VOCABULARY_NAME = this.vocabularyName;
       if (this.vocabularyFilterName) {
         opts.AWS_VOCABULARY_NAME = this.vocabularyFilterName;
@@ -352,12 +382,20 @@ class TaskGather extends Task {
       ep.addCustomEventListener(AwsTranscriptionEvents.VadDetected, this._onVadDetected.bind(this, cs, ep));
     }
     else if ('microsoft' === this.vendor) {
-      this.bugname = 'azure_trancribe';
+      this.bugname = 'azure_transcribe';
       if (this.sttCredentials) {
+        const {api_key, region, use_custom_stt, custom_stt_endpoint} = this.sttCredentials;
+
         Object.assign(opts, {
-          'AZURE_SUBSCRIPTION_KEY': this.sttCredentials.api_key,
-          'AZURE_REGION': this.sttCredentials.region
+          'AZURE_SUBSCRIPTION_KEY': api_key,
+          'AZURE_REGION': region
         });
+        if (this.azureSttEndpointId) {
+          Object.assign(opts, {'AZURE_SERVICE_ENDPOINT_ID': this.azureSttEndpointId});
+        }
+        else if (use_custom_stt && custom_stt_endpoint) {
+          Object.assign(opts, {'AZURE_SERVICE_ENDPOINT_ID': custom_stt_endpoint});
+        }
       }
       if (this.hints && this.hints.length > 0) {
         opts.AZURE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
@@ -368,6 +406,7 @@ class TaskGather extends Task {
       else {
         opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = '';
       }
+      if (this.azureAudioLogging) opts.AZURE_AUDIO_LOGGING = 1;
       if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
       if (this.profanityOption && this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
       if (this.azureServiceEndpoint) opts.AZURE_SERVICE_ENDPOINT = this.azureServiceEndpoint;
@@ -411,8 +450,7 @@ class TaskGather extends Task {
     if (0 === this.timeout) return;
     this._clearTimer();
     this._timeoutTimer = setTimeout(() => {
-      if (this.isContinuousAsr) this._startAsrTimer();
-      else this._resolve(this.digitBuffer.length >= this.minDigits ? 'dtmf-num-digits' : 'timeout');
+      this._resolve(this.digitBuffer.length >= this.minDigits ? 'dtmf-num-digits' : 'timeout');
     }, this.timeout);
   }
 
@@ -511,6 +549,15 @@ class TaskGather extends Task {
       }
     }
 
+    if (this.earlyHintsMatch && evt.is_final === false) {
+      const transcript = evt.alternatives[0].transcript?.toLowerCase();
+      if (this.hints.find((h) => h.toLowerCase() === transcript)) {
+        this.logger.debug({evt}, 'Gather:_onTranscription: early hint match');
+        this._resolve('speech', evt);
+        return;
+      }
+    }
+
     /* count words for bargein feature */
     const words = evt.alternatives[0].transcript.split(' ').length;
     const bufferedWords = this._bufferedTranscripts.reduce((count, e) => {
@@ -637,7 +684,7 @@ class TaskGather extends Task {
     }
 
     this.span.setAttributes({'stt.resolve': reason, 'stt.result': JSON.stringify(evt)});
-    if (this.ep && this.ep.connected) {
+    if (this.needsStt && this.ep && this.ep.connected) {
       this.ep.stopTranscription({vendor: this.vendor})
         .catch((err) => this.logger.error({err}, 'Error stopping transcription'));
     }

lib/tasks/hangup.js

@@ -18,6 +18,7 @@ class TaskHangup extends Task {
     await super.exec(cs);
     try {
       await dlg.destroy({headers: this.headers});
+      cs._callReleased();
     } catch (err) {
       this.logger.error(err, 'TaskHangup:exec - Error hanging up call');
     }

lib/tasks/message.js

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

lib/tasks/play.js

@@ -7,6 +7,8 @@ class TaskPlay extends Task {
     this.preconditions = TaskPreconditions.Endpoint;
 
     this.url = this.data.url;
+    this.seekOffset = this.data.seekOffset || -1;
+    this.timeoutSecs = this.data.timeoutSecs || -1;
     this.loop = this.data.loop || 1;
     this.earlyMedia = this.data.earlyMedia === true;
   }
@@ -31,8 +33,13 @@ class TaskPlay extends Task {
           } else {
             await this.playToConfMember(this.ep, memberId, confName, confUuid, this.url);
           }
+        } else {
+          const file = (this.timeoutSecs >= 0 || this.seekOffset >= 0) ?
+            {file: this.url, seekOffset: this.seekOffset, timeoutSecs: this.timeoutSecs} : this.url;
+          const result = await ep.play(file);
+          await this.performAction(Object.assign(result, {reason: 'playCompleted'}),
+            !(this.parentTask || cs.isConfirmCallSession));
         }
-        else await ep.play(this.url);
       }
     } catch (err) {
       this.logger.info(err, `TaskPlay:exec - error playing ${this.url}`);

lib/tasks/rest_dial.js

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

lib/tasks/say.js

@@ -1,12 +1,107 @@
 const Task = require('./task');
 const {TaskName, TaskPreconditions} = require('../utils/constants');
 
+const breakLengthyTextIfNeeded = (logger,  text) => {
+  const chunkSize = 1000;
+  if (text.length <= chunkSize) return [text];
+
+  const result = [];
+  const isSSML = text.startsWith('<speak>');
+  let startPos = 0;
+  let charPos = isSSML ? 7 : 0;  // skip <speak>
+  let tag;
+  //logger.debug({isSSML}, `breakLengthyTextIfNeeded: handling text of length ${text.length}`);
+  while (startPos + charPos < text.length) {
+    if (isSSML && !tag && text[startPos + charPos] === '<') {
+      const tagStartPos = ++charPos;
+      while (startPos + charPos < text.length) {
+        if (text[startPos + charPos] === '>') {
+          if (text[startPos + charPos - 1] === '\\') tag = null;
+          else if (!tag) tag = text.substring(startPos + tagStartPos, startPos + charPos - 1);
+          break;
+        }
+        if (!tag) {
+          const c = text[startPos + charPos];
+          if (c === ' ') {
+            tag = text.substring(startPos + tagStartPos, startPos + charPos);
+            //logger.debug(`breakLengthyTextIfNeeded: enter tag ${tag} (space)`);
+            break;
+          }
+        }
+        charPos++;
+      }
+      if (tag) {
+        //search for end of tag
+        //logger.debug(`breakLengthyTextIfNeeded: searching forward for </${tag}>`);
+        const e1 = text.indexOf(`</${tag}>`, startPos + charPos);
+        const e2 = text.indexOf('/>', startPos + charPos);
+        const tagEndPos = e1 === -1 ? e2 : e2 === -1 ? e1 : Math.min(e1, e2);
+        if (tagEndPos === -1) {
+          //logger.debug(`breakLengthyTextIfNeeded: exit tag ${tag} not found, exiting`);
+        } else {
+          //logger.debug(`breakLengthyTextIfNeeded: exit tag ${tag} found at ${tagEndPos}`);
+          charPos = tagEndPos + 1;
+        }
+        tag = null;
+      }
+      continue;
+    }
+
+    if (charPos < chunkSize) {
+      charPos++;
+      continue;
+    }
+
+    // start looking for a good break point
+    let chunkIt = false;
+    const a = text[startPos + charPos];
+    const b = text[startPos + charPos + 1];
+    if (/[\.!\?]/.test(a) && /\s/.test(b)) {
+      //logger.debug('breakLengthyTextIfNeeded: breaking at sentence end');
+      chunkIt = true;
+    }
+    if (chunkIt) {
+      charPos++;
+      const chunk = text.substr(startPos, charPos);
+      if (isSSML) {
+        result.push(0 === startPos ? `${chunk}</speak>` : `<speak>${chunk}</speak>`);
+      }
+      else result.push(chunk);
+      charPos = 0;
+      startPos += chunk.length;
+
+      //logger.debug({chunk: result[result.length - 1]},
+      //  `breakLengthyTextIfNeeded: chunked; new starting pos ${startPos}`);
+
+    }
+    else charPos++;
+  }
+
+  // final chunk
+  if (startPos < text.length) {
+    const chunk = text.substr(startPos);
+    if (isSSML) {
+      result.push(0 === startPos ? `${chunk}</speak>` : `<speak>${chunk}`);
+    }
+    else result.push(chunk);
+
+    //logger.debug({chunk: result[result.length - 1]},
+    //  `breakLengthyTextIfNeeded: final chunk; starting pos ${startPos} length ${chunk.length}`);
+
+  }
+
+  return result;
+};
+
 class TaskSay extends Task {
   constructor(logger, opts, parentTask) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
 
-    this.text = Array.isArray(this.data.text) ? this.data.text : [this.data.text];
+    this.text = (Array.isArray(this.data.text) ? this.data.text : [this.data.text])
+      .map((t) => breakLengthyTextIfNeeded(this.logger, t))
+      .flat();
+
     this.loop = this.data.loop || 1;
     this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
     this.synthesizer = this.data.synthesizer || {};
@@ -69,6 +164,10 @@ class TaskSay extends Task {
           'tts.voice': voice
         });
         try {
+          if (vendor === 'microsoft' && this.synthesizer.azureServiceEndpoint) {
+            credentials.use_custom_tts = true;
+            credentials.custom_tts_endpoint = this.synthesizer.azureServiceEndpoint;
+          }
           const {filePath, servedFromCache} = await synthAudio(stats, {
             text,
             vendor,

lib/tasks/sip_refer.js

@@ -36,6 +36,7 @@ class TaskSipRefer extends Task {
         method: 'REFER',
         headers: {
           ...this.headers,
+          ...(this.referToIsUri && {'X-Refer-To-Leave-Untouched': true}),
           'Refer-To': referTo,
           'Referred-By': referredBy
         }
@@ -46,7 +47,17 @@ class TaskSipRefer extends Task {
 
       /* if we fail, fall through to next verb.  If success, we should get BYE from far end */
       if (this.referStatus === 202) {
+        this._notifyTimer = setTimeout(() => {
+          this.logger.info('TaskSipRefer:exec - no NOTIFY received in 15 secs, exiting');
+          this.performAction({refer_status: this.referStatus})
+            .catch((err) => this.logger.error(err, 'TaskSipRefer:exec - error performing action'));
+          this.notifyTaskDone();
+        }, 15000);
         await this.awaitTaskDone();
+        if (this._notifyTimer) {
+          clearTimeout(this._notifyTimer);
+          this._notifyTimer = null;
+        }
       }
       else {
         await this.performAction({refer_status: this.referStatus});
@@ -70,10 +81,10 @@ class TaskSipRefer extends Task {
     const contentType = req.get('Content-Type');
     this.logger.debug({body: req.body}, `TaskSipRefer:_handleNotify got ${contentType}`);
 
-    if (contentType === 'message/sipfrag') {
+    if (contentType?.includes('message/sipfrag')) {
       const arr = /SIP\/2\.0\s+(\d+)/.exec(req.body);
       if (arr) {
-        const status = arr[1];
+        const status = typeof arr[1] === 'string' ? parseInt(arr[1], 10) : arr[1];
         this.logger.debug(`TaskSipRefer:_handleNotify: call got status ${status}`);
         if (this.eventHook) {
           const b3 = this.getTracingPropagation();
@@ -100,6 +111,7 @@ class TaskSipRefer extends Task {
       /* they may have only provided a phone number/user */
       referTo = `sip:${referTo}@${host}`;
     }
+    else this.referToIsUri = true;
     if (!referredBy) {
       /* default */
       referredBy = cs.req?.callingNumber || dlg.local.uri;

lib/tasks/specs.json

@@ -98,7 +98,10 @@
     "properties": {
       "url": "string|array",
       "loop": "number|string",
-      "earlyMedia": "boolean"
+      "earlyMedia": "boolean",
+      "seekOffset": "number|string",
+      "timeoutSecs": "number|string",
+      "actionHook": "object|string"
     },
     "required": [
       "url"
@@ -338,6 +341,7 @@
       "call_hook": "object|string",
       "call_status_hook": "object|string",
       "from": "string",
+      "fromHost": "string",
       "speech_synthesis_vendor": "string",
       "speech_synthesis_voice": "string",
       "speech_synthesis_language": "string",
@@ -384,6 +388,7 @@
         "enum": ["GET", "POST"]
       },
       "headers": "object",
+      "from": "#dialFrom",
       "name": "string",
       "number": "string",
       "sipUri": "string",
@@ -397,6 +402,14 @@
       "type"
     ]
   },
+  "dialFrom": {
+    "properties": {
+      "user": "string",
+      "host": "string"
+    },
+    "required": [
+    ]
+  },
   "auth": {
     "properties": {
       "username": "string",
@@ -422,7 +435,8 @@
       "gender": {
         "type": "string",
         "enum": ["MALE", "FEMALE", "NEUTRAL"]
-      }
+      },
+      "azureServiceEndpoint": "string"
     },
     "required": [
       "vendor"
@@ -494,8 +508,10 @@
       "requestSnr": "boolean",
       "initialSpeechTimeoutMs": "number",
       "azureServiceEndpoint": "string",
+      "azureSttEndpointId": "string",
       "asrDtmfTerminationDigit": "string",
-      "asrTimeout": "number"
+      "asrTimeout": "number",
+      "audioLogging": "boolean"
     },
     "required": [
       "vendor"

lib/tasks/task.js

@@ -1,5 +1,5 @@
 const Emitter = require('events');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const debug = require('debug')('jambonz:feature-server');
 const assert = require('assert');
 const {TaskPreconditions} = require('../utils/constants');
@@ -336,6 +336,9 @@ class Task extends Emitter {
         }
         required = required.filter((item) => item !== dKey);
       }
+      else if (dKey === '_') {
+        /* no op: allow arbitrary info to be carried here, used by conference e.g in transfer */
+      }
       else throw new Error(`${name}: unknown property ${dKey}`);
     }
     if (required.length > 0) throw new Error(`${name}: missing value for ${required}`);

lib/tasks/transcribe.js

@@ -54,6 +54,8 @@ class TaskTranscribe extends Task {
     this.requestSnr = recognizer.requestSnr || false;
     this.initialSpeechTimeoutMs = recognizer.initialSpeechTimeoutMs || 0;
     this.azureServiceEndpoint = recognizer.azureServiceEndpoint;
+    this.azureSttEndpointId = recognizer.azureSttEndpointId;
+    this.azureAudioLogging = recognizer.audioLogging;
   }
 
   get name() { return TaskName.Transcribe; }
@@ -74,6 +76,9 @@ class TaskTranscribe extends Task {
       this.logger.debug({altLanguages: this.altLanguages},
         'Gather:exec - applying altLanguages');
     }
+    if (cs.hasGlobalSttPunctuation) {
+      this.punctuation = cs.globalSttPunctuation;
+    }
 
     this.ep = ep;
     this.ep2 = ep2;
@@ -158,7 +163,7 @@ class TaskTranscribe extends Task {
     ep.addCustomEventListener(AzureTranscriptionEvents.NoSpeechDetected, this._onNoAudio.bind(this, cs, ep, channel));
 
     if (this.vendor === 'google') {
-      this.bugname = 'google_trancribe';
+      this.bugname = 'google_transcribe';
       if (this.sttCredentials) opts.GOOGLE_APPLICATION_CREDENTIALS = JSON.stringify(this.sttCredentials.credentials);
       [
         ['enhancedModel', 'GOOGLE_SPEECH_USE_ENHANCED'],
@@ -170,6 +175,7 @@ class TaskTranscribe extends Task {
         ['diarization', 'GOOGLE_SPEECH_PROFANITY_FILTER']
       ].forEach((arr) => {
         if (this[arr[0]]) opts[arr[1]] = true;
+        else if (this[arr[0]] === false) opts[arr[1]] = false;
       });
       if (this.hints.length > 0) {
         opts.GOOGLE_SPEECH_HINTS = this.hints.join(',');
@@ -195,7 +201,7 @@ class TaskTranscribe extends Task {
         .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with google'));
     }
     else if (this.vendor === 'aws') {
-      this.bugname = 'aws_trancribe';
+      this.bugname = 'aws_transcribe';
       [
         ['diarization', 'AWS_SHOW_SPEAKER_LABEL'],
         ['identifyChannels', 'AWS_ENABLE_CHANNEL_IDENTIFICATION']
@@ -227,16 +233,24 @@ class TaskTranscribe extends Task {
         .catch((err) => this.logger.info(err, 'TaskTranscribe:_startTranscribing with aws'));
     }
     else if (this.vendor === 'microsoft') {
-      this.bugname = 'azure_trancribe';
+      this.bugname = 'azure_transcribe';
+      const {api_key, region, use_custom_stt, custom_stt_endpoint} = this.sttCredentials;
       Object.assign(opts, {
-        'AZURE_SUBSCRIPTION_KEY': this.sttCredentials.api_key,
-        'AZURE_REGION': this.sttCredentials.region
+        'AZURE_SUBSCRIPTION_KEY': api_key,
+        'AZURE_REGION': region
       });
+      if (this.azureSttEndpointId) {
+        Object.assign(opts, {'AZURE_SERVICE_ENDPOINT_ID': this.azureSttEndpointId});
+      }
+      else if (use_custom_stt && custom_stt_endpoint) {
+        Object.assign(opts, {'AZURE_SERVICE_ENDPOINT_ID': custom_stt_endpoint});
+      }
       if (this.hints && this.hints.length > 0) {
         opts.AZURE_SPEECH_HINTS = this.hints.map((h) => h.trim()).join(',');
       }
       if (this.altLanguages.length > 0) opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = this.altLanguages.join(',');
       else opts.AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES = '';
+      if (this.azureAudioLogging) opts.AZURE_AUDIO_LOGGING = 1;
       if (this.requestSnr) opts.AZURE_REQUEST_SNR = 1;
       if (this.profanityOption !== 'raw') opts.AZURE_PROFANITY_OPTION = this.profanityOption;
       if (this.initialSpeechTimeoutMs > 0) opts.AZURE_INITIAL_SPEECH_TIMEOUT_MS = this.initialSpeechTimeoutMs;

lib/utils/amd-utils.js

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

lib/utils/aws-sns-lifecycle.js

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

lib/utils/cron-jobs.js

@@ -42,9 +42,9 @@ const clearChannels = () => {
 };
 
 const clearFiles = () => {
-  const {logger} = require('../..');
-  const out = execSync('find /tmp -name "*.mp3" -mtime +2 -exec rm {} \\;');
-  logger.debug({out}, 'clearFiles: command output');
+  //const {logger} = require('../..');
+  /*const out = */ execSync('find /tmp -name "*.mp3" -mtime +2 -exec rm {} \\;');
+  //logger.debug({out}, 'clearFiles: command output');
 };
 
 

lib/utils/db-utils.js

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

lib/utils/http-listener.js

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

lib/utils/http-requestor.js

@@ -28,9 +28,11 @@ class HttpRequestor extends BaseRequestor {
     assert(['GET', 'POST'].includes(this.method));
 
     const u = this._parsedUrl = parseUrl(this.url);
-    this._baseUrl = `${u.protocol}://${u.resource}`;
-    this._resource = u.resource;
+    if (u.port) this._baseUrl = `${u.protocol}://${u.resource}:${u.port}`;
+    else this._baseUrl = `${u.protocol}://${u.resource}`;
     this._protocol = u.protocol;
+    this._resource = u.resource;
+    this._port = u.port;
     this._search = u.search;
     this._usePools = process.env.HTTP_POOL && parseInt(process.env.HTTP_POOL);
 
@@ -49,7 +51,10 @@ class HttpRequestor extends BaseRequestor {
         this.logger.debug(`HttpRequestor:created pool for ${this._baseUrl}`);
       }
     }
-    else this.client = new Client(`${u.protocol}://${u.resource}`);
+    else {
+      if (u.port) this.client = new Client(`${u.protocol}://${u.resource}:${u.port}`);
+      else this.client = new Client(`${u.protocol}://${u.resource}`);
+    }
   }
 
   get baseUrl() {
@@ -95,13 +100,14 @@ class HttpRequestor extends BaseRequestor {
       }
       else {
         const u = parseUrl(url);
-        if (u.resource === this._resource && u.protocol === this._protocol) {
+        if (u.resource === this._resource && u.port === this._port && u.protocol === this._protocol) {
           client = this.client;
           path = u.pathname;
           query = u.query;
         }
         else {
-          client = newClient = new Client(`${u.protocol}://${u.resource}`);
+          if (u.port) client = newClient = new Client(`${u.protocol}://${u.resource}:${u.port}`);
+          else client = newClient = new Client(`${u.protocol}://${u.resource}`);
           path = u.pathname;
           query = u.query;
         }

lib/utils/place-outdial.js

@@ -12,7 +12,7 @@ const deepcopy = require('deepcopy');
 const moment = require('moment');
 const stripCodecs = require('./strip-ancillary-codecs');
 const RootSpan = require('./call-tracer');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 
 class SingleDialer extends Emitter {
   constructor({logger, sbcAddress, target, opts, application, callInfo, accountInfo, rootSpan, startSpan}) {
@@ -21,6 +21,7 @@ class SingleDialer extends Emitter {
 
     this.logger = logger;
     this.target = target;
+    this.from = target.from || {};
     this.sbcAddress = sbcAddress;
     this.opts = opts;
     this.application = application;
@@ -66,8 +67,11 @@ class SingleDialer extends Emitter {
     opts.headers = {
       ...opts.headers,
       ...(this.target.headers || {}),
+      ...(this.from.user && {'X-Preferred-From-User': this.from.user}),
+      ...(this.from.host && {'X-Preferred-From-Host': this.from.host}),
       'X-Jambonz-Routing': this.target.type,
-      'X-Call-Sid': this.callSid
+      'X-Call-Sid': this.callSid,
+      ...(this.applicationSid && {'X-Application-Sid': this.applicationSid})
     };
     if (srf.locals.fsUUID) {
       opts.headers = {
@@ -408,7 +412,7 @@ class SingleDialer extends Emitter {
       this.callInfo.updateCallStatus(callStatus, sipStatus, sipReason);
       if (typeof duration === 'number') this.callInfo.duration = duration;
       try {
-        this.requestor.request('call:status', this.application.call_status_hook, this.callInfo.toJSON());
+        this.notifier.request('call:status', this.application.call_status_hook, this.callInfo.toJSON());
       } catch (err) {
         this.logger.info(err, `SingleDialer:_notifyCallStatusChange error sending ${callStatus} ${sipStatus}`);
       }

lib/utils/requestor.js

@@ -1,42 +1,7 @@
-const bent = require('bent');
-const parseUrl = require('parse-url');
 const assert = require('assert');
-const snakeCaseKeys = require('./snakecase-keys');
-const crypto = require('crypto');
 const timeSeries = require('@jambonz/time-series');
 let alerter ;
 
-const toBase64 = (str) => Buffer.from(str || '', 'utf8').toString('base64');
-
-function computeSignature(payload, timestamp, secret) {
-  assert(secret);
-  const data = `${timestamp}.${JSON.stringify(payload)}`;
-  return crypto
-    .createHmac('sha256', secret)
-    .update(data, 'utf8')
-    .digest('hex');
-}
-
-function generateSigHeader(payload, secret) {
-  const timestamp = Math.floor(Date.now() / 1000);
-  const signature = computeSignature(payload, timestamp, secret);
-  const scheme = 'v1';
-  return {
-    'Jambonz-Signature': `t=${timestamp},${scheme}=${signature}`
-  };
-}
-
-function basicAuth(username, password) {
-  if (!username || !password) return {};
-  const creds = `${username}:${password || ''}`;
-  const header = `Basic ${toBase64(creds)}`;
-  return {Authorization: header};
-}
-
-function isRelativeUrl(u) {
-  return typeof u === 'string' && u.startsWith('/');
-}
-
 function isAbsoluteUrl(u) {
   return typeof u === 'string' &&
     u.startsWith('https://') || u.startsWith('http://');
@@ -49,14 +14,6 @@ class Requestor {
     this.logger = logger;
     this.url = hook.url;
     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);
 
     this.username = hook.username;
     this.password = hook.password;
@@ -78,72 +35,15 @@ class Requestor {
     }
   }
 
-  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(hook, params) {
-    const payload = params ? snakeCaseKeys(params, ['customerData', 'sip']) : null;
-    const url = hook.url || hook;
-    const method = hook.method || 'POST';
-
-    assert.ok(url, 'Requestor:request url was not provided');
-    assert.ok, (['GET', 'POST'].includes(method), `Requestor: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}, `Requestor:request ${method} ${url}`);
-    const startAt = process.hrtime();
-
-    let buf;
-    try {
-      const sigHeader = generateSigHeader(payload, this.secret);
-      const headers = {...sigHeader, ...this.authHeader};
-      //this.logger.info({url, headers}, 'send webhook');
-      buf = isRelativeUrl(url) ?
-        await this.post(url, payload, headers) :
-        await bent(method, 'buffer', 200, 201, 202)(url, payload, headers);
-    } catch (err) {
-      this.logger.error({err, secret: this.secret, baseUrl: this.baseUrl, url, statusCode: err.statusCode},
-        `web callback returned unexpected error code ${err.statusCode}`);
-      let opts = {account_sid: this.account_sid};
-      if (err.code === 'ECONNREFUSED') {
-        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url};
-      }
-      else if (err.name === 'StatusError') {
-        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_STATUS_FAILURE, url, status: err.statusCode};
-      }
-      else {
-        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url, detail: err.message};
-      }
-      alerter.writeAlerts(opts).catch((err) => this.logger.info({err, opts}, 'Error writing alert'));
-
-      throw err;
-    }
-    const diff = process.hrtime(startAt);
-    const time = diff[0] * 1e3 + diff[1] * 1e-6;
-    const rtt = time.toFixed(0);
-    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}, `Requestor:request ${method} ${url} succeeded in ${rtt}ms`);
-        return json;
-      }
-      catch (err) {
-        //this.logger.debug({err, url, method}, `Requestor:request returned non-JSON content: '${buf.toString()}'`);
-      }
+  get Alerter() {
+    if (!alerter) {
+      alerter = timeSeries(this.logger, {
+        host: process.env.JAMBONES_TIME_SERIES_HOST,
+        commitSize: 50,
+        commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+      });
     }
+    return alerter;
   }
 }
 

lib/utils/sbc-pinger.js

@@ -1,5 +1,5 @@
 const assert = require('assert');
-const { v4: uuidv4 } = require('uuid');
+const uuidv4 = require('uuid-random');
 const {LifeCycleEvents, FS_UUID_SET_NAME} = require('./constants');
 const Emitter = require('events');
 const debug = require('debug')('jambonz:feature-server');
@@ -75,6 +75,9 @@ module.exports = (logger) => {
       }
     })();
   }
+  else if (process.env.K8S) {
+    lifecycleEmitter.scaleIn = () => process.exit(0);
+  }
 
   async function pingProxies(srf) {
     if (process.env.NODE_ENV === 'test') return;

lib/utils/siprec-utils.js

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

lib/utils/ws-requestor.js

@@ -54,7 +54,11 @@ class WsRequestor extends BaseRequestor {
     /* 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);
+      const requestor = new HttpRequestor(this.logger, this.account_sid, {url: hook}, this.secret);
+      if (type === 'session:redirect') {
+        this.close();
+        this.emit('handover', requestor);
+      }
       return requestor.request(type, hook, params, httpHeaders);
     }
 
@@ -69,7 +73,7 @@ class WsRequestor extends BaseRequestor {
       this.connectInProgress = true;
       this.logger.debug(`WsRequestor:request(${this.id}) - connecting since we do not have a connection`);
       if (this.connections >= MAX_RECONNECTS) {
-        throw new Error(`max attempts connecting to ${this.url}`);
+        return Promise.reject(`max attempts connecting to ${this.url}`);
       }
       try {
         const startAt = process.hrtime();
@@ -79,7 +83,7 @@ class WsRequestor extends BaseRequestor {
       } catch (err) {
         this.logger.info({url, err}, 'WsRequestor:request - failed connecting');
         this.connectInProgress = false;
-        throw err;
+        return Promise.reject(err);
       }
     }
     assert(this.ws);
@@ -138,7 +142,7 @@ class WsRequestor extends BaseRequestor {
         success: (response) => {
           clearTimeout(timer);
           const rtt = this._roundTrip(startAt);
-          this.logger.info({response}, `WsRequestor:request ${url} succeeded in ${rtt}ms`);
+          this.logger.debug({response}, `WsRequestor:request ${url} succeeded in ${rtt}ms`);
           this.stats.histogram('app.hook.ws_response_time', rtt, ['hook_type:app']);
           resolve(response);
         },
@@ -161,8 +165,9 @@ class WsRequestor extends BaseRequestor {
     this.logger.debug('WsRequestor:close closing socket');
     try {
       if (this.ws) {
-        this.ws.close();
+        this.ws.close(1000);
         this.ws.removeAllListeners();
+        this.ws = null;
       }
 
       for (const [msgid, obj] of this.messagesInFlight) {
@@ -187,7 +192,7 @@ class WsRequestor extends BaseRequestor {
         followRedirects: true,
         maxRedirects: 2,
         handshakeTimeout,
-        maxPayload: 8096,
+        maxPayload: process.env.JAMBONES_WS_MAX_PAYLOAD ? parseInt(process.env.JAMBONES_WS_MAX_PAYLOAD) : 24 * 1024,
       };
       if (this.username && this.password) opts = {...opts, auth: `${this.username}:${this.password}`};
 
@@ -286,7 +291,7 @@ class WsRequestor extends BaseRequestor {
       const obj = JSON.parse(content);
       const {type, msgid, command, call_sid = this.call_sid, queueCommand = false, data} = obj;
 
-      this.logger.debug({obj}, 'WsRequestor:request websocket: received');
+      //this.logger.debug({obj}, 'WsRequestor:request websocket: received');
       assert.ok(type, 'type property not supplied');
 
       switch (type) {
@@ -323,7 +328,7 @@ class WsRequestor extends BaseRequestor {
 
   _recvCommand(msgid, command, call_sid, queueCommand, data) {
     // TODO: validate command
-    this.logger.info({msgid, command, call_sid, queueCommand, data}, 'received command');
+    this.logger.debug({msgid, command, call_sid, queueCommand, data}, 'received command');
     this.emit('command', {msgid, command, call_sid, queueCommand, data});
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "v0.7.6",
+  "version": "v0.7.13",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"
@@ -16,9 +16,7 @@
     "type": "git",
     "url": "https://github.com/jambonz/jambonz-feature-server.git"
   },
-  "bugs": {
-    "url": "https://github.com/jambonz/jambonz-feature-server/issues"
-  },
+  "bugs": {},
   "scripts": {
     "start": "node app",
     "test": "NODE_ENV=test JAMBONES_HOSTING=1 HTTP_POOL=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/ ",
@@ -26,11 +24,11 @@
     "jslint": "eslint app.js lib"
   },
   "dependencies": {
-    "@jambonz/db-helpers": "^0.6.18",
+    "@jambonz/db-helpers": "^0.7.4",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/realtimedb-helpers": "^0.4.29",
+    "@jambonz/realtimedb-helpers": "^0.6.3",
     "@jambonz/stats-collector": "^0.1.6",
-    "@jambonz/time-series": "^0.1.12",
+    "@jambonz/time-series": "^0.2.5",
     "@opentelemetry/api": "^1.1.0",
     "@opentelemetry/exporter-jaeger": "^1.3.1",
     "@opentelemetry/exporter-trace-otlp-http": "^0.27.0",
@@ -44,20 +42,19 @@
     "bent": "^7.3.12",
     "debug": "^4.3.4",
     "deepcopy": "^2.1.0",
-    "drachtio-fsmrf": "^3.0.2",
-    "drachtio-srf": "^4.5.1",
-    "express": "^4.18.1",
-    "helmet": "^5.1.0",
+    "drachtio-fsmrf": "^3.0.16",
+    "drachtio-srf": "^4.5.21",
+    "express": "^4.18.2",
     "ip": "^1.1.8",
-    "moment": "^2.29.3",
-    "parse-url": "^7.0.2",
+    "moment": "^2.29.4",
+    "parse-url": "^8.1.0",
     "pino": "^6.14.0",
     "sdp-transform": "^2.14.1",
     "short-uuid": "^4.2.0",
     "to-snake-case": "^1.0.0",
-    "undici": "^5.8.2",
-    "uuid": "^8.3.2",
-    "verify-aws-sns-signature": "^0.0.7",
+    "undici": "^5.11.0",
+    "uuid-random": "^1.3.2",
+    "verify-aws-sns-signature": "^0.1.0",
     "ws": "^8.8.0",
     "xml2js": "^0.4.23"
   },

test/index.js

@@ -8,5 +8,6 @@ require('./gather-tests');
 require('./sip-request-tests');
 require('./create-call-test');
 require('./play-tests');
+require('./sip-refer-tests');
 require('./remove-test-db');
 require('./docker_stop');

test/play-tests.js

@@ -156,3 +156,43 @@ test('\'play\' tests multi links in array in conference', async(t) => {
     t.error(err);
   }
 });
+
+test('\'play\' tests with seekOffset and actionHook', async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'play',
+        url: 'silence_stream://5000',
+        seekOffset: 8000,
+        timeoutSecs: 2,
+        actionHook: '/customHook'
+      }
+    ];
+
+    const waitHookVerbs = [];
+
+    const from = 'play_action_hook';
+    provisionCallHook(from, verbs)
+    provisionCustomHook(from, waitHookVerbs)
+
+    // THEN
+    await sippUac('uac-success-received-bye.xml', '172.38.0.10', from);
+    t.pass('play: succeeds');
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_customHook`)
+    t.ok(obj.body.reason === "playCompleted", "play: actionHook success received")
+    t.ok(obj.body.playback_seconds === "2", "playback_seconds: actionHook success received")
+    t.ok(obj.body.playback_milliseconds === "2048", "playback_milliseconds: actionHook success received")
+    t.ok(obj.body.playback_last_offset_pos === "16000", "playback_last_offset_pos: actionHook success received")
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/scenarios/uac-refer-no-notify.xml

@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+    INVITE sip:[to]@[remote_ip]:[remote_port] SIP/2.0
+    Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+    From: [from] <sip:[from]@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+    To: <sip:[to]@[remote_ip]:[remote_port]>
+    Call-ID: [call_id]
+    CSeq: 1 INVITE
+    Contact: sip:[from]@[local_ip]:[local_port]
+    Max-Forwards: 70
+    X-Account-Sid: bb845d4b-83a9-4cde-a6e9-50f3743bab3f
+    Subject: uac-refer-no-notify.xml
+    Content-Type: application/sdp
+    Content-Length: [len]
+
+    v=0
+    o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+    s=-
+    c=IN IP[media_ip_type] [media_ip]
+    t=0 0
+    m=audio [media_port] RTP/AVP 0
+    a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: [service] <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: REFER test with no NOT
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- receive re-invite -->
+  <recv request="REFER" crlf="true"/>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 202 Accepted
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+</scenario>

test/scenarios/uac-refer-with-notify.xml

@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="Basic Sipstone UAC">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+    INVITE sip:[to]@[remote_ip]:[remote_port] SIP/2.0
+    Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+    From: [from] <sip:[from]@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+    To: <sip:16174000000@[remote_ip]:[remote_port]>
+    Call-ID: [call_id]
+    CSeq: 1 INVITE
+    Contact: sip:[from]@[local_ip]:[local_port]
+    Max-Forwards: 70
+    X-Account-Sid: bb845d4b-83a9-4cde-a6e9-50f3743bab3f
+    Subject: uac-refer-with-notify.xml
+    Content-Type: application/sdp
+    Content-Length: [len]
+
+    v=0
+    o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+    s=-
+    c=IN IP[media_ip_type] [media_ip]
+    t=0 0
+    m=audio [media_port] RTP/AVP 0
+    a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv response="100"
+        optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="183" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000000@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-refer-with-notify.xml
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- receive re-invite -->
+  <recv request="REFER" crlf="true"/>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 202 Accepted
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <send retrans="500">
+    <![CDATA[
+
+      NOTIFY sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag00[call_number]
+      To: <sip:16174000000@[remote_ip]:[remote_port]>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 NOTIFY
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-refer-with-notify.xml
+      Content-Type: message/sipfrag;version=2.0
+      Content-Length: 16
+      
+      SIP/2.0 200 OK
+    ]]>
+  </send>
+  <recv response="200"</recv>
+      
+</scenario>

test/sip-refer-tests.js

@@ -0,0 +1,100 @@
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_fs');
+const clearModule = require('clear-module');
+const {provisionCallHook, provisionCustomHook, provisionActionHook} = require('./utils')
+const bent = require('bent');
+const getJSON = bent('json')
+
+const sleepFor = async(ms) => new Promise(resolve => setTimeout(resolve, ms));
+
+process.on('unhandledRejection', (reason, p) => {
+  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+function connect(connectable) {
+  return new Promise((resolve, reject) => {
+    connectable.on('connect', () => {
+      return resolve();
+    });
+  });
+}
+
+test('\'refer\' tests w/202 and NOTIFY', {timeout: 25000}, async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'say',
+        text: 'silence_stream://100'
+      },
+      {
+        verb: 'sip:refer',
+        referTo: '123456',
+        actionHook: '/actionHook'
+      }
+    ];
+    const noVerbs = [];
+
+    const from = 'refer_with_notify';
+    provisionCallHook(from, verbs);
+    provisionActionHook(from, noVerbs)
+
+    // THEN
+    await sippUac('uac-refer-with-notify.xml', '172.38.0.10', from);
+    t.pass('refer: successfully received 202 Accepted');
+    await sleepFor(1000);
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    t.ok(obj.body.final_referred_call_status === 200, 'refer: successfully received NOTIFY with 200 OK');
+    //console.log(`obj: ${JSON.stringify(obj)}`);
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});
+
+test('\'refer\' tests w/202 but no NOTIFY', {timeout: 25000}, async(t) => {
+  clearModule.all();
+  const {srf, disconnect} = require('../app');
+
+  try {
+    await connect(srf);
+
+    // GIVEN
+    const verbs = [
+      {
+        verb: 'say',
+        text: 'silence_stream://100'
+      },
+      {
+        verb: 'sip:refer',
+        referTo: '123456',
+        actionHook: '/actionHook'
+      }
+    ];
+    const noVerbs = [];
+
+    const from = 'refer_no_notify';
+    provisionCallHook(from, verbs);
+    provisionActionHook(from, noVerbs)
+
+    // THEN
+    await sippUac('uac-refer-no-notify.xml', '172.38.0.10', from);
+    t.pass('refer: successfully received 202 Accepted w/o NOTIFY');
+    await sleepFor(17000);
+    const obj  = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}_actionHook`);
+    console.log(`obj: ${JSON.stringify(obj)}`);
+    t.ok(obj.body.refer_status === 202, 'refer: successfully timed out and reported 202');
+    disconnect();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    disconnect();
+    t.error(err);
+  }
+});

test/sip-tests.js

@@ -53,6 +53,13 @@ test('incoming call tests', (t) => {
     .then(() => {
       return t.pass('handles in-dialog requests');
     })
+    .then(() => {
+      return sippUac('uac-refer-no-notify.xml', '172.38.0.30');
+    })
+    .then(() => {
+      return t.pass('handles sip:refer where we get 202 but no NOTIFY');
+    })
+
     .then(() => {
       srf.disconnect();
       t.end();

test/utils.js

@@ -24,4 +24,13 @@ const provisionCustomHook = (from, verbs) => {
   post(`/customHookMapping`, mapping);
 }
 
-module.exports = { provisionCallHook, provisionCustomHook}
+const provisionActionHook = (from, verbs) => {
+  const mapping = {
+    from,
+    data: JSON.stringify(verbs)
+  };
+  const post = bent('http://127.0.0.1:3100', 'POST', 'string', 200);
+  post(`/actionHook`, mapping);
+}
+
+module.exports = { provisionCallHook, provisionCustomHook, provisionActionHook}

tracer.js

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