sip-lab 1.30.0 → 1.31.0

package/index.js

@@ -60,6 +60,7 @@ addon.call = {
   send_dtmf: (c_id, params) => { return addon.call_send_dtmf(c_id, JSON.stringify(params)) },
   send_bfsk: (c_id, params) => { return addon.call_send_bfsk(c_id, JSON.stringify(params)) },
   reinvite: (c_id, params) => { return addon.call_reinvite(c_id, JSON.stringify(params ? params : {})) },
+  update: (c_id, params) => { return addon.call_update(c_id, JSON.stringify(params ? params : {})) },
   send_request: (c_id, params) => { return addon.call_send_request(c_id, JSON.stringify(params)) },
   start_record_wav: (c_id, params) => { return addon.call_start_record_wav(c_id, JSON.stringify(params)) },
   start_play_wav: (c_id, params) => { return addon.call_start_play_wav(c_id, JSON.stringify(params)) },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sip-lab",
-  "version": "1.30.0",
+  "version": "1.31.0",
   "description": "",
   "main": "index.js",
   "engines": {
@@ -29,7 +29,7 @@
     "node-gyp-build": "^4.5.0",
     "sdp-matching": "^1.3.2",
     "sip-matching": "^1.3.14",
-    "sipjs-lab": "^1.1.2"
+    "sipjs-lab": "^1.3.13"
   },
   "devDependencies": {
     "prebuildify": "^5.0.1",

package/samples/custom_call_id.js

@@ -0,0 +1,219 @@
+const sip = require ('../index.js')
+const Zeq = require('@mayama/zeq')
+const m = require('data-matching')
+const sip_msg = require('sip-matching')
+const uuid = require('uuid')
+
+// here we create our Zeq instance
+var z = new Zeq()
+
+
+async function test() {
+    z.trap_events(sip.event_source, 'event', (evt) => {
+        var e = evt.args[0]
+        return e
+    })
+
+    sip.set_codecs("pcmu/8000/1:128,pcma/8000/1:128,gsm/8000/1:128")
+
+    console.log(sip.start((data) => { console.log(data)} ))
+
+    const t1 = sip.transport.create({address: "127.0.0.1"})
+    const t2 = sip.transport.create({address: "127.0.0.1"})
+
+    console.log("t1", t1)
+    console.log("t2", t2)
+
+    const call_id = uuid.v4()
+
+    var oc = sip.call.create(t1.id, {
+        from_uri: 'sip:alice@test.com',
+        to_uri: `sip:bob@${t2.address}:${t2.port}`,
+        headers: {
+            'Call-ID': call_id,
+            'Supported': 'timer',
+            'Min-SE': '180',
+            'Session-Expires': '180',
+        },
+    })
+
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+            transport_id: t2.id,
+            msg: sip_msg({
+                $rU: 'bob',
+                $fU: 'alice',
+                $tU: 'bob',
+                $fd: 'test.com',
+                hdr_supported: 'timer',
+                hdr_min_se: '180',
+                hdr_session_expires: '180',
+                $ci: call_id,
+            })
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '100',
+                $rr: 'Trying',
+            }),
+        },
+    ], 1000)
+ 
+
+    var ic = {
+        id: z.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    sip.call.respond(ic.id, {
+        code: 422,
+        reason: 'Session Timer Too Small',
+        headers: {
+            'Supported': 'timer',
+            'Min-SE': '300',
+            'Session-Expires': '300;refresher=uac',
+        },
+    })
+
+    await z.wait([
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'response',
+            call_id: 0,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '422',
+                $rr: 'Session Timer Too Small',
+            }),
+        },
+    ], 1000)
+
+    oc = sip.call.create(t1.id, {
+        from_uri: 'sip:alice@test.com;tag=1c619456422',
+        to_uri: `sip:bob@${t2.address}:${t2.port}`,
+        headers: {
+            'Call-ID': call_id,
+            'Supported': 'timer',
+            'Min-SE': '300',
+            'Session-Expires': '300',
+        },
+    })
+
+    delete z.store.call_id
+
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+            transport_id: t2.id,
+            msg: sip_msg({
+                $rU: 'bob',
+                $fU: 'alice',
+                $tU: 'bob',
+                $fd: 'test.com',
+                hdr_supported: 'timer',
+                hdr_min_se: '300',
+                hdr_session_expires: '300',
+                $ci: call_id,
+            })
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '100',
+                $rr: 'Trying',
+            }),
+        },
+    ], 1000)
+ 
+    ic = {
+        id: z.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    sip.call.respond(ic.id, {
+        code: 200,
+        reason: 'OK',
+        headers: {
+            'Supported': 'timer',
+            'Min-SE': '300',
+            'Session-Expires': '300;refresher=uac',
+        },
+    })
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                hdr_supported: 'timer',
+                hdr_min_se: '300',
+                hdr_session_expires: '300;refresher=uac',
+            }),
+        },
+        {
+            event: 'media_update',
+            call_id: oc.id,
+            status: 'ok',
+        },
+        {
+            event: 'media_update',
+            call_id: ic.id,
+            status: 'ok',
+        },
+    ], 1000)
+
+    await z.sleep(5000)
+
+    sip.call.terminate(oc.id)
+
+    // and wait for termination events
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'BYE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+    ], 1000)
+
+    console.log("Success")
+
+    sip.stop()
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+

