fix: correct misleading DDP deprecation replacements

ggazzo · ggazzo · commit 9e01720f76fc · 2026-05-26T09:21:06.000-03:00
Initial pass shipped 18 deprecation-message replacements that pointed
developers at REST endpoints with materially different semantics or at
paths that did not exist. Independent review classified them as WRONG,
MISSING, or PARTIAL with silent-break risk:

  WRONG  (drop replacement, keep deprecation)
    - 2fa:enable        (TOTP enable vs email-2fa enable)
    - 2fa:disable       (TOTP disable vs send email code)
    - deleteFileMessage (single-msg vs rooms.cleanHistory range purge)
    - getMessages       (batched IDs vs single chat.getMessage)
    - loadNextMessages, loadSurroundingMessages
                        (forward/window fetch vs chat.syncMessages delta)
    - readThreads       (one thread vs whole-room read)
    - getSetupWizardParameters (wizard subset vs settings.public)
    - banner/dismiss    (per-user set vs Banner.dismiss broadcast)

  MISSING
    - saveSettings      (/v1/settings does not exist; only /v1/settings/:_id)

  PARTIAL (room-type or shape mismatch — silent break for callers)
    - loadHistory, joinRoom, leaveRoom, addUsersToRoom,
      getRoomByTypeAndName (channels.* fails on p/d/l rooms)
    - loadMissedMessages (chat.syncMessages has incompatible response)
    - spotlight, slashCommand (REST drops required params)

For all 18, the replacement argument is now an empty array so the
deprecation logger still reports the removal version without pointing
to a wrong endpoint.

Also fills four mappings that the previous heuristic missed because of
case/separator differences or an unscanned EE api directory:

    - autoTranslate.getSupportedLanguages
        -&gt; /v1/autotranslate.getSupportedLanguages
    - autoTranslate.translateMessage
        -&gt; /v1/autotranslate.translateMessage
    - subscriptions/get
        -&gt; /v1/subscriptions.get
    - getReadReceipts (EE)
        -&gt; /v1/chat.getMessageReadReceipts

scripts/audit-ddp-methods.mjs gains:
  - REST_DENYLIST that hard-blocks the 18 misleading mappings from being
    re-derived if the heuristic runs again,
  - lower-case and `/`-vs-`.` separator candidate paths so similarly
    misspelled mappings get matched,
  - apps/meteor/ee/server/api/ added to REST_DIRS so EE endpoints are
    visible to the audit.

