Merge branch 'main' into windows-support

Author: timokoessler

.devcontainer/devcontainer.json

@@ -0,0 +1,40 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+{
+  "name": "Zen Node.js",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:22",
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/rust:1": {}
+  },
+
+  // Configure tool-specific properties.
+  "customizations": {
+    // Configure properties specific to VS Code.
+    "vscode": {
+      "settings": {},
+      "extensions": [
+        "ms-azuretools.vscode-docker",
+        "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
+        "YoavBls.pretty-ts-errors",
+        "rust-lang.rust-analyzer"
+      ]
+    }
+  },
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  "forwardPorts": [3000, 4000],
+
+  // Use 'portsAttributes' to set default properties for specific forwarded ports.
+  // More info: https://containers.dev/implementors/json_reference/#port-attributes
+  "portsAttributes": {},
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "./.devcontainer/postCreateCommand.sh"
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

.devcontainer/postCreateCommand.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# Update
+sudo apt update -y && sudo apt upgrade -y
+rustup update
+source /usr/local/share/nvm/nvm.sh
+nvm install --lts
+nvm use --lts
+npm update -g
+
+# Install WASM pack
+curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+
+# Install k6
+## k6 installation -- arm machines
+if [ "$(uname -m)" = "aarch64" ]; then
+	K6_TAR_LINK=https://github.com/grafana/k6/releases/download/v0.58.0/k6-v0.58.0-linux-arm64.tar.gz
+	curl -OL $K6_TAR_LINK
+	tar -xzf k6-v0.58.0-linux-arm64.tar.gz
+	sudo mv k6-v0.58.0-linux-arm64/k6 /usr/local/bin/k6
+	rm -rf k6-v0.58.0-linux-arm64*
+else ## k6 installation -- other architectures
+	sudo gpg -k
+	sudo gpg --no-default-keyring --keyring /usr/share/keyrings/k6-archive-keyring.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys C5AD17C747E3415A3642D57D77C6C491D6AC1D69
+	echo "deb [signed-by=/usr/share/keyrings/k6-archive-keyring.gpg] https://dl.k6.io/deb stable main" | sudo tee /etc/apt/sources.list.d/k6.list
+	sudo apt-get update -y
+	sudo apt-get install k6 -y
+fi
+
+# Install wrk, sqlite3
+sudo apt install wrk sqlite3 -y
+
+# Install npm packages, build and run containers
+npm i
+npm run build
+npm run containers

.github/workflows/benchmark.yml

@@ -34,7 +34,7 @@ jobs:
           cache: "npm"
           cache-dependency-path: "**/package-lock.json"
       - name: Install K6
-        uses: grafana/setup-k6-action@v1
+        uses: grafana/setup-k6-action@ffe7d7290dfa715e48c2ccc924d068444c94bde2 # v1
       - name: Install wrk
         run: |
           sudo apt-get update
@@ -53,3 +53,5 @@ jobs:
         run: cd benchmarks/api-discovery && node benchmark.js
       - name: Run Express Benchmark
         run: cd benchmarks/express && node benchmark.js
+      - name: Check Rate Limiter memory usage
+        run: cd benchmarks/rate-limiting && node --expose-gc memory.js

.github/workflows/unit-test.yml

@@ -81,9 +81,9 @@ jobs:
       - run: npm run build
       - run: npm run test:ci
       - name: "Upload coverage"
-        uses: codecov/codecov-action@v4.0.1
+        uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574 # v5
         with:
-          file: ./library/.tap/report/lcov.info
+          files: ./library/.tap/report/lcov.info
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
           slug: AikidoSec/firewall-node

README.md

@@ -46,7 +46,7 @@ Zen for Node.js 16+ is compatible with:
 * ✅ [Next.js](docs/next.md) 12.x, 13.x and 14.x
 * ✅ [Fastify](docs/fastify.md) 4.x and 5.x
 * ✅ [Koa](docs/koa.md) 2.x
-* ✅ [NestJS](docs/nestjs.md) 10.x
+* ✅ [NestJS](docs/nestjs.md) 10.x and 11.x
 
 ### Database drivers
 
@@ -87,12 +87,12 @@ See list above for supported database drivers.
 ### Data serialization tools
 
 * ✅ [`xml2js`](https://www.npmjs.com/package/xml2js) 0.6.x, 0.5.x, ^0.4.18
-* ✅ [`fast-xml-parser`](https://www.npmjs.com/package/fast-xml-parser) 4.x
+* ✅ [`fast-xml-parser`](https://www.npmjs.com/package/fast-xml-parser) 5.x, 4.x
 * ✅ [`xml-js`](https://www.npmjs.com/package/xml-js) 1.x
 
 ### Shell tools
 
-* ✅ [`ShellJS`](https://www.npmjs.com/package/shelljs) 0.8.x, 0.7.x
+* ✅ [`ShellJS`](https://www.npmjs.com/package/shelljs) 0.9.x, 0.8.x, 0.7.x
 
 ### Routers
 

benchmarks/express/benchmark.js

@@ -57,12 +57,38 @@ async function run() {
   // Stop the server
   withoutFirewallProc.kill();
 
+  const withOpenTelemetryProc = spawn("node", ["app.js"], {
+    env: {
+      ...process.env,
+      PORT: 5003,
+      NODE_OPTIONS:
+        "--require @opentelemetry/auto-instrumentations-node/register",
+      OTEL_TRACES_EXPORTER: "none",
+      OTEL_METRICS_EXPORTER: "none",
+      OTEL_LOGS_EXPORTER: "none",
+    },
+    stdio: "inherit",
+  });
+
+  // Wait 2 seconds for the server to start and settle
+  await setTimeout(2000);
+
+  const resultWithOpenTelemetry = await exec(
+    generateWrkCommandForUrl("http://localhost:5003/empty")
+  );
+
+  // Stop the server
+  withOpenTelemetryProc.unref();
+  withOpenTelemetryProc.kill();
+
   const withFirewall = parseFloat(resultWithFirewall.stdout.trim());
   const withoutFirewall = parseFloat(resultWithoutFirewall.stdout.trim());
+  const withOpenTelemetry = parseFloat(resultWithOpenTelemetry.stdout.trim());
 
   console.log("--- Results ---");
   console.log(`Without Zen: ${withoutFirewall} Requests/sec`);
   console.log(`With Zen: ${withFirewall} Requests/sec`);
+  console.log(`With OpenTelemetry: ${withOpenTelemetry} Requests/sec`);
 
   const increase = ((withoutFirewall - withFirewall) / withoutFirewall) * 100;
   console.log(`Decrease with Zen for an empty route: ${increase.toFixed(2)}%`);