BC-8348 - Implement Sharing and Copying of Room Boards

apps/server/src/migrations/mikro-orm/Migration202411111604124.ts

@@ -0,0 +1,27 @@
+import { Migration } from '@mikro-orm/migrations-mongodb';
+
+export class Migration20241111160412 extends Migration {
+	async up(): Promise<void> {
+		// Rename ROOM_VIEWER role from room_viewer to roomviewer
+		await this.getCollection('roles').updateMany({ name: 'room_viewer' }, { $set: { name: 'roomviewer' } });
+
+		console.info('Renamed ROOM_VIEWER role from room_viewer to roomviewer');
+
+		// Rename ROOM_EDITOR role from room_editor to roomeditor
+		await this.getCollection('roles').updateMany({ name: 'room_editor' }, { $set: { name: 'roomeditor' } });
+
+		console.info('Renamed ROOM_EDITOR role from room_editor to roomeditor');
+	}
+
+	async down(): Promise<void> {
+		// Rename ROOM_VIEWER role from roomviewer to room_viewer
+		await this.getCollection('roles').updateMany({ name: 'roomviewer' }, { $set: { name: 'room_viewer' } });
+
+		console.info('Rollback: Renamed ROOM_VIEWER role from roomviewer to room_viewer');
+
+		// Rename ROOM_EDITOR role from roomeditor to room_editor
+		await this.getCollection('roles').updateMany({ name: 'roomeditor' }, { $set: { name: 'room_editor' } });
+
+		console.info('Rollback: Renamed ROOM_EDITOR role from roomeditor to room_editor');
+	}
+}

apps/server/src/migrations/mikro-orm/Migration202411121635382.ts

@@ -0,0 +1,31 @@
+import { Migration } from '@mikro-orm/migrations-mongodb';
+
+export class Migration20241112163538 extends Migration {
+	async up(): Promise<void> {
+		const collection = this.getCollection('room-members');
+
+		await collection.updateMany({ roomId: { $type: 'string' } }, [
+			{
+				$set: {
+					roomId: {
+						$convert: {
+							input: '$roomId',
+							to: 'objectId',
+							onError: '$roomId', // Keep the original value if conversion fails
+							onNull: '$roomId', // Keep the original value if the input is null
+						},
+					},
+				},
+			},
+		]);
+		console.info('Converted roomId from string to ObjectId');
+
+		await collection.updateMany({}, { $rename: { roomId: 'room' } });
+		console.info('Renamed roomId to room');
+	}
+
+	async down(): Promise<void> {
+		await Promise.resolve();
+		console.error(`Migration down not implemented. You might need to restore database from backup!`);
+	}
+}

apps/server/src/migrations/mikro-orm/Migration202411131005352.ts

@@ -0,0 +1,67 @@
+import { Migration } from '@mikro-orm/migrations-mongodb';
+
+export class Migration20241113100535 extends Migration {
+	async up(): Promise<void> {
+		const teacherRoleUpdate = await this.getCollection('roles').updateOne(
+			{ name: 'teacher' },
+			{
+				$addToSet: {
+					permissions: {
+						$each: ['ROOM_CREATE'],
+					},
+				},
+			}
+		);
+
+		if (teacherRoleUpdate.modifiedCount > 0) {
+			console.info('Permissions ROOM_CREATE added to role teacher.');
+		}
+
+		const roomEditorRoleUpdate = await this.getCollection('roles').updateOne(
+			{ name: 'roomeditor' },
+			{
+				$addToSet: {
+					permissions: {
+						$each: ['ROOM_DELETE'],
+					},
+				},
+			}
+		);
+
+		if (roomEditorRoleUpdate.modifiedCount > 0) {
+			console.info('Permissions ROOM_DELETE added to role roomeditor.');
+		}
+	}
+
+	async down(): Promise<void> {
+		const teacherRoleUpdate = await this.getCollection('roles').updateOne(
+			{ name: 'teacher' },
+			{
+				$pull: {
+					permissions: {
+						$in: ['ROOM_CREATE'],
+					},
+				},
+			}
+		);
+
+		if (teacherRoleUpdate.modifiedCount > 0) {
+			console.info('Rollback: Permission ROOM_CREATE added to role teacher.');
+		}
+
+		const roomEditorRoleUpdate = await this.getCollection('roles').updateOne(
+			{ name: 'roomeditor' },
+			{
+				$pull: {
+					permissions: {
+						$in: ['ROOM_DELETE'],
+					},
+				},
+			}
+		);
+
+		if (teacherRoleUpdate.modifiedCount > 0) {
+			console.info('Rollback: Permission ROOM_DELETE added to role roomeditor.');
+		}
+	}
+}

