@babblevoice/babble-drachtio-callmanager 3.3.2 → 3.3.4

package/jsconfig.json

@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
-    "module": "commonJS",
+    "module": "node16",
     "target": "es6",
-    "moduleResolution": "node",
+    "moduleResolution": "node16",
     "checkJs": true
   },
   "include": [ "index.js", "babble/*.js", "babble/apps/*.js" ],

package/lib/call.js

@@ -10,7 +10,7 @@ const callstore = require( "./store.js" )
 
 const sipauth = require( "@babblevoice/babble-drachtio-auth" )
 
-const ipv6regex = /^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$/gm
+const ipv6regex = /^(?:[a-fA-F0-9]{1,4}:){7}[a-fA-F0-9]{1,4}$/
 const parseurire = /^(sips?):(?:([^\s>:@]+)(?::([^\s@>]+))?@)?([\w\-.]+)(?::(\d+))?((?:;[^\s=?>;]+(?:=[^\s?;]+)?)*)(?:\?(([^\s&=>]+=[^\s&=>]+)(&[^\s&=>]+=[^\s&=>]+)*))?$/
 const parseuriparamsre = /([^;=]+)(=([^;=]+))?/g
 const parseuriheadersre = /[^&=]+=[^&=]+/g
@@ -218,7 +218,8 @@ class call {
       "audio": undefined,
       "closed": {
         "audio": []
-      }
+      },
+      "count": 0
     }
 
     /**
@@ -554,9 +555,9 @@ class call {
   #fromcontact( startingpoint ) {
     const dest = parseuri( this.options.contact )
     if( !dest ) return
-    startingpoint.uri = dest.uri
-    startingpoint.user = dest.user
-    startingpoint.host = dest.host
+    if( dest.uri ) startingpoint.uri = dest.uri
+    if( dest.user ) startingpoint.user = dest.user
+    if( dest.host ) startingpoint.host = dest.host
   }
 
   #fromdestination( startingpoint ) {
@@ -657,7 +658,6 @@ class call {
         this.#calleridforuac( startingpoint )
       } else {
         const other = this.other
-
         if( other ) {
           if( "uas" == other.type ) {
             other.#calleridforuas( startingpoint )
@@ -731,6 +731,9 @@ class call {
    * @param { string } c
    */
   set callerid( c ) {
+
+    if( undefined == c ) return
+
     if( !this.options.callerid ) this.options.callerid = {}
     if( !this.options.callerid.number ) this.options.callerid.number = ""
 
@@ -742,6 +745,8 @@ class call {
    */
   set calleridname( c ) {
 
+    if( undefined == c ) return
+
     if( !this.options.callerid ) this.options.callerid = {}
     if( !this.options.callerid.name ) this.options.callerid.name = ""
 
@@ -1713,13 +1718,20 @@ class call {
       this.channels.closed.audio.push( e )
     }
 
-    this.channels.audio = false
-    if( this._state._onhangup ) {
-      this._cleanup()
-      return
-    }
+    this.channels.count--
+
+    if ( 0 === this.channels.count ) {
+      this.channels.audio = false
 
-    this.hangup() /* ? */
+      if( this._state._onhangup ) {
+        this._cleanup()
+        return
+      }
+
+      // This will handle _cleanup() later
+      // based on the above flag
+      this.hangup()
+    }
   }
 
   /**
@@ -2006,9 +2018,13 @@ class call {
     same as used elsewhere. If a bond has been attached to the call, we will
     try to reuse an existing channel.
     @param { object } [ channeldef ]
+    @param { object } [ newchannel ]
     @private
   */
-  async reinvite( channeldef ) {
+  async reinvite( channeldef, newchannel ) {
+
+    if ( newchannel )
+      this.channels.audio = newchannel
 
     if ( !channeldef )
       channeldef = await this.#createchannelremotedef()
@@ -2041,17 +2057,43 @@ class call {
       const channeldef = await othercall.#createchannelremotedef()
 
       const oldchannel = othercall.channels.audio
-      // eslint-disable-next-line require-atomic-updates
-      othercall.channels.audio = await this.channels.audio.openchannel( channeldef, othercall._handlechannelevents.bind( othercall ) )
+      const newchannel = await this.#openchannel( channeldef, othercall )
 
-      await othercall.bond( this ).reinvite( channeldef )
+      await othercall.bond( this ).reinvite( channeldef, newchannel )
 
-      await oldchannel.close()
+      await oldchannel.unmix()
+      oldchannel.close()
     }
 
     await this.channels.audio.mix( othercall.channels.audio )
   }
 
+  /**
+    Mix two calls. If the two calls are on a different node
+    the second call is bonded and reinvited.
+    @param { object } channeldef - our call object which is early
+    @param { call } bindcall - the call which will own the channel
+  */
+  async #openchannel( channeldef, bindcall ) {
+
+    let chan = undefined
+
+    if ( !bindcall || !this.channels.audio ) {
+      chan = await projectrtp.openchannel(
+        channeldef, this._handlechannelevents.bind( this ) )
+    } else {
+      chan = await this.channels.audio.openchannel(
+        channeldef, bindcall._handlechannelevents.bind( bindcall ) )
+    }
+
+    if ( bindcall )
+      bindcall.channels.count++
+    else
+      this.channels.count++
+
+    return chan
+  }
+
   /**
    * 
    * @param { object } req 
@@ -2152,20 +2194,32 @@ class call {
     RTP stall timer will kick in first, but if a call is placed on hold followed
     by AWOL... */
     this._timers.seinterval = setInterval( async () => {
-      const opts = {
-        "method": "INVITE",
-        "body": this.sdp.local.toString()
-      }
 
-      const res = await dialog.request( opts )
-        .catch( ( e ) => {
-          console.trace( e )
-          this.hangup( hangupcodes.USER_GONE )
-        } )
+      try{
 
-      if( !this.destroyed && 200 != res.msg.status ) {
-        this.hangup( hangupcodes.USER_GONE )
-      }
+        if( this.destroyed ) {
+          /* this should be done - but we are still running */
+          clearInterval( this._timers.seinterval )
+          return
+        }
+
+        if( "function" != typeof dialog.request ) return
+
+        const opts = {
+          "method": "INVITE",
+          "body": this.sdp.local.toString()
+        }
+  
+        const res = await dialog.request( opts )
+          .catch( ( e ) => {
+            console.trace( e )
+            this.hangup( hangupcodes.USER_GONE )
+          } )
+  
+        if( !this.destroyed && 200 != res.msg.status ) {
+          this.hangup( hangupcodes.USER_GONE )
+        }
+      } catch( e ) { /* empty */ }
 
     }, callmanager.options.seexpire )
 
@@ -2563,7 +2617,6 @@ class call {
     @private
   */
   _cleanup() {
-
     if( this.state.cleaned ) return
     this.state.cleaned = true
 
@@ -2621,7 +2674,7 @@ class call {
     }
     this._state._onhangup = true
 
-    /* hangup our children */
+    /* hangup our children but, no other relations - i.e. children of our parent */
     const hangups = []
     for( const child of this.children ) {
       hangups.push( child.hangup( this.hangup_cause ) )
@@ -2639,7 +2692,7 @@ class call {
     if( this.channels.audio ) {
       this.channels.audio.close()
       this._timers.cleanup = setTimeout( () => {
-        console.trace( "Timeout waiting for channel close, cleaning up anyway", this.uuid )
+        console.trace( this.uuid + " Timeout waiting for channel close, cleaning up anyway, chan uuid: " + this.channels.audio.uuid + ", channel count: " + this.channels.count )
         this._cleanup() 
       }, 60 * 1000 )
 
@@ -2704,12 +2757,19 @@ class call {
   * Send an UPDATE. Use to updated called id, caller id, sdp etc. Send in dialog - TODO look how to send
   * early as this is recomended in the RFC.
   */
-  async update() {
+  async update( remote ) {
 
     /* if we are asked to update it suggests we have received new information and overrides should go */
     delete this.options.callerid
     delete this.options.calledid
 
+    if( remote ) {
+      if( remote.callerid ) {
+        this.callerid = remote.callerid.number
+        this.calleridname = remote.callerid.name
+      }
+    }
+
     this._em.emit( "call.updated", this )
     callmanager.options.em.emit( "call.updated", this )
 
@@ -2841,11 +2901,11 @@ class call {
       if( callbacks.prebridge ) return callbacks.prebridge( c )
     }
 
-    ourcallbacks.confirm = ( c, queuedcall ) => {
+    ourcallbacks.confirm = ( /** @type { call } */ c, /** @type { any } */ cookie ) => {
       if( false !== waitonchildrenresolve ) {
         waitonchildrenresolve( c )
         waitonchildrenresolve = false
-        if( callbacks.confirm ) callbacks.confirm( c, queuedcall )
+        if( callbacks.confirm ) callbacks.confirm( c, cookie )
       }
     }
 
@@ -2885,18 +2945,18 @@ class call {
     detect which mode the channel is in - but the channels property will exist on a connect
     style channel. projectrtp will getrelatives a rewrite to support only one. */
     if( relatedcall && relatedcall.channels.audio && relatedcall.channels.audio.channels ) {
-      this.channels.audio = await this.other.channels.audio.openchannel( channeldef, this._handlechannelevents.bind( this ) )
+      this.channels.audio = await this.#openchannel( channeldef, this )
       return
     }
 
     for( const other of this.relatives ) {
       if( other.channels && other.channels.audio ) {
-        this.channels.audio = await other.channels.audio.openchannel( channeldef, this._handlechannelevents.bind( this ) )
+        this.channels.audio = await other.#openchannel( channeldef, this )
         return
       }
     }
 
-    this.channels.audio = await projectrtp.openchannel( channeldef, this._handlechannelevents.bind( this ) )
+    this.channels.audio = await this.#openchannel( channeldef )
   }
 
   /**
@@ -2953,17 +3013,19 @@ class call {
       return this
     }
 
+    const hangups = []
     if( this.parent ) {
       for( const child of this.parent.children ) {
-        if( child.uuid !== this.uuid && !child.state.established ) {
+        if( child !== this ) {
           child.detach()
           /* do not await - we do not want to delay the winner in 
           connecting by waiting for the completion of the hangups */
-          child.hangup( hangupcodes.LOSE_RACE )
+          hangups.push( child.hangup( hangupcodes.LOSE_RACE ) )
         }
       }
     }
 
+    await Promise.all( hangups )
     callstore.set( this )
 
     if ( this._dialog.sip )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babblevoice/babble-drachtio-callmanager",
-  "version": "3.3.2",
+  "version": "3.3.4",
   "description": "Call processing to create a PBX",
   "main": "index.js",
   "scripts": {

package/test/interface/call.js

@@ -237,6 +237,7 @@ describe( "call object", function() {
       "type": "callerid"
     } )
 
+    /* when newuacv returns, only one of the contacts should hacve succeeded */
     const child = await call.newuac( { "entity": { "uri": "1000@dummy" } } )
 
     expect( await callstore.stats() ).to.deep.include( {
@@ -257,7 +258,7 @@ describe( "call object", function() {
     child.update()
 
     expect( requestoptions.method ).to.equal( "UPDATE" )
-    expect( requestoptions.headers[ "P-Asserted-Identity" ] ).to.equal( "\"\" <sip:0123456789@someotherrealm.com>" )
+    expect( requestoptions.headers[ "remote-party-id" ] ).to.equal( "\"\" <sip:0123456789@someotherrealm.com>;party=calling;screen=yes" )
 
     await call.hangup()
 
@@ -404,8 +405,8 @@ describe( "call object", function() {
     expect( children[ 0 ].hangup_cause.reason ).equal( "USER_BUSY" )
 
     expect( await callstore.stats() ).to.deep.include( {
-      "storebycallid": 1,
-      "storebyuuid": 1,
+      "storebycallid": 2,
+      "storebyuuid": 2,
       "storebyentity": 0
     } )
 
@@ -446,6 +447,9 @@ describe( "call object", function() {
     expect( children[ 0 ].hangup_cause.reason ).equal( "REQUEST_TIMEOUT" )
     expect( children[ 0 ].hangup_cause.src ).equal( "us" )
 
+    /* when we get here the clean up is on teh event loop */
+    await new Promise( resolve => setTimeout( resolve, 100 ) )
+
     expect( await callstore.stats() ).to.deep.include( {
       "storebycallid": 1,
       "storebyuuid": 1,
@@ -785,7 +789,7 @@ describe( "call object", function() {
 
     await call.newuac( options, { "early": ( c ) => c.hangup() } )
 
-    expect( createuacoptions.headers[ "Remote-Party-ID" ] ).to.equal( "\"\" <sip:0000000000@localhost.localdomain>" )
+    expect( createuacoptions.headers[ "remote-party-id" ] ).to.equal( "\"\" <sip:0000000000@localhost.localdomain>;party=calling;screen=yes" )
     expect( createuacoptions.late ).to.be.true
   } )
 
@@ -836,17 +840,16 @@ describe( "call object", function() {
     let requestoptions
     c._dialog.on( "request", ( options ) => requestoptions = options )
 
-    await c.update( { "remote": {
-      "display": "Kermit",
-      "realm": "muppetshow.com",
-      "username": "kermy"
+    await c.update( { "callerid": {
+      "name": "Kermit",
+      "number": "kermy"
     } } )
 
     c.hangup()
 
     expect( requestoptions.method ).to.equal( "UPDATE" )
     expect( requestoptions.body ).to.be.a( "string" )
-    expect( requestoptions.headers[ "P-Asserted-Identity" ] ).to.equal( "\"Kermit\" <sip:kermy@muppetshow.com>" )
+    expect( requestoptions.headers[ "remote-party-id" ] ).to.equal( "\"Kermit\" <sip:kermy@localhost.localdomain>;party=calling;screen=yes" )
 
   } )
 
@@ -1148,7 +1151,7 @@ describe( "call object", function() {
     const c = await call.newuac( options )
 
     /* no default configured */
-    expect( c.options.headers[ "Remote-Party-ID" ] ).to.equal( "\"Hello\" <sip:0000000000@localhost.localdomain>" )
+    expect( c.options.headers[ "remote-party-id" ] ).to.equal( "\"Hello\" <sip:0000000000@localhost.localdomain>;party=calling;screen=yes" )
 
     c._onhangup( "wire" )
 
@@ -1169,7 +1172,7 @@ describe( "call object", function() {
 
 
     /* no default configured */
-    expect( c.options.headers[ "Remote-Party-ID" ] ).to.equal( "\"\" <sip:012345789@localhost.localdomain>" )
+    expect( c.options.headers[ "remote-party-id" ] ).to.equal( "\"\" <sip:012345789@localhost.localdomain>;party=calling;screen=yes" )
 
     c._onhangup( "wire" )
 

package/test/interface/sdp.js

@@ -3,6 +3,8 @@
 const expect = require( "chai" ).expect
 const sdp = require( "../../lib/sdp" )
 
+const dns = require( "node:dns" )
+
 describe( "sdp", function() {
 
   it( "create new sdp object", async function() {
@@ -927,4 +929,77 @@ a=rtpmap:127 telephone-event/8000
     expect( outsdpstring ).include( outsdpstring, "a=rtpmap:110 ilbc/8000" )
 
   } )
+
+  it( "SDP IP V6 candidate", async () => {
+    const wsssdp = `v=0
+o=- 4684977919666729506 2 IN IP4 127.0.0.1
+s=-
+t=0 0
+a=group:BUNDLE 0
+a=extmap-allow-mixed
+a=msid-semantic: WMS 2e008e23-265a-42a0-ba6f-d147a9d0ca42
+m=audio 28022 UDP/TLS/RTP/SAVPF 111 63 9 0 8 13 110 126
+c=IN IP4 209.35.84.57
+a=rtcp:9 IN IP4 0.0.0.0
+a=candidate:1446275835 1 udp 2122129151 192.168.1.108 52396 typ host generation 0 network-id 1
+a=candidate:1833640547 1 udp 2122063615 172.25.160.1 52397 typ host generation 0 network-id 4
+a=candidate:3642338680 1 udp 2122262783 2a01:4b00:ea24:b300:10a8:8a7e:234c:3161 52398 typ host generation 0 network-id 2
+a=candidate:4227024272 1 udp 2122197247 2a01:4b00:ea24:b300:f50b:e799:7a1:8cc3 52399 typ host generation 0 network-id 3
+a=candidate:2218323828 1 udp 1685921535 209.35.84.57 28022 typ srflx raddr 192.168.1.108 rport 52396 generation 0 network-id 1
+a=ice-ufrag:5emx
+a=ice-pwd:T78uDKroul30L+4WytFCzZiv
+a=ice-options:trickle
+a=fingerprint:sha-256 AE:24:0F:8F:23:5C:EE:D5:F8:BD:EB:2C:86:15:13:44:A2:D1:30:9E:74:68:87:8C:50:80:F7:9A:6A:D9:3A:56
+a=setup:actpass
+a=mid:0
+a=extmap:1 urn:ietf:params:rtp-hdrext:ssrc-audio-level
+a=extmap:2 http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time
+a=extmap:3 http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01
+a=extmap:4 urn:ietf:params:rtp-hdrext:sdes:mid
+a=sendrecv
+a=msid:2e008e23-265a-42a0-ba6f-d147a9d0ca42 ff52617f-a48b-454e-9d50-47367329f318
+a=rtcp-mux
+a=rtpmap:111 opus/48000/2
+a=rtcp-fb:111 transport-cc
+a=fmtp:111 minptime=10;useinbandfec=1
+a=rtpmap:63 red/48000/2
+a=fmtp:63 111/111
+a=rtpmap:9 G722/8000
+a=rtpmap:0 PCMU/8000
+a=rtpmap:8 PCMA/8000
+a=rtpmap:13 CN/8000
+a=rtpmap:110 telephone-event/48000
+a=rtpmap:126 telephone-event/8000
+a=ssrc:2953770750 cname:/DZABa/Op+oV703F
+a=ssrc:2953770750 msid:2e008e23-265a-42a0-ba6f-d147a9d0ca42 ff52617f-a48b-454e-9d50-47367329f318
+`.replace( /\r\n/g, "\n" ).replace( /\n/g, "\r\n" )
+
+    const sdpobj = sdp.create( wsssdp )
+    const target = sdpobj.getaudio()
+    const ignoreipv6candidates = true
+    const ipv6regex = /^(?:[a-fA-F0-9]{1,4}:){7}[a-fA-F0-9]{1,4}$/
+
+    let candidates = sdpobj.sdp.media[ 0 ].candidates
+    if( 0 < candidates.length ) {
+      if( ignoreipv6candidates ) {
+        candidates = candidates.filter( ( c ) => { 
+          const ismatch = ipv6regex.test( c.ip )
+          return !ismatch
+        } )
+      }
+
+      candidates.sort( ( l, r ) => { return r.priority - l.priority } )
+      target.port = candidates[ 0 ].port
+
+      await new Promise( ( resolve ) => {
+        dns.lookup( candidates[ 0 ].ip, ( err, result ) => {
+          if( !err ) target.address = result
+          resolve()
+        } )
+      } )
+
+      expect( target.address ).to.equal( "192.168.1.108" )
+      expect( target.port ).to.equal( 52396 )
+    }
+  } )
 } )