fix metrics.spec.ts: add required histogram, responseSizeHistogram, activeRequestsGauge mocks

Co-authored-by: d-gubert <1810309+d-gubert@users.noreply.github.com>

Author: Copilot

apps/meteor/app/api/server/api.ts

@@ -102,7 +102,17 @@ settings.watch<number>('API_Enable_Rate_Limiter_Limit_Calls_Default', (value) =>
 export const startRestAPI = () => {
 	(WebApp.rawConnectHandlers as unknown as ReturnType<typeof express>).use(
 		API.api
-			.use(metricsMiddleware({ basePathRegex: new RegExp(/^\/api\/v1\//), api: API.v1, settings, summary: metrics.rocketchatRestApi, histogram: metrics.rocketchatRestApiSeconds, responseSizeHistogram: metrics.rocketchatRestApiResponseSizeBytes, activeRequestsGauge: metrics.rocketchatRestApiActiveRequests }))
+			.use(
+				metricsMiddleware({
+					basePathRegex: new RegExp(/^\/api\/v1\//),
+					api: API.v1,
+					settings,
+					summary: metrics.rocketchatRestApi,
+					histogram: metrics.rocketchatRestApiSeconds,
+					responseSizeHistogram: metrics.rocketchatRestApiResponseSizeBytes,
+					activeRequestsGauge: metrics.rocketchatRestApiActiveRequests,
+				}),
+			)
 			.use(tracerSpanMiddleware)
 			.use(remoteAddressMiddleware)
 			.use(cors(settings))

apps/meteor/app/api/server/middlewares/metrics.spec.ts

@@ -25,27 +25,42 @@ describe('Metrics middleware', () => {
 		const mockEndTimer = jest.fn();
 		summary.startTimer.mockReturnValue(mockEndTimer);
 
-		api.use(metricsMiddleware({ api: { version: 1 } as any, settings, summary: summary as any })).get(
-			'/test',
-			{
-				response: {
-					200: ajv.compile({
-						type: 'object',
-						properties: {
-							message: { type: 'string' },
+		const histogram = { startTimer: jest.fn().mockReturnValue(jest.fn()) };
+		const responseSizeHistogram = { observe: jest.fn() };
+		const activeRequestsGauge = { inc: jest.fn(), dec: jest.fn() };
+
+		api
+			.use(
+				metricsMiddleware({
+					api: { version: 1 } as any,
+					settings,
+					summary: summary as any,
+					histogram: histogram as any,
+					responseSizeHistogram: responseSizeHistogram as any,
+					activeRequestsGauge: activeRequestsGauge as any,
+				}),
+			)
+			.get(
+				'/test',
+				{
+					response: {
+						200: ajv.compile({
+							type: 'object',
+							properties: {
+								message: { type: 'string' },
+							},
+						}),
+					},
+				},
+				async () => {
+					return {
+						statusCode: 200,
+						body: {
+							message: 'Metrics test successful',
 						},
-					}),
+					};
 				},
-			},
-			async () => {
-				return {
-					statusCode: 200,
-					body: {
-						message: 'Metrics test successful',
-					},
-				};
-			},
-		);
+			);
 		app.use(api.router);
 		const response = await request(app).get('/api/test').set('user-agent', 'test');
 		expect(response.statusCode).toBe(200);
@@ -73,8 +88,22 @@ describe('Metrics middleware', () => {
 		const mockEndTimer = jest.fn();
 		summary.startTimer.mockReturnValue(mockEndTimer);
 
+		const histogram = { startTimer: jest.fn().mockReturnValue(jest.fn()) };
+		const responseSizeHistogram = { observe: jest.fn() };
+		const activeRequestsGauge = { inc: jest.fn(), dec: jest.fn() };
+
 		api
-			.use(metricsMiddleware({ basePathRegex: new RegExp(/^\/api\//), api: { version: 1 } as any, settings, summary: summary as any }))
+			.use(
+				metricsMiddleware({
+					basePathRegex: new RegExp(/^\/api\//),
+					api: { version: 1 } as any,
+					settings,
+					summary: summary as any,
+					histogram: histogram as any,
+					responseSizeHistogram: responseSizeHistogram as any,
+					activeRequestsGauge: activeRequestsGauge as any,
+				}),
+			)
 			.get(
 				'/test',
 				{
@@ -120,8 +149,22 @@ describe('Metrics middleware', () => {
 		const mockEndTimer = jest.fn();
 		summary.startTimer.mockReturnValue(mockEndTimer);
 
+		const histogram = { startTimer: jest.fn().mockReturnValue(jest.fn()) };
+		const responseSizeHistogram = { observe: jest.fn() };
+		const activeRequestsGauge = { inc: jest.fn(), dec: jest.fn() };
+
 		api
-			.use(metricsMiddleware({ basePathRegex: new RegExp(/^\/api\//), api: { version: 1 } as any, settings, summary: summary as any }))
+			.use(
+				metricsMiddleware({
+					basePathRegex: new RegExp(/^\/api\//),
+					api: { version: 1 } as any,
+					settings,
+					summary: summary as any,
+					histogram: histogram as any,
+					responseSizeHistogram: responseSizeHistogram as any,
+					activeRequestsGauge: activeRequestsGauge as any,
+				}),
+			)
 			.get(
 				'/method.call/:id',
 				{

apps/meteor/app/integrations/server/api/api.ts

@@ -427,7 +427,17 @@ const Api = new WebHookAPI({
 });
 
 Api.router
-	.use(metricsMiddleware({ basePathRegex: new RegExp(/^\/hooks\//), api: Api, settings, summary: metrics.rocketchatRestApi, histogram: metrics.rocketchatRestApiSeconds, responseSizeHistogram: metrics.rocketchatRestApiResponseSizeBytes, activeRequestsGauge: metrics.rocketchatRestApiActiveRequests }))
+	.use(
+		metricsMiddleware({
+			basePathRegex: new RegExp(/^\/hooks\//),
+			api: Api,
+			settings,
+			summary: metrics.rocketchatRestApi,
+			histogram: metrics.rocketchatRestApiSeconds,
+			responseSizeHistogram: metrics.rocketchatRestApiResponseSizeBytes,
+			activeRequestsGauge: metrics.rocketchatRestApiActiveRequests,
+		}),
+	)
 	.use(tracerSpanMiddleware)
 	.use(loggerMiddleware(integrationLogger));
 

apps/meteor/ee/server/apps/communication/rest.ts

@@ -72,7 +72,17 @@ export class AppsRestApi {
 		const logger = new Logger('APPS');
 		this.api.router
 			.use(loggerMiddleware(logger))
-			.use(metricsMiddleware({ basePathRegex: new RegExp(/^\/api\/apps\//), api: this.api, settings, summary: metrics.rocketchatRestApi, histogram: metrics.rocketchatRestApiSeconds, responseSizeHistogram: metrics.rocketchatRestApiResponseSizeBytes, activeRequestsGauge: metrics.rocketchatRestApiActiveRequests }))
+			.use(
+				metricsMiddleware({
+					basePathRegex: new RegExp(/^\/api\/apps\//),
+					api: this.api,
+					settings,
+					summary: metrics.rocketchatRestApi,
+					histogram: metrics.rocketchatRestApiSeconds,
+					responseSizeHistogram: metrics.rocketchatRestApiResponseSizeBytes,
+					activeRequestsGauge: metrics.rocketchatRestApiActiveRequests,
+				}),
+			)
 			.use(tracerSpanMiddleware);
 
 		this.addManagementRoutes();