Merge pull request #1853 from humanprotocol/develop

Release Sprint 8 - W1

Author: portuu3

packages/apps/job-launcher/server/docker-compose.yml

@@ -1,6 +1,7 @@
 version: '3.8'
 services:
   postgres:
+    container_name: postgres
     image: postgres:latest
     restart: always
     logging:
@@ -11,11 +12,10 @@ services:
       - 5432:5432
     # volumes: 
     #   - ./db:/var/lib/postgresql/data
-    env_file:
-      - path: .env
-        required: true # default
     environment:
       POSTGRES_DB: ${POSTGRES_DATABASE}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_USER: ${POSTGRES_USER}
   minio:
     container_name: minio
     image: minio/minio:RELEASE.2022-05-26T05-48-41Z
@@ -30,9 +30,6 @@ services:
       interval: 5s
       timeout: 5s
       retries: 3
-    env_file:
-      - path: .env
-        required: true # default
   minio-mc:
     container_name: minio-mc
     image: minio/mc
@@ -45,9 +42,6 @@ services:
       /usr/bin/mc mb myminio/manifests;
       /usr/bin/mc anonymous set public myminio/manifests;
       "
-    env_file:
-      - path: .env
-        required: true # default
   # job-launcher:
   #   container_name: job-launcher
   #   restart: unless-stopped

packages/apps/job-launcher/server/package.json

