Feature/ibm watson (#193)

* initial changes to support ibm watson

* update specs.json for ibm

* update to drachtio-fsmrf with support for ibm

* bugfix: set access token for ibm stt, not api_key

* fix name of api_key

* normalize ibm transcription results

* rework ibm credentials

* bugfix setting runtime speech creds

* bugfix: ibm region

* typo

* changes to transcribe for ibm watson

* implement connect handler

* bugfix: bind error

* proper use of result_index

* ibm error handling

lib/tasks/gather.js

@@ -6,7 +6,8 @@ const {
   NuanceTranscriptionEvents,
   AwsTranscriptionEvents,
   AzureTranscriptionEvents,
-  DeepgramTranscriptionEvents
+  DeepgramTranscriptionEvents,
+  IbmTranscriptionEvents
 } = require('../utils/constants');
 
 const makeTask = require('./make_task');
@@ -30,7 +31,8 @@ class TaskGather extends Task {
     const {
       setChannelVarsForStt,
       normalizeTranscription,
-      removeSpeechListeners
+      removeSpeechListeners,
+      setSpeechCredentialsAtRuntime
     } = require('../utils/transcription-utils')(logger);
     this.setChannelVarsForStt = setChannelVarsForStt;
     this.normalizeTranscription = normalizeTranscription;
@@ -56,14 +58,7 @@ class TaskGather extends Task {
       this.language = recognizer.language;
 
       /* let credentials be supplied in the recognizer object at runtime */
-      if (recognizer.vendor === 'nuance') {
-        const {clientId, secret} = recognizer.nuanceOptions;
-        if (clientId && secret) this.sttCredentials = {client_id: clientId, secret};
-      }
-      else if (recognizer.vendor === 'deepgram') {
-        const {apiKey} = recognizer.deepgramOptions;
-        if (apiKey) this.sttCredentials = {api_key: apiKey};
-      }
+      this.sttCredentials = setSpeechCredentialsAtRuntime(recognizer);
 
       /* continuous ASR (i.e. compile transcripts until a special timeout or dtmf key) */
       this.asrTimeout = typeof recognizer.asrTimeout === 'number' ? recognizer.asrTimeout * 1000 : 0;
@@ -120,7 +115,7 @@ class TaskGather extends Task {
     this.logger.debug('Gather:exec');
     await super.exec(cs);
     const {updateSpeechCredentialLastUsed} = require('../utils/db-utils')(this.logger, cs.srf);
-    const {getNuanceAccessToken} = cs.srf.locals.dbHelpers;
+    const {getNuanceAccessToken, getIbmAccessToken} = cs.srf.locals.dbHelpers;
 
     if (cs.hasGlobalSttHints) {
       const {hints, hintsBoost} = cs.globalSttHints;
@@ -173,6 +168,13 @@ class TaskGather extends Task {
       this.logger.debug({client_id}, `Gather:exec - got nuance access token ${servedFromCache ? 'from cache' : ''}`);
       this.sttCredentials = {...this.sttCredentials, access_token};
     }
+    else if (this.vendor == 'ibm' && this.sttCredentials.stt_api_key) {
+      /* get ibm access token */
+      const {stt_api_key, stt_region} = this.sttCredentials;
+      const {access_token, servedFromCache} = await getIbmAccessToken(stt_api_key);
+      this.logger.debug({stt_api_key}, `Gather:exec - got ibm access token ${servedFromCache ? 'from cache' : ''}`);
+      this.sttCredentials = {...this.sttCredentials, access_token, stt_region};
+    }
     const startListening = (cs, ep) => {
       this._startTimer();
       if (this.isContinuousAsr && 0 === this.timeout) this._startAsrTimer();
@@ -352,6 +354,16 @@ class TaskGather extends Task {
           this._onDeepGramConnectFailure.bind(this, cs, ep));
         break;
 
+      case 'ibm':
+        this.bugname = 'ibm_transcribe';
+        ep.addCustomEventListener(IbmTranscriptionEvents.Transcription, this._onTranscription.bind(this, cs, ep));
+        ep.addCustomEventListener(IbmTranscriptionEvents.Connect, this._onIbmConnect.bind(this, cs, ep));
+        ep.addCustomEventListener(IbmTranscriptionEvents.ConnectFailure,
+          this._onIbmConnectFailure.bind(this, cs, ep));
+        ep.addCustomEventListener(IbmTranscriptionEvents.Error,
+          this._onIbmError.bind(this, cs, ep));
+        break;
+
       default:
         throw new Error(`Invalid vendor ${this.vendor}`);
     }
@@ -579,6 +591,27 @@ class TaskGather extends Task {
     this.notifyTaskDone();
   }
 
+  _onIbmConnect(_cs, _ep) {
+    this.logger.debug('TaskGather:_onIbmConnect');
+  }
+
+  _onIbmConnectFailure(cs, _ep, evt) {
+    const {reason} = evt;
+    const {writeAlerts, AlertType} = cs.srf.locals;
+    this.logger.info({evt}, 'TaskGather:_onIbmConnectFailure');
+    writeAlerts({
+      account_sid: cs.accountSid,
+      alert_type: AlertType.STT_FAILURE,
+      message: `Failed connecting to IBM watson speech recognizer: ${reason}`,
+      vendor: 'ibm',
+    }).catch((err) => this.logger.info({err}, 'Error generating alert for IBM connection failure'));
+    this.notifyError(`Failed connecting to speech vendor IBM: ${reason}`);
+    this.notifyTaskDone();
+  }
+
+  _onIbmError(cs, _ep, evt) {
+    this.logger.info({evt}, 'TaskGather:_onIbmError');  }
+
   _onVadDetected(cs, ep) {
     if (this.bargein && this.minBargeinWordCount === 0) {
       this.logger.debug('TaskGather:_onVadDetected');