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/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,11 +33,11 @@ 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);
+		const room = await this.roomService.createRoom({ ...props, schoolId: user.school.id });
 		// NOTE: currently only teacher are allowed to create rooms. Could not find simpler way to check this.
 		this.authorizationService.checkOneOfPermissions(user, [Permission.COURSE_CREATE]);
 		await this.roomMemberService
@@ -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);
 

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(),

apps/server/src/modules/room/domain/do/room.do.ts

@@ -9,12 +9,13 @@ export interface RoomProps extends AuthorizableObject {
 	color: RoomColor;
 	startDate?: Date;
 	endDate?: Date;
+	schoolId: EntityId;
 	createdAt: Date;
 	updatedAt: Date;
 }
 
-export type RoomCreateProps = Pick<RoomProps, 'name' | 'color' | 'startDate' | 'endDate'>;
-export type RoomUpdateProps = RoomCreateProps; // will probably change in the future
+export type RoomCreateProps = Pick<RoomProps, 'name' | 'color' | 'startDate' | 'endDate' | 'schoolId'>;
+export type RoomUpdateProps = Omit<RoomCreateProps, 'schoolId'>;
 
 export class Room extends DomainObject<RoomProps> {
 	public constructor(props: RoomProps) {
@@ -48,6 +49,10 @@ export class Room extends DomainObject<RoomProps> {
 		this.props.color = value;
 	}
 
+	public get schoolId(): EntityId {
+		return this.props.schoolId;
+	}
+
 	public get startDate(): Date | undefined {
 		return this.props.startDate;
 	}

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

@@ -1,5 +1,7 @@
 import { Entity, Property } from '@mikro-orm/core';
 import { BaseEntityWithTimestamps } from '@shared/domain/entity/base.entity';
+import { EntityId } from '@shared/domain/types';
+import { ObjectIdType } from '@shared/repo/types/object-id.type';
 import { Room, RoomProps } from '../../domain/do/room.do';
 import { RoomColor } from '../../domain/type';
 
@@ -11,6 +13,9 @@ export class RoomEntity extends BaseEntityWithTimestamps implements RoomProps {
 	@Property({ nullable: false })
 	color!: RoomColor;
 
+	@Property({ type: ObjectIdType, fieldName: 'school', nullable: false })
+	schoolId!: EntityId;
+
 	@Property({ nullable: true })
 	startDate?: Date;
 

apps/server/src/modules/room/repo/room-domain.mapper.spec.ts

@@ -1,3 +1,4 @@
+import { ObjectId } from '@mikro-orm/mongodb';
 import { Room, RoomProps } from '../domain/do/room.do';
 import { RoomColor } from '../domain/type';
 import { roomEntityFactory } from '../testing';
@@ -32,6 +33,7 @@ describe('RoomDomainMapper', () => {
 				id: '1',
 				name: 'Existing Room',
 				color: RoomColor.GREEN,
+				schoolId: new ObjectId().toHexString(),
 				startDate: new Date('2023-01-01'),
 				endDate: new Date('2023-12-31'),
 				createdAt: new Date('2023-01-01'),
@@ -42,6 +44,7 @@ describe('RoomDomainMapper', () => {
 				id: '2',
 				name: 'Test Room',
 				color: RoomColor.RED,
+				schoolId: new ObjectId().toHexString(),
 				startDate: new Date('2023-02-01'),
 				endDate: new Date('2023-11-30'),
 				domainObject: existingRoom,
@@ -55,6 +58,7 @@ describe('RoomDomainMapper', () => {
 				id: '1',
 				name: 'Existing Room',
 				color: RoomColor.GREEN,
+				schoolId: existingRoom.schoolId,
 				startDate: new Date('2023-01-01'),
 				endDate: new Date('2023-12-31'),
 				createdAt: new Date('2023-01-01'),
@@ -69,6 +73,7 @@ describe('RoomDomainMapper', () => {
 				id: '1',
 				name: 'Test Room',
 				color: RoomColor.RED,
+				schoolId: new ObjectId().toHexString(),
 				startDate: new Date('2023-01-01'),
 				endDate: new Date('2023-12-31'),
 			} as RoomEntity;
@@ -99,6 +104,7 @@ describe('RoomDomainMapper', () => {
 					id: '66d581c3ef74c548a4efea1d',
 					name: 'Test Room #1',
 					color: RoomColor.RED,
+					schoolId: new ObjectId().toHexString(),
 					startDate: new Date('2023-01-01'),
 					endDate: new Date('2023-12-31'),
 					createdAt: new Date('2024-10-1'),

apps/server/src/modules/room/testing/room-entity.factory.ts

@@ -9,6 +9,7 @@ export const roomEntityFactory = EntityFactory.define<RoomEntity, RoomProps>(Roo
 		id: new ObjectId().toHexString(),
 		name: `room #${sequence}`,
 		color: [RoomColor.BLUE, RoomColor.RED, RoomColor.GREEN, RoomColor.MAGENTA][Math.floor(Math.random() * 4)],
+		schoolId: new ObjectId().toHexString(),
 		startDate: new Date(),
 		endDate: new Date(Date.now() + 1000 * 60 * 60 * 24 * 7),
 		createdAt: new Date(),

apps/server/src/modules/room/testing/room.factory.ts

@@ -8,6 +8,7 @@ export const roomFactory = BaseFactory.define<Room, RoomProps>(Room, ({ sequence
 		id: new ObjectId().toHexString(),
 		name: `room #${sequence}`,
 		color: [RoomColor.BLUE, RoomColor.RED, RoomColor.GREEN, RoomColor.MAGENTA][Math.floor(Math.random() * 4)],
+		schoolId: new ObjectId().toHexString(),
 		startDate: new Date(),
 		createdAt: new Date(),
 		updatedAt: new Date(),

apps/server/src/shared/domain/interface/rolename.enum.ts

@@ -9,8 +9,8 @@ export enum RoleName {
 	DEMOTEACHER = 'demoTeacher',
 	EXPERT = 'expert',
 	HELPDESK = 'helpdesk',
-	ROOM_VIEWER = 'room_viewer',
-	ROOM_EDITOR = 'room_editor',
+	ROOM_VIEWER = 'roomviewer',
+	ROOM_EDITOR = 'roomeditor',
 	STUDENT = 'student',
 	SUPERHERO = 'superhero',
 	TEACHER = 'teacher',

backup/setup/migrations.json

@@ -259,5 +259,32 @@
 		"created_at": {
 			"$date": "2024-10-30T17:03:31.473Z"
 		}
+	},
+	{
+		"_id": {
+			"$oid": "673237e9b0955dcff4cde3d9"
+		},
+		"name": "Migration20241111160412",
+		"created_at": {
+			"$date": "2024-11-11T16:59:21.768Z"
+		}
+	},
+	{
+		"_id": {
+			"$oid": "673237e9b0955dcff4cde3da"
+		},
+		"name": "Migration202411111604124",
+		"created_at": {
+			"$date": "2024-11-11T16:59:21.774Z"
+		}
+	},
+	{
+		"_id": {
+			"$oid": "673387c13aba1e283484119d"
+		},
+		"name": "Migration202411121635382",
+		"created_at": {
+			"$date": "2024-11-12T16:52:17.292Z"
+		}
 	}
 ]

backup/setup/roles.json

@@ -586,7 +586,7 @@
 		"_id": {
 			"$oid": "6720b8621b61c9dd7ebd193b"
 		},
-		"name": "room_viewer",
+		"name": "roomviewer",
 		"permissions": [
 			"ROOM_VIEW"
 		]
@@ -595,7 +595,7 @@
 		"_id": {
 			"$oid": "6720b8621b61c9dd7ebd193c"
 		},
-		"name": "room_editor",
+		"name": "roomeditor",
 		"permissions": [
 			"ROOM_VIEW",
 			"ROOM_EDIT"