K8s changes (#55)

* K8S: dont send OPTIONS pings

* fix missing ref

* k8s pre-stop hook added

* k8s pre-stop hook changes

* chmod +x utility

* more k8s pre-stop changes

* pre stop

* fix healthcheck

* k8s pre-stop working

* add readiness probe

* fix bug in pre-stop

* logging

* revamp k8s pre-stop a bit

* initial support for cognigy bot

* more cognigy changes

* switch to use transcribe for cognigy

* #54 include callInfo in dialogflow event payload

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16
+FROM node:17.0.1-slim
 WORKDIR /opt/app/
 COPY package.json ./
 RUN npm install

app.js

@@ -92,6 +92,10 @@ sessionTracker.on('idle', () => {
   }
 });
 
+const getCount = () => sessionTracker.count;
+const healthCheck = require('@jambonz/http-health-check');
+healthCheck({app, logger, path: '/', fn: getCount});
+
 setInterval(() => {
   srf.locals.stats.gauge('fs.sip.calls.count', sessionTracker.count);
 }, 5000);

bin/k8s-pre-stop-hook.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+const bent = require('bent');
+const getJSON = bent('json');
+const PORT = process.env.HTTP_PORT || 3000;
+
+const sleep = (ms) => {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+(async function() {
+
+  try {
+    do {
+      const obj = await getJSON(`http://127.0.0.1:${PORT}/`);
+      const {calls} = obj;
+      if (calls === 0) {
+        console.log('no calls on the system, we can exit');
+        process.exit(0);
+      }
+      else {
+        console.log(`waiting for ${calls} to exit..`);
+      }
+      await sleep(10000);
+    } while (1);
+  } catch (err) {
+    console.error(err, 'Error querying health endpoint');
+    process.exit(-1);
+  }
+})();

lib/http-routes/api/index.js

@@ -9,8 +9,4 @@ api.use('/enqueue', require('./enqueue'));
 api.use('/messaging', require('./messaging'));            // inbound SMS
 api.use('/createMessage', require('./create-message'));   // outbound SMS (REST)
 
-// health checks
-api.get('/', (req, res) => res.sendStatus(200));
-api.get('/health', (req, res) => res.sendStatus(200));
-
 module.exports = api;

lib/http-routes/index.js

@@ -1,16 +1,23 @@
 const express = require('express');
 const api = require('./api');
 const routes = express.Router();
+const sessionTracker = require('../session/session-tracker');
+
+const readiness = (req, res) => {
+  const logger = req.app.locals.logger;
+  const {count} = sessionTracker;
+  const {srf} = require('../..');
+  const {getFreeswitch} = srf.locals;
+  if (getFreeswitch()) {
+    return res.status(200).json({calls: count});
+  }
+  logger.info('responding to /health check with failure as freeswitch is not up');
+  res.sendStatus(480);
+};
 
 routes.use('/v1', api);
 
-// health checks
+// health check
-routes.get('/', (req, res) => {
+routes.get('/health', readiness);
-  res.sendStatus(200);
-});
-
-routes.get('/health', (req, res) => {
-  res.sendStatus(200);
-});
 
 module.exports = routes;

lib/tasks/cognigy.js

@@ -0,0 +1,242 @@
+const Task = require('./task');
+const {TaskName, TaskPreconditions} = require('../utils/constants');
+const makeTask = require('./make_task');
+const { SocketClient } = require('@cognigy/socket-client');
+
+const parseGallery = (obj = {}) => {
+  const {_default} = obj;
+  if (_default) {
+    const {_gallery} = _default;
+    if (_gallery) return _gallery.fallbackText;
+  }
+};
+
+const parseQuickReplies = (obj) => {
+  const {_default} = obj;
+  if (_default) {
+    const {_quickReplies} = _default;
+    if (_quickReplies) return _quickReplies.text || _quickReplies.fallbackText;
+  }
+};
+
+const parseBotText = (evt) => {
+  const {text, data} = evt;
+  if (text) return text;
+
+  switch (data?.type) {
+    case 'quickReplies':
+      return parseQuickReplies(data?._cognigy);
+    case 'gallery':
+      return parseGallery(data?._cognigy);
+    default:
+      break;
+  }
+};
+
+class Cognigy extends Task {
+  constructor(logger, opts) {
+    super(logger, opts);
+    this.preconditions = TaskPreconditions.Endpoint;
+
+    this.url = this.data.url;
+    this.token = this.data.token;
+    this.prompt = this.data.prompt;
+    this.eventHook = this.data?.eventHook;
+    this.actionHook = this.data?.actionHook;
+    this.data = this.data.data || {};
+    this.prompts = [];
+  }
+
+  get name() { return TaskName.Cognigy; }
+
+  get hasReportedFinalAction() {
+    return this.reportedFinalAction || this.isReplacingApplication;
+  }
+
+  async exec(cs, ep) {
+    await super.exec(cs);
+
+    this.ep = ep;
+    try {
+      /* set event handlers and start transcribing */
+      this.on('transcription', this._onTranscription.bind(this, cs, ep));
+      this.on('error', this._onError.bind(this, cs, ep));
+
+      this.transcribeTask = this._makeTranscribeTask();
+      this.transcribeTask.exec(cs, ep, this)
+        .catch((err) => {
+          this.logger.info({err}, 'Cognigy transcribe task returned error');
+          this.notifyTaskDone();
+        });
+      if (this.prompt) {
+        this.sayTask = this._makeSayTask(this.prompt);
+        this.sayTask.exec(cs, ep, this)
+          .catch((err) => {
+            this.logger.info({err}, 'Cognigy say task returned error');
+            this.notifyTaskDone();
+          });
+      }
+
+      /* connect to the bot and send initial data */
+      this.client = new SocketClient(
+        this.url,
+        this.token,
+        {
+          sessionId: cs.callSid,
+          channel: 'jambonz'
+        }
+      );
+      this.client.on('output', this._onBotUtterance.bind(this, cs, ep));
+      this.client.on('typingStatus', this._onBotTypingStatus.bind(this, cs, ep));
+      this.client.on('error', this._onBotError.bind(this, cs, ep));
+      this.client.on('finalPing', this._onBotFinalPing.bind(this, cs, ep));
+      await this.client.connect();
+      this.client.sendMessage('', {...this.data, ...cs.callInfo});
+
+      await this.awaitTaskDone();
+    } catch (err) {
+      this.logger.error({err}, 'Cognigy error');
+      throw err;
+    }
+  }
+
+  async kill(cs) {
+    super.kill(cs);
+    this.logger.debug('Cognigy:kill');
+
+    this.removeAllListeners();
+    this.transcribeTask && this.transcribeTask.kill();
+
+    this.client.removeAllListeners();
+    if (this.client && this.client.connected) this.client.disconnect();
+
+    if (!this.hasReportedFinalAction) {
+      this.reportedFinalAction = true;
+      this.performAction({cognigyResult: 'caller hungup'})
+        .catch((err) => this.logger.info({err}, 'cognigy - error w/ action webook'));
+    }
+
+    if (this.ep.connected) {
+      await this.ep.api('uuid_break', this.ep.uuid).catch((err) => this.logger.info(err, 'Error killing audio'));
+    }
+    this.notifyTaskDone();
+  }
+
+  _makeTranscribeTask() {
+    const opts = {
+      recognizer: this.data.recognizer || {
+        vendor: 'default',
+        language: 'default'
+      }
+    };
+    this.logger.debug({opts}, 'constructing a nested transcribe object');
+    const transcribe = makeTask(this.logger, {transcribe: opts}, this);
+    return transcribe;
+  }
+
+  _makeSayTask(text) {
+    const opts = {
+      text,
+      synthesizer: this.data.synthesizer ||
+      {
+        vendor: 'default',
+        language: 'default',
+        voice: 'default'
+      }
+    };
+    this.logger.debug({opts}, 'constructing a nested say object');
+    const say = makeTask(this.logger, {say: opts}, this);
+    return say;
+  }
+
+  async _onBotError(cs, ep, evt) {
+    this.logger.info({evt}, 'Cognigy:_onBotError');
+    this.performAction({cognigyResult: 'botError', message: evt.message });
+    this.reportedFinalAction = true;
+    this.notifyTaskDone();
+  }
+
+  async _onBotTypingStatus(cs, ep, evt) {
+    this.logger.info({evt}, 'Cognigy:_onBotTypingStatus');
+  }
+  async _onBotFinalPing(cs, ep) {
+    this.logger.info('Cognigy:_onBotFinalPing');
+    if (this.prompts.length) {
+      const text = this.prompts.join('.');
+      this.prompts = [];
+      if (text && !this.killed) {
+        this.sayTask = this._makeSayTask(text);
+        this.sayTask.exec(cs, ep, this)
+          .catch((err) => {
+            this.logger.info({err}, 'Cognigy say task returned error');
+            this.notifyTaskDone();
+          });
+      }
+    }
+  }
+
+  async _onBotUtterance(cs, ep, evt) {
+    this.logger.debug({evt}, 'Cognigy:_onBotUtterance');
+
+    if (this.eventHook) {
+      this.performHook(cs, this.eventHook, {event: 'botMessage', message: evt})
+        .then((redirected) => {
+          if (redirected) {
+            this.logger.info('Cognigy_onTranscription: event handler for bot message redirected us to new webhook');
+            this.reportedFinalAction = true;
+            this.performAction({cognigyResult: 'redirect'}, false);
+          }
+          return;
+        })
+        .catch(({err}) => {
+          this.logger.info({err}, 'Cognigy_onTranscription: error sending event hook');
+        });
+    }
+    const text = parseBotText(evt);
+    this.prompts.push(text);
+  }
+
+  async _onTranscription(cs, ep, evt) {
+    this.logger.debug({evt}, `Cognigy: got transcription for callSid ${cs.callSid}`);
+    const utterance = evt.alternatives[0].transcript;
+
+    if (this.eventHook) {
+      this.performHook(cs, this.eventHook, {event: 'userMessage', message: utterance})
+        .then((redirected) => {
+          if (redirected) {
+            this.logger.info('Cognigy_onTranscription: event handler for user message redirected us to new webhook');
+            this.reportedFinalAction = true;
+            this.performAction({cognigyResult: 'redirect'}, false);
+            if (this.transcribeTask) this.transcribeTask.kill(cs);
+          }
+          return;
+        })
+        .catch(({err}) => {
+          this.logger.info({err}, 'Cognigy_onTranscription: error sending event hook');
+        });
+    }
+
+    /* send the user utterance to the bot */
+    try {
+      if (this.client && this.client.connected) {
+        this.client.sendMessage(utterance);
+      }
+      else {
+        this.logger.info('Cognigy_onTranscription - not sending user utterance as bot is disconnected');
+      }
+    } catch (err) {
+      this.logger.error({err}, 'Cognigy_onTranscription: Error sending user utterance to Cognigy - ending task');
+      this.performAction({cognigyResult: 'socketError'});
+      this.reportedFinalAction = true;
+      this.notifyTaskDone();
+    }
+  }
+  _onError(cs, ep, err) {
+    this.logger.debug({err}, 'Cognigy: got error');
+    if (!this.hasReportedFinalAction) this.performAction({cognigyResult: 'error', err});
+    this.reportedFinalAction = true;
+    this.notifyTaskDone();
+  }
+}
+
+module.exports = Cognigy;

lib/tasks/dialogflow/index.js

@@ -452,8 +452,8 @@ class Dialogflow extends Task {
     this.noinputTimer = setTimeout(this._onNoInput.bind(this, ep, cs), this.noInputTimeout);
   }
 
-  async _performHook(cs, hook, results) {
+  async _performHook(cs, hook, results = {}) {
-    const json = await this.cs.requestor.request(hook, results);
+    const json = await this.cs.requestor.request(hook, {...results, ...cs.callInfo.toJSON()});
     if (json && Array.isArray(json)) {
       const makeTask = require('../make_task');
       const tasks = normalizeJambones(this.logger, json).map((tdata) => makeTask(this.logger, tdata));

lib/tasks/make_task.js

@@ -20,6 +20,9 @@ function makeTask(logger, obj, parent) {
     case TaskName.SipRefer:
       const TaskSipRefer = require('./sip_refer');
       return new TaskSipRefer(logger, data, parent);
+    case TaskName.Cognigy:
+      const TaskCognigy = require('./cognigy');
+      return new TaskCognigy(logger, data, parent);
     case TaskName.Conference:
       const TaskConference = require('./conference');
       return new TaskConference(logger, data, parent);

lib/tasks/specs.json

@@ -21,6 +21,22 @@
       "referTo"
     ]
   },
+  "cognigy": {
+    "properties": {
+      "url": "string",
+      "token": "string",
+      "recognizer": "#recognizer",
+      "tts": "#synthesizer",
+      "prompt": "string",
+      "actionHook": "object|string",
+      "eventHook": "object|string",
+      "data": "object"
+    },
+    "required": [
+      "url",
+      "token"
+    ]
+  },
   "dequeue": {
     "properties": {
       "name": "string",
@@ -308,7 +324,6 @@
       "earlyMedia": "boolean"
     },
     "required": [
-      "transcriptionHook",
       "recognizer"
     ]
   },

lib/tasks/transcribe.js

@@ -11,6 +11,7 @@ class TaskTranscribe extends Task {
   constructor(logger, opts, parentTask) {
     super(logger, opts);
     this.preconditions = TaskPreconditions.Endpoint;
+    this.parentTask = parentTask;
 
     this.transcriptionHook = this.data.transcriptionHook;
     this.earlyMedia = this.data.earlyMedia === true || (parentTask && parentTask.earlyMedia);
@@ -76,6 +77,7 @@ class TaskTranscribe extends Task {
       await this.awaitTaskDone();
     } catch (err) {
       this.logger.info(err, 'TaskTranscribe:exec - error');
+      this.parentTask && this.parentTask.emit('error', err);
     }
     ep.removeCustomEventListener(GoogleTranscriptionEvents.Transcription);
     ep.removeCustomEventListener(GoogleTranscriptionEvents.NoAudioDetected);
@@ -227,8 +229,13 @@ class TaskTranscribe extends Task {
     }
     this.logger.debug(evt, 'TaskTranscribe:_onTranscription');
 
+    if (this.transcriptionHook) {
       this.cs.requestor.request(this.transcriptionHook, Object.assign({speech: evt}, this.cs.callInfo))
         .catch((err) => this.logger.info(err, 'TranscribeTask:_onTranscription error'));
+    }
+    if (this.parentTask) {
+      this.parentTask.emit('transcription', evt);
+    }
     if (this.killed) {
       this.logger.debug('TaskTranscribe:_onTranscription exiting after receiving final transcription');
       this._clearTimer();

lib/utils/constants.json

@@ -1,5 +1,6 @@
 {
   "TaskName": {
+    "Cognigy": "cognigy",
     "Conference": "conference",
     "Dequeue": "dequeue",
     "Dial": "dial",

lib/utils/sbc-pinger.js

@@ -67,7 +67,6 @@ module.exports = (logger) => {
     })();
   }
 
-  // send OPTIONS pings to SBCs
   async function pingProxies(srf) {
     if (process.env.NODE_ENV === 'test') return;
 
@@ -91,6 +90,10 @@ module.exports = (logger) => {
     }
   }
 
+  if (process.env.K8S) {
+    logger.info('disabling OPTIONS pings since we are running as a kubernetes service');
+  }
+  else {
     // OPTIONS ping the SBCs from each feature server every 60 seconds
     setInterval(() => {
       const {srf} = require('../..');
@@ -113,6 +116,7 @@ module.exports = (logger) => {
 
       pingProxies(srf);
     }, 1000);
+  }
 
   return {
     lifecycleEmitter,

lib/utils/select-sbc.js

@@ -1,5 +1,8 @@
 const CIDRMatcher = require('cidr-matcher');
-const matcher = new CIDRMatcher([process.env.JAMBONES_NETWORK_CIDR]);
+const cidrs = process.env.JAMBONES_NETWORK_CIDR
+  .split(',')
+  .map((s) => s.trim());
+const matcher = new CIDRMatcher(cidrs);
 
 module.exports = (sbcList) => {
   const obj = sbcList

package.json

@@ -26,23 +26,25 @@
     "jslint": "eslint app.js lib"
   },
   "dependencies": {
+    "@cognigy/socket-client": "^4.5.5",
     "@jambonz/db-helpers": "^0.6.16",
+    "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/mw-registrar": "^0.2.1",
     "@jambonz/realtimedb-helpers": "^0.4.14",
-    "@jambonz/stats-collector": "^0.1.5",
+    "@jambonz/stats-collector": "^0.1.6",
     "@jambonz/time-series": "^0.1.5",
-    "aws-sdk": "^2.846.0",
+    "aws-sdk": "^2.1036.0",
     "bent": "^7.3.12",
     "cidr-matcher": "^2.1.1",
-    "debug": "^4.3.1",
+    "debug": "^4.3.2",
     "deepcopy": "^2.1.0",
     "drachtio-fsmrf": "^2.0.13",
     "drachtio-srf": "^4.4.55",
     "express": "^4.17.1",
     "ip": "^1.1.5",
     "moment": "^2.29.1",
-    "parse-url": "^5.0.2",
+    "parse-url": "^5.0.7",
-    "pino": "^6.11.2",
+    "pino": "^6.13.2",
     "to-snake-case": "^1.0.0",
     "uuid": "^8.3.2",
     "verify-aws-sns-signature": "^0.0.6",