Merge pull request #115 from DigiChanges/feat/GC/NRS-29/optimize-files

feat: optimize multipart files

Author: Murzbul

Dockerfile

@@ -1,6 +1,17 @@
 FROM node:16-alpine as dev
 
-RUN apk add bash dumb-init
+RUN apk add bash dumb-init curl
+RUN curl -s https://raw.githubusercontent.com/Intervox/node-webp/latest/bin/install_webp | bash
+RUN apk add --no-cache --update libwebp-tools
+RUN apk add --no-cache --update libpng-dev libjpeg-turbo-dev giflib-dev tiff-dev autoconf automake make gcc g++ wget
+RUN wget --no-check-certificate https://storage.googleapis.com/downloads.webmproject.org/releases/webp/libwebp-1.0.0.tar.gz && \
+      tar -xvzf libwebp-1.0.0.tar.gz && \
+      cd libwebp-1.0.0 && \
+      ./configure && \
+      make && \
+      make install && \
+      cd .. && \
+      rm -rf libwebp-1.0.0 libwebp-1.0.0.tar.gz
 
 WORKDIR /usr/app
 

package.json

@@ -44,6 +44,7 @@
     "compression": "^1.7.4",
     "config": "^3.3.8",
     "cors": "^2.8.5",
+    "cwebp": "^2.0.5",
     "dayjs": "^1.11.5",
     "dotenv": "^16.0.2",
     "envalid": "^7.3.1",

src/File/Domain/Entities/File.ts

@@ -22,7 +22,7 @@ class File extends Base implements IFileDomain
         this.setName(data?.hasOriginalName ?? false);
     }
 
-    private setName(hasOriginalName: boolean)
+    public setName(hasOriginalName: boolean)
     {
         this.name = this._id;
 

src/File/Domain/Entities/IFileDomain.ts

@@ -10,6 +10,7 @@ interface IFileDomain extends IBaseDomain
     size: number;
     version: number;
     isPublic: boolean;
+    setName(hasOriginalName: boolean): void;
 }
 
 export default IFileDomain;

src/File/Domain/Entities/IFileMultipart.ts

@@ -0,0 +1,13 @@
+interface IFileMultipart
+{
+    fieldname: string;
+    originalname: string;
+    encoding: string;
+    mimetype: string;
+    destination: string;
+    filename: string;
+    path: string;
+    size: number;
+}
+
+export default IFileMultipart;

src/File/Domain/Payloads/FileBase64RepPayload.ts

@@ -1,7 +1,6 @@
-import FileOptionsQueryPayload from './FileOptionsQueryPayload';
-import FileRepPayload from './FileRepPayload';
+import FilePayload from './FilePayload';
 
-interface FileBase64RepPayload extends FileRepPayload, FileOptionsQueryPayload
+interface FileBase64RepPayload extends FilePayload
 {
     base64: string,
 }

src/File/Domain/Payloads/FileMultipartRepPayload.ts

@@ -1,9 +1,9 @@
-import FileOptionsQueryPayload from './FileOptionsQueryPayload';
-import FileRepPayload from './FileRepPayload';
+import IFileMultipart from '../Entities/IFileMultipart';
+import FilePayload from './FilePayload';
 
-interface FileMultipartRepPayload extends FileRepPayload, FileOptionsQueryPayload
+interface FileMultipartRepPayload extends FilePayload
 {
-    file: any; // TODO: Add interface
+    file: IFileMultipart;
 }
 
 export default FileMultipartRepPayload;

src/File/Domain/Payloads/FileOptionsQueryPayload.ts

@@ -4,6 +4,7 @@ interface FileOptionsQueryPayload
     isOriginalName: boolean;
     isPublic: boolean;
     isOverwrite: boolean;
+    isOptimize: boolean;
 }
 
 export default FileOptionsQueryPayload;

src/File/Domain/Payloads/FilePayload.ts

@@ -0,0 +1,6 @@
+import FileRepPayload from './FileRepPayload';
+import FileOptionsQueryPayload from './FileOptionsQueryPayload';
+
+interface FilePayload extends FileRepPayload, FileOptionsQueryPayload {}
+
+export default FilePayload;

src/File/Domain/Payloads/FileRepPayload.ts

@@ -7,6 +7,7 @@ interface FileRepPayload
     extension: string;
     size: number;
     isPublic: boolean;
+    isImage: boolean;
 }
 
 export default FileRepPayload;

src/File/Domain/Services/FileService.ts

