apibara 2.1.0-beta.12 → 2.1.0-beta.14

package/dist/rolldown/index.mjs

@@ -2,10 +2,11 @@ import { existsSync } from 'node:fs';
 import { builtinModules } from 'node:module';
 import replace from '@rollup/plugin-replace';
 import defu from 'defu';
-import { join } from 'pathe';
+import { join as join$1 } from 'pathe';
 import { s as serialize } from '../shared/apibara.af330c7d.mjs';
 import virtual from '@rollup/plugin-virtual';
 import { hash } from 'ohash';
+import { join } from 'node:path';
 
 function appConfig(apibara) {
   return virtual({
@@ -42,6 +43,45 @@ function indexers(apibara) {
   });
 }
 
+function instrumentation(apibara) {
+  const instrumentationPath = join(
+    apibara.options._c12.cwd,
+    `instrumentation.${apibara.options._c12.configFile?.endsWith(".ts") ? "ts" : "js"}`
+  );
+  if (!existsSync(instrumentationPath)) {
+    return virtual({
+      "#apibara-internal-virtual/instrumentation": `
+      let register = undefined;
+      let logger = undefined;
+  
+      export { register, logger };
+      `
+    });
+  }
+  return virtual({
+    "#apibara-internal-virtual/instrumentation": `
+    let register = undefined;
+    let logger = undefined;
+
+    try {
+      const instrumentation = require('${instrumentationPath}');
+      
+      if (instrumentation?.register && typeof instrumentation.register === "function") {
+        register = instrumentation.register;
+      }
+      
+      if (instrumentation?.logger && typeof instrumentation.logger === "function") {
+        logger = instrumentation.logger;
+      }
+    } catch {
+      // Silently handle any require errors
+    }
+
+    export { register, logger };
+    `
+  });
+}
+
 const runtimeDependencies = [
   "better-sqlite3",
   "@electric-sql/pglite",
@@ -62,7 +102,7 @@ function getRolldownConfig(apibara) {
     ".jsx"
   ];
   const tsConfigExists = existsSync(
-    join(apibara.options.rootDir, "tsconfig.json")
+    join$1(apibara.options.rootDir, "tsconfig.json")
   );
   const rolldownConfig = defu(
     // biome-ignore lint/suspicious/noExplicitAny: apibara.options.rolldownConfig is typed
@@ -71,7 +111,7 @@ function getRolldownConfig(apibara) {
       platform: "node",
       input: apibara.options.entry,
       output: {
-        dir: join(apibara.options.outputDir || "./.apibara/build"),
+        dir: join$1(apibara.options.outputDir || "./.apibara/build"),
         format: "esm",
         entryFileNames: "[name].mjs",
         chunkFileNames: "chunks/[name]-[hash].mjs",
@@ -104,6 +144,7 @@ function getRolldownConfig(apibara) {
       }
     })
   );
+  rolldownConfig.plugins?.push(instrumentation(apibara));
   rolldownConfig.plugins?.push(indexers(apibara));
   rolldownConfig.plugins?.push(appConfig());
   return rolldownConfig;

package/dist/runtime/internal/app.mjs

@@ -9,6 +9,7 @@ import {
 import consola from "consola";
 import { config } from "#apibara-internal-virtual/config";
 import { indexers } from "#apibara-internal-virtual/indexers";
+import { logger as instrumentationLogger } from "#apibara-internal-virtual/instrumentation";
 import { createLogger } from "./logger.mjs";
 export const availableIndexers = indexers.map((i) => i.name);
 export function createIndexer(indexerName, preset) {
@@ -39,11 +40,21 @@ export function createIndexer(indexerName, preset) {
     return;
   }
   const definition = typeof indexerModule === "function" ? indexerModule(runtimeConfig) : indexerModule;
-  const reporter = createLogger({
+  let reporter = createLogger({
     indexer: indexerName,
     preset,
     indexers: availableIndexers
   });
+  if (instrumentationLogger) {
+    const _reporter = instrumentationLogger({
+      indexer: indexerName,
+      preset,
+      indexers: availableIndexers
+    });
+    if (_reporter && "log" in _reporter) {
+      reporter = _reporter;
+    }
+  }
   definition.plugins = [
     internalContext({
       indexerName,

package/dist/runtime/start.mjs

@@ -2,6 +2,7 @@ import { runWithReconnect } from "@apibara/indexer";
 import { createClient } from "@apibara/protocol";
 import { defineCommand, runMain } from "citty";
 import consola from "consola";
+import { register } from "#apibara-internal-virtual/instrumentation";
 import { createIndexer } from "./internal/app.mjs";
 const startCommand = defineCommand({
   meta: {
@@ -30,6 +31,11 @@ const startCommand = defineCommand({
       indexerInstance.streamConfig,
       indexerInstance.options.streamUrl
     );
+    if (register) {
+      consola.start("Registering from instrumentation");
+      await register();
+      consola.success("Registered from instrumentation");
+    }
     await runWithReconnect(client, indexerInstance);
   }
 });

package/dist/types/index.d.mts

@@ -18,11 +18,13 @@ interface ApibaraHooks {
     close: () => void;
 }
 
-type LoggerFactory = ({ indexer, preset, }: {
+type RegisterFn = () => Promise<void>;
+type LoggerFactoryFn = ({ indexer, indexers, preset, }: LoggerFactoryArgs) => ConsolaReporter;
+type LoggerFactoryArgs = {
     indexer: string;
     indexers: string[];
     preset?: string;
-}) => ConsolaReporter;
+};
 /**
  * Apibara Config type (apibara.config)
  */
@@ -30,7 +32,6 @@ interface ApibaraConfig<T extends Record<string, DeepPartial<Pick<ApibaraConfig<
     runtimeConfig?: R;
     presets?: T;
     preset?: keyof T;
-    logger?: LoggerFactory;
 }
 type ApibaraDynamicConfig = Pick<ApibaraConfig, "runtimeConfig">;
 /**
@@ -54,7 +55,6 @@ interface ApibaraOptions<T extends Record<string, DeepPartial<Pick<ApibaraConfig
     dev: boolean;
     watchOptions: WatchOptions["watch"];
     hooks: NestedHooks<ApibaraHooks>;
-    logger?: LoggerFactory;
     rolldownConfig?: Partial<RolldownOptions>;
     /**
      * @deprecated Use rolldownConfig instead. This option will be removed in future releases.
@@ -90,4 +90,4 @@ type RolldownConfig = InputOptions & {
 
 type ApibaraRuntimeConfig = Record<string, unknown>;
 
-export type { Apibara, ApibaraConfig, ApibaraDynamicConfig, ApibaraHooks, ApibaraOptions, ApibaraRuntimeConfig, DeepPartial, IndexerDefinition, LoadConfigOptions, LoggerFactory, RolldownConfig };
+export type { Apibara, ApibaraConfig, ApibaraDynamicConfig, ApibaraHooks, ApibaraOptions, ApibaraRuntimeConfig, DeepPartial, IndexerDefinition, LoadConfigOptions, LoggerFactoryArgs, LoggerFactoryFn, RegisterFn, RolldownConfig };

package/dist/types/index.d.ts

@@ -18,11 +18,13 @@ interface ApibaraHooks {
     close: () => void;
 }
 
-type LoggerFactory = ({ indexer, preset, }: {
+type RegisterFn = () => Promise<void>;
+type LoggerFactoryFn = ({ indexer, indexers, preset, }: LoggerFactoryArgs) => ConsolaReporter;
+type LoggerFactoryArgs = {
     indexer: string;
     indexers: string[];
     preset?: string;
-}) => ConsolaReporter;
+};
 /**
  * Apibara Config type (apibara.config)
  */
@@ -30,7 +32,6 @@ interface ApibaraConfig<T extends Record<string, DeepPartial<Pick<ApibaraConfig<
     runtimeConfig?: R;
     presets?: T;
     preset?: keyof T;
-    logger?: LoggerFactory;
 }
 type ApibaraDynamicConfig = Pick<ApibaraConfig, "runtimeConfig">;
 /**
@@ -54,7 +55,6 @@ interface ApibaraOptions<T extends Record<string, DeepPartial<Pick<ApibaraConfig
     dev: boolean;
     watchOptions: WatchOptions["watch"];
     hooks: NestedHooks<ApibaraHooks>;
-    logger?: LoggerFactory;
     rolldownConfig?: Partial<RolldownOptions>;
     /**
      * @deprecated Use rolldownConfig instead. This option will be removed in future releases.
@@ -90,4 +90,4 @@ type RolldownConfig = InputOptions & {
 
 type ApibaraRuntimeConfig = Record<string, unknown>;
 
-export type { Apibara, ApibaraConfig, ApibaraDynamicConfig, ApibaraHooks, ApibaraOptions, ApibaraRuntimeConfig, DeepPartial, IndexerDefinition, LoadConfigOptions, LoggerFactory, RolldownConfig };
+export type { Apibara, ApibaraConfig, ApibaraDynamicConfig, ApibaraHooks, ApibaraOptions, ApibaraRuntimeConfig, DeepPartial, IndexerDefinition, LoadConfigOptions, LoggerFactoryArgs, LoggerFactoryFn, RegisterFn, RolldownConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apibara",
-  "version": "2.1.0-beta.12",
+  "version": "2.1.0-beta.14",
   "type": "module",
   "main": "./dist/core/index.mjs",
   "exports": {
@@ -78,7 +78,7 @@
     "playground:add": "pnpm playground add --dir playground"
   },
   "devDependencies": {
-    "@apibara/starknet": "2.1.0-beta.12",
+    "@apibara/starknet": "2.1.0-beta.14",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^20.14.0",
     "@types/prompts": "^2.4.9",
@@ -89,8 +89,8 @@
     "vitest": "^1.6.0"
   },
   "dependencies": {
-    "@apibara/indexer": "2.1.0-beta.12",
-    "@apibara/protocol": "2.1.0-beta.12",
+    "@apibara/indexer": "2.1.0-beta.14",
+    "@apibara/protocol": "2.1.0-beta.14",
     "@rollup/plugin-replace": "^6.0.2",
     "@rollup/plugin-virtual": "^3.0.2",
     "c12": "^1.11.1",

package/src/rolldown/config.ts

@@ -12,6 +12,7 @@ import type {
 import { serialize } from "../utils/helper";
 import { appConfig } from "./plugins/config";
 import { indexers } from "./plugins/indexers";
+import { instrumentation } from "./plugins/instrumentation";
 
 const runtimeDependencies = [
   "better-sqlite3",
@@ -86,6 +87,8 @@ export function getRolldownConfig(apibara: Apibara): RolldownOptions {
       },
     }) as RolldownPluginOption,
   );
+
+  rolldownConfig.plugins?.push(instrumentation(apibara));
   rolldownConfig.plugins?.push(indexers(apibara));
   rolldownConfig.plugins?.push(appConfig(apibara));
 

package/src/rolldown/plugins/instrumentation.ts

@@ -0,0 +1,68 @@
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+import virtual from "@rollup/plugin-virtual";
+import type { Apibara } from "apibara/types";
+import type { RolldownPluginOption } from "rolldown";
+
+export function instrumentation(apibara: Apibara) {
+  const instrumentationPath = join(
+    apibara.options._c12.cwd!,
+    `instrumentation.${apibara.options._c12.configFile?.endsWith(".ts") ? "ts" : "js"}`,
+  );
+
+  if (!existsSync(instrumentationPath)) {
+    return virtual({
+      "#apibara-internal-virtual/instrumentation": `
+      let register = undefined;
+      let logger = undefined;
+  
+      export { register, logger };
+      `,
+    }) as RolldownPluginOption;
+  }
+
+  /**
+   * We are importing the instrumentation file inline with "require" instead of "import" at the top of the file to avoid warnings from rolldown
+   * when some methods are not defined in the instrumentation file.
+   *
+   * Example warning:
+   * 
+   * [IMPORT_IS_UNDEFINED] Warning: Import `logger` will always be undefined because there is no matching export in 'instrumentation.ts'
+   *     ╭─[virtual:#apibara-internal-virtual/instrumentation:11:35]
+   *     │
+   *  11 │     if (instrumentation && typeof instrumentation.logger === "function") {
+   *     │                                   ───────────┬──────────  
+   *     │                                              ╰──────────── 
+   * ────╯
+
+  * [IMPORT_IS_UNDEFINED] Warning: Import `logger` will always be undefined because there is no matching export in 'instrumentation.ts'
+  *     ╭─[virtual:#apibara-internal-virtual/instrumentation:12:16]
+  *     │
+  *  12 │       logger = instrumentation.logger;
+  *     │                ───────────┬──────────  
+  *     │                           ╰──────────── 
+  * ────╯ 
+  */
+  return virtual({
+    "#apibara-internal-virtual/instrumentation": `
+    let register = undefined;
+    let logger = undefined;
+
+    try {
+      const instrumentation = require('${instrumentationPath}');
+      
+      if (instrumentation?.register && typeof instrumentation.register === "function") {
+        register = instrumentation.register;
+      }
+      
+      if (instrumentation?.logger && typeof instrumentation.logger === "function") {
+        logger = instrumentation.logger;
+      }
+    } catch {
+      // Silently handle any require errors
+    }
+
+    export { register, logger };
+    `,
+  }) as RolldownPluginOption;
+}

package/src/runtime/internal/app.ts

@@ -11,6 +11,7 @@ import {
 import consola from "consola";
 import { config } from "#apibara-internal-virtual/config";
 import { indexers } from "#apibara-internal-virtual/indexers";
+import { logger as instrumentationLogger } from "#apibara-internal-virtual/instrumentation";
 import { createLogger } from "./logger";
 
 export const availableIndexers = indexers.map((i) => i.name);
@@ -56,28 +57,26 @@ export function createIndexer(indexerName: string, preset?: string) {
       ? indexerModule(runtimeConfig)
       : indexerModule;
 
-  const reporter: ConsolaReporter = createLogger({
+  let reporter: ConsolaReporter = createLogger({
     indexer: indexerName,
     preset,
     indexers: availableIndexers,
   });
 
-  // TODO: Add support for custom logger
-  //
-  // Custom logger support is temporarily disabled to prevent bundling issues.
-  // Previously, when using the config object directly, Rollup would bundle everything
-  // referenced in apibara.config, including plugins. Now we serialize only the
-  // essential config properties (runtimeConfig, preset, presets) during build time,
-  // which prevents unwanted bundling but also means we can't access the logger
-  // configuration.
-  //
-  // if (config.logger) {
-  //   reporter = config.logger({
-  //     indexer: indexerName,
-  //     preset,
-  //     indexers: availableIndexers,
-  //   });
-  // }
+  // Check if a custom logger is provided through instrumentation
+  if (instrumentationLogger) {
+    // Create a reporter using the custom logger function
+    const _reporter = instrumentationLogger({
+      indexer: indexerName,
+      preset,
+      indexers: availableIndexers,
+    });
+
+    // If the reporter is valid (has a log method), use it instead of the default
+    if (_reporter && "log" in _reporter) {
+      reporter = _reporter;
+    }
+  }
 
   // Put the in-memory persistence plugin first so that it can be overridden by any user-defined
   // persistence plugin.

package/src/runtime/start.ts

@@ -2,6 +2,7 @@ import { runWithReconnect } from "@apibara/indexer";
 import { createClient } from "@apibara/protocol";
 import { defineCommand, runMain } from "citty";
 import consola from "consola";
+import { register } from "#apibara-internal-virtual/instrumentation";
 import { createIndexer } from "./internal/app";
 
 const startCommand = defineCommand({
@@ -34,6 +35,12 @@ const startCommand = defineCommand({
       indexerInstance.options.streamUrl,
     );
 
+    if (register) {
+      consola.start("Registering from instrumentation");
+      await register();
+      consola.success("Registered from instrumentation");
+    }
+
     await runWithReconnect(client, indexerInstance);
   },
 });

package/src/types/config.ts

@@ -11,10 +11,19 @@ import type { RolldownOptions } from "rolldown";
 import type { DeepPartial } from "./_utils";
 import type { ApibaraHooks } from "./hooks";
 
-export type LoggerFactory = ({
+export type RegisterFn = () => Promise<void>;
+
+export type LoggerFactoryFn = ({
   indexer,
+  indexers,
   preset,
-}: { indexer: string; indexers: string[]; preset?: string }) => ConsolaReporter;
+}: LoggerFactoryArgs) => ConsolaReporter;
+
+export type LoggerFactoryArgs = {
+  indexer: string;
+  indexers: string[];
+  preset?: string;
+};
 
 /**
  * Apibara Config type (apibara.config)
@@ -30,7 +39,6 @@ export interface ApibaraConfig<
   runtimeConfig?: R;
   presets?: T;
   preset?: keyof T;
-  logger?: LoggerFactory;
 }
 
 export type ApibaraDynamicConfig = Pick<ApibaraConfig, "runtimeConfig">;
@@ -75,9 +83,6 @@ export interface ApibaraOptions<
   // Hooks
   hooks: NestedHooks<ApibaraHooks>;
 
-  // Logging
-  logger?: LoggerFactory;
-
   // Rolldown
   rolldownConfig?: Partial<RolldownOptions>;
 

package/src/types/virtual/instrumentation.d.ts

@@ -0,0 +1,4 @@
+import type { LoggerFactoryFn, RegisterFn } from "apibara/types";
+
+export const register: RegisterFn | undefined = undefined;
+export const logger: LoggerFactoryFn | undefined = undefined;