sip-lab 1.11.4 → 1.12.2

package/samples/simple.js

@@ -1,34 +1,45 @@
-var sip = require ('../index.js')
-var Zester = require('zester')
+// This test creates 2 UDP SIP endpoints, makes a call between them and disconeects.
+
+const sip = require ('../index.js')
+const Zester = require('zester')
+const m = require('data-matching')
+const sip_msg = require('sip-matching')
+
+// here we create our Zester instance
 var z = new Zester()
-var m = require('data-matching')
-var sip_msg = require('sip-matching')
 
-async function test() {
-    //sip.set_log_level(6)
-    sip.dtmf_aggregation_on(500)
 
+async function test() {
+    // here we set our zester 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
     })
 
+    // here we start sip-lab
     console.log(sip.start((data) => { console.log(data)} ))
 
-    t1 = sip.transport.create("127.0.0.1", 5090, 1)
-    t2 = sip.transport.create("127.0.0.1", 5092, 1)
+    // 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)
 
-    flags = 0
-
-    oc = sip.call.create(t1.id, flags, 'sip:a@t', 'sip:b@127.0.0.1:5092')
+    // make the call from t1 to t2
+    const oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`})
 
+    // Here we will wait for the call to arrive at t2
+    // 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,
         },
         {
             event: 'response',
@@ -39,22 +50,61 @@ async function test() {
                 $rr: 'Trying',
                 '$(hdrcnt(via))': 1,
                 '$hdr(call-id)': m.collect('sip_call_id'),
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(l)': '0',
             }),
         },
     ], 1000)
-
-    ic = {
+    // Details about zester 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 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,
     }
 
-    sip.call.respond(ic.id, 200, 'OK')
+    // Now we answer the call at t2 side
+    sip.call.respond(ic.id, {code: 200, reason: 'OK'})
 
+    // Then we wait for the '200 OK' at the t1 side
+    // We will also get event 'media_status' 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',
+            }),
+        },
         {
             event: 'media_status',
             call_id: oc.id,
@@ -69,26 +119,22 @@ async function test() {
             local_mode: 'sendrecv',
             remote_mode: 'sendrecv',
         },
+    ], 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: 'INVITE',
+            method: 'BYE',
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(VIA))': 1,
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
-                '$hdr(content-type)': 'application/sdp',
-                $rb: '!{_}a=sendrecv',
             }),
         },
-    ], 1000)
-
-    sip.call.terminate(oc.id)
-
-    await z.wait([
         {
             event: 'call_ended',
             call_id: oc.id,
@@ -97,15 +143,6 @@ async function test() {
             event: 'call_ended',
             call_id: ic.id,
         },
-        {
-            event: 'response',
-            call_id: oc.id,
-            method: 'BYE',
-            msg: sip_msg({
-                $rs: '200',
-                $rr: 'OK',
-            }),
-        },
     ], 1000)
 
     console.log("Success")

package/samples/sip_cancel.js

@@ -15,15 +15,13 @@ async function test() {
 
     console.log(sip.start((data) => { console.log(data)} ))
 
-    t1 = sip.transport.create("127.0.0.1", 5090, 1)
-    t2 = sip.transport.create("127.0.0.1", 5092, 1)
+    t1 = sip.transport.create({address: "127.0.0.1", port: 5090, type: 'udp'})
+    t2 = sip.transport.create({address: "127.0.0.1", port: 5092, type: 'udp'})
 
     console.log("t1", t1)
     console.log("t2", t2)
 
-    flags = 0
-
-    oc = sip.call.create(t1.id, flags, 'sip:a@t', 'sip:b@127.0.0.1:5092')
+    oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`})
 
     await z.wait([
         {
@@ -39,9 +37,9 @@ async function test() {
                 $rr: 'Trying',
                 '$(hdrcnt(via))': 1,
                 '$hdr(call-id)': m.collect('sip_call_id'),
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(l)': '0',
             }),
         },
@@ -52,7 +50,7 @@ async function test() {
         sip_call_id: z.store.sip_call_id,
     }
 
-    sip.call.respond(ic.id, 180, 'Ringing')
+    sip.call.respond(ic.id, {code: 180, reason: 'Ringing'})
 
     await z.wait([
         {
@@ -63,9 +61,9 @@ async function test() {
                 $rs: '180',
                 $rr: 'Ringing',
                 '$(hdrcnt(VIA))': 1,
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
             }),
         },
     ], 1000)

package/samples/tcp_and_extra_headers.js

