BC-5629 batch deletion mechanism

apps/server/src/modules/deletion/client/builder/deletion-request-input.builder.spec.ts

@@ -0,0 +1,33 @@
+import { ObjectId } from 'bson';
+import { DeletionRequestInput } from '../interface';
+import { DeletionRequestInputBuilder } from './deletion-request-input.builder';
+
+describe(DeletionRequestInputBuilder.name, () => {
+	describe(DeletionRequestInputBuilder.build.name, () => {
+		describe('when called with proper arguments', () => {
+			const setup = () => {
+				const targetRefDomain = 'school';
+				const targetRefId = new ObjectId().toHexString();
+				const deleteInMinutes = 43200;
+
+				const expectedOutput: DeletionRequestInput = {
+					targetRef: {
+						domain: targetRefDomain,
+						id: targetRefId,
+					},
+					deleteInMinutes,
+				};
+
+				return { targetRefDomain, targetRefId, deleteInMinutes, expectedOutput };
+			};
+
+			it('should return valid object with expected values', () => {
+				const { targetRefDomain, targetRefId, deleteInMinutes, expectedOutput } = setup();
+
+				const output = DeletionRequestInputBuilder.build(targetRefDomain, targetRefId, deleteInMinutes);
+
+				expect(output).toStrictEqual(expectedOutput);
+			});
+		});
+	});
+});

apps/server/src/modules/deletion/client/builder/deletion-request-input.builder.ts

@@ -0,0 +1,11 @@
+import { DeletionRequestInput } from '../interface';
+import { DeletionRequestTargetRefInputBuilder } from './deletion-request-target-ref-input.builder';
+
+export class DeletionRequestInputBuilder {
+	static build(targetRefDomain: string, targetRefId: string, deleteInMinutes?: number): DeletionRequestInput {
+		return {
+			targetRef: DeletionRequestTargetRefInputBuilder.build(targetRefDomain, targetRefId),
+			deleteInMinutes,
+		};
+	}
+}

apps/server/src/modules/deletion/client/builder/deletion-request-output.builder.spec.ts

@@ -0,0 +1,29 @@
+import { ObjectId } from 'bson';
+import { DeletionRequestOutput } from '../interface';
+import { DeletionRequestOutputBuilder } from './deletion-request-output.builder';
+
+describe(DeletionRequestOutputBuilder.name, () => {
+	describe(DeletionRequestOutputBuilder.build.name, () => {
+		describe('when called with proper arguments', () => {
+			const setup = () => {
+				const requestId = new ObjectId().toHexString();
+				const deletionPlannedAt = new Date();
+
+				const expectedOutput: DeletionRequestOutput = {
+					requestId,
+					deletionPlannedAt,
+				};
+
+				return { requestId, deletionPlannedAt, expectedOutput };
+			};
+
+			it('should return valid object with expected values', () => {
+				const { requestId, deletionPlannedAt, expectedOutput } = setup();
+
+				const output = DeletionRequestOutputBuilder.build(requestId, deletionPlannedAt);
+
+				expect(output).toStrictEqual(expectedOutput);
+			});
+		});
+	});
+});

apps/server/src/modules/deletion/client/builder/deletion-request-output.builder.ts

@@ -0,0 +1,10 @@
+import { DeletionRequestOutput } from '../interface';
+
+export class DeletionRequestOutputBuilder {
+	static build(requestId: string, deletionPlannedAt: Date): DeletionRequestOutput {
+		return {
+			requestId,
+			deletionPlannedAt,
+		};
+	}
+}

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

@@ -0,0 +1,26 @@
+import { ObjectId } from 'bson';
+import { DeletionRequestTargetRefInput } from '../interface';
+import { DeletionRequestTargetRefInputBuilder } from './deletion-request-target-ref-input.builder';
+
+describe(DeletionRequestTargetRefInputBuilder.name, () => {
+	describe(DeletionRequestTargetRefInputBuilder.build.name, () => {
+		describe('when called with proper arguments', () => {
+			const setup = () => {
+				const domain = 'user';
+				const id = new ObjectId().toHexString();
+
+				const expectedOutput: DeletionRequestTargetRefInput = { domain, id };
+
+				return { domain, id, expectedOutput };
+			};
+
+			it('should return valid object with expected values', () => {
+				const { domain, id, expectedOutput } = setup();
+
+				const output = DeletionRequestTargetRefInputBuilder.build(domain, id);
+
+				expect(output).toStrictEqual(expectedOutput);
+			});
+		});
+	});
+});

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

@@ -0,0 +1,7 @@
+import { DeletionRequestTargetRefInput } from '../interface';
+
+export class DeletionRequestTargetRefInputBuilder {
+	static build(domain: string, id: string): DeletionRequestTargetRefInput {
+		return { domain, id };
+	}
+}

apps/server/src/modules/deletion/client/builder/index.ts

@@ -0,0 +1,3 @@
+export * from './deletion-request-target-ref-input.builder';
+export * from './deletion-request-input.builder';
+export * from './deletion-request-output.builder';