apps/server/src/migrations/mikro-orm/Migration202411131520015.ts

@@ -0,0 +1,102 @@
+import { Migration } from '@mikro-orm/migrations-mongodb';
+
+export class Migration20241113152001 extends Migration {
+	async up(): Promise<void> {
+		const roomsToSchoolView = [
+			{
+				$lookup: {
+					from: 'rooms',
+					localField: 'room',
+					foreignField: '_id',
+					as: 'roomDetails',
+				},
+			},
+			{
+				$unwind: '$roomDetails',
+			},
+			{
+				$match: {
+					'roomDetails.school': { $exists: false, $eq: null },
+				},
+			},
+			{
+				$lookup: {
+					from: 'groups',
+					localField: 'userGroup',
+					foreignField: '_id',
+					as: 'groupDetails',
+				},
+			},
+			{
+				$unwind: '$groupDetails',
+			},
+			{
+				$unwind: '$groupDetails.users',
+			},
+			{
+				$lookup: {
+					from: 'roles',
+					localField: 'groupDetails.users.role',
+					foreignField: '_id',
+					as: 'roleDetails',
+				},
+			},
+			{
+				$unwind: '$roleDetails',
+			},
+			{
+				$match: {
+					'roleDetails.name': 'roomeditor',
+				},
+			},
+			{
+				$lookup: {
+					from: 'users',
+					localField: 'groupDetails.users.user',
+					foreignField: '_id',
+					as: 'userDetails',
+				},
+			},
+			{
+				$unwind: '$userDetails',
+			},
+			{
+				$group: {
+					_id: '$userDetails.schoolId',
+					rooms: { $push: '$roomDetails._id' },
+				},
+			},
+			{
+				$project: {
+					_id: 0,
+					school: '$_id',
+					rooms: 1,
+				},
+			},
+		];
+
+		const mappings = await this.driver.aggregate('room-members', roomsToSchoolView);
+
+		for await (const mapping of mappings) {
+			const schoolUpdate = await this.driver.nativeUpdate(
+				'rooms',
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-argument,@typescript-eslint/no-unsafe-member-access
+				{ _id: { $in: mapping.rooms } },
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-argument,@typescript-eslint/no-unsafe-member-access
+				{ $set: { school: mapping.school } }
+			);
+
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access, @typescript-eslint/restrict-template-expressions, @typescript-eslint/no-unsafe-call
+			console.info(`Updated ${schoolUpdate.affectedRows} rooms with school ${mapping.school.toHexString()}`);
+		}
+
+		if (mappings.length === 0) {
+			console.info(`No rooms without school to update`);
+		}
+	}
+
+	async down(): Promise<void> {
+		await Promise.resolve();
+		console.error(`Migration down not implemented. You might need to restore database from backup!`);
+	}
+}

apps/server/src/modules/room-member/repo/entity/room-member.entity.ts