docs/ddp-replacement-review.md captures the per-method review notes.
diff --git a/apps/meteor/app/2fa/server/methods/disable.ts b/apps/meteor/app/2fa/server/methods/disable.ts
@@ -15,7 +15,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async '2fa:disable'(code) {
-		methodDeprecationLogger.method('2fa:disable', '9.0.0', '/v1/users.2fa.sendEmailCode');
+		methodDeprecationLogger.method('2fa:disable', '9.0.0', []);
 		const userId = Meteor.userId();
 		if (!userId) {
 			throw new Meteor.Error('not-authorized');
diff --git a/apps/meteor/app/2fa/server/methods/enable.ts b/apps/meteor/app/2fa/server/methods/enable.ts
@@ -14,7 +14,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async '2fa:enable'() {
-		methodDeprecationLogger.method('2fa:enable', '9.0.0', '/v1/users.2fa.enableEmail');
+		methodDeprecationLogger.method('2fa:enable', '9.0.0', []);
 		const userId = Meteor.userId();
 		if (!userId) {
 			throw new Meteor.Error('not-authorized');
diff --git a/apps/meteor/app/autotranslate/server/methods/getSupportedLanguages.ts b/apps/meteor/app/autotranslate/server/methods/getSupportedLanguages.ts
@@ -3,6 +3,7 @@ import type { ServerMethods } from '@rocket.chat/ddp-client';
 import { DDPRateLimiter } from 'meteor/ddp-rate-limiter';
 import { Meteor } from 'meteor/meteor';
 
+import { methodDeprecationLogger } from '../../../lib/server/lib/deprecationWarningLogger';
 import { getSupportedLanguages } from '../functions/getSupportedLanguages';
 
 declare module '@rocket.chat/ddp-client' {
@@ -14,6 +15,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async 'autoTranslate.getSupportedLanguages'(targetLanguage) {
+		methodDeprecationLogger.method('autoTranslate.getSupportedLanguages', '9.0.0', '/v1/autotranslate.getSupportedLanguages');
 		const userId = Meteor.userId();
 
 		if (!userId) {
diff --git a/apps/meteor/app/autotranslate/server/methods/translateMessage.ts b/apps/meteor/app/autotranslate/server/methods/translateMessage.ts
@@ -5,6 +5,7 @@ import { check } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
 
 import { canAccessRoomAsync } from '../../../authorization/server';
+import { methodDeprecationLogger } from '../../../lib/server/lib/deprecationWarningLogger';
 import { translateMessage } from '../functions/translateMessage';
 
 declare module '@rocket.chat/ddp-client' {
@@ -16,6 +17,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async 'autoTranslate.translateMessage'(message, targetLanguage) {
+		methodDeprecationLogger.method('autoTranslate.translateMessage', '9.0.0', '/v1/autotranslate.translateMessage');
 		const userId = Meteor.userId();
 		if (!userId) {
 			throw new Meteor.Error('error-invalid-user', 'Invalid user', {
diff --git a/apps/meteor/app/lib/server/methods/addUsersToRoom.ts b/apps/meteor/app/lib/server/methods/addUsersToRoom.ts
@@ -123,7 +123,7 @@ export const addUsersToRoomMethod = async (userId: string, data: { rid: string;
 
 Meteor.methods<ServerMethods>({
 	async addUsersToRoom(data) {
-		methodDeprecationLogger.method('addUsersToRoom', '9.0.0', '/v1/channels.invite');
+		methodDeprecationLogger.method('addUsersToRoom', '9.0.0', []);
 		const uid = Meteor.userId();
 		// Validate user and room
 		if (!uid) {
diff --git a/apps/meteor/app/lib/server/methods/getMessages.ts b/apps/meteor/app/lib/server/methods/getMessages.ts
@@ -16,7 +16,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async getMessages(messages) {
-		methodDeprecationLogger.method('getMessages', '9.0.0', '/v1/chat.getMessage');
+		methodDeprecationLogger.method('getMessages', '9.0.0', []);
 		check(messages, [String]);
 		const uid = Meteor.userId();
 
diff --git a/apps/meteor/app/lib/server/methods/joinRoom.ts b/apps/meteor/app/lib/server/methods/joinRoom.ts
@@ -16,7 +16,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async joinRoom(rid, code) {
-		methodDeprecationLogger.method('joinRoom', '9.0.0', '/v1/channels.join');
+		methodDeprecationLogger.method('joinRoom', '9.0.0', []);
 		check(rid, String);
 
 		const user = await Meteor.userAsync();
diff --git a/apps/meteor/app/lib/server/methods/leaveRoom.ts b/apps/meteor/app/lib/server/methods/leaveRoom.ts
@@ -59,7 +59,7 @@ export const leaveRoomMethod = async (user: IUser, rid: string): Promise<void> =
 
 Meteor.methods<ServerMethods>({
 	async leaveRoom(rid) {
-		methodDeprecationLogger.method('leaveRoom', '9.0.0', '/v1/channels.leave');
+		methodDeprecationLogger.method('leaveRoom', '9.0.0', []);
 		check(rid, String);
 
 		if (!Meteor.userId()) {
diff --git a/apps/meteor/app/lib/server/methods/saveSettings.ts b/apps/meteor/app/lib/server/methods/saveSettings.ts
@@ -51,7 +51,7 @@ Meteor.methods<ServerMethods>({
 			value: ISetting['value'];
 		}[] = [],
 	) {
-		methodDeprecationLogger.method('saveSettings', '9.0.0', '/v1/settings');
+		methodDeprecationLogger.method('saveSettings', '9.0.0', []);
 		const uid = Meteor.userId();
 		const settingsNotAllowed: ISetting['_id'][] = [];
 		if (uid === null) {
diff --git a/apps/meteor/app/utils/server/slashCommand.ts b/apps/meteor/app/utils/server/slashCommand.ts
@@ -141,7 +141,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async slashCommand(command) {
-		methodDeprecationLogger.method('slashCommand', '9.0.0', '/v1/commands.run');
+		methodDeprecationLogger.method('slashCommand', '9.0.0', []);
 		const userId = Meteor.userId();
 		if (!userId) {
 			throw new Meteor.Error('error-invalid-user', 'Invalid user', {
diff --git a/apps/meteor/app/version-check/server/methods/banner_dismiss.ts b/apps/meteor/app/version-check/server/methods/banner_dismiss.ts
@@ -14,7 +14,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async 'banner/dismiss'({ id }) {
-		methodDeprecationLogger.method('banner/dismiss', '9.0.0', '/v1/banners.dismiss');
+		methodDeprecationLogger.method('banner/dismiss', '9.0.0', []);
 		const userId = Meteor.userId();
 		if (!userId) {
 			throw new Meteor.Error('error-invalid-user', 'Invalid user', { method: 'banner/dismiss' });
diff --git a/apps/meteor/ee/server/methods/getReadReceipts.ts b/apps/meteor/ee/server/methods/getReadReceipts.ts
@@ -6,6 +6,7 @@ import { check } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
 
 import { canAccessRoomIdAsync } from '../../../app/authorization/server/functions/canAccessRoom';
+import { methodDeprecationLogger } from '../../../app/lib/server/lib/deprecationWarningLogger';
 import { ReadReceipt } from '../lib/message-read-receipt/ReadReceipt';
 
 declare module '@rocket.chat/ddp-client' {
@@ -37,6 +38,7 @@ export const getReadReceiptsFunction = async function (messageId: IMessage['_id'
 
 Meteor.methods<ServerMethods>({
 	async getReadReceipts({ messageId }) {
+		methodDeprecationLogger.method('getReadReceipts', '9.0.0', '/v1/chat.getMessageReadReceipts');
 		check(messageId, String);
 
 		const uid = Meteor.userId();
diff --git a/apps/meteor/server/methods/deleteFileMessage.ts b/apps/meteor/server/methods/deleteFileMessage.ts
@@ -17,7 +17,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async deleteFileMessage(fileID) {
-		methodDeprecationLogger.method('deleteFileMessage', '9.0.0', '/v1/rooms.cleanHistory');
+		methodDeprecationLogger.method('deleteFileMessage', '9.0.0', []);
 		check(fileID, String);
 
 		const msg = await Messages.getMessageByFileId(fileID);
diff --git a/apps/meteor/server/methods/getSetupWizardParameters.ts b/apps/meteor/server/methods/getSetupWizardParameters.ts
@@ -18,7 +18,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async getSetupWizardParameters() {
-		methodDeprecationLogger.method('getSetupWizardParameters', '9.0.0', '/v1/settings.public');
+		methodDeprecationLogger.method('getSetupWizardParameters', '9.0.0', []);
 		const setupWizardSettings = await Settings.findSetupWizardSettings().toArray();
 		const serverAlreadyRegistered = !!settings.get('Cloud_Workspace_Client_Id') || process.env.DEPLOY_PLATFORM === 'rocket-cloud';
 
diff --git a/apps/meteor/server/methods/loadHistory.ts b/apps/meteor/server/methods/loadHistory.ts
@@ -31,7 +31,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async loadHistory(rid, end, limit = 20, ls, showThreadMessages = true) {
-		methodDeprecationLogger.method('loadHistory', '9.0.0', '/v1/channels.history');
+		methodDeprecationLogger.method('loadHistory', '9.0.0', []);
 		check(rid, String);
 		const fromUser = await Meteor.userAsync();
 
diff --git a/apps/meteor/server/methods/loadMissedMessages.ts b/apps/meteor/server/methods/loadMissedMessages.ts
@@ -16,7 +16,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async loadMissedMessages(rid, start) {
-		methodDeprecationLogger.method('loadMissedMessages', '9.0.0', '/v1/chat.syncMessages');
+		methodDeprecationLogger.method('loadMissedMessages', '9.0.0', []);
 		check(rid, String);
 		check(start, Date);
 
diff --git a/apps/meteor/server/methods/loadNextMessages.ts b/apps/meteor/server/methods/loadNextMessages.ts
@@ -17,7 +17,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async loadNextMessages(rid, end, limit = 20) {
-		methodDeprecationLogger.method('loadNextMessages', '9.0.0', '/v1/chat.syncMessages');
+		methodDeprecationLogger.method('loadNextMessages', '9.0.0', []);
 		check(rid, String);
 		check(limit, Number);
 
diff --git a/apps/meteor/server/methods/loadSurroundingMessages.ts b/apps/meteor/server/methods/loadSurroundingMessages.ts
@@ -28,7 +28,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async loadSurroundingMessages(message, limit = 50, showThreadMessages = true) {
-		methodDeprecationLogger.method('loadSurroundingMessages', '9.0.0', '/v1/chat.syncMessages');
+		methodDeprecationLogger.method('loadSurroundingMessages', '9.0.0', []);
 		check(message, Object);
 		check(limit, Number);
 		check(showThreadMessages, Boolean);
diff --git a/apps/meteor/server/methods/readThreads.ts b/apps/meteor/server/methods/readThreads.ts
@@ -19,7 +19,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async readThreads(tmid) {
-		methodDeprecationLogger.method('readThreads', '9.0.0', '/v1/subscriptions.read');
+		methodDeprecationLogger.method('readThreads', '9.0.0', []);
 		check(tmid, String);
 
 		if (!Meteor.userId() || !settings.get('Threads_enabled')) {
diff --git a/apps/meteor/server/publications/room/index.ts b/apps/meteor/server/publications/room/index.ts
@@ -53,7 +53,7 @@ Meteor.methods<ServerMethods>({
 	},
 
 	async 'getRoomByTypeAndName'(type, name) {
-		methodDeprecationLogger.method('getRoomByTypeAndName', '9.0.0', '/v1/rooms.info');
+		methodDeprecationLogger.method('getRoomByTypeAndName', '9.0.0', []);
 		if (!type || !name) {
 			throw new Meteor.Error('error-invalid-room', 'Invalid room', {
 				method: 'getRoomByTypeAndName',
diff --git a/apps/meteor/server/publications/spotlight.ts b/apps/meteor/server/publications/spotlight.ts
@@ -69,7 +69,7 @@ export const spotlightMethod = async ({
 
 Meteor.methods<ServerMethods>({
 	async spotlight(text, usernames = [], type = { users: true, rooms: true, mentions: false, includeFederatedRooms: false }, rid) {
-		methodDeprecationLogger.method('spotlight', '9.0.0', '/v1/spotlight');
+		methodDeprecationLogger.method('spotlight', '9.0.0', []);
 		return spotlightMethod({ text, usernames, type, rid, userId: this.userId });
 	},
 });
diff --git a/apps/meteor/server/publications/subscription/index.ts b/apps/meteor/server/publications/subscription/index.ts
@@ -3,6 +3,7 @@ import type { ServerMethods } from '@rocket.chat/ddp-client';
 import { Subscriptions } from '@rocket.chat/models';
 import { Meteor } from 'meteor/meteor';
 
+import { methodDeprecationLogger } from '../../../app/lib/server/lib/deprecationWarningLogger';
 import { subscriptionFields } from '../../../lib/publishFields';
 
 declare module '@rocket.chat/ddp-client' {
@@ -45,6 +46,7 @@ export const getSubscriptions = async (
 
 Meteor.methods<ServerMethods>({
 	async 'subscriptions/get'(updatedAt) {
+		methodDeprecationLogger.method('subscriptions/get', '9.0.0', '/v1/subscriptions.get');
 		const uid = Meteor.userId();
 		if (!uid) {
 			return [];
diff --git a/docs/ddp-audit.json b/docs/ddp-audit.json
diff --git a/docs/ddp-audit.md b/docs/ddp-audit.md
diff --git a/docs/ddp-replacement-review.md b/docs/ddp-replacement-review.md
diff --git a/scripts/audit-ddp-methods.mjs b/scripts/audit-ddp-methods.mjs
