@hackthedev/dsync-ratelimit 1.0.1 → 1.0.2

package/.github/workflows/publish.yml

@@ -0,0 +1,43 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: true
+
+      - name: Skip version bump commits
+        run: |
+          if git log -1 --pretty=%B | grep -q "chore: bump version"; then
+            echo "Version bump commit detected, skipping."
+            exit 0
+          fi
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - run: npm ci
+
+      - run: |
+          git config user.name "github-actions"
+          git config user.email "actions@github.com"
+          npm version patch -m "chore: bump version %s"
+          git push
+
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+

package/README.md

@@ -87,11 +87,23 @@ io.on("connection", (socket) => {
 });
 ```
 
+------
 
+## Consensus
 
+A `calculateConsensus` function has been added to possibly set dynamic rate limits.
 
-
-
+```js
+// exmaple
+const votes = [
+    ["userA", 12, 1],
+    ["userB", 13, 1],
+    ["userC", 11, 1],
+    ["userD", 48, 1], // spike
+];
+
+const { value, result, disqualified } = calculateConsensus(votes, 10);
+```
 
 
 

package/bun.lock

@@ -11,8 +11,8 @@
     },
   },
   "packages": {
-    "@hackthedev/arraytools": ["@hackthedev/arraytools@1.0.1", "", {}, "sha512-1XHKuqr0sNFUxYddX5G9HQdqtTmAAj7dAtEpqp9cFe+mGGkVjD8ce6/wIFLp0X+UlAMC8plIwePPN5klis64rA=="],
+    "@hackthedev/arraytools": ["@hackthedev/arraytools@1.0.2", "", {}, "sha512-rFr3L60vAqp6bs+ur2W3VqaavOzoyQxDFqGYU/R+ocgZ63Hh4nat7HRZOVqZ6BVHC/UuC4Q/Y8+BiX9i3xakkg=="],
 
-    "@hackthedev/dsync-ipsec": ["@hackthedev/dsync-ipsec@1.0.1", "", {}, "sha512-KkmckbsyXY/CXnB0Ygh+GsXEKC//3/5ihJANPd9Nd9xmd6kr/lShS3K41ExpdgbTSIroK6RpbPqPGGCqjPWBBg=="],
+    "@hackthedev/dsync-ipsec": ["@hackthedev/dsync-ipsec@1.0.12", "", {}, "sha512-aCPQu6Cypqa6kmIpGjmqVPsoRwaYWbtPBvhPkZjOPu/FI054DItr3gtcqCE8+sULJSzNwAo2Ol2NZP2HEWucEg=="],
   }
 }

package/index.mjs

@@ -24,6 +24,38 @@ export default class dSyncRateLimit {
         return Date.now();
     }
 
+    export function calculateConsensus(votes, tolerance = null) {
+        if (!votes || votes.length === 0) {
+            return { value: null, result: [], disqualified: [] };
+        }
+
+        // get median
+        const values = votes.map(v => v[1]).sort((a, b) => a - b);
+        const median = values.length % 2 === 0
+            ? (values[values.length / 2 - 1] + values[values.length / 2]) / 2
+            : values[Math.floor(values.length / 2)];
+
+        let sumWeighted = 0;
+        let sumWeights = 0;
+
+        const result = [];
+        const disqualified = [];
+
+        for (const [host, reportedValue, weight] of votes) {
+            if (tolerance !== null && Math.abs(reportedValue - median) > tolerance) {
+                disqualified.push([host, reportedValue, weight]);
+                continue;
+            }
+            result.push([host, reportedValue, weight]);
+            sumWeighted += reportedValue * weight;
+            sumWeights += weight;
+        }
+
+        const value = sumWeights > 0 ? parseFloat((sumWeighted / sumWeights).toFixed(2)) : null;
+
+        return { value, result, disqualified };
+    }
+
     check(key, limit, blockUntilDate = null) {
         const now = Date.now();
         let rec = this.store.get(key);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hackthedev/dsync-ratelimit",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "This small library is part of the dSync concept and will handle rate limits by either defining and using custom, generic rate limits or by using an express middleware to enforce rate limits.",
   "homepage": "https://github.com/NETWORK-Z-Dev/dsync-ratelimit#readme",
   "bugs": {
@@ -17,7 +17,7 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "@hackthedev/arraytools": "^1.0.1",
-    "@hackthedev/dsync-ipsec": "^1.0.1"
+    "@hackthedev/arraytools": "^1.0.2",
+    "@hackthedev/dsync-ipsec": "^1.0.12"
   }
 }