sip-lab 1.28.1 → 1.28.3

package/samples/simple.js

@@ -31,10 +31,17 @@ async function test() {
     console.log("t1", t1)
     console.log("t2", t2)
 
-    // 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}`})
+    // 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',
+        },
+    })
 
-    // Here we will wait for the call to arrive at t2
+    // 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([
@@ -42,6 +49,14 @@ async function test() {
             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',
@@ -64,7 +79,7 @@ async function test() {
     // 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 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:
     //
     //  {
@@ -75,7 +90,7 @@ async function test() {
     //          $rs: '100',
     //      }),
     //  }
-    // Regarding the function sip_msg() this is a special matching function provided by https://github.com/MayamaTakeshi/sip-matching that makes it 
+    // 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.
  
 
@@ -86,10 +101,17 @@ async function test() {
         sip_call_id: z.store.sip_call_id,
     }
 
-    // Now we answer the call at t2 side
-    sip.call.respond(ic.id, {code: 200, reason: 'OK'})
+    // 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
+    // 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([
         {
@@ -105,6 +127,8 @@ async function test() {
                 $tU: 'bob',
                 '$hdr(content-type)': 'application/sdp',
                 $rb: '!{_}a=sendrecv',
+                '$hdr(X-MyHeader3)': 'ABC',
+                hdr_x_myheader4: 'DEF',
             }),
         },
         {

package/samples/sip_cancel.js

@@ -36,12 +36,7 @@ async function test() {
             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)
@@ -61,10 +56,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '180',
                 $rr: 'Ringing',
-                '$(hdrcnt(VIA))': 1,
-                $fU: 'alice',
-                $fd: 'test.com',
-                $tU: 'bob',
             }),
         },
     ], 1000)

package/samples/speech_synth_and_recog.speex16000.js

