Update Node binding and JS API for NUClearNet 2

Migrate the addon to NUClear::network::NUClearNet (protocol 0x03), wire
typed event listeners through add/setSubscriptions, and release as 2.0.0.

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: TrentHouliston

README.md

@@ -4,6 +4,14 @@
 
 Node.js module for interacting with the [NUClear](https://github.com/Fastcode/NUClear) network.
 
+## NUClearNet 2 (v2.0.0+)
+
+Version 2 uses the redesigned **NUClearNet** library from [NUClear PR #190](https://github.com/Fastcode/NUClear/pull/190) (wire protocol **0x03**). It is **not** compatible with 1.x clients or NUClear builds that still use the old `NUClearNetwork` stack (protocol 0x02). Upgrade Node clients and NUClear robots together.
+
+The vendored NUClear tree is updated via `git subtree` from the `houliston/nuclearnet-v2` branch (currently [NUClear@ce389fbf](https://github.com/Fastcode/NUClear/commit/ce389fbfea56ce97527474865dc343e0c087bd70)).
+
+Peer join events may arrive slightly later than in 1.x because connection requires both multicast announce and a unicast CONNECT handshake.
+
 ## Installation
 
 The package contains a native module, so you'll need a working C++ compiler on your system to install and build it.

binding.gyp

@@ -6,17 +6,21 @@
                 'src/binding.cpp',
                 'src/NetworkBinding.cpp',
                 'src/NetworkListener.cpp',
-                'src/nuclear/src/extension/network/NUClearNetwork.cpp',
-                'src/nuclear/src/util/platform.cpp',
-                'src/nuclear/src/util/network/get_interfaces.cpp',
-                'src/nuclear/src/util/network/if_number_from_address.cpp',
+                'src/nuclear/src/nuclearnet/Discovery.cpp',
+                'src/nuclear/src/nuclearnet/Fragmentation.cpp',
+                'src/nuclear/src/nuclearnet/NUClearNet.cpp',
+                'src/nuclear/src/nuclearnet/PacketDeduplicator.cpp',
+                'src/nuclear/src/nuclearnet/RTTEstimator.cpp',
+                'src/nuclear/src/nuclearnet/Reliability.cpp',
+                'src/nuclear/src/nuclearnet/Routing.cpp',
                 'src/nuclear/src/util/network/resolve.cpp',
+                'src/nuclear/src/util/platform.cpp',
                 'src/nuclear/src/util/serialise/xxhash.cpp'
             ],
             'cflags': [],
             'include_dirs': [
                 '<!@(node -p "require(\'node-addon-api\').include")',
-                'src/nuclear/src/include'
+                'src/nuclear/src'
             ],
             "defines": [
                 # Restrict NAPI to v6 (to support Node v10)

index.js

@@ -38,35 +38,23 @@ class NUClearNet extends EventEmitter {
     this.on('newListener', (event) => {
       this.assertNotDestroyed();
 
-      if (
-        event !== 'nuclear_join' &&
-        event !== 'nuclear_leave' &&
-        event !== 'nuclear_packet' &&
-        event !== 'newListener' &&
-        event !== 'removeListener' &&
-        event !== 'disconnect' &&
-        this.listenerCount(event) === 0
-      ) {
+      if (this._isTypedPacketEvent(event) && this.listenerCount(event) === 0) {
         const hash = this._net.hash(event);
         this._callbackMap[hash] = event;
+        if (this._active) {
+          this._net.addSubscription(hash);
+        }
       }
     });
 
     // We are no longer listening to this type
     this.on('removeListener', (event) => {
-      // If we are no longer listening to this type
-      if (
-        event !== 'nuclear_join' &&
-        event !== 'nuclear_leave' &&
-        event !== 'nuclear_packet' &&
-        event !== 'newListener' &&
-        event !== 'removeListener' &&
-        event !== 'disconnect' &&
-        this.listenerCount(event) === 0
-      ) {
-        // Get our hash and delete it
+      if (this._isTypedPacketEvent(event) && this.listenerCount(event) === 0) {
         const hash = this._net.hash(event);
         delete this._callbackMap[hash];
+        if (this._active) {
+          this._syncSubscriptions();
+        }
       }
     });
 
@@ -147,6 +135,22 @@ class NUClearNet extends EventEmitter {
     }, duration);
   }
 
+  _isTypedPacketEvent(event) {
+    return (
+      event !== 'nuclear_join' &&
+      event !== 'nuclear_leave' &&
+      event !== 'nuclear_packet' &&
+      event !== 'newListener' &&
+      event !== 'removeListener' &&
+      event !== 'disconnect'
+    );
+  }
+
+  _syncSubscriptions() {
+    const hashes = Object.values(this._callbackMap).map((eventName) => this._net.hash(eventName));
+    this._net.setSubscriptions(hashes);
+  }
+
   hash(data) {
     this.assertNotDestroyed();
     return this._net.hash(data);
@@ -164,6 +168,10 @@ class NUClearNet extends EventEmitter {
     const port = options.port === undefined ? 7447 : options.port;
     const mtu = options.mtu === undefined ? 1500 : options.mtu;
 
+    if (Object.keys(this._callbackMap).length > 0) {
+      this._syncSubscriptions();
+    }
+
     // Connect to the network
     this._net.reset(name, address, port, mtu);
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "nuclearnet.js",
-  "version": "1.7.2",
+  "version": "2.0.0",
   "description": "Node.js module for interacting with the NUClear network",
   "main": "index.js",
   "types": "index.d.ts",