package/samples/custom_call_id_and_from_tag.js.future

@@ -0,0 +1,224 @@
+const sip = require ('../index.js')
+const Zeq = require('@mayama/zeq')
+const m = require('data-matching')
+const sip_msg = require('sip-matching')
+const uuid = require('uuid')
+
+// here we create our Zeq instance
+var z = new Zeq()
+
+
+async function test() {
+    z.trap_events(sip.event_source, 'event', (evt) => {
+        var e = evt.args[0]
+        return e
+    })
+
+    sip.set_codecs("pcmu/8000/1:128,pcma/8000/1:128,gsm/8000/1:128")
+
+    console.log(sip.start((data) => { console.log(data)} ))
+
+    const t1 = sip.transport.create({address: "127.0.0.1"})
+    const t2 = sip.transport.create({address: "127.0.0.1"})
+
+    console.log("t1", t1)
+    console.log("t2", t2)
+
+    const call_id = uuid.v4()
+    const from_tag = "my_fake_from_tag"
+
+    var oc = sip.call.create(t1.id, {
+        from_uri: 'sip:alice@test.com',
+        from_tag,
+        to_uri: `sip:bob@${t2.address}:${t2.port}`,
+        headers: {
+            'Call-ID': call_id,
+            'Supported': 'timer',
+            'Min-SE': '180',
+            'Session-Expires': '180',
+        },
+    })
+
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+            transport_id: t2.id,
+            msg: sip_msg({
+                $rU: 'bob',
+                $fU: 'alice',
+                // $ft: from_tag, -- not working. bug in sip-parsing
+                $tU: 'bob',
+                $fd: 'test.com',
+                hdr_supported: 'timer',
+                hdr_min_se: '180',
+                hdr_session_expires: '180',
+                $ci: call_id,
+            })
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '100',
+                $rr: 'Trying',
+            }),
+        },
+    ], 1000)
+ 
+
+    var ic = {
+        id: z.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    sip.call.respond(ic.id, {
+        code: 422,
+        reason: 'Session Timer Too Small',
+        headers: {
+            'Supported': 'timer',
+            'Min-SE': '300',
+            'Session-Expires': '300;refresher=uac',
+        },
+    })
+
+    await z.wait([
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'response',
+            call_id: 0,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '422',
+                $rr: 'Session Timer Too Small',
+            }),
+        },
+    ], 1000)
+
+    oc = sip.call.create(t1.id, {
+        from_uri: 'sip:alice@test.com;tag=1c619456422',
+        from_tag,
+        to_uri: `sip:bob@${t2.address}:${t2.port}`,
+        headers: {
+            'Call-ID': call_id,
+            'Supported': 'timer',
+            'Min-SE': '300',
+            'Session-Expires': '300',
+        },
+    })
+
+    delete z.store.call_id
+
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+            transport_id: t2.id,
+            msg: sip_msg({
+                $rU: 'bob',
+                $fU: 'alice',
+                // $ft: from_tag, -- not working. bug in sip-parsing
+                $tU: 'bob',
+                $fd: 'test.com',
+                hdr_supported: 'timer',
+                hdr_min_se: '300',
+                hdr_session_expires: '300',
+                $ci: call_id,
+            })
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '100',
+                $rr: 'Trying',
+            }),
+        },
+    ], 1000)
+ 
+    ic = {
+        id: z.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    sip.call.respond(ic.id, {
+        code: 200,
+        reason: 'OK',
+        headers: {
+            'Supported': 'timer',
+            'Min-SE': '300',
+            'Session-Expires': '300;refresher=uac',
+        },
+    })
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                hdr_supported: 'timer',
+                hdr_min_se: '300',
+                hdr_session_expires: '300;refresher=uac',
+            }),
+        },
+        {
+            event: 'media_update',
+            call_id: oc.id,
+            status: 'ok',
+        },
+        {
+            event: 'media_update',
+            call_id: ic.id,
+            status: 'ok',
+        },
+    ], 1000)
+
+    await z.sleep(1000)
+
+    sip.call.terminate(oc.id)
+
+    // and wait for termination events
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'BYE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+    ], 1000)
+
+    console.log("Success")
+
+    sip.stop()
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+

package/samples/media_fields.js

