chore: add isLegacy column to actions table

Signed-off-by: Tomás Migone <[email protected]>

Author: tmigone

packages/indexer-agent/src/db/migrations/19-actions-add-islegacy.ts

@@ -0,0 +1,52 @@
+import { Logger } from '@graphprotocol/common-ts'
+import { DataTypes, QueryInterface } from 'sequelize'
+
+interface MigrationContext {
+  queryInterface: QueryInterface
+  logger: Logger
+}
+
+interface Context {
+  context: MigrationContext
+}
+
+export async function up({ context }: Context): Promise<void> {
+  const { queryInterface, logger } = context
+
+  logger.debug(`Checking if 'Actions' table exists`)
+  const tables = await queryInterface.showAllTables()
+  if (!tables.includes('Actions')) {
+    logger.info(`Actions table does not exist, migration not necessary`)
+    return
+  }
+
+  logger.debug(`Checking if 'Actions' table needs to be migrated`)
+  const table = await queryInterface.describeTable('Actions')
+  const isLegacy = table.isLegacy
+  if (isLegacy) {
+    logger.info(`'isLegacy' column already exists, migration not necessary`)
+    return
+  }
+
+  logger.info(`Add 'isLegacy' column to 'Actions' table`)
+  await queryInterface.addColumn('Actions', 'isLegacy', {
+    type: DataTypes.BOOLEAN,
+    allowNull: false,
+    defaultValue: true,
+  })
+}
+
+export async function down({ context }: Context): Promise<void> {
+  const { queryInterface, logger } = context
+
+  return await queryInterface.sequelize.transaction({}, async transaction => {
+    const tables = await queryInterface.showAllTables()
+
+    if (tables.includes('Actions')) {
+      logger.info(`Remove 'isLegacy' column`)
+      await context.queryInterface.removeColumn('Actions', 'isLegacy', {
+        transaction,
+      })
+    }
+  })
+}

packages/indexer-cli/src/actions.ts

@@ -36,6 +36,11 @@ export async function buildActionInput(
   protocolNetwork: string,
 ): Promise<ActionInput> {
   await validateActionInput(type, actionParams)
+
+  // TODO: we could check isHorizon status here to set the proper value for isLegacy, but it requires multiNetworks
+  // The IndexerManagementServer will set the correct value anyways
+  const isLegacy = false
+
   switch (type) {
     case ActionType.ALLOCATE:
       return {
@@ -47,6 +52,7 @@ export async function buildActionInput(
         status,
         priority,
         protocolNetwork,
+        isLegacy,
       }
     case ActionType.UNALLOCATE: {
       let poi = actionParams.param2
@@ -64,6 +70,7 @@ export async function buildActionInput(
         status,
         priority,
         protocolNetwork,
+        isLegacy,
       }
     }
     case ActionType.REALLOCATE: {
@@ -83,6 +90,7 @@ export async function buildActionInput(
         status,
         priority,
         protocolNetwork,
+        isLegacy,
       }
     }
   }

packages/indexer-common/src/actions.ts

@@ -46,6 +46,7 @@ export interface ActionInput {
   status: ActionStatus
   priority: number | undefined
   protocolNetwork: string
+  isLegacy: boolean
 }
 
 export const isValidActionInput = (
@@ -161,6 +162,7 @@ export interface ActionFilter {
   reason?: string
   updatedAt?: WhereOperators
   protocolNetwork?: string
+  isLegacy?: boolean
 }
 
 export const actionFilterToWhereOptions = (filter: ActionFilter): WhereOptions => {
@@ -192,6 +194,7 @@ export interface ActionResult {
   failureReason: string | null
   transaction: string | null
   protocolNetwork: string
+  isLegacy: boolean
 }
 
 export enum ActionType {

packages/indexer-common/src/indexer-management/__tests__/helpers.test.ts

@@ -246,6 +246,7 @@ describe('Actions', () => {
       priority: 0,
       //  When writing directly to the database, `protocolNetwork` must be in the CAIP2-ID format.
       protocolNetwork: 'eip155:421614',
+      isLegacy: true,
     }
 
     await models.Action.upsert(action)
@@ -283,6 +284,14 @@ describe('Actions', () => {
         updatedAt: { [Op.lte]: literal("NOW() - INTERVAL '1d'") },
       }),
     ).resolves.toHaveLength(0)
+
+    await expect(
+      ActionManager.fetchActions(models, null, {
+        status: ActionStatus.FAILED,
+        type: ActionType.ALLOCATE,
+        isLegacy: true,
+      }),
+    ).resolves.toHaveLength(1)
   })
 })
 describe('Types', () => {

packages/indexer-common/src/indexer-management/actions.ts

@@ -112,6 +112,7 @@ export class ActionManager {
           oldestAffectedAllocationCreatedAtEpoch:
             affectedAllocations[0]?.createdAtEpoch ??
             'no action in the batch affects existing allocations',
+          oldestAffectedAllocationIsLegacy: affectedAllocations[0]?.isLegacy,
           affectedAllocationExpiring,
         },
       )

packages/indexer-common/src/indexer-management/models/action.ts

@@ -37,6 +37,8 @@ export class Action extends Model<
 
   declare protocolNetwork: string
 
+  declare isLegacy: boolean
+
   // eslint-disable-next-line @typescript-eslint/ban-types
   public toGraphQL(): object {
     return { ...this.toJSON(), __typename: 'Action' }
@@ -152,6 +154,11 @@ export const defineActionModels = (sequelize: Sequelize): ActionModels => {
           is: caip2IdRegex,
         },
       },
+      isLegacy: {
+        type: DataTypes.BOOLEAN,
+        allowNull: false,
+        defaultValue: true,
+      },
     },
     {
       modelName: 'Action',

packages/indexer-common/src/indexer-management/resolvers/actions.ts

@@ -20,6 +20,7 @@ import {
 import { literal, Op, Transaction } from 'sequelize'
 import { ActionManager } from '../actions'
 import groupBy from 'lodash.groupby'
+import { extractNetwork } from './utils'
 
 // Perform insert, update, or no-op depending on existing queue data
 // INSERT - No item in the queue yet targeting this deploymentID
@@ -170,6 +171,14 @@ export default {
       }
     })
 
+    // Set proper value for isLegacy - any new actions in horizon are not legacy
+    await Promise.all(
+      actions.map(async (action) => {
+        const network = extractNetwork(action.protocolNetwork, multiNetworks)
+        action.isLegacy = !(await network.isHorizon.value())
+      }),
+    )
+
     // Let Network Monitors validate actions based on their protocol networks
     await multiNetworks.mapNetworkMapped(
       groupBy(actions, (action) => action.protocolNetwork),