@babblevoice/babble-drachtio-callmanager 3.7.21 → 3.7.23

package/README.md

@@ -162,6 +162,30 @@ npm link projectrtp
 npm link babble-drachtio-registrar
 npm link babble-drachtio-auth
 
+If you want to test then projectrtp needs to be able to build locally, this uses the latest projectrtp docker image.
+
+```bash
+docker run --rm -it \
+  -e HOME=/usr/src/app \
+  -v "$(pwd)":/usr/src/app \
+  -w /usr/src/app \
+  tinpotnick/projectrtp \
+  npm test
+
+```
+
+or for a specific test
+
+```bash
+docker run --rm -it \
+  -e HOME=/usr/src/app \
+  -v "$(pwd)":/usr/src/app \
+  -w /usr/src/app \
+  tinpotnick/projectrtp \
+  ./node_modules/mocha/bin/mocha --recursive --check-leaks --grep 'Create call and send 183 - early - SAVPF'
+
+```
+
 # References
 
 * SIP: Session Initiation Protocol [RFC 3261](https://tools.ietf.org/html/rfc3261)

package/lib/call.js

@@ -74,6 +74,29 @@ function getheadervalue( headers, targetKey ) {
   }
 }
 
+
+/**
+ * Used in caller id etc
+ * @param { string } input 
+ * @returns { string }
+ */
+function sanitizecalleridnumber( input ) {
+  if (typeof input !== "string") return ""
+  // Digits, +, #, *
+  return input.replace( /[^a-zA-Z0-9+*#._-]/g, "").slice( 0, 32 )
+}
+
+/**
+ * used in caller id etc
+ * @param { string } input 
+ * @returns { string }
+ */
+function sanitizecalleridname( input ) {
+  if (typeof input !== "string") return ""
+  // Allow letters, numbers, space, dash, underscore, dot
+  return input.replace( /[^a-zA-Z0-9 \-_.',()/+*#&]/g, "" ).slice( 0, 40 )
+}
+
 /*
 Enum for different reasons for hangup.
 */
@@ -213,7 +236,10 @@ class call {
     }
 
     this.counters = {
-      "newuac": 0
+      "newuac": 0,
+      "adoptions": 0,
+      "adoptees": 0,
+      "mixes": 0
     }
 
     /**
@@ -882,7 +908,7 @@ class call {
     if( !this.options.callerid ) this.options.callerid = {}
     if( !this.options.callerid.number ) this.options.callerid.number = ""
 
-    this.options.callerid.number = c
+    this.options.callerid.number = sanitizecalleridnumber( c )
   }
 
   /**
@@ -895,7 +921,7 @@ class call {
     if( !this.options.callerid ) this.options.callerid = {}
     if( !this.options.callerid.name ) this.options.callerid.name = ""
 
-    this.options.callerid.name = c
+    this.options.callerid.name = sanitizecalleridname( c )
   }
 
   /**
@@ -1312,6 +1338,9 @@ class call {
     this.children.add( other )
     other.moh = this.moh
 
+    this.counters.adoptions += 1
+    other.counters.adoptees += 1
+
     /* maintain privacy */
     if ( this.options.privacy )
       other.options.privacy = this.options.privacy
@@ -2412,6 +2441,9 @@ class call {
 
     this.epochs.mix = Math.floor( +new Date() / 1000 )
     othercall.epochs.mix = Math.floor( +new Date() / 1000 )
+
+    this.counters.mixes += 1
+    othercall.counters.mixes += 1
   }
 
   /**
@@ -3617,6 +3649,7 @@ class call {
       if( contact.contact && "string" == typeof contact.contact ) {
         numcontacts++
         newoptions.contact = contact.contact
+        // @ts-ignore
         call.newuac( newoptions, ourcallbacks )
       }
     }
@@ -3814,11 +3847,10 @@ class call {
    * @returns { object }
    */
   #configcalleridfornewuac() {
-
     let callerid, calleridrem
     let party = ";party=calling"
 
-    if( "inbound" === this.direction ) {
+    if( this.direction === "inbound" ) {
       callerid = this.calledid
       calleridrem = this.calledid
     } else {
@@ -3827,11 +3859,23 @@ class call {
       party = ";party=called"
     }
 
-    const calleridstr = `"${callerid.name?callerid.name:callerid.user}" <sip:${callerid.user}@${callerid.host}>`
-    const calleridstrrem = `"${calleridrem.name?calleridrem.name:calleridrem.user}" <sip:${calleridrem.user}@${calleridrem.host}>`
+    // pull out values and sanitise
+    const callername = sanitizecalleridname( callerid.name ? callerid.name : callerid.user )
 
+    const callernumber = sanitizecalleridnumber( callerid.user )
+    const callerhost = callerid.host
+
+    const callernamerem = sanitizecalleridname( calleridrem.name ? calleridrem.name : calleridrem.user )
+    const callernumberrem = sanitizecalleridnumber( calleridrem.user )
+    const callerhostrem = calleridrem.host
+
+    // build header strings
+    const calleridstr = `"${callername}" <sip:${callernumber}@${callerhost}>`
+    const calleridstrrem = `"${callernamerem}" <sip:${callernumberrem}@${callerhostrem}>`
+
+    // handle privacy
     let privacy = ""
-    if( true === this.options.privacy ) {
+    if( this.options.privacy === true ) {
       privacy = ";privacy=full"
     }
 
@@ -3842,7 +3886,7 @@ class call {
     this.options.headers[ "remote-party-id" ] = calleridstrrem + party + ";screen=yes" + privacy
     this.options.headers[ "from" ] = calleridstr
 
-    return { user: callerid.user, realm: callerid.host }
+    return { user: callernumber, realm: callerhost }
   }
 
 
@@ -4306,6 +4350,8 @@ class call {
   set uactimeout( ms ) {
     if( this.established ) return
 
+    ms = Math.min( ms, 30 * 60 * 1000 )
+
     clearTimeout( this._timers.newuac )
     this._timers.newuac = setTimeout( () => {
       this.hangup( hangupcodes.REQUEST_TIMEOUT )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babblevoice/babble-drachtio-callmanager",
-  "version": "3.7.21",
+  "version": "3.7.23",
   "description": "Call processing to create a PBX",
   "main": "index.js",
   "scripts": {
@@ -25,17 +25,17 @@
     "uuid": "^8.3.2"
   },
   "optionalDependencies": {
-    "@babblevoice/projectrtp": "^2.5.28"
+    "@babblevoice/projectrtp": "^2.6.2"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "chai": "^4.3.6",
     "eslint": "^8.32.0",
     "eslint-config-standard-with-typescript": "^30.0.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.1.1",
     "mocha": "^9.2.2",
-    "chai": "^4.3.6",
     "typescript": "^4.9.4"
   },
   "bugs": {

package/test/interface/call.js

@@ -258,7 +258,7 @@ describe( "call object", function() {
     child.update()
 
     expect( requestoptions.method ).to.equal( "UPDATE" )
-    expect( requestoptions.headers[ "remote-party-id" ] ).to.equal( "\"0123456789\" <sip:0123456789@someotherrealm.com>;party=calling;screen=yes" )
+    expect( requestoptions.headers[ "remote-party-id" ] ).to.equal( "\"0123456789\" <sip:0123456789@someotherrealm.com>;party=called;screen=yes" )
 
     /* simulate wire to propogate hangup */
     await call.hangup( call.hangupcodes.NORMAL_CLEARING, false, "wire" )
@@ -790,7 +790,7 @@ describe( "call object", function() {
 
     await call.newuac( options, { "early": ( c ) => c.hangup() } )
 
-    expect( createuacoptions.headers[ "remote-party-id" ] ).to.equal( "\"0000000000\" <sip:0000000000@localhost.localdomain>;party=calling;screen=yes" )
+    expect( createuacoptions.headers[ "remote-party-id" ] ).to.equal( "\"0000000000\" <sip:0000000000@localhost.localdomain>;party=called;screen=yes" )
     expect( createuacoptions.late ).to.be.true
   } )
 
@@ -850,7 +850,7 @@ describe( "call object", function() {
 
     expect( requestoptions.method ).to.equal( "UPDATE" )
     expect( requestoptions.body ).to.be.a( "string" )
-    expect( requestoptions.headers[ "remote-party-id" ] ).to.equal( "\"Kermit\" <sip:kermy@localhost.localdomain>;party=calling;screen=yes" )
+    expect( requestoptions.headers[ "remote-party-id" ] ).to.equal( "\"Kermit\" <sip:kermy@localhost.localdomain>;party=called;screen=yes" )
 
   } )
 
@@ -1068,20 +1068,15 @@ describe( "call object", function() {
     setTimeout( () => connection.write( projectrtpmessage.createmessage( {"id": msgid,"uuid":"6d8ba7bb-44b9-4989-9aaf-5d938b496c49","action":"play","event":"start","reason":"new","status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d5c94"}} ) ), 1 )
     setTimeout( () => connection.write( projectrtpmessage.createmessage( {"id": msgid,"uuid":"6d8ba7bb-44b9-4989-9aaf-5d938b496c49","action":"play","event":"end","reason":"completed","status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d5c94"}} ) ), 10 )
     c.channels.audio.play( { "files": [ { "wav": "/voicemail/greeting.wav", "alt": "greeting" } ] } )
-    let ev = await c.waitforanyevent( { "action": "play", "event": "end" } )
-    expect( ev.action ).to.equal( "play" )
-    expect( ev.event ).to.equal( "end" )
-    expect( ev.reason ).to.equal( "completed" )
+    const playgreetendev = await c.waitforanyevent( { "action": "play", "event": "end" } )
 
     setTimeout( () => connection.write( projectrtpmessage.createmessage( {"id": msgid,"uuid":"6d8ba7bb-44b9-4989-9aaf-5d938b496c49","action":"play","event":"start","reason":"new","status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d5c94"}} ) ) )
     setTimeout( () => connection.write( projectrtpmessage.createmessage( {"id": msgid,"uuid":"6d8ba7bb-44b9-4989-9aaf-5d938b496c49","action":"play","event":"end","reason":"completed","status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d5c94"}} ) ) )
     c.channels.audio.play( { "files": [ { "wav": "/voicemail/boing.wav", "alt": "" } ] } )
-    ev = await c.waitforanyevent( { "action": "play", "event": "end" } )
-    expect( ev.action ).to.equal( "play" )
-    expect( ev.event ).to.equal( "end" )
-    expect( ev.reason ).to.equal( "completed" )
+    const playendev = await c.waitforanyevent( { "action": "play", "event": "end" } )
 
     setTimeout( () => connection.write( projectrtpmessage.createmessage( {"id": msgid,"uuid":"6d8ba7bb-44b9-4989-9aaf-5d938b496c49","action":"record","file":"/tmp/voicemail/recording/03039cdb-1949-407d-91d6-15ba6894955c.wav","event":"recording","status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d5c94"}} ) ), 5 )
+    setTimeout( () => connection.write( projectrtpmessage.createmessage( {"id": msgid,"uuid":"6d8ba7bb-44b9-4989-9aaf-5d938b496c49","action":"record","file":"/tmp/voicemail/recording/03039cdb-1949-407d-91d6-15ba6894955c.wav","event":"finished","event":"finished.channelclosed", "transcription": "test recording for voicemail", "emailed": true, "filesize": 160684, "status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d5c94"}} ) ), 10 )
     
     c.channels.audio.record( {
       "file": "/voicemail/jhjhjgjhgjg.wav",
@@ -1100,15 +1095,25 @@ describe( "call object", function() {
       c._onhangup( "wire" )
     }, 50 )
 
-    ev = await c.waitforanyevent( { "action": "record", "event": /finished.*|\*/ }, 10000 )
-    expect( ev.action ).to.equal( "record" )
-    expect( ev.event ).to.equal( "finished.channelclosed" )
-    expect( ev.transcription ).to.equal( "test recording for voicemail" )
-    expect( ev.emailed ).to.be.true
-    expect( ev.filesize ).to.equal( 160684 )
+    const recordfinishev = await c.waitforanyevent( { "action": "record", "event": /finished.*|\*/ }, 10000 )
 
     connection.destroy()
     await rtpserver.destroy()
+
+    expect( playgreetendev.action ).to.equal( "play" )
+    expect( playgreetendev.event ).to.equal( "end" )
+    expect( playgreetendev.reason ).to.equal( "completed" )
+
+    expect( playendev.action ).to.equal( "play" )
+    expect( playendev.event ).to.equal( "end" )
+    expect( playendev.reason ).to.equal( "completed" )
+
+    expect( recordfinishev.action ).to.equal( "record" )
+    expect( recordfinishev.event ).to.equal( "finished.channelclosed" )
+    expect( recordfinishev.transcription ).to.equal( "test recording for voicemail" )
+    expect( recordfinishev.emailed ).to.be.true
+    expect( recordfinishev.filesize ).to.equal( 160684 )
+
   } )
 
   it( "set get moh", async function() {
@@ -1152,7 +1157,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>;party=calling;screen=yes" )
+    expect( c.options.headers[ "remote-party-id" ] ).to.equal( "\"Hello\" <sip:0000000000@localhost.localdomain>;party=called;screen=yes" )
 
     c._onhangup( "wire" )
 
@@ -1173,7 +1178,7 @@ describe( "call object", function() {
 
 
     /* no default configured */
-    expect( c.options.headers[ "remote-party-id" ] ).to.equal( "\"012345789\" <sip:012345789@localhost.localdomain>;party=calling;screen=yes" )
+    expect( c.options.headers[ "remote-party-id" ] ).to.equal( "\"012345789\" <sip:012345789@localhost.localdomain>;party=called;screen=yes" )
 
     c._onhangup( "wire" )
 

package/test/interface/early.js

@@ -52,6 +52,9 @@ describe( "call early", function() {
     const messagestate = projectrtpmessage.newstate()
     const channelmessages = []
     let opencount = 0
+
+    let ourclosepromise
+    const closepromise = new Promise( resolve => ourclosepromise = resolve )
     
     connection.on( "data", ( data ) => {
       projectrtpmessage.parsemessage( messagestate, data, ( msg ) => {
@@ -87,6 +90,7 @@ describe( "call early", function() {
           } else if ( "close" === msg.channel ) {
             connection.write( projectrtpmessage.createmessage( {"id": msg.id,"uuid":msg.uuid,"action":"close","reason":"requested","stats":{"in":{"mos":4.5,"count":586,"dropped":0,"skip":0},"out":{"count":303,"skip":0},"tick":{"meanus":124,"maxus":508,"count":597}}, "status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d4566"}
             } ) )
+            ourclosepromise()
           } else if ( "mix" === msg.channel ) {
             mixing = true
           }
@@ -140,6 +144,12 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
     const newcall = await call.newuac( { "contact": "callto" } )
     
     await call._onhangup( "wire" )
+
+    await closepromise
+    
+    connection.destroy()
+    rtpserver.destroy()
+
     expect( newcall.state.early ).to.be.true
     expect( call.state.early ).to.be.true
     expect( mixing ).to.be.true
@@ -158,8 +168,6 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
 
     expect( msginfo.body ).to.include( "audio 10010 RTP/AVP" )
 
-    connection.destroy()
-    rtpserver.destroy()
   } )
 
 
@@ -181,6 +189,9 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
     const srfscenario = new srf.srfscenario()
     const rtpserver = callmanager.projectrtp.proxy.addnode( { host: "127.0.0.1", port: 9002 } )
 
+    let ourclosepromise
+    const closepromise = new Promise( resolve => ourclosepromise = resolve )
+
     let connection
     const mockrtp = net.createServer()
     mockrtp.on( "connection", ( c ) => {
@@ -220,6 +231,7 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
             } else if ( "close" === msg.channel ) {
               connection.write( projectrtpmessage.createmessage( {"id": msg.id,"uuid":msg.uuid,"action":"close","reason":"requested","stats":{"in":{"mos":4.5,"count":586,"dropped":0,"skip":0},"out":{"count":303,"skip":0},"tick":{"meanus":124,"maxus":508,"count":597}}, "status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d4566"}
               } ) )
+              ourclosepromise()
             } else if ( "mix" === msg.channel ) {
               mixing = true
             }
@@ -281,6 +293,9 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
     const newcall = await call.newuac( { "contact": "callto" } )
     
     await call._onhangup( "wire" )
+
+    await closepromise 
+
     expect( newcall.state.early ).to.be.true
     expect( call.state.early ).to.be.true
     expect( mixing ).to.be.true
@@ -332,6 +347,9 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
     const messagestate = projectrtpmessage.newstate()
     const channelmessages = []
     let opencount = 0
+
+    let ourclosepromise
+    const closepromise = new Promise( resolve => ourclosepromise = resolve )
     
     connection.on( "data", ( data ) => {
       projectrtpmessage.parsemessage( messagestate, data, ( msg ) => {
@@ -366,6 +384,7 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
             opencount++
           } else if ( "close" === msg.channel ) {
             connection.write( projectrtpmessage.createmessage( {"id": msg.id,"uuid":msg.uuid,"action":"close","reason":"requested","stats":{"in":{"mos":4.5,"count":586,"dropped":0,"skip":0},"out":{"count":303,"skip":0},"tick":{"meanus":124,"maxus":508,"count":597}}, "status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d4566"}}))
+            ourclosepromise()
           } else if ( "mix" === msg.channel ) {
             mixing = true
           }
@@ -427,7 +446,8 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
     const newcall = await call.newuac( { "contact": "callto" } )
     
     await call._onhangup( "wire" )
-    
+    await closepromise
+
     expect( newcall.state.early ).to.be.true
     expect( call.state.early ).to.be.true
     expect( mixing ).to.be.true
@@ -485,6 +505,9 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
     const messagestate = projectrtpmessage.newstate()
     const channelmessages = []
     let opencount = 0
+
+    let ourclosepromise
+    const closepromise = new Promise( resolve => ourclosepromise = resolve )
     
     connection.on( "data", ( data ) => {
       projectrtpmessage.parsemessage( messagestate, data, ( msg ) => {
@@ -519,6 +542,7 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
             opencount++
           } else if ( "close" === msg.channel ) {
             connection.write( projectrtpmessage.createmessage( {"id": msg.id,"uuid":msg.uuid,"action":"close","reason":"requested","stats":{"in":{"mos":4.5,"count":586,"dropped":0,"skip":0},"out":{"count":303,"skip":0},"tick":{"meanus":124,"maxus":508,"count":597}}, "status":{"channel":{"available":4995,"current":5},"workercount":12,"instance":"ca0ef6a9-9174-444d-bdeb-4c9eb54d4566"}} ) )
+            ourclosepromise()
           } else if ( "mix" === msg.channel ) {
             mixing = true
           }
@@ -580,6 +604,10 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
     
     await new Promise( ( resolve ) => setTimeout( () => resolve(), 500 ) )
     await call._onhangup( "wire" )
+    await closepromise
+
+    connection.destroy()
+    rtpserver.destroy()
     
     expect( newcall.state.early ).to.be.true
     expect( call.state.early ).to.be.true
@@ -600,8 +628,6 @@ a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
 
     expect( msginfo.body ).to.include( "UDP/TLS/RTP/SAVPF" )
 
-    connection.destroy()
-    rtpserver.destroy()
   } )
 
 } )