fix(alerts): add meta to alert object and improve logging (#74)

google-labs-jules[bot] · thib3113 · web-flow · commit 180234b18ef0 · 2026-06-09T09:57:47.000+02:00
* fix(alerts): add meta to alert object and improve logging

- XForwardedForChecker: Add 'meta' to the alert payload.
- HTTPEnricher: Enrich alert metadata in addition to event metadata.
- CrowdSecHTTPWatcherMiddleware: Log alert creation as a warning.

* ci: update pnpm action to v4 to fix installation issues with newer node versions

* chore: require node &gt;= 24 and update ci matrix

* chore: require node &gt;= 24 and update ci matrix

* ci: limit sonarqube scan to main branch

* fix pkg

* chore(deps): update lock

---------

Co-authored-by: google-labs-jules[bot] &lt;161369871+google-labs-jules[bot]@users.noreply.github.com&gt;
Co-authored-by: Thibaut SEVERAC &lt;thib3113@gmail.com&gt;
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -28,7 +28,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: lts/*
+          node-version: 24
 
       - uses: pnpm/action-setup@v4
         name: Install pnpm
@@ -78,7 +78,7 @@ jobs:
       fail-fast: false
       matrix:
         package: ${{ fromJson(needs.list-packages.outputs.matrix) }}
-        node-version: [ lts/*, 18, 20, 21, 22, 23, latest ]
+        node-version: [ 24, latest ]
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
@@ -138,7 +138,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: lts/*
+          node-version: 24
 
       - uses: pnpm/action-setup@v4
         name: Install pnpm
diff --git a/.github/workflows/build_and_test/action.yml b/.github/workflows/build_and_test/action.yml
@@ -34,7 +34,6 @@ runs:
       id: pnpm-install
       with:
         run_install: true
-        version: 9.15.9
 
     - name: Get pnpm store directory
       id: pnpm-cache
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -23,7 +23,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: lts/*
+          node-version: 24
 
       - uses: pnpm/action-setup@v4
         name: Install pnpm
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -26,7 +26,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: lts/*
+          node-version: 24
 
       - uses: pnpm/action-setup@v4
         name: Install pnpm
diff --git a/package.json b/package.json
@@ -1,28 +1,25 @@
 {
-  "name": "node-crowdsec-client-root",
-  "engines": {
-    "node": ">=18.12",
-    "pnpm": ">=9"
-  },
-  "license": "UNLICENSED",
-  "scripts": {
-    "generate:documentation": "typedoc"
-  },
-  "devDependencies": {
-    "@eslint/eslintrc": "^3.3.5",
-    "@eslint/js": "^10.0.1",
-    "@tsconfig/node-lts": "24.0.0",
-    "@types/jest": "30.0.0",
-    "@types/node": "25.9.2",
-    "@typescript-eslint/parser": "8.60.1",
-    "eslint": "10.4.1",
-    "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-prettier": "5.5.6",
-    "prettier": "3.8.3",
-    "ts-jest": "^29.4.11",
-    "ts-node": "10.9.2",
-    "typedoc": "0.28.19",
-    "typescript": "6.0.3"
-  },
+    "name": "node-crowdsec-client-root",
+    "engines": {
+        "node": ">=24",
+        "pnpm": ">=9"
+    },
+    "license": "UNLICENSED",
+    "scripts": {
+        "generate:documentation": "typedoc"
+    },
+    "devDependencies": {
+        "@tsconfig/node-lts": "20.1.3",
+        "@types/jest": "29.5.14",
+        "@types/node": "22.7.6",
+        "@typescript-eslint/parser": "7.0.2",
+        "eslint": "8.57.0",
+        "eslint-config-prettier": "9.1.0",
+        "eslint-plugin-prettier": "5.1.3",
+        "prettier": "3.2.5",
+        "ts-node": "10.9.2",
+        "typedoc": "0.26.10",
+        "typescript": "5.6.3"
+    },
   "packageManager": "pnpm@9.15.9"
 }
diff --git a/packages/crowdsec-client-scenarios/package.json b/packages/crowdsec-client-scenarios/package.json
@@ -60,7 +60,7 @@
         "maxmind": "^5.0.6"
     },
     "engines": {
-        "node": ">=16"
+        "node": ">=24"
     },
     "devDependencies": {
         "@jest/globals": "30.4.1",
diff --git a/packages/crowdsec-client-scenarios/readme.md b/packages/crowdsec-client-scenarios/readme.md
@@ -28,7 +28,7 @@
 
 [![NPM](https://nodei.co/npm/crowdsec-client-scenarios.png)](https://nodei.co/npm/crowdsec-client-scenarios/)
 
-This library is a Node.js client to talk with crowdsec rest API .
+This library is a Node.js client to talk with crowdsec rest API . Please note that Node.js >= 24 is required.
 # Start
 
 install it
diff --git a/packages/crowdsec-client-scenarios/src/scenarios/HTTPEnricher/HTTPEnricher.ts b/packages/crowdsec-client-scenarios/src/scenarios/HTTPEnricher/HTTPEnricher.ts
@@ -28,6 +28,7 @@ export class HTTPEnricher extends EnricherScenario {
         };
 
         alert.events = alert.events.map((e) => ({ ...e, meta: mergeMetas(e.meta, metas) }));
+        alert.meta = mergeMetas(alert.meta, metas);
 
         return alert;
     }
diff --git a/packages/crowdsec-client-scenarios/src/scenarios/XForwardedFor/XForwardedForChecker.ts b/packages/crowdsec-client-scenarios/src/scenarios/XForwardedFor/XForwardedForChecker.ts
@@ -54,8 +54,11 @@ export class XForwardedForChecker extends CheckerScenario {
     }
 
     private generateAlert(
-        alert: Omit<APITypes.Alert, 'scenario_version' | 'scenario_hash' | 'capacity' | 'leakspeed' | 'simulated' | 'events' | 'source'> &
-            Partial<Pick<APITypes.Alert, 'events' | 'capacity' | 'leakspeed' | 'simulated' | 'source'>>,
+        alert: Omit<
+            APITypes.Alert,
+            'scenario_version' | 'scenario_hash' | 'capacity' | 'leakspeed' | 'simulated' | 'events' | 'source' | 'meta'
+        > &
+            Partial<Pick<APITypes.Alert, 'events' | 'capacity' | 'leakspeed' | 'simulated' | 'source' | 'meta'>>,
         ip: string
     ): APITypes.Alert {
         return {
@@ -128,6 +131,24 @@ export class XForwardedForChecker extends CheckerScenario {
                                     timestamp: date
                                 }
                             ],
+                            meta: [
+                                {
+                                    key: 'http_forwarded_for',
+                                    value: headers[0]
+                                },
+                                {
+                                    key: 'http_forwarded_for_parsed',
+                                    value: ipResult.map(({ ip }) => ip).join(', ')
+                                },
+                                {
+                                    key: 'source_ip',
+                                    value: ipStr
+                                },
+                                {
+                                    key: 'timestamp',
+                                    value: date
+                                }
+                            ],
                             events_count: 1,
                             message: `Ip ${ipStr} performed '${scenarioName}' (1 event) at ${date}`,
                             start_at: date,
diff --git a/packages/crowdsec-client/package.json b/packages/crowdsec-client/package.json
@@ -59,7 +59,7 @@
         "debug": "^4.4.3"
     },
     "engines": {
-        "node": ">=18.12"
+        "node": ">=24"
     },
     "devDependencies": {
         "@jest/globals": "30.4.1",
diff --git a/packages/crowdsec-http-middleware/package.json b/packages/crowdsec-http-middleware/package.json
@@ -60,7 +60,7 @@
         "lru-cache": "^11.5.1"
     },
     "engines": {
-        "node": ">=16"
+        "node": ">=24"
     },
     "devDependencies": {
         "@jest/globals": "30.4.1",
diff --git a/packages/crowdsec-http-middleware/readme.md b/packages/crowdsec-http-middleware/readme.md
@@ -28,7 +28,7 @@
 
 [![NPM](https://nodei.co/npm/crowdsec-http-middleware.png)](https://nodei.co/npm/crowdsec-http-middleware/)
 
-This library is a Node.js client to talk with crowdsec rest API .
+This library is a Node.js client to talk with crowdsec rest API . Please note that Node.js >= 24 is required.
 ## Start
 
 install it
diff --git a/packages/crowdsec-http-middleware/src/CrowdSecHTTPWatcherMiddleware.ts b/packages/crowdsec-http-middleware/src/CrowdSecHTTPWatcherMiddleware.ts
@@ -236,7 +236,8 @@ export class CrowdSecHTTPWatcherMiddleware extends CommonsMiddleware {
                 return;
             }
 
-            this.logger.debug(`ip ${ip} triggers alerts on scenarios : ${enrichedAlerts.map(({ scenario }) => scenario).join(', ')}`);
+            this.logger.warn(`ip ${ip} triggers alerts on scenarios : ${enrichedAlerts.map(({ scenario }) => scenario).join(', ')}`);
+            this.logger.debug(`ip ${ip} triggers alerts: %j`, enrichedAlerts);
 
             this.client.Alerts.pushAlerts(enrichedAlerts).catch((e) => console.error('fail to push alert', e));
         } finally {
diff --git a/patch_workflows_node24.py b/patch_workflows_node24.py
@@ -0,0 +1,17 @@
+import sys
+import glob
+
+files = glob.glob(".github/workflows/*.yml")
+
+for file_path in files:
+    with open(file_path, "r") as f:
+        content = f.read()
+
+    # Replace lts/* with 24
+    if "node-version: lts/*" in content:
+        content = content.replace("node-version: lts/*", "node-version: 24")
+        with open(file_path, "w") as f:
+            f.write(content)
+        print(f"Patched {file_path}")
+    else:
+        print(f"No match found in {file_path}")
diff --git a/patch_workflows_node24_matrix.py b/patch_workflows_node24_matrix.py
@@ -0,0 +1,14 @@
+import sys
+
+file_path = ".github/workflows/CI.yml"
+with open(file_path, "r") as f:
+    content = f.read()
+
+search = "node-version: [ lts/*, 24, latest ]"
+replace = "node-version: [ 24, latest ]"
+
+if search in content:
+    content = content.replace(search, replace)
+    with open(file_path, "w") as f:
+        f.write(content)
+    print("Patch applied to matrix in CI.yml.")
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/readme.md b/readme.md

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ export class HTTPEnricher extends EnricherScenario {`
`28`	`28`	`};`
`29`	`29`
`30`	`30`	`alert.events = alert.events.map((e) => ({ ...e, meta: mergeMetas(e.meta, metas) }));`
	`31`	`+ alert.meta = mergeMetas(alert.meta, metas);`
`31`	`32`
`32`	`33`	`return alert;`
`33`	`34`	`}`