BC-5835 Add Task to KNL Deletion module

apps/server/src/modules/deletion/builder/deletion-log-statistic.builder.spec.ts

@@ -1,4 +1,4 @@
-import { DeletionDomainModel } from '../domain/types';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionLogStatisticBuilder } from '.';
 
 describe(DeletionLogStatisticBuilder.name, () => {
@@ -8,7 +8,7 @@ describe(DeletionLogStatisticBuilder.name, () => {
 
 	it('should build generic deletionLogStatistic with all attributes', () => {
 		// Arrange
-		const domain = DeletionDomainModel.PSEUDONYMS;
+		const domain = DomainModel.PSEUDONYMS;
 		const modifiedCount = 0;
 		const deletedCount = 2;
 

apps/server/src/modules/deletion/builder/deletion-log-statistic.builder.ts

@@ -1,9 +1,15 @@
-import { DeletionDomainModel } from '../domain/types';
-import { DeletionLogStatistic } from '../interface';
+import { DomainOperation } from '@shared/domain/interface';
+import { DomainModel } from '@shared/domain/types';
 
 export class DeletionLogStatisticBuilder {
-	static build(domain: DeletionDomainModel, modifiedCount?: number, deletedCount?: number): DeletionLogStatistic {
-		const deletionLogStatistic = { domain, modifiedCount, deletedCount };
+	static build(
+		domain: DomainModel,
+		modifiedCount: number,
+		deletedCount: number,
+		modifiedRef?: string[],
+		deletedRef?: string[]
+	): DomainOperation {
+		const deletionLogStatistic = { domain, modifiedCount, deletedCount, modifiedRef, deletedRef };
 
 		return deletionLogStatistic;
 	}

apps/server/src/modules/deletion/builder/deletion-request-body-props.builder.spec.ts

@@ -1,5 +1,5 @@
 import { ObjectId } from 'bson';
-import { DeletionDomainModel } from '../domain/types';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionRequestBodyPropsBuilder } from './deletion-request-body-props.builder';
 
 describe(DeletionRequestBodyPropsBuilder.name, () => {
@@ -8,7 +8,7 @@ describe(DeletionRequestBodyPropsBuilder.name, () => {
 	});
 	describe('when create deletionRequestBodyParams', () => {
 		const setup = () => {
-			const domain = DeletionDomainModel.PSEUDONYMS;
+			const domain = DomainModel.PSEUDONYMS;
 			const refId = new ObjectId().toHexString();
 			const deleteInMinutes = 1000;
 			return { domain, refId, deleteInMinutes };

apps/server/src/modules/deletion/builder/deletion-request-body-props.builder.ts

@@ -1,9 +1,8 @@
-import { EntityId } from '@shared/domain/types';
+import { DomainModel, EntityId } from '@shared/domain/types';
 import { DeletionRequestBodyProps } from '../controller/dto';
-import { DeletionDomainModel } from '../domain/types';
 
 export class DeletionRequestBodyPropsBuilder {
-	static build(domain: DeletionDomainModel, id: EntityId, deleteInMinutes?: number): DeletionRequestBodyProps {
+	static build(domain: DomainModel, id: EntityId, deleteInMinutes?: number): DeletionRequestBodyProps {
 		const deletionRequestItem = {
 			targetRef: { domain, id },
 			deleteInMinutes,

apps/server/src/modules/deletion/builder/deletion-request-log-response.builder.spec.ts

@@ -1,4 +1,4 @@
-import { DeletionDomainModel } from '../domain/types';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionLogStatisticBuilder, DeletionRequestLogResponseBuilder, DeletionTargetRefBuilder } from '.';
 
 describe(DeletionRequestLogResponseBuilder, () => {
@@ -8,7 +8,7 @@ describe(DeletionRequestLogResponseBuilder, () => {
 
 	it('should build generic deletionRequestLog with all attributes', () => {
 		// Arrange
-		const targetRefDomain = DeletionDomainModel.PSEUDONYMS;
+		const targetRefDomain = DomainModel.PSEUDONYMS;
 		const targetRefId = '653e4833cc39e5907a1e18d2';
 		const targetRef = DeletionTargetRefBuilder.build(targetRefDomain, targetRefId);
 		const deletionPlannedAt = new Date();

apps/server/src/modules/deletion/builder/deletion-request-log-response.builder.ts

@@ -1,11 +1,12 @@
+import { DomainOperation } from '@shared/domain/interface';
 import { DeletionRequestLogResponse } from '../controller/dto';
-import { DeletionLogStatistic, DeletionTargetRef } from '../interface';
+import { DeletionTargetRef } from '../interface';
 
 export class DeletionRequestLogResponseBuilder {
 	static build(
 		targetRef: DeletionTargetRef,
 		deletionPlannedAt: Date,
-		statistics?: DeletionLogStatistic[]
+		statistics?: DomainOperation[]
 	): DeletionRequestLogResponse {
 		const deletionRequestLog = { targetRef, deletionPlannedAt, statistics };
 

apps/server/src/modules/deletion/builder/deletion-target-ref.builder.spec.ts

@@ -1,4 +1,4 @@
-import { DeletionDomainModel } from '../domain/types';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionTargetRefBuilder } from './index';
 
 describe(DeletionTargetRefBuilder.name, () => {
@@ -8,7 +8,7 @@ describe(DeletionTargetRefBuilder.name, () => {
 
 	it('should build generic deletionTargetRef with all attributes', () => {
 		// Arrange
-		const domain = DeletionDomainModel.PSEUDONYMS;
+		const domain = DomainModel.PSEUDONYMS;
 		const refId = '653e4833cc39e5907a1e18d2';
 
 		const result = DeletionTargetRefBuilder.build(domain, refId);

apps/server/src/modules/deletion/builder/deletion-target-ref.builder.ts

@@ -1,9 +1,8 @@
-import { EntityId } from '@shared/domain/types';
-import { DeletionDomainModel } from '../domain/types';
+import { DomainModel, EntityId } from '@shared/domain/types';
 import { DeletionTargetRef } from '../interface';
 
 export class DeletionTargetRefBuilder {
-	static build(domain: DeletionDomainModel, id: EntityId): DeletionTargetRef {
+	static build(domain: DomainModel, id: EntityId): DeletionTargetRef {
 		const deletionTargetRef = { domain, id };
 
 		return deletionTargetRef;

apps/server/src/modules/deletion/controller/api-test/deletion-request-create.api.spec.ts

@@ -5,8 +5,8 @@ import { AuthGuard } from '@nestjs/passport';
 import { EntityManager } from '@mikro-orm/mongodb';
 import { TestXApiKeyClient } from '@shared/testing';
 import { AdminApiServerTestModule } from '@modules/server/admin-api.server.module';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionRequestBodyProps, DeletionRequestResponse } from '../dto';
-import { DeletionDomainModel } from '../../domain/types';
 import { DeletionRequestEntity } from '../../entity';
 
 const baseRouteName = '/deletionRequests';
@@ -86,14 +86,14 @@ describe(`deletionRequest create (api)`, () => {
 			const setup = () => {
 				const deletionRequestToCreate: DeletionRequestBodyProps = {
 					targetRef: {
-						domain: DeletionDomainModel.USER,
+						domain: DomainModel.USER,
 						id: '653e4833cc39e5907a1e18d2',
 					},
 				};
 
 				const deletionRequestToImmediateRemoval: DeletionRequestBodyProps = {
 					targetRef: {
-						domain: DeletionDomainModel.USER,
+						domain: DomainModel.USER,
 						id: '653e4833cc39e5907a1e18d2',
 					},
 					deleteInMinutes: 0,

apps/server/src/modules/deletion/controller/dto/deletion-request-log.response.spec.ts

@@ -1,13 +1,13 @@
 import { ObjectId } from 'bson';
-import { DeletionDomainModel } from '../../domain/types';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionLogStatisticBuilder, DeletionTargetRefBuilder } from '../../builder';
 import { DeletionRequestLogResponse } from './index';
 
 describe(DeletionRequestLogResponse.name, () => {
 	describe('constructor', () => {
 		describe('when passed properties', () => {
 			const setup = () => {
-				const targetRefDomain = DeletionDomainModel.PSEUDONYMS;
+				const targetRefDomain = DomainModel.PSEUDONYMS;
 				const targetRefId = new ObjectId().toHexString();
 				const targetRef = DeletionTargetRefBuilder.build(targetRefDomain, targetRefId);
 				const deletionPlannedAt = new Date();

apps/server/src/modules/deletion/controller/dto/deletion-request-log.response.ts

@@ -1,6 +1,7 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { IsOptional } from 'class-validator';
-import { DeletionLogStatistic, DeletionTargetRef } from '../../interface';
+import { DomainOperation } from '@shared/domain/interface';
+import { DeletionTargetRef } from '../../interface';
 
 export class DeletionRequestLogResponse {
 	@ApiProperty()
@@ -11,7 +12,7 @@ export class DeletionRequestLogResponse {
 
 	@ApiProperty()
 	@IsOptional()
-	statistics?: DeletionLogStatistic[];
+	statistics?: DomainOperation[];
 
 	constructor(response: DeletionRequestLogResponse) {
 		this.targetRef = response.targetRef;

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

@@ -14,10 +14,11 @@ import { RocketChatUserModule } from '@modules/rocketchat-user';
 import { Configuration } from '@hpi-schul-cloud/commons';
 import { RocketChatModule } from '@modules/rocketchat';
 import { RegistrationPinModule } from '@modules/registration-pin';
+import { TaskModule } from '@modules/task';
+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 { FilesStorageClientModule } from '../files-storage-client';
 
 @Module({
 	imports: [
@@ -35,6 +36,7 @@ import { FilesStorageClientModule } from '../files-storage-client';
 		RocketChatUserModule,
 		RegistrationPinModule,
 		FilesStorageClientModule,
+		TaskModule,
 		RocketChatModule.forRoot({
 			uri: Configuration.get('ROCKET_CHAT_URI') as string,
 			adminId: Configuration.get('ROCKET_CHAT_ADMIN_ID') as string,

apps/server/src/modules/deletion/domain/deletion-log.do.spec.ts

@@ -1,7 +1,8 @@
 import { ObjectId } from '@mikro-orm/mongodb';
+import { DomainModel } from '@shared/domain/types';
 import { deletionLogFactory } from './testing/factory/deletion-log.factory';
 import { DeletionLog } from './deletion-log.do';
-import { DeletionOperationModel, DeletionDomainModel } from './types';
+import { DeletionOperationModel } from './types';
 
 describe(DeletionLog.name, () => {
 	describe('constructor', () => {
@@ -35,7 +36,7 @@ describe(DeletionLog.name, () => {
 			const setup = () => {
 				const props = {
 					id: new ObjectId().toHexString(),
-					domain: DeletionDomainModel.USER,
+					domain: DomainModel.USER,
 					operation: DeletionOperationModel.DELETE,
 					modifiedCount: 0,
 					deletedCount: 1,

apps/server/src/modules/deletion/domain/deletion-log.do.ts

@@ -1,14 +1,14 @@
-import { EntityId } from '@shared/domain/types';
+import { DomainModel, EntityId } from '@shared/domain/types';
 import { AuthorizableObject, DomainObject } from '@shared/domain/domain-object';
-import { DeletionDomainModel, DeletionOperationModel } from './types';
+import { DeletionOperationModel } from './types';
 
 export interface DeletionLogProps extends AuthorizableObject {
 	createdAt?: Date;
 	updatedAt?: Date;
-	domain: DeletionDomainModel;
+	domain: DomainModel;
 	operation?: DeletionOperationModel;
-	modifiedCount?: number;
-	deletedCount?: number;
+	modifiedCount: number;
+	deletedCount: number;
 	deletionRequestId?: EntityId;
 	performedAt?: Date;
 }
@@ -22,19 +22,19 @@ export class DeletionLog extends DomainObject<DeletionLogProps> {
 		return this.props.updatedAt;
 	}
 
-	get domain(): DeletionDomainModel {
+	get domain(): DomainModel {
 		return this.props.domain;
 	}
 
 	get operation(): DeletionOperationModel | undefined {
 		return this.props.operation;
 	}
 
-	get modifiedCount(): number | undefined {
+	get modifiedCount(): number {
 		return this.props.modifiedCount;
 	}
 
-	get deletedCount(): number | undefined {
+	get deletedCount(): number {
 		return this.props.deletedCount;
 	}
 

apps/server/src/modules/deletion/domain/deletion-request.do.spec.ts

@@ -1,6 +1,7 @@
 import { ObjectId } from '@mikro-orm/mongodb';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionRequest } from './deletion-request.do';
-import { DeletionDomainModel, DeletionStatusModel } from './types';
+import { DeletionStatusModel } from './types';
 import { deletionRequestFactory } from './testing/factory/deletion-request.factory';
 
 describe(DeletionRequest.name, () => {
@@ -35,7 +36,7 @@ describe(DeletionRequest.name, () => {
 			const setup = () => {
 				const props = {
 					id: new ObjectId().toHexString(),
-					targetRefDomain: DeletionDomainModel.USER,
+					targetRefDomain: DomainModel.USER,
 					deleteAfter: new Date(),
 					targetRefId: new ObjectId().toHexString(),
 					status: DeletionStatusModel.REGISTERED,

apps/server/src/modules/deletion/domain/deletion-request.do.ts

@@ -1,11 +1,11 @@
-import { EntityId } from '@shared/domain/types';
+import { DomainModel, EntityId } from '@shared/domain/types';
 import { AuthorizableObject, DomainObject } from '@shared/domain/domain-object';
-import { DeletionDomainModel, DeletionStatusModel } from './types';
+import { DeletionStatusModel } from './types';
 
 export interface DeletionRequestProps extends AuthorizableObject {
 	createdAt?: Date;
 	updatedAt?: Date;
-	targetRefDomain: DeletionDomainModel;
+	targetRefDomain: DomainModel;
 	deleteAfter: Date;
 	targetRefId: EntityId;
 	status: DeletionStatusModel;
@@ -20,7 +20,7 @@ export class DeletionRequest extends DomainObject<DeletionRequestProps> {
 		return this.props.updatedAt;
 	}
 
-	get targetRefDomain(): DeletionDomainModel {
+	get targetRefDomain(): DomainModel {
 		return this.props.targetRefDomain;
 	}
 

apps/server/src/modules/deletion/domain/testing/factory/deletion-log.factory.ts

@@ -1,12 +1,13 @@
 import { DoBaseFactory } from '@shared/testing';
 import { ObjectId } from '@mikro-orm/mongodb';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionLog, DeletionLogProps } from '../../deletion-log.do';
-import { DeletionOperationModel, DeletionDomainModel } from '../../types';
+import { DeletionOperationModel } from '../../types';
 
 export const deletionLogFactory = DoBaseFactory.define<DeletionLog, DeletionLogProps>(DeletionLog, () => {
 	return {
 		id: new ObjectId().toHexString(),
-		domain: DeletionDomainModel.USER,
+		domain: DomainModel.USER,
 		operation: DeletionOperationModel.DELETE,
 		modifiedCount: 0,
 		deletedCount: 1,

apps/server/src/modules/deletion/domain/testing/factory/deletion-request.factory.ts

@@ -1,8 +1,9 @@
 import { DoBaseFactory } from '@shared/testing';
 import { ObjectId } from '@mikro-orm/mongodb';
 import { DeepPartial } from 'fishery';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionRequest, DeletionRequestProps } from '../../deletion-request.do';
-import { DeletionDomainModel, DeletionStatusModel } from '../../types';
+import { DeletionStatusModel } from '../../types';
 
 class DeletionRequestFactory extends DoBaseFactory<DeletionRequest, DeletionRequestProps> {
 	withUserIds(id: string): this {
@@ -17,7 +18,7 @@ class DeletionRequestFactory extends DoBaseFactory<DeletionRequest, DeletionRequ
 export const deletionRequestFactory = DeletionRequestFactory.define(DeletionRequest, () => {
 	return {
 		id: new ObjectId().toHexString(),
-		targetRefDomain: DeletionDomainModel.USER,
+		targetRefDomain: DomainModel.USER,
 		deleteAfter: new Date(),
 		targetRefId: new ObjectId().toHexString(),
 		status: DeletionStatusModel.REGISTERED,

apps/server/src/modules/deletion/domain/types/index.ts

@@ -1,3 +1,2 @@
-export * from './deletion-domain-model.enum';
 export * from './deletion-operation-model.enum';
 export * from './deletion-status-model.enum';

apps/server/src/modules/deletion/entity/deletion-log.entity.spec.ts

@@ -1,7 +1,8 @@
 import { setupEntities } from '@shared/testing';
 import { ObjectId } from '@mikro-orm/mongodb';
+import { DomainModel } from '@shared/domain/types';
 import { DeletionLogEntity } from './deletion-log.entity';
-import { DeletionOperationModel, DeletionDomainModel } from '../domain/types';
+import { DeletionOperationModel } from '../domain/types';
 
 describe(DeletionLogEntity.name, () => {
 	beforeAll(async () => {
@@ -13,7 +14,7 @@ describe(DeletionLogEntity.name, () => {
 			const setup = () => {
 				const props = {
 					id: new ObjectId().toHexString(),
-					domain: DeletionDomainModel.USER,
+					domain: DomainModel.USER,
 					operation: DeletionOperationModel.DELETE,
 					modifiedCount: 0,
 					deletedCount: 1,