implement release-media and anchor-media operations

lib/middleware.js

@@ -167,7 +167,7 @@ module.exports = function(srf, logger) {
       if (0 === app.tasks.length) throw new Error('no application provided');
       next();
     } catch (err) {
-      logger.info(`Error retrieving or parsing application: ${err.message}`);
+      logger.info({err}, `Error retrieving or parsing application: ${err.message}`);
       res.send(480, {headers: {'X-Reason': err.message}});
     }
   }

lib/session/adulting-call-session.js

@@ -8,13 +8,14 @@ const CallSession = require('./call-session');
 
  */
 class AdultingCallSession extends CallSession {
-  constructor({logger, application, singleDialer, tasks, callInfo}) {
+  constructor({logger, application, singleDialer, tasks, callInfo, accountInfo}) {
     super({
       logger,
       application,
       srf: singleDialer.dlg.srf,
       tasks,
-      callInfo
+      callInfo,
+      accountInfo
     });
     this.sd = singleDialer;
 

lib/session/call-session.js

@@ -927,14 +927,25 @@ class CallSession extends Emitter {
   }
 
   async releaseMediaToSBC(remoteSdp) {
-    assert(this.dlg);
-    assert(this.dlg.connected);
-    assert(this.ep);
-    assert(typeof remoteSdp === 'string');
-    await this.dlg.modify(remoteSdp);
+    assert(this.dlg && this.dlg.connected && this.ep && typeof remoteSdp === 'string');
+    await this.dlg.modify(remoteSdp, {
+      headers: {
+        'X-Reason': 'release-media'
+      }
+    });
     this.ep.destroy()
       .then(() => this.ep = null)
-      .catch((err) => this.logger.error({err}, 'releaseMediaToSBC: Error destroying endpoint'));
+      .catch((err) => this.logger.error({err}, 'CallSession:releaseMediaToSBC: Error destroying endpoint'));
+  }
+
+  async reAnchorMedia() {
+    assert(this.dlg && this.dlg.connected && !this.ep);
+    this.ep = await this.ms.createEndpoint({remoteSdp: this.dlg.remote.sdp});
+    await this.dlg.modify(this.ep.local.sdp, {
+      headers: {
+        'X-Reason': 'anchor-media'
+      }
+    });
   }
 
   /**

lib/tasks/dial.js

@@ -130,7 +130,9 @@ class TaskDial extends Task {
 
   get name() { return TaskName.Dial; }
 
-  get canReleaseMedia() { return !this.dtmfHook && !this.listenTask && !this.transcribeTask; }
+  get canReleaseMedia() {
+    return !process.env.ANCHOR_MEDIA_ALWAYS && !this.dtmfHook && !this.listenTask && !this.transcribeTask;
+  }
 
   async exec(cs) {
     await super.exec(cs);
@@ -179,9 +181,14 @@ class TaskDial extends Task {
    * @param {*} tasks - array of play/say tasks to execute
    */
   async whisper(tasks, callSid) {
-    if (!this.epOther || !this.ep) return this.logger.info('Dial:whisper: no paired endpoint found');
     try {
       const cs = this.callSession;
+      if (!this.ep && !this.epOther) {
+        await this.reAnchorMedia(this.callSession, this.sd);
+      }
+
+      if (!this.epOther || !this.ep) return this.logger.info('Dial:whisper: no paired endpoint found');
+
       this.logger.debug('Dial:whisper unbridging endpoints');
       await this.epOther.unbridge();
       this.logger.debug('Dial:whisper executing tasks');
@@ -190,7 +197,12 @@ class TaskDial extends Task {
         await task.exec(cs, callSid === this.callSid ? this.ep : this.epOther);
       }
       this.logger.debug('Dial:whisper tasks complete');
-      if (!cs.callGone && this.epOther) this.epOther.bridge(this.ep);
+      if (!cs.callGone && this.epOther) {
+
+        /* if we can release the media back to the SBC, do so now */
+        if (this.canReleaseMedia) this._releaseMedia(cs, this.sd);
+        else this.epOther.bridge(this.ep);
+      }
     } catch (err) {
       this.logger.error(err, 'Dial:whisper error');
     }
@@ -200,12 +212,20 @@ class TaskDial extends Task {
    * mute or unmute one side of the call
    */
   async mute(callSid, doMute) {
+    if (doMute && !this.epOther && !this.ep) {
+      this.logger.info('Dial:mute re-anchoring media so we can mute');
+      await this.reAnchorMedia(this.callSession, this.sd);
+      this.epOther.bridge(this.ep);
+    }
     if (!this.epOther || !this.ep) return this.logger.info('Dial:mute: no paired endpoint found');
     try {
       const parentCall = callSid !== this.callSid;
       const ep = parentCall ? this.epOther : this.ep;
       await ep[doMute ? 'mute' : 'unmute']();
       this.logger.debug(`Dial:mute ${doMute ? 'muted' : 'unmuted'} ${parentCall ? 'parentCall' : 'childCall'}`);
+
+      /* release media once mute is over, if we can */
+      if (!doMute && this.canReleaseMedia) this._releaseMedia(this.callSession, this.sd);
     } catch (err) {
       this.logger.error(err, 'Dial:mute error');
     }
@@ -325,7 +345,8 @@ class TaskDial extends Task {
           sbcAddress,
           target: t,
           opts,
-          callInfo: cs.callInfo
+          callInfo: cs.callInfo,
+          accountInfo: cs.accountInfo
         });
         this.dials.set(sd.callSid, sd);
 
@@ -369,9 +390,13 @@ class TaskDial extends Task {
                 break;
             }
           })
-          .on('accept', () => {
+          .on('accept', async() => {
             this.logger.debug(`Dial:_attemptCalls - we have a winner: ${sd.callSid}`);
-            this._connectSingleDial(cs, sd);
+            try {
+              await this._connectSingleDial(cs, sd);
+            } catch (err) {
+              this.logger.info({err}, 'Dial:_attemptCalls - Error calling _connectSingleDial ');
+            }
           })
           .on('decline', () => {
             this.logger.debug(`Dial:_attemptCalls - declined: ${sd.callSid}`);
@@ -397,7 +422,7 @@ class TaskDial extends Task {
     });
   }
 
-  _connectSingleDial(cs, sd) {
+  async _connectSingleDial(cs, sd) {
     if (!this.bridged && !this.canReleaseMedia) {
       this.logger.debug('Dial:_connectSingleDial bridging endpoints');
       if (this.epOther) {
@@ -408,7 +433,7 @@ class TaskDial extends Task {
     }
 
     // ding! ding! ding! we have a winner
-    this._selectSingleDial(cs, sd);
+    await this._selectSingleDial(cs, sd);
     this._killOutdials();       // NB: order is important
   }
 
@@ -421,7 +446,7 @@ class TaskDial extends Task {
    * - launch any nested tasks
    * - and establish a handler to clean up if the called party hangs up
    */
-  _selectSingleDial(cs, sd) {
+  async _selectSingleDial(cs, sd) {
     debug(`Dial:_selectSingleDial ep for outbound call: ${sd.ep.uuid}`);
     this.dials.delete(sd.callSid);
 
@@ -429,7 +454,7 @@ class TaskDial extends Task {
     this.callSid = sd.callSid;
     if (this.earlyMedia) {
       debug('Dial:_selectSingleDial propagating answer supervision on A leg now that B is connected');
-      cs.propagateAnswer();
+      await cs.propagateAnswer();
     }
     if (this.timeLimit) {
       this.timerMaxCallDuration = setTimeout(() => {
@@ -445,7 +470,7 @@ class TaskDial extends Task {
         this.logger.debug('Dial:_selectSingleDial called party hungup, ending dial operation');
         sessionTracker.remove(this.callSid);
         if (this.timerMaxCallDuration) clearTimeout(this.timerMaxCallDuration);
-        this.ep.unbridge();
+        this.ep && this.ep.unbridge();
         this.kill(cs);
       }
     });
@@ -483,15 +508,24 @@ class TaskDial extends Task {
     assert(cs.ep && sd.ep);
 
     try {
-      this.logger.info('Dial:_releaseMedia - releasing media from freewitch since we can');
+      this.logger.info('Dial:_releaseMedia - releasing media from freewitch');
       const aLegSdp = cs.ep.remote.sdp;
       const bLegSdp = sd.ep.remote.sdp;
       await Promise.all[sd.releaseMediaToSBC(aLegSdp), cs.releaseMediaToSBC(bLegSdp)];
       this.epOther = null;
+      this.logger.info('Dial:_releaseMedia - successfully released media from freewitch');
     } catch (err) {
       this.logger.info({err}, 'Dial:_releaseMedia error');
     }
   }
+
+  async reAnchorMedia(cs, sd) {
+    if (cs.ep && sd.ep) return;
+
+    this.logger.info('Dial:reAnchorMedia - re-anchoring media to freewitch');
+    await Promise.all([sd.reAnchorMedia(), cs.reAnchorMedia()]);
+    this.epOther = cs.ep;
+  }
 }
 
 module.exports = TaskDial;

lib/utils/place-outdial.js

@@ -17,7 +17,7 @@ const moment = require('moment');
 const { v4: uuidv4 } = require('uuid');
 
 class SingleDialer extends Emitter {
-  constructor({logger, sbcAddress, target, opts, application, callInfo}) {
+  constructor({logger, sbcAddress, target, opts, application, callInfo, accountInfo}) {
     super();
     assert(target.type);
 
@@ -31,6 +31,8 @@ class SingleDialer extends Emitter {
     this.bindings = logger.bindings();
 
     this.parentCallInfo = callInfo;
+    this.accountInfo = accountInfo;
+
     this.callGone = false;
 
     this.callSid = uuidv4();
@@ -202,7 +204,7 @@ class SingleDialer extends Emitter {
           const duration = moment().diff(connectTime, 'seconds');
           this.logger.debug('SingleDialer:exec called party hung up');
           this.emit('callStatusChange', {callStatus: CallStatus.Completed, duration});
-          this.ep.destroy();
+          this.ep && this.ep.destroy();
         })
         .on('refresh', () => this.logger.info('SingleDialer:exec - dialog refreshed by uas'))
         .on('modify', async(req, res) => {
@@ -300,14 +302,20 @@ class SingleDialer extends Emitter {
     this.logger = logger;
     this.adulting = true;
     this.emit('adulting');
-    await this.ep.unbridge()
-      .catch((err) => this.logger.info({err}, 'SingleDialer:doAdulting - failed to unbridge ep'));
-    this.ep.play('silence_stream://1000');
+    if (this.ep) {
+      await this.ep.unbridge()
+        .catch((err) => this.logger.info({err}, 'SingleDialer:doAdulting - failed to unbridge ep'));
+      this.ep.play('silence_stream://1000');
+    }
+    else {
+      await this.reAnchorMedia();
+    }
     const cs = new AdultingCallSession({
       logger: this.logger,
       singleDialer: this,
       application,
       callInfo: this.callInfo,
+      accountInfo: this.accountInfo,
       tasks
     });
     cs.exec();
@@ -315,14 +323,25 @@ class SingleDialer extends Emitter {
   }
 
   async releaseMediaToSBC(remoteSdp) {
-    assert(this.dlg);
-    assert(this.dlg.connected);
-    assert(this.ep);
-    assert(typeof remoteSdp === 'string');
-    await this.dlg.modify(remoteSdp);
+    assert(this.dlg && this.dlg.connected && this.ep && typeof remoteSdp === 'string');
+    await this.dlg.modify(remoteSdp, {
+      headers: {
+        'X-Reason': 'release-media'
+      }
+    });
     this.ep.destroy()
       .then(() => this.ep = null)
-      .catch((err) => this.logger.error({err}, 'releaseMediaToSBC: Error destroying endpoint'));
+      .catch((err) => this.logger.error({err}, 'SingleDialer:releaseMediaToSBC: Error destroying endpoint'));
+  }
+
+  async reAnchorMedia() {
+    assert(this.dlg && this.dlg.connected && !this.ep);
+    this.ep = await this.ms.createEndpoint({remoteSdp: this.dlg.remote.sdp});
+    await this.dlg.modify(this.ep.local.sdp, {
+      headers: {
+        'X-Reason': 'anchor-media'
+      }
+    });
   }
 
   _notifyCallStatusChange({callStatus, sipStatus, duration}) {
@@ -347,9 +366,9 @@ class SingleDialer extends Emitter {
   }
 }
 
-function placeOutdial({logger, srf, ms, sbcAddress, target, opts, application, callInfo}) {
+function placeOutdial({logger, srf, ms, sbcAddress, target, opts, application, callInfo, accountInfo}) {
   const myOpts = deepcopy(opts);
-  const sd = new SingleDialer({logger, sbcAddress, target, myOpts, application, callInfo});
+  const sd = new SingleDialer({logger, sbcAddress, target, myOpts, application, callInfo, accountInfo});
   sd.exec(srf, ms, myOpts);
   return sd;
 }

package.json

@@ -37,7 +37,7 @@
     "debug": "^4.3.1",
     "deepcopy": "^2.1.0",
     "drachtio-fsmrf": "^2.0.7",
-    "drachtio-srf": "^4.4.50",
+    "drachtio-srf": "^4.4.55",
     "express": "^4.17.1",
     "ip": "^1.1.5",
     "moment": "^2.29.1",