Fixes after code review (2024-05-07)

packages/apps/human-app/server/.env.example

@@ -1,8 +1,9 @@
 HOST= # string, example: localhost
 PORT= # number, example: 5010
 REPUTATION_ORACLE_URL= # string
-REDIS_PORT= # string, example: localhost
-REDIS_HOST= # number, example: 6379
+REPUTATION_ORACLE_ADDRESS= # string
+REDIS_HOST= # string, example: localhost
+REDIS_PORT= # number, example: 6379
 CACHE_TTL_ORACLE_DISCOVERY= # number, example: 43200
 CACHE_TTL_ORACLE_STATS= # number, example: 900
 CACHE_TTL_USER_STATS= # number, example: 86400

packages/apps/human-app/server/README.md

@@ -61,7 +61,7 @@ and transformation of data. NestJS provides many built-in pipes, so check the do
 
 ### Model 
 
-Interfaces are used to define the shape and responsibilities of the data:
+Models are used to define the shape and responsibilities of the data:
 
 - **Dto (Data Transfer Object)**: Data sent from/to the frontend.
 - **Command**: Datatype used for data manipulation in business logic.

packages/apps/human-app/server/docker-compose.yml

@@ -16,9 +16,11 @@ services:
       HOST: ${HOST}
       PORT: ${PORT}
       REPUTATION_ORACLE_URL: ${REPUTATION_ORACLE_URL}
+      REPUTATION_ORACLE_ADDRESS: ${REPUTATION_ORACLE_ADDRESS}
       REDIS_PORT: ${REDIS_PORT}
       REDIS_HOST: redis
       CACHE_TTL_ORACLE_DISCOVERY: ${CACHE_TTL_ORACLE_DISCOVERY}
+      RPC_URL: ${RPC_URL}
     depends_on:
       - redis
   redis:
@@ -27,6 +29,4 @@ services:
     ports:
       - '${REDIS_PORT}:6379'
     volumes:
-      - redis_data:/data
-volumes:
-  redis_data:
+      - redis_data:/data

packages/apps/human-app/server/package.json

@@ -32,6 +32,8 @@
     "@nestjs/platform-express": "^10.2.6",
     "@nestjs/swagger": "^7.1.13",
     "cache-manager": "^5.4.0",
+    "cache-manager-redis-store": "^3.0.1",
+    "ioredis": "^5.3.2",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
     "ethers": "^6.11.0",
