BC-8348 - Implement Sharing and Copying of Room Boards

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

@@ -19,11 +19,11 @@ export class Migration202410041210124 extends Migration {
 
 	async down(): Promise<void> {
 		// Remove ROOM_VIEWER role
-		await this.getCollection('roles').deleteOne({ name: 'ROOM_VIEWER' });
+		await this.getCollection('roles').deleteOne({ name: 'room_viewer' });
 		console.info('Rollback: Removed ROOM_VIEWER role');
 
 		// Remove ROOM_EDITOR role
-		await this.getCollection('roles').deleteOne({ name: 'ROOM_EDITOR' });
+		await this.getCollection('roles').deleteOne({ name: 'room_editor' });
 		console.info('Rollback: Removed ROOM_EDITOR role');
 	}
 }

apps/server/src/migrations/mikro-orm/Migration20241111160412.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/Migration20241112163538.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/Migration20241113100535.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 (roomEditorRoleUpdate.modifiedCount > 0) {
+			console.info('Rollback: Permission ROOM_DELETE added to role roomeditor.');
+		}
+	}
+}

apps/server/src/migrations/mikro-orm/Migration20241113152001.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/migrations/mikro-orm/Migration20241127195120.ts

@@ -0,0 +1,15 @@
+import { Migration } from '@mikro-orm/migrations-mongodb';
+
+export class Migration20241127195120 extends Migration {
+	async up(): Promise<void> {
+		const db = this.driver.getConnection().getDb();
+		await db.renameCollection('room-members', 'room-memberships');
+		console.info('Collection renamed from room-members to room-memberships');
+	}
+
+	async down(): Promise<void> {
+		const db = this.driver.getConnection().getDb();
+		await db.renameCollection('room-memberships', 'room-members');
+		console.info('Collection renamed from room-memberships to room-members');
+	}
+}

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

@@ -0,0 +1,61 @@
+import { Migration } from '@mikro-orm/migrations-mongodb';
+
+export class Migration20241128155801 extends Migration {
+	async up(): Promise<void> {
+		const roomMembershipToSchoolView = [
+			{
+				$match: {
+					school: { $exists: false, $eq: null },
+				},
+			},
+			{
+				$lookup: {
+					from: 'rooms',
+					localField: 'room',
+					foreignField: '_id',
+					as: 'roomDetails',
+				},
+			},
+			{
+				$unwind: '$roomDetails',
+			},
+			{
+				$group: {
+					_id: '$roomDetails.school',
+					roomMemberships: { $push: '$_id' },
+				},
+			},
+			{
+				$project: {
+					_id: 0,
+					school: '$_id',
+					roomMemberships: 1,
+				},
+			},
+		];
+
+		const mappings = await this.driver.aggregate('room-memberships', roomMembershipToSchoolView);
+
+		for await (const mapping of mappings) {
+			const schoolUpdate = await this.driver.nativeUpdate(
+				'room-memberships',
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-argument,@typescript-eslint/no-unsafe-member-access
+				{ _id: { $in: mapping.roomMemberships } },
+				// 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 roomMemberships 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/board/board-api.module.ts

@@ -2,7 +2,7 @@ import { AuthorizationModule } from '@modules/authorization';
 import { forwardRef, Module } from '@nestjs/common';
 import { CourseRepo } from '@shared/repo/course';
 import { LoggerModule } from '@src/core/logger';
-import { RoomMemberModule } from '../room-member';
+import { RoomMembershipModule } from '@src/modules/room-membership';
 import { BoardModule } from './board.module';
 import {
 	BoardController,
@@ -13,9 +13,10 @@ import {
 } from './controller';
 import { BoardNodePermissionService } from './service';
 import { BoardUc, CardUc, ColumnUc, ElementUc, SubmissionItemUc } from './uc';
+import { RoomModule } from '../room';
 
 @Module({
-	imports: [BoardModule, LoggerModule, RoomMemberModule, forwardRef(() => AuthorizationModule)],
+	imports: [BoardModule, LoggerModule, RoomMembershipModule, RoomModule, forwardRef(() => AuthorizationModule)],
 	controllers: [BoardController, ColumnController, CardController, ElementController, BoardSubmissionController],
 	providers: [BoardUc, BoardNodePermissionService, ColumnUc, CardUc, ElementUc, SubmissionItemUc, CourseRepo],
 })

apps/server/src/modules/board/board-ws-api.module.ts

@@ -3,15 +3,23 @@ import { UserModule } from '@modules/user';
 import { forwardRef, Module } from '@nestjs/common';
 import { CourseRepo } from '@shared/repo/course';
 import { LoggerModule } from '@src/core/logger';
-import { RoomMemberModule } from '../room-member';
+import { RoomMembershipModule } from '../room-membership';
 import { BoardModule } from './board.module';
 import { BoardCollaborationGateway } from './gateway/board-collaboration.gateway';
 import { MetricsService } from './metrics/metrics.service';
 import { BoardNodePermissionService } from './service';
 import { BoardUc, CardUc, ColumnUc, ElementUc } from './uc';
+import { RoomModule } from '../room';
 
 @Module({
-	imports: [BoardModule, forwardRef(() => AuthorizationModule), LoggerModule, UserModule, RoomMemberModule],
+	imports: [
+		BoardModule,
+		forwardRef(() => AuthorizationModule),
+		LoggerModule,
+		UserModule,
+		RoomMembershipModule,
+		RoomModule,
+	],
 	providers: [
 		BoardCollaborationGateway,
 		BoardNodePermissionService,

apps/server/src/modules/board/board.module.ts

@@ -10,7 +10,7 @@ import { CqrsModule } from '@nestjs/cqrs';
 import { CourseRepo } from '@shared/repo/course';
 import { LoggerModule } from '@src/core/logger';
 import { AuthorizationModule } from '../authorization';
-import { RoomMemberModule } from '../room-member';
+import { RoomMembershipModule } from '../room-membership';
 import { BoardNodeRule } from './authorisation/board-node.rule';
 import { BoardNodeFactory } from './domain';
 import { BoardNodeRepo } from './repo';
@@ -46,7 +46,7 @@ import {
 		CqrsModule,
 		CollaborativeTextEditorModule,
 		AuthorizationModule,
-		RoomMemberModule,
+		RoomMembershipModule,
 	],
 	providers: [
 		// TODO: move BoardDoAuthorizableService, BoardDoRepo, BoardDoService, BoardNodeRepo in separate module and move mediaboard related services in mediaboard module