BC-3961-move-s3-client-to-infra

apps/server/src/modules/files-storage/controller/api-test/files-storage-copy-files.api.spec.ts

@@ -5,6 +5,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { ApiValidationError } from '@shared/common';
 import { EntityId, Permission } from '@shared/domain';
 import { AntivirusService } from '@shared/infra/antivirus/antivirus.service';
+import { S3ClientAdapter } from '@shared/infra/s3-file-storage';
 import {
 	cleanupCollections,
 	courseFactory,
@@ -25,7 +26,6 @@ import {
 } from '@src/modules/files-storage/controller/dto';
 import { Request } from 'express';
 import request from 'supertest';
-import { S3ClientAdapter } from '../../client/s3-client.adapter';
 import { FileRecordParentType } from '../../entity';
 import { availableParentTypes } from './mocks';
 

apps/server/src/modules/files-storage/controller/api-test/files-storage-delete-files.api.spec.ts

@@ -5,6 +5,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { ApiValidationError } from '@shared/common';
 import { EntityId, Permission } from '@shared/domain';
 import { AntivirusService } from '@shared/infra/antivirus/antivirus.service';
+import { S3ClientAdapter } from '@shared/infra/s3-file-storage';
 import {
 	cleanupCollections,
 	fileRecordFactory,
@@ -19,7 +20,6 @@ import { FilesStorageTestModule } from '@src/modules/files-storage';
 import { FileRecordListResponse, FileRecordResponse } from '@src/modules/files-storage/controller/dto';
 import { Request } from 'express';
 import request from 'supertest';
-import { S3ClientAdapter } from '../../client/s3-client.adapter';
 import { FileRecordParentType, PreviewStatus } from '../../entity';
 import { availableParentTypes } from './mocks';
 

apps/server/src/modules/files-storage/controller/api-test/files-storage-download-upload.api.spec.ts

@@ -5,14 +5,14 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { ApiValidationError } from '@shared/common';
 import { EntityId, Permission } from '@shared/domain';
 import { AntivirusService } from '@shared/infra/antivirus/antivirus.service';
+import { S3ClientAdapter } from '@shared/infra/s3-file-storage';
 import { cleanupCollections, mapUserToCurrentUser, roleFactory, schoolFactory, userFactory } from '@shared/testing';
 import { ICurrentUser } from '@src/modules/authentication';
 import { JwtAuthGuard } from '@src/modules/authentication/guard/jwt-auth.guard';
 import { FilesStorageTestModule } from '@src/modules/files-storage';
 import { FileRecordResponse } from '@src/modules/files-storage/controller/dto';
 import { Request } from 'express';
 import request from 'supertest';
-import { S3ClientAdapter } from '../../client/s3-client.adapter';
 import { FileRecord } from '../../entity';
 import { ErrorType } from '../../error';
 import { TestHelper } from '../../helper/test-helper';

apps/server/src/modules/files-storage/controller/api-test/files-storage-preview.api.spec.ts

@@ -5,14 +5,14 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { ApiValidationError } from '@shared/common';
 import { EntityId, Permission } from '@shared/domain';
 import { AntivirusService } from '@shared/infra/antivirus/antivirus.service';
+import { S3ClientAdapter } from '@shared/infra/s3-file-storage';
 import { cleanupCollections, mapUserToCurrentUser, roleFactory, schoolFactory, userFactory } from '@shared/testing';
 import { ICurrentUser } from '@src/modules/authentication';
 import { JwtAuthGuard } from '@src/modules/authentication/guard/jwt-auth.guard';
 import { FilesStorageTestModule } from '@src/modules/files-storage';
 import { FileRecordResponse } from '@src/modules/files-storage/controller/dto';
 import { Request } from 'express';
 import request from 'supertest';
-import { S3ClientAdapter } from '../../client/s3-client.adapter';
 import { FileRecord, ScanStatus } from '../../entity';
 import { ErrorType } from '../../error';
 import { TestHelper } from '../../helper/test-helper';

apps/server/src/modules/files-storage/controller/api-test/files-storage-restore-files.api.spec.ts

@@ -5,6 +5,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { ApiValidationError } from '@shared/common';
 import { EntityId, Permission } from '@shared/domain';
 import { AntivirusService } from '@shared/infra/antivirus/antivirus.service';
+import { S3ClientAdapter } from '@shared/infra/s3-file-storage';
 import {
 	cleanupCollections,
 	fileRecordFactory,
@@ -19,7 +20,6 @@ import { FilesStorageTestModule } from '@src/modules/files-storage';
 import { FileRecordListResponse, FileRecordResponse } from '@src/modules/files-storage/controller/dto';
 import { Request } from 'express';
 import request from 'supertest';
-import { S3ClientAdapter } from '../../client/s3-client.adapter';
 import { FileRecordParentType, PreviewStatus } from '../../entity';
 import { availableParentTypes } from './mocks';
 

apps/server/src/modules/files-storage/controller/files-storage.controller.ts

@@ -27,7 +27,7 @@ import { PaginationParams } from '@shared/controller';
 import { ICurrentUser } from '@src/modules/authentication';
 import { Authenticate, CurrentUser } from '@src/modules/authentication/decorator/auth.decorator';
 import { Request, Response } from 'express';
-import { IGetFileResponse } from '../interface';
+import { GetFileResponse } from '../interface';
 import { FilesStorageMapper } from '../mapper';
 import { FileRecordMapper } from '../mapper/file-record.mapper';
 import { FilesStorageUC } from '../uc';
@@ -149,7 +149,7 @@ export class FilesStorageController {
 
 	private streamFileToClient(
 		req: Request,
-		fileResponse: IGetFileResponse,
+		fileResponse: GetFileResponse,
 		httpResponse: Response,
 		bytesRange?: string
 	): StreamableFile {

apps/server/src/modules/files-storage/files-storage.config.ts

@@ -1,6 +1,6 @@
 import { Configuration } from '@hpi-schul-cloud/commons';
+import { S3Config } from '@shared/infra/s3-file-storage';
 import { ICoreModuleConfig } from '@src/core';
-import { S3Config } from './interface';
 
 export interface IFileStorageConfig extends ICoreModuleConfig {
 	MAX_FILE_SIZE: number;

apps/server/src/modules/files-storage/files-storage.module.ts

@@ -1,4 +1,3 @@
-import { S3Client } from '@aws-sdk/client-s3';
 import { Configuration } from '@hpi-schul-cloud/commons';
 import { Dictionary, IPrimaryKey } from '@mikro-orm/core';
 import { MikroOrmModule, MikroOrmModuleSyncOptions } from '@mikro-orm/nestjs';
@@ -7,12 +6,11 @@ import { ConfigModule } from '@nestjs/config';
 import { ALL_ENTITIES } from '@shared/domain';
 import { AntivirusModule } from '@shared/infra/antivirus/antivirus.module';
 import { RabbitMQWrapperModule } from '@shared/infra/rabbitmq/rabbitmq.module';
+import { S3FileStorageModule } from '@shared/infra/s3-file-storage';
 import { DB_PASSWORD, DB_URL, DB_USERNAME, createConfigModuleOptions } from '@src/config';
 import { LoggerModule } from '@src/core/logger';
-import { S3ClientAdapter } from './client/s3-client.adapter';
 import { FileRecord, FileSecurityCheck } from './entity';
 import { config, s3Config } from './files-storage.config';
-import { S3Config } from './interface/config';
 import { FileRecordRepo } from './repo';
 import { FilesStorageService } from './service/files-storage.service';
 import { PreviewService } from './service/preview.service';
@@ -26,32 +24,9 @@ const imports = [
 		exchange: Configuration.get('ANTIVIRUS_EXCHANGE') as string,
 		routingKey: Configuration.get('ANTIVIRUS_ROUTING_KEY') as string,
 	}),
+	S3FileStorageModule.register(s3Config),
 ];
-const providers = [
-	FilesStorageService,
-	PreviewService,
-	{
-		provide: 'S3_Client',
-		useFactory: (configProvider: S3Config) =>
-			new S3Client({
-				region: configProvider.region,
-				credentials: {
-					accessKeyId: configProvider.accessKeyId,
-					secretAccessKey: configProvider.secretAccessKey,
-				},
-				endpoint: configProvider.endpoint,
-				forcePathStyle: true,
-				tls: true,
-			}),
-		inject: ['S3_Config'],
-	},
-	{
-		provide: 'S3_Config',
-		useValue: s3Config,
-	},
-	S3ClientAdapter,
-	FileRecordRepo,
-];
+const providers = [FilesStorageService, PreviewService, FileRecordRepo];
 
 const defaultMikroOrmOptions: MikroOrmModuleSyncOptions = {
 	findOneOrFailHandler: (entityName: string, where: Dictionary | IPrimaryKey) =>

apps/server/src/modules/files-storage/helper/path.ts

@@ -1,7 +1,7 @@
 import { EntityId } from '@shared/domain';
+import { CopyFiles } from '@shared/infra/s3-file-storage';
 import { FileRecord } from '../entity';
 import { ErrorType } from '../error';
-import { ICopyFiles } from '../interface';
 
 export function createPath(schoolId: EntityId, fileRecordId: EntityId): string {
 	if (!schoolId || !fileRecordId) {
@@ -32,7 +32,7 @@ export function getPaths(fileRecords: FileRecord[]): string[] {
 	return paths;
 }
 
-export function createICopyFiles(sourceFile: FileRecord, targetFile: FileRecord): ICopyFiles {
+export function createICopyFiles(sourceFile: FileRecord, targetFile: FileRecord): CopyFiles {
 	const iCopyFiles = {
 		sourcePath: createPath(sourceFile.getSchoolId(), sourceFile.id),
 		targetPath: createPath(targetFile.getSchoolId(), targetFile.id),

apps/server/src/modules/files-storage/helper/test-helper.ts

@@ -1,8 +1,9 @@
+import { GetFile } from '@shared/infra/s3-file-storage';
 import { Readable } from 'stream';
-import { IGetFile, IGetFileResponse } from '../interface';
+import { GetFileResponse } from '../interface';
 
 export class TestHelper {
-	public static createFile = (contentRange?: string): IGetFile => {
+	public static createFile = (contentRange?: string): GetFile => {
 		const text = 'testText';
 		const readable = Readable.from(text);
 
@@ -17,7 +18,7 @@ export class TestHelper {
 		return fileResponse;
 	};
 
-	public static createFileResponse = (contentRange?: string): IGetFileResponse => {
+	public static createFileResponse = (contentRange?: string): GetFileResponse => {
 		const name = 'testName';
 		const file = this.createFile(contentRange);
 		const fileResponse = { ...file, name };

apps/server/src/modules/files-storage/interface/index.ts

@@ -1,5 +1,4 @@
-export * from './config';
+export * from './interfaces';
 export * from './preview-input-mime-types.enum';
 export * from './preview-output-mime-types.enum';
 export * from './preview-width.enum';
-export * from './storage-client';

apps/server/src/modules/files-storage/interface/interfaces.ts

@@ -0,0 +1,21 @@
+import { Readable } from 'stream';
+import type { DownloadFileParams, PreviewParams } from '../controller/dto';
+import { FileRecord } from '../entity';
+
+export interface GetFileResponse {
+	data: Readable;
+	etag: string | undefined;
+	contentType: string | undefined;
+	contentLength: number | undefined;
+	contentRange: string | undefined;
+	name: string;
+}
+
+export interface PreviewFileParams {
+	fileRecord: FileRecord;
+	downloadParams: DownloadFileParams;
+	previewParams: PreviewParams;
+	hash: string;
+	filePath: string;
+	bytesRange?: string;
+}

apps/server/src/modules/files-storage/mapper/file-response.builder.ts

@@ -1,7 +1,8 @@
-import { IGetFile, IGetFileResponse } from '../interface';
+import { GetFile } from '@shared/infra/s3-file-storage';
+import { GetFileResponse } from '../interface';
 
 export class FileResponseBuilder {
-	public static build(file: IGetFile, name: string): IGetFileResponse {
+	public static build(file: GetFile, name: string): GetFileResponse {
 		const fileResponse = { ...file, data: file.data, name };
 
 		return fileResponse;

apps/server/src/modules/files-storage/mapper/files-storage.mapper.ts

@@ -9,7 +9,7 @@ import {
 	SingleFileParams,
 } from '../controller/dto';
 import { FileRecord, FileRecordParentType } from '../entity';
-import { IGetFileResponse } from '../interface';
+import { GetFileResponse } from '../interface';
 
 export class FilesStorageMapper {
 	static mapToAllowedAuthorizationEntityType(type: FileRecordParentType): AuthorizableReferenceType {
@@ -62,7 +62,7 @@ export class FilesStorageMapper {
 		return response;
 	}
 
-	static mapToStreamableFile(fileResponse: IGetFileResponse): StreamableFile {
+	static mapToStreamableFile(fileResponse: GetFileResponse): StreamableFile {
 		const streamableFile = new StreamableFile(fileResponse.data, {
 			type: fileResponse.contentType,
 			disposition: `inline; filename="${encodeURI(fileResponse.name)}"`,

apps/server/src/modules/files-storage/service/files-storage-copy.service.spec.ts

@@ -3,9 +3,9 @@ import { ObjectId } from '@mikro-orm/mongodb';
 import { ConfigService } from '@nestjs/config';
 import { Test, TestingModule } from '@nestjs/testing';
 import { AntivirusService } from '@shared/infra/antivirus/antivirus.service';
+import { S3ClientAdapter } from '@shared/infra/s3-file-storage';
 import { fileRecordFactory, setupEntities } from '@shared/testing';
 import { LegacyLogger } from '@src/core/logger';
-import { S3ClientAdapter } from '../client/s3-client.adapter';
 import { FileRecordParams } from '../controller/dto';
 import { FileRecord, FileRecordParentType, ScanStatus } from '../entity';
 import { createICopyFiles } from '../helper';

apps/server/src/modules/files-storage/service/files-storage-delete.service.spec.ts

@@ -4,9 +4,9 @@ import { InternalServerErrorException } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { Test, TestingModule } from '@nestjs/testing';
 import { AntivirusService } from '@shared/infra/antivirus/antivirus.service';
+import { S3ClientAdapter } from '@shared/infra/s3-file-storage';
 import { fileRecordFactory, setupEntities } from '@shared/testing';
 import { LegacyLogger } from '@src/core/logger';
-import { S3ClientAdapter } from '../client/s3-client.adapter';
 import { FileRecordParams } from '../controller/dto';
 import { FileRecord, FileRecordParentType } from '../entity';
 import { getPaths } from '../helper';

apps/server/src/modules/files-storage/service/files-storage-download.service.spec.ts

@@ -4,14 +4,13 @@ import { NotAcceptableException, NotFoundException } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { Test, TestingModule } from '@nestjs/testing';
 import { AntivirusService } from '@shared/infra/antivirus/antivirus.service';
+import { GetFile, S3ClientAdapter } from '@shared/infra/s3-file-storage';
 import { fileRecordFactory, setupEntities } from '@shared/testing';
 import { LegacyLogger } from '@src/core/logger';
-import { S3ClientAdapter } from '../client/s3-client.adapter';
 import { FileRecordParams } from '../controller/dto';
 import { FileRecord, FileRecordParentType, ScanStatus } from '../entity';
 import { ErrorType } from '../error';
 import { createPath } from '../helper';
-import { IGetFile, IGetFileResponse } from '../interface';
 import { FileResponseBuilder } from '../mapper';
 import { FileRecordRepo } from '../repo';
 import { FilesStorageService } from './files-storage.service';
@@ -101,10 +100,10 @@ describe('FilesStorageService download methods', () => {
 					fileName: fileRecord.name,
 				};
 
-				const fileResponse = createMock<IGetFile>();
+				const fileResponse = createMock<GetFile>();
 				const expectedResponse = FileResponseBuilder.build(fileResponse, fileRecord.getName());
 
-				spy = jest.spyOn(service, 'downloadFile').mockResolvedValueOnce(fileResponse);
+				spy = jest.spyOn(service, 'downloadFile').mockResolvedValueOnce(expectedResponse);
 
 				return { fileRecord, params, expectedResponse };
 			};
@@ -114,7 +113,7 @@ describe('FilesStorageService download methods', () => {
 
 				await service.download(fileRecord, params);
 
-				expect(service.downloadFile).toHaveBeenCalledWith(fileRecord.schoolId, fileRecord.id, undefined);
+				expect(service.downloadFile).toHaveBeenCalledWith(fileRecord, undefined);
 			});
 
 			it('returns correct response', async () => {
@@ -204,9 +203,10 @@ describe('FilesStorageService download methods', () => {
 				const { fileRecords } = buildFileRecordsWithParams();
 				const fileRecord = fileRecords[0];
 
-				const expectedResponse = createMock<IGetFileResponse>();
+				const fileResponse = createMock<GetFile>();
 
-				storageClient.get.mockResolvedValueOnce(expectedResponse);
+				storageClient.get.mockResolvedValueOnce(fileResponse);
+				const expectedResponse = FileResponseBuilder.build(fileResponse, fileRecord.getName());
 
 				return { fileRecord, expectedResponse };
 			};
@@ -216,15 +216,15 @@ describe('FilesStorageService download methods', () => {
 
 				const path = createPath(fileRecord.schoolId, fileRecord.id);
 
-				await service.downloadFile(fileRecord.schoolId, fileRecord.id);
+				await service.downloadFile(fileRecord);
 
 				expect(storageClient.get).toHaveBeenCalledWith(path, undefined);
 			});
 
 			it('returns correct response', async () => {
 				const { fileRecord, expectedResponse } = setup();
 
-				const response = await service.downloadFile(fileRecord.schoolId, fileRecord.id);
+				const response = await service.downloadFile(fileRecord);
 
 				expect(response).toEqual(expectedResponse);
 			});
@@ -244,7 +244,7 @@ describe('FilesStorageService download methods', () => {
 			it('passes error', async () => {
 				const { fileRecord, error } = setup();
 
-				await expect(service.downloadFile(fileRecord.schoolId, fileRecord.id)).rejects.toThrowError(error);
+				await expect(service.downloadFile(fileRecord)).rejects.toThrowError(error);
 			});
 		});
 	});