Static service refactored to support different implementations (#321)

* Static service refactored to support different implementations

Author: pashidlos

.env

@@ -12,6 +12,14 @@ POSTGRES_USER=postgres
 POSTGRES_PASSWORD=postgres
 POSTGRES_DB=vrt_db_dev
 
+# static 
+STATIC_SERVICE=hdd # hdd | s3 - hdd as default if not provided
+
+# AWS_ACCESS_KEY_ID=
+# AWS_SECRET_ACCESS_KEY=
+# AWS_REGION=
+# AWS_S3_BUCKET_NAME=
+
 # optional
 #HTTPS_KEY_PATH='./secrets/ssl.key'
 #HTTPS_CERT_PATH='./secrets/ssl.cert'

.vscode/settings.json

@@ -3,5 +3,6 @@
         "**/.git/objects/**": true,
         "**/.git/subtree-cache/**": true,
         "**/.hg/store/**": true
-    }
+    },
+    "jest.runMode":"on-demand"
 }

package-lock.json

@@ -67,7 +67,6 @@
     "@nestjs/testing": "^10.2.5",
     "@types/bcryptjs": "^2.4.4",
     "@types/cache-manager": "^3.4.3",
-    "@types/cron": "^2.4.0",
     "@types/express": "^4.17.17",
     "@types/jest": "^29.5.5",
     "@types/lodash": "^4.14.198",

package.json

@@ -3,9 +3,11 @@ import { CompareService } from './compare.service';
 import { LookSameService } from './libs/looks-same/looks-same.service';
 import { OdiffService } from './libs/odiff/odiff.service';
 import { PixelmatchService } from './libs/pixelmatch/pixelmatch.service';
+import { StaticModule } from '../static/static.module';
 
 @Module({
   providers: [CompareService, PixelmatchService, LookSameService, OdiffService],
+  imports: [StaticModule],
   exports: [CompareService],
 })
 export class CompareModule {}

src/compare/compare.module.ts

@@ -1,17 +1,18 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { PrismaService } from '../prisma/prisma.service';
-import { StaticService } from '../shared/static/static.service';
 import { CompareService } from './compare.service';
 import { LookSameService } from './libs/looks-same/looks-same.service';
 import { OdiffService } from './libs/odiff/odiff.service';
 import { PixelmatchService } from './libs/pixelmatch/pixelmatch.service';
+import { StaticModule } from '../static/static.module';
 
 describe('CompareService', () => {
   let service: CompareService;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
-      providers: [CompareService, OdiffService, PixelmatchService, LookSameService, StaticService, PrismaService],
+      providers: [CompareService, OdiffService, PixelmatchService, LookSameService, PrismaService],
+      imports: [StaticModule],
     }).compile();
 
     service = module.get<CompareService>(CompareService);

src/compare/compare.service.spec.ts

@@ -1,7 +1,7 @@
 import { TestingModule, Test } from '@nestjs/testing';
 import { TestStatus } from '@prisma/client';
 import { PNG } from 'pngjs';
-import { StaticService } from '../../../shared/static/static.service';
+import { StaticService } from '../../../static/static.service';
 import { DIFF_DIMENSION_RESULT, EQUAL_RESULT, NO_BASELINE_RESULT } from '../consts';
 import { DEFAULT_CONFIG, LookSameService } from './looks-same.service';
 import { LooksSameConfig } from './looks-same.types';

src/compare/libs/looks-same/looks-same.service.spec.ts

@@ -1,7 +1,7 @@
 import { Injectable, Logger } from '@nestjs/common';
 import { TestStatus } from '@prisma/client';
 import { PNG } from 'pngjs';
-import { StaticService } from '../../../shared/static/static.service';
+import { StaticService } from '../../../static/static.service';
 import { DiffResult } from '../../../test-runs/diffResult';
 import { applyIgnoreAreas, parseConfig } from '../../utils';
 import { ImageComparator } from '../image-comparator.interface';
@@ -32,8 +32,8 @@ export class LookSameService implements ImageComparator {
       ...NO_BASELINE_RESULT,
     };
 
-    const baseline = this.staticService.getImage(data.baseline);
-    const image = this.staticService.getImage(data.image);
+    const baseline = await this.staticService.getImage(data.baseline);
+    const image = await this.staticService.getImage(data.image);
 
     if (!baseline) {
       return NO_BASELINE_RESULT;

src/compare/libs/looks-same/looks-same.service.ts

@@ -1,7 +1,7 @@
 import { TestingModule, Test } from '@nestjs/testing';
 import { TestStatus } from '@prisma/client';
 import { IgnoreAreaDto } from 'src/test-runs/dto/ignore-area.dto';
-import { StaticService } from '../../../shared/static/static.service';
+import { StaticService } from '../../../static/static.service';
 import { DIFF_DIMENSION_RESULT, NO_BASELINE_RESULT } from '../consts';
 import { OdiffService, DEFAULT_CONFIG, ignoreAreaToRegionMapper } from './odiff.service';
 import { OdiffConfig, OdiffIgnoreRegions } from './odiff.types';

src/compare/libs/odiff/odiff.service.spec.ts

@@ -1,6 +1,6 @@
 import { Injectable, Logger } from '@nestjs/common';
 import { TestStatus } from '@prisma/client';
-import { StaticService } from '../../../shared/static/static.service';
+import { StaticService } from '../../../static/static.service';
 import { DiffResult } from '../../../test-runs/diffResult';
 import { parseConfig } from '../../utils';
 import { ImageComparator } from '../image-comparator.interface';
@@ -9,6 +9,8 @@ import { DIFF_DIMENSION_RESULT, NO_BASELINE_RESULT } from '../consts';
 import { compare } from 'odiff-bin';
 import { IgnoreAreaDto } from 'src/test-runs/dto/ignore-area.dto';
 import { OdiffConfig, OdiffIgnoreRegions, OdiffResult } from './odiff.types';
+import { HddService } from 'src/static/hdd/hdd.service';
+import { isHddStaticServiceConfigured } from '../../../static/utils';
 
 export const DEFAULT_CONFIG: OdiffConfig = {
   outputDiffMask: true,
@@ -20,8 +22,14 @@ export const DEFAULT_CONFIG: OdiffConfig = {
 @Injectable()
 export class OdiffService implements ImageComparator {
   private readonly logger: Logger = new Logger(OdiffService.name);
+  private readonly hddService: HddService;
 
-  constructor(private staticService: StaticService) {}
+  constructor(private staticService: StaticService) {
+    if (!isHddStaticServiceConfigured()) {
+      throw new Error('OdiffService can only be used with HddService');
+    }
+    this.hddService = this.staticService as unknown as HddService;
+  }
 
   parseConfig(configJson: string): OdiffConfig {
     return parseConfig(configJson, DEFAULT_CONFIG, this.logger);
@@ -37,10 +45,10 @@ export class OdiffService implements ImageComparator {
     }
 
     // compare
-    const diff = this.staticService.generateNewImage('diff');
+    const diff = this.hddService.generateNewImage('diff');
     const compareResult = (await compare(
-      this.staticService.getImagePath(data.baseline),
-      this.staticService.getImagePath(data.image),
+      this.hddService.getImagePath(data.baseline),
+      this.hddService.getImagePath(data.image),
       diff.imagePath,
       {
         ...config,