Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

2.0 KB
Raw Blame
import { DynamicModule, MiddlewareConsumer, Module, NestModule, Type } from '@nestjs/common';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { ConfigModule } from '@nestjs/config';
import { MetricsController } from './metrics.controller';
import { MetricsService } from './metrics.service';
import { StatsModule } from '../stats/stats.module';
import { RequestMetricsInterceptor } from '../../common/interceptors/request-metrics.interceptor';
import { requestMetricsBoundaryMiddleware } from '../../common/middleware/request-metrics.middleware';

// QueueModule registers the webhook and ingress queues MetricsService reports (@Optional). Imported
// only when enabled, like infra.module.ts, so a disabled queue never dials Redis.
const queueModules: Array<Type | DynamicModule> = [];
if (process.env.QUEUE_ENABLED === 'true') {
  // eslint-disable-next-line @typescript-eslint/no-require-imports
  const queueModule = require('../queue/queue.module') as { QueueModule: Type };
  queueModules.push(queueModule.QueueModule);
}

@Module({
  imports: [ConfigModule, StatsModule, ...queueModules],
  controllers: [MetricsController],
  providers: [
    MetricsService,
    // Global: one HTTP RED observation per inbound request, skipped for /api/health and /api/metrics.
    { provide: APP_INTERCEPTOR, useClass: RequestMetricsInterceptor },
  ],
})
export class MetricsModule implements NestModule {
  configure(consumer: MiddlewareConsumer): void {
    // Middleware runs BEFORE the global guards, so this boundary sees the requests the guards
    // reject (throttler 429, API-key 401/403) that never reach the interceptor. The pair
    // coordinates through a per-request claim so each response is counted exactly once.
    // '{*splat}' resolves against the global prefix, i.e. every /api route. The named wildcard is
    // the path-to-regexp v8 form; a bare '*' works too but logs a legacy-route warning on every boot.
    consumer.apply(requestMetricsBoundaryMiddleware).forRoutes('{*splat}');
  }
}