Admin joining (#43)

* updated to work with new DTOs + event types

* updated dtos + events

* add admin to room if not a member, and then wait for invitation to accept and/or room to sync

* tidy up

* version bump

* added a small explainer

* reverted default account

* version bump

* ensure can delete message also by being part of room for admin user

---------

Co-authored-by: Svetoslav <[email protected]>

Author: techsmyth

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
   "files.eol": "\n"
 }

lib/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@alkemio/matrix-adapter-lib",
-  "version": "0.3.6",
+  "version": "0.4.1",
   "description": "Library for interacting with Alkemio Matrix Adapter service",
   "author": "Alkemio Foundation",
   "private": false,

lib/package.json

@@ -29,10 +29,8 @@ export * from './remove.room.payload';
 export * from './remove.room.response.payload';
 export * from './room.members.payload';
 export * from './room.members.response.payload';
-export * from './room.join.rule.payload';
-export * from './room.join.rule.response.payload';
-export * from './update.rooms.guest.access.payload';
-export * from './update.rooms.guest.access.response.payload';
+export * from './update.room.state.payload';
+export * from './update.room.state.payload';
 export * from './send.message.to.user.payload';
 export * from './send.message.to.user.response.payload';
 export * from './register.new.user.payload';

lib/src/dto/index.ts

@@ -3,4 +3,5 @@ import { BaseMatrixAdapterEventPayload } from './base.event.payload';
 
 export interface RoomDetailsPayload extends BaseMatrixAdapterEventPayload {
   roomID: string;
+  withState?: boolean;
 }

lib/src/dto/room.details.payload.ts

@@ -0,0 +1,9 @@
+
+import { BaseMatrixAdapterEventPayload } from './base.event.payload';
+
+export interface UpdateRoomStatePayload extends BaseMatrixAdapterEventPayload {
+  roomID: string;
+  
+  historyWorldVisibile?: boolean;
+  allowJoining?: boolean;
+}

lib/src/dto/room.join.rule.payload.ts

