indexer: add plugins:init hook and hooks support in vcr and useTestDrizzleStorage() (#191)

resolves #190

Author: fracek

change/@apibara-indexer-9fa2931c-4a7e-4fb8-9f8b-cf50b02bf94f.json

@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "indexer: add hooks support to vcr and plugins:init hook",
+  "packageName": "@apibara/indexer",
+  "email": "jadejajaipal5@gmail.com",
+  "dependentChangeType": "patch"
+}

change/@apibara-plugin-drizzle-ea1d203a-a6e4-4043-be14-c3e737c25be5.json

@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "plugin-drizzle: add useTestDrizzleStorage and use `plugin:init` hook",
+  "packageName": "@apibara/plugin-drizzle",
+  "email": "jadejajaipal5@gmail.com",
+  "dependentChangeType": "patch"
+}

change/@apibara-plugin-mongo-32bec2ae-dcc5-4d53-a76a-78f3d7340a25.json

@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "plugin-mongo: use `plugin:init` hook",
+  "packageName": "@apibara/plugin-mongo",
+  "email": "jadejajaipal5@gmail.com",
+  "dependentChangeType": "patch"
+}

change/@apibara-plugin-sqlite-39d33299-a591-4c41-8661-da9efd0f214d.json

@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "plugin-sqlite: use `plugin:init` hook",
+  "packageName": "@apibara/plugin-sqlite",
+  "email": "jadejajaipal5@gmail.com",
+  "dependentChangeType": "patch"
+}

examples/cli-drizzle/indexers/1-evm.indexer.ts

@@ -43,6 +43,11 @@ export default function (runtimeConfig: ApibaraRuntimeConfig) {
         },
       ],
     },
+    hooks: {
+      "run:before": () => {
+        console.log("run:before hook called from indexer");
+      },
+    },
     plugins: [
       drizzleStorage({
         db: database,

examples/cli-drizzle/test/ethereum.test.ts

@@ -2,6 +2,7 @@ import { createVcr } from "apibara/testing";
 
 import createIndexer from "@/indexers/1-evm.indexer";
 import { ethereumUsdcTransfers } from "@/lib/schema";
+import { useTestDrizzleStorage } from "@apibara/plugin-drizzle";
 import { getTestDatabase } from "@apibara/plugin-drizzle/testing";
 import { describe, expect, it } from "vitest";
 
@@ -15,8 +16,20 @@ describe("Ethereum USDC Transfers indexer", () => {
     });
 
     const testResult = await vcr.run("ethereum-usdc-transfers", indexer, {
-      fromBlock: 10_000_000n,
-      toBlock: 10_000_005n,
+      range: {
+        fromBlock: 10_000_000n,
+        toBlock: 10_000_005n,
+      },
+      hooks: {
+        "run:before": async () => {
+          console.log("run:before hook called from test function");
+          const db = useTestDrizzleStorage();
+          await db.insert(ethereumUsdcTransfers).values({
+            number: 1,
+            hash: "0x0000000000000000000000000000000000000000000000000000000000000000",
+          });
+        },
+      },
     });
 
     const database = getTestDatabase(testResult);
@@ -25,6 +38,10 @@ describe("Ethereum USDC Transfers indexer", () => {
 
     expect(rows.map(({ _id, ...rest }) => rest)).toMatchInlineSnapshot(`
       [
+        {
+          "hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
+          "number": 1,
+        },
         {
           "hash": "0xfc80de5a3b766eece5c5a7f7858a9d537a8fefa8186c71fa7766a2bae939b816",
           "number": 10000001,

examples/cli-drizzle/test/starknet.test.ts

@@ -16,8 +16,7 @@ describe("Starknet USDC Transfers indexer", () => {
     });
 
     const testResult = await vcr.run("starknet-usdc-transfers", indexer, {
-      fromBlock: 800_000n,
-      toBlock: 800_005n,
+      range: { fromBlock: 800_000n, toBlock: 800_005n },
     });
 
     const database = getTestDatabase(testResult);

packages/indexer/src/indexer.ts

@@ -39,6 +39,7 @@ export type UseMiddlewareFunction = (
 ) => void;
 
 export interface IndexerHooks<TFilter, TBlock> {
+  "plugins:init": () => void;
   "run:before": () => void;
   "run:after": () => void;
   "connect:before": ({
@@ -230,6 +231,8 @@ export async function run<TFilter, TBlock>(
       context.debug = true;
     }
 
+    await indexer.hooks.callHook("plugins:init");
+
     const middleware = await registerMiddleware(indexer);
 
     const indexerMetrics = createIndexerMetrics();

packages/indexer/src/plugins/context.ts

@@ -7,7 +7,7 @@ export function internalContext<TFilter, TBlock, TTxnParams>(
   values: Record<string, unknown>,
 ) {
   return defineIndexerPlugin<TFilter, TBlock>((indexer) => {
-    indexer.hooks.hook("run:before", () => {
+    indexer.hooks.hook("plugins:init", () => {
       try {
         const ctx = useIndexerContext();
         ctx[INTERNAL_CONTEXT_PROPERTY] = {

packages/indexer/src/plugins/logger.ts

@@ -13,7 +13,7 @@ export function logger<TFilter, TBlock, TTxnParams>({
   logger,
 }: { logger?: ConsolaReporter } = {}) {
   return defineIndexerPlugin<TFilter, TBlock>((indexer) => {
-    indexer.hooks.hook("run:before", () => {
+    indexer.hooks.hook("plugins:init", () => {
       const ctx = useIndexerContext();
 
       if (logger) {