[Human App] Implemented register worker (#2315)

* Implemeted register worker

* Removed .env file

* Implemented registration_needed flag

* Lint human app

* Updated authorization headers

* Resolved comments

* Lint human app

* Updated unit tests

* Revert reputation oracle changes

* Removed the registration required check

* update endpoint summary

---------

Co-authored-by: portuu3 <adrian.portugues.mas@gmail.com>

Author: eugenvoronov

packages/apps/human-app/server/.gitignore

@@ -35,4 +35,7 @@ lerna-debug.log*
 !.vscode/extensions.json
 
 # Redis Data
-./redis_data
+./redis_data
+
+.env.development
+.env.production

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

@@ -9,6 +9,7 @@ const DEFAULT_CORS_ALLOWED_ORIGIN = 'http://localhost:5173';
 const DEFAULT_CORS_ALLOWED_HEADERS =
   'Content-Type,Authorization,X-Requested-With,Accept,Origin';
 const DEFAULT_CACHE_TTL_EXCHANGE_ORACLE_URL = 24 * 60 * 60;
+const DEFAULT_CACHE_TTL_EXCHANGE_ORACLE_REGISTRATION_NEEDED = 24 * 60 * 60;
 
 @Injectable()
 export class EnvironmentConfigService {
@@ -94,6 +95,12 @@ export class EnvironmentConfigService {
       DEFAULT_CACHE_TTL_EXCHANGE_ORACLE_URL,
     );
   }
+  get cacheTtlExchangeOracleRegistrationNeeded(): number {
+    return this.configService.get<number>(
+      'CACHE_TTL_EXCHANGE_ORACLE_REGISTRATION_NEEDED',
+      DEFAULT_CACHE_TTL_EXCHANGE_ORACLE_REGISTRATION_NEEDED,
+    );
+  }
   get hcaptchaLabelingStatsApiUrl(): string {
     return this.configService.getOrThrow<string>(
       'HCAPTCHA_LABELING_STATS_API_URL',

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

@@ -41,6 +41,11 @@ export class GatewayConfigService {
               method: HttpMethod.POST,
               headers: this.JSON_HEADER,
             },
+            [ReputationOracleEndpoints.WORKER_REGISTRATION]: {
+              endpoint: '/user/registration',
+              method: HttpMethod.POST,
+              headers: this.JSON_HEADER,
+            },
             [ReputationOracleEndpoints.EMAIL_VERIFICATION]: {
               endpoint: '/auth/email-verification',
               method: HttpMethod.POST,

packages/apps/human-app/server/src/common/config/spec/gateway-config-service.mock.ts

@@ -17,6 +17,11 @@ export const gatewayConfigServiceMock = {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
+      WORKER_REGISTRATION: {
+        endpoint: '/user/registration',
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+      },
       EMAIL_VERIFICATION: {
         endpoint: '/auth/email-verification',
         method: 'POST',

packages/apps/human-app/server/src/common/constants/cache.ts

@@ -1,6 +1,6 @@
 export const JOB_DISCOVERY_CACHE_KEY = 'jobs:avialable';
 export const JOB_ASSIGNMENT_CACHE_KEY = 'jobs:assigned';
-export const KV_STORE_CACHE_KEY = 'kvstore';
+export const ORACLE_URL_CACHE_KEY = 'oracle:url';
 export const DAILY_HMT_SPENT_CACHE_KEY = 'daily:hmt-spent';
 export const ORACLE_STATISTICS_CACHE_KEY = 'statistics:oracle';
 export const WORKER_STATISTICS_CACHE_KEY = 'statistics:worker';

packages/apps/human-app/server/src/common/enums/reputation-oracle-endpoints.ts

@@ -1,6 +1,7 @@
 export enum ReputationOracleEndpoints {
   WORKER_SIGNUP = 'WORKER_SIGNUP',
   WORKER_SIGNIN = 'WORKER_SIGNIN',
+  WORKER_REGISTRATION = 'WORKER_REGISTRATION',
   OPERATOR_SIGNUP = 'OPERATOR_SIGNUP',
   OPERATOR_SIGNIN = 'OPERATOR_SIGNIN',
   EMAIL_VERIFICATION = 'EMAIL_VERIFICATION',

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

@@ -1,4 +1,4 @@
-import { Injectable } from '@nestjs/common';
+import { HttpException, Injectable } from '@nestjs/common';
 import { AxiosRequestConfig } from 'axios';
 import { lastValueFrom } from 'rxjs';
 import {
@@ -34,6 +34,10 @@ import { HttpMethod } from '../../common/enums/http-method';
 import { toCleanObjParams } from '../../common/utils/gateway-common.utils';
 import { KvStoreGateway } from '../kv-store/kv-store.gateway';
 import { EscrowUtilsGateway } from '../escrow/escrow-utils-gateway.service';
+import {
+  RegisterWorkerCommand,
+  RegisterWorkerData,
+} from '../../modules/user-worker/model/worker-registration.model';
 
 @Injectable()
 export class ExchangeOracleGateway {
@@ -171,4 +175,25 @@ export class ExchangeOracleGateway {
     };
     return this.callExternalHttpUtilRequest<JobsDiscoveryResponse>(options);
   }
+
+  async registerWorker(command: RegisterWorkerCommand) {
+    const data = this.mapper.map(
+      command,
+      RegisterWorkerCommand,
+      RegisterWorkerData,
+    );
+
+    const options: AxiosRequestConfig = {
+      method: HttpMethod.POST,
+      url: `${await this.kvStoreGateway.getExchangeOracleUrlByAddress(
+        command.oracleAddress,
+      )}/register`,
+      data: data,
+      headers: {
+        Authorization: command.token,
+        Accept: 'application/json',
+      },
+    };
+    return this.callExternalHttpUtilRequest(options);
+  }
 }

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

@@ -21,6 +21,10 @@ import {
   JobsDiscoveryParams,
   JobsDiscoveryParamsData,
 } from '../../modules/jobs-discovery/model/jobs-discovery.model';
+import {
+  RegisterWorkerCommand,
+  RegisterWorkerData,
+} from '../../modules/user-worker/model/worker-registration.model';
 
 @Injectable()
 export class ExchangeOracleProfile extends AutomapperProfile {
@@ -88,6 +92,15 @@ export class ExchangeOracleProfile extends AutomapperProfile {
           destination: new SnakeCaseNamingConvention(),
         }),
       );
+      createMap(
+        mapper,
+        RegisterWorkerCommand,
+        RegisterWorkerData,
+        namingConventions({
+          source: new CamelCaseNamingConvention(),
+          destination: new SnakeCaseNamingConvention(),
+        }),
+      );
     };
   }
 }

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

@@ -4,4 +4,5 @@ export const exchangeOracleGatewayMock = {
   fetchAssignedJobs: jest.fn(),
   postNewJobAssignment: jest.fn(),
   fetchDiscoveredJobs: jest.fn(),
+  registerWorker: jest.fn(),
 };

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

@@ -17,6 +17,7 @@ import {
   jobResignAssignedCommandFixture,
   jobsFetchParamsCommandFixture,
   jobsFetchParamsDataFixtureAsString,
+  workerRegisterUrl,
 } from '../../../modules/job-assignment/spec/job-assignment.fixtures';
 import { ExchangeOracleProfile } from '../exchange-oracle.mapper.profile';
 import {
@@ -32,12 +33,20 @@ import { EscrowUtilsGateway } from '../../escrow/escrow-utils-gateway.service';
 import { ResignJobData } from '../../../modules/job-assignment/model/job-assignment.model';
 import { JobsDiscoveryParamsData } from '../../../modules/jobs-discovery/model/jobs-discovery.model';
 import { AxiosResponse } from 'axios';
+import { RegisterWorkerData } from '../../../modules/user-worker/model/worker-registration.model';
+import {
+  registerWorkerCommandFixture,
+  registerWorkerDataFixture,
+  responseWorkerFixture,
+} from '../../../modules/user-worker/spec/worker.fixtures';
 
 describe('ExchangeOracleApiGateway', () => {
   let gateway: ExchangeOracleGateway;
   let httpService: HttpService;
   let escrowGateway: EscrowUtilsGateway;
-  const EXCHANGE_ORACLE_ADR = 'mocked:exchange_oracle:address';
+  const EXCHANGE_ORACLE_REGISTRATION_NEEDED =
+    'mocked:exchange_oracle:registration_needed';
+  const EXCHANGE_ORACLE_URL = 'mocked:exchange_oracle:url';
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
       imports: [
@@ -49,9 +58,12 @@ describe('ExchangeOracleApiGateway', () => {
         {
           provide: KvStoreGateway,
           useValue: {
+            getExchangeOracleRegistrationNeeded: jest
+              .fn()
+              .mockReturnValue(EXCHANGE_ORACLE_REGISTRATION_NEEDED),
             getExchangeOracleUrlByAddress: jest
               .fn()
-              .mockReturnValue(EXCHANGE_ORACLE_ADR),
+              .mockReturnValue(EXCHANGE_ORACLE_URL),
           },
         },
         {
@@ -90,7 +102,7 @@ describe('ExchangeOracleApiGateway', () => {
       await gateway.fetchUserStatistics(command);
       expect(httpService.request).toHaveBeenCalledWith(
         expect.objectContaining({
-          url: EXCHANGE_ORACLE_ADR + '/stats/assignment',
+          url: EXCHANGE_ORACLE_URL + '/stats/assignment',
           method: HttpMethod.GET,
         }),
       );
@@ -115,7 +127,7 @@ describe('ExchangeOracleApiGateway', () => {
       await gateway.fetchOracleStatistics(command);
       expect(httpService.request).toHaveBeenCalledWith(
         expect.objectContaining({
-          url: EXCHANGE_ORACLE_ADR + '/stats',
+          url: EXCHANGE_ORACLE_URL + '/stats',
           method: HttpMethod.GET,
         }),
       );
@@ -151,7 +163,7 @@ describe('ExchangeOracleApiGateway', () => {
       await gateway.fetchAssignedJobs(command);
       expect(httpService.request).toHaveBeenCalledWith(
         expect.objectContaining({
-          url: EXCHANGE_ORACLE_ADR + '/assignment',
+          url: EXCHANGE_ORACLE_URL + '/assignment',
           method: HttpMethod.GET,
           params: expectedMappedData,
           headers: {
@@ -168,7 +180,7 @@ describe('ExchangeOracleApiGateway', () => {
       const data = jobAssignmentDataFixture;
       jest
         .spyOn(escrowGateway, 'getExchangeOracleAddressByEscrowAddress')
-        .mockResolvedValue(EXCHANGE_ORACLE_ADR);
+        .mockResolvedValue(EXCHANGE_ORACLE_URL);
       const matcher: RequestBodyMatcher = {
         escrowAddress: data.escrow_address,
         chainId: data.chain_id,
@@ -180,7 +192,7 @@ describe('ExchangeOracleApiGateway', () => {
       ).toHaveBeenCalledWith(command.data.chainId, command.data.escrowAddress);
       expect(httpService.request).toHaveBeenCalledWith(
         expect.objectContaining({
-          url: EXCHANGE_ORACLE_ADR + '/assignment',
+          url: EXCHANGE_ORACLE_URL + '/assignment',
           method: HttpMethod.POST,
         }),
       );
@@ -197,7 +209,7 @@ describe('ExchangeOracleApiGateway', () => {
       await gateway.resignAssignedJob(command);
       expect(httpService.request).toHaveBeenCalledWith(
         expect.objectContaining({
-          url: EXCHANGE_ORACLE_ADR + '/assignment/resign',
+          url: EXCHANGE_ORACLE_URL + '/assignment/resign',
           method: HttpMethod.POST,
           data: expectedMappedData,
           headers: {
@@ -228,7 +240,7 @@ describe('ExchangeOracleApiGateway', () => {
       await gateway.fetchJobs(command);
       expect(httpService.request).toHaveBeenCalledWith(
         expect.objectContaining({
-          url: EXCHANGE_ORACLE_ADR + '/job',
+          url: EXCHANGE_ORACLE_URL + '/job',
           method: HttpMethod.GET,
           params: expectedMappedData,
           headers: {
@@ -240,6 +252,37 @@ describe('ExchangeOracleApiGateway', () => {
     });
   });
 
+  describe('registerWorker', () => {
+    it('should successfully call register worker', async () => {
+      jest.spyOn(httpService, 'request').mockReturnValue(
+        of({
+          data: responseWorkerFixture,
+          status: 200,
+          statusText: 'OK',
+          headers: {},
+          config: {},
+        } as AxiosResponse),
+      );
+      const command = registerWorkerCommandFixture;
+      const expectedMappedData: RegisterWorkerData = registerWorkerDataFixture;
+      nock(workerRegisterUrl)
+        .post(`/register`)
+        .reply(200, responseWorkerFixture);
+      await gateway.registerWorker(command);
+      expect(httpService.request).toHaveBeenCalledWith(
+        expect.objectContaining({
+          url: EXCHANGE_ORACLE_URL + '/register',
+          method: HttpMethod.POST,
+          data: expectedMappedData,
+          headers: {
+            Authorization: command.token,
+            Accept: 'application/json',
+          },
+        }),
+      );
+    });
+  });
+
   afterEach(() => {
     nock.cleanAll();
   });

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

@@ -4,7 +4,7 @@ import { ethers } from 'ethers';
 import { ChainId, KVStoreKeys, KVStoreUtils } from '@human-protocol/sdk';
 import { CACHE_MANAGER } from '@nestjs/cache-manager';
 import { Cache } from 'cache-manager';
-import { KV_STORE_CACHE_KEY } from '../../common/constants/cache';
+import { ORACLE_URL_CACHE_KEY } from '../../common/constants/cache';
 
 @Injectable()
 export class KvStoreGateway {
@@ -13,18 +13,18 @@ export class KvStoreGateway {
     @Inject(CACHE_MANAGER) private cacheManager: Cache,
   ) {}
   async getExchangeOracleUrlByAddress(address: string): Promise<string | void> {
-    const key = `${KV_STORE_CACHE_KEY}:${address}`;
-    const cachedUrl: string | undefined = await this.cacheManager.get(key);
-    if (cachedUrl) {
-      return cachedUrl;
+    const key = `${ORACLE_URL_CACHE_KEY}:${address}`;
+    const cachedData: string | undefined = await this.cacheManager.get(key);
+    if (cachedData) {
+      return cachedData;
     }
-    let fetchedUrl: string;
+    let fetchedData: string;
     try {
       const runner = new ethers.JsonRpcProvider(this.configService.rpcUrl);
       const network = await runner.provider?.getNetwork();
       const chainId: ChainId = Number(network?.chainId);
 
-      fetchedUrl = await KVStoreUtils.get(chainId, address, KVStoreKeys.url);
+      fetchedData = await KVStoreUtils.get(chainId, address, KVStoreKeys.url);
     } catch (e) {
       if (e.toString().includes('Error: Invalid address')) {
         throw new HttpException(
@@ -37,16 +37,16 @@ export class KvStoreGateway {
         );
       }
     }
-    if (!fetchedUrl || fetchedUrl === '') {
+    if (!fetchedData || fetchedData === '') {
       throw new HttpException(
         `Unable to retrieve URL from address: ${address}`,
         400,
       );
     } else {
-      await this.cacheManager.set(key, fetchedUrl, {
+      await this.cacheManager.set(key, fetchedData, {
         ttl: this.configService.cacheTtlExchangeOracleUrl,
       } as any);
-      return fetchedUrl;
+      return fetchedData;
     }
   }
 }

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

@@ -4,7 +4,7 @@ import { ChainId, KVStoreKeys, KVStoreUtils } from '@human-protocol/sdk';
 import { EnvironmentConfigService } from '../../../common/config/environment-config.service';
 import { CACHE_MANAGER } from '@nestjs/cache-manager';
 import { Cache } from 'cache-manager';
-import { KV_STORE_CACHE_KEY } from '../../../common/constants/cache';
+import { ORACLE_URL_CACHE_KEY } from '../../../common/constants/cache';
 
 const EXPECTED_URL = 'https://example.com';
 jest.mock('@human-protocol/sdk', () => {
@@ -86,9 +86,9 @@ describe('KvStoreGateway', () => {
   describe('getExchangeOracleUrlByAddress', () => {
     it('should get data from kvStoreUtils, if not cached', async () => {
       const testAddress = 'testAddress';
-      const cacheKey = `${KV_STORE_CACHE_KEY}:${testAddress}`;
-      const expectedUrl = EXPECTED_URL;
-      mockKVStoreUtils.get.mockResolvedValue(expectedUrl);
+      const cacheKey = `${ORACLE_URL_CACHE_KEY}:${testAddress}`;
+      const expectedData = EXPECTED_URL;
+      mockKVStoreUtils.get.mockResolvedValue(expectedData);
       cacheManager.get.mockResolvedValue(undefined);
       const result = await service.getExchangeOracleUrlByAddress(testAddress);
       expect(KVStoreUtils.get).toHaveBeenCalledWith(
@@ -97,22 +97,22 @@ describe('KvStoreGateway', () => {
         KVStoreKeys.url,
       );
 
-      expect(cacheManager.set).toHaveBeenCalledWith(cacheKey, expectedUrl, {
+      expect(cacheManager.set).toHaveBeenCalledWith(cacheKey, expectedData, {
         ttl: configService.cacheTtlExchangeOracleUrl,
       });
       expect(cacheManager.get).toHaveBeenCalledWith(cacheKey);
-      expect(result).toBe(expectedUrl);
+      expect(result).toBe(expectedData);
     });
     it('should get data from cache, if available', async () => {
       const testAddress = 'testAddress';
-      const cacheKey = `${KV_STORE_CACHE_KEY}:${testAddress}`;
-      const expectedUrl = EXPECTED_URL;
-      cacheManager.get.mockResolvedValue(expectedUrl);
+      const cacheKey = `${ORACLE_URL_CACHE_KEY}:${testAddress}`;
+      const expectedData = EXPECTED_URL;
+      cacheManager.get.mockResolvedValue(expectedData);
       const result = await service.getExchangeOracleUrlByAddress(testAddress);
 
       expect(KVStoreUtils.get).not.toHaveBeenCalled();
       expect(cacheManager.get).toHaveBeenCalledWith(cacheKey);
-      expect(result).toBe(expectedUrl);
+      expect(result).toBe(expectedData);
     });
   });
 });