Refactor

packages/indexer-database/src/utils/BaseRepository.ts

@@ -1,18 +1,6 @@
 import { DataSource, EntityTarget, ObjectLiteral } from "typeorm";
 import winston from "winston";
 
-import { SaveQueryResultType, SaveQueryResult } from "../model";
-
-export function filterSaveQueryResults<Entity extends ObjectLiteral>(
-  results: SaveQueryResult<Entity>[],
-  type: SaveQueryResultType,
-) {
-  return results
-    .filter((result) => result.result === type)
-    .map((result) => result.data)
-    .filter((data) => data !== undefined);
-}
-
 export class BaseRepository {
   constructor(
     protected postgres: DataSource,
@@ -71,104 +59,4 @@ export class BaseRepository {
 
     return savedData.generatedMaps as Entity[];
   }
-
-  /**
-   * Saves the entities to the database.
-   * @param entity - The entity to save.
-   * @param data - The data to save.
-   * @param uniqueKeys
-   * The unique keys to check for. It is recommended these keys to be indexed columns, so that the query is faster.
-   * @param comparisonKeys - The keys to compare for changes.
-   */
-  protected async saveAndHandleFinalisationBatch<Entity extends ObjectLiteral>(
-    entity: EntityTarget<Entity>,
-    data: Partial<Entity>[],
-    uniqueKeys: (keyof Entity)[],
-    comparisonKeys: (keyof Entity)[],
-  ): Promise<SaveQueryResult<Entity>[]> {
-    return Promise.all(
-      data.map((dataItem) =>
-        this.saveAndHandleFinalisation(
-          entity,
-          dataItem,
-          uniqueKeys,
-          comparisonKeys,
-        ),
-      ),
-    );
-  }
-
-  /**
-   * Saves the entity to the database.
-   * @param entity - The entity to save.
-   * @param data - The data to save.
-   * @param uniqueKeys
-   * The unique keys to check for. It is recommended these keys to be indexed columns, so that the query is faster.
-   * @param comparisonKeys - The keys to compare for changes.
-   */
-  protected async saveAndHandleFinalisation<Entity extends ObjectLiteral>(
-    entity: EntityTarget<Entity>,
-    data: Partial<Entity>,
-    uniqueKeys: (keyof Entity)[],
-    comparisonKeys: (keyof Entity)[],
-  ): Promise<SaveQueryResult<Entity>> {
-    const where = uniqueKeys.reduce(
-      (acc, key) => {
-        acc[key] = data[key];
-        return acc;
-      },
-      {} as Record<keyof Entity, any>,
-    );
-    const dbEntity = await this.postgres
-      .getRepository(entity)
-      .findOne({ where });
-
-    if (!dbEntity) {
-      await this.postgres.getRepository(entity).insert(data);
-      return {
-        data: (await this.postgres
-          .getRepository(entity)
-          .findOne({ where })) as Entity,
-        result: SaveQueryResultType.Inserted,
-      };
-    }
-
-    // Check if the any of values of the comparison keys have changed
-    const isChanged = comparisonKeys.some((key) => data[key] !== dbEntity[key]);
-    // Check if the data moved in finalised state
-    const isFinalisedChanged = data.finalised && !dbEntity.finalised;
-
-    if (isChanged) {
-      await this.postgres.getRepository(entity).update(where, data);
-      if (isFinalisedChanged) {
-        return {
-          data: (await this.postgres
-            .getRepository(entity)
-            .findOne({ where })) as Entity,
-          result: SaveQueryResultType.UpdatedAndFinalised,
-        };
-      }
-      return {
-        data: (await this.postgres
-          .getRepository(entity)
-          .findOne({ where })) as Entity,
-        result: SaveQueryResultType.Updated,
-      };
-    }
-
-    if (isFinalisedChanged) {
-      await this.postgres.getRepository(entity).update(where, data);
-      return {
-        data: (await this.postgres
-          .getRepository(entity)
-          .findOne({ where })) as Entity,
-        result: SaveQueryResultType.Finalised,
-      };
-    }
-
-    return {
-      data: undefined,
-      result: SaveQueryResultType.Nothing,
-    };
-  }
 }

packages/indexer-database/src/utils/BlockchainEventRepository.ts

@@ -0,0 +1,121 @@
+import { DataSource, EntityTarget, ObjectLiteral } from "typeorm";
+import winston from "winston";
+
+import { SaveQueryResultType, SaveQueryResult } from "../model";
+
+export function filterSaveQueryResults<Entity extends ObjectLiteral>(
+  results: SaveQueryResult<Entity>[],
+  type: SaveQueryResultType,
+) {
+  return results
+    .filter((result) => result.result === type)
+    .map((result) => result.data)
+    .filter((data) => data !== undefined);
+}
+
+export class BlockchainEventRepository {
+  constructor(
+    protected postgres: DataSource,
+    protected logger: winston.Logger,
+  ) {}
+
+  /**
+   * Saves the entities to the database.
+   * @param entity - The entity to save.
+   * @param data - The data to save.
+   * @param uniqueKeys
+   * The unique keys to check for. It is recommended these keys to be indexed columns, so that the query is faster.
+   * @param comparisonKeys - The keys to compare for changes.
+   */
+  protected async saveAndHandleFinalisationBatch<Entity extends ObjectLiteral>(
+    entity: EntityTarget<Entity>,
+    data: Partial<Entity>[],
+    uniqueKeys: (keyof Entity)[],
+    comparisonKeys: (keyof Entity)[],
+  ): Promise<SaveQueryResult<Entity>[]> {
+    return Promise.all(
+      data.map((dataItem) =>
+        this.saveAndHandleFinalisation(
+          entity,
+          dataItem,
+          uniqueKeys,
+          comparisonKeys,
+        ),
+      ),
+    );
+  }
+
+  /**
+   * Saves the entity to the database.
+   * @param entity - The entity to save.
+   * @param data - The data to save.
+   * @param uniqueKeys
+   * The unique keys to check for. It is recommended these keys to be indexed columns, so that the query is faster.
+   * @param comparisonKeys - The keys to compare for changes.
+   */
+  protected async saveAndHandleFinalisation<Entity extends ObjectLiteral>(
+    entity: EntityTarget<Entity>,
+    data: Partial<Entity>,
+    uniqueKeys: (keyof Entity)[],
+    comparisonKeys: (keyof Entity)[],
+  ): Promise<SaveQueryResult<Entity>> {
+    const where = uniqueKeys.reduce(
+      (acc, key) => {
+        acc[key] = data[key];
+        return acc;
+      },
+      {} as Record<keyof Entity, any>,
+    );
+    const dbEntity = await this.postgres
+      .getRepository(entity)
+      .findOne({ where });
+
+    if (!dbEntity) {
+      await this.postgres.getRepository(entity).insert(data);
+      return {
+        data: (await this.postgres
+          .getRepository(entity)
+          .findOne({ where })) as Entity,
+        result: SaveQueryResultType.Inserted,
+      };
+    }
+
+    // Check if the any of values of the comparison keys have changed
+    const isChanged = comparisonKeys.some((key) => data[key] !== dbEntity[key]);
+    // Check if the data moved in finalised state
+    const isFinalisedChanged = data.finalised && !dbEntity.finalised;
+
+    if (isChanged) {
+      await this.postgres.getRepository(entity).update(where, data);
+      if (isFinalisedChanged) {
+        return {
+          data: (await this.postgres
+            .getRepository(entity)
+            .findOne({ where })) as Entity,
+          result: SaveQueryResultType.UpdatedAndFinalised,
+        };
+      }
+      return {
+        data: (await this.postgres
+          .getRepository(entity)
+          .findOne({ where })) as Entity,
+        result: SaveQueryResultType.Updated,
+      };
+    }
+
+    if (isFinalisedChanged) {
+      await this.postgres.getRepository(entity).update(where, data);
+      return {
+        data: (await this.postgres
+          .getRepository(entity)
+          .findOne({ where })) as Entity,
+        result: SaveQueryResultType.Finalised,
+      };
+    }
+
+    return {
+      data: undefined,
+      result: SaveQueryResultType.Nothing,
+    };
+  }
+}

packages/indexer-database/src/utils/index.ts

@@ -1 +1,2 @@
 export * from "./BaseRepository";
+export * from "./BlockchainEventRepository";

packages/indexer/src/database/SpokePoolRepository.ts

@@ -3,13 +3,13 @@ import * as across from "@across-protocol/sdk";
 import { DataSource, entities, utils as dbUtils } from "@repo/indexer-database";
 import * as utils from "../utils";
 
-export class SpokePoolRepository extends dbUtils.BaseRepository {
+export class SpokePoolRepository extends dbUtils.BlockchainEventRepository {
   constructor(
     postgres: DataSource,
     logger: winston.Logger,
     private chunkSize = 2000,
   ) {
-    super(postgres, logger, true);
+    super(postgres, logger);
   }
 
   public updateDepositEventWithIntegratorId(id: number, integratorId: string) {