ConsoleFormatter.ts

/**
 * @license
 * Copyright 2026 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

import {
  createStackTraceForConsoleMessage,
  type TargetUniverse,
  SymbolizedError,
} from '../DevtoolsUtils.js';
import {UncaughtError} from '../PageCollector.js';
import * as DevTools from '../third_party/index.js';
import type {ConsoleMessage} from '../third_party/index.js';
import {formatConsoleMessage} from '../utils/ConsoleFormat.js';

export interface ConsoleFormatterOptions {
  fetchDetailedData?: boolean;
  id: number;
  devTools?: TargetUniverse;
  resolvedArgsForTesting?: unknown[];
  resolvedStackTraceForTesting?: DevTools.DevTools.StackTrace.StackTrace.StackTrace;
  resolvedCauseForTesting?: SymbolizedError;
  isIgnoredForTesting?: IgnoreCheck;
}

export type IgnoreCheck = (
  frame: DevTools.DevTools.StackTrace.StackTrace.Frame,
) => boolean;

export class ConsoleFormatter {
  static readonly #STACK_TRACE_MAX_LINES = 50;

  readonly #id: number;
  readonly #type: string;
  readonly #text: string;

  readonly #argCount: number;
  readonly #resolvedArgs: unknown[];
  readonly #remainingArgs: unknown[];

  readonly #stack?: DevTools.DevTools.StackTrace.StackTrace.StackTrace;
  readonly #cause?: SymbolizedError;

  readonly #isIgnored: IgnoreCheck;

  private constructor(params: {
    id: number;
    type: string;
    text: string;
    argCount?: number;
    resolvedArgs?: unknown[];
    stack?: DevTools.DevTools.StackTrace.StackTrace.StackTrace;
    cause?: SymbolizedError;
    isIgnored: IgnoreCheck;
  }) {
    this.#id = params.id;
    this.#type = params.type;
    this.#text = params.text;
    this.#argCount = params.argCount ?? 0;
    this.#resolvedArgs = params.resolvedArgs ?? [];

    // Calculate remaining arguments after template substitution
    if (this.#resolvedArgs.length > 0 && this.#text) {
      const {remainingArgs} = formatConsoleMessage(this.#text, this.#resolvedArgs);
      this.#remainingArgs = remainingArgs;
    } else if (!this.#text && this.#resolvedArgs.length > 0) {
      this.#remainingArgs = this.#resolvedArgs.slice(1);
    } else {
      this.#remainingArgs = this.#resolvedArgs;
    }

    this.#stack = params.stack;
    this.#cause = params.cause;
    this.#isIgnored = params.isIgnored;
  }

  static async from(
    msg: ConsoleMessage | UncaughtError,
    options: ConsoleFormatterOptions,
  ): Promise<ConsoleFormatter> {
    const ignoreListManager = options?.devTools?.universe.context.get(
      DevTools.DevTools.IgnoreListManager,
    );
    const isIgnored: IgnoreCheck =
      options.isIgnoredForTesting ||
      (frame => {
        if (!ignoreListManager) {
          return false;
        }
        if (frame.uiSourceCode) {
          return ignoreListManager.isUserOrSourceMapIgnoreListedUISourceCode(
            frame.uiSourceCode,
          );
        }
        if (frame.url) {
          return ignoreListManager.isUserIgnoreListedURL(
            frame.url as Parameters<
              DevTools.DevTools.IgnoreListManager['isUserIgnoreListedURL']
            >[0],
          );
        }
        return false;
      });

    if (msg instanceof UncaughtError) {
      const error = await SymbolizedError.fromDetails({
        devTools: options?.devTools,
        details: msg.details,
        targetId: msg.targetId,
        includeStackAndCause: options?.fetchDetailedData,
        resolvedStackTraceForTesting: options?.resolvedStackTraceForTesting,
        resolvedCauseForTesting: options?.resolvedCauseForTesting,
      });
      return new ConsoleFormatter({
        id: options.id,
        type: 'error',
        text: error.message,
        stack: error.stackTrace,
        cause: error.cause,
        isIgnored,
      });
    }

    let resolvedArgs: unknown[] = [];
    if (options.resolvedArgsForTesting) {
      resolvedArgs = options.resolvedArgsForTesting;
    } else {
      resolvedArgs = await Promise.all(
        msg.args().map(async (arg, i) => {
          try {
            const remoteObject = arg.remoteObject();
            if (
              options.fetchDetailedData &&
              options.devTools &&
              remoteObject.type === 'object' &&
              remoteObject.subtype === 'error'
            ) {
              return await SymbolizedError.fromError({
                devTools: options.devTools,
                error: remoteObject,
                // @ts-expect-error Internal ConsoleMessage API
                targetId: msg._targetId(),
              });
            }
            return await arg.jsonValue();
          } catch {
            return `<error: Argument ${i} is no longer available>`;
          }
        }),
      );
    }

    let stack: DevTools.DevTools.StackTrace.StackTrace.StackTrace | undefined;
    if (options.resolvedStackTraceForTesting) {
      stack = options.resolvedStackTraceForTesting;
    } else if (options.fetchDetailedData && options.devTools) {
      try {
        stack = await createStackTraceForConsoleMessage(options.devTools, msg);
      } catch {
        // ignore
      }
    }

    return new ConsoleFormatter({
      id: options.id,
      type: msg.type(),
      text: msg.text(),
      argCount: resolvedArgs.length || msg.args().length,
      resolvedArgs,
      stack,
      isIgnored,
    });
  }

  // The short format for a console message.
  toString(): string {
    return `msgid=${this.#id} [${this.#type}] ${this.#getFormattedText()} (${this.#argCount} args)`;
  }

  // The verbose format for a console message, including all details.
  toStringDetailed(): string {
    const result = [
      `ID: ${this.#id}`,
      `Message: ${this.#type}> ${this.#getFormattedText()}`,
      this.#formatArgs(),
      this.#formatStackTrace(this.#stack, this.#cause, {
        includeHeading: true,
      }),
    ].filter(line => !!line);
    return result.join('\n');
  }

  // Gets the formatted message text, applying template string substitutions if arguments are available.
  #getFormattedText(): string {
    if (this.#resolvedArgs.length > 0 && this.#text) {
      // apply template formatting
      const {formattedText} = formatConsoleMessage(this.#text, this.#resolvedArgs);
      return formattedText;
    } else if (!this.#text && this.#resolvedArgs.length > 0) {
      return this.#formatArg(this.#resolvedArgs[0]);
    }
    // return the raw text
    return this.#text;
  }

  #getArgs(): unknown[] {
    // Return the remaining arguments after template substitution
    return this.#remainingArgs;
  }

  #formatArg(arg: unknown) {
    if (arg instanceof SymbolizedError) {
      return [
        arg.message,
        this.#formatStackTrace(arg.stackTrace, arg.cause, {
          includeHeading: false,
        }),
      ]
        .filter(line => !!line)
        .join('\n');
    }
    return typeof arg === 'object' ? JSON.stringify(arg) : String(arg);
  }

  #formatArgs(): string {
    const args = this.#getArgs();

    if (!args.length) {
      return '';
    }

    const result = ['### Arguments'];

    for (const [key, arg] of args.entries()) {
      result.push(`Arg #${key}: ${this.#formatArg(arg)}`);
    }

    return result.join('\n');
  }

  #formatStackTrace(
    stackTrace: DevTools.DevTools.StackTrace.StackTrace.StackTrace | undefined,
    cause: SymbolizedError | undefined,
    opts: {includeHeading: boolean},
  ): string {
    if (!stackTrace) {
      return '';
    }

    const lines = this.#formatStackTraceInner(stackTrace, cause);
    const includedLines = lines.slice(
      0,
      ConsoleFormatter.#STACK_TRACE_MAX_LINES,
    );
    const reminderCount = lines.length - includedLines.length;

    return [
      opts.includeHeading ? '### Stack trace' : '',
      ...includedLines,
      reminderCount > 0 ? `... and ${reminderCount} more frames` : '',
      'Note: line and column numbers use 1-based indexing',
    ]
      .filter(line => !!line)
      .join('\n');
  }

  #formatStackTraceInner(
    stackTrace: DevTools.DevTools.StackTrace.StackTrace.StackTrace | undefined,
    cause: SymbolizedError | undefined,
  ): string[] {
    if (!stackTrace) {
      return [];
    }

    return [
      ...this.#formatFragment(stackTrace.syncFragment),
      ...stackTrace.asyncFragments
        .map(this.#formatAsyncFragment.bind(this))
        .flat(),
      ...this.#formatCause(cause),
    ];
  }

  #formatFragment(
    fragment: DevTools.DevTools.StackTrace.StackTrace.Fragment,
  ): string[] {
    const frames = fragment.frames.filter(frame => !this.#isIgnored(frame));
    return frames.map(this.#formatFrame.bind(this));
  }

  #formatAsyncFragment(
    fragment: DevTools.DevTools.StackTrace.StackTrace.AsyncFragment,
  ): string[] {
    const formattedFrames = this.#formatFragment(fragment);
    if (formattedFrames.length === 0) {
      return [];
    }

    const separatorLineLength = 40;
    const prefix = `--- ${fragment.description || 'async'} `;
    const separator = prefix + '-'.repeat(separatorLineLength - prefix.length);
    return [separator, ...formattedFrames];
  }

  #formatFrame(frame: DevTools.DevTools.StackTrace.StackTrace.Frame): string {
    let result = `at ${frame.name ?? '<anonymous>'}`;
    if (frame.uiSourceCode) {
      const location = frame.uiSourceCode.uiLocation(frame.line, frame.column);
      result += ` (${location.linkText(/* skipTrim */ false, /* showColumnNumber */ true)})`;
    } else if (frame.url) {
      result += ` (${frame.url}:${frame.line}:${frame.column})`;
    }
    return result;
  }

  #formatCause(cause: SymbolizedError | undefined): string[] {
    if (!cause) {
      return [];
    }

    return [
      `Caused by: ${cause.message}`,
      ...this.#formatStackTraceInner(cause.stackTrace, cause.cause),
    ];
  }

  toJSON(): object {
    return {
      type: this.#type,
      text: this.#text,
      argsCount: this.#argCount,
      id: this.#id,
    };
  }

  toJSONDetailed(): object {
    return {
      id: this.#id,
      type: this.#type,
      text: this.#text,
      args: this.#getArgs().map(arg =>
        typeof arg === 'object' ? arg : String(arg),
      ),
      stackTrace: this.#stack,
    };
  }
}