@@ -16,6 +16,17 @@ import IFileDTO from '../Models/IFileDTO';
 import { validate } from 'uuid';
 import { getRequestContext } from '../../../Shared/Presentation/Shared/RequestContext';
 import IFilesystem from '../../../Shared/Infrastructure/Filesystem/IFilesystem';
+// @ts-ignore
+import { CWebp } from 'cwebp';
+import IFileMultipart from '../Entities/IFileMultipart';
+import FileMultipartOptimizeDTO from '../../Presentation/Requests/FileMultipartOptimizeDTO';
+import FileBase64OptimizeDTO from '../../Presentation/Requests/FileBase64OptimizeDTO';
+import * as fs from 'fs';
+import FileUpdateMultipartPayload from '../Payloads/FileUpdateMultipartPayload';
+import FileUpdateMultipartOptimizeDTO from '../../Presentation/Requests/FileUpdateMultipartOptimizeDTO';
+import FileUpdateBase64Payload from '../Payloads/FileUpdateBase64Payload';
+import FileUpdateBase64OptimizeDTO from '../../Presentation/Requests/FileUpdateBase64OptimizeDTO';
+import FilePayload from '../Payloads/FilePayload';
 
 class FileService
 {
@@ -59,6 +70,14 @@ class FileService
         return await this.repository.save(file);
     }
 
+    async update(file: IFileDomain, payload: FilePayload): Promise<IFileDomain>
+    {
+        file.originalName = payload.originalName;
+        file.setName(payload.isOriginalName);
+
+        return await this.persist(file, payload);
+    }
+
     async uploadFileBase64(file: IFileDomain, payload: FileBase64RepPayload): Promise<any>
     {
         await this.fileSystem.uploadFileByBuffer(file, payload.base64);
@@ -130,6 +149,63 @@ class FileService
         void await this.fileSystem.removeObjects(file);
         return file;
     }
+
+    private async getFileMultipartOptimized(payload: FileMultipartRepPayload): Promise<IFileMultipart>
+    {
+        const encoder = CWebp(payload.file.path);
+        const newPath = payload.file.path.replace(payload.extension, 'webp');
+        await encoder.write(newPath);
+
+        return {
+            fieldname: payload.file.fieldname,
+            originalname: payload.file.originalname.replace(payload.extension, 'webp'),
+            encoding: payload.file.encoding,
+            mimetype: 'image/webp',
+            destination: payload.file.destination,
+            filename: payload.file.filename.replace(payload.extension, 'webp'),
+            path: newPath,
+            size: payload.size
+        };
+    }
+
+    private async getFileBase64Optimized(payload: FileBase64RepPayload): Promise<string>
+    {
+        const buffer = Buffer.from(payload.base64, 'base64');
+        const encoder = CWebp(buffer);
+        const newPath = '/tmp/converted.webp';
+        await encoder.write(newPath);
+
+        const buff = fs.readFileSync(newPath);
+        return buff.toString('base64');
+    }
+
+    async optimizeMultipartToUpload(payload: FileMultipartRepPayload): Promise<FileMultipartRepPayload>
+    {
+        const file = await this.getFileMultipartOptimized(payload);
+
+        return new FileMultipartOptimizeDTO(payload, file);
+    }
+
+    async optimizeMultipartToUpdate(payload: FileUpdateMultipartPayload): Promise<FileUpdateMultipartPayload>
+    {
+        const file = await this.getFileMultipartOptimized(payload);
+
+        return new FileUpdateMultipartOptimizeDTO(payload, file);
+    }
+
+    async optimizeBase64ToUpload(payload: FileBase64RepPayload): Promise<FileBase64RepPayload>
+    {
+        const base64data = await this.getFileBase64Optimized(payload);
+
+        return new FileBase64OptimizeDTO(payload, base64data);
+    }
+
+    async optimizeBase64ToUpdate(payload: FileUpdateBase64Payload): Promise<FileUpdateBase64Payload>
+    {
+        const base64data = await this.getFileBase64Optimized(payload);
+
+        return new FileUpdateBase64OptimizeDTO(payload, base64data);
+    }
 }
 
 export default FileService;

src/File/Domain/UseCases/UpdateFileBase64UseCase.ts

