common: improve auto-graft-sync error logging, docs

Author: dwerner

packages/indexer-agent/src/commands/start.ts

@@ -334,7 +334,7 @@ export const start = {
       })
   },
   // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any
-  handler: (_argv: any) => { },
+  handler: (_argv: any) => {},
 }
 
 export async function createNetworkSpecification(
@@ -690,13 +690,14 @@ export function reviewArgumentsForWarnings(argv: AgentOptions, logger: Logger) {
   if (collectReceiptsEndpoint) {
     logger.warn(
       "The option '--collect-receipts-endpoint' is deprecated. " +
-      "Please use the option '--gateway-endpoint' to inform the Gateway base URL.",
+        "Please use the option '--gateway-endpoint' to inform the Gateway base URL.",
     )
   }
 
   if (gasIncreaseTimeout < advisedGasIncreaseTimeout) {
     logger.warn(
-      `Gas increase timeout is set to less than ${gasIncreaseTimeout / 1000
+      `Gas increase timeout is set to less than ${
+        gasIncreaseTimeout / 1000
       } seconds. This may lead to high gas usage`,
       { gasIncreaseTimeout: gasIncreaseTimeout / 1000.0 },
     )
@@ -705,14 +706,14 @@ export function reviewArgumentsForWarnings(argv: AgentOptions, logger: Logger) {
   if (gasIncreaseFactor > advisedGasIncreaseTimeout) {
     logger.warn(
       `Gas increase factor is set to > ${advisedGasIncreaseFactor}. ` +
-      'This may lead to high gas usage',
+        'This may lead to high gas usage',
       { gasIncreaseFactor: gasIncreaseFactor },
     )
   }
   if (rebateClaimThreshold < voucherRedemptionThreshold) {
     logger.warn(
       'Rebate single minimum claim value is less than voucher minimum redemption value, ' +
-      'but claims depend on redemptions',
+        'but claims depend on redemptions',
       {
         voucherRedemptionThreshold: formatGRT(voucherRedemptionThreshold),
         rebateClaimThreshold: formatGRT(rebateClaimThreshold),
@@ -729,7 +730,7 @@ export function reviewArgumentsForWarnings(argv: AgentOptions, logger: Logger) {
   if (rebateClaimMaxBatchSize > advisedRebateClaimMaxBatchSize) {
     logger.warn(
       `Setting the max batch size for rebate claims to more than ${advisedRebateClaimMaxBatchSize}` +
-      'may result in batches that are too large to fit into a block',
+        'may result in batches that are too large to fit into a block',
       { rebateClaimMaxBatchSize: rebateClaimMaxBatchSize },
     )
   }
@@ -743,7 +744,7 @@ export function reviewArgumentsForWarnings(argv: AgentOptions, logger: Logger) {
   if (voucherRedemptionMaxBatchSize > advisedVoucherRedemptionMaxBatchSize) {
     logger.warn(
       `Setting the max batch size for voucher redemptions to more than ${advisedVoucherRedemptionMaxBatchSize} ` +
-      'may result in batches that are too large to fit into a block',
+        'may result in batches that are too large to fit into a block',
       { voucherRedemptionMaxBatchSize: voucherRedemptionMaxBatchSize },
     )
   }

packages/indexer-common/src/__tests__/ipfs.test.ts

@@ -96,20 +96,16 @@ describe(SubgraphManifestResolver, () => {
         return res.send(err.message)
       }
 
-      // console.log(`got cid ${cid}`)
-
       // Example: Respond with different data based on the CID
       if (manifestMap.has(cid)) {
         res.send(manifestMap.get(cid))
       } else {
-        // console.log(`CID not found: ${cid}`)
         res.status(404).send('Not Found')
       }
     })
 
     // Handler for all other routes
     app.use((req: Request, res: Response, next) => {
-      // console.log(`404: ${req.url}, ${req.method}`)
       res.status(404).send('Not Found')
       next()
     })

packages/indexer-common/src/graph-node.ts

@@ -87,7 +87,7 @@ export class SubgraphManifestResolver {
     this.ipfsBaseUrl = new URL(`/api/v0/`, ipfsEndpoint)
     this.ipfsClient = axios.create({})
     this.ipfsClient.interceptors.request.use((config) => {
-      logger.info(`Subgraph Manifest IPFS request: ${config.url}`)
+      logger.debug(`Subgraph Manifest IPFS request: ${config.url}`)
       return config
     })
     this.logger = logger
@@ -811,7 +811,10 @@ export class GraphNode {
   }
 
   /**
-   *  wait for the block to be synced, polling indexing status until it is
+   * Wait for the block to be synced, polling indexing status until it is
+   * The Deployment should already be created and deployed to graph-node
+   * This will resume a paused subgraph if the block height target is higher than the
+   * current block height
    */
   public async syncToBlockAndPause(
     blockHeight: number,
@@ -833,9 +836,12 @@ export class GraphNode {
       let deployed: SubgraphDeploymentAssignment[] = []
       let attempt = 0
 
+      const maxAttempts = 5
+      const waitTimeMs = 3000
+
       // wait and poll for the assignment to be created.
-      while (attempt < 5) {
-        await waitForMs(3000)
+      while (attempt < maxAttempts) {
+        await waitForMs(waitTimeMs)
         deployed = await this.subgraphDeploymentAssignmentsByDeploymentID(
           SubgraphStatus.ALL,
           [subgraphDeployment.ipfsHash],
@@ -853,13 +859,14 @@ export class GraphNode {
           deployed,
         })
         attempt += 1
-      }
-
-      if (attempt >= 5) {
-        this.logger.error(`Subgraph not deployed and active`, {
-          subgraph: subgraphDeployment.ipfsHash,
-        })
-        throw new Error(`Subgraph not deployed and active, cannot sync to block`)
+        if (attempt >= maxAttempts) {
+          this.logger.error(`Subgraph not deployed and active`, {
+            subgraph: subgraphDeployment.ipfsHash,
+          })
+          throw new Error(
+            `Subgraph ${subgraphDeployment.ipfsHash} not deployed and active after ${maxAttempts} attempts, cannot sync to block ${blockHeight}`,
+          )
+        }
       }
 
       const indexingStatus = await this.indexingStatus([subgraphDeployment])
@@ -927,7 +934,7 @@ export class GraphNode {
           indexingStatus,
         },
       )
-      await waitForMs(3000)
+      await waitForMs(waitTimeMs)
     }
 
     this.logger.debug(`End syncing subgraph deployment synced to block`, {

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

@@ -329,7 +329,7 @@ export class ActionManager {
           if (pendingActions.length > 0) {
             logger.warn(
               `${pendingActions} Actions found in PENDING state when execution began. Was there a crash?` +
-              `These indicate that execution was interrupted while calling contracts, and will need to be cleared manually.`,
+                `These indicate that execution was interrupted while calling contracts, and will need to be cleared manually.`,
             )
           }
 
@@ -384,7 +384,7 @@ export class ActionManager {
           )
         }
         // This will return all results if successful, if failed it will return the failed actions
-        results = await this.allocationManager.executeBatch(
+        results = await allocationManager.executeBatch(
           prioritizedActions,
           onFinishedDeploying,
         )

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

@@ -127,7 +127,7 @@ export default {
       let lastId = ''
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const allAllocations: any[] = []
-      for (; ;) {
+      for (;;) {
         const result = await network.networkSubgraph.checkedQuery(
           gql`
             query allocations($indexer: String!, $lastId: String!) {
@@ -275,7 +275,8 @@ async function endpointForNetwork(network: Network): Promise<Endpoints> {
             const response = await fetch(url)
             if (!response.ok) {
               throw new Error(
-                `Returned status ${response.status}: ${response.body ? response.body.toString() : 'No data returned'
+                `Returned status ${response.status}: ${
+                  response.body ? response.body.toString() : 'No data returned'
                 }`,
               )
             }
@@ -310,7 +311,8 @@ async function endpointForNetwork(network: Network): Promise<Endpoints> {
             })
             if (!response.ok) {
               throw new Error(
-                `Returned status ${response.status}: ${response.body ? response.body.toString() : 'No data returned'
+                `Returned status ${response.status}: ${
+                  response.body ? response.body.toString() : 'No data returned'
                 }`,
               )
             }