Update BlockTable.getLatest to throw an error and simplify logic (#915)

* Update BlockTable.getLatest to throw an error and simplify logic * nit * nits * lint * fix * lint
dydxprotocol · Jan 2, 2024 · 5ef9175 · 5ef9175
1 parent 3f5654d
commit 5ef9175
Show file tree

Hide file tree

Showing 15 changed files with 65 additions and 57 deletions.
diff --git a/indexer/packages/base/src/stats-util.ts b/indexer/packages/base/src/stats-util.ts
@@ -11,7 +11,17 @@ export async function runFuncWithTimingStat(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): Promise<any> {
   const start: number = Date.now();
-  const result = await promise;
+  let result;
+  try {
+    result = await promise;
+  } catch (error) {
+    stats.timing(
+      `${config.SERVICE_NAME}.${functionName ?? STATS_FUNCTION_NAME}.timing`,
+      Date.now() - start,
+      options,
+    );
+    throw error;
+  }
   stats.timing(
     `${config.SERVICE_NAME}.${functionName ?? STATS_FUNCTION_NAME}.timing`,
     Date.now() - start,

diff --git a/indexer/packages/postgres/__tests__/stores/block-table.test.ts b/indexer/packages/postgres/__tests__/stores/block-table.test.ts
@@ -84,12 +84,11 @@ describe('Block store', () => {
       BlockTable.create(defaultBlock2),
     ]);
 
-    const block: BlockFromDatabase | undefined = await BlockTable.getLatest();
+    const block: BlockFromDatabase = await BlockTable.getLatest();
     expect(block).toEqual(expect.objectContaining(defaultBlock2));
   });
 
   it('Unable to find latest Block', async () => {
-    const block: BlockFromDatabase | undefined = await BlockTable.getLatest();
-    expect(block).toEqual(undefined);
+    await expect(BlockTable.getLatest()).rejects.toEqual(new Error('Unable to find latest block'));
   });
 });
diff --git a/indexer/packages/postgres/src/stores/block-table.ts b/indexer/packages/postgres/src/stores/block-table.ts
@@ -1,3 +1,4 @@
+import { logger } from '@dydxprotocol-indexer/base';
 import { QueryBuilder } from 'objection';
 
 import { DEFAULT_POSTGRES_OPTIONS } from '../constants';