@@ -25,7 +25,7 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "export POSTGRES_DATABASE=job-launcher POSTGRES_PASSWORD=qwerty POSTGRES_USER=default POSTGRES_HOST=0.0.0.0 NODE_ENV=test-e2e && docker compose up -d postgres && yarn migration:run && jest --config ./test/jest-e2e.json; testStatus=$?; docker rm -f postgres; exit $testStatus"
   },
   "dependencies": {
     "@human-protocol/sdk": "*",
@@ -58,7 +58,7 @@
     "pg": "8.11.3",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.2.0",
-    "stripe": "^14.20.0",
+    "stripe": "^14.24.0",
     "typeorm": "^0.3.17",
     "typeorm-naming-strategies": "^4.1.0",
     "zxcvbn": "^4.4.2"

packages/apps/job-launcher/server/src/app.module.ts

@@ -1,7 +1,6 @@
 import { Module } from '@nestjs/common';
 import { APP_FILTER, APP_GUARD, APP_INTERCEPTOR, APP_PIPE } from '@nestjs/core';
 import { ConfigModule } from '@nestjs/config';
-import { ScheduleModule } from '@nestjs/schedule';
 import { AppController } from './app.controller';
 import { DatabaseModule } from './database/database.module';
 import { JwtAuthGuard } from './common/guards';
@@ -21,6 +20,7 @@ import { SnakeCaseInterceptor } from './common/interceptors/snake-case';
 import { DatabaseExceptionFilter } from './common/exceptions/database.filter';
 import { WebhookModule } from './modules/webhook/webhook.module';
 import { EnvConfigModule } from './common/config/config.module';
+import { E2E_TEST_ENV } from './common/constants';
 
 @Module({
   providers: [
@@ -43,10 +43,15 @@ import { EnvConfigModule } from './common/config/config.module';
   ],
   imports: [
     ConfigModule.forRoot({
-      envFilePath: process.env.NODE_ENV
-        ? `.env.${process.env.NODE_ENV as string}`
-        : '.env',
-      validationSchema: envValidator,
+      ignoreEnvFile: process.env.NODE_ENV === E2E_TEST_ENV,
+      ...(process.env.NODE_ENV !== E2E_TEST_ENV && {
+        envFilePath: process.env.NODE_ENV
+          ? `.env.${process.env.NODE_ENV as string}`
+          : '.env',
+      }),
+      ...(process.env.NODE_ENV !== E2E_TEST_ENV && {
+        validationSchema: envValidator,
+      }),
     }),
     DatabaseModule,
     HealthModule,

packages/apps/job-launcher/server/src/common/constants/index.ts

@@ -65,3 +65,5 @@ export const HCAPTCHA_ORACLE_STAKE = 0.05;
 export const HCAPTCHA_NOT_PRESENTED_LABEL = 'Not presented';
 
 export const RESEND_EMAIL_VERIFICATION_PATH = '/auth/resend-email-verification';
+
+export const E2E_TEST_ENV = 'test-e2e';

packages/apps/job-launcher/server/src/modules/auth/auth.dto.ts

@@ -46,7 +46,7 @@ export class ResendEmailVerificationDto {
 
 export class RestorePasswordDto extends ValidatePasswordDto {
   @ApiProperty()
-  @IsString()
+  @IsUUID()
   public token: string;
 
   @ApiProperty({ name: 'h_captcha_token' })
@@ -56,7 +56,7 @@ export class RestorePasswordDto extends ValidatePasswordDto {
 
 export class VerifyEmailDto {
   @ApiProperty()
-  @IsString()
+  @IsUUID()
   public token: string;
 }
 

packages/apps/job-launcher/server/src/modules/sendgrid/sendgrid.service.ts

@@ -13,23 +13,20 @@ export class SendGridService {
 
   private readonly defaultFromEmail: string;
   private readonly defaultFromName: string;
-  private readonly apiKey: string;
 
   constructor(
     private readonly mailService: MailService,
     private readonly sendgridConfigService: SendgridConfigService,
   ) {
-    const apiKey = this.sendgridConfigService.apiKey;
-
-    if (this.apiKey === SENDGRID_API_KEY_DISABLED) {
+    if (this.sendgridConfigService.apiKey === SENDGRID_API_KEY_DISABLED) {
       return;
     }
 
-    if (!SENDGRID_API_KEY_REGEX.test(apiKey)) {
+    if (!SENDGRID_API_KEY_REGEX.test(this.sendgridConfigService.apiKey)) {
       throw new Error(ErrorSendGrid.InvalidApiKey);
     }
 
-    this.mailService.setApiKey(apiKey);
+    this.mailService.setApiKey(this.sendgridConfigService.apiKey);
 
     this.defaultFromEmail = this.sendgridConfigService.fromEmail;
     this.defaultFromName = this.sendgridConfigService.fromName;
@@ -45,7 +42,7 @@ export class SendGridService {
     ...emailData
   }: Partial<MailDataRequired>): Promise<void> {
     try {
-      if (this.apiKey === SENDGRID_API_KEY_DISABLED) {
+      if (this.sendgridConfigService.apiKey === SENDGRID_API_KEY_DISABLED) {
         this.logger.debug(personalizations);
         return;
       }

packages/apps/job-launcher/server/test/app.e2e-spec.ts renamed to packages/apps/job-launcher/server/test/e2e/app.e2e-spec.ts

@@ -1,10 +1,14 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { INestApplication } from '@nestjs/common';
-import * as request from 'supertest';
-import { AppModule } from './../src/app.module';
+import request from 'supertest';
+import { AppModule } from '../../src/app.module';
+import setupE2eEnvironment from './env-setup';
 
 describe('AppController (e2e)', () => {
   let app: INestApplication;
+  beforeAll(async () => {
+    setupE2eEnvironment();
+  });
 
   beforeEach(async () => {
     const moduleFixture: TestingModule = await Test.createTestingModule({
@@ -18,7 +22,7 @@ describe('AppController (e2e)', () => {
   it('/ (GET)', () => {
     return request(app.getHttpServer())
       .get('/')
-      .expect(200)
-      .expect('Hello World!');
+      .expect(301)
+      .expect('Moved Permanently. Redirecting to /swagger');
   });
 });

packages/apps/job-launcher/server/test/e2e/auth-workflow.e2e-spec.ts

@@ -0,0 +1,123 @@
+import request from 'supertest';
+import * as crypto from 'crypto';
+import { INestApplication } from '@nestjs/common';
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppModule } from '../../src/app.module';
+import { UserRepository } from '../../src/modules/user/user.repository';
+import { TokenRepository } from '../../src/modules/auth/token.repository';
+import { TokenType } from '../../src/modules/auth/token.entity';
+import { UserStatus } from '../../src/common/enums/user';
+import setupE2eEnvironment from './env-setup';
+
+describe('AuthService E2E', () => {
+  let app: INestApplication;
+  let userRepository: UserRepository;
+  let tokenRepository: TokenRepository;
+
+  beforeAll(async () => {
+    setupE2eEnvironment();
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+
+    userRepository = moduleFixture.get<UserRepository>(UserRepository);
+    tokenRepository = moduleFixture.get<TokenRepository>(TokenRepository);
+  });
+
+  afterAll(async () => {
+    await app.close();
+  });
+
+  it('should test authentication workflow', async () => {
+    const email = `${crypto.randomBytes(16).toString('hex')}@hmt.ai`;
+    const password = 'Password1!';
+    const hCaptchaToken = 'string';
+
+    // User Registration
+    const signUpResponse = await request(app.getHttpServer())
+      .post('/auth/signup')
+      .send({
+        email,
+        password,
+        h_captcha_token: hCaptchaToken,
+      });
+    expect(signUpResponse.status).toBe(201);
+
+    // Verify user registration
+    const userEntity = await userRepository.findByEmail(email);
+    expect(userEntity).toBeDefined();
+
+    // Email Verification
+    expect(userEntity!.status).toBe(UserStatus.PENDING);
+
+    // Invalid verification
+    const invalidVerifyTokenResponse = await request(app.getHttpServer())
+      .post(`/auth/email-verification`)
+      .send({ token: 123 });
+    expect(invalidVerifyTokenResponse.status).toBe(400);
+
+    const tokenEntity = await tokenRepository.findOneByUserIdAndType(
+      userEntity!.id,
+      TokenType.EMAIL,
+    );
+
+    // Valid verification
+    const verifyTokenResponse = await request(app.getHttpServer())
+      .post(`/auth/email-verification`)
+      .send({ token: tokenEntity!.uuid });
+
+    expect(verifyTokenResponse.status).toBe(200);
+
+    const updatedUserEntity = await userRepository.findByEmail(email);
+    expect(updatedUserEntity!.status).toBe(UserStatus.ACTIVE);
+
+    // User Authentication
+    const signInResponse = await request(app.getHttpServer())
+      .post('/auth/signin')
+      .send({
+        email,
+        password,
+        h_captcha_token: hCaptchaToken,
+      });
+    expect(signInResponse.status).toBe(200);
+
+    const refreshedUserEntity = await userRepository.findByEmail(email);
+    const refreshTokenEntity = await tokenRepository.findOneByUserIdAndType(
+      refreshedUserEntity!.id,
+      TokenType.REFRESH,
+    );
+    expect(refreshTokenEntity).toBeDefined();
+
+    // Invalid Authentication
+    const invalidSignInResponse = await request(app.getHttpServer())
+      .post('/auth/signin')
+      .send({
+        email,
+        password: 'Incorrect',
+        h_captcha_token: hCaptchaToken,
+      });
+    expect(invalidSignInResponse.status).toBe(403);
+
+    // Refresh Token
+    const refreshTokenResponse = await request(app.getHttpServer())
+      .post('/auth/refresh')
+      .send({ refresh_token: refreshTokenEntity!.uuid }); // Add appropriate data if needed
+
+    expect(refreshTokenResponse.status).toBe(200);
+    expect(refreshTokenResponse.body).toHaveProperty('access_token');
+    expect(refreshTokenResponse.body).toHaveProperty('refresh_token');
+
+    const accessToken = refreshTokenResponse.body.access_token;
+    const refreshToken = refreshTokenResponse.body.refresh_token;
+
+    // Resend Email Verification
+    const resendEmailVerificationResponse = await request(app.getHttpServer())
+      .post('/auth/resend-email-verification')
+      .set('Authorization', `Bearer ${accessToken}`)
+      .send({ email });
+    expect(resendEmailVerificationResponse.status).toBe(204);
+  });
+});

packages/apps/job-launcher/server/test/e2e/env-setup.ts

@@ -0,0 +1,76 @@
+export default function setupE2eEnvironment() {
+  process.env.NODE_ENV = 'test-e2e';
+  process.env.S3_ACCESS_KEY = 'value';
+
+  process.env.POSTGRES_DATABASE = 'job-launcher';
+  process.env.POSTGRES_PASSWORD = 'qwerty';
+  process.env.POSTGRES_USER = 'default';
+  process.env.POSTGRES_HOST = '0.0.0.0';
+
+  process.env.SESSION_SECRET = 'test';
+  process.env.POSTGRES_HOST = '0.0.0.0';
+  process.env.POSTGRES_USER = 'default';
+  process.env.POSTGRES_PASSWORD = 'qwerty';
+  process.env.POSTGRES_DATABASE = 'job-launcher';
+  process.env.POSTGRES_PORT = '5432';
+  process.env.POSTGRES_SSL = 'false';
+
+  process.env.WEB3_ENV = 'localhost';
+  process.env.WEB3_PRIVATE_KEY =
+    '0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d';
+  process.env.GAS_PRICE_MULTIPLIER = '1';
+  process.env.PGP_ENCRYPT = 'false';
+  process.env.FORTUNE_EXCHANGE_ORACLE_ADDRESS =
+    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC';
+  process.env.FORTUNE_RECORDING_ORACLE_ADDRESS =
+    '0x90F79bf6EB2c4f870365E785982E1f101E93b906';
+  process.env.CVAT_EXCHANGE_ORACLE_ADDRESS =
+    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC';
+  process.env.CVAT_RECORDING_ORACLE_ADDRESS =
+    '0x90F79bf6EB2c4f870365E785982E1f101E93b906';
+  process.env.REPUTATION_ORACLE_ADDRESS =
+    '0x90F79bf6EB2c4f870365E785982E1f101E93b906';
+  process.env.HCAPTCHA_RECORDING_ORACLE_URI = 'a';
+  process.env.HCAPTCHA_REPUTATION_ORACLE_URI = 'a';
+  process.env.HCAPTCHA_ORACLE_ADDRESS = 'a';
+  process.env.HCAPTCHA_SITE_KEY = 'a';
+
+  process.env.HASH_SECRET = 'a328af3fc1dad15342cc3d68936008fa';
+  process.env.JWT_PRIVATE_KEY = `-----BEGIN EC PARAMETERS-----
+BggqhkjOPQMBBw==
+-----END EC PARAMETERS-----
+-----BEGIN EC PRIVATE KEY-----
+MHcCAQEEID2jVcOtjupW4yqNTz70nvmt1GSvqET5G7lpC0Gp31LFoAoGCCqGSM49
+AwEHoUQDQgAEUznVCoagfRCuMA3TfG51xWShNrMJt86lkzfAep9bfBxbaCBbUhJ1
+s9+9eeLMG/nUMAaGxWeOwJ92L/KvzN6RFw==
+-----END EC PRIVATE KEY-----`;
+
+  process.env.JWT_PUBLIC_KEY = `-----BEGIN PUBLIC KEY-----
+MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUznVCoagfRCuMA3TfG51xWShNrMJ
+t86lkzfAep9bfBxbaCBbUhJ1s9+9eeLMG/nUMAaGxWeOwJ92L/KvzN6RFw==
+-----END PUBLIC KEY-----`;
+  process.env.JWT_ACCESS_TOKEN_EXPIRES_IN = '600';
+  process.env.JWT_REFRESH_TOKEN_EXPIRES_IN = '1d';
+
+  process.env.S3_ENDPOINT = 'localhost';
+  process.env.S3_PORT = '9000';
+  process.env.S3_ACCESS_KEY = 'access-key';
+  process.env.S3_SECRET_KEY = 'secret-key';
+  process.env.S3_BUCKET = 'bucket';
+  process.env.S3_USE_SSL = 'false';
+
+  process.env.MINIO_ROOT_USER = 'access-key';
+  process.env.MINIO_ROOT_PASSWORD = 'secrets-key';
+
+  process.env.STRIPE_SECRET_KEY =
+    'sk_test_GvCQRGFcSwDzNE9wBSaH6MbBzk6yUntQp5GSGjDU7VzMpkJpVq32kYx52EBP9t4Gin5UQ9nYwprq7ZRNPTQG4gvdUuTwYEGy7rp';
+  process.env.STRIPE_API_VERSION = '2022-11-15';
+  process.env.STRIPE_APP_NAME = 'Staging Launcher Server';
+  process.env.STRIPE_APP_VERSION = '1.0.0';
+  process.env.STRIPE_APP_INFO_URL =
+    'https://github.com/humanprotocol/human-protocol/tree/main/packages/apps/job-launcher/server';
+
+  process.env.SENDGRID_API_KEY = 'sendgrid-disabled';
+
+  process.env.CRON_SECRET = 'test';
+}