sip-lab 1.12.12 → 1.12.16

package/DEV.md

@@ -0,0 +1,35 @@
+### For devs
+
+We build and statically link to libs pjproject, spandsp, bgc729 and rapidjson.
+
+Basic tasks for development:
+
+#### To build
+```
+npm install
+```
+
+#### To clean up (for a clean rebuild)
+```
+npx node-gyp clean
+```
+
+#### To update pjproject, spandsp, bcg729 or rapidjson
+Just delete the corresponding library subfolder in subfolder 3drParty.
+
+
+Then temporarily change install.sh to not checkout a specific version (or checkout a desired commit)
+
+Then run
+```
+npm install
+```
+
+Then perform code changes and tests. When you are satisfied with them, update install.sh with the new commit id.
+
+
+#### Running tests
+```
+npm test
+```
+

package/README.md

@@ -25,12 +25,17 @@ apt install build-essential automake autoconf libtool libspeex-dev libopus-dev l
 
 Then install sip-lab by doing:
 ```
-  npm install sip-lab
+npm install sip-lab
 ```
 
 Be patient because we will need to download pjproject and build it.
 
-We will also download rapidjson.
+We will also download and build spandsp, bcg729 and rapidjson.
+
+However since it takes several minutes to build this module, you can install it globally:
+```
+npm install -g sip-lab
+```
 
 To test from within this repo just build and install by doing:
 ```
@@ -49,9 +54,11 @@ It was originally developed with node v.10 and tested with v.12 and v16.13.1 and
 (it is known to not work with node v.8)
 
 
+
 ### About the code
 
 Although the code in written in *.cpp/*.hpp named files, this is not actually a C++ project.
 
 It is mostly written in C using some C++ facilities.
 
+

package/devjournal

@@ -438,5 +438,12 @@ When rebuilding the addon, this should be enough (it should be fast):
 ```
   npm install --unsafe-perm
 ```
+------------------------------------------------------------
+2022/09/11 takeshi:
+
+To try to solve #21, we upraded pjproject to commit 797088ed133c98492519b7d042b75735f6f9388c.
+However, after doing it we verified sending CANCEL doesn't cause the other side to send '497 Request Terminated' by itself anymore (see samples/sip_cancel.js)
+ 
+
 
 

package/install.sh

@@ -52,10 +52,8 @@ then
 	git clone https://github.com/pjsip/pjproject
 	cd pjproject
 	#git checkout de3d744c2e1188b59bb907b6ee32ef83740ebc64
-    git checkout 33a3c9e0a5eb84426edef05a9aa98af17d8011c3 # required for bcg729
-
-    #echo "Patching sip_transaction.c to avoid problems with CANCEL"
-    sed -i -r 's|event->body.tx_msg.tdata == tsx->last_tx,|\t\t\t1, /* \0 */|' pjsip/src/pjsip/sip_transaction.c 
+    #git checkout 33a3c9e0a5eb84426edef05a9aa98af17d8011c3 # required for bcg729
+    git checkout 797088ed133c98492519b7d042b75735f6f9388c # updated as part of #21
 
 	cat > user.mak <<EOF
 	export CFLAGS += -fPIC -g

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "sip-lab",
-  "version": "1.12.12",
+  "version": "1.12.16",
   "description": "",
   "main": "index.js",
   "engines": {
     "node": ">=10.22"
   },
   "scripts": {
-    "install": "./install.sh"
+    "install": "./install.sh",
+    "test": "./runtests"
   },
   "repository": {
     "type": "git",

package/samples/g729.js

@@ -42,11 +42,11 @@ async function test() {
                 $rs: '100',
                 $rr: 'Trying',
                 '$(hdrcnt(via))': 1,
-                '$hdr(call-id)': m.collect('sip_call_id'),
+                'hdr_call_id': m.collect('sip_call_id'),
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(l)': '0',
+                'hdr_l': '0',
             }),
         },
     ], 1000)
@@ -84,7 +84,7 @@ async function test() {
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
-                '$hdr(content-type)': 'application/sdp',
+                'hdr_content_type': 'application/sdp',
                 $rb: '!{_}a=sendrecv',
             }),
         },

package/samples/register_subscribe.js

@@ -3,6 +3,7 @@ var Zeq = require('@mayama/zeq')
 var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
+var assert = require('assert')
 
 async function test() {
     //sip.set_log_level(6)
@@ -47,7 +48,7 @@ async function test() {
                 $tU: 'user1',
                 $td: domain,
                 '$hdr(X-MyHeader1)': 'aaa',
-                '$hdr(X-MyHeader2)': 'bbb',
+                'hdr_x_myheader2': 'bbb',
             }),
         },
     ], 1000)
@@ -78,7 +79,9 @@ async function test() {
             },
     })
 
-    sip.subscription.subscribe(s1, {expires: 120})
+    const sub_expires = 120 
+
+    sip.subscription.subscribe(s1, {expires: sub_expires})
 
     await z.wait([
         {
@@ -90,8 +93,8 @@ async function test() {
                 $fU: 'user1',
                 $fd: domain,
                 '$hdr(Event)': 'dialog',
-                '$hdr(Accept)': 'application/dialog-info+xml',
-                '$hdr(Allow-Events)': 'refer, dialog',
+                'hdr_accept': 'application/dialog-info+xml',
+                'hdr_allow_events': 'refer, dialog',
             })
         },
     ], 1000)
@@ -115,13 +118,16 @@ async function test() {
             subscription_id: s1,
             msg: sip_msg({
                 $rm: 'NOTIFY',
-                '$hdr(Event)': 'dialog',
-                '$hdr(Subscription-State)': 'active;expires=120',
+                'hdr_event': 'dialog',
+                '$hdr(Subscription-State)': 'active;expires=!{sub_expires:num}',
                 '$hdr(Allow-Events)': 'refer, dialog',
             }),
         },
     ], 1000)
 
+    // Subscription-State expires will be computed by pjsip. It might not be the exact value of sub_expires due to latence so we give 2 seconds of tolerance
+    assert(z.store.sub_expires > (sub_expires - 2))
+
     sip.account.unregister(a1)
 
     await z.wait([

package/samples/sip_cancel.js

@@ -87,6 +87,11 @@ async function test() {
                 $rr: 'OK',
             }),
         },
+    ], 1000)
+
+    sip.call.respond(ic.id, {code: 487, reason: 'Request Terminated'})
+
+    await z.wait([
         {
             event: 'response',
             call_id: oc.id,

package/samples/tcp_and_extra_headers.js

@@ -40,7 +40,7 @@ async function test() {
                 $fd: 'test.com',
                 $tU: 'bob',
                 '$hdr(X-MyHeader1)': 'abc',
-                '$hdr(X-MyHeader2)': 'def',
+                'hdr_x_myheader2': 'def',
             }),
         },
         {
@@ -51,7 +51,7 @@ async function test() {
                 $rs: '100',
                 $rr: 'Trying',
                 '$(hdrcnt(via))': 1,
-                '$hdr(call-id)': m.collect('sip_call_id'),
+                'hdr_call_id': m.collect('sip_call_id'),
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',
@@ -96,7 +96,7 @@ async function test() {
             msg: sip_msg({
                 $rs: '200',
                 $rr: 'OK',
-                '$(hdrcnt(VIA))': 1,
+                '$(hdrcnt(v))': 1,
                 $fU: 'alice',
                 $fd: 'test.com',
                 $tU: 'bob',

package/src/event_templates.cpp

@@ -26,8 +26,11 @@ int make_evt_dtmf(char *dest, int size, long call_id, int digits_len, const char
 }
 
 int make_evt_call_ended(char *dest, int size, long call_id, int sip_msg_len, const char *sip_msg) {
-	printf("sip_msg_len=%i sip_msg=%s\n", sip_msg_len, sip_msg);
-	if(sip_msg_len > 500 && sip_msg_len < 2000 && sip_msg) {
+	printf("sip_msg_len=%i sip_msg=%x\n", sip_msg_len, sip_msg);
+    if(!sip_msg || sip_msg == (char*)0xc000000000000) {
+        // received invalid pointer to sip_msg so do not add the message to the event
+		return snprintf(dest, size, "{\"event\": \"call_ended\", \"call_id\": %ld}", call_id); 
+    } else if(sip_msg_len > 500 && sip_msg_len < 2000 && sip_msg) {
 		/* sip_msg_len sometimes show up as a large value like sip_msg_len=11560297 which seems to be a bug in pjsip */
 		return snprintf(dest, size, "{\"event\": \"call_ended\", \"call_id\": %ld}\n%.*s", call_id, sip_msg_len, sip_msg); 
 	} else {