@apibara/plugin-drizzle 2.1.0-beta.3 → 2.1.0-beta.30

package/src/helper.ts

@@ -0,0 +1,219 @@
+import type { PGlite, PGliteOptions } from "@electric-sql/pglite";
+import type { DrizzleConfig } from "drizzle-orm";
+import { entityKind } from "drizzle-orm";
+import type { MigrationConfig } from "drizzle-orm/migrator";
+import type { NodePgDatabase as OriginalNodePgDatabase } from "drizzle-orm/node-postgres";
+import type { PgliteDatabase as OriginalPgliteDatabase } from "drizzle-orm/pglite";
+import type pg from "pg";
+import { DrizzleStorageError } from "./utils";
+
+/**
+ * Union type of all possible drizzle database options
+ */
+export type DrizzleOptions = PgliteDrizzleOptions | NodePgDrizzleOptions;
+
+/**
+ * Configuration options for Node-Postgres database connection
+ */
+export type NodePgDrizzleOptions = {
+  /**
+   * Type of database to use -
+   * - "pglite" - PGLite database
+   * - "node-postgres" - Node-Postgres database
+   * @default "pglite"
+   */
+  type: "node-postgres";
+  /**
+   * Connection string to use for the database
+   * @default ""
+   */
+  connectionString?: string;
+  /**
+   * Pool configuration options for Node-Postgres
+   */
+  poolConfig?: pg.PoolConfig;
+  /**
+   * Additional drizzle configuration options
+   */
+  config?: Omit<DrizzleConfig, "schema">;
+};
+
+/**
+ * Configuration options for PGLite database connection
+ */
+export type PgliteDrizzleOptions = {
+  /**
+   * Type of database to use -
+   * - "pglite" - PGLite database
+   * - "node-postgres" - Node-Postgres database
+   */
+  type?: "pglite";
+  /**
+   * Connection string to use for the database
+   * @default process.env["POSTGRES_CONNECTION_STRING"] ?? "memory://pglite"
+   */
+  connectionString?: string;
+  /**
+   * Pool configuration is not supported for PGLite
+   */
+  poolConfig?: never;
+  /**
+   * Additional drizzle configuration options with PGLite specific connection options
+   */
+  config?: Omit<DrizzleConfig, "schema"> & {
+    connection?:
+      | (PGliteOptions & {
+          dataDir?: string;
+        })
+      | string;
+  };
+};
+
+/**
+ * Extended PGLite database type with client information
+ */
+export type PgliteDatabase<TSchema extends Record<string, unknown>> =
+  OriginalPgliteDatabase<TSchema> & {
+    $client: PGlite;
+  };
+
+/**
+ * Extended Node-Postgres database type with client information
+ */
+export type NodePgDatabase<TSchema extends Record<string, unknown>> =
+  OriginalNodePgDatabase<TSchema> & {
+    $client: pg.Pool;
+  };
+
+export type Database<
+  TOptions extends DrizzleOptions,
+  TSchema extends Record<string, unknown>,
+> = TOptions extends PgliteDrizzleOptions
+  ? PgliteDatabase<TSchema>
+  : NodePgDatabase<TSchema>;
+
+/**
+ * Creates a new Drizzle database instance based on the provided options
+ *
+ * @important connectionString defaults to process.env["POSTGRES_CONNECTION_STRING"], if not set, it defaults to "memory://" (in-memory pglite)
+ *
+ * @param options - Configuration options for the database connection
+ * @returns A configured Drizzle database instance
+ * @throws {Error} If an invalid database type is specified
+ */
+export function drizzle<
+  TSchema extends Record<string, unknown>,
+  TOptions extends DrizzleOptions,
+>(
+  options?: TOptions & {
+    /**
+     * Schema to use for the database
+     * @default {}
+     */
+    schema?: TSchema;
+  },
+): Database<TOptions, TSchema> {
+  const {
+    connectionString = process.env["POSTGRES_CONNECTION_STRING"] ?? "memory://",
+    schema,
+    type = "pglite",
+    config,
+    poolConfig,
+  } = options ?? {};
+
+  if (isPgliteConnectionString(connectionString) && type === "pglite") {
+    const { drizzle: drizzlePGLite } = require("drizzle-orm/pglite");
+
+    return drizzlePGLite({
+      schema: schema as TSchema,
+      connection: {
+        dataDir: connectionString || "memory://pglite",
+      },
+      ...(config || {}),
+    }) as Database<TOptions, TSchema>;
+  }
+
+  const { Pool } = require("pg");
+  const { drizzle: drizzleNode } = require("drizzle-orm/node-postgres");
+  const pool = new Pool({
+    connectionString,
+    ...(poolConfig || {}),
+  });
+  return drizzleNode(pool, { schema, ...(config || {}) }) as Database<
+    TOptions,
+    TSchema
+  >;
+}
+
+/**
+ * Options for database migration
+ */
+export type MigrateOptions = MigrationConfig;
+
+/**
+ * Performs database migration based on the provided configuration
+ * @param db - The database instance to migrate
+ * @param options - Migration configuration options
+ *
+ * @important This function runs migrations on the database instance provided to the `drizzleStorage` plugin.
+ * It automatically detects the type of database and runs the appropriate migrate function
+ * (PGLite or Node-Postgres).
+ *
+ * @example
+ * ```ts
+ * await migrate(db, { migrationsFolder: "./drizzle" });
+ * ```
+ */
+export async function migrate<TSchema extends Record<string, unknown>>(
+  db: PgliteDatabase<TSchema> | NodePgDatabase<TSchema>,
+  options: MigrateOptions,
+) {
+  const isPglite = isDrizzleKind(db, "PgliteDatabase");
+
+  try {
+    if (isPglite) {
+      const { migrate: migratePGLite } = require("drizzle-orm/pglite/migrator");
+      await migratePGLite(db as PgliteDatabase<TSchema>, options);
+    } else {
+      const {
+        migrate: migrateNode,
+      } = require("drizzle-orm/node-postgres/migrator");
+      await migrateNode(db as NodePgDatabase<TSchema>, options);
+    }
+  } catch (error) {
+    throw new DrizzleStorageError(
+      "Failed to apply migrations! Please check if you have generated migrations using drizzle:generate",
+      {
+        cause: error,
+      },
+    );
+  }
+}
+
+function isPgliteConnectionString(conn: string) {
+  return (
+    conn.startsWith("memory://") ||
+    conn.startsWith("file://") ||
+    conn.startsWith("idb://")
+  );
+}
+
+function isDrizzleKind(value: unknown, entityKindValue: string) {
+  if (!value || typeof value !== "object") {
+    return false;
+  }
+  // https://github.com/drizzle-team/drizzle-orm/blob/f39f885779800982e90dd3c89aba6df3217a6fd2/drizzle-orm/src/entity.ts#L29-L41
+  let cls = Object.getPrototypeOf(value).constructor;
+  if (cls) {
+    // Traverse the prototype chain to find the entityKind
+    while (cls) {
+      // https://github.com/drizzle-team/drizzle-orm/blob/f39f885779800982e90dd3c89aba6df3217a6fd2/drizzle-orm/src/pglite/driver.ts#L41
+      if (entityKind in cls && cls[entityKind] === entityKindValue) {
+        return true;
+      }
+      cls = Object.getPrototypeOf(cls);
+    }
+  }
+
+  return false;
+}

