ENSDb migrations

.changeset/big-impalas-brush.md

@@ -0,0 +1,5 @@
+---
+"ensindexer": minor
+---
+
+Extended `EnsDbClient` with `EnsDbClientMigration` interface implementation.

.changeset/seven-hands-ask.md

@@ -0,0 +1,5 @@
+---
+"@ensnode/ensnode-sdk": minor
+---
+
+Introduced `EnsDbClientMigration` interface.

.changeset/silly-bats-smell.md

@@ -0,0 +1,5 @@
+---
+"ensindexer": minor
+---
+
+Introduced database migration toolkit based on `drizzle-kit`.

apps/ensindexer/drizzle-kit/config.ts

@@ -0,0 +1,13 @@
+import { fileURLToPath } from "node:url";
+
+import { defineConfig } from "drizzle-kit";
+
+// Resolve the path to the database schema file for Drizzle migrations.
+const dbSchemaPath = fileURLToPath(new URL("./schema.ts", import.meta.url));
+
+export default defineConfig({
+  casing: "snake_case",
+  dialect: "postgresql",
+  out: `drizzle-kit/migrations`,
+  schema: dbSchemaPath,
+});

apps/ensindexer/drizzle-kit/migrations/0000_smiling_prima.sql

@@ -0,0 +1,8 @@
+CREATE SCHEMA IF NOT EXISTS ensnode;
+
+CREATE TABLE "ensnode"."ensnode_metadata" (
+	"ens_indexer_ref" text NOT NULL,
+	"key" text NOT NULL,
+	"value" jsonb NOT NULL,
+	CONSTRAINT "ensnode_metadata_pkey" PRIMARY KEY("ens_indexer_ref","key")
+);

apps/ensindexer/drizzle-kit/migrations/meta/0000_snapshot.json

@@ -0,0 +1,55 @@
+{
+  "id": "d05a87cf-3971-41ac-9eab-a15a54711a47",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "ensnode.ensnode_metadata": {
+      "name": "ensnode_metadata",
+      "schema": "ensnode",
+      "columns": {
+        "ens_indexer_ref": {
+          "name": "ens_indexer_ref",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "key": {
+          "name": "key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "value": {
+          "name": "value",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {
+        "ensnode_metadata_pkey": {
+          "name": "ensnode_metadata_pkey",
+          "columns": ["ens_indexer_ref", "key"]
+        }
+      },
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

apps/ensindexer/drizzle-kit/migrations/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1773295356548,
+      "tag": "0000_smiling_prima",
+      "breakpoints": true
+    }
+  ]
+}

apps/ensindexer/drizzle-kit/schema.ts

@@ -0,0 +1,2 @@
+// Re-export the ENSNode schema for Drizzle migrations.
+export * from "@ensnode/ensnode-schema/ensnode";

apps/ensindexer/package.json

@@ -20,7 +20,8 @@
     "test": "vitest",
     "lint": "biome check --write .",
     "lint:ci": "biome ci",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "drizzle-gen": "drizzle-kit generate --config ./drizzle-kit/config.ts"
   },
   "dependencies": {
     "@ensdomains/ensjs": "^4.0.2",
@@ -47,6 +48,7 @@
     "@types/dns-packet": "^5.6.5",
     "@types/node": "catalog:",
     "@types/pg": "8.16.0",
+    "drizzle-kit": "0.31.9",
     "typescript": "catalog:",
     "vitest": "catalog:"
   }

apps/ensindexer/src/lib/ensdb-client/ensdb-client.ts

@@ -1,11 +1,13 @@
 import type { NodePgDatabase } from "drizzle-orm/node-postgres";
-import { and, eq, sql } from "drizzle-orm/sql";
+import { migrate } from "drizzle-orm/node-postgres/migrator";
+import { and, eq } from "drizzle-orm/sql";
 
 import * as ensNodeSchema from "@ensnode/ensnode-schema/ensnode";
 import {
   type CrossChainIndexingStatusSnapshot,
   deserializeCrossChainIndexingStatusSnapshot,
   deserializeEnsIndexerPublicConfig,
+  type EnsDbClientMigration,
   type EnsDbClientMutation,
   type EnsDbClientQuery,
   type EnsIndexerPublicConfig,
@@ -38,7 +40,7 @@ interface DrizzleDb extends NodePgDatabase<typeof ensNodeSchema> {}
  * - ENSDb version
  * - ENSIndexer Public Config, and Indexing Status Snapshot and CrossChainIndexingStatusSnapshot.
  */
-export class EnsDbClient implements EnsDbClientQuery, EnsDbClientMutation {
+export class EnsDbClient implements EnsDbClientQuery, EnsDbClientMutation, EnsDbClientMigration {
   /**
    * Drizzle database instance for ENSDb.
    */
@@ -191,4 +193,14 @@ export class EnsDbClient implements EnsDbClientQuery, EnsDbClientMutation {
         set: { value: metadata.value },
       });
   }
+
+  /**
+   * @inheritdoc
+   */
+  async migrate(migrationsDirPath: string): Promise<void> {
+    return migrate(this.db, {
+      migrationsFolder: migrationsDirPath,
+      migrationsSchema: ensNodeSchema.ENSNODE_SCHEMA_NAME,
+    });
+  }
 }

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

@@ -10,6 +10,7 @@ import {
 
 import type { EnsDbClient } from "@/lib/ensdb-client/ensdb-client";
 import * as ensDbClientMock from "@/lib/ensdb-client/ensdb-client.mock";
+import { EnsDbWriterWorker } from "@/lib/ensdb-writer-worker/ensdb-writer-worker";
 import type { IndexingStatusBuilder } from "@/lib/indexing-status-builder";
 import type { PublicConfigBuilder } from "@/lib/public-config-builder";
 
@@ -23,12 +24,27 @@ export function createMockEnsDbClient(
   } as unknown as EnsDbClient;
 }
 
+export function createMockEnsDbWriterWorker(
+  ensDbClient: EnsDbClient,
+  publicConfigBuilder: PublicConfigBuilder,
+  indexingStatusBuilder: IndexingStatusBuilder,
+  migrationsDirPath: string = "/mock/migrations",
+) {
+  return new EnsDbWriterWorker(
+    ensDbClient,
+    publicConfigBuilder,
+    indexingStatusBuilder,
+    migrationsDirPath,
+  );
+}
+
 export function baseEnsDbClient() {
   return {
     getEnsIndexerPublicConfig: vi.fn().mockResolvedValue(undefined),
     upsertEnsDbVersion: vi.fn().mockResolvedValue(undefined),
     upsertEnsIndexerPublicConfig: vi.fn().mockResolvedValue(undefined),
     upsertIndexingStatusSnapshot: vi.fn().mockResolvedValue(undefined),
+    migrate: vi.fn().mockResolvedValue(undefined),
   };
 }