@@ -27,10 +27,6 @@ async function test() {
     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([
@@ -42,8 +38,6 @@ async function test() {
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(X-MyHeader1)': 'abc',
-                'hdr_x_myheader2': 'def',
             }),
         },
         {
@@ -53,12 +47,7 @@ async function test() {
             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)
@@ -71,10 +60,6 @@ async function test() {
     sip.call.respond(ic.id, {
         code: 200,
         reason:'OK',
-        headers: {
-            'X-MyHeader3': 'ghi',
-            'X-MyHeader4': 'jkl',
-        },
     })
 
     await z.wait([
@@ -95,14 +80,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(v))': 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)
@@ -144,6 +121,8 @@ async function test() {
     sip.call.stop_speech_synth(oc.id) // this is not actually necessary. It is used just to confirm the command works
     sip.call.stop_speech_synth(ic.id) // this is not actually necessary. It is used just to confirm the command works
 
+    sip.call.stop_speech_recog(oc.id) // this is not actually necessary. It is used just to confirm the command works
+    sip.call.stop_speech_recog(ic.id) // this is not actually necessary. It is used just to confirm the command works
 
     sip.call.stop_record_wav(oc.id)
     sip.call.stop_record_wav(ic.id)

package/samples/srtp.js

@@ -67,12 +67,6 @@ async function test() {
             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',
             }),
         },
         {

package/samples/start_play_wav_with_end_of_file_event.js

@@ -25,10 +25,6 @@ async function test() {
     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([
@@ -40,8 +36,6 @@ async function test() {
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(X-MyHeader1)': 'abc',
-                'hdr_x_myheader2': 'def',
             }),
         },
         {
@@ -51,12 +45,7 @@ async function test() {
             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)
@@ -69,10 +58,6 @@ async function test() {
     sip.call.respond(ic.id, {
         code: 200,
         reason:'OK',
-        headers: {
-            'X-MyHeader3': 'ghi',
-            'X-MyHeader4': 'jkl',
-        },
     })
 
     await z.wait([
@@ -93,14 +78,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(v))': 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)

package/samples/start_play_wav_with_no_loop.js

@@ -25,10 +25,6 @@ async function test() {
     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([
@@ -40,8 +36,6 @@ async function test() {
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(X-MyHeader1)': 'abc',
-                'hdr_x_myheader2': 'def',
             }),
         },
         {
@@ -51,12 +45,7 @@ async function test() {
             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)
@@ -69,10 +58,6 @@ async function test() {
     sip.call.respond(ic.id, {
         code: 200,
         reason:'OK',
-        headers: {
-            'X-MyHeader3': 'ghi',
-            'X-MyHeader4': 'jkl',
-        },
     })
 
     await z.wait([
@@ -93,14 +78,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(v))': 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)

package/samples/{tcp_and_extra_headers.js → tcp.js}

@@ -25,10 +25,6 @@ async function test() {
     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([
@@ -40,8 +36,6 @@ async function test() {
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(X-MyHeader1)': 'abc',
-                'hdr_x_myheader2': 'def',
             }),
         },
         {
@@ -51,12 +45,7 @@ async function test() {
             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)
@@ -69,10 +58,6 @@ async function test() {
     sip.call.respond(ic.id, {
         code: 200,
         reason:'OK',
-        headers: {
-            'X-MyHeader3': 'ghi',
-            'X-MyHeader4': 'jkl',
-        },
     })
 
     await z.wait([
@@ -93,14 +78,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(v))': 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)

package/samples/text_to_speech.js

@@ -25,10 +25,6 @@ async function test() {
     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([
@@ -40,8 +36,6 @@ async function test() {
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(X-MyHeader1)': 'abc',
-                'hdr_x_myheader2': 'def',
             }),
         },
         {
@@ -51,12 +45,7 @@ async function test() {
             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)
@@ -69,10 +58,6 @@ async function test() {
     sip.call.respond(ic.id, {
         code: 200,
         reason:'OK',
-        headers: {
-            'X-MyHeader3': 'ghi',
-            'X-MyHeader4': 'jkl',
-        },
     })
 
     await z.wait([
@@ -93,14 +78,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(v))': 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)

package/samples/tls.js

@@ -0,0 +1,128 @@
+// 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() {
+    sip.set_log_level(6)
+
+    // 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", port: 6060, type: 'tls', cert_file: 'samples/artifacts/tls/cacert.pem', key_file: 'samples/artifacts/tls/cakey.pem'})
+    const t2 = sip.transport.create({address: "127.0.0.1", port: 6061, type: 'tls', cert_file: 'samples/artifacts/tls/cacert.pem', key_file: 'samples/artifacts/tls/cakey.pem'})
+
+    // here we just print the transports
+    console.log("t1", t1)
+    console.log("t2", t2)
+
+    // 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};transport=tls`})
+
+    // 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',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '100',
+                $rr: 'Trying',
+            }),
+        },
+    ], 1000)
+
+    // 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
+    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_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',
+            }),
+        },
+        {
+            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)
+})
+

package/samples/two_audio_streams.js

@@ -56,11 +56,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(VIA))': 1,
-                $fU: 'alice',
-                $fd: 'test.com',
-                $tU: 'bob',
-                '$hdr(content-type)': 'application/sdp',
                 $rb: sdp.jsonpath_matcher({
                     '$.media.length': [2],
                     '$.media[*].desc.type': ['audio','audio'],

package/samples/two_audio_streams.port_zero.js

@@ -56,11 +56,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(VIA))': 1,
-                $fU: 'alice',
-                $fd: 'test.com',
-                $tU: 'bob',
-                '$hdr(content-type)': 'application/sdp',
                 $rb: sdp.jsonpath_matcher({
                     '$.media.length': [2],
                     '$.media[*].desc.type': ['audio','audio'],

package/samples_extra/ws_speech_server.dtmf.js

@@ -27,10 +27,6 @@ async function test() {
     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([
@@ -42,8 +38,6 @@ async function test() {
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(X-MyHeader1)': 'abc',
-                'hdr_x_myheader2': 'def',
             }),
         },
         {
@@ -53,12 +47,6 @@ async function test() {
             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)
@@ -71,10 +59,6 @@ async function test() {
     sip.call.respond(ic.id, {
         code: 200,
         reason:'OK',
-        headers: {
-            'X-MyHeader3': 'ghi',
-            'X-MyHeader4': 'jkl',
-        },
     })
 
     await z.wait([
@@ -95,14 +79,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(v))': 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)

package/samples_extra/ws_speech_server.google.js

@@ -27,10 +27,6 @@ async function test() {
     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([
@@ -42,8 +38,6 @@ async function test() {
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(X-MyHeader1)': 'abc',
-                'hdr_x_myheader2': 'def',
             }),
         },
         {
@@ -53,12 +47,6 @@ async function test() {
             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)
@@ -71,10 +59,6 @@ async function test() {
     sip.call.respond(ic.id, {
         code: 200,
         reason:'OK',
-        headers: {
-            'X-MyHeader3': 'ghi',
-            'X-MyHeader4': 'jkl',
-        },
     })
 
     await z.wait([
@@ -95,14 +79,6 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(v))': 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)