support referby display name (#161)

* forward all refer to feature server

* forwawrd extra custom header

app.js

@@ -68,6 +68,8 @@ const {
   decrKey,
   retrieveSet,
   isMemberOfSet,
+  addKey,
+  retrieveKey
 } = require('@jambonz/realtimedb-helpers')({}, logger);
 
 const activeCallIds = new Map();
@@ -101,6 +103,8 @@ srf.locals = {...srf.locals,
   },
   realtimeDbHelpers: {
     client: redisClient,
+    addKey,
+    retrieveKey,
     createHash,
     retrieveHash,
     incrKey,
@@ -198,6 +202,10 @@ if ('test' !== process.env.NODE_ENV) {
         logger.info(`updating private network cidr from ${srf.locals.privateNetworkCidr} to ${r.private_network_cidr}`);
         srf.locals.privateNetworkCidr = r.private_network_cidr;
       }
+      // Update system log level
+      if (r.log_level) {
+        logger.level = r.log_level;
+      }
     }
   }, 20000);
 }

lib/call-session.js

@@ -1,7 +1,15 @@
 const Emitter = require('events');
 const sdpTransform = require('sdp-transform');
 const SrsClient = require('@jambonz/siprec-client-utils');
-const {makeRtpEngineOpts, nudgeCallCounts, isPrivateVoipNetwork, isBlackListedSipGateway} = require('./utils');
+const {
+  makeRtpEngineOpts,
+  nudgeCallCounts,
+  isPrivateVoipNetwork,
+  isBlackListedSipGateway,
+  makeFullMediaReleaseKey,
+  makePartnerFullMediaReleaseKey
+} = require('./utils');
+const { MediaPath } = require('./constants.json');
 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
 const {SipError, stringifyUri, parseUri} = require('drachtio-srf');
 const debug = require('debug')('jambonz:sbc-outbound');