@@ -40,7 +42,6 @@
     "rxjs": "^7.2.0"
   },
   "devDependencies": {
-    "@nestjs/cache-manager": "^2.2.1",
     "@nestjs/cli": "^9.4.3",
     "@nestjs/schematics": "^9.2.0",
     "@nestjs/testing": "^9.4.3",
@@ -50,11 +51,9 @@
     "@types/supertest": "^2.0.15",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
-    "cache-manager-redis-store": "^3.0.1",
     "eslint": "^8.55.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "ioredis": "^5.3.2",
     "jest": "29.5.0",
     "nock": "^13.5.1",
     "prettier": "^3.1.1",

packages/apps/human-app/server/src/app.module.ts

@@ -22,12 +22,23 @@ import { StatisticsModule } from './modules/statistics/statistics.module';
 import { StatisticsController } from './modules/statistics/statistics.controller';
 import { ExchangeOracleModule } from './integrations/exchange-oracle/exchange-oracle.module';
 import { KvStoreModule } from './integrations/kv-store/kv-store.module';
+import { EscrowUtilsModule } from './integrations/escrow/escrow-utils.module';
+import Joi from 'joi';
 
 @Module({
   imports: [
     ConfigModule.forRoot({
       envFilePath: '.env',
       isGlobal: true,
+      validationSchema: Joi.object({
+        HOST: Joi.string().required(),
+        PORT: Joi.number().required(),
+        REPUTATION_ORACLE_URL: Joi.string().required(),
+        REPUTATION_ORACLE_ADDRESS: Joi.string().required(),
+        REDIS_PORT: Joi.number().required(),
+        REDIS_HOST: Joi.string().required(),
+        RPC_URL: Joi.string().required(),
+      }),
     }),
     AutomapperModule.forRoot({
       strategyInitializer: classes(),
@@ -44,6 +55,7 @@ import { KvStoreModule } from './integrations/kv-store/kv-store.module';
     OracleDiscoveryModule,
     StatisticsModule,
     KvStoreModule,
+    EscrowUtilsModule,
   ],
   controllers: [
     AppController,

packages/apps/human-app/server/src/common/config/environment-config.service.ts

@@ -1,6 +1,5 @@
 import { ConfigService } from '@nestjs/config';
 import { Injectable } from '@nestjs/common';
-import { EnvironmentVariableMissingError } from '../interfaces/custom-exceptions.interface';
 const DEFAULT_CACHE_TTL_ORACLE_STATS = 12 * 60 * 60;
 const DEFAULT_CACHE_TTL_USER_STATS = 15 * 60;
 const DEFAULT_CACHE_TTL_ORACLE_DISCOVERY = 24 * 60 * 60;
@@ -10,21 +9,22 @@ const DEFAULT_CORS_ALLOWED_HEADERS = 'Content-Type, Accept';
 export class EnvironmentConfigService {
   constructor(private configService: ConfigService) {}
   get host(): string {
-    return this.conditionallyReturnMandatoryEnvVariable<string>('HOST');
+    return this.configService.getOrThrow<string>('HOST');
   }
   get port(): number {
-    return this.conditionallyReturnMandatoryEnvVariable<number>('PORT');
+    return this.configService.getOrThrow<number>('PORT');
   }
   get reputationOracleUrl(): string {
-    return this.conditionallyReturnMandatoryEnvVariable<string>(
-      'REPUTATION_ORACLE_URL',
-    );
+    return this.configService.getOrThrow<string>('REPUTATION_ORACLE_URL');
+  }
+  get reputationOracleAddress(): string {
+    return this.configService.getOrThrow<string>('REPUTATION_ORACLE_ADDRESS');
   }
   get cachePort(): number {
-    return this.conditionallyReturnMandatoryEnvVariable<number>('REDIS_PORT');
+    return this.configService.getOrThrow<number>('REDIS_PORT');
   }
   get cacheHost(): string {
-    return this.conditionallyReturnMandatoryEnvVariable<string>('REDIS_HOST');
+    return this.configService.getOrThrow<string>('REDIS_HOST');
   }
   get cacheTtlOracleStats(): number {
     return this.configService.get<number>(
@@ -47,7 +47,7 @@ export class EnvironmentConfigService {
     );
   }
   get rpcUrl(): string {
-    return this.conditionallyReturnMandatoryEnvVariable<string>('RPC_URL');
+    return this.configService.getOrThrow<string>('RPC_URL');
   }
   get isCorsEnabled(): boolean {
     return this.configService.get<boolean>('CORS_ENABLED', false);
@@ -61,35 +61,7 @@ export class EnvironmentConfigService {
   get corsAllowedHeaders(): string {
     return this.configService.get<string>(
       'CORS_ALLOWED_HEADERS',
-      DEFAULT_CORS_ALLOWED_HEADERS
+      DEFAULT_CORS_ALLOWED_HEADERS,
     );
   }
-  conditionallyReturnMandatoryEnvVariable<T>(envName: string): T {
-    const value = this.configService.get<T>(envName);
-    if (!value) {
-      throw new EnvironmentVariableMissingError(envName);
-    }
-    return value;
-  }
-  checkMandatoryConfig(): void {
-    const mandatoryVariables = [
-      'HOST',
-      'PORT',
-      'REPUTATION_ORACLE_URL',
-      'REDIS_PORT',
-      'REDIS_HOST',
-      'RPC_URL',
-    ];
-    const missingVariables: string[] = [];
-
-    mandatoryVariables.forEach((variable) => {
-      if (!this.configService.get(variable)) {
-        missingVariables.push(variable);
-      }
-    });
-
-    if (missingVariables.length > 0) {
-      throw new EnvironmentVariableMissingError(missingVariables.join(', '));
-    }
-  }
 }

packages/apps/human-app/server/src/common/interfaces/pageable.interface.ts → packages/apps/human-app/server/src/common/utils/pageable.model.ts

@@ -1,7 +1,7 @@
 import { ApiPropertyOptional } from '@nestjs/swagger';
 import { Type } from 'class-transformer';
 import { IsEnum, IsNumber, IsOptional, Max, Min } from 'class-validator';
-import { SortOrder } from '../enums/global-common.interface';
+import { SortOrder } from '../enums/global-common';
 import { AutoMap } from '@automapper/classes';
 
 export abstract class PageableDto {

packages/apps/human-app/server/src/integrations/escrow/escrow-utils-gateway.service.ts

@@ -0,0 +1,16 @@
+import { Injectable, NotFoundException } from '@nestjs/common';
+import { ChainId, EscrowUtils } from '@human-protocol/sdk';
+
+@Injectable()
+export class EscrowUtilsGateway {
+  async getExchangeOracleAddressByEscrowAddress(
+    chainId: ChainId,
+    address: string,
+  ): Promise<string> {
+    const escrowsData = await EscrowUtils.getEscrow(chainId, address);
+    if (!escrowsData.exchangeOracle) {
+      throw new NotFoundException('Exchange Oracle not found');
+    }
+    return escrowsData.exchangeOracle;
+  }
+}

packages/apps/human-app/server/src/integrations/escrow/escrow-utils.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { EscrowUtilsGateway } from './escrow-utils-gateway.service';
+
+@Module({
+  providers: [EscrowUtilsGateway],
+  exports: [EscrowUtilsGateway],
+})
+export class EscrowUtilsModule {}

packages/apps/human-app/server/src/integrations/escrow/spec/escrow-utils-gateway.spec.ts

@@ -0,0 +1,67 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { EscrowUtilsGateway } from '../escrow-utils-gateway.service';
+import { EscrowUtils, ChainId } from '@human-protocol/sdk';
+import { NotFoundException } from '@nestjs/common';
+
+jest.mock('@human-protocol/sdk', () => {
+  return {
+    EscrowUtils: {
+      getEscrow: jest.fn().mockResolvedValue({
+        exchangeOracle: '0x',
+      }),
+    },
+    ChainId: {
+      POLYGON_AMOY: 1,
+    },
+  };
+});
+
+describe('EscrowUtilsGateway', () => {
+  let service: EscrowUtilsGateway;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [EscrowUtilsGateway],
+    }).compile();
+
+    service = module.get<EscrowUtilsGateway>(EscrowUtilsGateway);
+  });
+
+  afterEach(async () => {
+    jest.restoreAllMocks();
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+
+  describe('getExchangeOracleAddressByEscrowAddress', () => {
+    it('should fetch data from EscrowUtils', async () => {
+      const escrowAddress = 'escrowAddress';
+      const expectedUrl = '0x';
+
+      const result = await service.getExchangeOracleAddressByEscrowAddress(
+        ChainId.POLYGON_AMOY,
+        escrowAddress,
+      );
+      expect(EscrowUtils.getEscrow).toHaveBeenCalledWith(
+        ChainId.POLYGON_AMOY,
+        escrowAddress,
+      );
+      expect(result).toBe(expectedUrl);
+    });
+
+    it('should throw error if Exchange Oracle not found', async () => {
+      const escrowAddress = 'escrowAddress';
+
+      (EscrowUtils.getEscrow as jest.Mock).mockResolvedValue({});
+
+      await expect(
+        service.getExchangeOracleAddressByEscrowAddress(
+          ChainId.POLYGON_AMOY,
+          escrowAddress,
+        ),
+      ).rejects.toThrow(new NotFoundException('Exchange Oracle not found'));
+    });
+  });
+});

packages/apps/human-app/server/src/integrations/exchange-oracle/exchange-oracle.gateway.ts

@@ -77,7 +77,6 @@ export class ExchangeOracleGateway {
   async fetchAssignedJobs(
     details: JobsFetchParamsDetails,
   ): Promise<JobsFetchResponse> {
-    console.log("Details: ", details);
     const jobFetchParamsData = this.mapper.map(
       details.data,
       JobsFetchParams,

packages/apps/human-app/server/src/integrations/exchange-oracle/spec/exchange-oracle.gateway.spec.ts

@@ -3,7 +3,7 @@ import { HttpService } from '@nestjs/axios';
 import { ExchangeOracleGateway } from '../exchange-oracle.gateway';
 import {
   oracleStatsDetailsFixture,
-  statisticsExchangeOracleAddress, statisticsExchangeOracleUrl,
+  statisticsExchangeOracleUrl,
   userStatsDetailsFixture,
 } from '../../../modules/statistics/spec/statistics.fixtures';
 import { AutomapperModule } from '@automapper/nestjs';

packages/apps/human-app/server/src/integrations/kv-store/kv-store-gateway.service.ts

@@ -1,11 +1,11 @@
-import { Injectable, OnModuleInit } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import { EnvironmentConfigService } from '../../common/config/environment-config.service';
 import { ethers } from 'ethers';
-import { KVStoreClient } from '@human-protocol/sdk';
+import { KVStoreClient, KVStoreKeys } from '@human-protocol/sdk';
 
 @Injectable()
 export class KvStoreGateway {
-  private URL_KEY = 'url';
+  private URL_KEY = KVStoreKeys.url;
   private kvStoreClient: KVStoreClient;
   constructor(private environmentConfig: EnvironmentConfigService) {}
   async onModuleInit(): Promise<void> {

packages/apps/human-app/server/src/integrations/kv-store/spec/kv-store.gateway.spec.ts

@@ -1,18 +1,22 @@
 import { Test, TestingModule } from '@nestjs/testing';
-import { KVStoreClient } from '@human-protocol/sdk';
+import { KVStoreClient, KVStoreKeys } from '@human-protocol/sdk';
 import { KvStoreGateway } from '../kv-store-gateway.service';
 import { EnvironmentConfigService } from '../../../common/config/environment-config.service';
 import { ethers } from 'ethers';
 
-jest.mock('@human-protocol/sdk', () => ({
-  KVStoreClient: {
-    build: jest.fn().mockImplementation(() =>
-      Promise.resolve({
-        get: jest.fn().mockResolvedValue('https://example.com'),
-      }),
-    ),
-  },
-}));
+jest.mock('@human-protocol/sdk', () => {
+  const actualSdk = jest.requireActual('@human-protocol/sdk');
+  return {
+    ...actualSdk,
+    KVStoreClient: {
+      build: jest.fn().mockImplementation(() =>
+        Promise.resolve({
+          get: jest.fn().mockResolvedValue('https://example.com'),
+        }),
+      ),
+    },
+  };
+});
 
 describe('KvStoreGateway', () => {
   let service: KvStoreGateway;
@@ -72,7 +76,7 @@ describe('KvStoreGateway', () => {
 
       expect(service['kvStoreClient'].get).toHaveBeenCalledWith(
         testAddress,
-        'url',
+        KVStoreKeys.url,
       );
 
       expect(result).toBe(expectedUrl);

packages/apps/human-app/server/src/main.ts

@@ -12,7 +12,6 @@ async function bootstrap() {
 
   const configService: ConfigService = app.get(ConfigService);
   const envConfigService = new EnvironmentConfigService(configService);
-  envConfigService.checkMandatoryConfig();
   if (envConfigService.isCorsEnabled) {
     app.enableCors({
       origin: envConfigService.corsEnabledOrigin,

packages/apps/human-app/server/src/modules/job-assignment/job-assignment.controller.ts

@@ -2,7 +2,6 @@ import {
   Body,
   Controller,
   Get,
-  Headers,
   Post,
   Query,
   UsePipes,

packages/apps/human-app/server/src/modules/job-assignment/job-assignment.module.ts

@@ -3,9 +3,10 @@ import { JobAssignmentProfile } from './job-assignment.mapper';
 import { Module } from '@nestjs/common';
 import { ExchangeOracleModule } from '../../integrations/exchange-oracle/exchange-oracle.module';
 import { KvStoreModule } from '../../integrations/kv-store/kv-store.module';
+import { EscrowUtilsModule } from '../../integrations/escrow/escrow-utils.module';
 
 @Module({
-  imports: [ExchangeOracleModule, KvStoreModule],
+  imports: [ExchangeOracleModule, KvStoreModule, EscrowUtilsModule],
   providers: [JobAssignmentService, JobAssignmentProfile],
   exports: [JobAssignmentService],
 })