interpolate tags

The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-XML2JS-5414874

.github/workflows/docker-publish.yml

@@ -2,13 +2,8 @@ name: Docker
 
 on:
   push:
-    # Publish `main` as Docker `latest` image.
-    branches:
-      - main
-
-    # Publish `v1.2.3` tags as releases.
     tags:
-      - v*
+      - '*'
 
 env:
   IMAGE_NAME: feature-server
@@ -20,32 +15,37 @@ jobs:
     if: github.event_name == 'push'
 
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-      - name: Build image
-        run: docker build . --file Dockerfile --tag $IMAGE_NAME
+      - name: Login to Docker Hub 
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-      - name: Log into registry
-        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
-
-      - name: Push image
+      - name: prepare tag 
         run: |
-          IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
+            IMAGE_ID=jambonz/$IMAGE_NAME
 
-          # Change all uppercase to lowercase
-          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+            # Strip git ref prefix from version
+            VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
 
-          # Strip git ref prefix from version
-          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+            # Strip "v" prefix from tag name
+            [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
 
-          # Strip "v" prefix from tag name
-          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+            # Use Docker `latest` tag convention
+            [ "$VERSION" == "main" ] && VERSION=latest
 
-          # Use Docker `latest` tag convention
-          [ "$VERSION" == "main" ] && VERSION=latest
+            echo IMAGE_ID=$IMAGE_ID
+            echo VERSION=$VERSION
 
-          echo IMAGE_ID=$IMAGE_ID
-          echo VERSION=$VERSION
-
-          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
-          docker push $IMAGE_ID:$VERSION
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ IMAGE_ID }}:${{ VERSION }}
+          build-args: |
+            GITHUB_REPOSITORY=$GITHUB_REPOSITORY
+            GITHUB_REF=$GITHUB_REF

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

@@ -104,7 +104,7 @@ router.post('/', async(req, res) => {
       proxy: `sip:${sbcAddress}`,
       localSdp: ep.local.sdp
     });