apps/server/src/modules/deletion/client/deletion-client.config.spec.ts

@@ -0,0 +1,41 @@
+import { IConfig } from '@hpi-schul-cloud/commons/lib/interfaces/IConfig';
+import { Configuration } from '@hpi-schul-cloud/commons/lib';
+import { DeletionClientConfig } from './interface';
+import { getDeletionClientConfig } from './deletion-client.config';
+
+describe(getDeletionClientConfig.name, () => {
+	let configBefore: IConfig;
+
+	beforeAll(() => {
+		configBefore = Configuration.toObject({ plainSecrets: true });
+	});
+
+	afterEach(() => {
+		Configuration.reset(configBefore);
+	});
+
+	describe('when called', () => {
+		const setup = () => {
+			const baseUrl = 'http://api-admin:4030';
+			const apiKey = '652559c2-93da-42ad-94e1-640e3afbaca0';
+
+			Configuration.set('ADMIN_API_CLIENT__BASE_URL', baseUrl);
+			Configuration.set('ADMIN_API_CLIENT__API_KEY', apiKey);
+
+			const expectedConfig: DeletionClientConfig = {
+				ADMIN_API_CLIENT_BASE_URL: baseUrl,
+				ADMIN_API_CLIENT_API_KEY: apiKey,
+			};
+
+			return { expectedConfig };
+		};
+
+		it('should return config with proper values', () => {
+			const { expectedConfig } = setup();
+
+			const config = getDeletionClientConfig();
+
+			expect(config).toEqual(expectedConfig);
+		});
+	});
+});

apps/server/src/modules/deletion/client/deletion-client.config.ts

@@ -0,0 +1,9 @@
+import { Configuration } from '@hpi-schul-cloud/commons/lib';
+import { DeletionClientConfig } from './interface';
+
+export const getDeletionClientConfig = (): DeletionClientConfig => {
+	return {
+		ADMIN_API_CLIENT_BASE_URL: Configuration.get('ADMIN_API_CLIENT__BASE_URL') as string,
+		ADMIN_API_CLIENT_API_KEY: Configuration.get('ADMIN_API_CLIENT__API_KEY') as string,
+	};
+};

apps/server/src/modules/deletion/client/deletion.client.spec.ts

@@ -0,0 +1,154 @@
+import { of } from 'rxjs';
+import { AxiosResponse } from 'axios';
+import { HttpService } from '@nestjs/axios';
+import { ConfigService } from '@nestjs/config';
+import { Test, TestingModule } from '@nestjs/testing';
+import { createMock, DeepMocked } from '@golevelup/ts-jest';
+import { axiosResponseFactory } from '@shared/testing';
+import { DeletionRequestInputBuilder, DeletionRequestOutputBuilder } from '@modules/deletion';
+import { DeletionRequestOutput } from './interface';
+import { DeletionClient } from './deletion.client';
+
+describe(DeletionClient.name, () => {
+	let module: TestingModule;
+	let client: DeletionClient;
+	let httpService: DeepMocked<HttpService>;
+
+	beforeEach(async () => {
+		module = await Test.createTestingModule({
+			providers: [
+				DeletionClient,
+				{
+					provide: ConfigService,
+					useValue: createMock<ConfigService>({
+						get: jest.fn((key: string) => {
+							if (key === 'ADMIN_API_CLIENT_BASE_URL') {
+								return 'http://localhost:4030';
+							}
+
+							// Default is for the Admin APIs API Key.
+							return '6b3df003-61e9-467c-9e6b-579634801896';
+						}),
+					}),
+				},
+				{
+					provide: HttpService,
+					useValue: createMock<HttpService>(),
+				},
+			],
+		}).compile();
+
+		client = module.get(DeletionClient);
+		httpService = module.get(HttpService);
+	});
+
+	afterEach(() => {
+		jest.resetAllMocks();
+	});
+
+	afterAll(async () => {
+		await module.close();
+	});
+
+	describe('queueDeletionRequest', () => {
+		describe('when received valid response with expected HTTP status code', () => {
+			const setup = () => {
+				const input = DeletionRequestInputBuilder.build('user', '652f1625e9bc1a13bdaae48b');
+
+				const output: DeletionRequestOutput = DeletionRequestOutputBuilder.build(
+					'6536ce29b595d7c8e5faf200',
+					new Date('2024-10-15T12:42:50.521Z')
+				);
+
+				const response: AxiosResponse<DeletionRequestOutput> = axiosResponseFactory.build({
+					data: output,
+					status: 202,
+				});
+
+				httpService.post.mockReturnValueOnce(of(response));
+
+				return { input, output };
+			};
+
+			it('should return proper output', async () => {
+				const { input, output } = setup();
+
+				const result = await client.queueDeletionRequest(input);
+
+				expect(result).toEqual(output);
+			});
+		});
+
+		describe('when received invalid HTTP status code in a response', () => {
+			const setup = () => {
+				const input = DeletionRequestInputBuilder.build('user', '652f1625e9bc1a13bdaae48b');
+
+				const output: DeletionRequestOutput = DeletionRequestOutputBuilder.build('', new Date());
+
+				const response: AxiosResponse<DeletionRequestOutput> = axiosResponseFactory.build({
+					data: output,
+					status: 200,
+				});
+
+				httpService.post.mockReturnValueOnce(of(response));
+
+				return { input };
+			};
+
+			it('should throw an exception', async () => {
+				const { input } = setup();
+
+				await expect(client.queueDeletionRequest(input)).rejects.toThrow(Error);
+			});
+		});
+
+		describe('when received no requestId in a response', () => {
+			const setup = () => {
+				const input = DeletionRequestInputBuilder.build('user', '652f1625e9bc1a13bdaae48b');
+
+				const output: DeletionRequestOutput = DeletionRequestOutputBuilder.build(
+					'',
+					new Date('2024-10-15T12:42:50.521Z')
+				);
+
+				const response: AxiosResponse<DeletionRequestOutput> = axiosResponseFactory.build({
+					data: output,
+					status: 202,
+				});
+
+				httpService.post.mockReturnValueOnce(of(response));
+
+				return { input };
+			};
+
+			it('should throw an exception', async () => {
+				const { input } = setup();
+
+				await expect(client.queueDeletionRequest(input)).rejects.toThrow(Error);
+			});
+		});
+
+		describe('when received no deletionPlannedAt in a response', () => {
+			const setup = () => {
+				const input = DeletionRequestInputBuilder.build('user', '652f1625e9bc1a13bdaae48b');
+
+				const response: AxiosResponse<DeletionRequestOutput> = axiosResponseFactory.build({
+					data: {
+						requestId: '6536ce29b595d7c8e5faf200',
+					},
+					status: 202,
+				});
+
+				httpService.post.mockReturnValueOnce(of(response));
+
+				return { input };
+			};
+
+			it('should throw an exception', async () => {
+				const { input } = setup();
+
+				await expect(client.queueDeletionRequest(input)).rejects.toThrow(Error);
+			});
+		});
+	});
+});

