Simplify initIndexingOnchainEvents function

Author: tk-o

apps/ensindexer/src/lib/indexing-engines/init-indexing-onchain-events.ts

@@ -34,6 +34,25 @@ import {
 import { indexingMetadataContextBuilder } from "@/lib/indexing-metadata-context-builder/singleton";
 import { logger } from "@/lib/logger";
 
+async function upsertIndexingMetadataContextRecord(): Promise<void> {
+  const indexingMetadataContext = await indexingMetadataContextBuilder.getIndexingMetadataContext();
+
+  logger.info({
+    msg: `Upserting Indexing Metadata Context Initialized`,
+  });
+  logger.debug({
+    msg: `Indexing Metadata Context`,
+    indexingStatus: indexingMetadataContext.indexingStatus,
+    stackInfo: indexingMetadataContext.stackInfo,
+  });
+
+  await ensDbClient.upsertIndexingMetadataContext(indexingMetadataContext);
+
+  logger.info({
+    msg: `Successfully upserted Indexing Metadata Context Initialized`,
+  });
+}
+
 /**
  * Prepare for executing the "onchain" event handlers.
  *
@@ -74,21 +93,8 @@ export async function initIndexingOnchainEvents(): Promise<void> {
     // by the time ENSIndexer instance executes `initIndexingOnchainEvents`.
     await waitForEnsRainbowToBeHealthy();
 
-    const indexingMetadataContext =
-      await indexingMetadataContextBuilder.getIndexingMetadataContext();
-
-    logger.info({
-      msg: `Upserting Indexing Metadata Context Initialized`,
-    });
-    logger.debug({
-      msg: `Indexing Metadata Context`,
-      indexingStatus: indexingMetadataContext.indexingStatus,
-      stackInfo: indexingMetadataContext.stackInfo,
-    });
-    await ensDbClient.upsertIndexingMetadataContext(indexingMetadataContext);
-    logger.info({
-      msg: `Successfully upserted Indexing Metadata Context Initialized`,
-    });
+    // Upsert the Indexing Metadata Context record into ENSDb
+    await upsertIndexingMetadataContextRecord();
 
     // Before starting to process onchain events, we want to make sure that
     // ENSRainbow is ready to serve the "heal" requests.

apps/ensindexer/src/lib/indexing-metadata-context-builder/indexing-metadata-context-builder.test.ts

@@ -13,6 +13,7 @@ import {
   type OmnichainIndexingStatusSnapshot,
   validateEnsIndexerPublicConfigCompatibility,
 } from "@ensnode/ensnode-sdk";
+import type { LocalPonderClient } from "@ensnode/ponder-sdk";
 
 import "@/lib/__test__/mockLogger";
 
@@ -92,6 +93,28 @@ function createMockStackInfoBuilder(
   } as unknown as StackInfoBuilder;
 }
 
+function createMockLocalPonderClient(options: { isInDevMode?: boolean } = {}): LocalPonderClient {
+  return {
+    isInDevMode: options.isInDevMode ?? false,
+  } as unknown as LocalPonderClient;
+}
+
+function createIndexingMetadataContextBuilder(
+  overrides: {
+    ensDbClient?: EnsDbReader;
+    indexingStatusBuilder?: IndexingStatusBuilder;
+    stackInfoBuilder?: StackInfoBuilder;
+    localPonderClient?: LocalPonderClient;
+  } = {},
+): IndexingMetadataContextBuilder {
+  return new IndexingMetadataContextBuilder(
+    overrides.ensDbClient ?? createMockEnsDbReader(),
+    overrides.indexingStatusBuilder ?? createMockIndexingStatusBuilder(),
+    overrides.stackInfoBuilder ?? createMockStackInfoBuilder(),
+    overrides.localPonderClient ?? createMockLocalPonderClient(),
+  );
+}
+
 describe("IndexingMetadataContextBuilder", () => {
   beforeEach(() => {
     vi.clearAllMocks();
@@ -109,11 +132,11 @@ describe("IndexingMetadataContextBuilder", () => {
         const indexingStatusBuilder = createMockIndexingStatusBuilder(omnichainSnapshotUnstarted);
         const stackInfoBuilder = createMockStackInfoBuilder();
 
-        const builder = new IndexingMetadataContextBuilder(
+        const builder = createIndexingMetadataContextBuilder({
           ensDbClient,
           indexingStatusBuilder,
           stackInfoBuilder,
-        );
+        });
         const result = await builder.getIndexingMetadataContext();
 
         expect(ensDbClient.getIndexingMetadataContext).toHaveBeenCalledOnce();
@@ -133,11 +156,9 @@ describe("IndexingMetadataContextBuilder", () => {
       it("throws when indexing status is not unstarted", async () => {
         const indexingStatusBuilder = createMockIndexingStatusBuilder(omnichainSnapshotFollowing);
 
-        const builder = new IndexingMetadataContextBuilder(
-          createMockEnsDbReader(),
+        const builder = createIndexingMetadataContextBuilder({
           indexingStatusBuilder,
-          createMockStackInfoBuilder(),
-        );
+        });
 
         await expect(builder.getIndexingMetadataContext()).rejects.toThrow(
           /Omnichain indexing status must be "unstarted"/,
@@ -146,18 +167,20 @@ describe("IndexingMetadataContextBuilder", () => {
     });
 
     describe("when stored context is Initialized", () => {
-      it("builds and returns initialized context after validating compatibility", async () => {
+      it("validates compatibility when not in dev mode", async () => {
         const ensDbClient = createMockEnsDbReader({
           getIndexingMetadataContext: vi.fn().mockResolvedValue(indexingMetadataContextInitialized),
         });
         const indexingStatusBuilder = createMockIndexingStatusBuilder(omnichainSnapshotFollowing);
         const stackInfoBuilder = createMockStackInfoBuilder();
+        const localPonderClient = createMockLocalPonderClient({ isInDevMode: false });
 
-        const builder = new IndexingMetadataContextBuilder(
+        const builder = createIndexingMetadataContextBuilder({
           ensDbClient,
           indexingStatusBuilder,
           stackInfoBuilder,
-        );
+          localPonderClient,
+        });
         const result = await builder.getIndexingMetadataContext();
 
         expect(validateEnsIndexerPublicConfigCompatibility).toHaveBeenCalledWith(
@@ -172,7 +195,32 @@ describe("IndexingMetadataContextBuilder", () => {
         expect(result).toBe(indexingMetadataContextInitialized);
       });
 
-      it("throws when stored and in-memory configs are incompatible", async () => {
+      it("skips compatibility validation when in dev mode", async () => {
+        const ensDbClient = createMockEnsDbReader({
+          getIndexingMetadataContext: vi.fn().mockResolvedValue(indexingMetadataContextInitialized),
+        });
+        const indexingStatusBuilder = createMockIndexingStatusBuilder(omnichainSnapshotFollowing);
+        const stackInfoBuilder = createMockStackInfoBuilder();
+        const localPonderClient = createMockLocalPonderClient({ isInDevMode: true });
+
+        const builder = createIndexingMetadataContextBuilder({
+          ensDbClient,
+          indexingStatusBuilder,
+          stackInfoBuilder,
+          localPonderClient,
+        });
+        const result = await builder.getIndexingMetadataContext();
+
+        // Compatibility validation should NOT be called in dev mode
+        expect(validateEnsIndexerPublicConfigCompatibility).not.toHaveBeenCalled();
+        expect(buildIndexingMetadataContextInitialized).toHaveBeenCalledWith(
+          crossChainSnapshot,
+          stackInfo,
+        );
+        expect(result).toBe(indexingMetadataContextInitialized);
+      });
+
+      it("throws when stored and in-memory configs are incompatible (not in dev mode)", async () => {
         vi.mocked(validateEnsIndexerPublicConfigCompatibility).mockImplementation(() => {
           throw new Error("Incompatible ENSIndexer config");
         });
@@ -181,16 +229,34 @@ describe("IndexingMetadataContextBuilder", () => {
           getIndexingMetadataContext: vi.fn().mockResolvedValue(indexingMetadataContextInitialized),
         });
 
-        const builder = new IndexingMetadataContextBuilder(
+        const builder = createIndexingMetadataContextBuilder({
           ensDbClient,
-          createMockIndexingStatusBuilder(omnichainSnapshotFollowing),
-          createMockStackInfoBuilder(),
-        );
+          indexingStatusBuilder: createMockIndexingStatusBuilder(omnichainSnapshotFollowing),
+          localPonderClient: createMockLocalPonderClient({ isInDevMode: false }),
+        });
 
         await expect(builder.getIndexingMetadataContext()).rejects.toThrow(
           "Incompatible ENSIndexer config",
         );
       });
+
+      it("does not throw on incompatible configs when in dev mode", async () => {
+        vi.mocked(validateEnsIndexerPublicConfigCompatibility).mockImplementation(() => {
+          throw new Error("Incompatible ENSIndexer config");
+        });
+
+        const ensDbClient = createMockEnsDbReader({
+          getIndexingMetadataContext: vi.fn().mockResolvedValue(indexingMetadataContextInitialized),
+        });
+
+        const builder = createIndexingMetadataContextBuilder({
+          ensDbClient,
+          indexingStatusBuilder: createMockIndexingStatusBuilder(omnichainSnapshotFollowing),
+          localPonderClient: createMockLocalPonderClient({ isInDevMode: true }),
+        });
+
+        await expect(builder.getIndexingMetadataContext()).resolves.toBeDefined();
+      });
     });
 
     it("fetches all three data sources in parallel", async () => {
@@ -215,11 +281,11 @@ describe("IndexingMetadataContextBuilder", () => {
         return stackInfo;
       });
 
-      const builder = new IndexingMetadataContextBuilder(
+      const builder = createIndexingMetadataContextBuilder({
         ensDbClient,
         indexingStatusBuilder,
         stackInfoBuilder,
-      );
+      });
       await builder.getIndexingMetadataContext();
 
       // All three should have been called (ordering is not deterministic for parallel)

apps/ensindexer/src/lib/indexing-metadata-context-builder/indexing-metadata-context-builder.ts

@@ -11,6 +11,7 @@ import {
   type OmnichainIndexingStatusSnapshot,
   validateEnsIndexerPublicConfigCompatibility,
 } from "@ensnode/ensnode-sdk";
+import type { LocalPonderClient } from "@ensnode/ponder-sdk";
 
 import type { IndexingStatusBuilder } from "@/lib/indexing-status-builder/indexing-status-builder";
 import { logger } from "@/lib/logger";
@@ -46,6 +47,7 @@ export class IndexingMetadataContextBuilder {
     private readonly ensDbClient: EnsDbReader,
     private readonly indexingStatusBuilder: IndexingStatusBuilder,
     private readonly stackInfoBuilder: StackInfoBuilder,
+    private readonly localPonderClient: LocalPonderClient,
   ) {}
 
   /**
@@ -94,10 +96,18 @@ export class IndexingMetadataContextBuilder {
         stackInfo: storedIndexingMetadataContext.stackInfo,
       });
 
-      invariant_ensIndexerPublicConfigIsCompatibleWithStackInfo(
-        storedIndexingMetadataContext.stackInfo,
-        inMemoryEnsIndexerStackInfo,
-      );
+      // Validate in-memory config object compatibility with the stored one,
+      // if the stored one is available.
+      // The validation is skipped if the local Ponder app is running in dev mode.
+      // This is to improve the development experience during ENSIndexer
+      // development, by allowing to override the stored config in ENSDb with
+      // the current in-memory config, without having to keep them compatible.
+      if (!this.localPonderClient.isInDevMode) {
+        invariant_ensIndexerPublicConfigIsCompatibleWithStackInfo(
+          storedIndexingMetadataContext.stackInfo,
+          inMemoryEnsIndexerStackInfo,
+        );
+      }
     }
 
     return inMemoryIndexingMetadataContext;

apps/ensindexer/src/lib/indexing-metadata-context-builder/singleton.ts

@@ -1,6 +1,7 @@
 import { ensDbClient } from "@/lib/ensdb/singleton";
 import { IndexingMetadataContextBuilder } from "@/lib/indexing-metadata-context-builder/indexing-metadata-context-builder";
 import { indexingStatusBuilder } from "@/lib/indexing-status-builder/singleton";
+import { localPonderClient } from "@/lib/local-ponder-client";
 import { stackInfoBuilder } from "@/lib/stack-info-builder/singleton";
 
 /**
@@ -10,4 +11,5 @@ export const indexingMetadataContextBuilder = new IndexingMetadataContextBuilder
   ensDbClient,
   indexingStatusBuilder,
   stackInfoBuilder,
+  localPonderClient,
 );

packages/ensdb-sdk/src/client/ensnode-metadata.ts

@@ -23,6 +23,9 @@ export interface EnsNodeMetadataIndexingMetadataContext {
 /**
  * ENSNode Metadata
  *
- * Union type gathering all variants of ENSNode Metadata.
+ * Type alias for ENSNode Metadata records,
+ * currently only includes the record for Indexing Metadata Context,
+ * but can be extended in the future to include more types of
+ * ENSNode Metadata records as needed.
  */
 export type EnsNodeMetadata = EnsNodeMetadataIndexingMetadataContext;