fix race condition if transcribe_bugname is saved in ep

lib/config.js

@@ -120,7 +120,6 @@ const HTTP_TIMEOUT = 10000;
 const HTTP_PROXY_IP = process.env.JAMBONES_HTTP_PROXY_IP;
 const HTTP_PROXY_PORT = process.env.JAMBONES_HTTP_PROXY_PORT;
 const HTTP_PROXY_PROTOCOL = process.env.JAMBONES_HTTP_PROXY_PROTOCOL || 'http';
-const HTTP_USER_AGENT_HEADER = process.env.JAMBONES_HTTP_USER_AGENT_HEADER || 'jambonz';
 
 const OPTIONS_PING_INTERVAL = parseInt(process.env.OPTIONS_PING_INTERVAL, 10) || 30000;
 
@@ -194,7 +193,6 @@ module.exports = {
   HTTP_PROXY_IP,
   HTTP_PROXY_PORT,
   HTTP_PROXY_PROTOCOL,
-  HTTP_USER_AGENT_HEADER,
   OPTIONS_PING_INTERVAL,
   RESPONSE_TIMEOUT_MS,
   JAMBONES_WS_HANDSHAKE_TIMEOUT_MS,

lib/middleware.js

@@ -382,7 +382,7 @@ module.exports = function(srf, logger) {
           },
           recognizer: {
             vendor: app.speech_recognizer_vendor,
-            ...(app.speech_recognizer_label && {label: app.speech_recognizer_label}),
+            ...(app.speech_synthesis_label && {label: app.speech_synthesis_label}),
             language: app.speech_recognizer_language,
             ...(app.fallback_speech_recognizer_vendor && {fallback_vendor: app.fallback_speech_recognizer_vendor}),
             ...(app.fallback_speech_recognizer_label && {fallback_label: app.fallback_speech_recognizer_label}),

lib/tasks/transcribe.js

@@ -41,6 +41,7 @@ class TaskTranscribe extends SttTask {
     /* buffer speech for continuous asr */
     this._bufferedTranscripts = [];
     this.bugname_prefix = 'transcribe_';
+    this.bugnames = new Map();
   }
 
   get name() { return TaskName.Transcribe; }
@@ -89,13 +90,13 @@ class TaskTranscribe extends SttTask {
       stopTranscription = true;
       this.ep.stopTranscription({
         vendor: this.vendor,
-        bugname: this.bugname
+        bugname: this.bugnames.get(1)
       })
         .catch((err) => this.logger.info(err, 'Error TaskTranscribe:kill'));
     }
     if (this.separateRecognitionPerChannel && this.ep2 && this.ep2.connected) {
       stopTranscription = true;
-      this.ep2.stopTranscription({vendor: this.vendor})
+      this.ep2.stopTranscription({vendor: this.vendor, bugname: this.bugnames.get(2)})
         .catch((err) => this.logger.info(err, 'Error TaskTranscribe:kill'));
     }
 
@@ -132,6 +133,7 @@ class TaskTranscribe extends SttTask {
   async _setSpeechHandlers(cs, ep, channel) {
     if (this[`_speechHandlersSet_${channel}`]) return;
     this[`_speechHandlersSet_${channel}`] = true;
+    let bugname;
 
     /* some special deepgram logic */
     if (this.vendor === 'deepgram') {
@@ -141,7 +143,7 @@ class TaskTranscribe extends SttTask {
     const opts = this.setChannelVarsForStt(this, this.sttCredentials, this.data.recognizer);
     switch (this.vendor) {
       case 'google':
-        this.bugname = `${this.bugname_prefix}google_transcribe`;
+        bugname = `${this.bugname_prefix}google_transcribe`;
         this.addCustomEventListener(ep, GoogleTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         this.addCustomEventListener(ep, GoogleTranscriptionEvents.NoAudioDetected,
@@ -152,7 +154,7 @@ class TaskTranscribe extends SttTask {
 
       case 'aws':
       case 'polly':
-        this.bugname = `${this.bugname_prefix}aws_transcribe`;
+        bugname = `${this.bugname_prefix}aws_transcribe`;
         this.addCustomEventListener(ep, AwsTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         this.addCustomEventListener(ep, AwsTranscriptionEvents.NoAudioDetected,
@@ -161,19 +163,19 @@ class TaskTranscribe extends SttTask {
           this._onMaxDurationExceeded.bind(this, cs, ep, channel));
         break;
       case 'microsoft':
-        this.bugname = `${this.bugname_prefix}azure_transcribe`;
+        bugname = `${this.bugname_prefix}azure_transcribe`;
         this.addCustomEventListener(ep, AzureTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         this.addCustomEventListener(ep, AzureTranscriptionEvents.NoSpeechDetected,
           this._onNoAudio.bind(this, cs, ep, channel));
         break;
       case 'nuance':
-        this.bugname = `${this.bugname_prefix}nuance_transcribe`;
+        bugname = `${this.bugname_prefix}nuance_transcribe`;
         this.addCustomEventListener(ep, NuanceTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         break;
       case 'deepgram':
-        this.bugname = `${this.bugname_prefix}deepgram_transcribe`;
+        bugname = `${this.bugname_prefix}deepgram_transcribe`;
         this.addCustomEventListener(ep, DeepgramTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         this.addCustomEventListener(ep, DeepgramTranscriptionEvents.Connect,
@@ -186,12 +188,12 @@ class TaskTranscribe extends SttTask {
 
         break;
       case 'soniox':
-        this.bugname = `${this.bugname_prefix}soniox_transcribe`;
+        bugname = `${this.bugname_prefix}soniox_transcribe`;
         this.addCustomEventListener(ep, SonioxTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         break;
       case 'cobalt':
-        this.bugname = `${this.bugname_prefix}cobalt_transcribe`;
+        bugname = `${this.bugname_prefix}cobalt_transcribe`;
         this.addCustomEventListener(ep, CobaltTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
 
@@ -221,7 +223,7 @@ class TaskTranscribe extends SttTask {
         break;
 
       case 'ibm':
-        this.bugname = `${this.bugname_prefix}ibm_transcribe`;
+        bugname = `${this.bugname_prefix}ibm_transcribe`;
         this.addCustomEventListener(ep, IbmTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         this.addCustomEventListener(ep, IbmTranscriptionEvents.Connect,
@@ -231,13 +233,13 @@ class TaskTranscribe extends SttTask {
         break;
 
       case 'nvidia':
-        this.bugname = `${this.bugname_prefix}nvidia_transcribe`;
+        bugname = `${this.bugname_prefix}nvidia_transcribe`;
         this.addCustomEventListener(ep, NvidiaTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         break;
 
       case 'assemblyai':
-        this.bugname = `${this.bugname_prefix}assemblyai_transcribe`;
+        bugname = `${this.bugname_prefix}assemblyai_transcribe`;
         this.addCustomEventListener(ep, AssemblyAiTranscriptionEvents.Transcription,
           this._onTranscription.bind(this, cs, ep, channel));
         this.addCustomEventListener(ep,
@@ -249,7 +251,7 @@ class TaskTranscribe extends SttTask {
 
       default:
         if (this.vendor.startsWith('custom:')) {
-          this.bugname = `${this.bugname_prefix}${this.vendor}_transcribe`;
+          bugname = `${this.bugname_prefix}${this.vendor}_transcribe`;
           this.addCustomEventListener(ep, JambonzTranscriptionEvents.Transcription,
             this._onTranscription.bind(this, cs, ep, channel));
           this.addCustomEventListener(ep, JambonzTranscriptionEvents.Connect, this._onVendorConnect.bind(this, cs, ep));
@@ -263,31 +265,33 @@ class TaskTranscribe extends SttTask {
           throw new Error(`Invalid vendor ${this.vendor}`);
         }
     }
-
+    // save dedicated bugname for each endpoint
+    this.bugnames.set(channel, `${bugname}_${Date.now()}`);
     /* common handler for all stt engine errors */
-    this.addCustomEventListener(ep, JambonzTranscriptionEvents.Error, this._onJambonzError.bind(this, cs, ep));
+    this.addCustomEventListener(ep, JambonzTranscriptionEvents.Error, this._onJambonzError.bind(this, cs, ep, channel));
     await ep.set(opts)
       .catch((err) => this.logger.info(err, 'Error setting channel variables'));
   }
 
   async _startTranscribing(cs, ep, channel) {
     await this._setSpeechHandlers(cs, ep, channel);
-    await this._transcribe(ep);
+    await this._transcribe(ep, channel);
 
     /* start child span for this channel */
     const {span, ctx} = this.startChildSpan(`${STT_LISTEN_SPAN_NAME}:${channel}`);
     this.childSpan[channel - 1] = {span, ctx};
   }
 
-  async _transcribe(ep) {
+  async _transcribe(ep, channel) {
     this.logger.debug(
-      `TaskTranscribe:_transcribe - starting transcription vendor ${this.vendor} bugname ${this.bugname}`);
+      `TaskTranscribe:_transcribe - starting transcription vendor
+ ${this.vendor} bugname ${this.bugnames.get(channel)}`);
     await ep.startTranscription({
       vendor: this.vendor,
       interim: this.interim ? true : false,
       locale: this.language,
       channels: /*this.separateRecognitionPerChannel ? 2 : */ 1,
-      bugname: this.bugname,
+      bugname: this.bugnames.get(channel),
       hostport: this.hostport
     });
   }
@@ -295,7 +299,7 @@ class TaskTranscribe extends SttTask {
   async _onTranscription(cs, ep, channel, evt, fsEvent) {
     // make sure this is not a transcript from answering machine detection
     const bugname = fsEvent.getHeader('media-bugname');
-    if (bugname && this.bugname !== bugname) return;
+    if (bugname && this.bugnames.get(channel) !== bugname) return;
 
     if (this.vendor === 'ibm' && evt?.state === 'listening') return;
 
@@ -328,7 +332,7 @@ class TaskTranscribe extends SttTask {
       }
       else {
         this.logger.info({evt}, 'TaskTranscribe:_onTranscription - got empty transcript, listen again');
-        this._transcribe(ep);
+        this._transcribe(ep, channel);
       }
       return;
     }
@@ -407,7 +411,7 @@ class TaskTranscribe extends SttTask {
       });
       this.childSpan[channel - 1].span.end();
     }
-    this._transcribe(ep);
+    this._transcribe(ep, channel);
 
     /* start new child span for this channel */
     const {span, ctx} = this.startChildSpan(`${STT_LISTEN_SPAN_NAME}:${channel}`);
@@ -424,7 +428,7 @@ class TaskTranscribe extends SttTask {
       this.childSpan[channel - 1].span.end();
     }
 
-    this._transcribe(ep);
+    this._transcribe(ep, channel);
 
     /* start new child span for this channel */
     const {span, ctx} = this.startChildSpan(`${STT_LISTEN_SPAN_NAME}:${channel}`);
@@ -438,12 +442,12 @@ class TaskTranscribe extends SttTask {
     }
   }
 
-  async _onJambonzError(cs, _ep, evt) {
+  async _onJambonzError(cs, _ep, channel, evt) {
     this.logger.info({evt}, 'TaskTranscribe:_onJambonzError');
     if (this.isHandledByPrimaryProvider && this.fallbackVendor) {
       _ep.stopTranscription({
         vendor: this.vendor,
-        bugname: this.bugname
+        bugname: this.bugnames.get(channel)
       })
         .catch((err) => this.logger.error({err}, `Error stopping transcription for primary vendor ${this.vendor}`));
       const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);

lib/utils/http-requestor.js

@@ -14,7 +14,6 @@ const {
   HTTP_PROXY_PORT,
   HTTP_PROXY_PROTOCOL,
   NODE_ENV,
-  HTTP_USER_AGENT_HEADER,
 } = require('../config');
 
 const toBase64 = (str) => Buffer.from(str || '', 'utf8').toString('base64');
@@ -117,10 +116,6 @@ class HttpRequestor extends BaseRequestor {
     const url = hook.url || hook;
     const method = hook.method || 'POST';
     let buf = '';
-    httpHeaders = {
-      ...httpHeaders,
-      ...(HTTP_USER_AGENT_HEADER && {'user-agent' : HTTP_USER_AGENT_HEADER})
-    };
 
     assert.ok(url, 'HttpRequestor:request url was not provided');
     assert.ok, (['GET', 'POST'].includes(method), `HttpRequestor:request method must be 'GET' or 'POST' not ${method}`);

lib/utils/ws-requestor.js

@@ -9,8 +9,7 @@ const {
   JAMBONES_WS_PING_INTERVAL_MS,
   MAX_RECONNECTS,
   JAMBONES_WS_HANDSHAKE_TIMEOUT_MS,
-  JAMBONES_WS_MAX_PAYLOAD,
-  HTTP_USER_AGENT_HEADER
+  JAMBONES_WS_MAX_PAYLOAD
 } = require('../config');
 
 class WsRequestor extends BaseRequestor {
@@ -229,9 +228,6 @@ class WsRequestor extends BaseRequestor {
         maxRedirects: 2,
         handshakeTimeout,
         maxPayload: JAMBONES_WS_MAX_PAYLOAD ? parseInt(JAMBONES_WS_MAX_PAYLOAD) : 24 * 1024,
-        headers: {
-          ...(HTTP_USER_AGENT_HEADER && {'user-agent' : HTTP_USER_AGENT_HEADER})
-        }
       };
       if (this.username && this.password) opts = {...opts, auth: `${this.username}:${this.password}`};
 

package-lock.json

@@ -7530,9 +7530,9 @@
       "dev": true
     },
     "node_modules/follow-redirects": {
-      "version": "1.15.4",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
-      "integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==",
+      "version": "1.15.2",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz",
+      "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==",
       "funding": [
         {
           "type": "individual",
@@ -18056,9 +18056,9 @@
       "dev": true
     },
     "follow-redirects": {
-      "version": "1.15.4",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
-      "integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw=="
+      "version": "1.15.2",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz",
+      "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA=="
     },
     "for-each": {
       "version": "0.3.3",

test/create-call-test.js

@@ -99,8 +99,6 @@ test('test create-call call-hook basic authentication', async(t) => {
     let obj = await getJSON(`http:127.0.0.1:3100/lastRequest/${from}`)
     t.ok(obj.headers.Authorization = 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
       'create-call: call-hook contains basic authentication header');
-    t.ok(obj.headers['user-agent'] = 'jambonz',
-    'create-call: call-hook contains user-agent header');
     disconnect();
   } catch (err) {
     console.log(`error received: ${err}`);