@@ -9,8 +9,14 @@ class UpdateFileBase64UseCase
     async handle(payload: FileUpdateBase64Payload): Promise<any>
     {
         const { id } = payload;
+
+        if (payload.isOptimize && payload.isImage)
+        {
+            payload = await this.fileService.optimizeBase64ToUpdate(payload);
+        }
+
         let file: IFileDomain = await this.fileService.getOne(id);
-        file = await this.fileService.persist(file, payload);
+        file = await this.fileService.update(file, payload);
         return await this.fileService.uploadFileBase64(file, payload);
     }
 }

src/File/Domain/UseCases/UpdateFileMultipartUseCase.ts

@@ -9,8 +9,14 @@ class UpdateFileMultipartUseCase
     async handle(payload: FileUpdateMultipartPayload): Promise<any>
     {
         const { id } = payload;
+
+        if (payload.isOptimize && payload.isImage)
+        {
+            payload = await this.fileService.optimizeMultipartToUpdate(payload);
+        }
+
         let file: IFileDomain = await this.fileService.getOne(id);
-        file = await this.fileService.persist(file, payload);
+        file = await this.fileService.update(file, payload);
         return await this.fileService.uploadFileMultipart(file, payload);
     }
 }

src/File/Domain/UseCases/UploadBase64UseCase.ts

@@ -9,6 +9,11 @@ class UploadBase64UseCase
 
     async handle(payload: FileBase64RepPayload): Promise<any>
     {
+        if (payload.isOptimize && payload.isImage)
+        {
+            payload = await this.fileService.optimizeBase64ToUpload(payload);
+        }
+
         const build = {
             hasOriginalName: payload.isOriginalName,
             originalName: payload.originalName

src/File/Domain/UseCases/UploadMultipartUseCase.ts

@@ -9,6 +9,11 @@ class UploadMultipartUseCase
 
     async handle(payload: FileMultipartRepPayload): Promise<any>
     {
+        if (payload.isOptimize && payload.isImage)
+        {
+            payload = await this.fileService.optimizeMultipartToUpload(payload);
+        }
+
         const build = {
             hasOriginalName: payload.isOriginalName,
             originalName: payload.originalName

src/File/Presentation/Handlers/FileExpressHandler.ts

@@ -148,7 +148,7 @@ class FileExpressHandler
     {
         const body = {
             file: req.file,
-            params: req.params,
+            query: req.query,
             id: req.params.id
         };
 

src/File/Presentation/Handlers/FileKoaHandler.ts

@@ -132,7 +132,7 @@ FileKoaHandler.put('/:id', <any>FileKoaReqMulterMiddleware.single('file'), Autho
 {
     const body = {
         file: ctx.request.file,
-        params: ctx.params,
+        query: ctx.query,
         id: ctx.params.id
     };
 

src/File/Presentation/Requests/FileBase64OptimizeDTO.ts

@@ -0,0 +1,62 @@
+import FileBase64RepPayload from '../../Domain/Payloads/FileBase64RepPayload';
+
+class FileBase64OptimizeDTO implements FileBase64RepPayload
+{
+    private readonly _req: FileBase64RepPayload;
+    private readonly _base64: string;
+
+    constructor(fileRequest: FileBase64RepPayload, _base64: string)
+    {
+        this._req = fileRequest;
+        this._base64 = _base64;
+    }
+
+    get extension(): string
+    {
+        return 'webp';
+    }
+
+    get base64(): string
+    {
+        return this._base64;
+    }
+    get isOptimize(): boolean
+    {
+        return this._req.isOptimize;
+    }
+    get isOriginalName(): boolean
+    {
+        return this._req.isOriginalName;
+    }
+    get isOverwrite(): boolean
+    {
+        return this._req.isOverwrite;
+    }
+    get isPublic(): boolean
+    {
+        return this._req.isPublic;
+    }
+    get mimeType(): string
+    {
+        return 'image/webp';
+    }
+    get originalName(): string
+    {
+        return this._req.originalName.replace(this._req.extension, 'webp');
+    }
+    get path(): string
+    {
+        return '/';
+    }
+    get size(): number
+    {
+        return this._req.size;
+    }
+
+    get isImage(): boolean
+    {
+        return this._req.isImage;
+    }
+}
+
+export default FileBase64OptimizeDTO;

src/File/Presentation/Requests/FileBase64RepRequest.ts

@@ -53,6 +53,11 @@ class FileBase64RepRequest extends FileOptionsQueryRequest implements FileBase64
     {
         return this._base64;
     }
+
+    get isImage(): boolean
+    {
+        return this._mimeType.includes('image');
+    }
 }
 
 export default FileBase64RepRequest;