BC-5836 - Add news to KNLDeletion Module

apps/server/src/modules/deletion/deletion-api.module.ts

@@ -19,6 +19,7 @@ import { FilesStorageClientModule } from '@modules/files-storage-client';
 import { DeletionRequestsController } from './controller/deletion-requests.controller';
 import { DeletionExecutionsController } from './controller/deletion-executions.controller';
 import { DeletionRequestUc } from './uc';
+import { NewsModule } from '../news';
 
 @Module({
 	imports: [
@@ -37,6 +38,7 @@ import { DeletionRequestUc } from './uc';
 		RegistrationPinModule,
 		FilesStorageClientModule,
 		TaskModule,
+		NewsModule,
 		RocketChatModule.forRoot({
 			uri: Configuration.get('ROCKET_CHAT_URI') as string,
 			adminId: Configuration.get('ROCKET_CHAT_ADMIN_ID') as string,

apps/server/src/modules/deletion/uc/deletion-request.uc.spec.ts

@@ -18,6 +18,7 @@ import { FilesStorageClientAdapterService } from '@src/modules/files-storage-cli
 import { DomainModel } from '@shared/domain/types';
 import { TaskService } from '@modules/task';
 import { DomainOperationBuilder } from '@shared/domain/builder';
+import { NewsUc } from '@src/modules/news/uc';
 import { DeletionStatusModel } from '../domain/types';
 import { DeletionLogService } from '../services/deletion-log.service';
 import { DeletionRequestService } from '../services';
@@ -124,6 +125,7 @@ describe(DeletionRequestUc.name, () => {
 					provide: TaskService,
 					useValue: createMock<TaskService>(),
 				},
+				{ provide: NewsUc, useValue: createMock<NewsUc>() },
 			],
 		}).compile();
 
@@ -462,7 +464,7 @@ describe(DeletionRequestUc.name, () => {
 
 				await uc.executeDeletionRequests();
 
-				expect(deletionLogService.createDeletionLog).toHaveBeenCalledTimes(12);
+				expect(deletionLogService.createDeletionLog).toHaveBeenCalledTimes(13);
 			});
 		});
 

apps/server/src/modules/deletion/uc/deletion-request.uc.ts

@@ -16,6 +16,7 @@ import { FilesStorageClientAdapterService } from '@modules/files-storage-client'
 import { TaskService } from '@modules/task';
 import { DomainOperation } from '@shared/domain/interface';
 import { DomainOperationBuilder } from '@shared/domain/builder/domain-operation.builder';
+import { NewsUc } from '@src/modules/news/uc';
 import { DeletionRequestLogResponseBuilder, DeletionTargetRefBuilder } from '../builder';
 import { DeletionRequestBodyProps, DeletionRequestLogResponse, DeletionRequestResponse } from '../controller/dto';
 import { DeletionRequest, DeletionLog } from '../domain';
@@ -42,7 +43,8 @@ export class DeletionRequestUc {
 		private readonly registrationPinService: RegistrationPinService,
 		private readonly filesStorageClientAdapterService: FilesStorageClientAdapterService,
 		private readonly dashboardService: DashboardService,
-		private readonly taskService: TaskService
+		private readonly taskService: TaskService,
+		private readonly newsUc: NewsUc
 	) {
 		this.logger.setContext(DeletionRequestUc.name);
 	}
@@ -112,6 +114,7 @@ export class DeletionRequestUc {
 				this.removeUserFromRocketChat(deletionRequest),
 				this.removeUsersDashboard(deletionRequest),
 				this.removeUserFromTasks(deletionRequest),
+				this.removeUsersDataFromNews(deletionRequest),
 			]);
 			await this.deletionRequestService.markDeletionRequestAsExecuted(deletionRequest.id);
 		} catch (error) {
@@ -305,4 +308,10 @@ export class DeletionRequestUc {
 			tasksDeleted.deletedCount
 		);
 	}
+
+	private async removeUsersDataFromNews(deletionRequest: DeletionRequest) {
+		const newsesModified = await this.newsUc.deleteCreatorOrUpdaterReference(deletionRequest.targetRefId);
+
+		await this.logDeletion(deletionRequest, DomainModel.NEWS, DeletionOperationModel.UPDATE, newsesModified, 0);
+	}
 }

apps/server/src/modules/news/controller/dto/news.response.ts

