EW-1061 TBA

apps/server/src/infra/files-storage-client/files-storage-rest-client.adapter.spec.ts

@@ -0,0 +1,129 @@
+import { faker } from '@faker-js/faker';
+import { createMock, DeepMocked } from '@golevelup/ts-jest';
+import { HttpService } from '@nestjs/axios';
+import { ConfigService } from '@nestjs/config';
+import { REQUEST } from '@nestjs/core';
+import { Test, TestingModule } from '@nestjs/testing';
+import { axiosResponseFactory } from '@shared/testing';
+import { ErrorLogger, Logger } from '@src/core/logger';
+import type { Request } from 'express';
+import { from, throwError } from 'rxjs';
+import { FilesStorageRestClientAdapter } from './files-storage-rest-client.adapter';
+import { FileApi } from './generated';
+
+describe(FilesStorageRestClientAdapter.name, () => {
+	let module: TestingModule;
+	let sut: FilesStorageRestClientAdapter;
+	let httpServiceMock: DeepMocked<HttpService>;
+	let errorLoggerMock: DeepMocked<ErrorLogger>;
+	let configServiceMock: DeepMocked<ConfigService>;
+
+	beforeAll(async () => {
+		module = await Test.createTestingModule({
+			providers: [
+				FilesStorageRestClientAdapter,
+				{
+					provide: FileApi,
+					useValue: createMock<FileApi>(),
+				},
+				{
+					provide: Logger,
+					useValue: createMock<Logger>(),
+				},
+				{
+					provide: ErrorLogger,
+					useValue: createMock<ErrorLogger>(),
+				},
+				{
+					provide: HttpService,
+					useValue: createMock<HttpService>(),
+				},
+				{
+					provide: ConfigService,
+					useValue: createMock<ConfigService>(),
+				},
+				{
+					provide: REQUEST,
+					useValue: createMock<Request>({
+						headers: {
+							authorization: `Bearer ${faker.string.alphanumeric(42)}`,
+						},
+					}),
+				},
+			],
+		}).compile();
+
+		sut = module.get(FilesStorageRestClientAdapter);
+		httpServiceMock = module.get(HttpService);
+		errorLoggerMock = module.get(ErrorLogger);
+		configServiceMock = module.get(ConfigService);
+	});
+
+	afterAll(async () => {
+		await module.close();
+	});
+
+	beforeEach(() => {
+		jest.clearAllMocks();
+	});
+
+	it('should be defined', () => {
+		expect(sut).toBeDefined();
+	});
+
+	describe('download', () => {
+		describe('when download succeeds', () => {
+			const setup = () => {
+				const fileRecordId = faker.string.uuid();
+				const fileName = faker.system.fileName();
+				const observable = from([axiosResponseFactory.build({ data: Buffer.from('') })]);
+
+				httpServiceMock.get.mockReturnValue(observable);
+				configServiceMock.getOrThrow.mockReturnValue(faker.internet.url());
+
+				return {
+					fileRecordId,
+					fileName,
+				};
+			};
+
+			it('should return the response buffer', async () => {
+				const { fileRecordId, fileName } = setup();
+
+				const result = await sut.download(fileRecordId, fileName);
+
+				expect(result).toEqual(Buffer.from(''));
+				expect(httpServiceMock.get).toBeCalledWith(expect.any(String), {
+					responseType: 'arraybuffer',
+					headers: {
+						Authorization: expect.any(String),
+					},
+				});
+			});
+		});
+
+		describe('when download fails', () => {
+			const setup = () => {
+				const fileRecordId = faker.string.uuid();
+				const fileName = faker.system.fileName();
+				const observable = throwError(() => new Error('error'));
+
+				httpServiceMock.get.mockReturnValue(observable);
+
+				return {
+					fileRecordId,
+					fileName,
+				};
+			};
+
+			it('should return null', async () => {
+				const { fileRecordId, fileName } = setup();
+
+				const result = await sut.download(fileRecordId, fileName);
+
+				expect(result).toBeNull();
+				expect(errorLoggerMock.error).toBeCalled();
+			});
+		});
+	});
+});

apps/server/src/infra/files-storage-client/files-storage-rest-client.adapter.ts

