drachtio-srf 4.5.0 → 4.5.13

package/lib/dialog.js

@@ -198,21 +198,24 @@ class Dialog extends Emitter {
 
     const __x = (callback) => {
       if (this.dialogType === 'INVITE') {
-        this.agent.request({
-          method: 'BYE',
-          headers: opts.headers || {},
-          stackDialogId: this.id,
-          auth: opts.auth || this.auth,
-          _socket: this.socket
-        }, (err, bye) => {
-          if (err || !bye) {
-            return removeDialog(err, bye, callback);
-          }
-
-          bye.on('response', () => {
-            removeDialog(err, bye, callback);
+        try {
+          this.agent.request({
+            method: 'BYE',
+            headers: opts.headers || {},
+            stackDialogId: this.id,
+            auth: opts.auth || this.auth,
+            _socket: this.socket
+          }, (err, bye) => {
+            if (err || !bye) {
+              return removeDialog(err, bye, callback);
+            }
+            bye.on('response', () => {
+              removeDialog(err, bye, callback);
+            });
           });
-        }) ;
+        } catch (err) {
+          removeDialog(err, null, callback);
+        }
         if (this._emitter) {
           Object.assign(this._state, {state: 'terminated'});
           this._emitter.emit('stateChange', this._state);
@@ -223,14 +226,18 @@ class Dialog extends Emitter {
         opts.headers = opts.headers || {} ;
         opts.headers['subscription-state'] = 'terminated';
         opts.headers['event'] = this.subscribeEvent ;
-        this.agent.request({
-          method: 'NOTIFY',
-          headers: opts.headers || {},
-          stackDialogId: this.id,
-          _socket: this.socket
-        }, (err, notify) => {
-          removeDialog(err, notify, callback);
-        }) ;
+        try {
+          this.agent.request({
+            method: 'NOTIFY',
+            headers: opts.headers || {},
+            stackDialogId: this.id,
+            _socket: this.socket
+          }, (err, notify) => {
+            removeDialog(err, notify, callback);
+          }) ;
+        } catch (err) {
+          removeDialog(err, null, callback);
+        }
       }
     };
 
@@ -318,43 +325,48 @@ class Dialog extends Emitter {
         if (opts.headers && !opts.headers['Contact']) {
           opts.headers['Contact'] = this.local.contact;
         }
-        this.agent.request({
-          method: 'INVITE',
-          stackDialogId: this.id,
-          body: this.local.sdp,
-          _socket: this.socket,
-          headers:
-            opts.headers ? opts.headers : {'Contact': this.local.contact}
-        }, (err, req) => {
-          if (err) {
-            this._reinvitesInProgress.count--;
-            const admitOne = this._reinvitesInProgress.admitOne.shift();
-            if (admitOne) setImmediate(admitOne);
-            return callback(err);
-          }
-          req.on('response', (res, ack) => {
-            debug(`Dialog#modifySession: received response to reINVITE with status ${res.status}`) ;
-            if (res.status >= 200) {
-              if (200 === res.status) {
-                this.remote.sdp = res.body ;
-                if (this.local.sdp || opts.noAck !== true) {
-                  ack() ;
-                  onReInviteComplete(this);
-                  return callback(null, res.body);
-                }
-                else {
-                  debug(`opts: ${JSON.stringify(opts)}`);
-                  debug('SipDialog#modify: go 200 OK to 3pcc INVITE with no sdp; ack is application responsibility');
-                  return callback(null, res.body, (sdp) => {
-                    ack({body: sdp});
+        try {
+          this.agent.request({
+            method: 'INVITE',
+            stackDialogId: this.id,
+            body: this.local.sdp,
+            _socket: this.socket,
+            auth: opts.auth || this.auth,
+            headers:
+              opts.headers ? opts.headers : {'Contact': this.local.contact}
+          }, (err, req) => {
+            if (err) {
+              this._reinvitesInProgress.count--;
+              const admitOne = this._reinvitesInProgress.admitOne.shift();
+              if (admitOne) setImmediate(admitOne);
+              return callback(err);
+            }
+            req.on('response', (res, ack) => {
+              debug(`Dialog#modifySession: received response to reINVITE with status ${res.status}`) ;
+              if (res.status >= 200) {
+                if (200 === res.status) {
+                  this.remote.sdp = res.body ;
+                  if (this.local.sdp || opts.noAck !== true) {
+                    ack() ;
                     onReInviteComplete(this);
-                  });
+                    return callback(null, res.body);
+                  }
+                  else {
+                    debug(`opts: ${JSON.stringify(opts)}`);
+                    debug('SipDialog#modify: go 200 OK to 3pcc INVITE with no sdp; ack is application responsibility');
+                    return callback(null, res.body, (sdp) => {
+                      ack({body: sdp});
+                      onReInviteComplete(this);
+                    });
+                  }
                 }
+                callback(new SipError(res.status, res.reason)) ;
               }
-              callback(new SipError(res.status, res.reason)) ;
-            }
-          }) ;
-        });
+            }) ;
+          });
+        } catch (err) {
+          callback(err);
+        }
       });
     };
 
@@ -398,45 +410,48 @@ class Dialog extends Emitter {
     const __x = (callback) => {
       const method = opts.method.toUpperCase() ;
 
-      this.agent.request({
-        method: method,
-        stackDialogId: this.id,
-        headers: opts.headers || {},
-        auth: opts.auth || this.auth,
-        _socket: this.socket,
-        body: opts.body
-      }, (err, req) => {
-        if (err) {
-          return callback(err) ;
-        }
-
-        req.on('response', (res, ack) => {
-          if ('BYE' === method) {
-            this.srf.removeDialog(this) ;
+      try {
+        this.agent.request({
+          method: method,
+          stackDialogId: this.id,
+          headers: opts.headers || {},
+          auth: opts.auth || this.auth,
+          _socket: this.socket,
+          body: opts.body
+        }, (err, req) => {
+          if (err) {
+            return callback(err) ;
           }
-          if ('INVITE' === method && res.status >= 200) {
-            if (res.status > 200 || opts.body || opts.noAck !== true) ack() ;
-            else {
-              debug('SipDialog#request: received 200 OK to 3pcc INVITE sent with no sdp; deferring ack to application');
-              return callback(null, res, ack) ;
+
+          req.on('response', (res, ack) => {
+            if ('BYE' === method) {
+              this.srf.removeDialog(this) ;
+            }
+            if ('INVITE' === method && res.status >= 200) {
+              if (res.status > 200 || opts.body || opts.noAck !== true) ack() ;
+              else {
+                return callback(null, res, ack) ;
+              }
             }
-          }
 
-          if (this.dialogType === 'SUBSCRIBE' && 'NOTIFY' === method &&
-            /terminated/.test(req.get('Subscription-State'))) {
-            debug('received response to a NOTIFY we sent terminating final subscription; dialog is ended') ;
+            if (this.dialogType === 'SUBSCRIBE' && 'NOTIFY' === method &&
+              /terminated/.test(req.get('Subscription-State'))) {
+              debug('received response to a NOTIFY we sent terminating final subscription; dialog is ended') ;
 
-            const from = req.getParsedHeader('From');
-            if (this.removeSubscription(from.uri, req.get('Event')) === 0) {
-              this.connected = false ;
-              this.srf.removeDialog(this) ;
-              this.emit('destroy', req) ;
-              this.removeAllListeners();
+              const from = req.getParsedHeader('From');
+              if (this.removeSubscription(from.uri, req.get('Event')) === 0) {
+                this.connected = false ;
+                this.srf.removeDialog(this) ;
+                this.emit('destroy', req) ;
+                this.removeAllListeners();
+              }
             }
-          }
-          callback(null, res) ;
+            callback(null, res) ;
+          }) ;
         }) ;
-      }) ;
+      } catch (err) {
+        callback(err);
+      }
     } ;
 
     if (callback) {

package/lib/srf.js

@@ -25,6 +25,8 @@ DialogState.Cancelled = 'cancelled';
 DialogDirection.Initiator = 'initiator';
 DialogDirection.Recipient = 'recipient';
 
+const sleepFor = async(ms) => await new Promise((resolve) => setTimeout(resolve, ms));
+
 const noncopyableHdrs = ['via', 'from', 'to', 'call-id', 'cseq', 'contact', 'content-length', 'content-type'];
 function copyAllHeaders(msg, obj) {
   if (msg) Object.keys(msg.headers).forEach((h) => {
@@ -835,7 +837,15 @@ class Srf extends Emitter {
 
       if (remoteSdpB && remoteSdpB === sdpB) {
         // called again with same remote SDP, return previous result
-        return translatedRemoteSdpB ;
+        if (translatedRemoteSdpB) return translatedRemoteSdpB;
+
+        /* race condition: we are still producing the translatedSdp from 183 */
+        await sleepFor(100);
+        if (translatedRemoteSdpB) return translatedRemoteSdpB;
+        await sleepFor(500);
+        if (translatedRemoteSdpB) return translatedRemoteSdpB;
+        await sleepFor(1000);
+        return translatedRemoteSdpB;
       }
 
       remoteSdpB = sdpB ;
@@ -872,7 +882,11 @@ class Srf extends Emitter {
 
     /* get headers from response on uac (B) leg and ready them for inclusion on our response on uas (A) leg */
     function copyUACHeadersToUAS(uacRes) {
-      const headers = {} ;
+      const headers = {};
+      if (!uacRes) {
+        return headers;
+      }
+
       if (proxyResponseHeaders[0] === 'all') {
         copyAllHeaders(uacRes, headers);
         possiblyRemoveHeaders(proxyResponseHeaders.slice(1), headers);
@@ -908,7 +922,7 @@ class Srf extends Emitter {
             try {
               const sdpA = await generateSdpA(provisionalRes);
               opts.body = sdpA ;
-              return res.send(provisionalRes.status, provisionalRes.reason, opts) ;  
+              return res.send(provisionalRes.status, provisionalRes.reason, opts);
             } catch (err) {
               debug(`Srf#createB2BUA: failed in call to produceSdpForALeg: ${err.message}`);
               res.send(500) ;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drachtio-srf",
-  "version": "4.5.0",
+  "version": "4.5.13",
   "description": "drachtio signaling resource framework",
   "main": "lib/srf.js",
   "scripts": {

package/test/docker-compose-testbed.yaml

@@ -161,3 +161,14 @@ services:
     networks:
       testbed:
         ipv4_address: 172.29.0.24
+
+  sipp-uas-reinvite-with-auth:
+    image: drachtio/sipp:latest
+    command: sipp -sf /tmp/uas-reinvite-with-auth.xml
+    container_name: sipp-uas-reinvite-with-auth
+    volumes:
+      - ./scenarios:/tmp
+    tty: true
+    networks:
+      testbed:
+        ipv4_address: 172.29.0.25

package/test/scenarios/uas-reinvite-with-auth.xml

@@ -0,0 +1,213 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="Basic UAS responder">
+  <recv request="INVITE" crlf="true">
+    <action>
+      <ereg regexp="<sip:(.*)>" search_in="hdr" header="Contact:" assign_to="3"/>
+      <log message="Contact hostport is [$3]"/>
+    </action>
+
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 100 Trying
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <send retrans="500">
+    <![CDATA[
+
+      SIP/2.0 407 Proxy Authentication Required
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Proxy-Authenticate: Digest realm="local", nonce="4cdbb733645816512687270b83d2ae5d11e4d9d8"
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv request="ACK"
+        rtd="true"
+        crlf="true">
+    <action>
+      <ereg regexp=".*" search_in="hdr" header="From:" assign_to="1"/>
+      <ereg regexp=".*" search_in="hdr" header="To:" assign_to="2"/>
+    </action>
+  </recv>
+
+
+  <recv request="INVITE" crlf="true">
+    <action>
+      <ereg regexp="<sip:(.*)>" search_in="hdr" header="Contact:" assign_to="3"/>
+      <log message="Contact hostport is [$3]"/>
+    </action>
+
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 100 Trying
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <send retrans="500">
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv request="ACK"
+        rtd="true"
+        crlf="true">
+    <action>
+      <ereg regexp=".*" search_in="hdr" header="From:" assign_to="1"/>
+      <ereg regexp=".*" search_in="hdr" header="To:" assign_to="2"/>
+    </action>
+  </recv>
+
+  <recv request="INVITE" crlf="true">
+    <action>
+      <ereg regexp=".*" search_in="hdr" header="From:" assign_to="1"/>
+      <ereg regexp=".*" search_in="hdr" header="To:" assign_to="2"/>
+    </action>
+  </recv>
+
+  <send retrans="500">
+    <![CDATA[
+
+      SIP/2.0 407 Proxy Authentication Required
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Proxy-Authenticate: Digest realm="local", nonce="4cdbb733645816512687270b83d2ae5d11e4d9d8"
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv request="ACK"
+        rtd="true"
+        crlf="true">
+    <action>
+      <ereg regexp=".*" search_in="hdr" header="From:" assign_to="1"/>
+      <ereg regexp=".*" search_in="hdr" header="To:" assign_to="2"/>
+    </action>
+  </recv>
+
+  <recv request="INVITE" crlf="true">
+    <action>
+      <ereg regexp=".*" search_in="hdr" header="From:" assign_to="1"/>
+      <ereg regexp=".*" search_in="hdr" header="To:" assign_to="2"/>
+    </action>
+
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      [last_Record-Route:]
+      Subject:[$1]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+
+    ]]>
+  </send>
+
+  <recv request="ACK"
+        rtd="true"
+        crlf="true">
+    <action>
+      <ereg regexp=".*" search_in="hdr" header="From:" assign_to="1"/>
+      <ereg regexp=".*" search_in="hdr" header="To:" assign_to="2"/>
+    </action>
+  </recv>
+
+  <recv request="BYE">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      SIP/2.0 200 OK
+      [last_Via:]
+      [last_From:]
+      [last_To:]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Keep the call open for a while in case the 200 is lost to be     -->
+  <!-- able to retransmit it if we receive the BYE again.               -->
+  <timewait milliseconds="4000"/>
+
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>
+

package/test/uac.js

@@ -176,6 +176,32 @@ test('UAC', (t) => {
       srf = new Srf();
       return connect(srf);
     })
+    .then(() => {
+      return srf.createUAC('sip:172.29.0.25', {
+        method: 'INVITE',
+        headers: {
+          To: 'sip:dhorton@sip.drachtio.org',
+          From: 'sip:dhorton@sip.drachtio.org'
+        },
+        auth: {
+          username: 'foo',
+          password: 'bar'
+        }
+      });
+    })
+    .then((uac) => {
+      uacOverlap = uac;
+      return uac.modify('hold');
+    })
+    .then(() => uacOverlap.destroy())
+    .then(() => {
+      srf.disconnect();
+      return t.pass('SipDialog will handle authentication on re-invites');
+    })
+    .then(() => {
+      srf = new Srf();
+      return connect(srf);
+    })
     .then(() => {
       return srf.createUAC('sip:sipp-uas-auth', {
         method: 'INVITE',