@@ -1,6 +1,5 @@
 export enum MatrixAdapterEventType {
   ROOM_DETAILS = 'roomDetails',
-  ROOM_JOIN_RULE = 'roomJoinRule',
   ROOM_MEMBERS = 'roomMembers',
   ROOM_SEND_MESSAGE = 'roomSendMessage',
   ROOM_SEND_MESSAGE_REPLY = 'roomSendMessageReply',
@@ -19,7 +18,7 @@ export enum MatrixAdapterEventType {
   ADD_USER_TO_ROOMS = 'addUserToRooms',
   ADD_USER_TO_ROOM = 'addUserToRoom',
   REMOVE_ROOM = 'removeRoom',
-  UPDATE_ROOMS_GUEST_ACCESS = 'updateRoomsGuestAccess',
+  UPDATE_ROOM_STATE = 'updateRoomState',
   SEND_MESSAGE_TO_USER = 'sendMessageToUser',
   REGISTER_NEW_USER = 'registerNewUser',
 }

lib/src/dto/room.join.rule.response.payload.ts

@@ -9,4 +9,8 @@ export class RoomResult {
 
   // The communication IDs of the room members
   members!: string[];
+
+  joinRule?: string;
+  
+  historyVisibility?: string;
 }

lib/src/dto/update.room.state.payload.ts

@@ -32,3 +32,12 @@ Alkemio Matrix Adapter service.
 Execute the following command from the workspace root:
 
 `docker build -t alkemio/matrix-adapter:v0.2.0 .`
+
+## Explainer
+
+The way syncing works with Matrix SDK client is that you see the rooms in the MatrixClient that you are a member of.
+
+For the way we use it this can mean that the admin account can potentially have a lot of rooms that it is a member of, and hence take a long time to sync.
+
+To address this, an admin account is only added as a member at the moment that it needs to read the room. This does mean the sync time will increase over time, but it
+is then trivial to go to a new admin account and have that gradually join the rooms that are needed.

lib/src/dto/update.rooms.guest.access.payload.ts

@@ -1,6 +1,6 @@
 {
   "name": "alkemio-matrix-adapter",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Alkemio Matrix Adapter service",
   "author": "Alkemio Foundation",
   "private": false,
@@ -34,7 +34,7 @@
     "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --config src/config/typeorm.cli.config.ts"
   },
   "dependencies": {
-    "@alkemio/matrix-adapter-lib": "^0.3.6",
+    "@alkemio/matrix-adapter-lib": "^0.4.1",
     "@nestjs/axios": "^2.0.0",
     "@nestjs/common": "^9.4.0",
     "@nestjs/config": "^2.3.1",

lib/src/dto/update.rooms.guest.access.response.payload.ts

@@ -11,12 +11,9 @@ import { LogContext } from './common/enums';
 import {
   MatrixAdapterEventType,
   RoomDetailsResponsePayload,
-  RoomJoinRulePayload,
-  RoomJoinRuleResponsePayload,
   RoomMembersPayload,
   RoomMembersResponsePayload,
-  UpdateRoomsGuestAccessPayload,
-  UpdateRoomsGuestAccessResponsePayload,
+  UpdateRoomStatePayload,
 } from '@alkemio/matrix-adapter-lib';
 import { RoomDetailsPayload } from '@alkemio/matrix-adapter-lib';
 import { CommunicationAdapter } from './services/communication-adapter/communication.adapter';
@@ -344,13 +341,13 @@ export class AppController {
     }
   }
 
-  @MessagePattern({ cmd: MatrixAdapterEventType.ROOM_JOIN_RULE })
-  async roomJoinRule(
-    @Payload() data: RoomJoinRulePayload,
+  @MessagePattern({ cmd: MatrixAdapterEventType.UPDATE_ROOM_STATE })
+  async updateRoomState(
+    @Payload() data: UpdateRoomStatePayload,
     @Ctx() context: RmqContext
-  ): Promise<RoomJoinRuleResponsePayload> {
+  ): Promise<RoomDetailsResponsePayload> {
     this.logger.verbose?.(
-      `${MatrixAdapterEventType.ROOM_JOIN_RULE} - payload: ${JSON.stringify(
+      `${MatrixAdapterEventType.UPDATE_ROOM_STATE} - payload: ${JSON.stringify(
         data
       )}`,
       LogContext.EVENTS
@@ -359,46 +356,10 @@ export class AppController {
     const originalMsg = context.getMessage();
 
     try {
-      const rule = await this.communicationAdapter.getRoomJoinRule(data.roomID);
-      channel.ack(originalMsg);
-      const response: RoomJoinRuleResponsePayload = {
-        rule: rule,
-      };
-
-      return response;
-    } catch (error) {
-      const errorMessage = `Error when getting join rule on room: ${error}`;
-      this.logger.error(errorMessage, LogContext.COMMUNICATION);
-      channel.ack(originalMsg);
-      throw new RpcException(errorMessage);
-    }
-  }
-
-  @MessagePattern({ cmd: MatrixAdapterEventType.UPDATE_ROOMS_GUEST_ACCESS })
-  async updateRoomsGuestAccess(
-    @Payload() data: UpdateRoomsGuestAccessPayload,
-    @Ctx() context: RmqContext
-  ): Promise<UpdateRoomsGuestAccessResponsePayload> {
-    this.logger.verbose?.(
-      `${
-        MatrixAdapterEventType.UPDATE_ROOMS_GUEST_ACCESS
-      } - payload: ${JSON.stringify(data)}`,
-      LogContext.EVENTS
-    );
-    const channel = context.getChannelRef();
-    const originalMsg = context.getMessage();
-
-    try {
-      const result = await this.communicationAdapter.setMatrixRoomsGuestAccess(
-        data.roomIDs,
-        data.allowGuests
-      );
+      const result = await this.communicationAdapter.updateRoomState(data);
       channel.ack(originalMsg);
-      const response: UpdateRoomsGuestAccessResponsePayload = {
-        success: result,
-      };
 
-      return response;
+      return result;
     } catch (error) {
       const errorMessage = `Error when getting join rule on room: ${error}`;
       this.logger.error(errorMessage, LogContext.COMMUNICATION);