Make buckets parameter required for histogram metric (#315)

* make buckets parameter required for histogram metric

* adjusted prom metric constructor parameters

Author: kjamrog

packages/metrics/lib/prometheus/PrometheusMessageMetric.ts

@@ -9,20 +9,22 @@ import type { MessageVersionGeneratingFunction, PrometheusMetricParams } from '.
 export abstract class PrometheusMessageMetric<
   MessagePayload extends object,
   MetricType extends Metric,
+  MetricParams extends
+    PrometheusMetricParams<MessagePayload> = PrometheusMetricParams<MessagePayload>,
 > implements MessageMetricsManager<MessagePayload>
 {
   /** Fallbacks to null if metrics are disabled on app level */
   protected readonly metric: MetricType
 
   protected readonly messageVersionGeneratingFunction: MessageVersionGeneratingFunction<MessagePayload>
 
-  private readonly metricParams: PrometheusMetricParams<MessagePayload>
+  private readonly metricParams: MetricParams
 
   /**
    * @param metricParams - metrics parameters (see PrometheusMetricParams)
    * @param client - use it to specify custom Prometheus client
    */
-  constructor(metricParams: PrometheusMetricParams<MessagePayload>, client?: typeof promClient) {
+  constructor(metricParams: MetricParams, client?: typeof promClient) {
     this.metricParams = metricParams
     this.messageVersionGeneratingFunction =
       this.resolveMessageVersionGeneratingFunction(metricParams)
@@ -38,15 +40,12 @@ export abstract class PrometheusMessageMetric<
   }
 
   private resolveMessageVersionGeneratingFunction(
-    metricParams: PrometheusMetricParams<MessagePayload>,
+    metricParams: MetricParams,
   ): MessageVersionGeneratingFunction<MessagePayload> {
     const messageVersion = metricParams.messageVersion
     return typeof messageVersion === 'function' ? messageVersion : () => messageVersion
   }
 
-  protected abstract createMetric(
-    client: typeof promClient,
-    metricParams: PrometheusMetricParams<MessagePayload>,
-  ): MetricType
+  protected abstract createMetric(client: typeof promClient, metricParams: MetricParams): MetricType
   abstract registerProcessedMessage(metadata: ProcessedMessageMetadata<MessagePayload>): void
 }

packages/metrics/lib/prometheus/metrics/message-time/PrometheusMessageTimeMetric.ts

@@ -1,3 +1,4 @@
+import type { MakeRequired } from '@lokalise/universal-ts-utils/node'
 import type { ProcessedMessageMetadata } from '@message-queue-toolkit/core'
 import type { Histogram } from 'prom-client'
 import type promClient from 'prom-client'
@@ -8,11 +9,12 @@ export abstract class PrometheusMessageTimeMetric<
   MessagePayload extends object,
 > extends PrometheusMessageMetric<
   MessagePayload,
-  Histogram<'messageType' | 'version' | 'queue' | 'result'>
+  Histogram<'messageType' | 'version' | 'queue' | 'result'>,
+  MakeRequired<PrometheusMetricParams<MessagePayload>, 'buckets'>
 > {
   protected createMetric(
     client: typeof promClient,
-    metricParams: PrometheusMetricParams<MessagePayload>,
+    metricParams: MakeRequired<PrometheusMetricParams<MessagePayload>, 'buckets'>,
   ): Histogram<'messageType' | 'version' | 'queue' | 'result'> {
     return new client.Histogram({
       name: metricParams.name,

packages/metrics/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@message-queue-toolkit/metrics",
-    "version": "4.1.0",
+    "version": "4.1.1",
     "private": false,
     "license": "MIT",
     "description": "Utilities for collecting metrics in message-queue-toolkit",
@@ -26,7 +26,8 @@
         "prepublishOnly": "npm run lint && npm run build"
     },
     "dependencies": {
-        "@lokalise/node-core": "^14.0.1"
+        "@lokalise/node-core": "^14.0.1",
+        "@lokalise/universal-ts-utils": "^4.4.1"
     },
     "peerDependencies": {
         "@message-queue-toolkit/core": ">=21.0.0",