@@ -0,0 +1,67 @@
+import { HttpService } from '@nestjs/axios';
+import { Inject, Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { REQUEST } from '@nestjs/core';
+import { extractJwtFromRequest } from '@shared/common/utils/jwt';
+import { AxiosErrorLoggable } from '@src/core/error/loggable';
+import { ErrorLogger, Logger } from '@src/core/logger';
+import { AxiosError } from 'axios';
+import type { Request } from 'express';
+import { lastValueFrom } from 'rxjs';
+import { FilesStorageRestClientConfig } from './files-storage-rest-client.config';
+import { FileApi } from './generated';
+
+@Injectable()
+export class FilesStorageRestClientAdapter {
+	constructor(
+		private readonly api: FileApi,
+		private readonly logger: Logger,
+		private readonly errorLogger: ErrorLogger,
+		// these should be removed when the generated client supports downloading files as arraybuffer
+		private readonly httpService: HttpService,
+		private readonly configService: ConfigService<FilesStorageRestClientConfig, true>,
+		@Inject(REQUEST) private readonly req: Request
+	) {}
+
+	public async download(fileRecordId: string, fileName: string): Promise<Buffer | null> {
+		try {
+			// INFO: we need to download the file from the files storage service without using the generated client,
+			// because the generated client does not support downloading files as arraybuffer. Otherwise files with
+			// binary content would be corrupted like pdfs, zip files, etc. Setting the responseType to 'arraybuffer'
+			// will not work with the generated client.
+			// const response = await this.api.download(fileRecordId, fileName, undefined, {
+			// 	responseType: 'arraybuffer',
+			// });
+			const token = extractJwtFromRequest(this.req);
+			const url = new URL(
+				`${this.configService.getOrThrow<string>(
+					'FILES_STORAGE__SERVICE_BASE_URL'
+				)}/api/v3/file/download/${fileRecordId}/${fileName}`
+			);
+			const observable = this.httpService.get(url.toString(), {
+				responseType: 'arraybuffer',
+				headers: {
+					Authorization: `Bearer ${token}`,
+				},
+			});
+			const response = await lastValueFrom(observable);
+
+			this.logger.warning({
+				getLogMessage() {
+					return {
+						message: 'File downloaded',
+						fileRecordId,
+						response: response as unknown as string,
+					};
+				},
+			});
+
+			// we can safely cast the response to Buffer because we are using responseType: 'arraybuffer'
+			return response.data as unknown as Buffer;
+		} catch (error: unknown) {
+			this.errorLogger.error(new AxiosErrorLoggable(error as AxiosError, 'FilesStorageRestClientAdapter.download'));
+
+			return null;
+		}
+	}
+}

apps/server/src/infra/files-storage-client/files-storage-rest-client.config.ts

@@ -0,0 +1,3 @@
+export interface FilesStorageRestClientConfig {
+	FILES_STORAGE__SERVICE_BASE_URL: string;
+}

apps/server/src/infra/files-storage-client/files-storage-rest-client.module.spec.ts

@@ -0,0 +1,53 @@
+import { faker } from '@faker-js/faker';
+import { createMock } from '@golevelup/ts-jest';
+import { Scope } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { REQUEST } from '@nestjs/core';
+import { Test, TestingModule } from '@nestjs/testing';
+import { Request } from 'express';
+import { FilesStorageRestClientAdapter } from './files-storage-rest-client.adapter';
+import { FilesStorageRestClientModule } from './files-storage-rest-client.module';
+
+describe(FilesStorageRestClientModule.name, () => {
+	let module: TestingModule;
+
+	const configServiceMock = createMock<ConfigService>();
+
+	beforeAll(async () => {
+		module = await Test.createTestingModule({
+			imports: [FilesStorageRestClientModule, ConfigModule.forRoot({ isGlobal: true })],
+			providers: [
+				{
+					provide: REQUEST,
+					scope: Scope.REQUEST,
+					useValue: createMock<Request>({
+						headers: {
+							authorization: `Bearer ${faker.string.alphanumeric(42)}`,
+						},
+					}),
+				},
+			],
+		})
+			.overrideProvider(ConfigService)
+			.useValue(configServiceMock)
+			.compile();
+	});
+
+	afterAll(async () => {
+		await module.close();
+	});
+
+	it('should be defined', () => {
+		expect(module).toBeDefined();
+	});
+
+	describe('resolve providers', () => {
+		describe('when resolving FilesStorageRestClientAdapter', () => {
+			it('should resolve FilesStorageRestClientAdapter', async () => {
+				const provider = await module.resolve(FilesStorageRestClientAdapter);
+
+				expect(provider).toBeInstanceOf(FilesStorageRestClientAdapter);
+			});
+		});
+	});
+});

apps/server/src/infra/files-storage-client/files-storage-rest-client.module.ts

@@ -0,0 +1,32 @@
+import { Module, Scope } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { REQUEST } from '@nestjs/core';
+import { extractJwtFromRequest } from '@shared/common/utils/jwt';
+import { LoggerModule } from '@src/core/logger';
+import { Request } from 'express';
+import { FilesStorageRestClientAdapter } from './files-storage-rest-client.adapter';
+import { FilesStorageRestClientConfig } from './files-storage-rest-client.config';
+import { Configuration, FileApi } from './generated';
+
+@Module({
+	imports: [LoggerModule],
+	providers: [
+		{
+			provide: FilesStorageRestClientAdapter,
+			scope: Scope.REQUEST,
+			useFactory: (configService: ConfigService<FilesStorageRestClientConfig, true>, request: Request): FileApi => {
+				const basePath = configService.getOrThrow<string>('FILES_STORAGE__SERVICE_BASE_URL');
+
+				const config = new Configuration({
+					accessToken: extractJwtFromRequest(request),
+					basePath: `${basePath}/api/v3`,
+				});
+
+				return new FileApi(config);
+			},
+			inject: [ConfigService, REQUEST],
+		},
+	],
+	exports: [FilesStorageRestClientAdapter],
+})
+export class FilesStorageRestClientModule {}

apps/server/src/infra/files-storage-client/generated/.gitignore

@@ -0,0 +1,4 @@
+wwwroot/*.js
+node_modules
+typings
+dist

apps/server/src/infra/files-storage-client/generated/.npmignore

@@ -0,0 +1 @@
+# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm

apps/server/src/infra/files-storage-client/generated/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

apps/server/src/infra/files-storage-client/generated/.openapi-generator/FILES

@@ -0,0 +1,12 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+api.ts
+api/file-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+models/file-record-response.ts
+models/index.ts

apps/server/src/infra/files-storage-client/generated/api.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Schulcloud-Verbund-Software Server API
+ * This is v3 of Schulcloud-Verbund-Software Server. Checkout /docs for v1.
+ *
+ * The version of the OpenAPI document: 3.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export * from './api/file-api';
+