From 10afc76843d69e326c9448fb613b6c26713246aa Mon Sep 17 00:00:00 2001 From: AllanPazRibeiro Date: Fri, 7 Jun 2024 17:08:31 -0300 Subject: [PATCH] chore: fix some comments --- .../server/functions/loadMessageHistory.ts | 2 +- .../lib/server/lib/getHiddenSystemMessages.ts | 2 +- .../lib/server/methods/getChannelHistory.ts | 7 ++--- .../server/lib/getHiddenSystemMessage.spec.ts | 28 +++++++++++++++---- 4 files changed, 28 insertions(+), 11 deletions(-) diff --git a/apps/meteor/app/lib/server/functions/loadMessageHistory.ts b/apps/meteor/app/lib/server/functions/loadMessageHistory.ts index e51bcd142cf17..af631957cccb6 100644 --- a/apps/meteor/app/lib/server/functions/loadMessageHistory.ts +++ b/apps/meteor/app/lib/server/functions/loadMessageHistory.ts @@ -32,7 +32,7 @@ export async function loadMessageHistory({ const hiddenSystemMessages = (await getSettingCached('Hide_System_Messages')) as MessageTypesValues[]; - const hiddenMessageTypes = await getHiddenSystemMessages(room, hiddenSystemMessages); + const hiddenMessageTypes = getHiddenSystemMessages(room, hiddenSystemMessages); const options: FindOptions = { sort: { diff --git a/apps/meteor/app/lib/server/lib/getHiddenSystemMessages.ts b/apps/meteor/app/lib/server/lib/getHiddenSystemMessages.ts index 6fb9dc356f61f..35f0f7f9f1ff8 100644 --- a/apps/meteor/app/lib/server/lib/getHiddenSystemMessages.ts +++ b/apps/meteor/app/lib/server/lib/getHiddenSystemMessages.ts @@ -1,5 +1,5 @@ import type { MessageTypesValues, IRoom } from '@rocket.chat/core-typings'; -export const getHiddenSystemMessages = async (room: IRoom, hiddenSystemMessages: MessageTypesValues[]): Promise => { +export const getHiddenSystemMessages = (room: IRoom, hiddenSystemMessages: MessageTypesValues[]): MessageTypesValues[] => { return Array.isArray(room?.sysMes) ? room.sysMes : [...hiddenSystemMessages]; }; diff --git a/apps/meteor/app/lib/server/methods/getChannelHistory.ts b/apps/meteor/app/lib/server/methods/getChannelHistory.ts index 56d960946d91a..7c5e5903a76ce 100644 --- a/apps/meteor/app/lib/server/methods/getChannelHistory.ts +++ b/apps/meteor/app/lib/server/methods/getChannelHistory.ts @@ -1,5 +1,5 @@ import type { IMessage, MessageTypesValues } from '@rocket.chat/core-typings'; -import { Messages, Subscriptions, Rooms } from '@rocket.chat/models'; +import { Messages, Subscriptions, Rooms, Settings } from '@rocket.chat/models'; import type { ServerMethods } from '@rocket.chat/ui-contexts'; import { check } from 'meteor/check'; import { Meteor } from 'meteor/meteor'; @@ -9,7 +9,6 @@ import { canAccessRoomAsync } from '../../../authorization/server'; import { hasPermissionAsync } from '../../../authorization/server/functions/hasPermission'; import { normalizeMessagesForUser } from '../../../utils/server/lib/normalizeMessagesForUser'; import { getHiddenSystemMessages } from '../lib/getHiddenSystemMessages'; -import { getSettingCached } from '../lib/getMemSettings'; declare module '@rocket.chat/ui-contexts' { // eslint-disable-next-line @typescript-eslint/naming-convention @@ -68,9 +67,9 @@ Meteor.methods({ throw new Meteor.Error('error-invalid-date', 'Invalid date', { method: 'getChannelHistory' }); } - const hiddenSystemMessages = (await getSettingCached('Hide_System_Messages')) as MessageTypesValues[]; + const hiddenSystemMessages = (await Settings.getValueById('Hide_System_Messages')) as MessageTypesValues[]; - const hiddenMessageTypes = await getHiddenSystemMessages(room, hiddenSystemMessages); + const hiddenMessageTypes = getHiddenSystemMessages(room, hiddenSystemMessages); const options: Record = { sort: { diff --git a/apps/meteor/tests/unit/app/lib/server/lib/getHiddenSystemMessage.spec.ts b/apps/meteor/tests/unit/app/lib/server/lib/getHiddenSystemMessage.spec.ts index 64ccceb98b6ac..064c270929871 100644 --- a/apps/meteor/tests/unit/app/lib/server/lib/getHiddenSystemMessage.spec.ts +++ b/apps/meteor/tests/unit/app/lib/server/lib/getHiddenSystemMessage.spec.ts @@ -15,7 +15,7 @@ describe('getHiddenSystemMessages', () => { _updatedAt: new Date(), }; - const result = await getHiddenSystemMessages(room, []); + const result = getHiddenSystemMessages(room, []); expect(result).to.deep.equal(room.sysMes); }); @@ -32,7 +32,7 @@ describe('getHiddenSystemMessages', () => { _updatedAt: new Date(), }; - const result = await getHiddenSystemMessages(room, cachedHiddenSystemMessage); + const result = getHiddenSystemMessages(room, cachedHiddenSystemMessage); expect(result).to.deep.equal(cachedHiddenSystemMessage); }); @@ -47,13 +47,13 @@ describe('getHiddenSystemMessages', () => { _updatedAt: new Date(), }; - const result = await getHiddenSystemMessages(room, []); + const result = getHiddenSystemMessages(room, []); expect(result).to.deep.equal([]); }); it('should return cached hidden system messages if room.sysMes is null', async () => { - const cachedHiddenSystemMessage: MessageTypesValues[] = ['room_changed_announcement', 'room_changed_announcement']; + const cachedHiddenSystemMessage: MessageTypesValues[] = ['subscription-role-added', 'room_changed_announcement']; const room: IRoom = { _id: 'roomId', @@ -65,8 +65,26 @@ describe('getHiddenSystemMessages', () => { _updatedAt: new Date(), }; - const result = await getHiddenSystemMessages(room, cachedHiddenSystemMessage); + const result = getHiddenSystemMessages(room, cachedHiddenSystemMessage); expect(result).to.deep.equal(cachedHiddenSystemMessage); }); + + it('should return cached hidden system messages if room.sysMes array and hidden system message is available', async () => { + const cachedHiddenSystemMessage: MessageTypesValues[] = ['room_changed_announcement', 'room-archived']; + + const room: IRoom = { + _id: 'roomId', + sysMes: ['mute_unmute', 'room_changed_description'] as MessageTypesValues[], + t: 'c', + msgs: 0, + u: {} as IUser, + usersCount: 0, + _updatedAt: new Date(), + }; + + const result = getHiddenSystemMessages(room, cachedHiddenSystemMessage); + + expect(result).to.deep.equal(['mute_unmute', 'room_changed_description']); + }); });