BC-8348 - Implement Sharing and Copying of Room Boards

apps/server/src/modules/board/controller/api-test/board-copy-in-room.api.spec.ts

@@ -0,0 +1,78 @@
+import { EntityManager } from '@mikro-orm/mongodb';
+import { INestApplication } from '@nestjs/common';
+import { Test, TestingModule } from '@nestjs/testing';
+import { Permission, RoleName } from '@shared/domain/interface';
+import {
+	cleanupCollections,
+	groupEntityFactory,
+	roleFactory,
+	TestApiClient,
+	UserAndAccountTestFactory,
+} from '@shared/testing';
+import { GroupEntityTypes } from '@src/modules/group/entity';
+import { roomMembershipEntityFactory } from '@src/modules/room-membership/testing';
+import { roomEntityFactory } from '@src/modules/room/testing';
+import { ServerTestModule } from '@src/modules/server';
+import { BoardExternalReferenceType, ColumnBoardProps } from '../../domain';
+import { columnBoardEntityFactory } from '../../testing';
+
+const baseRouteName = '/boards';
+
+describe(`board copy with room relation (api)`, () => {
+	let app: INestApplication;
+	let em: EntityManager;
+	let testApiClient: TestApiClient;
+
+	beforeAll(async () => {
+		const module: TestingModule = await Test.createTestingModule({
+			imports: [ServerTestModule],
+		}).compile();
+
+		app = module.createNestApplication();
+		await app.init();
+		em = module.get(EntityManager);
+		testApiClient = new TestApiClient(app, baseRouteName);
+	});
+
+	afterAll(async () => {
+		await app.close();
+	});
+
+	beforeEach(async () => {
+		await cleanupCollections(em);
+	});
+
+	describe('with valid user', () => {
+		const setup = async (columnBoardProps: Partial<ColumnBoardProps> = {}) => {
+			const room = roomEntityFactory.buildWithId();
+			const role = roleFactory.buildWithId({
+				name: RoleName.ROOMEDITOR,
+				permissions: [Permission.ROOM_EDIT],
+			});
+			const { teacherAccount, teacherUser } = UserAndAccountTestFactory.buildTeacher();
+			const userGroup = groupEntityFactory.buildWithId({
+				type: GroupEntityTypes.ROOM,
+				users: [{ role, user: teacherUser }],
+			});
+			const roomMembership = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+			const columnBoardNode = columnBoardEntityFactory.build({
+				...columnBoardProps,
+				context: { id: room.id, type: BoardExternalReferenceType.Room },
+			});
+			await em.persistAndFlush([room, roomMembership, teacherAccount, teacherUser, userGroup, role, columnBoardNode]);
+			em.clear();
+
+			const loggedInClient = await testApiClient.login(teacherAccount);
+
+			return { loggedInClient, columnBoardNode };
+		};
+
+		it('should return status 201', async () => {
+			const { loggedInClient, columnBoardNode } = await setup();
+
+			const response = await loggedInClient.post(`${columnBoardNode.id}/copy`);
+
+			expect(response.status).toEqual(201);
+		});
+	});
+});

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

@@ -181,7 +181,7 @@ export class BoardUc {
 
 			return { id: room.schoolId, type: StorageLocation.SCHOOL };
 		}
-
-		throw new Error(`Cannot get storage location reference for context type ${context.type as string}`);
+		/* istanbul ignore next */
+		throw new Error(`Unsupported board reference type ${context.type as string}`);
 	}
 }

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

@@ -1,5 +1,5 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { SanitizeHtml } from '@shared/controller';
+import { NullToUndefined, SanitizeHtml } from '@shared/controller';
 import { RoomCreateProps } from '@modules/room/domain';
 import { RoomColor } from '@modules/room/domain/type';
 import { IsDate, IsEnum, IsOptional, IsString, MaxLength, MinLength } from 'class-validator';
