chore: Throw error if deprecation endpoint deprecated should be removed (#36647)

Author: ggazzo

.changeset/twelve-feet-repeat.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/meteor': major
+---
+
+Removes deprecated 'e2e.updateGroupKey' method and related type declarations

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

@@ -813,6 +813,11 @@ export class APIClass<TBasePath extends string = '', TOperations extends Record<
 				}
 				// Add a try/catch for each endpoint
 				const originalAction = (operations[method as keyof Operations<TPathPattern, TOptions>] as Record<string, any>).action;
+
+				if (options.deprecation && shouldBreakInVersion(options.deprecation.version)) {
+					throw new Meteor.Error('error-deprecated', `The endpoint ${route} should be removed`);
+				}
+
 				// eslint-disable-next-line @typescript-eslint/no-this-alias
 				const api = this;
 				(operations[method as keyof Operations<TPathPattern, TOptions>] as Record<string, any>).action =

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

@@ -57,7 +57,7 @@ export async function parseJsonQuery(api: GenericRouteExecutionContext): Promise
 	let fields: Record<string, 0 | 1> | undefined;
 	if (typeof params?.fields === 'string' && isUnsafeQueryParamsAllowed) {
 		try {
-			apiDeprecationLogger.parameter(route, 'fields', '8.0.0', response, messageGenerator);
+			apiDeprecationLogger.parameter(route, 'fields', '9.0.0', response, messageGenerator);
 			fields = JSON.parse(params.fields) as Record<string, 0 | 1>;
 			Object.entries(fields).forEach(([key, value]) => {
 				if (value !== 1 && value !== 0) {
@@ -106,7 +106,7 @@ export async function parseJsonQuery(api: GenericRouteExecutionContext): Promise
 
 	let query: Record<string, any> = {};
 	if (typeof params?.query === 'string' && isUnsafeQueryParamsAllowed) {
-		apiDeprecationLogger.parameter(route, 'query', '8.0.0', response, messageGenerator);
+		apiDeprecationLogger.parameter(route, 'query', '9.0.0', response, messageGenerator);
 		try {
 			query = ejson.parse(params.query);
 			query = clean(query, pathAllowConf.def);

apps/meteor/app/e2e/server/methods/updateGroupKey.ts

@@ -1,21 +1,11 @@
-import type { ServerMethods } from '@rocket.chat/ddp-client';
 import { Subscriptions, Rooms } from '@rocket.chat/models';
-import { Meteor } from 'meteor/meteor';
 
-import { methodDeprecationLogger } from '../../../lib/server/lib/deprecationWarningLogger';
 import {
 	notifyOnSubscriptionChangedById,
 	notifyOnSubscriptionChanged,
 	notifyOnRoomChangedById,
 } from '../../../lib/server/lib/notifyListener';
 
-declare module '@rocket.chat/ddp-client' {
-	// eslint-disable-next-line @typescript-eslint/naming-convention
-	interface ServerMethods {
-		'e2e.updateGroupKey'(rid: string, uid: string, key: string): Promise<void>;
-	}
-}
-
 export async function updateGroupKey(rid: string, uid: string, key: string, callerUserId: string) {
 	// I have a subscription to this room
 	const mySub = await Subscriptions.findOneByRoomIdAndUserId(rid, callerUserId);
@@ -46,16 +36,3 @@ export async function updateGroupKey(rid: string, uid: string, key: string, call
 		}
 	}
 }
-
-Meteor.methods<ServerMethods>({
-	async 'e2e.updateGroupKey'(rid, uid, key) {
-		methodDeprecationLogger.method('e2e.updateGroupKey', '8.0.0', '/v1/e2e.acceptSuggestedGroupKey');
-
-		const userId = Meteor.userId();
-		if (!userId) {
-			throw new Meteor.Error('error-invalid-user', 'Invalid user', { method: 'e2e.acceptSuggestedGroupKey' });
-		}
-
-		return updateGroupKey(rid, uid, key, userId);
-	},
-});

apps/meteor/app/lib/server/lib/deprecationWarningLogger.ts

@@ -24,13 +24,17 @@ const compareVersions = (version: string, message: string) => {
 	}
 };
 
-export type DeprecationLoggerNextPlannedVersion = '7.0.0' | '8.0.0';
+export type DeprecationLoggerNextPlannedVersion = '9.0.0';
 
 export const apiDeprecationLogger = ((logger) => {
 	return {
 		endpoint: (endpoint: string, version: DeprecationLoggerNextPlannedVersion, res: Response, info = '') => {
 			const message = `The endpoint "${endpoint}" is deprecated and will be removed on version ${version}${info ? ` (${info})` : ''}`;
 
+			if (process.env.TEST_MODE === 'true') {
+				throw new Error(message);
+			}
+
 			compareVersions(version, message);
 
 			writeDeprecationHeader(res, 'endpoint-deprecation', message, version);
@@ -54,6 +58,10 @@ export const apiDeprecationLogger = ((logger) => {
 				}) ?? `The parameter "${parameter}" in the endpoint "${endpoint}" is deprecated and will be removed on version ${version}`;
 			compareVersions(version, message);
 
+			if (process.env.TEST_MODE === 'true') {
+				throw new Error(message);
+			}
+
 			metrics.deprecations.inc({ type: 'parameter-deprecation', kind: 'endpoint', name: endpoint, params: parameter });
 
 			writeDeprecationHeader(res, 'parameter-deprecation', message, version);
@@ -76,6 +84,11 @@ export const apiDeprecationLogger = ((logger) => {
 					endpoint,
 					version,
 				}) ?? `The usage of the endpoint "${endpoint}" is deprecated and will be removed on version ${version}`;
+
+			if (process.env.TEST_MODE === 'true') {
+				throw new Error(message);
+			}
+
 			compareVersions(version, message);
 
 			metrics.deprecations.inc({ type: 'invalid-usage', kind: 'endpoint', name: endpoint, params: parameter });
@@ -96,12 +109,18 @@ export const methodDeprecationLogger = ((logger) => {
 		) => {
 			const replacement = typeof info === 'string' ? info : `Use the ${info} endpoint instead`;
 			const message = `The method "${method}" is deprecated and will be removed on version ${version}${replacement ? ` (${replacement})` : ''}`;
+			if (process.env.TEST_MODE === 'true') {
+				throw new Error(message);
+			}
 			compareVersions(version, message);
 			metrics.deprecations.inc({ type: 'deprecation', name: method, kind: 'method' });
 			logger.warn(message);
 		},
 		parameter: (method: string, parameter: string, version: DeprecationLoggerNextPlannedVersion) => {
 			const message = `The parameter "${parameter}" in the method "${method}" is deprecated and will be removed on version ${version}`;
+			if (process.env.TEST_MODE === 'true') {
+				throw new Error(message);
+			}
 
 			metrics.deprecations.inc({ type: 'parameter-deprecation', name: method, params: parameter });
 
@@ -122,6 +141,11 @@ export const methodDeprecationLogger = ((logger) => {
 					method,
 					version,
 				}) ?? `The usage of the method "${method}" is deprecated and will be removed on version ${version}`;
+
+			if (process.env.TEST_MODE === 'true') {
+				throw new Error(message);
+			}
+
 			compareVersions(version, message);
 
 			metrics.deprecations.inc({ type: 'invalid-usage', name: method, params: parameter, kind: 'method' });
@@ -130,6 +154,10 @@ export const methodDeprecationLogger = ((logger) => {
 		},
 		/** @deprecated */
 		warn: (message: string) => {
+			if (process.env.TEST_MODE === 'true') {
+				throw new Error(message);
+			}
+
 			compareVersions('0.0.0', message);
 			logger.warn(message);
 		},