@@ -103,7 +103,7 @@ export class NewsResponse {
 	@ApiProperty({
 		description: 'Reference to the User that created the News entity',
 	})
-	creator: UserInfoResponse;
+	creator: UserInfoResponse | undefined;
 
 	@ApiPropertyOptional({
 		description: 'Reference to the User that updated the News entity',

apps/server/src/modules/news/mapper/news.mapper.ts

@@ -1,7 +1,13 @@
 import { News } from '@shared/domain/entity';
 import { CreateNews, INewsScope, IUpdateNews, NewsTargetModel } from '@shared/domain/types';
 import { LogMessageData } from '@src/core/logger';
-import { CreateNewsParams, FilterNewsParams, NewsResponse, UpdateNewsParams } from '../controller/dto';
+import {
+	CreateNewsParams,
+	FilterNewsParams,
+	NewsResponse,
+	UpdateNewsParams,
+	UserInfoResponse,
+} from '../controller/dto';
 import { SchoolInfoMapper } from './school-info.mapper';
 import { TargetInfoMapper } from './target-info.mapper';
 import { UserInfoMapper } from './user-info.mapper';
@@ -10,7 +16,10 @@ export class NewsMapper {
 	static mapToResponse(news: News): NewsResponse {
 		const target = TargetInfoMapper.mapToResponse(news.target);
 		const school = SchoolInfoMapper.mapToResponse(news.school);
-		const creator = UserInfoMapper.mapToResponse(news.creator);
+		let creator: UserInfoResponse | undefined;
+		if (news.creator !== undefined) {
+			creator = UserInfoMapper.mapToResponse(news.creator);
+		}
 
 		const dto = new NewsResponse({
 			id: news.id,

apps/server/src/modules/news/uc/news.uc.spec.ts

@@ -8,6 +8,8 @@ import { Permission } from '@shared/domain/interface';
 import { CreateNews, NewsTargetModel } from '@shared/domain/types';
 import { NewsRepo } from '@shared/repo';
 import { Logger } from '@src/core/logger';
+import { FederalStateEntity, Role, SchoolEntity, TeamNews, User } from '@shared/domain/entity';
+import { Collection } from '@mikro-orm/core';
 import { NewsUc } from './news.uc';
 
 describe('NewsUc', () => {
@@ -40,6 +42,40 @@ describe('NewsUc', () => {
 			id: courseTargetId,
 		},
 	};
+	const federalState = new FederalStateEntity({
+		name: 'string',
+		abbreviation: 'string',
+		logoUrl: 'string',
+		createdAt: new Date(),
+		updatedAt: new Date(),
+	});
+
+	const school = new SchoolEntity({
+		_id: schoolId,
+
+		name: 'string',
+		federalState,
+	});
+	const creator: User = {
+		_id: new ObjectId(userId),
+		id: userId,
+		email: 'string',
+		firstName: 'string',
+		lastName: 'string',
+		roles: new Collection<Role>(User),
+		school,
+		createdAt: new Date(),
+		updatedAt: new Date(),
+		resolvePermissions: () => ['a'],
+	};
+	const exampleNews: TeamNews = new TeamNews({
+		title: 'string',
+		content: 'string',
+		displayAt,
+		creator,
+		school: schoolId,
+		target: teamTargetId,
+	});
 	const pagination = {};
 
 	const targets = [
@@ -75,6 +111,12 @@ describe('NewsUc', () => {
 							}
 							throw new NotFoundException();
 						},
+						findByCreatorOrUpdaterId(creatorId) {
+							if (creatorId === creator.id) {
+								return [[exampleNews], 1];
+							}
+							return [[undefined], 0];
+						},
 						delete() {},
 					},
 				},
@@ -301,4 +343,18 @@ describe('NewsUc', () => {
 			await expect(service.delete(newsId, anotherUser)).rejects.toThrow(UnauthorizedException);
 		});
 	});
+
+	describe('deleteCreatorReference', () => {
+		it('should successfully delete creator reference from news', async () => {
+			const result = await service.deleteCreatorOrUpdaterReference(creator.id);
+			expect(exampleNews.creator).toBeUndefined();
+			expect(result).toBe(1);
+		});
+
+		it('should return 0 if news not found', async () => {
+			const anotherUser = new ObjectId().toHexString();
+			const result = await service.deleteCreatorOrUpdaterReference(anotherUser);
+			expect(result).toBe(0);
+		});
+	});
 });

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

@@ -2,10 +2,20 @@ import { FeathersAuthorizationService } from '@modules/authorization';
 import { Injectable } from '@nestjs/common';
 import { News } from '@shared/domain/entity';
 import { IFindOptions, Permission, SortOrder } from '@shared/domain/interface';
-import { Counted, CreateNews, EntityId, INewsScope, IUpdateNews, NewsTargetModel } from '@shared/domain/types';
+import {
+	Counted,
+	CreateNews,
+	DomainModel,
+	EntityId,
+	INewsScope,
+	IUpdateNews,
+	NewsTargetModel,
+	StatusModel,
+} from '@shared/domain/types';
 import { NewsRepo, NewsTargetFilter } from '@shared/repo';
 import { CrudOperation } from '@shared/types';
 import { Logger } from '@src/core/logger';
+import { DataDeletionDomainOperationLoggable } from '@shared/common/loggable';
 import { NewsCrudOperationLoggable } from '../loggable/news-crud-operation.loggable';
 
 type NewsPermission = Permission.NEWS_VIEW | Permission.NEWS_EDIT;
@@ -147,6 +157,43 @@ export class NewsUc {
 		return id;
 	}
 
+	public async deleteCreatorOrUpdaterReference(userId: EntityId): Promise<number> {
+		this.logger.info(
+			new DataDeletionDomainOperationLoggable(
+				'Deleting user data from News',
+				DomainModel.NEWS,
+				userId,
+				StatusModel.PENDING
+			)
+		);
+
+		const news = await this.newsRepo.findByCreatorOrUpdaterId(userId);
+
+		const newsCount = news[1];
+		if (newsCount === 0) {
+			return 0;
+		}
+
+		news[0].forEach((newsEntity) => {
+			newsEntity.removeCreatorReference(userId);
+			newsEntity.removeUpdaterReference(userId);
+		});
+
+		await this.newsRepo.save(news[0]);
+
+		this.logger.info(
+			new DataDeletionDomainOperationLoggable(
+				'Successfully removed user data from News',
+				DomainModel.NEWS,
+				userId,
+				StatusModel.FINISHED,
+				newsCount,
+				0
+			)
+		);
+		return newsCount;
+	}
+
 	private async getPermittedTargets(userId: EntityId, scope: INewsScope | undefined, permissions: NewsPermission[]) {
 		let targets: NewsTargetFilter[];
 

apps/server/src/shared/domain/entity/news.entity.spec.ts

@@ -0,0 +1,47 @@
+import { setupEntities, teamNewsFactory, userFactory } from '@shared/testing';
+import { News } from './news.entity';
+
+describe(News.name, () => {
+	beforeAll(async () => {
+		await setupEntities();
+	});
+
+	describe('removeCreatorReference', () => {
+		describe('when called on a news that contains some creator with given refId', () => {
+			const setup = () => {
+				const creator = userFactory.buildWithId();
+				const news = teamNewsFactory.build({
+					creator,
+				});
+
+				return { creator, news };
+			};
+			it('should properly remove this creator reference', () => {
+				const { creator, news } = setup();
+
+				news.removeCreatorReference(creator.id);
+
+				expect(news.creator).toEqual(undefined);
+			});
+		});
+	});
+	describe('removeUpdaterReference', () => {
+		describe('when called on a news that contains some creator with given refId', () => {
+			const setup = () => {
+				const updater = userFactory.buildWithId();
+				const news = teamNewsFactory.build({
+					updater,
+				});
+
+				return { updater, news };
+			};
+			it('should properly remove this updater reference', () => {
+				const { updater, news } = setup();
+
+				news.removeUpdaterReference(updater.id);
+
+				expect(news.updater).toEqual(undefined);
+			});
+		});
+	});
+});

apps/server/src/shared/domain/entity/news.entity.ts

@@ -12,7 +12,7 @@ export interface NewsProperties {
 	content: string;
 	displayAt: Date;
 	school: EntityId | SchoolEntity;
-	creator: EntityId | User;
+	creator?: EntityId | User;
 	target: EntityId | NewsTarget;
 
 	externalId?: string;
@@ -61,14 +61,26 @@ export abstract class News extends BaseEntityWithTimestamps {
 	@ManyToOne(() => SchoolEntity, { fieldName: 'schoolId' })
 	school!: SchoolEntity;
 
-	@ManyToOne('User', { fieldName: 'creatorId' })
-	creator!: User;
+	@ManyToOne('User', { fieldName: 'creatorId', nullable: true })
+	creator?: User;
 
 	@ManyToOne('User', { fieldName: 'updaterId', nullable: true })
 	updater?: User;
 
 	permissions: string[] = [];
 
+	public removeCreatorReference(creatorId: EntityId): void {
+		if (creatorId === this.creator?.id) {
+			this.creator = undefined;
+		}
+	}
+
+	public removeUpdaterReference(updaterId: EntityId): void {
+		if (updaterId === this.updater?.id) {
+			this.updater = undefined;
+		}
+	}
+
 	constructor(props: NewsProperties) {
 		super();
 		this.title = props.title;

apps/server/src/shared/domain/types/domain.ts

@@ -13,4 +13,5 @@ export const enum DomainModel {
 	TASK = 'task',
 	TEAMS = 'teams',
 	USER = 'user',
+	NEWS = 'news',
 }

apps/server/src/shared/repo/news/news-scope.ts

@@ -41,4 +41,11 @@ export class NewsScope extends Scope<News> {
 		}
 		return this;
 	}
+
+	byUpdater(updaterId: EntityId): NewsScope {
+		if (updaterId !== undefined) {
+			this.addQuery({ updater: updaterId });
+		}
+		return this;
+	}
 }