refactor!: upgrade to prom-client 15.1.0

BREAKING CHANGE: drop support for node 16
SkeLLLa · Mar 8, 2024 · bf31d38 · bf31d38
1 parent 87b403c
commit bf31d38
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 16 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}

diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml
@@ -10,7 +10,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -97,7 +97,7 @@ pnpm i fastify-metrics --save
 ---
 
 - Requires fastify `>=4.0.0`.
-- Node.js `>=16.0.0`.
+- Node.js `>=18.0.0`.
 
 <sub>[Back to top](#toc)</sub>
 

diff --git a/docs/api/fastify-metrics.idefaultmetricsconfig.md b/docs/api/fastify-metrics.idefaultmetricsconfig.md
@@ -9,10 +9,10 @@ Default prom-client metrics config
 <b>Signature:</b>
 
 ```typescript
-export interface IDefaultMetricsConfig extends DefaultMetricsCollectorConfiguration
+export interface IDefaultMetricsConfig extends DefaultMetricsCollectorConfiguration<'text/plain; version=0.0.4; charset=utf-8'>
 ```
 
-<b>Extends:</b> DefaultMetricsCollectorConfiguration
+<b>Extends:</b> DefaultMetricsCollectorConfiguration&lt;'text/plain; version=0.0.4; charset=utf-8'&gt;
 
 ## Remarks
 

diff --git a/etc/fastify-metrics.api.md b/etc/fastify-metrics.api.md
@@ -27,7 +27,7 @@ export default _default;
 
 // @public
 export interface IDefaultMetricsConfig
-  extends DefaultMetricsCollectorConfiguration {
+  extends DefaultMetricsCollectorConfiguration<'text/plain; version=0.0.4; charset=utf-8'> {
   enabled: boolean;
 }
 

diff --git a/package.json b/package.json
@@ -44,7 +44,7 @@
   },
   "dependencies": {
     "fastify-plugin": "^4.3.0",
-    "prom-client": "^14.2.0"
+    "prom-client": "^15.1.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.1.2",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/__tests__/edge-cases.spec.ts b/src/__tests__/edge-cases.spec.ts
@@ -144,7 +144,7 @@ describe('edge cases', () => {
           expect.stringMatching(
             /process_cpu_user_seconds_total\{foo="bar"\} \d+/
           ),
-          'http_request_duration_seconds_count{method="GET",route="/test",status_code="200",foo="bar"} 1',
+          'http_request_duration_seconds_count{foo="bar",method="GET",route="/test",status_code="200"} 1',
           'http_request_summary_seconds_count{method="GET",route="/test",status_code="200",foo="bar"} 1',
         ])
       );

diff --git a/src/fastify-metrics.ts b/src/fastify-metrics.ts
@@ -7,6 +7,7 @@ import {
 import promClient, {
   Histogram,
   LabelValues,
+  PrometheusContentType,
   Registry,
   Summary,
 } from 'prom-client';
@@ -191,8 +192,10 @@ export class FastifyMetrics implements IFastifyMetrics {
       return [];
     }
     return [
-      ...(routeMetrics.overrides?.histogram?.registers ?? []),
-      ...(routeMetrics.overrides?.summary?.registers ?? []),
+      ...((routeMetrics.overrides?.histogram?.registers ??
+        []) as Registry<PrometheusContentType>[]),
+      ...((routeMetrics.overrides?.summary?.registers ??
+        []) as Registry<PrometheusContentType>[]),
     ];
   }
 

diff --git a/src/types.ts b/src/types.ts
@@ -33,7 +33,7 @@ export interface IMetricsRouteContextConfig {
  * @see {@link https://github.com/siimon/prom-client#default-metrics | prom-client} for extra options
  */
 export interface IDefaultMetricsConfig
-  extends DefaultMetricsCollectorConfiguration {
+  extends DefaultMetricsCollectorConfiguration<'text/plain; version=0.0.4; charset=utf-8'> {
   /**
    * Enables collection of default prom-client metrics (e.g. node.js vitals like
    * cpu, memory, etc.)