Feature/minimal media anchoring (#12)

* feature: release media from freeswitch * handle mute/unmute * linting * update dep * support for relaying dtmf via SIP INFO to FS * fix ci test * handle outdial error
2026-01-25 02:07:59 +00:00 · 2021-10-21 11:59:54 -04:00
parent 2ea516be8a
commit 07f3a55ec3
6 changed files with 178 additions and 4377 deletions
--- a/app.js
+++ b/app.js
@@ -6,9 +6,12 @@ assert.ok(process.env.JAMBONES_MYSQL_HOST &&
 assert.ok(process.env.JAMBONES_REDIS_HOST, 'missing JAMBONES_REDIS_HOST env var');
 assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACHTIO_PORT env var');
 assert.ok(process.env.DRACHTIO_SECRET, 'missing DRACHTIO_SECRET env var');
+assert.ok(process.env.JAMBONES_NETWORK_CIDR, 'missing JAMBONES_NETWORK_CIDR env var');

 const Srf = require('drachtio-srf');
 const srf = new Srf('sbc-outbound');
+const CIDRMatcher = require('cidr-matcher');
+const matcher = new CIDRMatcher([process.env.JAMBONES_NETWORK_CIDR]);
 const opts = Object.assign({
  timestamp: () => {return `, "time": "${new Date().toISOString()}"`;}
 }, {level: process.env.JAMBONES_LOGLEVEL || 'info'});
@@ -73,17 +76,30 @@ const {initLocals, checkLimits, route} = require('./lib/middleware')(srf, logger
  host: process.env.JAMBONES_REDIS_HOST,
  port: process.env.JAMBONES_REDIS_PORT || 6379
 });
-const {getRtpEngine, setRtpEngines} = require('@jambonz/rtpengine-utils')([], logger, {emitter: stats});
+const {getRtpEngine, setRtpEngines} = require('@jambonz/rtpengine-utils')([], logger, {
+  emitter: stats,
+  dtmfListenPort: process.env.DTMF_LISTEN_PORT || 22225
+});
 srf.locals.getRtpEngine = getRtpEngine;

 if (process.env.DRACHTIO_HOST) {
  srf.connect({host: process.env.DRACHTIO_HOST, port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET });
  srf.on('connect', (err, hp) => {
    logger.info(`connected to drachtio listening on ${hp}`);
-    const last = hp.split(',').pop();
-    const arr = /^(.*)\/(.*):(\d+)$/.exec(last);
-    logger.info(`connected to drachtio listening on ${hp}: adding ${arr[2]} to sbc_addresses table`);
-    srf.locals.sipAddress = arr[2];
+
+    const hostports = hp.split(',');
+    for (const hp of hostports) {
+      const arr = /^(.*)\/(.*):(\d+)$/.exec(hp);
+      if (arr && 'udp' === arr[1] && !matcher.contains(arr[2])) {
+        logger.info(`sbc public address: ${arr[2]}`);
+        srf.locals.sipAddress = arr[2];
+      }
+      else if (arr && 'tcp' === arr[1] && matcher.contains(arr[2])) {
+        const hostport = `${arr[2]}:${arr[3]}`;
+        logger.info(`sbc private address: ${hostport}`);
+        srf.locals.privateSipAddress = hostport;
+      }
+    }
  });
 }
 else {
--- a/data/rtp-transcoding.json
+++ b/data/rtp-transcoding.json
@@ -3,5 +3,6 @@
  "DTLS": "off",
  "SDES": "off",
  "ICE": "remove",
+  "flags": ["media handover", "port latching"],
  "rtcp-mux": ["demux"]
 }
--- a/data/srtp-transcoding.json
+++ b/data/srtp-transcoding.json
@@ -3,7 +3,7 @@
    "transport-protocol": "UDP/TLS/RTP/SAVPF",
    "ICE": "force",
    "SDES": "off",
-    "flags": ["generate mid", "SDES-no", "media handover"],
+    "flags": ["generate mid", "SDES-no", "media handover", "port latching"],
    "rtcp-mux": ["require"]  
  },
  "teams": {
--- a/lib/call-session.js
+++ b/lib/call-session.js
@@ -70,6 +70,10 @@ class CallSession extends Emitter {
    return this.req.locals.account_sid;
  }

+  get privateSipAddress() {
+    return this.srf.locals.privateSipAddress;
+  }
+
  async connect() {
    const teams = this.teams = this.req.locals.target === 'teams';
    const engine = this.srf.locals.getRtpEngine();
@@ -78,11 +82,27 @@ class CallSession extends Emitter {
      return this.res.send(480);
    }
    debug(`got engine: ${JSON.stringify(engine)}`);
-    const {offer, answer, del} = engine;
+    const {
+      offer,
+      answer,
+      del,
+      blockMedia,
+      unblockMedia,
+      blockDTMF,
+      unblockDTMF,
+      subscribeDTMF,
+      unsubscribeDTMF
+    } = engine;
    const {createHash, retrieveHash} = this.srf.locals.realtimeDbHelpers;
    this.offer = offer;
    this.answer = answer;
    this.del = del;
+    this.blockMedia = blockMedia;
+    this.unblockMedia = unblockMedia;
+    this.blockDTMF = blockDTMF;
+    this.unblockDTMF = unblockDTMF;
+    this.subscribeDTMF = subscribeDTMF;
+    this.unsubscribeDTMF = unsubscribeDTMF;

    this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, this.useWss || teams, teams);
    this.rtpEngineResource = {destroy: this.del.bind(null, this.rtpEngineOpts.common)};
@@ -212,6 +232,8 @@ class CallSession extends Emitter {
        }
        else this.logger.info(`sending INVITE to ${uri} via proxy ${proxy})`);
        try {
+          const responseHeaders = this.privateSipAddress ? {Contact: `<sip:${this.privateSipAddress}>`} : {};
+
          const {uas, uac} = await this.srf.createB2BUA(this.req, this.res, uri, {
            proxy,
            passFailure,
@@ -219,6 +241,7 @@ class CallSession extends Emitter {
              '-Session-Expires', 'Min-SE'],
            proxyResponseHeaders: ['all', '-Allow', '-Session-Expires'],
            headers: hdrs,
+            responseHeaders,
            auth: gw ? gw.auth : undefined,
            localSdpB: response.sdp,
            localSdpA: async(sdp, res) => {
@@ -242,6 +265,7 @@ class CallSession extends Emitter {
            }
          }, {
            cbRequest: async(err, inv) => {
+              if (err) return this.logger.info({err}, 'CallSession error sending INVITE');
              let trunk = gw ? gw.name : null;
              if (!trunk) {
                if (teams) trunk = 'Microsoft Teams';
@@ -286,7 +310,7 @@ class CallSession extends Emitter {
            !(err instanceof SipError) ||   // unexpected error
            err.status === 487) {           // caller hung up

-            const abandoned = err.message.includes('rtpengine failed: Unknown call-id');
+            const abandoned = err.message && err.message.includes('rtpengine failed: Unknown call-id');
            const status = err.status || (abandoned ? 487 : 500);
            if (err instanceof SipError) this.logger.info(`final call failure  ${status}`);
            else if (!abandoned) this.logger.error(err, 'unexpected call failure');
@@ -336,6 +360,7 @@ class CallSession extends Emitter {
        this.logger.info('call ended');
        this.rtpEngineResource.destroy();
        this.activeCallIds.delete(this.req.get('Call-ID'));
+        this.unsubscribeDTMF(this.logger, this.req.get('Call-ID'), this.rtpEngineOpts.uac.tag);
        dlg.other.destroy();

        this.decrKey(this.callCountKey)
@@ -360,18 +385,52 @@ class CallSession extends Emitter {
      });
    });

+    this.subscribeDTMF(this.logger, this.req.get('Call-ID'), this.rtpEngineOpts.uac.tag,
+      this._onDTMF.bind(this, uas));
+
    uas.on('modify', this._onReinvite.bind(this, uas));
    uac.on('modify', this._onReinvite.bind(this, uac));

    uas.on('refer', this._onFeatureServerTransfer.bind(this, uas));

+    uas.on('info', this._onInfo.bind(this, uas));
+    uac.on('info', this._onInfo.bind(this, uac));

    // default forwarding of other request types
-    forwardInDialogRequests(uac,  ['info', 'notify', 'options', 'message']);
+    forwardInDialogRequests(uac,  ['notify', 'options', 'message']);
+  }
+
+  async _onDTMF(dlg, payload) {
+    this.logger.info({payload}, '_onDTMF');
+    try {
+      let dtmf;
+      switch (payload.event) {
+        case 10:
+          dtmf = '*';
+          break;
+        case 11:
+          dtmf = '#';
+          break;
+        default:
+          dtmf = '' + payload.event;
+          break;
+      }
+      await dlg.request({
+        method: 'INFO',
+        headers: {
+          'Content-Type': 'application/dtmf-relay'
+        },
+        body: `Signal=${dtmf}
+Duration=${payload.duration} `
+      });
+    } catch (err) {
+      this.logger.info({err}, 'Error sending INFO application/dtmf-relay');
+    }
  }

  async _onReinvite(dlg, req, res) {
    try {
+      const reason = req.get('X-Reason');
      const fromTag = dlg.type === 'uas' ? this.rtpEngineOpts.uas.tag : this.rtpEngineOpts.uac.tag;
      const toTag = dlg.type === 'uas' ? this.rtpEngineOpts.uac.tag : this.rtpEngineOpts.uas.tag;
      const offerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uac.mediaOpts : this.rtpEngineOpts.uas.mediaOpts;
@@ -385,13 +444,23 @@ class CallSession extends Emitter {
        direction,
        sdp: req.body,
      };
+      if (reason) opts.flags.push('reset');

      let response = await this.offer(opts);
      if ('ok' !== response.result) {
        res.send(488);
        throw new Error(`_onReinvite: rtpengine failed: offer: ${JSON.stringify(response)}`);
      }
-      const sdp = await dlg.other.modify(response.sdp);
+
+      /* if this is a re-invite from the FS to change media anchoring, avoid sending the reinvite out */
+      let sdp;
+      if (reason && dlg.type === 'uas' && ['release-media', 'anchor-media'].includes(reason)) {
+        this.logger.info(`got a reinvite from FS to ${reason}`);
+        sdp = dlg.other.remote.sdp;
+      }
+      else {
+        sdp = await dlg.other.modify(response.sdp);
+      }
      opts = {
        ...this.rtpEngineOpts.common,
        ...answerMedia,
@@ -410,6 +479,42 @@ class CallSession extends Emitter {
    }
  }

+  async _onInfo(dlg, req, res) {
+    try {
+      if (dlg.type === 'uas' && req.has('X-Reason')) {
+        const toTag = this.rtpEngineOpts.uac.tag;
+        const reason = req.get('X-Reason');
+        const opts = {
+          ...this.rtpEngineOpts.common,
+          'from-tag': toTag
+        };
+        this.logger.info(`_onInfo: got request ${reason}`);
+        res.send(200);
+
+        if (reason.startsWith('mute')) {
+          const response = Promise.all([this.blockMedia(opts), this.blockDTMF(opts)]);
+          this.logger.info({response}, `_onInfo: response to rtpengine command for ${reason}`);
+        }
+        else if (reason.startsWith('unmute')) {
+          const response = Promise.all([this.unblockMedia(opts), this.unblockDTMF(opts)]);
+          this.logger.info({response}, `_onInfo: response to rtpengine command for ${reason}`);
+        }
+      }
+      else {
+        const response = await dlg.other.request({
+          method: 'INFO',
+          headers: req.headers,
+          body: req.body
+        });
+        res.send(response.status, {
+          headers: response.headers,
+          body: response.body
+        });
+      }
+    } catch (err) {
+      this.logger.info({err}, `Error handing INFO request on ${dlg.type} leg`);
+    }
+  }

  async _onFeatureServerTransfer(dlg, req, res) {
    try {
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -22,7 +22,7 @@
  "description": "jambonz session border controller application for outbound calls",
  "scripts": {
    "start": "node app",
-    "test": "NODE_ENV=test JAMBONZ_HOSTING=1 JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_LOGLEVEL=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 node test/ ",
+    "test": "NODE_ENV=test JAMBONZ_HOSTING=1 JAMBONES_NETWORK_CIDR=127.0.0.1/32 JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_LOGLEVEL=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 node test/ ",
    "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
    "jslint": "eslint app.js lib"
  },
@@ -30,12 +30,13 @@
    "@jambonz/db-helpers": "^0.6.12",
    "@jambonz/mw-registrar": "0.2.1",
    "@jambonz/realtimedb-helpers": "^0.4.3",
-    "@jambonz/rtpengine-utils": "^0.1.12",
+    "@jambonz/rtpengine-utils": "^0.1.17",
    "@jambonz/stats-collector": "^0.1.5",
    "@jambonz/time-series": "^0.1.5",
+    "cidr-matcher": "^2.1.1",
    "debug": "^4.3.1",
    "drachtio-fn-b2b-sugar": "^0.0.12",
-    "drachtio-srf": "^4.4.49",
+    "drachtio-srf": "^4.4.55",
    "pino": "^6.11.2"
  },
  "devDependencies": {