rename room-member to room-membership

hpi-schul-cloud · Nov 27, 2024 · 8b9feea · 8b9feea
1 parent 6896568
commit 8b9feea
Show file tree

Hide file tree

Showing 61 changed files with 551 additions and 517 deletions.
diff --git a/apps/server/src/migrations/mikro-orm/Migration202411271951208.ts b/apps/server/src/migrations/mikro-orm/Migration202411271951208.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');
+	}
+}
diff --git a/apps/server/src/modules/board/board-api.module.ts b/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 '@modules/room-member';
+import { RoomMembershipModule } from '@src/modules/room-membership';
 import { BoardModule } from './board.module';
 import {
 	BoardController,
@@ -16,7 +16,7 @@ import { BoardUc, CardUc, ColumnUc, ElementUc, SubmissionItemUc } from './uc';
 import { RoomModule } from '../room';
 
 @Module({
-	imports: [BoardModule, LoggerModule, RoomMemberModule, RoomModule, forwardRef(() => AuthorizationModule)],
+	imports: [BoardModule, LoggerModule, RoomMembershipModule, RoomModule, forwardRef(() => AuthorizationModule)],
 	controllers: [BoardController, ColumnController, CardController, ElementController, BoardSubmissionController],
 	providers: [BoardUc, BoardNodePermissionService, ColumnUc, CardUc, ElementUc, SubmissionItemUc, CourseRepo],
 })

diff --git a/apps/server/src/modules/board/board-ws-api.module.ts b/apps/server/src/modules/board/board-ws-api.module.ts
@@ -3,7 +3,7 @@ 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';
@@ -12,7 +12,14 @@ import { BoardUc, CardUc, ColumnUc, ElementUc } from './uc';
 import { RoomModule } from '../room';
 
 @Module({
-	imports: [BoardModule, forwardRef(() => AuthorizationModule), LoggerModule, UserModule, RoomMemberModule, RoomModule],
+	imports: [
+		BoardModule,
+		forwardRef(() => AuthorizationModule),
+		LoggerModule,
+		UserModule,
+		RoomMembershipModule,
+		RoomModule,
+	],
 	providers: [
 		BoardCollaborationGateway,
 		BoardNodePermissionService,

diff --git a/apps/server/src/modules/board/board.module.ts b/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

diff --git a/apps/server/src/modules/board/controller/api-test/board-context-in-rooms.api.spec.ts b/apps/server/src/modules/board/controller/api-test/board-context-in-rooms.api.spec.ts
@@ -6,7 +6,7 @@ import { TestApiClient, cleanupCollections, groupEntityFactory, roleFactory, use
 import { Permission, RoleName } from '@shared/domain/interface';
 import { accountFactory } from '@src/modules/account/testing';
 import { GroupEntityTypes } from '@src/modules/group/entity';
-import { roomMemberEntityFactory } from '@src/modules/room-member/testing';
+import { roomMembershipEntityFactory } from '@src/modules/room-membership/testing';
 import { roomEntityFactory } from '@src/modules/room/testing';
 import { columnBoardEntityFactory } from '../../testing';
 import { BoardExternalReferenceType } from '../../domain';
@@ -66,7 +66,7 @@ describe('board get context in room (api)', () => {
 
 		const room = roomEntityFactory.buildWithId();
 
-		const roomMember = roomMemberEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+		const roomMember = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
 
 		await em.persistAndFlush([
 			accountWithEditRole,

diff --git a/apps/server/src/modules/board/controller/api-test/board-create-in-room.api.spec.ts b/apps/server/src/modules/board/controller/api-test/board-create-in-room.api.spec.ts
@@ -7,7 +7,7 @@ import { RoleName } from '@shared/domain/interface/rolename.enum';
 import { cleanupCollections, groupEntityFactory, roleFactory, TestApiClient, userFactory } from '@shared/testing';
 import { accountFactory } from '@src/modules/account/testing';
 import { GroupEntityTypes } from '@src/modules/group/entity';
-import { roomMemberEntityFactory } from '@src/modules/room-member/testing';
+import { roomMembershipEntityFactory } from '@src/modules/room-membership/testing';
 import { roomEntityFactory } from '@src/modules/room/testing';
 import { BoardExternalReferenceType, BoardLayout } from '../../domain';
 import { BoardNodeEntity } from '../../repo';
@@ -54,7 +54,7 @@ describe(`create board in room (api)`, () => {
 
 				const room = roomEntityFactory.buildWithId();
 
-				const roomMember = roomMemberEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+				const roomMember = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
 
 				await em.persistAndFlush([account, user, role, userGroup, room, roomMember]);
 				em.clear();
@@ -170,7 +170,7 @@ describe(`create board in room (api)`, () => {
 
 				const room = roomEntityFactory.buildWithId();
 
-				const roomMember = roomMemberEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+				const roomMember = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
 
 				await em.persistAndFlush([account, user, role, userGroup, room, roomMember]);
 				em.clear();
@@ -238,7 +238,7 @@ describe(`create board in room (api)`, () => {
 
 			const room = roomEntityFactory.buildWithId();
 
-			const roomMember = roomMemberEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+			const roomMember = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
 
 			await em.persistAndFlush([account, user, role, userGroup, room, roomMember]);
 			em.clear();

diff --git a/apps/server/src/modules/board/controller/api-test/board-delete-in-room.api.spec.ts b/apps/server/src/modules/board/controller/api-test/board-delete-in-room.api.spec.ts
@@ -7,7 +7,7 @@ import { accountFactory } from '@src/modules/account/testing';
 import { Permission, RoleName } from '@shared/domain/interface';
 import { GroupEntityTypes } from '@src/modules/group/entity';
 import { roomEntityFactory } from '@src/modules/room/testing';
-import { roomMemberEntityFactory } from '@src/modules/room-member/testing';
+import { roomMembershipEntityFactory } from '@src/modules/room-membership/testing';
 import { columnBoardEntityFactory, columnEntityFactory } from '../../testing';
 import { BoardNodeEntity } from '../../repo';
 import { BoardExternalReferenceType } from '../../domain';
@@ -61,7 +61,7 @@ describe(`board delete in room (api)`, () => {
 
 		const room = roomEntityFactory.buildWithId();
 
-		const roomMember = roomMemberEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+		const roomMember = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
 
 		await em.persistAndFlush([
 			accountWithEditRole,

diff --git a/apps/server/src/modules/board/controller/api-test/board-lookup-in-room.api.spec.ts b/apps/server/src/modules/board/controller/api-test/board-lookup-in-room.api.spec.ts
@@ -7,7 +7,7 @@ import { cleanupCollections, groupEntityFactory, roleFactory, TestApiClient, use
 import { Permission, RoleName } from '@shared/domain/interface';
 import { accountFactory } from '@src/modules/account/testing';
 import { GroupEntityTypes } from '@src/modules/group/entity';
-import { roomMemberEntityFactory } from '@src/modules/room-member/testing';
+import { roomMembershipEntityFactory } from '@src/modules/room-membership/testing';
 import { roomEntityFactory } from '@src/modules/room/testing';
 import { BoardExternalReferenceType, BoardLayout } from '../../domain';
 import { BoardResponse } from '../dto';
@@ -62,7 +62,7 @@ describe(`board lookup in room (api)`, () => {
 
 		const room = roomEntityFactory.buildWithId();
 
-		const roomMember = roomMemberEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+		const roomMember = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
 
 		await em.persistAndFlush([
 			accountWithEditRole,

diff --git a/apps/server/src/modules/board/controller/api-test/board-update-title-in-room.api.spec.ts b/apps/server/src/modules/board/controller/api-test/board-update-title-in-room.api.spec.ts
@@ -7,7 +7,7 @@ import { TestApiClient, cleanupCollections, groupEntityFactory, roleFactory, use
 import { Permission, RoleName } from '@shared/domain/interface';
 import { accountFactory } from '@src/modules/account/testing';
 import { GroupEntityTypes } from '@src/modules/group/entity';
-import { roomMemberEntityFactory } from '@src/modules/room-member/testing';
+import { roomMembershipEntityFactory } from '@src/modules/room-membership/testing';
 import { roomEntityFactory } from '@src/modules/room/testing';
 import { BoardNodeEntity } from '../../repo';
 import { columnBoardEntityFactory } from '../../testing';
@@ -68,7 +68,7 @@ describe(`board update title with room relation (api)`, () => {
 
 		const room = roomEntityFactory.buildWithId();
 
-		const roomMember = roomMemberEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+		const roomMember = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
 
 		await em.persistAndFlush([
 			accountWithEditRole,

diff --git a/apps/server/src/modules/board/controller/api-test/board-visibility-in-room.api.spec.ts b/apps/server/src/modules/board/controller/api-test/board-visibility-in-room.api.spec.ts
@@ -6,7 +6,7 @@ import { TestApiClient, cleanupCollections, groupEntityFactory, roleFactory, use
 import { Permission, RoleName } from '@shared/domain/interface';
 import { accountFactory } from '@src/modules/account/testing';
 import { GroupEntityTypes } from '@src/modules/group/entity';
-import { roomMemberEntityFactory } from '@src/modules/room-member/testing';
+import { roomMembershipEntityFactory } from '@src/modules/room-membership/testing';
 import { roomEntityFactory } from '@src/modules/room/testing';
 import { BoardExternalReferenceType } from '../../domain';
 import { columnBoardEntityFactory } from '../../testing';
@@ -67,7 +67,7 @@ describe(`board update visibility with room relation (api)`, () => {
 
 		const room = roomEntityFactory.buildWithId();
 
-		const roomMember = roomMemberEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
+		const roomMember = roomMembershipEntityFactory.build({ roomId: room.id, userGroupId: userGroup.id });
 
 		await em.persistAndFlush([
 			accountWithEditRole,

diff --git a/apps/server/src/modules/board/service/internal/board-context.service.spec.ts b/apps/server/src/modules/board/service/internal/board-context.service.spec.ts
@@ -5,26 +5,26 @@ import { Permission, RoleName } from '@shared/domain/interface';
 import { CourseRepo } from '@shared/repo/course';
 import { courseFactory, groupFactory, roleFactory, setupEntities, userFactory } from '@shared/testing';
 import { GroupTypes } from '@src/modules/group';
-import { RoomMemberService } from '@src/modules/room-member';
-import { roomMemberFactory } from '@src/modules/room-member/testing';
+import { RoomMembershipService } from '@src/modules/room-membership';
+import { roomMembershipFactory } from '@src/modules/room-membership/testing';
 import { roomFactory } from '@src/modules/room/testing';
 import { BoardExternalReferenceType, BoardRoles, UserWithBoardRoles } from '../../domain';
 import { columnBoardFactory, columnFactory } from '../../testing';
 import { BoardContextService } from './board-context.service';
 
-describe(`${BoardContextService.name}`, () => {
+describe(BoardContextService.name, () => {
 	let module: TestingModule;
 	let service: BoardContextService;
 	let courseRepo: DeepMocked<CourseRepo>;
-	let roomMemberService: DeepMocked<RoomMemberService>;
+	let roomMembershipService: DeepMocked<RoomMembershipService>;
 
 	beforeAll(async () => {
 		module = await Test.createTestingModule({
 			providers: [
 				BoardContextService,
 				{
-					provide: RoomMemberService,
-					useValue: createMock<RoomMemberService>(),
+					provide: RoomMembershipService,
+					useValue: createMock<RoomMembershipService>(),
 				},
 				{
 					provide: CourseRepo,
@@ -34,7 +34,7 @@ describe(`${BoardContextService.name}`, () => {
 		}).compile();
 
 		service = module.get(BoardContextService);
-		roomMemberService = module.get(RoomMemberService);
+		roomMembershipService = module.get(RoomMembershipService);
 		courseRepo = module.get(CourseRepo);
 
 		await setupEntities();
@@ -221,7 +221,7 @@ describe(`${BoardContextService.name}`, () => {
 					const role = roleFactory.build({ name: RoleName.ROOMEDITOR, permissions: [Permission.ROOM_EDIT] });
 					const group = groupFactory.build({ type: GroupTypes.ROOM, users: [{ userId: user.id, roleId: role.id }] });
 					const room = roomFactory.build();
-					roomMemberFactory.build({ roomId: room.id, userGroupId: group.id });
+					roomMembershipFactory.build({ roomId: room.id, userGroupId: group.id });
 					const columnBoard = columnBoardFactory.build({
 						context: { id: room.id, type: BoardExternalReferenceType.Room },
 					});
@@ -232,7 +232,7 @@ describe(`${BoardContextService.name}`, () => {
 				it('should return their information + editor role', async () => {
 					const { columnBoard, role, user } = setup();
 
-					roomMemberService.getRoomMemberAuthorizable.mockResolvedValue({
+					roomMembershipService.getRoomMembershipAuthorizable.mockResolvedValue({
 						id: 'foo',
 						roomId: columnBoard.context.id,
 						members: [{ userId: user.id, roles: [role] }],
@@ -256,7 +256,7 @@ describe(`${BoardContextService.name}`, () => {
 					const role = roleFactory.build({ name: RoleName.ROOMVIEWER, permissions: [Permission.ROOM_VIEW] });
 					const group = groupFactory.build({ type: GroupTypes.ROOM, users: [{ userId: user.id, roleId: role.id }] });
 					const room = roomFactory.build();
-					roomMemberFactory.build({ roomId: room.id, userGroupId: group.id });
+					roomMembershipFactory.build({ roomId: room.id, userGroupId: group.id });
 					const columnBoard = columnBoardFactory.build({
 						context: { id: room.id, type: BoardExternalReferenceType.Room },
 					});
@@ -267,7 +267,7 @@ describe(`${BoardContextService.name}`, () => {
 				it('should return their information + reader role', async () => {
 					const { columnBoard, role, user } = setup();
 
-					roomMemberService.getRoomMemberAuthorizable.mockResolvedValue({
+					roomMembershipService.getRoomMembershipAuthorizable.mockResolvedValue({
 						id: 'foo',
 						roomId: columnBoard.context.id,
 						members: [{ userId: user.id, roles: [role] }],
@@ -291,7 +291,7 @@ describe(`${BoardContextService.name}`, () => {
 					const role = roleFactory.build();
 					const group = groupFactory.build({ type: GroupTypes.ROOM, users: [{ userId: user.id, roleId: role.id }] });
 					const room = roomFactory.build();
-					roomMemberFactory.build({ roomId: room.id, userGroupId: group.id });
+					roomMembershipFactory.build({ roomId: room.id, userGroupId: group.id });
 					const columnBoard = columnBoardFactory.build({
 						context: { id: room.id, type: BoardExternalReferenceType.Room },
 					});
@@ -302,7 +302,7 @@ describe(`${BoardContextService.name}`, () => {
 				it('should return their information + no role', async () => {
 					const { columnBoard, role, user } = setup();
 
-					roomMemberService.getRoomMemberAuthorizable.mockResolvedValue({
+					roomMembershipService.getRoomMembershipAuthorizable.mockResolvedValue({
 						id: 'foo',
 						roomId: columnBoard.context.id,
 						members: [{ userId: user.id, roles: [role] }],

diff --git a/apps/server/src/modules/board/service/internal/board-context.service.ts b/apps/server/src/modules/board/service/internal/board-context.service.ts
@@ -2,13 +2,12 @@ import { Injectable } from '@nestjs/common';
 import { Permission } from '@shared/domain/interface';
 import { EntityId } from '@shared/domain/types';
 import { CourseRepo } from '@shared/repo/course';
-import { RoomMemberService } from '@src/modules/room-member';
-import { UserWithRoomRoles } from '@src/modules/room-member/do/room-member-authorizable.do';
+import { RoomMembershipService, UserWithRoomRoles } from '@src/modules/room-membership';
 import { AnyBoardNode, BoardExternalReferenceType, BoardRoles, UserWithBoardRoles } from '../../domain';
 
 @Injectable()
 export class BoardContextService {
-	constructor(private readonly courseRepo: CourseRepo, private readonly roomMemberService: RoomMemberService) {}
+	constructor(private readonly courseRepo: CourseRepo, private readonly roomMembershipService: RoomMembershipService) {}
 
 	async getUsersWithBoardRoles(rootNode: AnyBoardNode): Promise<UserWithBoardRoles[]> {
 		if (!('context' in rootNode)) {
@@ -31,8 +30,8 @@ export class BoardContextService {
 	}
 
 	private async getFromRoom(roomId: EntityId): Promise<UserWithBoardRoles[]> {
-		const roomMemberAuthorizable = await this.roomMemberService.getRoomMemberAuthorizable(roomId);
-		const usersWithRoles: UserWithBoardRoles[] = roomMemberAuthorizable.members.map((member) => {
+		const roomMembershipAuthorizable = await this.roomMembershipService.getRoomMembershipAuthorizable(roomId);
+		const usersWithRoles: UserWithBoardRoles[] = roomMembershipAuthorizable.members.map((member) => {
 			const roles = this.getBoardRolesFromRoomMember(member);
 			return {
 				userId: member.userId,

diff --git a/apps/server/src/modules/board/uc/board.uc.spec.ts b/apps/server/src/modules/board/uc/board.uc.spec.ts
@@ -8,7 +8,7 @@ import { setupEntities, userFactory } from '@shared/testing';
 import { courseFactory } from '@shared/testing/factory';
 import { LegacyLogger } from '@src/core/logger';
 import { RoomService } from '@src/modules/room';
-import { RoomMemberService } from '@src/modules/room-member';
+import { RoomMembershipService } from '@src/modules/room-membership';
 import { CopyElementType, CopyStatus, CopyStatusEnum } from '../../copy-helper';
 import { BoardExternalReferenceType, BoardLayout, BoardNodeFactory, Column, ColumnBoard } from '../domain';
 import { BoardNodePermissionService, BoardNodeService, ColumnBoardService } from '../service';
@@ -58,8 +58,8 @@ describe(BoardUc.name, () => {
 					useValue: createMock<BoardNodeFactory>(),
 				},
 				{
-					provide: RoomMemberService,
-					useValue: createMock<RoomMemberService>(),
+					provide: RoomMembershipService,
+					useValue: createMock<RoomMembershipService>(),
 				},
 				{
 					provide: LegacyLogger,

diff --git a/apps/server/src/modules/board/uc/board.uc.ts b/apps/server/src/modules/board/uc/board.uc.ts
@@ -7,7 +7,7 @@ import { CourseRepo } from '@shared/repo/course';
 import { LegacyLogger } from '@src/core/logger';
 import { StorageLocation } from '@src/modules/files-storage/interface';
 import { RoomService } from '@src/modules/room';
-import { RoomMemberService } from '@src/modules/room-member';
+import { RoomMembershipService } from '@src/modules/room-membership';
 import { CreateBoardBodyParams } from '../controller/dto';
 import { BoardExternalReference, BoardExternalReferenceType, BoardNodeFactory, Column, ColumnBoard } from '../domain';
 import { BoardNodePermissionService, BoardNodeService, ColumnBoardService } from '../service';
@@ -19,7 +19,7 @@ export class BoardUc {
 		@Inject(forwardRef(() => AuthorizationService)) // TODO is this needed?
 		private readonly authorizationService: AuthorizationService,
 		private readonly boardPermissionService: BoardNodePermissionService,
-		private readonly roomMemberService: RoomMemberService,
+		private readonly roomMembershipService: RoomMembershipService,
 		private readonly boardNodeService: BoardNodeService,
 		private readonly columnBoardService: ColumnBoardService,
 		private readonly logger: LegacyLogger,
@@ -158,9 +158,9 @@ export class BoardUc {
 				requiredPermissions: [Permission.COURSE_EDIT],
 			});
 		} else if (context.type === BoardExternalReferenceType.Room) {
-			const roomMemberAuthorizable = await this.roomMemberService.getRoomMemberAuthorizable(context.id);
+			const roomMembershipAuthorizable = await this.roomMembershipService.getRoomMembershipAuthorizable(context.id);
 
-			this.authorizationService.checkPermission(user, roomMemberAuthorizable, {
+			this.authorizationService.checkPermission(user, roomMembershipAuthorizable, {
 				action: Action.write,
 				requiredPermissions: [],
 			});

diff --git a/apps/server/src/modules/room-member/index.ts b/apps/server/src/modules/room-member/index.ts
diff --git a/apps/server/src/modules/room-member/repo/entity/index.ts b/apps/server/src/modules/room-member/repo/entity/index.ts