@@ -0,0 +1,190 @@
+// This test creates 2 UDP SIP endpoints, makes a call between them and disconeects.
+
+const sip = require ('../index.js')
+const Zeq = require('@mayama/zeq')
+const m = require('data-matching')
+const sip_msg = require('sip-matching')
+
+// here we create our Zeq instance
+var z = new Zeq()
+
+
+async function test() {
+    // here we set our Zeq instance to trap events generated by sip-lab event_source
+    z.trap_events(sip.event_source, 'event', (evt) => {
+        var e = evt.args[0]
+        return e
+    })
+
+    sip.set_codecs("pcmu/8000/1:128,pcma/8000/1:128,gsm/8000/1:128")
+
+    // here we start sip-lab
+    console.log(sip.start((data) => { console.log(data)} ))
+
+    // Here we create the SIP endpoints (transports).
+    // Since we don't specify the port, an available port will be allocated.
+    // Since we don't specify the type ('udp' or 'tcp' or 'tls'), 'udp' will be used by default.
+    const t1 = sip.transport.create({address: "127.0.0.1"})
+    const t2 = sip.transport.create({address: "127.0.0.1"})
+
+    // here we just print the transports
+    console.log("t1", t1)
+    console.log("t2", t2)
+
+    // make the call from t1 to t2 with some custom heaaders
+    const oc = sip.call.create(t1.id, {
+        from_uri: 'sip:alice@test.com',
+        to_uri: `sip:bob@${t2.address}:${t2.port}`,
+        headers: {
+            'X-MyHeader1': 'abc',
+            'X-MyHeader2': 'def',
+        },
+        media: [
+            {
+                type: 'audio',
+                fields: [
+                    'a=bla bla',
+                    'a=fmtp:120 0-16',
+                ],
+            },
+        ],
+    })
+
+    // Here we will wait for the call to arrive at t2 with the custom headers
+    // We will also get a '100 Trying' that is sent by sip-lab automatically
+    // We will wait for at most 1000ms. If all events don't arrive within 1000ms, an exception will be thrown and the test will fail due to timeout.
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+            transport_id: t2.id,
+            msg: sip_msg({
+                $rU: 'bob',
+                $fU: 'alice',
+                $tU: 'bob',
+                $fd: 'test.com',
+                '$hdr(X-MyHeader1)': 'abc',
+                hdr_x_myheader2: 'def',
+            })
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '100',
+                $rr: 'Trying',
+                '$(hdrcnt(via))': 1,
+                '$hdr(call-id)': m.collect('sip_call_id'),
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
+                '$hdr(l)': '0',
+            }),
+        },
+    ], 1000)
+    // Details about zeq wait(list_of_events_to_wait_for, timeout_in_ms):
+    // The order of events in the list is irrelevant.
+    // What matters is that all events arrive within the specified timeout.
+    // When specifying events, you can be as detailed or succinct as you need.
+    // For example, the above event 'response' is waiting for a SIP '100 Trying' to arrive,
+    // but we are specifying several things to match just to show that we can be very detailed when performing a match.
+    // But it could have been just like this:
+    //
+    //  {
+    //      event: 'response',
+    //      call_id: oc.id,
+    //      method: 'INVITE',
+    //      msg: sip_msg({
+    //          $rs: '100',
+    //      }),
+    //  }
+    // Regarding the function sip_msg(), this is a special matching function provided by https://github.com/MayamaTakeshi/sip-matching that makes it 
+    // easy to match a SIP message using openser/kamailio/opensips pseudo-variables syntax.
+ 
+
+    // Here we store data for the incoming call
+    // just to organize our code (not really needed)
+    const ic = {
+        id: z.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    // Now we answer the call at t2 side sending custom headers.
+    sip.call.respond(ic.id, {
+        code: 200,
+        reason: 'OK',
+        headers: {
+            'X-MyHeader3': 'ABC',
+            'X-MyHeader4': 'DEF',
+        },
+    })
+
+    // Then we wait for the '200 OK' at the t1 side with the custom headers.
+    // We will also get event 'media_update' for both sides indicating media streams (RTP) were set up successfully
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                '$(hdrcnt(VIA))': 1,
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
+                '$hdr(content-type)': 'application/sdp',
+                $rb: '!{_}a=sendrecv',
+                '$hdr(X-MyHeader3)': 'ABC',
+                hdr_x_myheader4: 'DEF',
+            }),
+        },
+        {
+            event: 'media_update',
+            call_id: oc.id,
+            status: 'ok',
+        },
+        {
+            event: 'media_update',
+            call_id: ic.id,
+            status: 'ok',
+        },
+    ], 1000)
+
+    // now we terminate the call from t1 side
+    sip.call.terminate(oc.id)
+
+    // and wait for termination events
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'BYE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+    ], 1000)
+
+    console.log("Success")
+
+    sip.stop()
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+