@@ -16,12 +16,11 @@ export interface RoomMemberEntityProps extends AuthorizableObject {
 @Entity({ tableName: 'room-members' })
 @Unique({ properties: ['roomId', 'userGroupId'] })
 export class RoomMemberEntity extends BaseEntityWithTimestamps implements RoomMemberEntityProps {
-	@Property()
 	@Unique()
-	@Property({ type: ObjectIdType })
+	@Property({ type: ObjectIdType, fieldName: 'room' })
 	roomId!: EntityId;
 
-	@Property({ type: ObjectIdType })
+	@Property({ type: ObjectIdType, fieldName: 'userGroup' })
 	userGroupId!: EntityId;
 
 	@Property({ persist: false })

apps/server/src/modules/room/api/dto/request/create-room.body.params.ts

@@ -4,7 +4,7 @@ import { RoomCreateProps } from '@src/modules/room/domain';
 import { RoomColor } from '@src/modules/room/domain/type';
 import { IsDate, IsEnum, IsOptional, IsString, MaxLength, MinLength } from 'class-validator';
 
-export class CreateRoomBodyParams implements RoomCreateProps {
+export class CreateRoomBodyParams implements Omit<RoomCreateProps, 'schoolId'> {
 	@ApiProperty({
 		description: 'The name of the room',
 		required: true,

apps/server/src/modules/room/api/dto/response/room-details.response.ts

@@ -13,6 +13,9 @@ export class RoomDetailsResponse {
 	@IsEnum(RoomColor)
 	color: RoomColor;
 
+	@ApiProperty()
+	schoolId: string;
+
 	@ApiPropertyOptional({ type: Date })
 	startDate?: Date;
 
@@ -29,6 +32,7 @@ export class RoomDetailsResponse {
 		this.id = room.id;
 		this.name = room.name;
 		this.color = room.color;
+		this.schoolId = room.schoolId;
 
 		this.startDate = room.startDate;
 		this.endDate = room.endDate;

apps/server/src/modules/room/api/dto/response/room-item.response.ts

@@ -13,6 +13,9 @@ export class RoomItemResponse {
 	@IsEnum(RoomColor)
 	color: RoomColor;
 
+	@ApiProperty()
+	schoolId: string;
+
 	@ApiPropertyOptional({ type: Date })
 	startDate?: Date;
 
@@ -29,6 +32,7 @@ export class RoomItemResponse {
 		this.id = room.id;
 		this.name = room.name;
 		this.color = room.color;
+		this.schoolId = room.schoolId;
 
 		this.startDate = room.startDate;
 		this.endDate = room.endDate;

apps/server/src/modules/room/api/mapper/room.mapper.ts

@@ -14,6 +14,7 @@ export class RoomMapper {
 			id: room.id,
 			name: room.name,
 			color: room.color,
+			schoolId: room.schoolId,
 			startDate: room.startDate,
 			endDate: room.endDate,
 			createdAt: room.createdAt,
@@ -37,6 +38,7 @@ export class RoomMapper {
 			id: room.id,
 			name: room.name,
 			color: room.color,
+			schoolId: room.schoolId,
 			startDate: room.startDate,
 			endDate: room.endDate,
 			createdAt: room.createdAt,

apps/server/src/modules/room/api/room.uc.ts

@@ -8,8 +8,10 @@ import { Page, UserDO } from '@shared/domain/domainobject';
 import { IFindOptions, Permission, RoleName, RoomRole } from '@shared/domain/interface';
 import { EntityId } from '@shared/domain/types';
 import { BoardExternalReferenceType, ColumnBoard, ColumnBoardService } from '@src/modules/board';
-import { Room, RoomCreateProps, RoomService, RoomUpdateProps } from '../domain';
+import { Room, RoomService } from '../domain';
 import { RoomConfig } from '../room.config';
+import { CreateRoomBodyParams } from './dto/request/create-room.body.params';
+import { UpdateRoomBodyParams } from './dto/request/update-room.body.params';
 import { RoomMemberResponse } from './dto/response/room-member.response';
 
 @Injectable()
@@ -31,13 +33,13 @@ export class RoomUc {
 		return rooms;
 	}
 
-	public async createRoom(userId: EntityId, props: RoomCreateProps): Promise<Room> {
+	public async createRoom(userId: EntityId, props: CreateRoomBodyParams): Promise<Room> {
 		this.checkFeatureEnabled();
 
 		const user = await this.authorizationService.getUserWithPermissions(userId);
-		const room = await this.roomService.createRoom(props);
-		// NOTE: currently only teacher are allowed to create rooms. Could not find simpler way to check this.
-		this.authorizationService.checkOneOfPermissions(user, [Permission.COURSE_CREATE]);
+		const room = await this.roomService.createRoom({ ...props, schoolId: user.school.id });
+		// NOTE: currently only teachers are allowed to create rooms. Could not find simpler way to check this.
+		this.authorizationService.checkOneOfPermissions(user, [Permission.ROOM_CREATE]);
 		await this.roomMemberService
 			.addMembersToRoom(room.id, [{ userId: user.id, roleName: RoleName.ROOM_EDITOR }], user.school.id)
 			.catch(async (err) => {
@@ -72,7 +74,7 @@ export class RoomUc {
 		return boards;
 	}
 
-	public async updateRoom(userId: EntityId, roomId: EntityId, props: RoomUpdateProps): Promise<Room> {
+	public async updateRoom(userId: EntityId, roomId: EntityId, props: UpdateRoomBodyParams): Promise<Room> {
 		this.checkFeatureEnabled();
 		const room = await this.roomService.getSingleRoom(roomId);
 
@@ -86,7 +88,7 @@ export class RoomUc {
 		this.checkFeatureEnabled();
 		const room = await this.roomService.getSingleRoom(roomId);
 
-		await this.checkRoomAuthorization(userId, roomId, Action.write);
+		await this.checkRoomAuthorization(userId, roomId, Action.write, [Permission.ROOM_DELETE]);
 		await this.roomService.deleteRoom(room);
 	}
 
@@ -151,10 +153,15 @@ export class RoomUc {
 		return authorizedRoomIds.map((item) => item.roomId);
 	}
 
-	private async checkRoomAuthorization(userId: EntityId, roomId: EntityId, action: Action): Promise<void> {
+	private async checkRoomAuthorization(
+		userId: EntityId,
+		roomId: EntityId,
+		action: Action,
+		requiredPermissions: Permission[] = []
+	): Promise<void> {
 		const roomMemberAuthorizable = await this.roomMemberService.getRoomMemberAuthorizable(roomId);
 		const user = await this.authorizationService.getUserWithPermissions(userId);
-		this.authorizationService.checkPermission(user, roomMemberAuthorizable, { action, requiredPermissions: [] });
+		this.authorizationService.checkPermission(user, roomMemberAuthorizable, { action, requiredPermissions });
 	}
 
 	private checkFeatureEnabled(): void {

apps/server/src/modules/room/api/test/room-get.api.spec.ts

@@ -114,6 +114,7 @@ describe('Room Controller (API)', () => {
 					id: room.id,
 					name: room.name,
 					color: room.color,
+					schoolId: room.schoolId,
 					startDate: room.startDate?.toISOString(),
 					endDate: room.endDate?.toISOString(),
 					createdAt: room.createdAt.toISOString(),

apps/server/src/modules/room/api/test/room-index.api.spec.ts

@@ -86,6 +86,7 @@ describe('Room Controller (API)', () => {
 						id: room.id,
 						name: room.name,
 						color: room.color,
+						schoolId: room.schoolId,
 						startDate: room.startDate?.toISOString(),
 						endDate: room.endDate?.toISOString(),
 						createdAt: room.createdAt.toISOString(),
@@ -152,6 +153,7 @@ describe('Room Controller (API)', () => {
 						id: room.id,
 						name: room.name,
 						color: room.color,
+						schoolId: room.schoolId,
 						startDate: room.startDate?.toISOString(),
 						endDate: room.endDate?.toISOString(),
 						createdAt: room.createdAt.toISOString(),