signalk-edge-link 2.0.0 → 2.1.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Karl-Erik Gustafsson
+Copyright (c) 2024-2026 Karl-Erik Gustafsson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/connection-config.js

@@ -235,6 +235,20 @@ function validateConnectionConfig(connection, prefix = "") {
                 }
             }
         }
+        // Validate that primary and backup links are different
+        const primaryLink = bonding.primary;
+        const backupLink = bonding.backup;
+        if (primaryLink && backupLink) {
+            const sameAddress = primaryLink.address !== undefined &&
+                backupLink.address !== undefined &&
+                primaryLink.address === backupLink.address;
+            const samePort = primaryLink.port !== undefined &&
+                backupLink.port !== undefined &&
+                primaryLink.port === backupLink.port;
+            if (sameAddress && samePort) {
+                return `${p}bonding primary and backup links must use different address:port combinations`;
+            }
+        }
         if (bonding.failover !== undefined) {
             if (!bonding.failover ||
                 typeof bonding.failover !== "object" ||

package/lib/instance.js

@@ -93,7 +93,6 @@ function createInstance(app, options, instanceId, pluginId, onStatusChange) {
         pipelineServer: null,
         heartbeatHandle: null,
         monitoring: null,
-        networkSimulator: null,
         configDebounceTimers: {},
         configContentHashes: {},
         configWatcherObjects: [],
@@ -240,7 +239,7 @@ function createInstance(app, options, instanceId, pluginId, onStatusChange) {
             state.timer = false;
             return;
         }
-        const actualBatchSize = Math.min(batchSize, state.deltas.length);
+        const actualBatchSize = Math.min(batchSize, state.deltas.length, state.maxDeltasPerBatch);
         const batch = state.deltas.slice(0, actualBatchSize);
         state.batchSendInFlight = true;
         try {
@@ -269,7 +268,7 @@ function createInstance(app, options, instanceId, pluginId, onStatusChange) {
         }
         finally {
             state.batchSendInFlight = false;
-            if (state.deltas.length > 0 && !state.pendingRetry) {
+            if (state.deltas.length > 0 && !state.pendingRetry && !state.stopped) {
                 setImmediate(() => {
                     flushDeltaBatch();
                 });
@@ -884,7 +883,6 @@ function createInstance(app, options, instanceId, pluginId, onStatusChange) {
             }
             state.monitoring = null;
         }
-        state.networkSimulator = null;
         // Stop ping monitor
         if (state.pingMonitor) {
             state.pingMonitor.stop();

package/lib/pipeline-v2-client.js

@@ -140,8 +140,11 @@ function createPipelineV2Client(app, state, metricsApi) {
     }
     function _effectiveRetransmitAge() {
         let maxAge = retransmitMaxAge;
-        if ((metrics.rtt ?? 0) > 0) {
-            const rttBasedAge = Math.round((metrics.rtt ?? 0) * retransmitRttMultiplier);
+        // Use the congestion controller's smoothed RTT (EMA) instead of the raw
+        // latest sample to avoid volatile timeout swings from single RTT spikes.
+        const smoothedRtt = congestionControl.getAvgRTT();
+        if (smoothedRtt > 0) {
+            const rttBasedAge = Math.round(smoothedRtt * retransmitRttMultiplier);
             maxAge = Math.min(maxAge, Math.max(retransmitMinAge, rttBasedAge));
         }
         const ackIdleMs = Date.now() - lastAckAt;
@@ -349,10 +352,12 @@ function createPipelineV2Client(app, state, metricsApi) {
             const ackedSeq = packetParser.parseACKPayload(parsed.payload);
             const now = Date.now();
             let rttSample = null;
-            // Estimate RTT from original send timestamp (not retransmit timestamp).
+            // Only sample RTT from packets that were NOT retransmitted (Karn's algorithm).
+            // When a retransmitted packet is ACKed, the measurement is ambiguous — the ACK
+            // could be for the original or the retransmit — so we skip it entirely.
             const entry = retransmitQueue.get(ackedSeq);
-            if (entry && (entry.originalTimestamp || entry.timestamp)) {
-                rttSample = Math.max(0, now - (entry.originalTimestamp || entry.timestamp));
+            if (entry && entry.attempts === 0) {
+                rttSample = Math.max(0, now - entry.originalTimestamp);
             }
             if (rttSample !== null) {
                 metrics.rtt = rttSample;
@@ -376,10 +381,13 @@ function createPipelineV2Client(app, state, metricsApi) {
             lastAckAt = now;
             lastAckRinfo = rinfo ? { address: rinfo.address, port: rinfo.port } : lastAckRinfo;
             // Update congestion control with latest network metrics.
+            // Only feed RTT when we have a fresh sample; passing -1 causes the
+            // congestion controller's >= 0 guard to skip the RTT EMA update,
+            // preventing stale values from being repeatedly folded into the average.
             // Clamp packetLoss to [0, 1] as a defensive measure against any future
             // changes to _calculatePacketLoss that could produce out-of-range values.
             congestionControl.updateMetrics({
-                rtt: metrics.rtt ?? 0,
+                rtt: rttSample ?? -1,
                 packetLoss: Math.min(1, Math.max(0, _calculatePacketLoss()))
             });
             app.debug(`ACK received: seq=${ackedSeq}, removed=${removed}, queueDepth=${retransmitQueue.getSize()}, rtt=${metrics.rtt}ms`);

package/lib/pipeline-v2-server.js

@@ -625,7 +625,7 @@ function createPipelineV2Server(app, state, metricsApi) {
                 if (!Array.isArray(deltaMessage.updates) || deltaMessage.updates.length === 0) {
                     continue;
                 }
-                trackPathStats(deltaMessage, decompressed.length / deltaCount);
+                trackPathStats(deltaMessage, decompressed.length / deltas.length);
                 app.handleMessage("", deltaMessage);
                 metrics.deltasReceived++;
             }

package/lib/pipeline.js

@@ -203,7 +203,7 @@ function createPipeline(app, state, metricsApi) {
                     continue;
                 }
                 // Track path stats for server-side analytics
-                trackPathStats(deltaMessage, decompressed.length / deltaCount);
+                trackPathStats(deltaMessage, decompressed.length / deltas.length);
                 app.handleMessage("", deltaMessage);
                 // Log a compact summary only — never log full delta values which may
                 // contain sensitive data (position, fuel, MMSI) in plaintext logs.

package/lib/routes/monitoring.js

@@ -336,15 +336,9 @@ function register(router, ctx) {
             if (!bundle) {
                 return res.status(503).json({ error: "Plugin not started" });
             }
-            const { state } = bundle;
-            if (!state.networkSimulator) {
-                return res.json({ enabled: false });
-            }
-            res.json({
-                enabled: true,
-                conditions: state.networkSimulator.getConditions(),
-                stats: state.networkSimulator.getStats()
-            });
+            // Network simulator is not currently implemented; endpoint kept for
+            // API compatibility and future use.
+            res.json({ enabled: false });
         }
         catch (err) {
             res.status(500).json({ error: err instanceof Error ? err.message : String(err) });

package/package.json

@@ -1,161 +1,165 @@
-{
-  "name": "signalk-edge-link",
-  "version": "2.0.0",
-  "description": "SignalK Edge Link. Secure UDP link for data exchange.",
-  "main": "lib/index.js",
-  "files": [
-    "lib/",
-    "public/",
-    "schemas/"
-  ],
-  "keywords": [
-    "signalk-node-server-plugin",
-    "signalk-category-network",
-    "signalk-webapp",
-    "signalk-category-utility",
-    "signalk-plugin-configurator"
-  ],
-  "signalk": {
-    "appIcon": "./icons/icon-72x72.png",
-    "displayName": "Edge Link Configuration"
-  },
-  "signalk-plugin-enabled-by-default": false,
-  "scripts": {
-    "clean:lib": "node -e \"const fs=require('fs');if(fs.existsSync('lib'))fs.rmSync('lib',{recursive:true,force:true});\"",
-    "clean:public": "node -e \"const fs=require('fs');if(fs.existsSync('public'))fs.rmSync('public',{recursive:true,force:true});\"",
-    "build": "npm run build:ts && npm run build:web",
-    "build:web": "npm run clean:public && webpack --mode production",
-    "build:ts": "npm run clean:lib && tsc",
-    "check:ts": "tsc --noEmit",
-    "dev": "webpack --mode development --watch",
-    "test": "jest --runInBand",
-    "test:v2": "jest __tests__/v2/",
-    "test:integration": "jest test/integration/",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "format": "prettier --write \"**/*.{js,ts,json,md}\"",
-    "migrate:config": "node lib/scripts/migrate-config.js",
-    "cli": "node lib/bin/edge-link-cli.js",
-    "prepare": "husky"
-  },
-  "dependencies": {
-    "@msgpack/msgpack": "^3.0.0",
-    "@rjsf/core": "^5.18.4",
-    "@rjsf/utils": "^5.18.4",
-    "@rjsf/validator-ajv8": "^5.18.4",
-    "ping-monitor": "^0.8.2"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.22.0",
-    "@babel/preset-env": "^7.22.0",
-    "@babel/preset-react": "^7.22.0",
-    "@testing-library/jest-dom": "^5.17.0",
-    "@testing-library/react": "^12.1.5",
-    "@types/node": "^25.3.5",
-    "@types/react": "^16.14.0",
-    "@types/react-dom": "^16.9.0",
-    "babel-loader": "^9.1.2",
-    "copy-webpack-plugin": "^14.0.0",
-    "css-loader": "^6.8.1",
-    "eslint": "^8.57.1",
-    "eslint-plugin-react": "^7.37.5",
-    "html-webpack-plugin": "^5.5.3",
-    "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^30.3.0",
-    "lint-staged": "^15.4.3",
-    "mini-css-extract-plugin": "^2.7.6",
-    "prettier": "^3.6.2",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
-    "react-test-renderer": "^16.14.0",
-    "style-loader": "^3.3.3",
-    "ts-jest": "^29.4.6",
-    "ts-loader": "^9.5.4",
-    "typescript": "^5.9.3",
-    "webpack": "^5.102.1",
-    "webpack-cli": "^5.1.4"
-  },
-  "engines": {
-    "node": ">=16"
-  },
-  "author": "Karl-Erik Gustafsson",
-  "repository": "https://github.com/KEGustafsson/signalk-edge-link",
-  "license": "MIT",
-  "jest": {
-    "testEnvironment": "node",
-    "coverageDirectory": "coverage",
-    "collectCoverageFrom": [
-      "lib/**/*.js",
-      "!lib/webapp/**",
-      "!lib/components/**",
-      "!lib/utils/**"
-    ],
-    "testMatch": [
-      "**/__tests__/**/*.js",
-      "**/*.test.js",
-      "**/*.spec.js"
-    ],
-    "transform": {
-      "^.+\\.js$": [
-        "babel-jest",
-        {
-          "presets": [
-            [
-              "@babel/preset-env",
-              {
-                "targets": {
-                  "node": "current"
-                }
-              }
-            ]
-          ]
-        }
-      ],
-      ".+\\.tsx$": [
-        "ts-jest",
-        {
-          "tsconfig": "tsconfig.webapp.json",
-          "diagnostics": false
-        }
-      ],
-      "^.+\\.ts$": "ts-jest"
-    },
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "json",
-      "node"
-    ],
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "/public/"
-    ],
-    "coverageThreshold": {
-      "global": {
-        "branches": 60,
-        "functions": 65,
-        "lines": 65,
-        "statements": 65
-      }
-    }
-  },
-  "bin": {
-    "edge-link-cli": "lib/bin/edge-link-cli.js"
-  },
-  "lint-staged": {
-    "*.js": [
-      "prettier --write",
-      "eslint --fix"
-    ],
-    "*.ts": [
-      "prettier --write"
-    ],
-    "*.{json,md}": [
-      "prettier --write"
-    ]
-  }
-}
+{
+  "name": "signalk-edge-link",
+  "version": "2.1.1",
+  "description": "SignalK Edge Link. Secure UDP link for data exchange.",
+  "main": "lib/index.js",
+  "files": [
+    "lib/",
+    "public/",
+    "schemas/"
+  ],
+  "keywords": [
+    "signalk-node-server-plugin",
+    "signalk-category-network",
+    "signalk-webapp",
+    "signalk-category-utility",
+    "signalk-plugin-configurator"
+  ],
+  "signalk": {
+    "appIcon": "./icons/icon-72x72.png",
+    "displayName": "Edge Link Configuration"
+  },
+  "signalk-plugin-enabled-by-default": false,
+  "scripts": {
+    "clean:lib": "node -e \"const fs=require('fs');if(fs.existsSync('lib'))fs.rmSync('lib',{recursive:true,force:true});\"",
+    "clean:public": "node -e \"const fs=require('fs');if(fs.existsSync('public'))fs.rmSync('public',{recursive:true,force:true});\"",
+    "build": "npm run build:ts && npm run build:web",
+    "build:web": "npm run clean:public && webpack --mode production",
+    "build:ts": "npm run clean:lib && tsc",
+    "check:ts": "tsc --noEmit",
+    "dev": "webpack --mode development --watch",
+    "test": "jest --runInBand",
+    "test:v2": "jest __tests__/v2/",
+    "test:integration": "jest test/integration/",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"**/*.{js,ts,json,md}\"",
+    "migrate:config": "node lib/scripts/migrate-config.js",
+    "cli": "node lib/bin/edge-link-cli.js",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "@msgpack/msgpack": "^3.0.0",
+    "@rjsf/core": "^5.18.4",
+    "@rjsf/utils": "^5.18.4",
+    "@rjsf/validator-ajv8": "^5.18.4",
+    "ping-monitor": "^0.8.2"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.22.0",
+    "@babel/preset-env": "^7.22.0",
+    "@babel/preset-react": "^7.22.0",
+    "@testing-library/jest-dom": "^5.17.0",
+    "@testing-library/react": "^12.1.5",
+    "@types/node": "^25.3.5",
+    "@types/react": "^16.14.0",
+    "@types/react-dom": "^16.9.0",
+    "babel-loader": "^9.1.2",
+    "copy-webpack-plugin": "^14.0.0",
+    "css-loader": "^6.8.1",
+    "eslint": "^8.57.1",
+    "eslint-plugin-react": "^7.37.5",
+    "html-webpack-plugin": "^5.5.3",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^30.3.0",
+    "lint-staged": "^15.4.3",
+    "mini-css-extract-plugin": "^2.7.6",
+    "prettier": "^3.6.2",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
+    "react-test-renderer": "^16.14.0",
+    "style-loader": "^3.3.3",
+    "ts-jest": "^29.4.6",
+    "ts-loader": "^9.5.4",
+    "typescript": "^5.9.3",
+    "webpack": "^5.102.1",
+    "webpack-cli": "^5.1.4"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "author": "Karl-Erik Gustafsson",
+  "repository": "https://github.com/KEGustafsson/signalk-edge-link",
+  "homepage": "https://github.com/KEGustafsson/signalk-edge-link#readme",
+  "bugs": {
+    "url": "https://github.com/KEGustafsson/signalk-edge-link/issues"
+  },
+  "license": "MIT",
+  "jest": {
+    "testEnvironment": "node",
+    "coverageDirectory": "coverage",
+    "collectCoverageFrom": [
+      "lib/**/*.js",
+      "!lib/webapp/**",
+      "!lib/components/**",
+      "!lib/utils/**"
+    ],
+    "testMatch": [
+      "**/__tests__/**/*.js",
+      "**/*.test.js",
+      "**/*.spec.js"
+    ],
+    "transform": {
+      "^.+\\.js$": [
+        "babel-jest",
+        {
+          "presets": [
+            [
+              "@babel/preset-env",
+              {
+                "targets": {
+                  "node": "current"
+                }
+              }
+            ]
+          ]
+        }
+      ],
+      ".+\\.tsx$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.webapp.json",
+          "diagnostics": false
+        }
+      ],
+      "^.+\\.ts$": "ts-jest"
+    },
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "json",
+      "node"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "/public/"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "branches": 60,
+        "functions": 65,
+        "lines": 65,
+        "statements": 65
+      }
+    }
+  },
+  "bin": {
+    "edge-link-cli": "lib/bin/edge-link-cli.js"
+  },
+  "lint-staged": {
+    "*.js": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "*.ts": [
+      "prettier --write"
+    ],
+    "*.{json,md}": [
+      "prettier --write"
+    ]
+  }
+}