@babblevoice/babble-drachtio-callmanager 1.0.2 → 1.1.0

package/index.js

@@ -3,7 +3,7 @@ const assert = require( "assert" )
 const callmanager = require( "./lib/callmanager.js" )
 const store = require( "./lib/store.js" )
 
-const projectrtp = require( "projectrtp" ).projectrtp
+const projectrtp = require( "@babblevoice/projectrtp" ).projectrtp
 
 const default_options = {
   "preferedcodecs": "g722 ilbc pcmu pcma",

package/lib/call.js

@@ -2,13 +2,13 @@
 const { v4: uuidv4 } = require( "uuid" )
 const events = require( "events" )
 
-const projectrtp = require( "projectrtp" ).projectrtp
+const projectrtp = require( "@babblevoice/projectrtp" ).projectrtp
 
 const parseuri = require( "drachtio-srf" ).parseUri
 const sdpgen = require( "./sdp.js" )
 const callstore = require( "./store.js" )
 
-const sipauth = require( "babble-drachtio-auth" )
+const sipauth = require( "@babblevoice/babble-drachtio-auth" )
 
 /*
 Enum for different reasons for hangup.
@@ -65,7 +65,9 @@ const inboundsiperros = {
   404: hangupcodes.UNALLOCATED_NUMBER
 }
 
-var callmanager
+var callmanager = {
+  "options": {}
+}
 
 /** @class */
 class call {
@@ -110,6 +112,14 @@ class call {
       "refered": false
     }
 
+    /**
+     * @private
+     */
+    this._state = {
+      "_onhangup": false,
+      "_hangup": false
+    }
+
     /**
     @member
     @summary Channels which have been created
@@ -240,6 +250,10 @@ class call {
       }
     }
 
+    this._promises.promise.hangup = new Promise( ( r ) => {
+      this._promises.resolve.hangup = r
+    } )
+
     /**
     @member {object}
     @private
@@ -1025,7 +1039,9 @@ class call {
 
       }, 50000 )
 
-      if( !this._auth.requestauth( this._req, this._res ) ) return this.hangup( hangupcodes.FORBIDDEN )
+      if( !this._auth.requestauth( this._req, this._res ) ) {
+        reject( this.hangup( hangupcodes.FORBIDDEN ) )
+      }
     } )
   }
 
@@ -1060,7 +1076,10 @@ class call {
         return this._auth.requestauth( this._req, this._res )
       }
 
-      this.hangup( hangupcodes.FORBIDDEN )
+      this._em.emit( "call.authed.failed", this )
+      callmanager.options.em.emit( "call.authed.failed", this )
+
+      await this.hangup( hangupcodes.FORBIDDEN )
 
       let r = this._promises.reject.auth
       this._promises.resolve.auth = false
@@ -1071,9 +1090,6 @@ class call {
 
       if( r ) r()
 
-      this._em.emit( "call.authed.failed", this )
-      callmanager.options.em.emit( "call.authed.failed", this )
-
       return
     }
 
@@ -1323,16 +1339,20 @@ class call {
       this._em.emit( "channel", { "call": this, "event": e } )
     } catch ( e ) { console.error( e ) }
 
-    if( "close" === e.action && this.destroyed ) {
+    if( "close" === e.action ) {
       /* keep a record */
-      this.channels.closed.audio.push( e )
-
-      if( "requested" == e.reason ) {
+      if( this.channels.audio.history ) {
+        this.channels.closed.audio.push( this.channels.audio.history )
+      } else {
+        this.channels.closed.audio.push( e )
+      }
+      
+      this.channels.audio = false
+      if( this._state._onhangup ) {
         this._cleanup()
         return
       }
       
-      this.channels.audio = false
       this.hangup() /* ? */
       return
     }
@@ -1567,8 +1587,8 @@ class call {
 
     }, callmanager.options.seexpire )
 
-    dialog.on( "destroy", async ( req ) => {
-      await this._onhangup( "wire" )
+    dialog.on( "destroy", ( req ) => {
+      this._onhangup( "wire" )
     } )
 
     dialog.on( "modify", ( req, res ) => {
@@ -1770,11 +1790,21 @@ class call {
     b_1.detach()
     b_2.detach()
 
+    a_1.channels.audio.unmix()
+    b_1.channels.audio.unmix()
+    b_2.channels.audio.unmix()
+    c_1.channels.audio.unmix()
+
     /* Swap channels and update */
+
+    /* copy all first */
     let a_1_audio = a_1.channels.audio
     let a_1_sdp = a_1.sdp.local
+    let a_1_chem = a_1.channels.audio.em
+    let b_2_chem = b_2.channels.audio.em
 
     a_1.channels.audio = b_2.channels.audio
+    a_1.channels.audio.em = a_1_chem
     a_1.sdp.local = b_2.sdp.local
 
     a_1.sdp.local
@@ -1788,11 +1818,11 @@ class call {
     }
 
     /* Link logically */
-    a_1.children.add( c_1 )
-    c_1.parent = a_1
+    a_1.adopt( c_1 )
 
     /* this one will be hung up soon anyway - so it to has to close the correct one  */
     b_2.channels.audio = a_1_audio
+    b_2.channels.audio.em = b_2_chem
     b_2.sdp.local = a_1_sdp
 
     failed = false
@@ -1879,54 +1909,8 @@ class call {
   }
 
   /**
-    When our dialog has confirmed we have hung up
-    @param {string} [us] - "us"|"wire"
-    @param {object} reason - one of the reasons from the hangupcodes enum - only used if we havn't alread set our reason
-    @private
-  */
-  async _onhangup( src = "us", reason ) {
-
-    if( this.destroyed ) return
-    this.destroyed = true
-
-    this._sethangupcause( src, reason )
-    await callstore.delete( this )
-
-    let r = this._promises.resolve.hangup
-    this._promises.promise.hangup = false
-    this._promises.resolve.hangup = false
-    try{
-      if( r ) r()
-    } catch( e ) {
-      console.error( e )
-    }
-
-    let hangups = []
-    for( let child of this.children ) {
-      hangups.push( child.hangup( this.hangup_cause ) )
-    }
-
-    if( hangups.length > 0 ) {
-      await Promise.all( hangups )
-    }
-
-    this._em.emit( "call.destroyed", this )
-    callmanager.options.em.emit( "call.destroyed", this ) 
-    let audiochannel = this.channels.audio
-    this.channels.audio = false
-    if( audiochannel ) {
-      audiochannel.close()
-      this._timers.cleanup = setTimeout( () => { 
-        console.error( "Timeout waiting for channel close, cleaning up anyway" )
-        this._cleanup() 
-      }, 60000 )
-    } else {
-      this._cleanup()
-    }
-  }
-
-  /**
-    Use this as our destructor. This may get called more than once depending on what is going on
+    Use this as our destructor. This may get called more than once depending on what is going on.
+    Clean up all timers and tidy up any outstanding promises.
     @private
   */
   _cleanup() {
@@ -1951,25 +1935,82 @@ class call {
       this._promises.resolve[ key ] = false
     }
 
+    /* Call outstanding resolves for promises - this will trigger out hangup promise also */
     resolves.forEach( r => r( this ) )
 
     this.removealllisteners()
 
+    this._em.emit( "call.destroyed", this )
+    callmanager.options.em.emit( "call.destroyed", this )
+
     this._em.emit( "call.reporting", this )
     callmanager.options.em.emit( "call.reporting", this )
   }
 
   /**
-    Hangup the call with reason.
-    @param {object} reason - one of the reasons from the hangupcodes enum
+   * Used by our frame to a) continue a hangup which has been initiated by either us or the network.
+   * Complete the hangup, including hanging up all children and waiting for them to complete their
+   * hangup.
+   * @param {string} [us] - "us"|"wire"
+   * @param {object} reason - one of the reasons from the hangupcodes enum - only used if we havn't alread set our reason
+   * @private
+  */
+  async _onhangup( src = "us", reason ) {
+
+    if( this._state._onhangup ) {
+      await this.waitforhangup()
+      return
+    }
+    this._state._onhangup = true
+
+    /* hangup our children */
+    let hangups = []
+    for( let child of this.children ) {
+      hangups.push( child.hangup( this.hangup_cause ) )
+    }
+
+    /* wait for all children to have completed their hangup */
+    if( hangups.length > 0 ) {
+      await Promise.all( hangups )
+    }
+
+    await callstore.delete( this )
+
+    this._sethangupcause( src, reason )
+
+    let audiochannel = this.channels.audio
+    this.channels.audio = false
+    /* flag destroyed so when we receive our close event we know what to do */
+    this.destroyed = true
+    if( audiochannel ) {
+      audiochannel.close()
+      this._timers.cleanup = setTimeout( () => {
+        console.error( "Timeout waiting for channel close, cleaning up anyway", this.uuid )
+        this._cleanup() 
+      }, 60 * 1000 )
+
+      await this.waitforhangup()
+    } else {
+      this._cleanup()
+    }
+  }
+
+  /**
+   * Hangup the call with reason. Public interface for callers to use.
+   * @param {object} reason - one of the reasons from the hangupcodes enum
   */
   async hangup( reason ) {
 
-    if( this.destroyed ) return
+    if( this._state._hangup || this._state._onhangup ) {
+      await this.waitforhangup()
+      return
+    }
+    this._state._hangup = true
 
-    this._sethangupcause( "us", reason )
     await callstore.delete( this )
 
+    this._sethangupcause( "us", reason )
+
     if( this.established ) {
       try {
         await this._dialog.destroy()
@@ -1992,15 +2033,12 @@ class call {
   }
 
   async waitforhangup() {
-    if( this.destroyed ) return
 
     if( !this._promises.promise.hangup ) {
-      this._promises.promise.hangup = new Promise( ( resolve ) => {
-        this._promises.resolve.hangup = resolve
-      } )
+      return
     }
 
-    await this._promises.resolve.hangup
+    await this._promises.promise.hangup
     this._promises.promise.hangup = false
     this._promises.resolve.hangup = false
 
@@ -2149,6 +2187,8 @@ class call {
   */
   static async newuac( options, callbacks = {} ) {
 
+    if( !options.contact && !options.entity ) return false
+
     /* If we don't have a contact we need to look up the entity */
     if( undefined === options.contact ) {
 
@@ -2204,9 +2244,10 @@ class call {
       for( let contact of contactinfo.contacts ) {
         if( undefined === contact ) continue
         let newoptions = { ...options }
-        
-        newoptions.contact = contact.contact
-        call.newuac( newoptions, ourcallbacks )
+        if( contact.contact && "string" == typeof contact.contact ) {
+          newoptions.contact = contact.contact
+          call.newuac( newoptions, ourcallbacks )
+        }
       }
 
       let child = await waitonchildrenpromise

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babblevoice/babble-drachtio-callmanager",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Call processing to create a PBX",
   "main": "index.js",
   "scripts": {
@@ -20,11 +20,15 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "@babblevoice/babble-drachtio-auth": "^1.0.0",
     "chai": "^4.3.4",
     "drachtio-srf": "^4.4.47",
     "mocha": "^9.2.2",
     "uuid": "^8.3.2"
   },
+  "optionalDependencies": {
+    "@babblevoice/projectrtp": "^2.2.0"
+  },
   "bugs": {
     "url": "https://github.com/tinpotnick/babble-drachtio-callmanager/issues"
   },
@@ -32,6 +36,5 @@
   "directories": {
     "lib": "lib",
     "test": "test"
-  },
-  "devDependencies": {}
+  }
 }

package/test/interface/call.js

@@ -3,8 +3,8 @@ const expect = require( "chai" ).expect
 const callmanager = require( "../../index.js" )
 const call = require( "../../lib/call.js" )
 const srf = require( "../mock/srf.js" )
-const projectrtp = require( "projectrtp" ).projectrtp
-const projectrtpmessage = require( "projectrtp/lib/message.js" )
+const projectrtp = require( "@babblevoice/projectrtp" ).projectrtp
+const projectrtpmessage = require( "@babblevoice/projectrtp/lib/message.js" )
 const net = require( "net" )
 
 /* These DO NOT form part of our interface */
@@ -77,10 +77,11 @@ describe( "call object", function() {
     expect( call.channels ).to.have.property( "audio" ).to.be.false
 
     /* if uas */
-    expect( call ).to.have.property( "source" ).that.is.a( "object" )
-    expect( call.source ).to.have.property( "address" ).that.is.a( "string" )
-    expect( call.source ).to.have.property( "port" ).that.is.a( "number" )
-    expect( call.source ).to.have.property( "protocol" ).that.is.a( "string" )
+    expect( call ).to.have.property( "network" ).that.is.a( "object" )
+    expect( call.network ).to.have.property( "remote" ).that.is.a( "object" )
+    expect( call.network.remote ).to.have.property( "address" ).that.is.a( "string" )
+    expect( call.network.remote ).to.have.property( "port" ).that.is.a( "number" )
+    expect( call.network.remote ).to.have.property( "protocol" ).that.is.a( "string" )
     expect( call ).to.have.property( "sip" ).that.is.a( "object" )
     expect( call.sip ).to.have.property( "callid" ).that.is.a( "string" )
     expect( call.sip ).to.have.property( "tags" ).that.is.a( "object" )
@@ -90,6 +91,8 @@ describe( "call object", function() {
     expect( call.hangup_cause.reason ).to.equal( "NORMAL_CLEARING" )
     expect( call.hangup_cause.sip ).to.equal( 487 )
 
+    expect( call.state.cleaned ).to.be.true
+
   } )
 
   it( `uas.newuac - create uac`, async function() {
@@ -160,6 +163,9 @@ describe( "call object", function() {
 
     expect( child.state ).to.have.property( "destroyed" ).that.is.a( "boolean" ).to.be.true
 
+    expect( call.state.cleaned ).to.be.true
+    expect( child.state.cleaned ).to.be.true
+
   } )
 
   it( `uas.newuac - create uac by entity no registrar`, async function() {
@@ -180,9 +186,17 @@ describe( "call object", function() {
     } )
 
     await call.hangup()
+
+    expect( await callstore.stats() ).to.deep.include( {
+      "storebycallid": 0,
+      "storebyuuid": 0,
+      "storebyentity": 0
+    } )
+
+    expect( call.state.cleaned ).to.be.true
   } )
 
-  it( `uas.newuac - create uac by entity with registrar`, async function() {
+  it( `uas.newuac - create uac by entity with registrar #123`, async function() {
 
     let options = {
       "registrar": {
@@ -192,7 +206,7 @@ describe( "call object", function() {
             "realm": "dummy.com",
             "display": "Bob",
             "uri": "1000@dummy.com",
-            "contacts": [ "sip:1000@dummy.com:5060", "sip:1000@dummy.com:5060;transport=blah" ]
+            "contacts": [ { "contact": "sip:1000@dummy.com:5060" }, { "contact": "sip:1000@dummy.com:5060;transport=blah" } ]
           }
         }
       }
@@ -237,6 +251,9 @@ describe( "call object", function() {
 
     expect( srfscenario.options.srf._createuaccount ).to.equal( 2 )
 
+    expect( call.state.cleaned ).to.be.true
+    expect( child.state.cleaned ).to.be.true
+
   } )
 
   it( `uas.newuac - create uac by entity with max limit and registrar`, async function() {
@@ -249,7 +266,7 @@ describe( "call object", function() {
             "realm": "dummy.com",
             "display": "Bob",
             "uri": "1000@dummy.com",
-            "contacts": [ "sip:1000@dummy.com:5060", "sip:1000@dummy.com:5060;transport=blah" ]
+            "contacts": [ { "contact": "sip:1000@dummy.com:5060" }, { "contact": "sip:1000@dummy.com:5060;transport=blah" } ]
           }
         }
       }
@@ -291,6 +308,9 @@ describe( "call object", function() {
     expect( srfscenario.options.srf._createuaccount ).to.equal( 4 )
     expect( child2 ).to.be.false
 
+    expect( child.state.cleaned ).to.be.true
+    expect( child3.state.cleaned ).to.be.true
+
   } )
 
   it( `uas.newuac detatch from parent`, async function() {
@@ -332,6 +352,9 @@ describe( "call object", function() {
       "storebyuuid": 0,
       "storebyentity": 0
     } )
+
+    expect( call.state.cleaned ).to.be.true
+    expect( child.state.cleaned ).to.be.true
   } )
 
   it( `uas.newuac - 486`, async function() {
@@ -369,6 +392,9 @@ describe( "call object", function() {
       "storebyuuid": 0,
       "storebyentity": 0
     } )
+
+    expect( call.state.cleaned ).to.be.true
+    expect( child.state.cleaned ).to.be.true
   } )
 
 
@@ -388,7 +414,7 @@ describe( "call object", function() {
       }
     } ) /* overide default - very short */
 
-    expect( child ).to.be.false
+    expect( child.destroyed ).to.be.true
     expect( children.length ).to.equal( 1 )
     expect( children[ 0 ].destroyed ).to.be.true
 
@@ -409,6 +435,9 @@ describe( "call object", function() {
       "storebyuuid": 0,
       "storebyentity": 0
     } )
+
+    expect( call.state.cleaned ).to.be.true
+    expect( child.state.cleaned ).to.be.true
   } )
 
   it( `uas.newuac - child remote hangup`, async function() {
@@ -461,6 +490,9 @@ describe( "call object", function() {
 
     expect( child.state ).to.have.property( "destroyed" ).that.is.a( "boolean" ).to.be.true
 
+    expect( call.state.cleaned ).to.be.true
+    expect( child.state.cleaned ).to.be.true
+
   } )
 
   it( `uas.newuac - new call event`, async function() {
@@ -511,23 +543,20 @@ describe( "call object", function() {
 
     let srfscenario = new srf.srfscenario()
 
-    let waitforcallresolve
-    let waitforcall = new Promise( ( resolve ) => waitforcallresolve = resolve )
-
-    let ourcall
-    call.newuac( { "contact": "1000@dummy.com" }, { "early": ( c ) => { ourcall = c; waitforcallresolve(); } } )
+    let eventhappened = false
 
-    await waitforcall
+    let c = await new Promise( ( resolve ) => {
+      srfscenario.oncall( async ( call ) => { resolve( call ) } )
+      srfscenario.inbound()
+    } )
 
-    let eventhappened = false
-    ourcall.on( "call.destroyed", ( c ) => {
+    c.on( "call.destroyed", ( c ) => {
       eventhappened = true
     } )
 
-    /* immediately hangup */
-    await ourcall.hangup()
+    await c.hangup()
 
-    expect( eventhappened ).to.be.true
+    expect( eventhappened ).to.be.false
   } )
 
   it( `uas.newuac - answered and destroyed event`, async function() {
@@ -692,6 +721,8 @@ describe( "call object", function() {
       srfscenario.inbound()
     } )
 
+    await c.waitforhangup()
+
     expect( eventhappened ).to.be.true
     expect( c.hangup_cause.reason ).to.equal( "FORBIDDEN" )
     expect( c.hangup_cause.src ).to.equal( "us" )

package/test/interface/events.js

@@ -1,13 +1,7 @@
 
 const expect = require( "chai" ).expect
-const callmanager = require( "../../index.js" )
 const call = require( "../../lib/call.js" )
 const srf = require( "../mock/srf.js" )
-const projectrtp = require( "projectrtp" ).projectrtp
-
-/* These DO NOT form part of our interface */
-const clearcallmanager = require( "../../lib/callmanager.js" )._clear
-const callstore = require( "../../lib/store.js" )
 
 describe( "events", function() {
 

package/test/interface/hold.js

@@ -3,7 +3,7 @@ const expect = require( "chai" ).expect
 const callmanager = require( "../../index.js" )
 const call = require( "../../lib/call.js" )
 const srf = require( "../mock/srf.js" )
-const projectrtp = require( "projectrtp" ).projectrtp
+const projectrtp = require( "@babblevoice/projectrtp" ).projectrtp
 
 /* These DO NOT form part of our interface */
 const clearcallmanager = require( "../../lib/callmanager.js" )._clear

package/test/interface/xfer.js

@@ -3,11 +3,10 @@ const expect = require( "chai" ).expect
 const callmanager = require( "../../index.js" )
 const call = require( "../../lib/call.js" )
 const srf = require( "../mock/srf.js" )
-const projectrtp = require( "projectrtp" ).projectrtp
+const projectrtp = require( "@babblevoice/projectrtp" ).projectrtp
 
 /* These DO NOT form part of our interface */
 const clearcallmanager = require( "../../lib/callmanager.js" )._clear
-const callstore = require( "../../lib/store.js" )
 
 describe( "xfer", function() {
 
@@ -131,16 +130,17 @@ describe( "xfer", function() {
     await b_2._dialog.callbacks.refer( req, res )
 
     /* As part of the process the b_2 client will send us a hangup */
-    b_2.hangup()
+    await b_2._onhangup( "wire" )
 
     /* these two now have a chat before hanging up */
-    a_1.hangup()
-    c_1.hangup()
+    await a_1.hangup()
+    await c_1.hangup()
 
     expect( b_1.hangup_cause.sip ).equal( 487 )
     expect( b_1.hangup_cause.src ).equal( "us" )
     expect( b_1.hangup_cause.reason ).equal( "ATTENDED_TRANSFER" )
 
+    expect( b_2.state.cleaned ).to.be.true
     expect( b_2.hangup_cause.sip ).equal( 487 )
     expect( b_2.hangup_cause.src ).equal( "wire" )
     expect( b_2.hangup_cause.reason ).equal( "ATTENDED_TRANSFER" )

package/test/mock/srf.js

@@ -375,6 +375,7 @@ class srfscenario {
 
       let newcall = call.frominvite( this.req, this.res )
       this.callbacks.call( newcall )
+        .catch( () => newcall.hangup() )
     }
   }
 }