- apps/server/src/modules/files-storage-client/mapper/error.mapper.ts
+ apps/server/src/shared/infra/rabbitmq/error.mapper.ts
+
+ File
+
import { Readable } from 'stream';
+ import { File } from '@shared/infra/s3-client';
+import { Readable } from 'stream';
-export class FileDto {
+export class FileDto implements File {
constructor(file: FileDto) {
this.name = file.name;
this.data = file.data;
diff --git a/classes/FileRecordSecurityCheck.html b/classes/FileRecordSecurityCheck.html
index 0c79b365782..2ac46cb99a3 100644
--- a/classes/FileRecordSecurityCheck.html
+++ b/classes/FileRecordSecurityCheck.html
@@ -133,7 +133,7 @@ Constructor
-
+
@@ -204,7 +204,7 @@
-
+
@@ -245,7 +245,7 @@
-
+
@@ -287,7 +287,7 @@
-
+
@@ -328,7 +328,7 @@
-
+
@@ -363,7 +363,7 @@
-
+
@@ -386,6 +386,7 @@
import { ObjectId } from '@mikro-orm/mongodb';
import { BadRequestException } from '@nestjs/common';
import { BaseEntityWithTimestamps, EntityId } from '@shared/domain';
+import path from 'path';
import { v4 as uuid } from 'uuid';
import { ErrorType } from '../error';
import { PreviewInputMimeTypes } from '../interface/preview-input-mime-types.enum';
@@ -677,6 +678,12 @@
return PreviewStatus.PREVIEW_NOT_POSSIBLE_SCAN_STATUS_ERROR;
}
+
+ public get fileNameWithoutExtension(): string {
+ const filenameObj = path.parse(this.name);
+
+ return filenameObj.name;
+ }
}
+
+ apps/server/src/shared/infra/preview-generator/loggable/preview-actions.loggable.ts
+
+
+ Loggable
+
+ Methods+ |
+
+
|
+
+constructor(message: string, payload: PreviewFileOptions)
+ |
+ |||||||||
| + + | +|||||||||
|
+
+ Parameters :
+
+
|
+
| + + + getLogMessage + + + | +
+getLogMessage()
+ |
+
| + + | +
|
+
+
+ Returns :
+ LogMessage
+
+ |
+
import { LogMessage, Loggable } from '@src/core/logger';
+import { PreviewFileOptions } from '../interface';
+
+export class PreviewActionsLoggable implements Loggable {
+ constructor(private readonly message: string, private readonly payload: PreviewFileOptions) {}
+
+ getLogMessage(): LogMessage {
+ const { originFilePath, previewFilePath, previewOptions } = this.payload;
+ return {
+ message: this.message,
+ data: {
+ originFilePath,
+ previewFilePath,
+ format: previewOptions.format,
+ width: previewOptions.width,
+ },
+ };
+ }
+}
++
+ apps/server/src/modules/files-storage/mapper/preview.builder.ts
+
+ Methods+ |
+
+
|
+
| + + + Static + buildParams + + + | +||||||||||||
+
+ buildParams(fileRecord: FileRecord, previewParams: PreviewParams, bytesRange: string | undefined)
+ |
+ ||||||||||||
| + + | +||||||||||||
|
+
+
+ Parameters :
+
+
+
+ Returns :
+ PreviewFileParams
+
+
+
+
+ |
+
| + + + Static + buildPayload + + + | +||||||
+
+ buildPayload(params: PreviewFileParams)
+ |
+ ||||||
| + + | +||||||
|
+
+
+ Parameters :
+
+
+
+ Returns :
+ PreviewFileOptions
+
+
+
+
+ |
+
import { PreviewFileOptions } from '@shared/infra/preview-generator';
+import { PreviewParams } from '../controller/dto';
+import { FileRecord } from '../entity';
+import { createPath, createPreviewFilePath, createPreviewNameHash, getFormat } from '../helper';
+import { PreviewFileParams } from '../interface';
+
+export class PreviewBuilder {
+ public static buildParams(
+ fileRecord: FileRecord,
+ previewParams: PreviewParams,
+ bytesRange: string | undefined
+ ): PreviewFileParams {
+ const { schoolId, id, mimeType } = fileRecord;
+ const originFilePath = createPath(schoolId, id);
+ const format = getFormat(previewParams.outputFormat ?? mimeType);
+
+ const hash = createPreviewNameHash(id, previewParams);
+ const previewFilePath = createPreviewFilePath(schoolId, hash, id);
+
+ const previewFileParams = {
+ fileRecord,
+ previewParams,
+ hash,
+ previewFilePath,
+ originFilePath,
+ format,
+ bytesRange,
+ };
+
+ return previewFileParams;
+ }
+
+ public static buildPayload(params: PreviewFileParams): PreviewFileOptions {
+ const { originFilePath, previewFilePath, previewParams, format } = params;
+
+ const payload = {
+ originFilePath,
+ previewFilePath,
+ previewOptions: {
+ format,
+ width: previewParams.width,
+ },
+ };
+
+ return payload;
+ }
+}
++
+ apps/server/src/shared/infra/preview-generator/preview-generator.builder.ts
+
+ Methods+ |
+
+
|
+
| + + + Static + buildFile + + + | +|||||||||
+
+ buildFile(preview: PassThrough, previewOptions: PreviewOptions)
+ |
+ |||||||||
| + + | +|||||||||
|
+
+
+ Parameters :
+
+
+
+ Returns :
+ File
+
+
+
+
+ |
+
import { File } from '@shared/infra/s3-client';
+import { PassThrough } from 'stream';
+import { PreviewOptions } from './interface';
+
+export class PreviewGeneratorBuilder {
+ public static buildFile(preview: PassThrough, previewOptions: PreviewOptions): File {
+ const { format } = previewOptions;
+
+ const file = {
+ data: preview,
+ mimeType: format,
+ };
+
+ return file;
+ }
+}
++
+ apps/server/src/shared/infra/rabbitmq/rpc-message-producer.ts
+
+ Methods+ |
+
+
|
+
+constructor(amqpConnection: AmqpConnection, exchange: string, timeout: number)
+ |
+
| + + | +
| + + | +
| + + + Protected + checkError + + + | +||||||
+
+ checkError(response: RpcMessage<T>)
+ |
+ ||||||
| + + | +||||||
+ Type parameters :
+
|
+ ||||||
|
+
+
+ Parameters :
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
| + + + Protected + createRequest + + + | +|||||||||
+
+ createRequest(event: string, payload)
+ |
+ |||||||||
| + + | +|||||||||
|
+
+
+ Parameters :
+
+
+
+ Returns :
+ { exchange: string; routingKey: string; payload: unknown; timeout: number; }
+
+
+
+
+ |
+
| + + + Protected + Async + request + + + | +|||||||||
+
+ request(event: string, payload)
+ |
+ |||||||||
| + + | +|||||||||
+ Type parameters :
+
|
+ |||||||||
|
+
+
+ Parameters :
+
+
+
+ Returns :
+ unknown
+
+
+
+
+ |
+
import { AmqpConnection } from '@golevelup/nestjs-rabbitmq';
+import { ErrorMapper } from './error.mapper';
+import { RpcMessage } from './rpc-message';
+
+export abstract class RpcMessageProducer {
+ constructor(
+ protected readonly amqpConnection: AmqpConnection,
+ protected readonly exchange: string,
+ protected readonly timeout: number
+ ) {}
+
+ protected async request<T>(event: string, payload: unknown) {
+ const response = await this.amqpConnection.request<RpcMessage<T>>(this.createRequest(event, payload));
+
+ this.checkError<T>(response);
+ return response.message;
+ }
+
+ // need to be fixed with https://ticketsystem.dbildungscloud.de/browse/BC-2984
+ // mapRpcErrorResponseToDomainError should also removed with this ticket
+ protected checkError<T>(response: RpcMessage<T>) {
+ const { error } = response;
+ if (error) {
+ const domainError = ErrorMapper.mapRpcErrorResponseToDomainError(error);
+ throw domainError;
+ }
+ }
+
+ protected createRequest(event: string, payload: unknown) {
+ return {
+ exchange: this.exchange,
+ routingKey: event,
+ payload,
+ timeout: this.timeout,
+ };
+ }
+}
+@ApiOperation({summary: 'Streamable download of a preview file.'})
@ApiResponse({status: 200, type: StreamableFile})
@ApiResponse({status: 206, type: StreamableFile})
@ApiResponse({status: 400, type: ApiValidationError})
@ApiResponse({status: 403, type: ForbiddenException})
@ApiResponse({status: 404, type: NotFoundException})
@ApiResponse({status: 422, type: UnprocessableEntityException})
@ApiResponse({status: 500, type: InternalServerErrorException})
@ApiHeader({name: 'Range', required: false})
@Get('/preview/:fileRecordId/:fileName')
+ @ApiOperation({summary: 'Streamable download of a preview file.'})
@ApiResponse({status: 200, type: StreamableFile})
@ApiResponse({status: 206, type: StreamableFile})
@ApiResponse({status: 400, type: ApiValidationError})
@ApiResponse({status: 403, type: ForbiddenException})
@ApiResponse({status: 404, type: NotFoundException})
@ApiResponse({status: 422, type: UnprocessableEntityException})
@ApiResponse({status: 500, type: InternalServerErrorException})
@ApiHeader({name: 'Range', required: false})
@Get('/preview/:fileRecordId/:fileName')
@RequestTimeout(undefined.INCOMING_REQUEST_TIMEOUT)
import {
+ import { Authenticate, CurrentUser, ICurrentUser } from '@modules/authentication';
+import {
BadRequestException,
Body,
ConflictException,
@@ -1685,10 +1688,10 @@
UseInterceptors,
} from '@nestjs/common';
import { ApiConsumes, ApiHeader, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
-import { ApiValidationError, RequestLoggingInterceptor } from '@shared/common';
+import { ApiValidationError, RequestLoggingInterceptor, RequestTimeout } from '@shared/common';
import { PaginationParams } from '@shared/controller';
-import { ICurrentUser, Authenticate, CurrentUser } from '@modules/authentication';
import { Request, Response } from 'express';
+import { config } from '../files-storage.config';
import { GetFileResponse } from '../interface';
import { FilesStorageMapper } from '../mapper';
import { FileRecordMapper } from '../mapper/file-record.mapper';
@@ -1789,6 +1792,7 @@
@ApiResponse({ status: 500, type: InternalServerErrorException })
@ApiHeader({ name: 'Range', required: false })
@Get('/preview/:fileRecordId/:fileName')
+ @RequestTimeout(config().INCOMING_REQUEST_TIMEOUT)
async downloadPreview(
@Param() params: DownloadFileParams,
@CurrentUser() currentUser: ICurrentUser,
diff --git a/coverage.html b/coverage.html
index 33202408308..ad5f6fd1c7a 100644
--- a/coverage.html
+++ b/coverage.html
@@ -187,6 +187,18 @@
(0/1)
+
+
+
+ apps/server/src/apps/preview-generator-consumer.app.ts
+
+ function
+ bootstrap
+
+ 0 %
+ (0/1)
+
+
@@ -3175,18 +3187,6 @@
(0/2)
-
-
-
- apps/server/src/modules/files-storage-client/mapper/error.mapper.ts
-
- class
- ErrorMapper
-
- 0 %
- (0/2)
-
-
@@ -3643,6 +3643,18 @@
(0/1)
+
+
+
+ apps/server/src/modules/files-storage/files-storage.config.ts
+
+ variable
+ defaultConfig
+
+ 0 %
+ (0/1)
+
+
@@ -3787,6 +3799,30 @@
(0/1)
+
+
+
+ apps/server/src/modules/files-storage/helper/file-record.ts
+
+ function
+ getFormat
+
+ 0 %
+ (0/1)
+
+
+
+
+
+ apps/server/src/modules/files-storage/helper/file-record.ts
+
+ function
+ getPreviewName
+
+ 0 %
+ (0/1)
+
+
@@ -3928,7 +3964,7 @@
PreviewFileParams
0 %
- (0/7)
+ (0/8)
@@ -3991,6 +4027,18 @@
(0/7)
+
+
+
+ apps/server/src/modules/files-storage/mapper/preview.builder.ts
+
+ class
+ PreviewBuilder
+
+ 0 %
+ (0/3)
+
+
@@ -4036,7 +4084,7 @@
PreviewService
0 %
- (0/11)
+ (0/8)
@@ -15511,6 +15559,150 @@
(0/17)
+
+
+
+ apps/server/src/shared/infra/preview-generator/interface/preview-consumer-config.ts
+
+ interface
+ PreviewConfig
+
+ 0 %
+ (0/3)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/interface/preview-consumer-config.ts
+
+ interface
+ PreviewModuleConfig
+
+ 0 %
+ (0/3)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/interface/preview.ts
+
+ interface
+ PreviewFileOptions
+
+ 0 %
+ (0/4)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/interface/preview.ts
+
+ interface
+ PreviewOptions
+
+ 0 %
+ (0/3)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/interface/preview.ts
+
+ interface
+ PreviewResponseMessage
+
+ 0 %
+ (0/3)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/loggable/preview-actions.loggable.ts
+
+ class
+ PreviewActionsLoggable
+
+ 0 %
+ (0/3)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/preview-generator.builder.ts
+
+ class
+ PreviewGeneratorBuilder
+
+ 0 %
+ (0/2)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/preview-generator.consumer.ts
+
+ injectable
+ PreviewGeneratorConsumer
+
+ 0 %
+ (0/3)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/preview-generator.service.ts
+
+ injectable
+ PreviewGeneratorService
+
+ 0 %
+ (0/6)
+
+
+
+
+
+ apps/server/src/shared/infra/preview-generator/preview.producer.ts
+
+ injectable
+ PreviewProducer
+
+ 0 %
+ (0/6)
+
+
+
+
+
+ apps/server/src/shared/infra/rabbitmq/error.mapper.ts
+
+ class
+ ErrorMapper
+
+ 0 %
+ (0/2)
+
+
+
+
+
+ apps/server/src/shared/infra/rabbitmq/exchange/files-preview.ts
+
+ variable
+ FilesPreviewExchange
+
+ 0 %
+ (0/1)
+
+
@@ -15583,6 +15775,18 @@
(1/1)
+
+
+
+ apps/server/src/shared/infra/rabbitmq/rpc-message-producer.ts
+
+ class
+ RpcMessageProducer
+
+ 0 %
+ (0/5)
+
+
@@ -15664,7 +15868,7 @@
File
0 %
- (0/4)
+ (0/3)
diff --git a/entities/FileRecord.html b/entities/FileRecord.html
index c30c682d630..537fc36ac95 100644
--- a/entities/FileRecord.html
+++ b/entities/FileRecord.html
@@ -181,7 +181,7 @@
-
+
@@ -218,7 +218,7 @@
-
+
@@ -255,7 +255,7 @@
-
+
@@ -291,7 +291,7 @@
-
+
@@ -329,7 +329,7 @@
-
+
@@ -365,7 +365,7 @@
-
+
@@ -401,7 +401,7 @@
-
+
@@ -438,7 +438,7 @@
-
+
@@ -474,7 +474,7 @@
-
+
@@ -510,7 +510,7 @@
-
+
@@ -526,6 +526,7 @@
import { ObjectId } from '@mikro-orm/mongodb';
import { BadRequestException } from '@nestjs/common';
import { BaseEntityWithTimestamps, EntityId } from '@shared/domain';
+import path from 'path';
import { v4 as uuid } from 'uuid';
import { ErrorType } from '../error';
import { PreviewInputMimeTypes } from '../interface/preview-input-mime-types.enum';
@@ -817,6 +818,12 @@
return PreviewStatus.PREVIEW_NOT_POSSIBLE_SCAN_STATUS_ERROR;
}
+
+ public get fileNameWithoutExtension(): string {
+ const filenameObj = path.parse(this.name);
+
+ return filenameObj.name;
+ }
}