package/src/index.ts

@@ -1,5 +1,5 @@
 import { useIndexerContext } from "@apibara/indexer";
-import { defineIndexerPlugin } from "@apibara/indexer/plugins";
+import { defineIndexerPlugin, useLogger } from "@apibara/indexer/plugins";
 
 import type {
   ExtractTablesWithRelations,
@@ -14,23 +14,36 @@ import type {
   PgQueryResultHKT,
   PgTransaction,
 } from "drizzle-orm/pg-core";
+import { DRIZZLE_PROPERTY, DRIZZLE_STORAGE_DB_PROPERTY } from "./constants";
+import { type MigrateOptions, migrate } from "./helper";
 import {
   finalizeState,
   getState,
   initializePersistentState,
   invalidateState,
   persistState,
+  resetPersistence,
 } from "./persistence";
 import {
+  cleanupStorage,
   finalize,
   initializeReorgRollbackTable,
   invalidate,
   registerTriggers,
   removeTriggers,
 } from "./storage";
-import { DrizzleStorageError, sleep, withTransaction } from "./utils";
+import {
+  DrizzleStorageError,
+  type IdColumnMap,
+  getIdColumnForTable,
+  sleep,
+  withTransaction,
+} from "./utils";
+
+export * from "./helper";
+
+export type { IdColumnMap };
 
-const DRIZZLE_PROPERTY = "_drizzle";
 const MAX_RETRIES = 5;
 
 export type DrizzleStorage<
@@ -67,11 +80,53 @@ export interface DrizzleStorageOptions<
   TSchema extends
     TablesRelationalConfig = ExtractTablesWithRelations<TFullSchema>,
 > {
+  /**
+   * The Drizzle database instance.
+   */
   db: PgDatabase<TQueryResult, TFullSchema, TSchema>;
+  /**
+   * Whether to persist the indexer's state. Defaults to true.
+   */
   persistState?: boolean;
+  /**
+   * The name of the indexer. Default value is 'default'.
+   */
   indexerName?: string;
+  /**
+   * The schema of the database.
+   */
   schema?: Record<string, unknown>;
-  idColumn?: string;
+  /**
+   * The column to use as the primary identifier for each table.
+   *
+   * This identifier is used for tracking changes during reorgs and rollbacks.
+   *
+   * Can be specified in two ways:
+   *
+   * 1. As a single string that applies to all tables:
+   * ```ts
+   * idColumn: "_id" // Uses "_id" column for all tables
+   * ```
+   *
+   * 2. As an object mapping table names to their ID columns:
+   * ```ts
+   * idColumn: {
+   *   transfers: "transaction_hash",    // Use "transaction_hash" for transfers table
+   *   blocks: "block_number",           // Use "block_number" for blocks table
+   *   "*": "_id"                        // Use "_id" for all other tables | defaults to "id"
+   * }
+   * ```
+   *
+   * The special "*" key acts as a fallback for any tables not explicitly mapped.
+   *
+   * @default "id"
+   * @type {string | Partial<IdColumnMap>}
+   */
+  idColumn?: string | Partial<IdColumnMap>;
+  /**
+   * The options for the database migration. When provided, the database will automatically run migrations before the indexer runs.
+   */
+  migrate?: MigrateOptions;
 }
 
 /**
@@ -83,6 +138,7 @@ export interface DrizzleStorageOptions<
  * @param options.indexerName - The name of the indexer. Defaults value is 'default'.
  * @param options.schema - The schema of the database.
  * @param options.idColumn - The column to use as the id. Defaults to 'id'.
+ * @param options.migrate - The options for the database migration. when provided, the database will automatically run migrations before the indexer runs.
  */
 export function drizzleStorage<
   TFilter,
@@ -95,42 +151,101 @@ export function drizzleStorage<
   db,
   persistState: enablePersistence = true,
   indexerName: identifier = "default",
-  schema,
-  idColumn = "id",
+  schema: _schema,
+  idColumn,
+  migrate: migrateOptions,
 }: DrizzleStorageOptions<TQueryResult, TFullSchema, TSchema>) {
   return defineIndexerPlugin<TFilter, TBlock>((indexer) => {
     let tableNames: string[] = [];
     let indexerId = "";
+    const alwaysReindex = process.env["APIBARA_ALWAYS_REINDEX"] === "true";
+    let prevFinality: DataFinality | undefined;
+    const schema: TSchema = (_schema as TSchema) ?? db._.schema ?? {};
+    const idColumnMap: IdColumnMap = {
+      "*": typeof idColumn === "string" ? idColumn : "id",
+      ...(typeof idColumn === "object" ? idColumn : {}),
+    };
 
     try {
-      tableNames = Object.values((schema as TSchema) ?? db._.schema ?? {}).map(
-        (table) => table.dbName,
-      );
+      tableNames = Object.values(schema).map((table) => table.dbName);
     } catch (error) {
       throw new DrizzleStorageError("Failed to get table names from schema", {
         cause: error,
       });
     }
 
+    // Check if specified idColumn exists in all the tables in schema
+    for (const table of Object.values(schema)) {
+      const columns = table.columns;
+      const tableIdColumn = getIdColumnForTable(table.dbName, idColumnMap);
+
+      const columnExists = Object.values(columns).some(
+        (column) => column.name === tableIdColumn,
+      );
+
+      if (!columnExists) {
+        throw new DrizzleStorageError(
+          `Column \`"${tableIdColumn}"\` does not exist in table \`"${table.dbName}"\`. ` +
+            "Make sure the table has the specified column or provide a valid `idColumn` mapping to `drizzleStorage`.",
+        );
+      }
+    }
+
     indexer.hooks.hook("run:before", async () => {
+      const internalContext = useInternalContext();
+      const context = useIndexerContext();
+      const logger = useLogger();
+
+      // For testing purposes using vcr.
+      context[DRIZZLE_STORAGE_DB_PROPERTY] = db;
+
       const { indexerName: indexerFileName, availableIndexers } =
-        useInternalContext();
+        internalContext;
 
       indexerId = generateIndexerId(indexerFileName, identifier);
 
       let retries = 0;
 
+      // incase the migrations are already applied, we don't want to run them again
+      let migrationsApplied = false;
+      let cleanupApplied = false;
+
       while (retries <= MAX_RETRIES) {
         try {
+          if (migrateOptions && !migrationsApplied) {
+            // @ts-ignore type mismatch for db
+            await migrate(db, migrateOptions);
+            migrationsApplied = true;
+            logger.success("Migrations applied");
+          }
           await withTransaction(db, async (tx) => {
             await initializeReorgRollbackTable(tx, indexerId);
             if (enablePersistence) {
               await initializePersistentState(tx);
             }
+
+            if (alwaysReindex && !cleanupApplied) {
+              logger.warn(
+                `Reindexing: Deleting all data from tables - ${tableNames.join(", ")}`,
+              );
+
+              await cleanupStorage(tx, tableNames, indexerId);
+
+              if (enablePersistence) {
+                await resetPersistence({ tx, indexerId });
+              }
+
+              cleanupApplied = true;
+
+              logger.success("Tables have been cleaned up for reindexing");
+            }
           });
           break;
         } catch (error) {
           if (retries === MAX_RETRIES) {
+            if (error instanceof DrizzleStorageError) {
+              throw error;
+            }
             throw new DrizzleStorageError(
               "Initialization failed after 5 retries",
               {
@@ -177,7 +292,8 @@ export function drizzleStorage<
       }
 
       await withTransaction(db, async (tx) => {
-        await invalidate(tx, cursor, idColumn, indexerId);
+        // Use the appropriate idColumn for each table when calling invalidate
+        await invalidate(tx, cursor, idColumnMap, indexerId);
 
         if (enablePersistence) {
           await invalidateState({ tx, cursor, indexerId });
@@ -204,7 +320,7 @@ export function drizzleStorage<
     });
 
     indexer.hooks.hook("message:finalize", async ({ message }) => {
-      const { cursor } = message.finalize;
+      const { cursor } = message;
 
       if (!cursor) {
         throw new DrizzleStorageError("Finalized Cursor is undefined");
@@ -220,14 +336,15 @@ export function drizzleStorage<
     });
 
     indexer.hooks.hook("message:invalidate", async ({ message }) => {
-      const { cursor } = message.invalidate;
+      const { cursor } = message;
 
       if (!cursor) {
         throw new DrizzleStorageError("Invalidate Cursor is undefined");
       }
 
       await withTransaction(db, async (tx) => {
-        await invalidate(tx, cursor, idColumn, indexerId);
+        // Use the appropriate idColumn for each table when calling invalidate
+        await invalidate(tx, cursor, idColumnMap, indexerId);
 
         if (enablePersistence) {
           await invalidateState({ tx, cursor, indexerId });
@@ -238,7 +355,8 @@ export function drizzleStorage<
     indexer.hooks.hook("handler:middleware", async ({ use }) => {
       use(async (context, next) => {
         try {
-          const { endCursor, finality } = context as {
+          const { endCursor, finality, cursor } = context as {
+            cursor: Cursor;
             endCursor: Cursor;
             finality: DataFinality;
           };
@@ -254,12 +372,17 @@ export function drizzleStorage<
               TSchema
             >;
 
+            if (prevFinality === "pending") {
+              // invalidate if previous block's finality was "pending"
+              await invalidate(tx, cursor, idColumnMap, indexerId);
+            }
+
             if (finality !== "finalized") {
               await registerTriggers(
                 tx,
                 tableNames,
                 endCursor,
-                idColumn,
+                idColumnMap,
                 indexerId,
               );
             }
@@ -267,13 +390,15 @@ export function drizzleStorage<
             await next();
             delete context[DRIZZLE_PROPERTY];
 
-            if (enablePersistence) {
+            if (enablePersistence && finality !== "pending") {
               await persistState({
                 tx,
                 endCursor,
                 indexerId,
               });
             }
+
+            prevFinality = finality;
           });
 
           if (finality !== "finalized") {

package/src/persistence.ts

@@ -1,24 +1,29 @@
 import { type Cursor, normalizeCursor } from "@apibara/protocol";
-import { and, eq, gt, isNull, lt } from "drizzle-orm";
+import { and, eq, gt, isNull, lt, sql } from "drizzle-orm";
 import type {
   ExtractTablesWithRelations,
   TablesRelationalConfig,
 } from "drizzle-orm";
 import type { PgQueryResultHKT, PgTransaction } from "drizzle-orm/pg-core";
-import { integer, pgTable, primaryKey, text } from "drizzle-orm/pg-core";
+import { integer, pgSchema, primaryKey, text } from "drizzle-orm/pg-core";
+import { SCHEMA_NAME } from "./constants";
 import { DrizzleStorageError, deserialize, serialize } from "./utils";
 
-const CHECKPOINTS_TABLE_NAME = "__indexer_checkpoints";
-const FILTERS_TABLE_NAME = "__indexer_filters";
-const SCHEMA_VERSION_TABLE_NAME = "__indexer_schema_version";
+const CHECKPOINTS_TABLE_NAME = "checkpoints";
+const FILTERS_TABLE_NAME = "filters";
+const SCHEMA_VERSION_TABLE_NAME = "schema_version";
 
-export const checkpoints = pgTable(CHECKPOINTS_TABLE_NAME, {
+const schema = pgSchema(SCHEMA_NAME);
+
+/** This table is not used for migrations, its only used for ease of internal operations with drizzle. */
+export const checkpoints = schema.table(CHECKPOINTS_TABLE_NAME, {
   id: text("id").notNull().primaryKey(),
   orderKey: integer("order_key").notNull(),
   uniqueKey: text("unique_key"),
 });
 
-export const filters = pgTable(
+/** This table is not used for migrations, its only used for ease of internal operations with drizzle. */
+export const filters = schema.table(
   FILTERS_TABLE_NAME,
   {
     id: text("id").notNull(),
@@ -33,7 +38,8 @@ export const filters = pgTable(
   ],
 );
 
-export const schemaVersion = pgTable(SCHEMA_VERSION_TABLE_NAME, {
+/** This table is not used for migrations, its only used for ease of internal operations with drizzle. */
+export const schemaVersion = schema.table(SCHEMA_VERSION_TABLE_NAME, {
   k: integer("k").notNull().primaryKey(),
   version: integer("version").notNull(),
 });
@@ -53,13 +59,22 @@ export async function initializePersistentState<
   TSchema extends
     TablesRelationalConfig = ExtractTablesWithRelations<TFullSchema>,
 >(tx: PgTransaction<TQueryResult, TFullSchema, TSchema>) {
+  // Create schema if it doesn't exist
+  await tx.execute(
+    sql.raw(`
+      CREATE SCHEMA IF NOT EXISTS ${SCHEMA_NAME};
+  `),
+  );
+
   // Create schema version table
-  await tx.execute(`
-    CREATE TABLE IF NOT EXISTS ${SCHEMA_VERSION_TABLE_NAME} (
+  await tx.execute(
+    sql.raw(`
+    CREATE TABLE IF NOT EXISTS ${SCHEMA_NAME}.${SCHEMA_VERSION_TABLE_NAME} (
       k INTEGER PRIMARY KEY,
       version INTEGER NOT NULL
     );
-  `);
+  `),
+  );
 
   // Get current schema version
   const versionRows = await tx
@@ -80,23 +95,27 @@ export async function initializePersistentState<
   try {
     if (storedVersion === -1) {
       // First time initialization
-      await tx.execute(`
-        CREATE TABLE IF NOT EXISTS ${CHECKPOINTS_TABLE_NAME} (
+      await tx.execute(
+        sql.raw(`
+        CREATE TABLE IF NOT EXISTS ${SCHEMA_NAME}.${CHECKPOINTS_TABLE_NAME} (
           id TEXT PRIMARY KEY,
           order_key INTEGER NOT NULL,
           unique_key TEXT
         );
-      `);
+      `),
+      );
 
-      await tx.execute(`
-        CREATE TABLE IF NOT EXISTS ${FILTERS_TABLE_NAME} (
+      await tx.execute(
+        sql.raw(`
+        CREATE TABLE IF NOT EXISTS ${SCHEMA_NAME}.${FILTERS_TABLE_NAME} (
           id TEXT NOT NULL,
           filter TEXT NOT NULL,
           from_block INTEGER NOT NULL,
           to_block INTEGER DEFAULT NULL,
           PRIMARY KEY (id, from_block)
         );
-      `);
+      `),
+      );
 
       // Set initial schema version
       await tx.insert(schemaVersion).values({
@@ -155,7 +174,9 @@ export async function persistState<
           target: checkpoints.id,
           set: {
             orderKey: Number(endCursor.orderKey),
-            uniqueKey: endCursor.uniqueKey,
+            // Explicitly set the unique key to `null` to indicate that it has been deleted
+            // Otherwise drizzle will not update its value.
+            uniqueKey: endCursor.uniqueKey ? endCursor.uniqueKey : null,
           },
         });
 
@@ -297,3 +318,24 @@ export async function finalizeState<
     });
   }
 }
+
+export async function resetPersistence<
+  TQueryResult extends PgQueryResultHKT,
+  TFullSchema extends Record<string, unknown> = Record<string, never>,
+  TSchema extends
+    TablesRelationalConfig = ExtractTablesWithRelations<TFullSchema>,
+>(props: {
+  tx: PgTransaction<TQueryResult, TFullSchema, TSchema>;
+  indexerId: string;
+}) {
+  const { tx, indexerId } = props;
+
+  try {
+    await tx.delete(checkpoints).where(eq(checkpoints.id, indexerId));
+    await tx.delete(filters).where(eq(filters.id, indexerId));
+  } catch (error) {
+    throw new DrizzleStorageError("Failed to reset persistence state", {
+      cause: error,
+    });
+  }
+}