#206: ignore request to start bot mode when bot mode is already active

.github/workflows/build.yml

@@ -1,6 +1,7 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
 
 jobs:
   build:
@@ -19,5 +20,3 @@ 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 }}

.gitignore

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

lib/middleware.js

@@ -245,9 +245,7 @@ module.exports = function(srf, logger) {
 
       // eslint-disable-next-line no-unused-vars
       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}`);
+      logger.info({app: appInfo}, `retrieved application for incoming call to ${req.locals.calledNumber}`);
       req.locals.callInfo = new CallInfo({
         req,
         app: app2,

lib/session/call-session.js

@@ -457,10 +457,10 @@ class CallSession extends Emitter {
       this.backgroundGatherTask = makeTask(this.logger, t[0]);
       this._bargeInEnabled = true;
       this.backgroundGatherTask
-        .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));
+        .once('dtmf', this._clearTasks.bind(this))
+        .once('vad', this._clearTasks.bind(this))
+        .once('transcription', this._clearTasks.bind(this))
+        .once('timeout', this._clearTasks.bind(this));
       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}`);
@@ -999,32 +999,14 @@ class CallSession extends Emitter {
     }
   }
 
-  kill(onBackgroundGatherBargein = false) {
+  kill() {
     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;
     }
-    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.tasks = [];
     this.taskIdx = 0;
   }
 
@@ -1632,12 +1614,11 @@ class CallSession extends Emitter {
     });
   }
 
-  _clearTasks(backgroundGather, evt) {
-    if (this.requestor instanceof WsRequestor && !backgroundGather.cleared) {
+  _clearTasks(evt) {
+    if (this.requestor instanceof WsRequestor) {
       this.logger.info({evt}, 'CallSession:_clearTasks on event from background gather');
       try {
-        backgroundGather.cleared = true;
-        this.kill(true);
+        this.kill();
       } catch (err) {}
     }
   }

lib/tasks/gather.js

@@ -143,6 +143,14 @@ class TaskGather extends Task {
       this.logger.debug({hints: this.hints, hintsBoost: this.hintsBoost},
         'Gather:exec - applying global sttHints');
     }
+    if (process.env.JAMBONZ_GATHER_EARLY_HINTS_MATCH &&
+      !this.isContinuousAsr &&
+      this.hints.length > 0 && this.hints.length <= 10) {
+      this.earlyHintsMatch = true;
+      this.interim = true;
+      this.logger.debug('Gather:exec - early hints match enabled');
+    }
+
     if (cs.hasAltLanguages) {
       this.altLanguages = this.altLanguages.concat(cs.altLanguages);
       this.logger.debug({altLanguages: this.altLanguages},
@@ -160,14 +168,6 @@ 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;

lib/tasks/hangup.js

@@ -18,7 +18,6 @@ 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/sip_refer.js

@@ -47,17 +47,7 @@ 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});
@@ -81,10 +71,10 @@ class TaskSipRefer extends Task {
     const contentType = req.get('Content-Type');
     this.logger.debug({body: req.body}, `TaskSipRefer:_handleNotify got ${contentType}`);
 
-    if (contentType?.includes('message/sipfrag')) {
+    if (contentType === 'message/sipfrag') {
       const arr = /SIP\/2\.0\s+(\d+)/.exec(req.body);
       if (arr) {
-        const status = typeof arr[1] === 'string' ? parseInt(arr[1], 10) : arr[1];
+        const status = arr[1];
         this.logger.debug(`TaskSipRefer:_handleNotify: call got status ${status}`);
         if (this.eventHook) {
           const b3 = this.getTracingPropagation();

lib/utils/ws-requestor.js

@@ -165,9 +165,8 @@ class WsRequestor extends BaseRequestor {
     this.logger.debug('WsRequestor:close closing socket');
     try {
       if (this.ws) {
-        this.ws.close(1000);
+        this.ws.close();
         this.ws.removeAllListeners();
-        this.ws = null;
       }
 
       for (const [msgid, obj] of this.messagesInFlight) {

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "jambonz-feature-server",
-  "version": "v0.7.9",
+  "version": "v0.7.8",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "jambonz-feature-server",
-      "version": "v0.7.9",
+      "version": "v0.7.8",
       "license": "MIT",
       "dependencies": {
         "@jambonz/db-helpers": "^0.7.3",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jambonz-feature-server",
-  "version": "v0.7.9",
+  "version": "v0.7.8",
   "main": "app.js",
   "engines": {
     "node": ">= 10.16.0"

test/index.js

@@ -8,6 +8,5 @@ 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/scenarios/uac-refer-no-notify.xml

@@ -1,95 +0,0 @@
-<?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

@@ -1,115 +0,0 @@
-<?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

@@ -1,100 +0,0 @@
-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,13 +53,6 @@ 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,13 +24,4 @@ const provisionCustomHook = (from, verbs) => {
   post(`/customHookMapping`, mapping);
 }
 
-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}
+module.exports = { provisionCallHook, provisionCustomHook}