@@ -91,7 +92,7 @@ export async function findByBlockHeight(
 
 export async function getLatest(
   options: Options = DEFAULT_POSTGRES_OPTIONS,
-): Promise<BlockFromDatabase | undefined> {
+): Promise<BlockFromDatabase> {
   const baseQuery: QueryBuilder<BlockModel> = setupBaseQuery<BlockModel>(
     BlockModel,
     options,
@@ -102,5 +103,13 @@ export async function getLatest(
     .limit(1)
     .returning('*');
 
-  return results[0];
+  const latestBlock: BlockFromDatabase | undefined = results[0];
+  if (latestBlock === undefined) {
+    logger.error({
+      at: 'block-table#getLatest',
+      message: 'Unable to find latest block',
+    });
+    throw new Error('Unable to find latest block');
+  }
+  return latestBlock;
 }
diff --git a/indexer/services/comlink/__tests__/controllers/api/v4/height-controller.test.ts b/indexer/services/comlink/__tests__/controllers/api/v4/height-controller.test.ts
@@ -26,7 +26,7 @@ describe('height-controller#V4', () => {
 
     it('Get /height gets latest block', async () => {
       await testMocks.seedData();
-      const latestBlock: BlockFromDatabase | undefined = await BlockTable.getLatest();
+      const latestBlock: BlockFromDatabase = await BlockTable.getLatest();
       const block: any = await sendRequest({
         type: RequestMethod.GET,
         path: '/v4/height',

diff --git a/indexer/services/comlink/__tests__/lib/helpers.test.ts b/indexer/services/comlink/__tests__/lib/helpers.test.ts
@@ -290,7 +290,7 @@ describe('helpers', () => {
         latestBlock,
       ]: [
         SubaccountFromDatabase | undefined,
-        BlockFromDatabase | undefined,
+        BlockFromDatabase,
       ] = await Promise.all([
         SubaccountTable.findById(testConstants.defaultSubaccountId),
         BlockTable.getLatest(),

diff --git a/indexer/services/comlink/src/controllers/api/v4/addresses-controller.ts b/indexer/services/comlink/src/controllers/api/v4/addresses-controller.ts
@@ -82,7 +82,7 @@ class AddressesController extends Controller {
   ): Promise<SubaccountResponseObject[]> {
     // TODO(IND-189): Use a transaction across all the DB queries
     const [subaccounts, latestBlock]:
-    [SubaccountFromDatabase[], BlockFromDatabase | undefined] = await Promise.all([
+    [SubaccountFromDatabase[], BlockFromDatabase] = await Promise.all([
       SubaccountTable.findAll(
         {
           address,
@@ -92,7 +92,7 @@ class AddressesController extends Controller {
       BlockTable.getLatest(),
     ]);
 
-    if (subaccounts.length === 0 || latestBlock === undefined) {
+    if (subaccounts.length === 0) {
       throw new NotFoundError(`No subaccounts found for address ${address}`);
     }
 
@@ -175,7 +175,7 @@ class AddressesController extends Controller {
       AssetPositionFromDatabase[],
       AssetFromDatabase[],
       MarketFromDatabase[],
-      BlockFromDatabase | undefined,
+      BlockFromDatabase,
     ] = await Promise.all([
       SubaccountTable.findById(
         subaccountId,
@@ -197,7 +197,7 @@ class AddressesController extends Controller {
       BlockTable.getLatest(),
     ]);
 
-    if (subaccount === undefined || latestBlock === undefined) {
+    if (subaccount === undefined) {
       throw new NotFoundError(
         `No subaccount found with address ${address} and subaccountNumber ${subaccountNumber}`,
       );

diff --git a/indexer/services/comlink/src/controllers/api/v4/asset-positions-controller.ts b/indexer/services/comlink/src/controllers/api/v4/asset-positions-controller.ts
@@ -74,7 +74,7 @@ class AddressesController extends Controller {
       AssetPositionFromDatabase[],
       PerpetualPositionFromDatabase[],
       AssetFromDatabase[],
-      BlockFromDatabase | undefined,
+      BlockFromDatabase,
     ] = await Promise.all([
       SubaccountTable.findById(
         subaccountUuid,
@@ -116,7 +116,7 @@ class AddressesController extends Controller {
 
     // If a subaccount, latest block, and perpetual positions exist, calculate the unsettled funding
     // for positions and adjust the returned USDC position
-    if (subaccount !== undefined && latestBlock !== undefined && perpetualPositions.length > 0) {
+    if (subaccount !== undefined && perpetualPositions.length > 0) {
       const {
         lastUpdatedFundingIndexMap,
         latestFundingIndexMap,

diff --git a/indexer/services/comlink/src/controllers/api/v4/height-controller.ts b/indexer/services/comlink/src/controllers/api/v4/height-controller.ts
@@ -19,16 +19,15 @@ const controllerName: string = 'height-controller';
 class HeightController extends Controller {
   @Get('/')
   async getHeight(): Promise<HeightResponse> {
-    const latestBlock: BlockFromDatabase | undefined = await BlockTable.getLatest();
-
-    if (latestBlock === undefined) {
+    try {
+      const latestBlock: BlockFromDatabase = await BlockTable.getLatest();
+      return {
+        height: latestBlock.blockHeight,
+        time: latestBlock.time,
+      };
+    } catch {
       throw new NotFoundError('No blocks found');
     }
-
-    return {
-      height: latestBlock.blockHeight,
-      time: latestBlock.time,
-    };
   }
 }
 

diff --git a/indexer/services/ender/src/caches/block-cache.ts b/indexer/services/ender/src/caches/block-cache.ts
@@ -17,9 +17,16 @@ const INITIAL_BLOCK_HEIGHT: string = '-1';
 let currentBlockHeight: string = INITIAL_BLOCK_HEIGHT;
 
 export async function refreshBlockCache(txId?: number): Promise<void> {
-  const block: BlockFromDatabase | undefined = await BlockTable.getLatest({ txId });
-  if (block !== undefined) {
+  try {
+    const block: BlockFromDatabase = await BlockTable.getLatest({ txId });
     currentBlockHeight = block.blockHeight;
+  } catch (error) { // Unable to find latest block
+    logger.info({
+      at: 'block-cache#refreshBlockCache',
+      message: 'Unable to refresh block cache most likely due to unable to find latest block',
+      error,
+    });
+
   }
 }
 

diff --git a/indexer/services/roundtable/src/tasks/cancel-stale-orders.ts b/indexer/services/roundtable/src/tasks/cancel-stale-orders.ts
@@ -1,5 +1,4 @@
 import {
-  logger,
   stats,
 } from '@dydxprotocol-indexer/base';
 import {
@@ -17,18 +16,10 @@ import config from '../config';
 // and the orders have their status correctly set
 export default async function runTask(): Promise<void> {
   const queryStart: number = Date.now();
-  const latestBlock: BlockFromDatabase | undefined = await BlockTable.getLatest({
+  const latestBlock: BlockFromDatabase = await BlockTable.getLatest({
     readReplica: true,
   });
 
-  if (latestBlock === undefined) {
-    logger.info({
-      at: 'close-stale-orders#getLatestBlockHeight',
-      message: 'No latest block height found. Skipping task',
-    });
-    return;
-  }
-
   const latestBlockHeight: number = parseInt(latestBlock.blockHeight, 10);
 
   const staleOpenOrders: OrderFromDatabase[] = await OrderTable.findAll(

diff --git a/indexer/services/roundtable/src/tasks/create-pnl-ticks.ts b/indexer/services/roundtable/src/tasks/create-pnl-ticks.ts
@@ -8,7 +8,6 @@ import {
 } from '@dydxprotocol-indexer/postgres';
 import { LatestAccountPnlTicksCache } from '@dydxprotocol-indexer/redis';
 import _ from 'lodash';
-import { DateTime } from 'luxon';
 
 import config from '../config';
 import { getPnlTicksCreateObjects } from '../helpers/pnl-ticks-helper';
@@ -31,14 +30,14 @@ export default async function runTask(): Promise<void> {
     block,
     pnlTickLatestBlocktime,
   ]: [
-    BlockFromDatabase | undefined,
+    BlockFromDatabase,
     string,
   ] = await Promise.all([
     BlockTable.getLatest({ readReplica: true }),
     PnlTicksTable.findLatestProcessedBlocktime(),
   ]);
-  const latestBlockTime: string = block !== undefined ? block.time : DateTime.utc(0).toISO();
-  const latestBlockHeight: string = block !== undefined ? block.blockHeight : '0';
+  const latestBlockTime: string = block.time;
+  const latestBlockHeight: string = block.blockHeight;
   // Check that the latest block time is within PNL_TICK_UPDATE_INTERVAL_MS of the last computed
   // PNL tick block time.
   if (

diff --git a/indexer/services/roundtable/src/tasks/remove-expired-orders.ts b/indexer/services/roundtable/src/tasks/remove-expired-orders.ts
@@ -26,14 +26,7 @@ import { getExpiredOffChainUpdateMessage } from '../helpers/websocket';
  */
 export default async function runTask(): Promise<void> {
   const start: number = Date.now();
-  const block: BlockFromDatabase | undefined = await BlockTable.getLatest({ readReplica: true });
-  if (block === undefined) {
-    logger.error({
-      at: 'remove-expired-orders#runTask',
-      message: 'Unable to find latest block',
-    });
-    return;
-  }
+  const block: BlockFromDatabase = await BlockTable.getLatest({ readReplica: true });
 
   try {
     // Only need to expire short-term orders because long-term OrderRemoves will be on-chain.

diff --git a/indexer/services/roundtable/src/tasks/track-lag.ts b/indexer/services/roundtable/src/tasks/track-lag.ts
@@ -28,7 +28,7 @@ export default async function runTask(): Promise<void> {
     validatorBlock,
     otherFullNodeBlock,
   ]: [
-    BlockFromDatabase | undefined,
+    BlockFromDatabase,
     BlockData,
     BlockData,
     BlockData,
@@ -39,10 +39,6 @@ export default async function runTask(): Promise<void> {
     getValidatorBlockData(config.TRACK_LAG_OTHER_FULL_NODE_URL, 'other_full_node'),
   ]);
 
-  if (indexerBlockFromDatabase === undefined) {
-    return;
-  }
-
   const indexerBlock: BlockData = {
     block: indexerBlockFromDatabase.blockHeight,
     timestamp: indexerBlockFromDatabase.time,

diff --git a/indexer/services/vulcan/__tests__/handlers/order-remove-handler.test.ts b/indexer/services/vulcan/__tests__/handlers/order-remove-handler.test.ts
@@ -1705,7 +1705,10 @@ describe('OrderRemoveHandler', () => {
       const removedRedisOrder: RedisOrder = redisTestConstants.defaultRedisOrder;
       const expectedOrderUuid: string = redisTestConstants.defaultOrderUuid;
 
-      const tableSpy = jest.spyOn(BlockTable, 'getLatest').mockResolvedValueOnce(undefined);
+      // eslint-disable-next-line @typescript-eslint/require-await
+      const tableSpy = jest.spyOn(BlockTable, 'getLatest').mockImplementation(async () => {
+        throw new Error();
+      });
 
       try {
         const orderRemoveJson: OrderRemoveV1 = { ...indexerExpiredOrderRemoved, removedOrderId };

diff --git a/indexer/services/vulcan/src/handlers/order-remove-handler.ts b/indexer/services/vulcan/src/handlers/order-remove-handler.ts
@@ -393,11 +393,13 @@ export class OrderRemoveHandler extends Handler {
    * update since it occurred which would invalidate the message.
    */
   protected async isOrderExpired(orderRemove: OrderRemoveV1): Promise<boolean> {
-    const block: BlockFromDatabase | undefined = await runFuncWithTimingStat(
-      BlockTable.getLatest({ readReplica: true }),
-      this.generateTimingStatsOptions('get_latest_block_for_indexer_expired_expiry_verification'),
-    );
-    if (block === undefined) {
+    let block: BlockFromDatabase;
+    try {
+      block = await runFuncWithTimingStat(
+        BlockTable.getLatest({ readReplica: true }),
+        this.generateTimingStatsOptions('get_latest_block_for_indexer_expired_expiry_verification'),
+      );
+    } catch {
       logger.error({
         at: 'orderRemoveHandler#isOrderExpired',
         message: 'Unable to find latest block',