Make ENSDb Writer Worker to use builders for ENSIndexer Public Config and Indexing Status objects

.changeset/flat-flowers-shave.md

@@ -0,0 +1,5 @@
+---
+"@ensnode/ensnode-sdk": minor
+---
+
+Added `validateEnsIndexerPublicConfig` and `validateEnsIndexerVersionInfo` functions.

.changeset/violet-tires-sell.md

@@ -0,0 +1,5 @@
+---
+"ensindexer": minor
+---
+
+Refactored HTTP handlers to rely solely on ENSDb Client for data.

apps/ensindexer/ponder/src/api/handlers/ensnode-api.ts

@@ -1,10 +1,7 @@
-import config from "@/config";
-
 import { getUnixTime } from "date-fns";
 import { Hono } from "hono";
 
 import {
-  buildCrossChainIndexingStatusSnapshotOmnichain,
   createRealtimeIndexingStatusProjection,
   IndexingStatusResponseCodes,
   type IndexingStatusResponseError,
@@ -13,31 +10,37 @@ import {
   serializeIndexingStatusResponse,
 } from "@ensnode/ensnode-sdk";
 
-import { buildENSIndexerPublicConfig } from "@/config/public";
-import { indexingStatusBuilder } from "@/lib/indexing-status-builder/singleton";
+import { ensDbClient } from "@/lib/ensdb-client/singleton";
 
 const app = new Hono();
 
 // include ENSIndexer Public Config endpoint
 app.get("/config", async (c) => {
-  // prepare the public config object, including dependency info
-  const publicConfig = await buildENSIndexerPublicConfig(config);
+  const publicConfig = await ensDbClient.getEnsIndexerPublicConfig();
+
+  // Invariant: the public config is guaranteed to be available in ENSDb after
+  // application startup.
+  if (typeof publicConfig === "undefined") {
+    throw new Error("Unreachable: ENSIndexer Public Config is not available in ENSDb");
+  }
 
   // respond with the serialized public config object
   return c.json(serializeENSIndexerPublicConfig(publicConfig));
 });
 
 app.get("/indexing-status", async (c) => {
-  // get system timestamp for the current request
-  const snapshotTime = getUnixTime(new Date());
-
   try {
-    const omnichainSnapshot = await indexingStatusBuilder.getOmnichainIndexingStatusSnapshot();
+    const crossChainSnapshot = await ensDbClient.getIndexingStatusSnapshot();
 
-    const crossChainSnapshot = buildCrossChainIndexingStatusSnapshotOmnichain(
-      omnichainSnapshot,
-      snapshotTime,
-    );
+    // Invariant: the Indexing Status Snapshot is expected to be available in
+    // ENSDb shortly after application startup. There is a possibility that
+    // the snapshot is not yet available at the time of the request,
+    // i.e. when ENSDb has not yet been populated with the first snapshot.
+    // In this case, we treat the snapshot as unavailable and respond with
+    // an error response.
+    if (typeof crossChainSnapshot === "undefined") {
+      throw new Error("ENSDb does not contain an Indexing Status Snapshot");
+    }
 
     const projectedAt = getUnixTime(new Date());
     const realtimeProjection = createRealtimeIndexingStatusProjection(
@@ -53,7 +56,7 @@ app.get("/indexing-status", async (c) => {
     );
   } catch (error) {
     const errorMessage = error instanceof Error ? error.message : "Unknown error";
-    console.error(`Omnichain snapshot is currently not available: ${errorMessage}`);
+    console.error(`Indexing Status Snapshot is currently not available: ${errorMessage}`);
 
     return c.json(
       serializeIndexingStatusResponse({

apps/ensindexer/src/lib/ensdb-writer-worker/ensdb-writer-worker.mock.ts

@@ -0,0 +1,72 @@
+import { vi } from "vitest";
+
+import {
+  type CrossChainIndexingStatusSnapshot,
+  CrossChainIndexingStrategyIds,
+  type EnsIndexerPublicConfig,
+  OmnichainIndexingStatusIds,
+  type OmnichainIndexingStatusSnapshot,
+} from "@ensnode/ensnode-sdk";
+
+import type { EnsDbClient } from "@/lib/ensdb-client/ensdb-client";
+import * as ensDbClientMock from "@/lib/ensdb-client/ensdb-client.mock";
+import type { IndexingStatusBuilder } from "@/lib/indexing-status-builder";
+import type { PublicConfigBuilder } from "@/lib/public-config-builder";
+
+// Helper to create mock objects with consistent typing
+export function createMockEnsDbClient(
+  overrides: Partial<ReturnType<typeof baseEnsDbClient>> = {},
+): EnsDbClient {
+  return {
+    ...baseEnsDbClient(),
+    ...overrides,
+  } as unknown as EnsDbClient;
+}
+
+export function baseEnsDbClient() {
+  return {
+    getEnsIndexerPublicConfig: vi.fn().mockResolvedValue(undefined),
+    upsertEnsDbVersion: vi.fn().mockResolvedValue(undefined),
+    upsertEnsIndexerPublicConfig: vi.fn().mockResolvedValue(undefined),
+    upsertIndexingStatusSnapshot: vi.fn().mockResolvedValue(undefined),
+  };
+}
+
+export function createMockPublicConfigBuilder(
+  resolvedConfig: EnsIndexerPublicConfig = ensDbClientMock.publicConfig,
+): PublicConfigBuilder {
+  return {
+    getPublicConfig: vi.fn().mockResolvedValue(resolvedConfig),
+  } as unknown as PublicConfigBuilder;
+}
+
+export function createMockIndexingStatusBuilder(
+  resolvedSnapshot: OmnichainIndexingStatusSnapshot = createMockOmnichainSnapshot(),
+): IndexingStatusBuilder {
+  return {
+    getOmnichainIndexingStatusSnapshot: vi.fn().mockResolvedValue(resolvedSnapshot),
+  } as unknown as IndexingStatusBuilder;
+}
+
+export function createMockOmnichainSnapshot(
+  overrides: Partial<OmnichainIndexingStatusSnapshot> = {},
+): OmnichainIndexingStatusSnapshot {
+  return {
+    omnichainStatus: OmnichainIndexingStatusIds.Following,
+    omnichainIndexingCursor: 100,
+    chains: new Map(),
+    ...overrides,
+  };
+}
+
+export function createMockCrossChainSnapshot(
+  overrides: Partial<CrossChainIndexingStatusSnapshot> = {},
+): CrossChainIndexingStatusSnapshot {
+  return {
+    strategy: CrossChainIndexingStrategyIds.Omnichain,
+    slowestChainIndexingCursor: 100,
+    snapshotTime: 200,
+    omnichainSnapshot: createMockOmnichainSnapshot(),
+    ...overrides,
+  };
+}