@@ -13,6 +21,7 @@ const createBLegFromHeader = ({
   logger,
   req,
   host,
+  fromUser,
   register_from_domain,
   transport,
   teams = false,
@@ -22,9 +31,9 @@ const createBLegFromHeader = ({
   const uri = parseUri(from.uri);
   const transportParam = transport ? `;transport=${transport}` : '';
 
-  logger.debug({from, uri, host, scheme, transport, teams}, 'createBLegFromHeader');
+  logger.debug({from, fromUser, uri, host, scheme, transport, teams}, 'createBLegFromHeader');
   /* user */
-  const user = req.get('X-Preferred-From-User') || uri.user || 'anonymous';
+  const user = fromUser || req.get('X-Preferred-From-User') || uri.user || 'anonymous';
 
   /* host */
   if (!host) {
@@ -70,6 +79,7 @@ const initCdr = (req, invite) => {
     account_sid: req.get('X-Account-Sid'),
     call_sid: req.get('X-Call-Sid'),
     sip_callid: invite.get('Call-ID'),
+    ...(req.has('X-CID') && {sip_parent_callid: req.get('X-CID')}),
     ...(applicationSid && {application_sid: applicationSid}),
     from,
     to,
@@ -87,7 +97,10 @@ const updateRtpEngineFlags = (sdp, opts) => {
   try {
     const parsed = sdpTransform.parse(sdp);
     const codec = parsed.media[0].rtp[0].codec;
-    if (['PCMU', 'PCMA'].includes(codec)) opts.flags.push(`codec-accept-${codec}`);
+    if (['PCMU', 'PCMA'].includes(codec)) {
+      opts.flags.push(`codec-accept-${codec}`);
+      opts.flags.push('codec-accept-telephone-event');
+    }
   } catch (err) {}
   return opts;
 };
@@ -106,6 +119,8 @@ class CallSession extends Emitter {
     this.writeCdrs = this.srf.locals.writeCdrs;
 
     this.decrKey = req.srf.locals.realtimeDbHelpers.decrKey;
+    this.addKey = req.srf.locals.realtimeDbHelpers.addKey;
+    this.retrieveKey = req.srf.locals.realtimeDbHelpers.retrieveKey;
 
     const {
       lookupOutboundCarrierForAccount,
@@ -118,7 +133,8 @@ class CallSession extends Emitter {
     this.lookupSipGatewaysByCarrier = lookupSipGatewaysByCarrier;
     this.lookupCarrierByAccountLcr = lookupCarrierByAccountLcr;
 
-    this._mediaReleased = false;
+    this._mediaPath = MediaPath.FullMedia;
+
     this.recordingNoAnswerTimeout = (process.env.JAMBONES_RECORDING_NO_ANSWER_TIMEOUT || 2) * 1000;
   }
 
@@ -139,12 +155,7 @@ class CallSession extends Emitter {
   }
 
   get isMediaReleased() {
-    return this._mediaReleased;
-  }
-
-  get calleeIsUsingSrtp() {
-    const tp = this.rtpEngineOpts?.uac?.mediaOpts['transport-protocol'];
-    return tp && -1 !== tp.indexOf('SAVP');
+    return this._mediaPath !== MediaPath.FullMedia;
   }
 
   subscribeForDTMF(dlg) {
@@ -456,6 +467,7 @@ class CallSession extends Emitter {
             Contact: createBLegFromHeader({
               logger: this.logger,
               req: this.req,
+              ...(gw.auth?.username && {fromUser: gw.auth?.username}),
               scheme,
               transport,
               ...(private_network && {host: this.privateSipAddress})
@@ -519,6 +531,11 @@ class CallSession extends Emitter {
               '-Allow',
               '-Session-Expires'
             ],
+            // Add X-CID header to feature server response.
+            // to allow calling/status hooks contains sbc_callid.
+            responseHeaders: (uacRes, headers) => {
+              headers['X-CID'] = uacRes.get('Call-ID');
+            },
             headers: hdrs,
             auth: gw ? gw.auth : undefined,
             localSdpB: response.sdp,
@@ -645,6 +662,15 @@ class CallSession extends Emitter {
         answered_at: callStart
       };
     }
+
+    /* save far end SDP for later use if we do a full media release */
+    if (process.env.JAMBONES_ENABLE_FULL_MEDIA_RELEASE) {
+      const key = makeFullMediaReleaseKey(this.req.get('X-CID'));
+      const sdp = uac.remote.sdp;
+      this.logger.info({key, sdp}, 'saving far end sdp for full media release feature');
+      this.addKey(key, sdp, 3600).catch((err) => this.logger.error(err, 'Error saving far end sdp'));
+    }
+
     this.uas = uas;
     this.uac = uac;
     [uas, uac].forEach((dlg) => {
@@ -660,7 +686,6 @@ class CallSession extends Emitter {
             if (!IMMUTABLE_HEADERS.includes(h)) headers[h] = bye.headers[h];
           });
           await other.destroy({headers});
-          await other.destroy();
         } catch (err) {}
 
         const trackingOn = process.env.JAMBONES_TRACK_ACCOUNT_CALLS ||
@@ -669,12 +694,16 @@ class CallSession extends Emitter {
 
         if (process.env.JAMBONES_HOSTING || trackingOn) {
           const {writeCallCount, writeCallCountSP, writeCallCountApp} = this.req.srf.locals;
-          await nudgeCallCounts(this.logger, {
-            service_provider_sid: this.service_provider_sid,
-            account_sid: this.account_sid,
-            application_sid: this.application_sid
-          }, this.decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
-            .catch((err) => this.logger.error(err, 'Error decrementing call counts'));
+          if (!this.req.locals.callCountNudged) {
+            this.req.locals.callCountNudged = true;
+            this.logger.debug('decrementing call count at end of call');
+            await nudgeCallCounts(this.logger, {
+              service_provider_sid: this.service_provider_sid,
+              account_sid: this.account_sid,
+              application_sid: this.application_sid
+            }, this.decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
+              .catch((err) => this.logger.error(err, 'Error decrementing call counts'));
+          }
         }
 
         /* write cdr for connected call */
@@ -751,12 +780,19 @@ class CallSession extends Emitter {
   async _onRefer(dlg, req, res) {
     /* REFER coming in from a sip device, forward to feature server */
     try {
+      const customHeaders = Object.keys(req.headers)
+        .filter((h) => h.toLowerCase().startsWith('x-'))
+        .reduce((acc, h) => {
+          acc[h] = req.get(h);
+          return acc;
+        }, {});
       const response = await dlg.other.request({
         method: 'REFER',
         headers: {
           'Refer-To': req.get('Refer-To'),
           'Referred-By': req.get('Referred-By'),
-          'User-Agent': req.get('User-Agent')
+          'User-Agent': req.get('User-Agent'),
+          ...customHeaders
         }
       });
       res.send(response.status, response.reason);
@@ -797,11 +833,32 @@ Duration=${payload.duration} `
     try {
       const reason = req.get('X-Reason');
       const isReleasingMedia = reason && dlg.type === 'uas' && ['release-media', 'anchor-media'].includes(reason);
+      const isFullMediaRelease = reason === 'release-media-entirely' && process.env.JAMBONES_ENABLE_FULL_MEDIA_RELEASE;
       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;
       const answerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uas.mediaOpts : this.rtpEngineOpts.uac.mediaOpts;
       const direction =  dlg.type === 'uas' ? ['private', 'public'] : ['public', 'private'];
+
+      if (isFullMediaRelease) {
+        const a_sdp = await this.retrieveKey(makePartnerFullMediaReleaseKey(this.req.get('X-CID')));
+        this.logger.info({a_sdp}, 'reinvite ourselves out of the media path with this reinvite offer');
+        const answerSdp = await dlg.other.modify(a_sdp);
+        this.logger.info({answerSdp}, 'far end response to full media release');
+        res.send(200, {
+          body: dlg.local.sdp,
+          headers: {
+            'Contact': this.contactHeader
+          }
+        });
+        /* no media going through us now we can destroy the rtpengine resource */
+        this.rtpEngineResource.destroy().catch((err) => {
+          this.logger.info({err}, 'Error destroying rtpengine resource after full media release');
+        });
+        this._mediaPath = MediaPath.NoMedia;
+        return;
+      }
+
       if (isReleasingMedia) {
         if (!offerMedia.flags.includes('port latching')) offerMedia.flags.push('port latching');
         if (!offerMedia.flags.includes('asymmetric')) offerMedia.flags.push('asymmetric');
@@ -827,17 +884,20 @@ Duration=${payload.duration} `
 
       /* if this is a re-invite from the FS to change media anchoring, avoid sending the reinvite out */
       let sdp;
-      if (isReleasingMedia && !this.calleeIsUsingSrtp) {
+      //HL 2024-11-13: previously forwarded re-invites to webrtc clients but further testing has shown to be unnecessary
+      //if (isReleasingMedia && !this.calleeIsUsingSrtp) {
+
+      //DH 2024-11- 18: if we are going from no-media to either partial or full media, we need reinvite the far end
+      if (isReleasingMedia && this._mediaPath !== MediaPath.NoMedia) {
         this.logger.info(`got a reinvite from FS to ${reason}`);
         sdp = dlg.other.remote.sdp;
         if (!answerMedia.flags.includes('port latching')) answerMedia.flags.push('port latching');
         if (!answerMedia.flags.includes('asymmetric')) answerMedia.flags.push('asymmetric');
         answerMedia.flags = answerMedia.flags.filter((f) => f !== 'media handover');
-        this._mediaReleased = 'release-media' === reason;
+        this._mediaPath = 'release-media' === reason ? MediaPath.PartialMedia : MediaPath.FullMedia;
       }
       else {
         sdp = await dlg.other.modify(response.sdp);
-        this.logger.info({sdp}, 'CallSession:_onReinvite: got sdp from 200 OK to invite we sent');
       }
       opts = {
         ...this.rtpEngineOpts.common,
@@ -1086,7 +1146,7 @@ Duration=${payload.duration} `
       // eslint-disable-next-line no-unused-vars
       const { via, from, to, 'call-id': callid, cseq, 'max-forwards': maxforwards,
       // eslint-disable-next-line no-unused-vars
-        'content-length': _contentlength, 'refer-to': _referto, 'referred-by': _referredby,
+        'content-length': _contentlength, 'refer-to': _referto, 'referred-by': referredby,
         // eslint-disable-next-line no-unused-vars
         'X-Refer-To-Leave-Untouched': _leave,
         ...customHeaders
@@ -1098,9 +1158,7 @@ Duration=${payload.duration} `
       const arr = /context-(.*)/.exec(uri.user);
       if (!arr) {
         /* call transfer requested */
-        const referredBy = req.getParsedHeader('Referred-By');
-        if (!referredBy) return res.send(400);
-        const u = parseUri(referredBy.uri);
+        if (!req.has('Referred-By')) return res.send(400);
 
         /* delete contact if it was there from feature server */
         delete customHeaders['contact'];
@@ -1109,7 +1167,7 @@ Duration=${payload.duration} `
           method: 'REFER',
           headers: {
             'Refer-To': `<${stringifyUri(uri)}>`,
-            'Referred-By': `<${stringifyUri(u)}>`,
+            'Referred-By': referredby,
             ...customHeaders
           }
         });

lib/constants.json

@@ -0,0 +1,7 @@
+{
+  "MediaPath": {
+  "NoMedia": "no-media",
+  "PartialMedia": "partial-media",
+  "FullMedia": "full-media"
+  }
+}

lib/middleware.js

@@ -77,7 +77,11 @@ module.exports = (srf, logger, redisClient) => {
     });
 
     try {
-      req.locals.account = await lookupAccountBySid(req.locals.account_sid);
+      const account = await lookupAccountBySid(req.locals.account_sid);
+      req.locals.account = account;
+      if (account.enable_debug_log) {
+        req.locals.logger.level = 'debug';
+      }
       req.locals.service_provider_sid = req.locals.account.service_provider_sid;
     } catch (err) {
       req.locals.logger.error({err}, `Error looking up account sid ${req.locals.account_sid}`);
@@ -102,7 +106,9 @@ module.exports = (srf, logger, redisClient) => {
     try {
       /* decrement count if INVITE is later rejected */
       res.once('end', async({status}) => {
-        if (status > 200) {
+        if (status > 200 && !req.locals.callCountNudged) {
+          req.locals.callCountNudged = true;
+          logger.debug('decrementing call count due to call rejection');
           nudgeCallCounts(logger, {
             service_provider_sid,
             account_sid,
@@ -223,7 +229,10 @@ module.exports = (srf, logger, redisClient) => {
           /* redirect to the correct SBC where this user is connected */
           const proxyAddress = selectHostPort(reg.sbcAddress, 'tcp');
           const redirectUri =  `<sip:${proxyAddress[1]}>`;
-          logger.info(`redirecting call to SBC at ${redirectUri}`);
+          logger.info({
+            myHostPort: req.server.hostport,
+            registeredHostPort: reg.sbcAddress,
+          }, `redirecting call to SBC at ${redirectUri}`);
           return res.send(302, {headers: {Contact: redirectUri}});
         }
         req.locals.registration = reg;

lib/utils.js

@@ -40,7 +40,11 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams
     },
     uac: {
       tag: null,
-      mediaOpts: dstOpts
+      mediaOpts: {
+        ...dstOpts,
+        ...(process.env.JAMBONES_CODEC_OFFER_WITH_ORDER &&
+          { codec: { offer: process.env.JAMBONES_CODEC_OFFER_WITH_ORDER.split(','), strip: 'all' } }),
+      }
     }
   };
 }
@@ -229,6 +233,13 @@ async function isBlackListedSipGateway(client, logger, sip_gateway_sid) {
   }
 }
 
+const makeFullMediaReleaseKey = (callId) => {
+  return `b_sdp:${callId}`;
+};
+const makePartnerFullMediaReleaseKey = (callId) => {
+  return `a_sdp:${callId}`;
+};
+
 module.exports = {
   makeRtpEngineOpts,
   selectHostPort,
@@ -240,5 +251,7 @@ module.exports = {
   createHealthCheckApp,
   nudgeCallCounts,
   isPrivateVoipNetwork,
-  isBlackListedSipGateway
+  isBlackListedSipGateway,
+  makeFullMediaReleaseKey,
+  makePartnerFullMediaReleaseKey
 };

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "sbc-outbound",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "sbc-outbound",
-      "version": "0.9.0",
+      "version": "0.9.2",
       "license": "MIT",
       "dependencies": {
         "@jambonz/db-helpers": "^0.9.7",
@@ -14,9 +14,9 @@
         "@jambonz/mw-registrar": "0.2.7",
         "@jambonz/realtimedb-helpers": "^0.8.9",
         "@jambonz/rtpengine-utils": "^0.4.4",
-        "@jambonz/siprec-client-utils": "^0.2.7",
+        "@jambonz/siprec-client-utils": "^0.2.9",
         "@jambonz/stats-collector": "^0.1.10",
-        "@jambonz/time-series": "^0.2.8",
+        "@jambonz/time-series": "^0.2.10",
         "cidr-matcher": "^2.1.1",
         "debug": "^4.3.4",
         "drachtio-fn-b2b-sugar": "^0.1.0",
@@ -33,7 +33,7 @@
         "tape": "^5.7.5"
       },
       "engines": {
-        "node": ">= 12.0.0"
+        "node": ">= 18.0.0"
       }
     },
     "node_modules/@ampproject/remapping": {
@@ -628,9 +628,10 @@
       }
     },
     "node_modules/@jambonz/siprec-client-utils": {
-      "version": "0.2.7",
-      "resolved": "https://registry.npmjs.org/@jambonz/siprec-client-utils/-/siprec-client-utils-0.2.7.tgz",
-      "integrity": "sha512-VztOToBfXnOphg/y6kO+lBYqoDH7X5Ci0daXT5zQ8v5NnaZw+UwxGeFPX3knIR3r5pmzUld0f2giFOuD4ZOF8w==",
+      "version": "0.2.9",
+      "resolved": "https://registry.npmjs.org/@jambonz/siprec-client-utils/-/siprec-client-utils-0.2.9.tgz",
+      "integrity": "sha512-C/1UOrAvQVG0iwiSMS0MC9VHRjhg3/sOjNna+eEjHjws1SHl8NrKBoDL8uOwLqOM2ccpbqCPH9GJAxo5OnOhww==",
+      "license": "MIT",
       "dependencies": {
         "sdp-transform": "^2.14.1",
         "uuid": "^8.3.2"
@@ -646,9 +647,10 @@
       }
     },
     "node_modules/@jambonz/time-series": {
-      "version": "0.2.8",
-      "resolved": "https://registry.npmjs.org/@jambonz/time-series/-/time-series-0.2.8.tgz",
-      "integrity": "sha512-iFSKPAEElb3NXVAKYlr+2Q08zNhv8SlsS4I1Bwg4gFIj4Tku0vHzoXk6WTCzMRY1hE4YbBPbImNYLW9BfzMJjw==",
+      "version": "0.2.10",
+      "resolved": "https://registry.npmjs.org/@jambonz/time-series/-/time-series-0.2.10.tgz",
+      "integrity": "sha512-Y7Ih2ej6SxK2kZzI1BRLL5ytaxicmIPI/uZB5Sf02kl1/O/ddJ45/xI7OipSu8SPkTuRLRJwkFgTmYekBiUHfw==",
+      "license": "MIT",
       "dependencies": {
         "debug": "^4.3.1",
         "influx": "^5.9.3"

package.json

@@ -1,9 +1,9 @@
 {
   "name": "sbc-outbound",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "main": "app.js",
   "engines": {
-    "node": ">= 12.0.0"
+    "node": ">= 18.0.0"
   },
   "keywords": [
     "sip",
@@ -32,9 +32,9 @@
     "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/mw-registrar": "0.2.7",
     "@jambonz/rtpengine-utils": "^0.4.4",
-    "@jambonz/siprec-client-utils": "^0.2.7",
+    "@jambonz/siprec-client-utils": "^0.2.9",
     "@jambonz/stats-collector": "^0.1.10",
-    "@jambonz/time-series": "^0.2.8",
+    "@jambonz/time-series": "^0.2.10",
     "cidr-matcher": "^2.1.1",
     "debug": "^4.3.4",
     "drachtio-fn-b2b-sugar": "^0.1.0",

test/db/jambones-sql.sql

@@ -358,7 +358,9 @@ CREATE TABLE system_information
 (
 domain_name VARCHAR(255),
 sip_domain_name VARCHAR(255),
-monitoring_domain_name VARCHAR(255)
+monitoring_domain_name VARCHAR(255),
+private_network_cidr VARCHAR(8192),
+log_level ENUM('info', 'debug') NOT NULL DEFAULT 'info'
 );
 
 CREATE TABLE users
@@ -552,6 +554,7 @@ siprec_hook_sid CHAR(36),
 record_all_calls BOOLEAN NOT NULL DEFAULT false,
 record_format VARCHAR(16) NOT NULL DEFAULT 'mp3',
 bucket_credential VARCHAR(8192) COMMENT 'credential used to authenticate with storage service',
+enable_debug_log BOOLEAN NOT NULL DEFAULT false,
 PRIMARY KEY (account_sid)
 ) COMMENT='An enterprise that uses the platform for comm services';
 

test/docker-compose-testbed.yaml

@@ -24,7 +24,7 @@ services:
         ipv4_address: 172.39.0.2
 
   sbc:
-    image: drachtio/drachtio-server:latest
+    image: drachtio/drachtio-server:0.8.26
     command: drachtio --contact "sip:*;transport=udp" --loglevel debug --sofia-loglevel 9
     ports:
       - "9060:9022/tcp"