Rename registrations in exchange oracles (humanprotocol#2683)

* Rename registrations in exchange oracles * update variable to registrationInExchangeOracleError * rename variable to isRegistrationInExchangeOraclePending
KacperKoza343 · Oct 23, 2024 · fc60052 · fc60052
1 parent 4d2c963
commit fc60052
Show file tree

Hide file tree

Showing 34 changed files with 232 additions and 199 deletions.
diff --git a/packages/apps/fortune/exchange-oracle/server/src/modules/user/user.controller.ts b/packages/apps/fortune/exchange-oracle/server/src/modules/user/user.controller.ts
@@ -12,7 +12,7 @@ import { JwtAuthGuard } from '../../common/guards/jwt.auth';
 @UseGuards(JwtAuthGuard)
 @ApiBearerAuth()
 export class UserController {
-  @Post('registration')
+  @Post('register')
   @ApiOperation({
     summary: 'Register a user in Exchange Oracle',
     description: 'Endpoint to register a user in Exchange Oracle.',

diff --git a/packages/apps/human-app/frontend/src/api/api-paths.ts b/packages/apps/human-app/frontend/src/api/api-paths.ts
@@ -65,8 +65,8 @@ export const apiPaths = {
     dailyHmtSpend: {
       path: '/labeling/h-captcha/daily-hmt-spent',
     },
-    userRegistration: {
-      path: '/registration',
+    registrationInExchangeOracle: {
+      path: '/exchange-oracle-registration',
     },
   },
   operator: {

diff --git a/...api/services/worker/registered-oracles.ts → ...r/get-registration-in-exchange-oracles.ts b/...api/services/worker/registered-oracles.ts → ...r/get-registration-in-exchange-oracles.ts
@@ -8,18 +8,18 @@ const RegisteredOraclesSuccessResponseSchema = z.object({
   oracle_addresses: z.array(z.string()),
 });
 
-export async function getRegisteredOracles() {
-  return apiClient(apiPaths.worker.userRegistration.path, {
+export async function getRegistrationInExchangeOracles() {
+  return apiClient(apiPaths.worker.registrationInExchangeOracle.path, {
     authenticated: true,
     successSchema: RegisteredOraclesSuccessResponseSchema,
     options: { method: 'GET' },
   });
 }
 
-export function useGetRegisteredOracles() {
+export function useGetRegistrationInExchangeOracles() {
   return useQuery({
-    queryFn: () => getRegisteredOracles(),
-    queryKey: ['getRegisteredOracles'],
+    queryFn: () => getRegistrationInExchangeOracles(),
+    queryKey: ['getRegistrationInExchangeOracles'],
     refetchOnMount: false,
     refetchOnWindowFocus: false,
     refetchOnReconnect: false,

diff --git a/.../api/services/worker/user-registration.ts → ...orker/registration-in-exchange-oracles.ts b/.../api/services/worker/user-registration.ts → ...orker/registration-in-exchange-oracles.ts
@@ -6,7 +6,7 @@ import { t } from 'i18next';
 import { apiClient } from '@/api/api-client';
 import { apiPaths } from '@/api/api-paths';
 
-export const registrationDtoSchema = z.object({
+export const registrationInExchangeOracleDtoSchema = z.object({
   oracle_address: z
     .string()
     .refine(
@@ -16,23 +16,27 @@ export const registrationDtoSchema = z.object({
   h_captcha_token: z.string().min(1, t('validation.captcha')).default('token'),
 });
 
-export type RegistrationDto = z.infer<typeof registrationDtoSchema>;
+export type RegistrationInExchangeOracleDto = z.infer<
+  typeof registrationInExchangeOracleDtoSchema
+>;
 
-const UserRegistrationSuccessResponseSchema = z.unknown();
+const RegistrationInExchangeOracleSuccessResponseSchema = z.unknown();
 
-function userRegistrationMutationFn(data: RegistrationDto) {
-  return apiClient(apiPaths.worker.userRegistration.path, {
+function registrationInExchangeOracleMutationFn(
+  data: RegistrationInExchangeOracleDto
+) {
+  return apiClient(apiPaths.worker.registrationInExchangeOracle.path, {
     authenticated: true,
-    successSchema: UserRegistrationSuccessResponseSchema,
+    successSchema: RegistrationInExchangeOracleSuccessResponseSchema,
     options: { method: 'POST', body: JSON.stringify(data) },
   });
 }
 
-export function useUserRegistrationMutation() {
+export function useExchangeOracleRegistrationMutation() {
   const queryClient = useQueryClient();
 
   return useMutation({
-    mutationFn: userRegistrationMutationFn,
+    mutationFn: registrationInExchangeOracleMutationFn,
     onSuccess: async () => {
       await queryClient.invalidateQueries();
     },

diff --git a/...human-app/frontend/src/components/layout/drawer-menu-items/drawer-menu-items-operator.tsx b/...human-app/frontend/src/components/layout/drawer-menu-items/drawer-menu-items-operator.tsx
@@ -15,10 +15,8 @@ export const operatorDrawerBottomMenuItems: BottomMenuItem[] = [
     icon: <HelpIcon />,
     onClick: () => {
       // @ts-expect-error -- ...
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- ...
       if ($zoho?.salesiq?.chat?.start) {
         // @ts-expect-error -- ...
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call -- ...
         $zoho.salesiq.chat.start();
       }
     },

diff --git a/...s/human-app/frontend/src/components/layout/drawer-menu-items/drawer-menu-items-worker.tsx b/...s/human-app/frontend/src/components/layout/drawer-menu-items/drawer-menu-items-worker.tsx
@@ -37,10 +37,8 @@ export const workerDrawerBottomMenuItems: BottomMenuItem[] = [
     icon: <HelpIcon />,
     onClick: () => {
       // @ts-expect-error -- ...
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- ...
       if ($zoho?.salesiq?.chat?.start) {
         // @ts-expect-error -- ...
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call -- ...
         $zoho.salesiq.chat.start();
       }
     },

diff --git a/packages/apps/human-app/frontend/src/i18n/en.json b/packages/apps/human-app/frontend/src/i18n/en.json
@@ -11,7 +11,7 @@
     "jobsDiscovery": "Tasks",
     "hcaptchaLabeling": "Labeling",
     "jobs": "Tasks",
-    "registration": "Registration"
+    "registrationInExchangeOracle": "Registration in Exchange Oracle"
   },
   "web3ProtectedPagesHeaders": {
     "profile": "Profile"
@@ -211,7 +211,7 @@
       "seeJobs": "See tasks",
       "allJobs": "All tasks"
     },
-    "registration": {
+    "registrationInExchangeOracle": {
       "requiredMessage": "This oracle requires a registration process. Click on the link below to see the registration tutorial:",
       "completeMessage": "Click on Complete once you have finished the registration process:",
       "completeButton": "Complete"

diff --git a/...n-app/frontend/src/pages/worker/jobs-discovery/components/oracles-table/oracles-table.tsx b/...n-app/frontend/src/pages/worker/jobs-discovery/components/oracles-table/oracles-table.tsx
@@ -19,7 +19,7 @@ import { createTableDarkMode } from '@/styles/create-table-dark-mode';
 import { env } from '@/shared/env';
 import { useAuthenticatedUser } from '@/auth/use-authenticated-user';
 import { type JobType } from '@/smart-contracts/EthKVStore/config';
-import { useGetRegisteredOracles } from '@/api/services/worker/registered-oracles';
+import { useGetRegistrationInExchangeOracles } from '@/api/services/worker/get-registration-in-exchange-oracles';
 
 const getColumns = (
   selectOracle: (oracle: OracleSuccessResponse) => void
@@ -88,16 +88,19 @@ export function OraclesTable({
   const navigate = useNavigate();
   const isMobile = useIsMobile();
   const { user } = useAuthenticatedUser();
-  const { data: registeredOraclesResults } = useGetRegisteredOracles();
+  const { data: registrationInExchangeOraclesResult } =
+    useGetRegistrationInExchangeOracles();
 
   const selectOracle = (oracle: OracleSuccessResponse) => {
     if (
       oracle.registrationNeeded &&
-      !registeredOraclesResults?.oracle_addresses.find(
+      !registrationInExchangeOraclesResult?.oracle_addresses.find(
         (address) => address === oracle.address
       )
     ) {
-      navigate(`${routerPaths.worker.registration}/${oracle.address}`);
+      navigate(
+        `${routerPaths.worker.registrationInExchangeOracle}/${oracle.address}`
+      );
       return;
     }
 

diff --git a/packages/apps/human-app/frontend/src/pages/worker/registration/registration.page.tsx b/packages/apps/human-app/frontend/src/pages/worker/registration/registration.page.tsx
@@ -7,10 +7,10 @@ import { zodResolver } from '@hookform/resolvers/zod';
 import { FormCaptcha } from '@/components/h-captcha';
 import { Button } from '@/components/ui/button';
 import {
-  type RegistrationDto,
-  registrationDtoSchema,
-  useUserRegistrationMutation,
-} from '@/api/services/worker/user-registration';
+  type RegistrationInExchangeOracleDto,
+  registrationInExchangeOracleDtoSchema,
+  useExchangeOracleRegistrationMutation,
+} from '@/api/services/worker/registration-in-exchange-oracles';
 import { useRegisteredOracles } from '@/contexts/registered-oracles';
 import { useGetOracles } from '@/api/services/worker/oracles';
 import { routerPaths } from '@/router/router-paths';
@@ -27,27 +27,29 @@ export function RegistrationPage() {
 
   const { registeredOracles, setRegisteredOracles } = useRegisteredOracles();
 
-  const methods = useForm<RegistrationDto>({
+  const methods = useForm<RegistrationInExchangeOracleDto>({
     defaultValues: {
       // eslint-disable-next-line camelcase
       oracle_address: oracleAddress,
       // eslint-disable-next-line camelcase
       h_captcha_token: '',
     },
-    resolver: zodResolver(registrationDtoSchema),
+    resolver: zodResolver(registrationInExchangeOracleDtoSchema),
   });
 
   const {
     mutate: userRegistrationMutate,
-    isPending: isUserRegistrationPending,
-    error: userRegistrationError,
-  } = useUserRegistrationMutation();
+    isPending: isRegistrationInExchangeOraclePending,
+    error: registrationInExchangeOracleError,
+  } = useExchangeOracleRegistrationMutation();
 
   const handleLinkClick = () => {
     setHasClickedRegistrationLink(true);
   };
 
-  const handleRegistrationComplete = (data: RegistrationDto) => {
+  const handleRegistrationComplete = (
+    data: RegistrationInExchangeOracleDto
+  ) => {
     userRegistrationMutate(data, {
       onSuccess(_data) {
         if (oracleAddress !== undefined) {
@@ -99,7 +101,9 @@ export function RegistrationPage() {
           }}
         >
           <Stack maxWidth="350px" spacing={2}>
-            <Box>{t('worker.registration.requiredMessage')}</Box>
+            <Box>
+              {t('worker.registrationInExchangeOracle.requiredMessage')}
+            </Box>
             <Link
               href={oracleData?.registrationInstructions ?? ''}
               onClick={handleLinkClick}
@@ -109,7 +113,9 @@ export function RegistrationPage() {
             >
               {oracleData?.registrationInstructions}
             </Link>
-            <Box>{t('worker.registration.completeMessage')}</Box>
+            <Box>
+              {t('worker.registrationInExchangeOracle.completeMessage')}
+            </Box>
             <FormProvider {...methods}>
               <form
                 onSubmit={(event) =>
@@ -118,17 +124,17 @@ export function RegistrationPage() {
               >
                 <Stack alignItems="center" spacing={2}>
                   <FormCaptcha
-                    error={userRegistrationError}
+                    error={registrationInExchangeOracleError}
                     name="h_captcha_token"
                   />
                   <Button
                     disabled={!hasClickedRegistrationLink}
                     fullWidth
-                    loading={isUserRegistrationPending}
+                    loading={isRegistrationInExchangeOraclePending}
                     type="submit"
                     variant="contained"
                   >
-                    {t('worker.registration.completeButton')}
+                    {t('worker.registrationInExchangeOracle.completeButton')}
                   </Button>
                 </Stack>
               </form>

diff --git a/packages/apps/human-app/frontend/src/router/router-paths.ts b/packages/apps/human-app/frontend/src/router/router-paths.ts
@@ -15,7 +15,7 @@ export const routerPaths = {
     jobs: '/worker/jobs',
     HcaptchaLabeling: '/worker/hcaptcha-labeling',
     enableLabeler: '/worker/enable-labeler',
-    registration: '/worker/registration',
+    registrationInExchangeOracle: '/worker/registration-in-exchange-oracle',
   },
   operator: {
     signIn: '/operator/sign-in',

diff --git a/packages/apps/human-app/frontend/src/router/routes.tsx b/packages/apps/human-app/frontend/src/router/routes.tsx
@@ -114,12 +114,12 @@ export const protectedRoutes: {
         },
         {
           routerProps: {
-            path: `${routerPaths.worker.registration}/:address`,
+            path: `${routerPaths.worker.registrationInExchangeOracle}/:address`,
             element: <RegistrationPage />,
           },
           pageHeaderProps: {
             headerIcon: <HomepageWorkIcon />,
-            headerText: t('protectedPagesHeaders.registration'),
+            headerText: t('protectedPagesHeaders.registrationInExchangeOracle'),
           },
         },
       ]

diff --git a/packages/apps/human-app/server/src/common/config/gateway-config.service.ts b/packages/apps/human-app/server/src/common/config/gateway-config.service.ts
@@ -41,8 +41,8 @@ export class GatewayConfigService {
               method: HttpMethod.POST,
               headers: this.JSON_HEADER,
             },
-            [ReputationOracleEndpoints.WORKER_REGISTRATION]: {
-              endpoint: '/user/registration',
+            [ReputationOracleEndpoints.REGISTRATION_IN_EXCHANGE_ORACLE]: {
+              endpoint: '/user/exchange-oracle-registration',
               method: HttpMethod.POST,
               headers: this.JSON_HEADER,
             },
@@ -105,8 +105,8 @@ export class GatewayConfigService {
               method: HttpMethod.GET,
               headers: this.JSON_HEADER,
             },
-            [ReputationOracleEndpoints.GET_REGISTERED_ORACLES]: {
-              endpoint: '/user/registration',
+            [ReputationOracleEndpoints.GET_REGISTRATION_IN_EXCHANGE_ORACLES]: {
+              endpoint: '/user/exchange-oracle-registration',
               method: HttpMethod.GET,
               headers: this.JSON_HEADER,
             },

diff --git a/packages/apps/human-app/server/src/common/config/spec/gateway-config-service.mock.ts b/packages/apps/human-app/server/src/common/config/spec/gateway-config-service.mock.ts
@@ -17,8 +17,8 @@ export const gatewayConfigServiceMock = {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      WORKER_REGISTRATION: {
-        endpoint: '/user/registration',
+      REGISTRATION_IN_EXCHANGE_ORACLE: {
+        endpoint: '/user/exchange-oracle-registration',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },

diff --git a/packages/apps/human-app/server/src/common/enums/reputation-oracle-endpoints.ts b/packages/apps/human-app/server/src/common/enums/reputation-oracle-endpoints.ts
@@ -1,7 +1,7 @@
 export enum ReputationOracleEndpoints {
   WORKER_SIGNUP = 'WORKER_SIGNUP',
   WORKER_SIGNIN = 'WORKER_SIGNIN',
-  WORKER_REGISTRATION = 'WORKER_REGISTRATION',
+  REGISTRATION_IN_EXCHANGE_ORACLE = 'REGISTRATION_IN_EXCHANGE_ORACLE',
   OPERATOR_SIGNUP = 'OPERATOR_SIGNUP',
   OPERATOR_SIGNIN = 'OPERATOR_SIGNIN',
   EMAIL_VERIFICATION = 'EMAIL_VERIFICATION',
@@ -15,7 +15,7 @@ export enum ReputationOracleEndpoints {
   REGISTER_ADDRESS = 'REGISTER_ADDRESS',
   TOKEN_REFRESH = 'TOKEN_REFRESH',
   KYC_ON_CHAIN = 'KYC_ON_CHAIN',
-  GET_REGISTERED_ORACLES = 'GET_REGISTERED_ORACLES',
+  GET_REGISTRATION_IN_EXCHANGE_ORACLES = 'GET_REGISTRATION_IN_EXCHANGE_ORACLES',
 }
 export enum HCaptchaLabelingStatsEndpoints {
   USER_STATS = 'USER_STATS',

diff --git a/packages/apps/human-app/server/src/integrations/exchange-oracle/exchange-oracle.gateway.ts b/packages/apps/human-app/server/src/integrations/exchange-oracle/exchange-oracle.gateway.ts
@@ -35,8 +35,8 @@ 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 {
-  WorkerRegistrationCommand,
-  WorkerRegistrationData,
+  RegistrationInExchangeOracleCommand,
+  RegistrationInExchangeOracleData,
 } from '../../modules/user-worker/model/worker-registration.model';
 
 @Injectable()
@@ -176,18 +176,20 @@ export class ExchangeOracleGateway {
     return this.callExternalHttpUtilRequest<JobsDiscoveryResponse>(options);
   }
 
-  async workerRegistration(command: WorkerRegistrationCommand) {
+  async sendRegistrationInExchangeOracle(
+    command: RegistrationInExchangeOracleCommand,
+  ) {
     const data = this.mapper.map(
       command,
-      WorkerRegistrationCommand,
-      WorkerRegistrationData,
+      RegistrationInExchangeOracleCommand,
+      RegistrationInExchangeOracleData,
     );
 
     const options: AxiosRequestConfig = {
       method: HttpMethod.POST,
       url: `${await this.kvStoreGateway.getExchangeOracleUrlByAddress(
         command.oracleAddress,
-      )}/registration`,
+      )}/register`,
       data: data,
       headers: {
         Authorization: command.token,

diff --git a/.../apps/human-app/server/src/integrations/exchange-oracle/exchange-oracle.mapper.profile.ts b/.../apps/human-app/server/src/integrations/exchange-oracle/exchange-oracle.mapper.profile.ts
@@ -22,8 +22,8 @@ import {
   JobsDiscoveryParamsData,
 } from '../../modules/jobs-discovery/model/jobs-discovery.model';
 import {
-  WorkerRegistrationCommand,
-  WorkerRegistrationData,
+  RegistrationInExchangeOracleCommand,
+  RegistrationInExchangeOracleData,
 } from '../../modules/user-worker/model/worker-registration.model';
 
 @Injectable()
@@ -94,8 +94,8 @@ export class ExchangeOracleProfile extends AutomapperProfile {
       );
       createMap(
         mapper,
-        WorkerRegistrationCommand,
-        WorkerRegistrationData,
+        RegistrationInExchangeOracleCommand,
+        RegistrationInExchangeOracleData,
         namingConventions({
           source: new CamelCaseNamingConvention(),
           destination: new SnakeCaseNamingConvention(),

diff --git a/...ps/human-app/server/src/integrations/exchange-oracle/spec/exchange-oracle.gateway.mock.ts b/...ps/human-app/server/src/integrations/exchange-oracle/spec/exchange-oracle.gateway.mock.ts
@@ -4,5 +4,5 @@ export const exchangeOracleGatewayMock = {
   fetchAssignedJobs: jest.fn(),
   postNewJobAssignment: jest.fn(),
   fetchDiscoveredJobs: jest.fn(),
-  workerRegistration: jest.fn(),
+  sendRegistrationInExchangeOracle: jest.fn(),
 };