feat: Add conditional check for updating file path in FilestorageService

Author: tacxou

src/_common/decorators/api-file-upload.decorator.ts

@@ -0,0 +1,49 @@
+import { applyDecorators, Type } from '@nestjs/common';
+import { ApiBody, ApiBodyOptions, ApiConsumes, ApiExtraModels, ApiOperationOptions, getSchemaPath } from '@nestjs/swagger';
+import { ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator';
+import { ApiBodyDecorator } from '~/_common/decorators/api-body.decorator';
+import { ApiCreatedResponseDecorator } from '~/_common/decorators/api-created-response.decorator';
+
+export const ApiFileUploadDecorator = <TModel extends Type<NonNullable<unknown>>>(
+  uploadModel: Type<NonNullable<unknown>>,
+  bodyModel: TModel,
+  responseModel: TModel,
+  options?: {
+    bodyOptions?: ApiBodyOptions | null | undefined,
+    responseOptions?: ApiResponseOptions | null | undefined,
+    operationOptions?: ApiOperationOptions | null | undefined,
+    consumesOptions?: string[],
+  },
+) => {
+  const consumes = options?.consumesOptions || ['multipart/form-data'];
+
+  return applyDecorators(
+    ApiExtraModels(uploadModel),
+    ApiExtraModels(bodyModel),
+    ApiBody({
+      schema: {
+        type: 'object',
+        allOf: [
+          { $ref: getSchemaPath(bodyModel) },
+          { $ref: getSchemaPath(uploadModel) },
+        ],
+        // properties: {
+        //   // comment: { type: 'string' },
+        //   // outletId: { type: 'integer' },
+
+        //   file: {
+        //     type: 'string',
+        //     format: 'binary',
+        //   },
+        // },
+      },
+      description: 'Corps de création de l\'enregistrement',
+      ...options?.bodyOptions,
+    }),
+    ApiCreatedResponseDecorator(responseModel, {
+      responseOptions: options?.responseOptions,
+      operationOptions: options?.operationOptions,
+    }),
+    ApiConsumes(...consumes),
+  );
+};

src/core/filestorage/_dto/filestorage.dto.ts

@@ -1,53 +1,59 @@
 import { ApiProperty, PartialType } from '@nestjs/swagger'
 import { CustomFieldsDto } from '~/_common/abstracts/dto/custom-fields.dto'
-import { IsMongoId, IsString, IsEnum, IsOptional, IsObject, IsBoolean, IsNotEmpty, IsMimeType } from 'class-validator'
+import { IsMongoId, IsString, IsEnum, IsOptional, IsObject, IsBoolean, IsNotEmpty, IsMimeType, Matches } from 'class-validator'
 import { FsType, FsTypeList } from '~/core/filestorage/_enum/fs-type.enum'
 import { MixedValue } from '~/_common/types/mixed-value.type'
 
+export class FileUploadDto {
+  @ApiProperty({ type: 'string', format: 'binary' })
+  public file: string
+}
+
 export class FilestorageCreateDto extends CustomFieldsDto {
   @IsEnum(FsTypeList)
   @IsNotEmpty()
-  @ApiProperty({ enum: FsTypeList })
+  @ApiProperty({ enum: FsTypeList, default: FsType.FILE, })
   public type: FsType
 
   @IsString()
   @IsNotEmpty()
-  @ApiProperty()
+  @ApiProperty({ type: String, required: true })
   public namespace: string
 
   @IsString()
   @IsNotEmpty()
-  @ApiProperty()
+  @ApiProperty({ type: String, default: '/' })
+  @Matches(/^\/(\.?[^\/\0]+\/?)+$/, { message: 'Path must be a valid path' })
   public path: string
 
   @IsOptional()
   @IsMongoId()
-  @ApiProperty({ type: String })
+  @ApiProperty({ type: String, required: false })
   public linkedTo?: string
 
   @IsOptional()
   @IsString()
-  @ApiProperty()
+  @ApiProperty({ type: String, required: false })
   public comments?: string
 
   @IsOptional()
   @IsMimeType()
-  @ApiProperty()
+  @ApiProperty({ type: String, required: false })
   public mime?: string
 
   @IsOptional()
   @IsBoolean()
-  @ApiProperty()
+  @ApiProperty({ type: Boolean, required: false })
   public hidden?: boolean
 
   @IsOptional()
   @IsObject()
-  @ApiProperty({ type: Object })
+  @ApiProperty({ type: String, required: false, nullable: true })
   public tags?: { [key: string]: MixedValue }
 
   @IsOptional()
   @IsObject()
-  @ApiProperty({ type: Object })
+  @ApiProperty({ type: String, required: false, nullable: true })
   public acls?: { [key: string]: any } // eslint-disable-line
 }
 

src/core/filestorage/filestorage.controller.ts

@@ -1,6 +1,6 @@
-import { Body, Controller, Delete, Get, HttpStatus, Param, ParseFilePipe, Patch, Post, Query, Res, UploadedFile, UseInterceptors } from '@nestjs/common'
+import { Body, Controller, Delete, Get, HttpStatus, Param, ParseBoolPipe, ParseFilePipe, Patch, Post, Query, Res, UploadedFile, UseInterceptors } from '@nestjs/common'
 import { FileInterceptor } from '@nestjs/platform-express'
-import { ApiParam, ApiTags } from '@nestjs/swagger'
+import { ApiBody, ApiConsumes, ApiOperation, ApiParam, ApiProduces, ApiTags, getSchemaPath } from '@nestjs/swagger'
 import { FilterOptions, FilterSchema, ObjectIdValidationPipe, SearchFilterOptions, SearchFilterSchema } from '@the-software-compagny/nestjs_module_restools'
 import { Response } from 'express'
 import { Types } from 'mongoose'
@@ -12,11 +12,12 @@ import { ApiReadResponseDecorator } from '~/_common/decorators/api-read-response
 import { ApiUpdateDecorator } from '~/_common/decorators/api-update.decorator'
 import { PickProjectionHelper } from '~/_common/helpers/pick-projection.helper'
 import { PartialProjectionType } from '~/_common/types/partial-projection.type'
-import { FilestorageCreateDto, FilestorageDto, FilestorageUpdateDto } from './_dto/filestorage.dto'
+import { FilestorageCreateDto, FilestorageDto, FilestorageUpdateDto, FileUploadDto } from './_dto/filestorage.dto'
 import { TransformersFilestorageService } from './_services/transformers-filestorage.service'
 import { FilestorageService } from './filestorage.service'
+import { ApiFileUploadDecorator } from '~/_common/decorators/api-file-upload.decorator'
 
-@ApiTags('core')
+@ApiTags('default')
 @Controller('filestorage')
 export class FilestorageController extends AbstractController {
   protected static readonly projection: PartialProjectionType<FilestorageDto> = {
@@ -32,7 +33,7 @@ export class FilestorageController extends AbstractController {
 
   @Post()
   @UseInterceptors(FileInterceptor('file'))
-  @ApiCreateDecorator(FilestorageCreateDto, FilestorageDto)
+  @ApiFileUploadDecorator(FileUploadDto, FilestorageCreateDto, FilestorageDto)
   public async create(
     @Res() res: Response,
     @Body() body: FilestorageCreateDto,
@@ -47,8 +48,21 @@ export class FilestorageController extends AbstractController {
 
   @Get()
   @ApiPaginatedDecorator(PickProjectionHelper(FilestorageDto, FilestorageController.projection))
-  public async search(@Res() res: Response, @SearchFilterSchema() searchFilterSchema: FilterSchema, @SearchFilterOptions() searchFilterOptions: FilterOptions): Promise<Response> {
-    const [data, total] = await this._service.findAndCount(searchFilterSchema, FilestorageController.projection, searchFilterOptions)
+  public async search(
+    @Res() res: Response,
+    @SearchFilterSchema() searchFilterSchema: FilterSchema,
+    @SearchFilterOptions() searchFilterOptions: FilterOptions,
+    @Query('hidden') hiddenQuery: string,
+  ): Promise<Response> {
+    const hidden = /true|on|yes|1/i.test(hiddenQuery);
+    const extraSearch = { hidden: { $ne: true } }
+    if (hidden) delete extraSearch['hidden']
+
+    const [data, total] = await this._service.findAndCount({
+      ...extraSearch,
+      ...searchFilterSchema,
+    }, FilestorageController.projection, searchFilterOptions)
+
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,
       total,

src/core/filestorage/filestorage.service.ts

@@ -44,14 +44,20 @@ export class FilestorageService extends AbstractServiceSchema {
       const basePath = this.reservedChars.reduce((acc, char) => {
         if (char === EMBED_SEPARATOR) return acc
         return acc.replace(char, '_')
-      }, payload.path.replace(/^\//, '').replace(/\.\.\//g, ''))
-      const partPath = ['', basePath]
+      }, payload.path.replace(/(?<!^)\/{2,}|(?<!\/)\/+$/, ''))
+      const partPath = [basePath]
       // noinspection ExceptionCaughtLocallyJS
       switch (data.type) {
         case FsType.FILE: {
+          console.log('basePath', basePath)
+          console.log('hasFileExtension', hasFileExtension(basePath))
           if (!basePath || !hasFileExtension(basePath)) {
             partPath.push(file.originalname)
           }
+          const exists = await this.storage.getDisk(data.namespace).exists(partPath.join('/'))
+          if (exists.exists) {
+            throw new BadRequestException(`File ${partPath.join('/')} already exists`)
+          }
           payload.mime = data.mime || file.mimetype
           await this.storage.getDisk(data.namespace).put(partPath.join('/'), file.buffer)
           break
@@ -150,7 +156,10 @@ export class FilestorageService extends AbstractServiceSchema {
           throw e
         }
       })
+    } else {
+      updated = await super.update(_id, update, options)
     }
+
     return updated
   }
   /* eslint-enable */