fix(prometheus): add generic argument for registry

Author: tada5hi

package-lock.json

@@ -46,7 +46,7 @@
     },
     "homepage": "https://github.com/routup/plugins#readme",
     "peerDependencies": {
-        "prom-client": ">=13.0.0",
+        "prom-client": ">=15.0.0",
         "routup": "^4.0.1"
     },
     "devDependencies": {

packages/prometheus/package.json

@@ -5,16 +5,18 @@ import {
     useRequestPath,
 } from 'routup';
 import type {
-    LabelValues,
-    Registry,
+    LabelValues, PrometheusContentType,
+    Registry, RegistryContentType,
 } from 'prom-client';
 import promClient from 'prom-client';
 import { buildRequestDurationMetric, buildUptimeMetric } from './metrics';
 import type { Metrics, Options } from './type';
 import { onResponseFinished } from './utils';
 
-export function createHandler(input?: Registry) {
-    const registry : Registry = input || promClient.register;
+export function createHandler<
+    T extends RegistryContentType = PrometheusContentType,
+>(input?: Registry<T>) {
+    const registry : Registry<T> = input || promClient.register as Registry<T>;
 
     return coreHandler(async (req, res, next) => {
         registry.metrics()
@@ -26,9 +28,11 @@ export function createHandler(input?: Registry) {
     });
 }
 
-export function registerMetrics(
+export function registerMetrics<
+    T extends RegistryContentType = PrometheusContentType,
+>(
     router: Router,
-    options: Options,
+    options: Options<T>,
 ): Metrics {
     /* istanbul ignore next */
     if (options.collectDefaultMetrics) {

packages/prometheus/src/handler.ts

@@ -1,9 +1,13 @@
-import type { Histogram, Summary } from 'prom-client';
+import type {
+    Histogram, PrometheusContentType, Registry, RegistryContentType, Summary,
+} from 'prom-client';
 import promClient from 'prom-client';
 import { MetricTypeName } from '../constants';
 import type { Options } from '../type';
 
-export function buildRequestDurationMetric(options: Options) : Histogram | Summary {
+export function buildRequestDurationMetric<
+    T extends RegistryContentType = PrometheusContentType,
+>(options: Options<T>) : Histogram | Summary {
     const labels : string[] = [
         'method',
         'path',
@@ -20,7 +24,7 @@ export function buildRequestDurationMetric(options: Options) : Histogram | Summa
             help: `duration (sec) summary of http responses labeled with: ${labels.join(', ')}`,
             labelNames: labels,
             percentiles: [0.5, 0.75, 0.95, 0.98, 0.99, 0.999],
-            registers: [options.registry],
+            registers: [options.registry as Registry],
             ...options.requestDurationSummary,
         });
     }
@@ -30,7 +34,7 @@ export function buildRequestDurationMetric(options: Options) : Histogram | Summa
         help: `duration (sec) histogram of http responses labeled with: ${labels.join(', ')}`,
         labelNames: labels,
         buckets: [0.003, 0.03, 0.1, 0.3, 1.5, 10],
-        registers: [options.registry],
+        registers: [options.registry as Registry],
         ...options.requestDurationHistogram,
     });
 }

packages/prometheus/src/metrics/request-duration.ts

@@ -1,9 +1,13 @@
 import { performance } from 'node:perf_hooks';
-import type { Gauge } from 'prom-client';
+import type {
+    Gauge, PrometheusContentType, Registry, RegistryContentType,
+} from 'prom-client';
 import promClient from 'prom-client';
 import type { Options } from '../type';
 
-export function buildUptimeMetric(options: Options) : Gauge {
+export function buildUptimeMetric<
+    T extends RegistryContentType = PrometheusContentType,
+>(options: Options<T>) : Gauge {
     const starTime = performance.now();
 
     return new promClient.Gauge({
@@ -13,7 +17,7 @@ export function buildUptimeMetric(options: Options) : Gauge {
             this.set(parseInt(`${((performance.now() - starTime) / 1000)}`, 10));
         },
         registers: [
-            options.registry,
+            options.registry as Registry,
         ],
     });
 }

packages/prometheus/src/metrics/uptime.ts

@@ -1,9 +1,12 @@
+import type { PrometheusContentType, RegistryContentType } from 'prom-client';
 import type { Plugin } from 'routup';
 import { createHandler, registerMetrics } from './handler';
 import type { Options, OptionsInput } from './type';
 import { buildOptions } from './utils';
 
-export function prometheus(input: OptionsInput = {}) : Plugin {
+export function prometheus<
+    T extends RegistryContentType = PrometheusContentType,
+>(input: OptionsInput<T> = {}) : Plugin {
     const options = buildOptions({
         ...(input || {}),
     });

packages/prometheus/src/module.ts

@@ -4,8 +4,8 @@ import type {
     Gauge,
     Histogram,
     HistogramConfiguration,
-    LabelValues,
-    Registry,
+    LabelValues, PrometheusContentType,
+    Registry, RegistryContentType,
     Summary,
     SummaryConfiguration,
 } from 'prom-client';
@@ -18,7 +18,7 @@ export type Metrics = {
 
 export type LabelTransformer = (labels: LabelValues<string>, req: Request, res: Response) => void;
 
-export type Options = {
+export type Options<T extends RegistryContentType = PrometheusContentType> = {
     metricsPath: string,
 
     requestDuration: boolean,
@@ -36,8 +36,8 @@ export type Options = {
     normalizePath?: ((path: string, req: Request) => string);
     skip: (req: Request) => boolean;
 
-    collectDefaultMetrics?: DefaultMetricsCollectorConfiguration,
-    registry: Registry;
+    collectDefaultMetrics?: DefaultMetricsCollectorConfiguration<T>,
+    registry: Registry<T>;
 };
 
-export type OptionsInput = Partial<Options>;
+export type OptionsInput<T extends RegistryContentType = PrometheusContentType> = Partial<Options<T>>;

packages/prometheus/src/type.ts

@@ -1,8 +1,11 @@
+import type { PrometheusContentType, Registry, RegistryContentType } from 'prom-client';
 import promClient from 'prom-client';
 import { MetricName, MetricTypeName } from '../constants';
 import type { Options, OptionsInput } from '../type';
 
-export function buildOptions(input?: OptionsInput) : Options {
+export function buildOptions<
+    T extends RegistryContentType = PrometheusContentType,
+>(input?: OptionsInput<T>) : Options<T> {
     input = input || {};
 
     return {
@@ -14,7 +17,7 @@ export function buildOptions(input?: OptionsInput) : Options {
         requestDurationType: MetricTypeName.HISTOGRAM,
 
         skip: (req) => false,
-        registry: promClient.register,
+        registry: promClient.register as Registry<T>,
 
         metricsPath: '/metrics',