cli: use default logger that includes indexer name (#120)

change/apibara-17aa4aa8-e6bb-419c-9c4a-65bee8c749cd.json

@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "cli: use default logger that includes indexer name",
+  "packageName": "apibara",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

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

@@ -1,5 +1,6 @@
 import { EvmStream } from "@apibara/evm";
 import { defineIndexer } from "@apibara/indexer";
+import { useLogger } from "@apibara/indexer/plugins/logger";
 
 export default defineIndexer(EvmStream)({
   streamUrl: "https://ethereum.preview.apibara.org",
@@ -12,6 +13,7 @@ export default defineIndexer(EvmStream)({
     transactions: [{}],
   },
   async transform({ endCursor }) {
-    console.log({ endCursor });
+    const logger = useLogger();
+    logger.info("Transforming block ", endCursor?.orderKey);
   },
 });

examples/cli/indexers/2-starknet.indexer.ts

@@ -34,7 +34,7 @@ export default function (runtimeConfig: ApibaraRuntimeConfig) {
     },
     async transform({ endCursor, block: { header }, context }) {
       const logger = useLogger();
-      logger.info("Transforming block ", endCursor);
+      logger.info("Transforming block ", endCursor?.orderKey);
       const { writer } = useSink({ context });
 
       // writer.insert([{

packages/cli/src/core/apibara.ts

@@ -15,10 +15,8 @@ export async function createApibara(
   opts: LoadConfigOptions = {},
   dev = false,
 ): Promise<Apibara> {
-  // load options
   const options = await loadOptions(config, opts, dev);
 
-  // create apibara context
   const apibara: Apibara = {
     options,
     indexers: [],

packages/cli/src/rollup/plugins/config.ts

@@ -4,7 +4,9 @@ import type { Apibara } from "apibara/types";
 export function appConfig(apibara: Apibara) {
   return virtual({
     "#apibara-internal-virtual/config": `
-    export const config = ${JSON.stringify(apibara.options, null, 2)};
+    import * as projectConfig from '${apibara.options._c12.configFile}';
+
+    export const config = projectConfig.default;
     `,
   });
 }

packages/cli/src/runtime/index.ts

@@ -1 +1,2 @@
 export { createIndexer } from "./internal/app";
+export { createLogger } from "./internal/logger";

packages/cli/src/runtime/internal/app.ts

@@ -1,9 +1,11 @@
 import { createIndexer as _createIndexer } from "@apibara/indexer";
-import { logger } from "@apibara/indexer/plugins/logger";
+import { type ConsolaReporter, logger } from "@apibara/indexer/plugins/logger";
 
 import { config } from "#apibara-internal-virtual/config";
 import { indexers } from "#apibara-internal-virtual/indexers";
 
+import { createLogger } from "./logger";
+
 export const availableIndexers = indexers.map((i) => i.name);
 
 export function createIndexer(indexerName: string, preset?: string) {
@@ -39,7 +41,24 @@ export function createIndexer(indexerName: string, preset?: string) {
       ? indexerDefinition.indexer(runtimeConfig)
       : indexerDefinition.indexer;
 
-  definition.plugins = [...(definition.plugins ?? []), logger()];
+  let reporter: ConsolaReporter = createLogger({
+    indexer: indexerName,
+    preset,
+    indexers: availableIndexers,
+  });
+
+  if (config.logger) {
+    reporter = config.logger({
+      indexer: indexerName,
+      preset,
+      indexers: availableIndexers,
+    });
+  }
+
+  definition.plugins = [
+    ...(definition.plugins ?? []),
+    logger({ logger: reporter }),
+  ];
 
   return _createIndexer(definition);
 }

packages/cli/src/runtime/internal/logger.ts

@@ -0,0 +1,70 @@
+import type {
+  ConsolaOptions,
+  ConsolaReporter,
+  LogLevel,
+  LogObject,
+  LogType,
+} from "consola";
+import { type ColorName, colors, getColor } from "consola/utils";
+import { murmurHash } from "ohash";
+
+const INDEXER_COLOR_MAP = [
+  colors.red,
+  colors.green,
+  colors.yellow,
+  colors.blue,
+  colors.magenta,
+  colors.cyan,
+];
+
+const TYPE_COLOR_MAP: { [k in LogType]?: string } = {
+  info: "cyan",
+  fail: "red",
+  success: "green",
+  ready: "green",
+  start: "magenta",
+};
+
+const LEVEL_COLOR_MAP: { [k in LogLevel]?: string } = {
+  0: "red",
+  1: "yellow",
+};
+
+const MAX_INDEXER_NAME_LENGTH = 20;
+
+class DefaultReporter implements ConsolaReporter {
+  private tag: string;
+
+  constructor(indexer: string, indexers: string[], preset?: string) {
+    const color =
+      INDEXER_COLOR_MAP[murmurHash(indexer) % INDEXER_COLOR_MAP.length];
+
+    const presetLength = preset ? preset.length : 0;
+
+    const longestIndexerName =
+      Math.max(...indexers.map((i) => i.length), indexer.length) + presetLength;
+
+    const paddedIndexer = `${indexer}${preset ? `:${preset} ` : ""}`
+      .padEnd(longestIndexerName, " ")
+      .slice(0, Math.min(longestIndexerName, MAX_INDEXER_NAME_LENGTH));
+
+    this.tag = color(`${paddedIndexer} |`);
+  }
+
+  log(logObj: LogObject, ctx: { options: ConsolaOptions }) {
+    const { args } = logObj;
+    const typeColor =
+      TYPE_COLOR_MAP[logObj.type] || LEVEL_COLOR_MAP[logObj.level] || "gray";
+
+    const type = getColor(typeColor as ColorName, "white")(logObj.type);
+    console.log(`${this.tag} ${type}`, ...args);
+  }
+}
+
+export function createLogger({
+  indexer,
+  indexers,
+  preset,
+}: { indexer: string; indexers: string[]; preset?: string }) {
+  return new DefaultReporter(indexer, indexers, preset);
+}

packages/cli/src/types/config.ts

@@ -1,3 +1,4 @@
+import type { ConsolaReporter } from "@apibara/indexer/plugins/logger";
 import type { RollupCommonJSOptions } from "@rollup/plugin-commonjs";
 import type {
   C12InputConfig,
@@ -11,6 +12,11 @@ import type { DeepPartial } from "./_utils";
 import type { ApibaraHooks } from "./hooks";
 import type { RollupConfig } from "./rollup";
 
+export type LoggerFactory = ({
+  indexer,
+  preset,
+}: { indexer: string; indexers: string[]; preset?: string }) => ConsolaReporter;
+
 /**
  * Apibara Config type (apibara.config)
  */
@@ -25,6 +31,7 @@ export interface ApibaraConfig<
   runtimeConfig?: R;
   presets?: T;
   preset?: keyof T;
+  logger?: LoggerFactory;
 }
 
 export type ApibaraDynamicConfig = Pick<ApibaraConfig, "runtimeConfig">;
@@ -69,6 +76,9 @@ export interface ApibaraOptions<
   // Hooks
   hooks: NestedHooks<ApibaraHooks>;
 
+  // Logging
+  logger?: LoggerFactory;
+
   // Rollup
   rollupConfig?: RollupConfig;
   sourceMap?: boolean;