Fix: Feature server REFER (#90)

* Update _onFeatureServerTransfer to fix REFER case

* Avoid remote re-invite by using port latching

* Add INFO listener and pretend we're a uas

---------

Co-authored-by: Matt Preskett <matt.preskett@netcall.com>

lib/call-session.js

@@ -99,6 +99,10 @@ class CallSession extends Emitter {
     this._mediaReleased = false;
   }
 
+  get service_provider_sid() {
+    return this.req.locals.service_provider_sid;
+  }
+
   get account_sid() {
     return this.req.locals.account_sid;
   }
@@ -171,6 +175,7 @@ class CallSession extends Emitter {
     this.subscribeRequest = subscribeRequest;
     this.subscribeAnswer = subscribeAnswer;
     this.unsubscribe = unsubscribe;
+    this.srsClients = [];
 
     this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, this.useWss || teams, teams);
     this.rtpEngineResource = {destroy: this.del.bind(null, this.rtpEngineOpts.common)};
@@ -347,9 +352,10 @@ class CallSession extends Emitter {
             this.logger.info({err}, 'Error retrieving iip key');
           }
         }
+        // INVITE request line and To header should be the same.
+        hdrs = {...hdrs, 'To': uri};
         if (gw) {
           this.logger.info({gw}, `sending INVITE to ${uri} via carrier ${gw.name}`);
-          hdrs = {...hdrs, 'To': uri};
           if (gw.diversion) {
             let div = gw.diversion;
             if (div.startsWith('+')) {
@@ -380,7 +386,7 @@ class CallSession extends Emitter {
               '-X-Jambonz-Routing',
               '-X-Jambonz-FS-UUID',
               '-X-Preferred-From-User',
-              'X-Preferred-From-Host',
+              '-X-Preferred-From-Host',
               '-X-Jambonz-FS-UUID',
               '-X-Voip-Carrier-Sid',
             ],
@@ -562,10 +568,7 @@ class CallSession extends Emitter {
         dlg.other = null;
         other.other = null;
 
-        if (this.srsClient) {
-          this.srsClient.stop();
-          this.srsClient = null;
-        }
+        this._stopRecording();
 
         this.logger.info(`call ended with normal termination, there are ${this.activeCallIds.size} active`);
         if (this.activeCallIds.size === 0) this.idleEmitter.emit('idle');
@@ -590,6 +593,13 @@ class CallSession extends Emitter {
     forwardInDialogRequests(uac,  ['notify', 'options', 'message']);
   }
 
+  _stopRecording() {
+    if (this.srsClients.length) {
+      this.srsClients.forEach((c) => c.stop());
+      this.srsClients = [];
+    }
+  }
+
   async _onRefer(dlg, req, res) {
     /* REFER coming in from a sip device, forward to feature server */
     try {
@@ -728,6 +738,7 @@ Duration=${payload.duration} `
             const to = this.req.getParsedHeader('To');
             const aorFrom = from.uri;
             const aorTo = to.uri;
+            const headers = contentType === 'application/json' && req.body ? JSON.parse(req.body) : {};
             this.logger.info({to, from}, 'startCallRecording request for an outbound call');
 
             const srsUrl = req.get('X-Srs-Url');
@@ -735,7 +746,7 @@ Duration=${payload.duration} `
             const callSid = req.get('X-Call-Sid');
             const accountSid = req.get('X-Account-Sid');
             const applicationSid = req.get('X-Application-Sid');
-            if (this.srsClient) {
+            if (this.srsClients.length) {
               res.send(400);
               this.logger.info('discarding duplicate startCallRecording request for a call');
               return;
@@ -745,13 +756,14 @@ Duration=${payload.duration} `
               res.send(400);
               return;
             }
-            this.srsClient = new SrsClient(this.logger, {
+            const arr = srsUrl.split(',');
+            this.srsClients = arr.map((url) => new SrsClient(this.logger, {
               srf: dlg.srf,
               direction: 'outbound',
               originalInvite: this.req,
               callingNumber: this.req.callingNumber,
               calledNumber: this.req.calledNumber,
-              srsUrl,
+              srsUrl: url,
               srsRecordingId,
               callSid,
               accountSid,
@@ -765,42 +777,51 @@ Duration=${payload.duration} `
               del: this.del,
               blockMedia: this.blockMedia,
               unblockMedia: this.unblockMedia,
-              unsubscribe: this.unsubscribe
-            });
+              unsubscribe: this.unsubscribe,
+              headers
+            }));
             try {
-              succeeded = await this.srsClient.start();
+              succeeded = (await Promise.all(
+                this.srsClients.map((c) => c.start())
+              )).every((r) => r);
             } catch (err) {
               this.logger.error({err}, 'Error starting SipRec call recording');
             }
           }
           else if (reason === 'stopCallRecording') {
-            if (!this.srsClient) {
+            if (!this.srsClients.length) {
               res.send(400);
               this.logger.info('discarding stopCallRecording request because we are not recording');
               return;
             }
             try {
-              succeeded = await this.srsClient.stop();
+              succeeded = (await Promise.all(
+                this.srsClients.map((c) => c.stop())
+              )).every((r) => r);
             } catch (err) {
               this.logger.error({err}, 'Error stopping SipRec call recording');
             }
-            this.srsClient = null;
+            this.srsClients = [];
           }
           else if (reason === 'pauseCallRecording') {
-            if (!this.srsClient || this.srsClient.paused) {
+            if (!this.srsClients.length || this.srsClients.every((c) => c.paused)) {
               this.logger.info('discarding invalid pauseCallRecording request');
               res.send(400);
               return;
             }
-            succeeded = await this.srsClient.pause();
+            succeeded = (await Promise.all(
+              this.srsClients.map((c) => c.pause())
+            )).every((r) => r);
           }
           else if (reason === 'resumeCallRecording') {
-            if (!this.srsClient || !this.srsClient.paused) {
+            if (!this.srsClients.length || !this.srsClients.every((c) => c.paused)) {
               res.send(400);
               this.logger.info('discarding invalid resumeCallRecording request');
               return;
             }
-            succeeded = await this.srsClient.resume();
+            succeeded = (await Promise.all(
+              this.srsClients.map((c) => c.resume())
+            )).every((r) => r);
           }
           res.send(succeeded ? 200 : 503);
         }
@@ -886,35 +907,38 @@ Duration=${payload.duration} `
         ...(req.has('X-Retain-Call-Sid') && {'X-Retain-Call-Sid': req.get('X-Retain-Call-Sid')}),
         ...(req.has('X-Account-Sid') && {'X-Account-Sid': req.get('X-Account-Sid')})
       };
-      const dlg = await this.srf.createUAC(referTo.uri, {localSdp: dlg.local.sdp, headers});
-      this.uas = dlg;
-      this.uas.other = this.uac;
-      this.uac.other = this.uas;
-      this.uas.on('modify', this._onReinvite.bind(this, this.uas));
-      this.uas.on('refer', this._onFeatureServerTransfer.bind(this, this.uas));
-      this.uas.on('destroy', () => {
+
+      const uac = await this.srf.createUAC(referTo.uri, {localSdp: dlg.local.sdp, headers});
+      this.uas = uac;
+      uac.type = 'uas';
+      uac.other = this.uac;
+      this.uac.other = uac;
+      uac.on('info', this._onInfo.bind(this, uac));
+      uac.on('modify', this._onReinvite.bind(this, uac));
+      uac.on('refer', this._onFeatureServerTransfer.bind(this, uac));
+      uac.on('destroy', () => {
         this.logger.info('call ended with normal termination');
         this.rtpEngineResource.destroy();
         this.activeCallIds.delete(this.req.get('Call-ID'));
         if (this.activeCallIds.size === 0) this.idleEmitter.emit('idle');
-        this.uas.other.destroy();
+        uac.other.destroy();
         this.srf.endSession(this.req);
       });
 
-      // modify rtpengine to stream to new feature server
-      let response = await this.offer(Object.assign(this.rtpEngineOpts.offer, {sdp: this.uas.remote.sdp}));
+      const opts = {
+        ...this.rtpEngineOpts.common,
+        'from-tag': this.rtpEngineOpts.uas.tag,
+        sdp: uac.remote.sdp,
+        flags: ['port latching']
+      };
+      const response = await this.offer(opts);
       if ('ok' !== response.result) {
-        throw new Error(`_onReinvite: rtpengine failed: offer: ${JSON.stringify(response)}`);
-      }
-      const sdp = await this.uas.other.modify(response.sdp);
-      const opts = Object.assign({sdp, 'to-tag': res.getParsedHeader('To').params.tag},
-        this.rtpEngineOpts.answer);
-      response = await this.answer(opts);
-      if ('ok' !== response.result) {
-        throw new Error(`_onReinvite: rtpengine failed: ${JSON.stringify(response)}`);
+        throw new Error(`_onFeatureServerTransfer: rtpengine offer failed: ${JSON.stringify(response)}`);
       }
+      dlg.destroy().catch(() => {});
       this.logger.info('successfully moved call to new feature server');
     } catch (err) {
+      res.send(488);
       this.logger.error(err, 'Error handling refer from feature server');
     }
   }

package-lock.json

@@ -14,8 +14,8 @@
         "@jambonz/mw-registrar": "0.2.4",
         "@jambonz/realtimedb-helpers": "^0.8.6",
         "@jambonz/rtpengine-utils": "^0.4.3",
-        "@jambonz/siprec-client-utils": "^0.2.5",
-        "@jambonz/stats-collector": "^0.1.8",
+        "@jambonz/siprec-client-utils": "^0.2.6",
+        "@jambonz/stats-collector": "^0.1.9",
         "@jambonz/time-series": "^0.2.5",
         "cidr-matcher": "^2.1.1",
         "debug": "^4.3.4",
@@ -628,18 +628,18 @@
       }
     },
     "node_modules/@jambonz/siprec-client-utils": {
-      "version": "0.2.5",
-      "resolved": "https://registry.npmjs.org/@jambonz/siprec-client-utils/-/siprec-client-utils-0.2.5.tgz",
-      "integrity": "sha512-Ib3M2ecFNxi80gZRG3hcCvxXLLImti1/0bVjAtglGjo1+qn3MyirIVYDchqdabzOC2nWl5aKBEcpG30c2saIDg==",
+      "version": "0.2.6",
+      "resolved": "https://registry.npmjs.org/@jambonz/siprec-client-utils/-/siprec-client-utils-0.2.6.tgz",
+      "integrity": "sha512-z2x6nghLaCfOBPcr36f+1vxsV557X3z5JW1L1RxZg8YPWkTboNIHyHxtEcAua7V9g6EB4G1qv2KDwA+iE5n5Ww==",
       "dependencies": {
         "sdp-transform": "^2.14.1",
         "uuid": "^8.3.2"
       }
     },
     "node_modules/@jambonz/stats-collector": {
-      "version": "0.1.8",
-      "resolved": "https://registry.npmjs.org/@jambonz/stats-collector/-/stats-collector-0.1.8.tgz",
-      "integrity": "sha512-PadBKTmcphU7bZI7pVr4awhoIi+DMLw7An6AGE0GGsLCn2x0IGnxr9k47gI4Bk3OaSF6N7RyVLEAMkJfr24l8Q==",
+      "version": "0.1.9",
+      "resolved": "https://registry.npmjs.org/@jambonz/stats-collector/-/stats-collector-0.1.9.tgz",
+      "integrity": "sha512-JNRBaHQ47pWsXydj4gUp7zc64/0pM89a6E9pA8uQ15l1KxPGYYTrNRdone5aJqLTFOoPl3tYeF1kXj+3nU1nEA==",
       "dependencies": {
         "debug": "^4.3.2",
         "hot-shots": "^8.5.0"
@@ -5293,18 +5293,18 @@
       }
     },
     "@jambonz/siprec-client-utils": {
-      "version": "0.2.5",
-      "resolved": "https://registry.npmjs.org/@jambonz/siprec-client-utils/-/siprec-client-utils-0.2.5.tgz",
-      "integrity": "sha512-Ib3M2ecFNxi80gZRG3hcCvxXLLImti1/0bVjAtglGjo1+qn3MyirIVYDchqdabzOC2nWl5aKBEcpG30c2saIDg==",
+      "version": "0.2.6",
+      "resolved": "https://registry.npmjs.org/@jambonz/siprec-client-utils/-/siprec-client-utils-0.2.6.tgz",
+      "integrity": "sha512-z2x6nghLaCfOBPcr36f+1vxsV557X3z5JW1L1RxZg8YPWkTboNIHyHxtEcAua7V9g6EB4G1qv2KDwA+iE5n5Ww==",
       "requires": {
         "sdp-transform": "^2.14.1",
         "uuid": "^8.3.2"
       }
     },
     "@jambonz/stats-collector": {
-      "version": "0.1.8",
-      "resolved": "https://registry.npmjs.org/@jambonz/stats-collector/-/stats-collector-0.1.8.tgz",
-      "integrity": "sha512-PadBKTmcphU7bZI7pVr4awhoIi+DMLw7An6AGE0GGsLCn2x0IGnxr9k47gI4Bk3OaSF6N7RyVLEAMkJfr24l8Q==",
+      "version": "0.1.9",
+      "resolved": "https://registry.npmjs.org/@jambonz/stats-collector/-/stats-collector-0.1.9.tgz",
+      "integrity": "sha512-JNRBaHQ47pWsXydj4gUp7zc64/0pM89a6E9pA8uQ15l1KxPGYYTrNRdone5aJqLTFOoPl3tYeF1kXj+3nU1nEA==",
       "requires": {
         "debug": "^4.3.2",
         "hot-shots": "^8.5.0"

package.json

@@ -32,8 +32,8 @@
     "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/mw-registrar": "0.2.4",
     "@jambonz/rtpengine-utils": "^0.4.3",
-    "@jambonz/siprec-client-utils": "^0.2.5",
-    "@jambonz/stats-collector": "^0.1.8",
+    "@jambonz/siprec-client-utils": "^0.2.6",
+    "@jambonz/stats-collector": "^0.1.9",
     "@jambonz/time-series": "^0.2.5",
     "cidr-matcher": "^2.1.1",
     "debug": "^4.3.4",

test/scenarios/uac-pcap-sip-routing-success.xml

@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="UAC with media">
+
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16173333456@172.39.0.20 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16173333456@172.39.0.20>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: fff49e33-e771-403a-8c99-1780eabbc803
+      X-Jambonz-Routing: sip
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <recv response="200" rtd="true" crlf="true">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      ACK sip:sip:+16173333456@127.0.0.1 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:sip:+16173333456@127.0.0.1>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="2000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:sip:+16173333456@127.0.0.1 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:sip:+16173333456@127.0.0.1>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+</scenario>

test/sip-tests.js

@@ -44,6 +44,10 @@ test('sbc-outbound tests', async(t) => {
     await sippUac('uac-pcap-carrier-success.xml');
     t.pass('successfully completed outbound call to sip trunk');
 
+    /* call to Sip URI with no lcr configured */
+    await sippUac('uac-pcap-sip-routing-success.xml');
+    t.pass('successfully completed outbound call to sip routing trunk');
+
     /* call to PSTN with no lcr configured */
     await sippUac('uac-pcap-inbound-carrier-success.xml');
     t.pass('successfully completed outbound call to sip trunk');
@@ -92,7 +96,7 @@ test('sbc-outbound tests', async(t) => {
 
     const res = await queryCdrs({account_sid: 'ed649e33-e771-403a-8c99-1780eabbc803'});
     console.log(`${res.total} cdrs: ${JSON.stringify(res)}`);
-    t.ok(res.total === 7, 'wrote 7 cdrs');
+    t.ok(res.total === 8, 'wrote 8 cdrs');
 
     srf.disconnect();
   } catch (err) {