@@ -23,17 +23,19 @@ export class CreateRoomBodyParams implements Omit<RoomCreateProps, 'schoolId'> {
 	@IsEnum(RoomColor)
 	color!: RoomColor;
 
-	@IsDate()
 	@IsOptional()
+	@NullToUndefined()
+	@IsDate()
 	@ApiPropertyOptional({
 		description: 'Start date of the room',
 		required: false,
 		type: Date,
 	})
 	startDate?: Date;
 
-	@IsDate()
 	@IsOptional()
+	@NullToUndefined()
+	@IsDate()
 	@ApiPropertyOptional({
 		description: 'End date of the room',
 		required: false,

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

@@ -1,7 +1,7 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { SanitizeHtml } from '@shared/controller';
 import { RoomUpdateProps } from '@modules/room/domain';
 import { RoomColor } from '@modules/room/domain/type';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { NullToUndefined, SanitizeHtml } from '@shared/controller';
 import { IsDate, IsEnum, IsOptional, IsString, MaxLength, MinLength } from 'class-validator';
 
 export class UpdateRoomBodyParams implements RoomUpdateProps {
@@ -25,6 +25,7 @@ export class UpdateRoomBodyParams implements RoomUpdateProps {
 
 	@IsDate()
 	@IsOptional()
+	@NullToUndefined()
 	@ApiPropertyOptional({
 		description: 'Start date of the room',
 		required: false,
@@ -34,6 +35,7 @@ export class UpdateRoomBodyParams implements RoomUpdateProps {
 
 	@IsDate()
 	@IsOptional()
+	@NullToUndefined()
 	@ApiPropertyOptional({
 		description: 'Start date of the room',
 		required: false,

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

@@ -11,6 +11,7 @@ import {
 	Param,
 	Patch,
 	Post,
+	Put,
 	Query,
 	UnauthorizedException,
 } from '@nestjs/common';
@@ -115,8 +116,8 @@ export class RoomController {
 		return response;
 	}
 
-	@Patch(':roomId')
-	@ApiOperation({ summary: 'Create a new room' })
+	@Put(':roomId')
+	@ApiOperation({ summary: 'Update an existing room' })
 	@ApiResponse({ status: HttpStatus.OK, description: 'Returns the details of a room', type: RoomDetailsResponse })
 	@ApiResponse({ status: HttpStatus.BAD_REQUEST, type: ApiValidationError })
 	@ApiResponse({ status: HttpStatus.UNAUTHORIZED, type: UnauthorizedException })

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

@@ -42,11 +42,11 @@ describe('Room Controller (API)', () => {
 		await app.close();
 	});
 
-	describe('PATCH /rooms/:id', () => {
+	describe('PUT /rooms/:id', () => {
 		describe('when the user is not authenticated', () => {
 			it('should return a 401 error', async () => {
 				const someId = new ObjectId().toHexString();
-				const response = await testApiClient.patch(someId);
+				const response = await testApiClient.put(someId);
 				expect(response.status).toBe(HttpStatus.UNAUTHORIZED);
 			});
 		});
@@ -68,7 +68,7 @@ describe('Room Controller (API)', () => {
 				const { loggedInClient } = await setup();
 				const someId = new ObjectId().toHexString();
 				const params = { name: 'Room #101', color: 'green' };
-				const response = await loggedInClient.patch(someId, params);
+				const response = await loggedInClient.put(someId, params);
 				expect(response.status).toBe(HttpStatus.FORBIDDEN);
 			});
 		});
@@ -87,7 +87,7 @@ describe('Room Controller (API)', () => {
 			it('should return a 400 error', async () => {
 				const { loggedInClient } = await setup();
 				const params = { name: 'Room #101', color: 'green' };
-				const response = await loggedInClient.patch('42', params);
+				const response = await loggedInClient.put('42', params);
 				expect(response.status).toBe(HttpStatus.BAD_REQUEST);
 			});
 		});
@@ -121,7 +121,7 @@ describe('Room Controller (API)', () => {
 					const someId = new ObjectId().toHexString();
 					const params = { name: 'Room #101', color: 'green' };
 
-					const response = await loggedInClient.patch(someId, params);
+					const response = await loggedInClient.put(someId, params);
 
 					expect(response.status).toBe(HttpStatus.NOT_FOUND);
 				});
@@ -132,7 +132,7 @@ describe('Room Controller (API)', () => {
 					const { loggedInClient, room } = await setup();
 					const params = { name: 'Room #101', color: 'green' };
 
-					const response = await loggedInClient.patch(room.id, params);
+					const response = await loggedInClient.put(room.id, params);
 
 					expect(response.status).toBe(HttpStatus.OK);
 					await expect(em.findOneOrFail(RoomEntity, room.id)).resolves.toMatchObject({
@@ -147,7 +147,7 @@ describe('Room Controller (API)', () => {
 						const { loggedInClient, room } = await setup();
 						const params = { name: '', color: 'red' };
 
-						const response = await loggedInClient.patch(room.id, params);
+						const response = await loggedInClient.put(room.id, params);
 
 						expect(response.status).toBe(HttpStatus.BAD_REQUEST);
 					});
@@ -158,7 +158,7 @@ describe('Room Controller (API)', () => {
 						const { loggedInClient, room } = await setup();
 						const params = { name: 'Room #101', color: '' };
 
-						const response = await loggedInClient.patch(room.id, params);
+						const response = await loggedInClient.put(room.id, params);
 
 						expect(response.status).toBe(HttpStatus.BAD_REQUEST);
 					});
@@ -169,7 +169,7 @@ describe('Room Controller (API)', () => {
 						const { loggedInClient, room } = await setup();
 						const params = { name: 'Room #101', color: 'fancy-color' };
 
-						const response = await loggedInClient.patch(room.id, params);
+						const response = await loggedInClient.put(room.id, params);
 
 						expect(response.status).toBe(HttpStatus.BAD_REQUEST);
 					});
@@ -181,7 +181,7 @@ describe('Room Controller (API)', () => {
 					const { loggedInClient, room } = await setup();
 
 					const params = { name: 'Room #101', color: 'green', startDate: '2024-10-02' };
-					const response = await loggedInClient.patch(room.id, params);
+					const response = await loggedInClient.put(room.id, params);
 
 					expect(response.status).toBe(HttpStatus.OK);
 					await expect(em.findOneOrFail(RoomEntity, room.id)).resolves.toMatchObject({
@@ -194,7 +194,7 @@ describe('Room Controller (API)', () => {
 					it('should return a 400 error', async () => {
 						const { loggedInClient, room } = await setup();
 						const params = { name: 'Room #101', color: 'green', startDate: 'invalid date' };
-						const response = await loggedInClient.patch(room.id, params);
+						const response = await loggedInClient.put(room.id, params);
 						expect(response.status).toBe(HttpStatus.BAD_REQUEST);
 					});
 				});
@@ -204,23 +204,35 @@ describe('Room Controller (API)', () => {
 						const { loggedInClient, room } = await setup();
 						const params = { name: 'Room #101', color: 'green', startDate: null };
 
-						const response = await loggedInClient.patch(room.id, params);
+						const response = await loggedInClient.put(room.id, params);
 
 						expect(response.status).toBe(HttpStatus.OK);
-						await expect(em.findOneOrFail(RoomEntity, room.id)).resolves.toMatchObject({
-							id: room.id,
-							startDate: null,
-						});
+						const resultRoom = await em.findOneOrFail(RoomEntity, room.id);
+						expect(resultRoom.startDate).toBe(undefined);
 					});
 				});
 			});
 
+			describe('when the startDate is omitted', () => {
+				it('should unset the property', async () => {
+					const { loggedInClient, room } = await setup();
+					const params = { name: 'Room #101', color: 'green' };
+
+					const response = await loggedInClient.put(room.id, params);
+
+					expect(response.status).toBe(HttpStatus.OK);
+
+					const resultRoom = await em.findOneOrFail(RoomEntity, room.id);
+					expect(resultRoom.endDate).toBe(undefined);
+				});
+			});
+
 			describe('when an end date is given', () => {
 				it('should update the room', async () => {
 					const { loggedInClient, room } = await setup();
 					const params = { name: 'Room #101', color: 'green', endDate: '2024-10-18' };
 
-					const response = await loggedInClient.patch(room.id, params);
+					const response = await loggedInClient.put(room.id, params);
 
 					expect(response.status).toBe(HttpStatus.OK);
 					await expect(em.findOneOrFail(RoomEntity, room.id)).resolves.toMatchObject({
@@ -233,27 +245,40 @@ describe('Room Controller (API)', () => {
 					it('should return a 400 error', async () => {
 						const { loggedInClient, room } = await setup();
 						const params = { name: 'Room #101', color: 'green', endDate: 'invalid date' };
-						const response = await loggedInClient.patch(room.id, params);
+						const response = await loggedInClient.put(room.id, params);
 						expect(response.status).toBe(HttpStatus.BAD_REQUEST);
 					});
 				});
 
 				describe('when the date is null', () => {
 					it('should unset the property', async () => {
 						const { loggedInClient, room } = await setup();
-						const params = { name: 'Room #101', color: 'green', endDate: null };
+						const params = { name: 'Room #101', color: 'green', startDate: '2024-10-02', endDate: null };
 
-						const response = await loggedInClient.patch(room.id, params);
+						const response = await loggedInClient.put(room.id, params);
 
 						expect(response.status).toBe(HttpStatus.OK);
-						await expect(em.findOneOrFail(RoomEntity, room.id)).resolves.toMatchObject({
-							id: room.id,
-							endDate: null,
-						});
+
+						const resultRoom = await em.findOneOrFail(RoomEntity, room.id);
+						expect(resultRoom.endDate).toBe(undefined);
 					});
 				});
 			});
 
+			describe('when the endDate is omitted', () => {
+				it('should unset the property', async () => {
+					const { loggedInClient, room } = await setup();
+					const params = { name: 'Room #101', color: 'green', startDate: '2024-10-02' };
+
+					const response = await loggedInClient.put(room.id, params);
+
+					expect(response.status).toBe(HttpStatus.OK);
+
+					const resultRoom = await em.findOneOrFail(RoomEntity, room.id);
+					expect(resultRoom.endDate).toBe(undefined);
+				});
+			});
+
 			describe('when the start date is before the end date', () => {
 				it('should update the room', async () => {
 					const { loggedInClient, room } = await setup();
@@ -264,7 +289,7 @@ describe('Room Controller (API)', () => {
 						endDate: '2024-10-18',
 					};
 
-					const response = await loggedInClient.patch(room.id, params);
+					const response = await loggedInClient.put(room.id, params);
 
 					expect(response.status).toBe(HttpStatus.OK);
 					await expect(em.findOneOrFail(RoomEntity, room.id)).resolves.toMatchObject({
@@ -285,7 +310,7 @@ describe('Room Controller (API)', () => {
 						endDate: '2024-10-05',
 					};
 
-					const response = await loggedInClient.patch(room.id, params);
+					const response = await loggedInClient.put(room.id, params);
 
 					expect(response.status).toBe(HttpStatus.BAD_REQUEST);
 				});
@@ -313,7 +338,7 @@ describe('Room Controller (API)', () => {
 					const someId = new ObjectId().toHexString();
 					const params = { name: 'Room #101', color: 'green' };
 
-					const response = await loggedInClient.patch(someId, params);
+					const response = await loggedInClient.put(someId, params);
 
 					expect(response.status).toBe(HttpStatus.NOT_FOUND);
 				});
@@ -324,7 +349,7 @@ describe('Room Controller (API)', () => {
 					const { loggedInClient, room } = await setup();
 					const params = { name: 'Room #101', color: 'green' };
 
-					const response = await loggedInClient.patch(room.id, params);
+					const response = await loggedInClient.put(room.id, params);
 
 					expect(response.status).toBe(HttpStatus.FORBIDDEN);
 				});