feat: Reactions bridge for apps (#792)

Author: KevLehman

src/definition/accessors/IMessageUpdater.ts

@@ -0,0 +1,21 @@
+import type { Reaction } from '../messages';
+
+export interface IMessageUpdater {
+    /**
+     * Add a reaction to a message
+     *
+     * @param messageId the id of the message
+     * @param userId the id of the user
+     * @param reaction the reaction
+     */
+    addReaction(messageId: string, userId: string, reaction: Reaction): Promise<void>;
+
+    /**
+     * Remove a reaction from a message
+     *
+     * @param messageId the id of the message
+     * @param userId the id of the user
+     * @param reaction the reaction
+     */
+    removeReaction(messageId: string, userId: string, reaction: Reaction): Promise<void>;
+}

src/definition/accessors/IModifyUpdater.ts

@@ -3,6 +3,7 @@ import type { ILivechatUpdater } from './ILivechatUpdater';
 import type { IMessageBuilder } from './IMessageBuilder';
 import type { IRoomBuilder } from './IRoomBuilder';
 import type { IUserUpdater } from './IUserUpdater';
+import type { IMessageUpdater } from './IMessageUpdater';
 
 export interface IModifyUpdater {
     /**
@@ -17,6 +18,12 @@ export interface IModifyUpdater {
      */
     getUserUpdater(): IUserUpdater;
 
+    /**
+     * Get the updater object responsible for
+     * methods that update messages
+     */
+    getMessageUpdater(): IMessageUpdater;
+
     /**
      * Modifies an existing message.
      * Raises an exception if a non-existent messageId is supplied

src/definition/accessors/index.ts

@@ -21,6 +21,7 @@ export * from './ILogger';
 export * from './IMessageBuilder';
 export * from './IMessageExtender';
 export * from './IMessageRead';
+export * from './IMessageUpdater';
 export * from './IModify';
 export * from './IModifyCreator';
 export * from './IModifyDeleter';

src/definition/messages/IMessageReaction.ts

@@ -1,6 +1,9 @@
+export type Reaction = `:${string}:`;
+
 /**
  * Interface which represents a reaction which can be added to a message.
  */
+// Note: keeping it as string for compatibility
 export interface IMessageReactions {
     [emoji: string]: Array<IMessageReaction>;
 }

src/definition/messages/index.ts

@@ -9,7 +9,7 @@ import { IMessageFile } from './IMessageFile';
 import { IMessageFollowContext } from './IMessageFollowContext';
 import { IMessagePinContext } from './IMessagePinContext';
 import { IMessageRaw } from './IMessageRaw';
-import { IMessageReaction, IMessageReactions } from './IMessageReaction';
+import { IMessageReaction, IMessageReactions, Reaction } from './IMessageReaction';
 import { IMessageReactionContext } from './IMessageReactionContext';
 import { IMessageReportContext } from './IMessageReportContext';
 import { IMessageStarContext } from './IMessageStarContext';
@@ -67,4 +67,5 @@ export {
     MessageActionType,
     MessageProcessingType,
     IMessageDeleteContext,
+    Reaction,
 };

src/server/accessors/ModifyUpdater.ts

@@ -1,4 +1,4 @@
-import type { ILivechatUpdater, IMessageBuilder, IModifyUpdater, IRoomBuilder } from '../../definition/accessors';
+import type { ILivechatUpdater, IMessageBuilder, IMessageUpdater, IModifyUpdater, IRoomBuilder } from '../../definition/accessors';
 import type { IUserUpdater } from '../../definition/accessors/IUserUpdater';
 import { RocketChatAssociationModel } from '../../definition/metadata';
 import { RoomType } from '../../definition/rooms';
@@ -15,6 +15,8 @@ export class ModifyUpdater implements IModifyUpdater {
 
     private userUpdater: IUserUpdater;
 
+    private messageUpdater: IMessageUpdater;
+
     constructor(private readonly bridges: AppBridges, private readonly appId: string) {
         this.livechatUpdater = new LivechatUpdater(this.bridges, this.appId);
         this.userUpdater = new UserUpdater(this.bridges, this.appId);
@@ -28,6 +30,10 @@ export class ModifyUpdater implements IModifyUpdater {
         return this.userUpdater;
     }
 
+    public getMessageUpdater(): IMessageUpdater {
+        return this.messageUpdater;
+    }
+
     public async message(messageId: string, updater: IUser): Promise<IMessageBuilder> {
         const msg = await this.bridges.getMessageBridge().doGetById(messageId, this.appId);
 

src/server/bridges/MessageBridge.ts

@@ -1,5 +1,5 @@
 import type { ITypingOptions } from '../../definition/accessors/INotifier';
-import type { IMessage } from '../../definition/messages';
+import type { IMessage, Reaction } from '../../definition/messages';
 import type { IRoom } from '../../definition/rooms';
 import type { IUser } from '../../definition/users';
 import { PermissionDeniedError } from '../errors/PermissionDeniedError';
@@ -54,6 +54,18 @@ export abstract class MessageBridge extends BaseBridge {
         }
     }
 
+    public async doAddReaction(messageId: string, userId: string, reaction: Reaction, appId: string): Promise<void> {
+        if (this.hasWritePermission(appId)) {
+            return this.addReaction(messageId, userId, reaction);
+        }
+    }
+
+    public async doRemoveReaction(messageId: string, userId: string, reaction: Reaction, appId: string): Promise<void> {
+        if (this.hasWritePermission(appId)) {
+            return this.removeReaction(messageId, userId, reaction);
+        }
+    }
+
     protected abstract create(message: IMessage, appId: string): Promise<string>;
 
     protected abstract update(message: IMessage, appId: string): Promise<void>;
@@ -68,6 +80,10 @@ export abstract class MessageBridge extends BaseBridge {
 
     protected abstract delete(message: IMessage, user: IUser, appId: string): Promise<void>;
 
+    protected abstract addReaction(messageId: string, userId: string, reaction: Reaction): Promise<void>;
+
+    protected abstract removeReaction(messageId: string, userId: string, reaction: Reaction): Promise<void>;
+
     private hasReadPermission(appId: string): boolean {
         if (AppPermissionManager.hasPermission(appId, AppPermissions.message.read)) {
             return true;

tests/test-data/bridges/messageBridge.ts

@@ -1,4 +1,4 @@
-import type { IMessage } from '../../../src/definition/messages';
+import type { IMessage, Reaction } from '../../../src/definition/messages';
 import type { IRoom } from '../../../src/definition/rooms';
 import type { IUser } from '../../../src/definition/users';
 import { MessageBridge } from '../../../src/server/bridges';
@@ -32,4 +32,12 @@ export class TestsMessageBridge extends MessageBridge {
     public typing(options: ITypingDescriptor): Promise<void> {
         throw new Error('Method not implemented.');
     }
+
+    public addReaction(_messageId: string, _userId: string, _reaction: Reaction): Promise<void> {
+        throw new Error('Method not implemented.');
+    }
+
+    public removeReaction(_messageId: string, _userId: string, _reaction: Reaction): Promise<void> {
+        throw new Error('Method not implemented.');
+    }
 }