[Reputation Oracle] refactor: typeorm usage (#3154)

* fix: db entities usage bypassing repository

* refactor: use typeorm Data Mapper instead of Active Record

* refactor: cleanup typeorm configs

* fix: entity schema out of datasource

Author: dnechay

packages/apps/reputation-oracle/server/package.json

@@ -13,10 +13,10 @@
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/src/main",
     "migration:create": "yarn build && typeorm-ts-node-commonjs migration:create",
-    "migration:generate": "yarn build && typeorm-ts-node-commonjs migration:generate -d typeorm.config.ts",
-    "migration:revert": "yarn build && typeorm-ts-node-commonjs migration:revert -d typeorm.config.ts",
-    "migration:run": "yarn build && typeorm-ts-node-commonjs migration:run -d typeorm.config.ts",
-    "migration:show": "yarn build && typeorm-ts-node-commonjs migration:show -d typeorm.config.ts",
+    "migration:generate": "yarn build && typeorm-ts-node-commonjs migration:generate -d typeorm-migrations-datasource.ts",
+    "migration:revert": "yarn build && typeorm-ts-node-commonjs migration:revert -d typeorm-migrations-datasource.ts",
+    "migration:run": "yarn build && typeorm-ts-node-commonjs migration:run -d typeorm-migrations-datasource.ts",
+    "migration:show": "yarn build && typeorm-ts-node-commonjs migration:show -d typeorm-migrations-datasource.ts",
     "docker:db:up": "docker compose up -d postgres && yarn migration:run",
     "docker:db:down": "docker compose down postgres",
     "setup:local": "ts-node ./test/setup.ts",

packages/apps/reputation-oracle/server/src/common/constants/index.ts

@@ -1,4 +1,4 @@
-export const NS = 'hmt';
+export const DATABASE_SCHEMA_NAME = 'hmt';
 export const INITIAL_REPUTATION = 0;
 export const JWT_STRATEGY_NAME = 'jwt-http';
 

packages/apps/reputation-oracle/server/src/database/base.entity.ts

@@ -1,30 +1,29 @@
 import {
-  BaseEntity as OrmBaseEntity,
   BeforeInsert,
   BeforeUpdate,
   Column,
   PrimaryGeneratedColumn,
 } from 'typeorm';
 
-export abstract class BaseEntity extends OrmBaseEntity {
+export abstract class BaseEntity {
   @PrimaryGeneratedColumn()
-  public id: number;
+  id: number;
 
   @Column({ type: 'timestamptz' })
-  public createdAt: Date;
+  createdAt: Date;
 
   @Column({ type: 'timestamptz' })
-  public updatedAt: Date;
+  updatedAt: Date;
 
   @BeforeInsert()
-  public beforeInsert(): void {
+  protected beforeInsert(): void {
     const date = new Date();
     this.createdAt = date;
     this.updatedAt = date;
   }
 
   @BeforeUpdate()
-  public beforeUpdate(): void {
+  protected beforeUpdate(): void {
     const date = new Date();
     this.updatedAt = date;
   }

packages/apps/reputation-oracle/server/src/database/database.module.ts

@@ -1,10 +1,8 @@
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
-import * as path from 'path';
 import { LoggerOptions } from 'typeorm';
 import { SnakeNamingStrategy } from 'typeorm-naming-strategies';
 
-import { NS } from '../common/constants';
 import { ReputationEntity } from '../modules/reputation/reputation.entity';
 import { TokenEntity } from '../modules/auth/token.entity';
 import { UserEntity } from '../modules/user/user.entity';
@@ -18,7 +16,6 @@ import { WebhookIncomingEntity } from '../modules/webhook/webhook-incoming.entit
 import { WebhookOutgoingEntity } from '../modules/webhook/webhook-outgoing.entity';
 import { EscrowCompletionEntity } from '../modules/escrow-completion/escrow-completion.entity';
 import { EscrowPayoutsBatchEntity } from '../modules/escrow-completion/escrow-payouts-batch.entity';
-import Environment from '../utils/environment';
 
 import { TypeOrmLoggerModule, TypeOrmLoggerService } from './typeorm';
 
@@ -37,9 +34,31 @@ import { TypeOrmLoggerModule, TypeOrmLoggerService } from './typeorm';
             ? 'all'
             : ((loggerOptions as LoggerOptions) ?? false),
         );
+
         return {
-          name: 'default',
+          name: 'default-connection',
           type: 'postgres',
+
+          ...(databaseConfigService.url
+            ? {
+                url: databaseConfigService.url,
+              }
+            : {
+                host: databaseConfigService.host,
+                port: databaseConfigService.port,
+                username: databaseConfigService.user,
+                password: databaseConfigService.password,
+                database: databaseConfigService.database,
+              }),
+          ssl: databaseConfigService.ssl,
+
+          namingStrategy: new SnakeNamingStrategy(),
+          /**
+           * Schema synchronization should be done
+           * via manually running migrations
+           */
+          synchronize: false,
+          migrationsRun: false,
           entities: [
             WebhookIncomingEntity,
             WebhookOutgoingEntity,
@@ -54,29 +73,9 @@ import { TypeOrmLoggerModule, TypeOrmLoggerService } from './typeorm';
             QualificationEntity,
             UserQualificationEntity,
           ],
-          // We are using migrations, synchronize should be set to false.
-          synchronize: false,
-          // Run migrations automatically,
-          // you can disable this if you prefer running migration manually.
-          migrationsTableName: NS,
-          migrationsTransactionMode: 'each',
-          namingStrategy: new SnakeNamingStrategy(),
+
           logging: true,
-          // Allow both start:prod and start:dev to use migrations
-          // __dirname is either dist or server folder, meaning either
-          // the compiled js in prod or the ts in dev.
-          migrations: [path.join(__dirname, '/migrations/**/*{.ts,.js}')],
-          //"migrations": ["dist/migrations/*{.ts,.js}"],
           logger: typeOrmLoggerService,
-          url: databaseConfigService.url,
-          host: databaseConfigService.host,
-          port: databaseConfigService.port,
-          username: databaseConfigService.user,
-          password: databaseConfigService.password,
-          database: databaseConfigService.database,
-          keepConnectionAlive: Environment.isTest(),
-          migrationsRun: false,
-          ssl: databaseConfigService.ssl,
         };
       },
     }),

packages/apps/reputation-oracle/server/src/database/migrations/1694691302615-InitialMigration.ts

@@ -1,11 +1,11 @@
-import { NS } from '../../common/constants';
 import { MigrationInterface, QueryRunner } from 'typeorm';
+import { DATABASE_SCHEMA_NAME } from '../../common/constants';
 
 export class InitialMigration1694776006387 implements MigrationInterface {
   name = 'InitialMigration1694776006387';
 
   public async up(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.createSchema(NS, true);
+    await queryRunner.createSchema(DATABASE_SCHEMA_NAME, true);
     await queryRunner.query(
       `CREATE TYPE "hmt"."tokens_token_type_enum" AS ENUM('EMAIL', 'PASSWORD')`,
     );
@@ -61,6 +61,6 @@ export class InitialMigration1694776006387 implements MigrationInterface {
     await queryRunner.query(`DROP TYPE "hmt"."users_type_enum"`);
     await queryRunner.query(`DROP TABLE "hmt"."tokens"`);
     await queryRunner.query(`DROP TYPE "hmt"."tokens_token_type_enum"`);
-    await queryRunner.dropSchema(NS);
+    await queryRunner.dropSchema(DATABASE_SCHEMA_NAME);
   }
 }

packages/apps/reputation-oracle/server/src/modules/auth/auth.service.ts

@@ -278,7 +278,7 @@ export class AuthService {
     );
 
     if (existingToken) {
-      await existingToken.remove();
+      await this.tokenRepository.deleteOne(existingToken);
     }
 
     const tokenEntity = new TokenEntity();

packages/apps/reputation-oracle/server/src/modules/auth/token.entity.ts

@@ -9,7 +9,7 @@ import {
 
 import { UserEntity } from '../user/user.entity';
 import { BaseEntity } from '../../database/base.entity';
-import { NS } from '../../common/constants';
+import { DATABASE_SCHEMA_NAME } from '../../common/constants';
 import { IBase } from '../../common/interfaces/base';
 
 export enum TokenType {
@@ -23,7 +23,7 @@ export interface IToken extends IBase {
   type: TokenType;
 }
 
-@Entity({ schema: NS, name: 'tokens' })
+@Entity({ schema: DATABASE_SCHEMA_NAME, name: 'tokens' })
 @Index(['type', 'userId'], { unique: true })
 export class TokenEntity extends BaseEntity implements IToken {
   @Column({ type: 'uuid', unique: true })

packages/apps/reputation-oracle/server/src/modules/auth/token.repository.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import { BaseRepository } from '../../database/base.repository';
-import { DataSource, DeleteResult } from 'typeorm';
+import { DataSource } from 'typeorm';
 import { TokenEntity, TokenType } from './token.entity';
 
 @Injectable()
@@ -9,7 +9,7 @@ export class TokenRepository extends BaseRepository<TokenEntity> {
     super(TokenEntity, dataSource);
   }
 
-  public async findOneByUuidAndType(
+  async findOneByUuidAndType(
     uuid: string,
     type: TokenType,
   ): Promise<TokenEntity | null> {
@@ -22,7 +22,7 @@ export class TokenRepository extends BaseRepository<TokenEntity> {
     });
   }
 
-  public async findOneByUserIdAndType(
+  async findOneByUserIdAndType(
     userId: number,
     type: TokenType,
   ): Promise<TokenEntity | null> {
@@ -35,10 +35,10 @@ export class TokenRepository extends BaseRepository<TokenEntity> {
     });
   }
 
-  public async deleteOneByTypeAndUserId(
+  async deleteOneByTypeAndUserId(
     type: TokenType,
     userId: number,
-  ): Promise<DeleteResult> {
-    return this.delete({ type, userId });
+  ): Promise<void> {
+    await this.delete({ type, userId });
   }
 }

packages/apps/reputation-oracle/server/src/modules/cron-job/cron-job.entity.ts

@@ -1,11 +1,11 @@
 import { BeforeInsert, Column, Entity, Index } from 'typeorm';
 
-import { NS } from '../../common/constants';
 import { BaseEntity } from '../../database/base.entity';
+import { DATABASE_SCHEMA_NAME } from '../../common/constants';
 import { ICronJob } from '../../common/interfaces/cron-job';
 import { CronJobType } from '../../common/enums/cron-job';
 
-@Entity({ schema: NS, name: 'cron-jobs' })
+@Entity({ schema: DATABASE_SCHEMA_NAME, name: 'cron-jobs' })
 @Index(['cronJobType'], { unique: true })
 export class CronJobEntity extends BaseEntity implements ICronJob {
   @Column({

packages/apps/reputation-oracle/server/src/modules/escrow-completion/escrow-completion.entity.ts

@@ -1,11 +1,11 @@
 import { Column, Entity, Index } from 'typeorm';
 
-import { NS } from '../../common/constants';
 import { BaseEntity } from '../../database/base.entity';
+import { DATABASE_SCHEMA_NAME } from '../../common/constants';
 import { EscrowCompletionStatus } from '../../common/enums';
 import { ChainId } from '@human-protocol/sdk';
 
-@Entity({ schema: NS, name: 'escrow_completion_tracking' })
+@Entity({ schema: DATABASE_SCHEMA_NAME, name: 'escrow_completion_tracking' })
 @Index(['escrowAddress', 'chainId'], { unique: true })
 export class EscrowCompletionEntity extends BaseEntity {
   @Column({ type: 'int' })