-    if (target.auth) opts.auth = this.target.auth;
+    if (target.auth) opts.auth = target.auth;
 
 
     /**

lib/middleware.js

@@ -46,7 +46,16 @@ module.exports = function(srf, logger) {
     }
     if (req.has('X-Authenticated-User')) req.locals.originatingUser = req.get('X-Authenticated-User');
     if (req.has('X-MS-Teams-Tenant-FQDN')) req.locals.msTeamsTenant = req.get('X-MS-Teams-Tenant-FQDN');
-
+    if (req.has('X-Cisco-Recording-Participant')) {
+      const ciscoParticipants = req.get('X-Cisco-Recording-Participant');
+      const regex = /sip:[\d]+@[\d]+\.[\d]+\.[\d]+\.[\d]+/g;
+      const sipURIs = ciscoParticipants.match(regex);
+      logger.info(`X-Cisco-Recording-Participant : ${sipURIs} `);
+      if (sipURIs && sipURIs.length > 0) {
+        req.locals.calledNumber = sipURIs[0];
+        req.locals.callingNumber = sipURIs[1];
+      }
+    }
     next();
   }
 
@@ -94,8 +103,10 @@ module.exports = function(srf, logger) {
           .find((p) => p.type === 'application/sdp')
           .content;
         const {sdp1, sdp2, ...metadata} = await parseSiprecPayload(req, logger);
-        req.locals.calledNumber = metadata.caller.number;
-        req.locals.callingNumber = metadata.callee.number;
+        if (!req.locals.calledNumber && !req.locals.calledNumber) {
+          req.locals.calledNumber = metadata.caller.number;
+          req.locals.callingNumber = metadata.callee.number;
+        }
         req.locals = {
           ...req.locals,
           siprec: {

lib/session/call-info.js

@@ -33,6 +33,23 @@ class CallInfo {
       this.callStatus = CallStatus.Trying;
       this.originatingSipIp = req.get('X-Forwarded-For');
       this.originatingSipTrunkName = req.get('X-Originating-Carrier');
+      const {siprec} = req.locals;
+      if (siprec) {
+        const caller = parseUri(req.locals.callingNumber);
+        const callee = parseUri(req.locals.calledNumber);
+        this.participants = [
+          {
+            participant: 'caller',
+            uriUser: caller.user,
+            uriHost: caller.host
+          },
+          {
+            participant: 'callee',
+            uriUser: callee.user,
+            uriHost: callee.host
+          }
+        ];
+      }
     }
     else if (opts.parentCallInfo) {
       // outbound call that is a child of an existing call

lib/session/call-session.js

@@ -511,12 +511,24 @@ 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]);
+      const task = makeTask(this.logger, t[0]);
+
+      if (this.isBotModeEnabled) {
+        const currInput = this.backgroundGatherTask.input;
+        const newInput = task.input;
+        if (JSON.stringify(currInput) === JSON.stringify(newInput)) {
+          this.logger.info('CallSession:enableBotMode - bot mode currently enabled, ignoring request to start again');
+          return;
+        }
+        else {
+          this.logger.info({currInput, newInput},
+            'CallSession:enableBotMode - restarting background gather to apply new input type');
+          this.backgroundGatherTask.sticky = false;
+          this.disableBotMode();
+        }
+      }
+      this.backgroundGatherTask = task;
       this._bargeInEnabled = true;
       this.backgroundGatherTask
         .once('dtmf', this._clearTasks.bind(this, this.backgroundGatherTask))
@@ -528,13 +540,15 @@ class CallSession extends Emitter {
       const {span, ctx} = this.rootSpan.startChildSpan(`background-gather:${this.backgroundGatherTask.summary}`);
       this.backgroundGatherTask.span = span;
       this.backgroundGatherTask.ctx = ctx;
+      this.backgroundGatherTask.sticky = autoEnable;
       this.backgroundGatherTask.exec(this, resources)
         .then(() => {
           this.logger.info('CallSession:enableBotMode: gather completed');
           this.backgroundGatherTask && this.backgroundGatherTask.removeAllListeners();
           this.backgroundGatherTask && this.backgroundGatherTask.span.end();
+          const sticky = this.backgroundGatherTask?.sticky;
           this.backgroundGatherTask = null;
-          if (autoEnable && !this.callGone && !this._stopping && this._bargeInEnabled) {
+          if (sticky && !this.callGone && !this._stopping && this._bargeInEnabled) {
             this.logger.info('CallSession:enableBotMode: restarting background gather');
             setImmediate(() => this.enableBotMode(gather, true));
           }

lib/session/siprec-call-session.js

@@ -1,6 +1,7 @@
 const InboundCallSession = require('./inbound-call-session');
 const {createSipRecPayload} = require('../utils/siprec-utils');
 const {CallStatus} = require('../utils/constants');
+const {parseSiprecPayload} = require('../utils/siprec-utils');
 /**
  * @classdesc Subclass of InboundCallSession.  This represents a CallSession that is
  * established for an inbound SIPREC call.
@@ -16,6 +17,32 @@ class SipRecCallSession extends InboundCallSession {
     this.metadata = metadata;
   }
 
+  async _onReinvite(req, res) {
+    try {
+      this.logger.info(req.payload, 'SipRec Re-INVITE payload');
+      const {sdp1: reSdp1, sdp2: reSdp2, metadata: reMetadata} = await parseSiprecPayload(req, this.logger);
+      this.sdp1 = reSdp1;
+      this.sdp2 = reSdp2;
+      this.metadata = reMetadata;
+
+      if (this.ep && this.ep2) {
+        let remoteSdp = this.sdp1.replace(/sendonly/, 'sendrecv');
+        const newSdp1 = await this.ep.modify(remoteSdp);
+        remoteSdp = this.sdp2.replace(/sendonly/, 'sendrecv');
+        const newSdp2 = await this.ep2.modify(remoteSdp);
+        const combinedSdp = await createSipRecPayload(newSdp1, newSdp2, this.logger);
+        res.send(200, {body: combinedSdp});
+        this.logger.info({offer: req.body, answer: combinedSdp}, 'SipRec handling reINVITE');
+      }
+      else {
+        this.logger.info('got SipRec reINVITE but no endpoint and media has not been released');
+        res.send(488);
+      }
+    } catch (err) {
+      this.logger.error(err, 'Error handling reinvite');
+    }
+  }
+
   async answerSipRecCall() {
     try {
       this.ms = this.getMS();

lib/tasks/gather.js

@@ -130,7 +130,7 @@ class TaskGather extends Task {
   }
 
   async exec(cs, {ep}) {
-    this.logger.debug('Gather:exec');
+    this.logger.debug({options: this.data}, 'Gather:exec');
     await super.exec(cs);
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
     const {getNuanceAccessToken, getIbmAccessToken} = cs.srf.locals.dbHelpers;

lib/tasks/listen.js

@@ -2,6 +2,7 @@ const Task = require('./task');
 const {TaskName, TaskPreconditions, ListenEvents, ListenStatus} = require('../utils/constants');
 const makeTask = require('./make_task');
 const moment = require('moment');
+const MAX_PLAY_AUDIO_QUEUE_SIZE = 10;
 
 class TaskListen extends Task {
   constructor(logger, opts, parentTask) {
@@ -20,6 +21,8 @@ class TaskListen extends Task {
     this.nested = parentTask instanceof Task;
 
     this.results = {};
+    this.playAudioQueue = [];
+    this.isPlayingAudioFromQueue = false;
 
     if (this.transcribe) this.transcribeTask = makeTask(logger, {'transcribe': opts.transcribe}, this);
   }
@@ -58,6 +61,7 @@ class TaskListen extends Task {
     super.kill(cs);
     this.logger.debug(`TaskListen:kill endpoint connected? ${this.ep && this.ep.connected}`);
     this._clearTimer();
+    this.playAudioQueue = [];
     if (this.ep && this.ep.connected) {
       this.logger.debug('TaskListen:kill closing websocket');
       try {
@@ -184,16 +188,36 @@ class TaskListen extends Task {
     this.notifyTaskDone();
   }
 
-  async _onPlayAudio(ep, evt) {
-    this.logger.info(`received play_audio event: ${JSON.stringify(evt)}`);
+  async _playAudio(ep, evt, logger) {
     try {
       const results = await ep.play(evt.file);
-      this.logger.debug(`Finished playing file, result: ${JSON.stringify(results)}`);
+      logger.debug(`Finished playing file, result: ${JSON.stringify(results)}`);
       ep.forkAudioSendText({type: 'playDone', data: Object.assign({id: evt.id}, results)});
+    } catch (err) {
+      logger.error({err}, 'Error playing file');
     }
-    catch (err) {
-      this.logger.error({err}, 'Error playing file');
+  }
+
+  async _onPlayAudio(ep, evt) {
+    this.logger.info(`received play_audio event: ${JSON.stringify(evt)}`);
+    if (!evt.queuePlay) {
+      this.playAudioQueue = [];
+      this._playAudio(ep, evt, this.logger);
+      this.isPlayingAudioFromQueue = false;
+      return;
     }
+
+    if (this.playAudioQueue.length <= MAX_PLAY_AUDIO_QUEUE_SIZE) {
+      this.playAudioQueue.push(evt);
+    }
+
+    if (this.isPlayingAudioFromQueue) return;
+
+    this.isPlayingAudioFromQueue = true;
+    while (this.playAudioQueue.length > 0) {
+      await this._playAudio(ep, this.playAudioQueue.shift(), this.logger);
+    }
+    this.isPlayingAudioFromQueue = false;
   }
 
   _onKillAudio(ep) {

lib/utils/siprec-utils.js

@@ -47,8 +47,16 @@ const parseSiprecPayload = (req, logger) => {
       }
     }
 
-    if (!sdp || !meta) {
-      logger.info({payload: req.payload}, 'invalid SIPREC payload');
+
+    if (!meta && sdp) {
+      const arr = /^([^]+)(m=[^]+?)(m=[^]+?)$/.exec(sdp);
+      opts.sdp1 = `${arr[1]}${arr[2]}`;
+      opts.sdp2 = `${arr[1]}${arr[3]}\r\n`;
+      opts.sessionId = uuidv4();
+      logger.info({ payload: req.payload }, 'SIPREC payload with no metadata (e.g. Cisco NBR)');
+      resolve(opts);
+    } else if (!sdp || !meta) {
+      logger.info({ payload: req.payload }, 'invalid SIPREC payload');
       return reject(new Error('expected multipart SIPREC body'));
     }
 
@@ -242,7 +250,8 @@ const createSipRecPayload = (sdp1, sdp2, logger) => {
     .replace(/a=sendonly\r\n/g, '')
     .replace(/a=direction:both\r\n/g, '');
   */
