@babblevoice/projectrtp 2.5.35 → 2.6.0

package/.dockerignore

@@ -6,6 +6,8 @@
 .eslintrc.js
 .gitignore
 
+build
+
 Dockerfile
 
 node_modules

package/Dockerfile

@@ -1,8 +1,5 @@
 
-# docker build . -t <your username>/projectrtp
-# I have tied this to version alpine 3.16 as 3.17 has an exception symbol dynamic linking issue.
-FROM alpine:3.20 AS builder
-
+FROM alpine:3.21 AS builder
 
 WORKDIR /usr/src/
 
@@ -17,10 +14,11 @@ RUN apk add --no-cache \
 WORKDIR /usr/local/lib/node_modules/@babblevoice/projectrtp/
 COPY . .
 
-RUN npm ci --no-optional --production;\
-    rm -fr src/build/Release/obj.target
+RUN npm ci --no-optional --production && \
+    rm -fr src/build/Release/obj.target && \
+    rm -fr build/Release/obj.target/projectrtp
 
-FROM alpine:3.20 AS app
+FROM alpine:3.21 AS app
 
 RUN apk add --no-cache \
     spandsp tiff gnutls libsrtp libc6-compat openssl ca-certificates nodejs npm

package/Dockerfile.debian

@@ -0,0 +1,42 @@
+
+FROM node:22-bookworm-slim AS builder
+
+WORKDIR /usr/src/
+
+RUN apt-get update && apt-get install -y \
+    build-essential cmake python3 wget libspandsp-dev libtiff-dev libgnutls28-dev libsrtp2-dev libboost-all-dev && \
+    npm install -g node-gyp && \
+    wget https://github.com/TimothyGu/libilbc/releases/download/v3.0.4/libilbc-3.0.4.tar.gz && \
+    tar xvzf libilbc-3.0.4.tar.gz && \
+    cd libilbc-3.0.4 && \
+    cmake . -DCMAKE_INSTALL_LIBDIR=/usr/lib -DCMAKE_INSTALL_INCLUDEDIR=/usr/include && \
+    cmake --build . && \
+    cmake --install . && \
+    cd .. && rm -rf libilbc-3.0.4 libilbc-3.0.4.tar.gz && \
+    apt-get clean && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /usr/local/lib/node_modules/@babblevoice/projectrtp/
+COPY . .
+
+# Install production dependencies
+RUN npm ci --no-optional --production && \
+    rm -fr src/build/Release/obj.target && \
+    rm -fr build/Release/obj.target/projectrtp
+
+FROM node:22-bookworm-slim AS app
+
+RUN apt-get update && apt-get install -y \
+    libspandsp2 libtiff6 libgnutls30 libc6 openssl ca-certificates && \
+    apt-get clean && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local/lib/node_modules/@babblevoice/projectrtp/ /usr/local/lib/node_modules/@babblevoice/projectrtp/
+COPY --from=builder /usr/lib/libilbc* /usr/lib/
+
+ENV NODE_PATH=/usr/local/lib/node_modules
+
+# Expose UDP ports
+EXPOSE 10000-50000/udp
+
+# Set working directory and run the app
+WORKDIR /usr/local/lib/node_modules/@babblevoice/projectrtp/
+CMD ["node", "examples/simplenode.js"]

package/README.md

@@ -46,6 +46,12 @@ We now have 3 different sets of tests.
 
 ### `npm test`
 
+If you are using an image - that doesn't have dev deps installed then theses might need to be added:
+
+```sh
+npm install --omit=prod --ignore-scripts
+```
+
 All tests are run from NodeJS. From the root directory, run the `npm test`. These test all our interfaces and should test expected outputs. These tests use mocha.
 
 The folder is separated out into interface, unit and mock. The mock folder contains mock objects/functions required for testing. Unit tests are to help test internal functions. Interface tests are used to guarantee a stable interface for a specific version number. If these tests require changing (other than bug fixing i.e. a material API change), then a major version update will happen.
