upstream-rocketchat/apps/meteor/server/api/v1/stats.ts

import type { IStats } from '@rocket.chat/core-typings';
import {
	ajv,
	isTelemetryPayload,
	validateUnauthorizedErrorResponse,
	validateForbiddenErrorResponse,
	validateBadRequestErrorResponse,
} from '@rocket.chat/rest-typings';

import { getStatistics, getLastStatistics } from '../../lib/statistics';
import telemetryEvent from '../../lib/statistics/lib/telemetryEvents';
import { API } from '../api';
import { getPaginationItems } from '../lib/getPaginationItems';

const statisticsResponseSchema = ajv.compile<IStats>({
	type: 'object',
	properties: {
		success: { type: 'boolean', enum: [true] },
	},
	required: ['success'],
	additionalProperties: true,
});

const statisticsListResponseSchema = ajv.compile<{ statistics: IStats[]; count: number; offset: number; total: number }>({
	type: 'object',
	properties: {
		statistics: { type: 'array' },
		count: { type: 'number' },
		offset: { type: 'number' },
		total: { type: 'number' },
		success: { type: 'boolean', enum: [true] },
	},
	required: ['statistics', 'count', 'offset', 'total', 'success'],
	additionalProperties: false,
});

const statisticsTelemetryResponseSchema = ajv.compile<void>({
	type: 'object',
	properties: {
		success: { type: 'boolean', enum: [true] },
	},
	required: ['success'],
	additionalProperties: false,
});

API.v1.get(
	'statistics',
	{
		authRequired: true,
		response: {
			200: statisticsResponseSchema,
			400: validateBadRequestErrorResponse,
			401: validateUnauthorizedErrorResponse,
			403: validateForbiddenErrorResponse,
		},
	},
	async function action() {
		const { refresh } = this.queryParams;

		return API.v1.success(
			await getLastStatistics({
				userId: this.userId,
				refresh: refresh === 'true',
			}),
		);
	},
);

API.v1.get(
	'statistics.list',
	{
		authRequired: true,
		response: {
			200: statisticsListResponseSchema,
			400: validateBadRequestErrorResponse,
			401: validateUnauthorizedErrorResponse,
			403: validateForbiddenErrorResponse,
		},
	},
	async function action() {
		const { offset, count } = await getPaginationItems(this.queryParams);
		const { sort, fields, query } = await this.parseJsonQuery();

		return API.v1.success(
			await getStatistics({
				userId: this.userId,
				query,
				pagination: {
					offset,
					count,
					sort,
					fields,
				},
			}),
		);
	},
);

API.v1.post(
	'statistics.telemetry',
	{
		authRequired: true,
		body: isTelemetryPayload,
		response: {
			200: statisticsTelemetryResponseSchema,
			400: validateBadRequestErrorResponse,
			401: validateUnauthorizedErrorResponse,
		},
	},
	function action() {
		const { params } = this.bodyParams;

		params.forEach((event) => {
			const { eventName, ...rest } = event;
			void telemetryEvent.call(eventName, rest);
		});

		return API.v1.success();
	},
);