Merge pull request #94 from Lazztech/shosh-file-module-updates

Shosh file module updates

Author: shoshannaTM

package-lock.json

@@ -29,6 +29,7 @@
   },
   "dependencies": {
     "@apollo/server": "^4.10.4",
+    "@aws-sdk/client-s3": "^3.965.0",
     "@mikro-orm/better-sqlite": "^6.6.2",
     "@mikro-orm/core": "^6.6.2",
     "@mikro-orm/migrations": "^6.6.2",
@@ -46,11 +47,10 @@
     "@nestjs/platform-express": "^10.3.8",
     "@nestjs/schedule": "^4.0.2",
     "@nestjs/serve-static": "^4.0.2",
-    "@ntegral/nestjs-sentry": "^4.0.0",
+    "@ntegral/nestjs-sentry": "^4.0.0",    
     "@sentry/node": "^7.55.2",
     "@sentry/tracing": "^7.55.2",
     "adorable-avatars": "^0.5.0",
-    "aws-sdk": "^2.1397.0",
     "bcryptjs": "^2.4.3",
     "better-sqlite3": "^12.5.0",
     "class-transformer": "^0.5.1",
@@ -70,7 +70,7 @@
     "jpeg-js": "^0.4.4",
     "lodash": "^4.17.21",
     "nestjs-pino": "^3.3.0",
-    "nestjs-s3": "^1.0.1",
+    "nestjs-s3": "^3.0.1",
     "node-datetime": "^2.1.2",
     "nodemailer": "^6.9.3",
     "nodemailer-mailgun-transport": "^2.1.5",
@@ -105,7 +105,6 @@
     "@types/passport-local": "^1.0.35",
     "@types/sharp": "^0.31.1",
     "@types/supertest": "^2.0.12",
-    "@types/uuid": "^9.0.2",
     "@types/web-push": "^3.6.3",
     "@typescript-eslint/eslint-plugin": "^5.59.11",
     "@typescript-eslint/parser": "^5.59.11",

package.json

@@ -12,13 +12,13 @@ import { JoinUserHub } from '../dal/entity/joinUserHub.entity';
 import { JwtModule } from '@nestjs/jwt';
 import { S3Module, S3ModuleOptions } from 'nestjs-s3';
 import { ImageFileService } from '../file/image-file/image-file.service';
-import { FILE_SERVICE } from '../file/file-service.token';
 import { getRepositoryToken } from '@mikro-orm/nestjs';
 import { EntityManager, EntityRepository } from '@mikro-orm/core';
 import { Block } from '../dal/entity/block.entity';
 import { File } from '../dal/entity/file.entity';
 import { JoinEventFile } from '../dal/entity/joinEventFile.entity';
 import { JoinHubFile } from '../dal/entity/joinHubFile.entity';
+import { FileService } from '../file/file-service.abstract';
 
 describe('AuthService', () => {
   let service: AuthService;
@@ -55,7 +55,7 @@ describe('AuthService', () => {
         UserService,
         ImageFileService,
         {
-          provide: FILE_SERVICE,
+          provide: FileService,
           useClass: S3FileService,
         },
         {

src/auth/auth.service.spec.ts

@@ -1,7 +1,6 @@
 import { BeforeCreate, Property } from '@mikro-orm/core';
 import { Field, ObjectType } from '@nestjs/graphql';
-import { v4 as uuid } from 'uuid';
-
+import { randomUUID } from 'crypto';
 @ObjectType({ isAbstract: true })
 export abstract class ShareableId {
 
@@ -12,7 +11,7 @@ export abstract class ShareableId {
   // Only fires is repostiory.create is used for before save
   @BeforeCreate()
   public addId(){
-    this.shareableId = uuid();
+    this.shareableId = randomUUID();
   }
 
   @Property({ nullable: true })

src/dal/entity/shareableId.entity.ts

@@ -5,7 +5,6 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { ImageFileService } from '../file/image-file/image-file.service';
 import { Event } from '../dal/entity/event.entity';
 import { JoinUserEvent } from '../dal/entity/joinUserEvent.entity';
-import { FILE_SERVICE } from '../file/file-service.token';
 import { LocalFileService } from '../file/local-file/local-file.service';
 import { EventResolver } from './event.resolver';
 import { EventService } from './event.service';
@@ -18,6 +17,7 @@ import { File } from '../dal/entity/file.entity';
 import { EventGeofenceService } from './event-geofence/event-geofence.service';
 import { JoinEventFile } from '../dal/entity/joinEventFile.entity';
 import { EntityManager } from '@mikro-orm/core';
+import { FileService } from '../file/file-service.abstract';
 
 describe('EventResolver', () => {
   let resolver: EventResolver;
@@ -38,7 +38,7 @@ describe('EventResolver', () => {
         ImageFileService,
         NotificationService,
         {
-          provide: FILE_SERVICE,
+          provide: FileService,
           useClass: LocalFileService,
         },
         {

src/event/event.resolver.spec.ts

@@ -1,7 +1,6 @@
 import { getRepositoryToken } from '@mikro-orm/nestjs';
 import { EntityRepository } from '@mikro-orm/postgresql';
 import { Test, TestingModule } from '@nestjs/testing';
-import { FILE_SERVICE } from '../file/file-service.token';
 import { LocalFileService } from '../file/local-file/local-file.service';
 import { Event } from '../dal/entity/event.entity';
 import { JoinUserEvent } from '../dal/entity/joinUserEvent.entity';
@@ -16,6 +15,7 @@ import { UserDevice } from '../dal/entity/userDevice.entity';
 import { File } from '../dal/entity/file.entity';
 import { JoinEventFile } from '../dal/entity/joinEventFile.entity';
 import { EntityManager } from '@mikro-orm/core';
+import { FileService } from '../file/file-service.abstract';
 
 describe('EventService', () => {
   let service: EventService;
@@ -34,7 +34,7 @@ describe('EventService', () => {
         ImageFileService,
         NotificationService,
         {
-          provide: FILE_SERVICE,
+          provide: FileService,
           useClass: LocalFileService,
         },
         {

src/event/event.service.spec.ts

@@ -2,22 +2,21 @@ import { EntityManager, EntityRepository, QueryOrder } from '@mikro-orm/core';
 import { InjectRepository } from '@mikro-orm/nestjs';
 import { Inject, Injectable, Logger } from '@nestjs/common';
 import { FileUpload } from 'src/file/interfaces/file-upload.interface';
-import { v4 as uuid } from 'uuid';
 import { Event } from '../dal/entity/event.entity';
 import { JoinUserEvent, RSVP } from '../dal/entity/joinUserEvent.entity';
 import { User } from '../dal/entity/user.entity';
-import { FILE_SERVICE } from '../file/file-service.token';
-import { FileServiceInterface } from '../file/interfaces/file-service.interface';
 import { NotificationService } from '../notification/notification.service';
 import { JoinEventFile } from '../dal/entity/joinEventFile.entity';
+import { FileService } from '../file/file-service.abstract';
+import { randomUUID } from 'crypto';
 
 @Injectable()
 export class EventService {
     private readonly logger = new Logger(EventService.name);
 
     constructor(
-        @Inject(FILE_SERVICE)
-        private readonly fileService: FileServiceInterface,
+        @Inject()
+        private readonly fileService: FileService,
         @InjectRepository(JoinUserEvent)
         private readonly joinUserEventRepository: EntityRepository<JoinUserEvent>,
         @InjectRepository(Event)
@@ -182,7 +181,7 @@ export class EventService {
         if (createdBy?.id != userId) {
             throw new Error('Only the event creator can reset the shareable ID');
         }
-        event.shareableId = uuid();
+        event.shareableId = randomUUID();
         await this.em.persist(event).flush();
         return userEvent;
     }

src/event/event.service.ts

@@ -1,25 +1,37 @@
 import { ConfigService } from '@nestjs/config';
 import { Test, TestingModule } from '@nestjs/testing';
-import { FILE_SERVICE } from '../file-service.token';
 import { FileController } from './file.controller';
 import { ImageFileService } from '../image-file/image-file.service';
 import { LocalFileService } from '../local-file/local-file.service';
 import { getRepositoryToken } from '@mikro-orm/nestjs';
 import { File } from '../../dal/entity/file.entity';
 import { EntityManager, EntityRepository } from '@mikro-orm/core';
+import { FileService } from '../file-service.abstract';
+import fs from 'fs';
+
+jest.mock('fs');
 
 describe('FileController', () => {
   let controller: FileController;
 
   beforeEach(async () => {
+    (fs.existsSync as jest.Mock).mockReturnValue(true);
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    (fs.mkdirSync as jest.Mock).mockImplementation(() => {});
     const module: TestingModule = await Test.createTestingModule({
       controllers: [FileController],
       providers: [
         {
-          provide: FILE_SERVICE,
+          provide: FileService,
           useClass: LocalFileService,
         },
-        ConfigService,
+        {
+          provide: ConfigService,
+          useValue: {
+            get: jest.fn(() => ''),
+            getOrThrow: jest.fn(() => ''),
+          },
+        },
         ImageFileService,
         {
           provide: getRepositoryToken(File),

src/file/controller/file.controller.spec.ts

@@ -1,65 +1,37 @@
 import { Controller, Get, Header, Inject, Logger, Param, Res } from '@nestjs/common';
 import { Response } from 'express';
-import { join } from 'path';
-import sharp from 'sharp';
-import { FILE_SERVICE } from '../file-service.token';
 import { ImageFileService } from '../image-file/image-file.service';
-import { FileServiceInterface } from '../interfaces/file-service.interface';
+import { FileService } from '../file-service.abstract';
 
 @Controller('file')
 export class FileController {
   private logger = new Logger(FileController.name);
 
   constructor(
-    @Inject(FILE_SERVICE)
-    private readonly fileService: FileServiceInterface,
+    @Inject()
+    private readonly fileService: FileService,
     private readonly imageService: ImageFileService,
   ) {}
 
   @Get(':fileName')
   @Header('Cache-Control', 'public, max-age=86400') // public for CDN, max-age= 24hrs in seconds
-  get(@Param('fileName') fileName: string, @Res() response: Response) {
-    this.fileService.get(fileName).on('error', (err) => {
+  async get(@Param('fileName') fileName: string, @Res() response: Response) {
+    (await this.fileService.get(fileName)).on('error', (err) => {
       this.logger.error(err);
       response.status(500).send(err);
     }).pipe(response);
   }
 
-  @Get('watermark/:shareableId')
+    @Get('watermark/:shareableId')
   @Header('Cache-Control', 'public, max-age=86400') // public for CDN, max-age= 24hrs in seconds
   @Header('content-type', 'image/jpeg')
-  async watermark(@Param('shareableId') shareableId: string, @Res() response: Response) {
-    const watermark = await sharp(
-      join(process.cwd(), 'public', 'assets', 'lazztech_icon.webp')
-    ).resize(150, 150)
-      .extend({
-        top: 0,
-        bottom: 20,
-        left: 20,
-        right: 0,
-        background: { r: 0, g: 0, b: 0, alpha: 0 }
-      })
-      .composite([
-        {
-          input: Buffer.from([0, 0, 0, 200]),
-          raw: {
-            width: 1,
-            height: 1,
-            channels: 4,
-          },
-          tile: true,
-          blend: 'dest-in',
-        }
-      ]).toBuffer();
+  async watermark(
+    @Param('shareableId') shareableId: string,
+    @Res() response: Response,
+  ) {
     const fileStream = await this.fileService.getByShareableId(shareableId);
-    fileStream.pipe(
-      sharp()
-        .jpeg()
-        .resize(1080, 1080, { fit: sharp.fit.inside })
-        .composite([
-          { input: watermark, gravity: 'southwest' },
-        ])
-    ).pipe(response).on('error', (err) => {
+    const readable = await this.fileService.watermarkImage(fileStream);
+    readable?.pipe(response).on('error', (err) => {
       this.logger.error(err);
       response.status(500).send(err);
     });

src/file/controller/file.controller.ts

@@ -0,0 +1,70 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { join } from 'path';
+import sharp from 'sharp';
+import { File } from 'src/dal/entity/file.entity';
+import Stream, { Readable } from 'stream';
+import { FileServiceInterface } from './interfaces/file-service.interface';
+import { FileUpload } from './interfaces/file-upload.interface';
+
+@Injectable()
+export abstract class FileService implements FileServiceInterface {
+  public logger = new Logger(FileService.name);
+
+  public watermark: Promise<Buffer<ArrayBufferLike>>;
+
+  constructor(readonly configService: ConfigService) {}
+
+  abstract storeImageFromFileUpload(
+    upload: Promise<FileUpload> | FileUpload,
+    userId: any,
+  ): Promise<File>;
+  abstract delete(fileName: string): Promise<void>;
+  abstract deleteById(fileId: any, userId: any): Promise<any>;
+  abstract get(fileName: string): Promise<Readable>;
+  abstract getByShareableId(shareableId: string): Promise<Readable>;
+
+  async getWatermark() {
+    return sharp(
+      join(
+        process.cwd(),
+        'public',
+        'assets',
+        this.configService.getOrThrow('ICON_NAME'),
+      ),
+    )
+      .resize(150, 150)
+      .extend({
+        top: 0,
+        bottom: 20,
+        left: 20,
+        right: 0,
+        background: { r: 0, g: 0, b: 0, alpha: 0 },
+      })
+      .composite([
+        {
+          input: Buffer.from([0, 0, 0, 200]),
+          raw: {
+            width: 1,
+            height: 1,
+            channels: 4,
+          },
+          tile: true,
+          blend: 'dest-in',
+        },
+      ])
+      .toBuffer();
+  }
+
+  async watermarkImage(
+    fileStream: Stream.Readable | undefined,
+  ): Promise<Readable | undefined> {
+    const watermark = await this.getWatermark();
+    return fileStream?.pipe(
+      sharp()
+        .jpeg()
+        .resize(1080, 1080, { fit: sharp.fit.inside })
+        .composite([{ input: watermark, gravity: 'southwest' }]),
+    );
+  }
+}