@@ -60,7 +66,18 @@ If you wish to build outsode of a Docker image, there are npm target scripts for
 
 ```bash
 docker buildx prune
-docker buildx build --platform linux/amd64,linux/arm64 -t tinpotnick/projectrtp:2.5.35 . --push
+docker buildx build --platform linux/amd64,linux/arm64 -t tinpotnick/projectrtp:2.5.37_beta22 . --push
+```
+
+### Dev build
+
+Some items might need installing.
+```sh
+sudo dnf install libasan libubsan
+```
+
+```sh
+npm run build:dev
 ```
 
 ## Example scripts

package/asan.options

@@ -0,0 +1,2 @@
+verbosity=0
+detect_leaks=1

package/binding.gyp

@@ -1,16 +1,43 @@
 {
+  "variables": {
+    "build_type%": "prod"
+  },
   "targets": [
     {
       "target_name": "projectrtp",
       "defines": [ "NODE_MODULE", "BOOST_NO_EXCEPTIONS", "BOOST_EXCEPTION_DISABLE", "NAPI_DISABLE_CPP_EXCEPTIONS" ],
       "cflags_cc!": [ "-fno-rtti" ],
       "cflags_cc": [
-        "-O3",
         "-g",
-        "-Wall",
-        "-fstack-protector-strong",
         "-std=c++20",
         "-Weffc++" ],
+      "conditions": [
+        [
+          "build_type=='dev'", {
+            "cflags": [
+              "-O1",
+              "-fsanitize=address,undefined,bounds",
+              "-fno-omit-frame-pointer",
+              "-D_FORTIFY_SOURCE=2",
+              "-fstack-protector-strong",
+              "-fstack-protector-all",
+              "-Wformat-security",
+              "-Wall",
+              "-Wextra"
+            ],
+            "ldflags": [
+              "-fsanitize=address,undefined,bounds"
+            ]
+          }
+        ],
+        [
+          "build_type=='prod'", {
+            "cflags": [
+              "-O3"
+            ]
+          }
+        ]
+      ],
       "ldflags": [
         "-Wl,-z,relro",
         "-Wl,-z,now",

package/index.js

@@ -10,7 +10,12 @@ const { spawnSync } = require( "child_process" )
 
 let localaddress = "127.0.0.1"
 let privateaddress = "127.0.0.1"
-const bin = "./build/Release/projectrtp"
+
+let bin = "./build/Release/projectrtp"
+if ( fs.existsSync( "./build/Debug/projectrtp.node" ) ) {
+  console.log( "Dev build exists - using dev build..." )
+  bin = "./build/Debug/projectrtp"
+}
 
 
 /**
@@ -135,6 +140,21 @@ class proxy {
     this._server.clearnodes()
   }
 
+  /**
+   * 
+   * @param {*} nodes 
+   */
+  setnodes( nodes ) {
+    this._server.setnodes( nodes )
+  }
+
+  /**
+   * 
+   */
+  getnodes() {
+    return this._server.getnodes()
+  }
+
   get () {
     return server.interface.get()
   }

package/jsconfig.json

@@ -5,6 +5,6 @@
     "moduleResolution": "node",
     "checkJs": true
   },
-  "include": [ "index.js", "lib/*.js", "test/interface/*.js", "test/mock/*.js" ],
+  "include": [ "index.js", "lib/*.js", "test/interface/*.js", "test/mock/*.js", "stress/*.js" ],
   "exclude": [ "node_modules" ]
 }

package/lib/server.js

@@ -34,26 +34,22 @@ const nodeconnectiontype = { "listen": 1, "connect": 2 }
  * @property { channel } left
  * @property { channel } right
  * @property { Set< channel > } channels
- * @ignore
  */
 /**
  * @typedef { object } nodebridge
  * @property { Array< channelbridge > } bridges
  * @property { string } main
- * @ignore
  */
 
 /**
  * The remote (listening) nodes
  * @type { Array< nodehost > }
- * @ignore
  */
 let listeningnodes = []
 
 /**
  * Our nodes which have connected to our listening server.
  * @type { Map< string, nodeconnection > }
- * @ignore
  */
 let nodes = new Map()
 
@@ -429,8 +425,8 @@ class channel {
    * @returns { Promise< Boolean > }
    */
   async mix( other ) {
-
-    //if( await this._addbridge( other ) ) return true
+    if( !other ) return false
+    if( !other.uuid ) return false
 
     this._write( {
       "channel": "mix",
@@ -627,7 +623,8 @@ class channel {
    * @param { object } msg 
    */
   _on( msg ) {
-    msg.timestamp = ( new Date ).getTime()
+    msg.now = new Date()
+    msg.timestamp = msg.now.getTime()
     this.history.push( msg )
     if( this._runopen( msg ) ) return
     if( this.#haserror( msg ) ) return
@@ -653,7 +650,8 @@ class channel {
 
     this.connection.sock.write( message.createmessage( msg ) )
     
-    msg.timestamp = ( new Date ).getTime()
+    msg.now = new Date()
+    msg.timestamp = msg.now.getTime()
     this.history.push( msg )
 
     if( this._sockerr && nodeconnectiontype.connect == this.connection.type ) {
@@ -667,7 +665,9 @@ class channel {
 }
 
 /**
- * @ignore
+ * @param { number } min
+ * @param { number } max
+ * @returns { number }
  */
 function between( min, max ) {
   return Math.floor(
@@ -991,11 +991,27 @@ class serverinterface {
    * Clean up after using remote nodes for us to connect to, switch back to local mode.
    * @returns { void }
    */
-  clearnodes = () => {
+  clearnodes() {
     delete serverinterface._s
     listeningnodes = []
   }
 
+  /**
+   * 
+   * @param { Array< nodehost > } nodes 
+   */
+  setnodes( nodes ) {
+    listeningnodes = nodes
+  }
+
+  /**
+   * 
+   * @returns { Array< nodehost > }
+   */
+  getnodes() {
+    return listeningnodes
+  }
+
   /**
    * Remove our reference to server interface
    * @ignore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babblevoice/projectrtp",
-  "version": "2.5.35",
+  "version": "2.6.0",
   "description": "A scalable Node addon RTP server",
   "main": "index.js",
   "directories": {
@@ -9,18 +9,18 @@
     "test": "test"
   },
   "scripts": {
-    "test": "./node_modules/mocha/bin/_mocha test/**/*.js --check-leaks",
+    "test": "ASAN_OPTIONS=$(cat asan.options) LD_PRELOAD=/usr/lib64/libasan.so.8 ./node_modules/mocha/bin/_mocha test/**/*.js --check-leaks",
     "github:check": "node test/basictests.js; npm update; ./node_modules/mocha/bin/_mocha test/**/*.js --check-leaks --exit",
     "check": "tsc --checkJs --noEmit --target es6 --module commonjs --skipLibCheck *.js test/**/*.js; ./node_modules/eslint/bin/eslint.js ./",
     "docs": "jsdoc -c jsdoc.conf.json ./README.md",
-    "stress": "node stress/index.js",
-    "configure:dev": "node-gyp configure --debug",
+    "stress": "ASAN_OPTIONS=$(cat asan.options) LD_PRELOAD=/usr/lib64/libasan.so.8 node stress/index.js",
+    "configure:dev": "node-gyp configure --build_type=dev",
     "configure": "node-gyp configure",
-    "rebuild:dev": "node-gyp configure --debug; node-gyp rebuild --debug",
     "clean": "node-gyp clean",
-    "build:dev": "node-gyp configure build --debug",
+    "build:dev": "node-gyp configure build --build_type=dev",
     "build": "node-gyp configure build",
     "rebuild": "node-gyp rebuild",
+    "rebuild:dev": "node-gyp configure --build_type=dev; node-gyp rebuild --build_type=dev",
     "install": "node-gyp rebuild"
   },
   "repository": {

package/src/globals.h

@@ -15,6 +15,7 @@
 #define L16NARROWBANDBYTES 320
 #define L16WIDEBANDBYTES 640
 #define ILBC20PAYLOADBYTES 38
+#define ILBC20PAYLOADSAMPLES 38 /* correct ? */
 #define ILBC30PAYLOADBYTES 50 /* not needed but for completness */
 
 #define PCMUPAYLOADTYPE 0
@@ -65,4 +66,6 @@ struct SpinLockGuard {
   }
 };
 
+#define releasespinlock( x ) x.store( false, std::memory_order_release );
+
 #endif /* PROJECTRTPGLOBALS_H */

package/src/projectrtpbuffer.cpp

@@ -1,4 +1,7 @@
 
+/* needed to build on ubuntu */
+#include <utility>
+
 #include <iostream>
 #include <cstdlib>