apps/server/src/modules/deletion/client/deletion.client.ts

@@ -0,0 +1,66 @@
+import { firstValueFrom } from 'rxjs';
+import { AxiosResponse } from 'axios';
+import { Injectable } from '@nestjs/common';
+import { HttpService } from '@nestjs/axios';
+import { ConfigService } from '@nestjs/config';
+import { DeletionRequestInput, DeletionRequestOutput, DeletionClientConfig } from './interface';
+
+@Injectable()
+export class DeletionClient {
+	private readonly baseUrl: string;
+
+	private readonly apiKey: string;
+
+	private readonly postDeletionRequestsEndpoint: string;
+
+	constructor(
+		private readonly httpService: HttpService,
+		private readonly configService: ConfigService<DeletionClientConfig, true>
+	) {
+		this.baseUrl = this.configService.get<string>('ADMIN_API_CLIENT_BASE_URL');
+		this.apiKey = this.configService.get<string>('ADMIN_API_CLIENT_API_KEY');
+
+		// Prepare the POST /deletionRequests endpoint beforehand to not do it on every client call.
+		this.postDeletionRequestsEndpoint = new URL('/admin/api/v1/deletionRequests', this.baseUrl).toString();
+	}
+
+	async queueDeletionRequest(input: DeletionRequestInput): Promise<DeletionRequestOutput> {
+		const request = this.httpService.post(this.postDeletionRequestsEndpoint, input, this.defaultHeaders());
+
+		return firstValueFrom(request)
+			.then((resp: AxiosResponse<DeletionRequestOutput>) => {
+				// Throw an error if any other status code (other than expected "202 Accepted" is returned).
+				if (resp.status !== 202) {
+					throw new Error(`invalid HTTP status code in a response from the server - ${resp.status} instead of 202`);
+				}
+
+				// Throw an error if server didn't return a requestId in a response (and it is
+				// required as it gives client the reference to the created deletion request).
+				if (!resp.data.requestId) {
+					throw new Error('no valid requestId returned from the server');
+				}
+
+				// Throw an error if server didn't return a deletionPlannedAt timestamp so the user
+				// will not be aware after which date the deletion request's execution will begin.
+				if (!resp.data.deletionPlannedAt) {
+					throw new Error('no valid deletionPlannedAt returned from the server');
+				}
+
+				return resp.data;
+			})
+			.catch((err: Error) => {
+				// Throw an error if sending/processing deletion request by the client failed in any way.
+				throw new Error(`failed to send/process a deletion request: ${err.toString()}`);
+			});
+	}
+
+	private apiKeyHeader() {
+		return { 'X-Api-Key': this.apiKey };
+	}
+
+	private defaultHeaders() {
+		return {
+			headers: this.apiKeyHeader(),
+		};
+	}
+}