-  return combinedSdp;
+
+  return combinedSdp.replace(/sendrecv/g, 'recvonly');
 };
 
 module.exports = { parseSiprecPayload, createSipRecPayload } ;

lib/utils/transcription-utils.js

@@ -1,4 +1,5 @@
 const {
+  TaskName,
   AzureTranscriptionEvents,
   GoogleTranscriptionEvents,
   AwsTranscriptionEvents,
@@ -28,6 +29,7 @@ const stickyVars = {
     'AZURE_SERVICE_ENDPOINT_ID',
     'AZURE_REQUEST_SNR',
     'AZURE_PROFANITY_OPTION',
+    'AZURE_SPEECH_ALTERNATIVE_LANGUAGE_CODES',
     'AZURE_SERVICE_ENDPOINT',
     'AZURE_INITIAL_SPEECH_TIMEOUT_MS',
     'AZURE_USE_OUTPUT_FORMAT_DETAILED',
@@ -334,6 +336,7 @@ module.exports = (logger) => {
     };
 
     if ('google' === vendor) {
+      const model = task.name === TaskName.Gather ? 'command_and_search' : 'latest_long';
       opts = {
         ...opts,
         ...(sttCredentials && {GOOGLE_APPLICATION_CREDENTIALS: JSON.stringify(sttCredentials.credentials)}),
@@ -348,7 +351,7 @@ module.exports = (logger) => {
           {GOOGLE_SPEECH_SPEAKER_DIARIZATION_MIN_SPEAKER_COUNT: rOpts.diarizationMinSpeakers}),
         ...(rOpts.diarization && rOpts.diarizationMaxSpeakers > 0 &&
           {GOOGLE_SPEECH_SPEAKER_DIARIZATION_MAX_SPEAKER_COUNT: rOpts.diarizationMaxSpeakers}),
-        ...(rOpts.enhancedModel && {GOOGLE_SPEECH_USE_ENHANCED: 1}),
+        ...(rOpts.enhancedModel !== false && {GOOGLE_SPEECH_USE_ENHANCED: 1}),
         ...(rOpts.profanityFilter === false && {GOOGLE_SPEECH_PROFANITY_FILTER: 0}),
         ...(rOpts.punctuation === false && {GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION: 0}),
         ...(rOpts.words  == false && {GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS: 0}),
@@ -362,7 +365,7 @@ module.exports = (logger) => {
           {GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES: [...new Set(rOpts.altLanguages)].join(',')}),
         ...(rOpts.interactionType &&
           {GOOGLE_SPEECH_METADATA_INTERACTION_TYPE: rOpts.interactionType}),
-        ...{GOOGLE_SPEECH_MODEL: rOpts.model || 'phone_call'},
+        ...{GOOGLE_SPEECH_MODEL: rOpts.model || model},
         ...(rOpts.naicsCode > 0 && {GOOGLE_SPEECH_METADATA_INDUSTRY_NAICS_CODE: rOpts.naicsCode}),
         GOOGLE_SPEECH_METADATA_RECORDING_DEVICE_TYPE: 'phone_line',
       };

package.json

@@ -27,8 +27,8 @@
     "@jambonz/db-helpers": "^0.7.4",
     "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/realtimedb-helpers": "^0.7.0",
-    "@jambonz/speech-utils": "^0.0.8",
-    "@jambonz/stats-collector": "^0.1.6",
+    "@jambonz/speech-utils": "^0.0.12",
+    "@jambonz/stats-collector": "^0.1.8",
     "@jambonz/time-series": "^0.2.5",
     "@jambonz/verb-specifications": "^0.0.11",
     "@opentelemetry/api": "^1.4.0",
@@ -61,7 +61,7 @@
     "uuid-random": "^1.3.2",
     "verify-aws-sns-signature": "^0.1.0",
     "ws": "^8.9.0",
-    "xml2js": "^0.4.23"
+    "xml2js": "^0.5.0"
   },
   "devDependencies": {
     "clear-module": "^4.1.2",

test/create-test-db.js

@@ -18,30 +18,38 @@ test('creating schema', (t) => {
     if (err) return t.end(err);
     t.pass('schema and test data successfully created');
 
-    if (process.env.GCP_JSON_KEY && process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY) {
+    const sql = [];
+    if (process.env.GCP_JSON_KEY) {
       const google_credential = encrypt(process.env.GCP_JSON_KEY);
+      t.pass('adding google credentials');
+      sql.push(`UPDATE speech_credentials SET credential='${google_credential}' WHERE vendor='google';`);
+    }
+    if (process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY) {
       const aws_credential = encrypt(JSON.stringify({
         access_key_id: process.env.AWS_ACCESS_KEY_ID,
         secret_access_key: process.env.AWS_SECRET_ACCESS_KEY,
         aws_region: process.env.AWS_REGION
       }));
+      t.pass('adding aws credentials');
+      sql.push(`UPDATE speech_credentials SET credential='${aws_credential}' WHERE vendor='aws';`);
+    }
+    if (process.env.MICROSOFT_REGION && process.env.MICROSOFT_API_KEY) {
       const microsoft_credential = encrypt(JSON.stringify({
-        region: process.env.MICROSOFT_REGION || 'useast',
-        api_key: process.env.MICROSOFT_API_KEY || '1234567890'
+        region: process.env.MICROSOFT_REGION,
+        api_key: process.env.MICROSOFT_API_KEY
       }));
-      const cmd = `
-UPDATE speech_credentials SET credential='${google_credential}' WHERE vendor='google';
-UPDATE speech_credentials SET credential='${aws_credential}' WHERE vendor='aws';
-UPDATE speech_credentials SET credential='${microsoft_credential}' WHERE vendor='microsoft';
-`;
+      t.pass('adding microsoft credentials');
+      sql.push(`UPDATE speech_credentials SET credential='${microsoft_credential}' WHERE vendor='microsoft';`);
+    }
+    if (sql.length > 0) {
       const path = `${__dirname}/.creds.sql`;
-      fs.writeFileSync(path, cmd);
+      const cmd = sql.join('\n');
+      fs.writeFileSync(path, sql.join('\n'));
       exec(`mysql -h 127.0.0.1 -u root --protocol=tcp --port=3360  -D jambones_test < ${path}`, (err, stdout, stderr) => {
         console.log(stdout);
         console.log(stderr);
         if (err) return t.end(err);
         fs.unlinkSync(path)
-        fs.writeFileSync(`${__dirname}/credentials/gcp.json`, process.env.GCP_JSON_KEY);
         t.pass('set account-level speech credentials');
         t.end();
       });

test/remove-test-db.js

@@ -5,7 +5,6 @@ test('dropping jambones_test database', (t) => {
   exec(`mysql -h 127.0.0.1 -u root --protocol=tcp --port=3360 < ${__dirname}/db/remove_test_db.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('database successfully dropped');
-    fs.unlinkSync(`${__dirname}/credentials/gcp.json`);
     t.end();
   });
 });