@@ -0,0 +1,333 @@
+var sip = require ('../index.js')
+var Zester = require('zester')
+var z = new Zester()
+var m = require('data-matching')
+var sip_msg = require('sip-matching')
+
+async function test() {
+    //sip.set_log_level(6)
+    sip.dtmf_aggregation_on(500)
+
+    z.trap_events(sip.event_source, 'event', (evt) => {
+        var e = evt.args[0]
+        return e
+    })
+
+    console.log(sip.start((data) => { console.log(data)} ))
+
+    t1 = sip.transport.create({address: "127.0.0.1", port: 5090, type: 'tcp'})
+    t2 = sip.transport.create({address: "127.0.0.1", port: 5092, type: 'tcp'})
+
+    console.log("t1", t1)
+    console.log("t2", t2)
+
+    oc = sip.call.create(t1.id, {
+        from_uri: '"abc"<sip:alice@test.com>',
+        to_uri: `sip:bob@${t2.address}:${t2.port}`,
+        headers: {
+            'X-MyHeader1': 'abc',
+            'X-MyHeader2': 'def',
+        },
+    })
+
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+            msg: sip_msg({
+                $rm: 'INVITE',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
+                '$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)
+
+    ic = {
+        id: z.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    sip.call.respond(ic.id, {
+        code: 200,
+        reason:'OK',
+        headers: {
+            'X-MyHeader3': 'ghi',
+            'X-MyHeader4': 'jkl',
+        },
+    })
+
+    await z.wait([
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+        {
+            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)': 'ghi',
+                '$hdr(X-MyHeader4)': 'jkl',
+            }),
+        },
+    ], 1000)
+
+    sip.call.start_recording(oc.id, {file: './oc.wav'})
+    sip.call.start_recording(ic.id, {file: './ic.wav'})
+
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
+
+    await z.wait([
+        {
+            event: 'dtmf',
+            call_id: ic.id,
+            digits: '1234',
+            mode: 0,
+        },
+        {
+            event: 'dtmf',
+            call_id: oc.id,
+            digits: '4321',
+            mode: 1,
+        },
+    ], 2000)
+
+
+    sip.call.reinvite(oc.id, { hold: true })
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                $rb: '!{_}a=recvonly',
+            }),
+        },
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendonly',
+            remote_mode: 'recvonly',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'recvonly',
+            remote_mode: 'sendonly',
+        },
+    ], 500)
+
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 0}) // this will not generate event 'dtmf' as the call is on hold
+
+    await z.wait([
+        {
+            event: 'dtmf',
+            call_id: ic.id,
+            digits: '1234',
+            mode: 0,
+        },
+    ], 2000)
+
+    sip.call.reinvite(ic.id)
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: ic.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                $rb: '!{_}a=sendonly',
+            }),
+        },
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendonly',
+            remote_mode: 'recvonly',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'recvonly',
+            remote_mode: 'sendonly',
+        },
+    ], 500)
+
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1}) // this will not generate event 'dtmf' as the call is on hold
+
+    await z.wait([
+        {
+            event: 'dtmf',
+            call_id: ic.id,
+            digits: '1234',
+            mode: 0,
+        },
+    ], 2000)
+
+    sip.call.send_request(oc.id, {method: 'INFO'})
+
+    await z.wait([
+        {
+            event: 'request',
+            call_id: ic.id,
+            msg: sip_msg({
+                $rm: 'INFO',
+            }),
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INFO',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+    ], 500)
+
+    sip.call.reinvite(oc.id)
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                $rb: '!{_}a=sendrecv',
+            }),
+        },
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+    ], 500)
+
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
+
+    await z.wait([
+        {
+            event: 'dtmf',
+            call_id: ic.id,
+            digits: '1234',
+            mode: 0,
+        },
+        {
+            event: 'dtmf',
+            call_id: oc.id,
+            digits: '4321',
+            mode: 1,
+        },
+    ], 2000)
+
+    sip.call.start_playing(oc.id, {file: '/home/takeshi/work/src/svn/brastel/SIP-Tools/trunk/sip-tester/yosemitesam.wav'})
+    sip.call.start_playing(ic.id, {file: '/home/takeshi/work/src/svn/brastel/SIP-Tools/trunk/sip-tester/yosemitesam.wav'})
+
+    await z.sleep(2000)
+
+    stat1 = sip.call.get_stream_stat(oc.id)
+    stat2 = sip.call.get_stream_stat(ic.id)
+
+    console.log("stat1", stat1)
+    console.log("stat2", stat2)
+
+    sip.call.stop_recording(oc.id)
+    sip.call.stop_recording(ic.id)
+
+
+    sip.call.terminate(oc.id)
+
+    await z.wait([
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'BYE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+    ], 1000)
+
+    await z.sleep(1000)
+
+    console.log("Success")
+
+    sip.stop()
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+