devtools-tracing 1.1.1 → 1.2.0

package/lib/front_end/core/sdk/SourceMapCache.ts

@@ -1,54 +0,0 @@
-// Copyright 2025 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import type {DebugId, SourceMapV3} from './SourceMap.js';
-
-/** A thin wrapper around the Cache API to store source map JSONs keyed on Debug IDs */
-export class SourceMapCache {
-  static readonly #INSTANCE = new SourceMapCache('devtools-source-map-cache');
-
-  static instance(): SourceMapCache {
-    return this.#INSTANCE;
-  }
-
-  static createForTest(name: string): SourceMapCache {
-    return new SourceMapCache(name);
-  }
-
-  readonly #name: string;
-  #cachePromise?: Promise<Cache>;
-
-  private constructor(name: string) {
-    this.#name = name;
-  }
-
-  async set(debugId: DebugId, sourceMap: SourceMapV3): Promise<void> {
-    const cache = await this.#cache();
-    await cache.put(SourceMapCache.#urlForDebugId(debugId), new Response(JSON.stringify(sourceMap)));
-  }
-
-  async get(debugId: DebugId): Promise<SourceMapV3|null> {
-    const cache = await this.#cache();
-    const response = await cache.match(SourceMapCache.#urlForDebugId(debugId));
-    return await response?.json() ?? null;
-  }
-
-  async #cache(): Promise<Cache> {
-    if (this.#cachePromise) {
-      return await this.#cachePromise;
-    }
-
-    this.#cachePromise = window.caches.open(this.#name);
-    return await this.#cachePromise;
-  }
-
-  /** The Cache API only allows URL as keys, so we construct a simple one. Given that we have our own cache, we have no risk of conflicting URLs */
-  static #urlForDebugId(debugId: DebugId): string {
-    return 'http://debug.id/' + encodeURIComponent(debugId);
-  }
-
-  async disposeForTest(): Promise<void> {
-    await window.caches.delete(this.#name);
-  }
-}

package/lib/front_end/core/sdk/SourceMapFunctionRanges.ts

@@ -1,156 +0,0 @@
-// Copyright 2025 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import type * as ScopesCodec from '../../third_party/source-map-scopes-codec/source-map-scopes-codec.js';
-
-import {TokenIterator} from './SourceMap.js';
-
-export interface NamedFunctionRange {
-  start: ScopesCodec.Position;
-  end: ScopesCodec.Position;
-  name: string;
-}
-
-/**
- * Turns a list of {@link NamedFunctionRange}s into a single {@link OriginalScope} tree nested
- * according to the start/end position. Each range is turned into a OriginalScope with the `isStackFrame`
- * bit set to denote it as a function and a generic "Function" label.
- *
- * We nest all these function scopes underneath a single global scope that always starts at (0, 0) and
- * reaches to the largest end position.
- *
- * `ranges` can be unsorted but will be sorted in-place.
- *
- * @throws if the ranges are not nested properly. Concretely: start < end for each range, and no
- * "straddling" (i.e. partially overlapping ranges).
- */
-export function buildOriginalScopes(ranges: NamedFunctionRange[]): ScopesCodec.OriginalScope {
-  validateStartBeforeEnd(ranges);
-
-  // 1. Sort ranges by ascending start position.
-  //    If two ranges have the same start position, we sort the one
-  //    with the higher end position first, because it's the parent.
-  ranges.sort((a, b) => comparePositions(a.start, b.start) || comparePositions(b.end, a.end));
-
-  const root: ScopesCodec.OriginalScope = {
-    start: {line: 0, column: 0},
-    end: {line: Number.POSITIVE_INFINITY, column: Number.POSITIVE_INFINITY},
-    kind: 'Global',
-    isStackFrame: false,
-    children: [],
-    variables: [],
-  };
-
-  // 2. Build the tree from the ranges.
-  const stack: ScopesCodec.OriginalScope[] = [root];
-  for (const range of ranges) {
-    // Pop all scopes that precede the current entry (to find the right parent).
-    let stackTop = stack.at(-1) as ScopesCodec.OriginalScope;
-    while (true) {
-      if (comparePositions(stackTop.end, range.start) <= 0) {
-        stack.pop();
-        stackTop = stack.at(-1) as ScopesCodec.OriginalScope;
-      } else {
-        break;
-      }
-    }
-
-    /*
-     * Check for partially overlapping ranges:
-     *
-     * --- A
-     *  |  --- B
-     * ---  |
-     *     ---
-     *
-     *i.e.: B.start < A.end < B.end
-     */
-    if (comparePositions(range.start, stackTop.end) < 0 && comparePositions(stackTop.end, range.end) < 0) {
-      throw new Error(`Range ${JSON.stringify(range)} and ${JSON.stringify(stackTop)} partially overlap.`);
-    }
-
-    const scope = createScopeFrom(range);
-    stackTop.children.push(scope);
-    stack.push(scope);
-  }
-
-  // 3. Update root.end.
-  const lastChild = root.children.at(-1);
-  if (lastChild) {
-    root.end = lastChild.end;
-  }
-
-  return root;
-}
-
-function validateStartBeforeEnd(ranges: NamedFunctionRange[]): void {
-  for (const range of ranges) {
-    if (comparePositions(range.start, range.end) >= 0) {
-      throw new Error(`Invalid range. End before start: ${JSON.stringify(range)}`);
-    }
-  }
-}
-
-function createScopeFrom(range: NamedFunctionRange): ScopesCodec.OriginalScope {
-  return {
-    ...range,
-    kind: 'Function',
-    isStackFrame: true,
-    children: [],
-    variables: [],
-  };
-}
-
-/**
- * Implements decoding of the pasta source map specification.
- *
- * See https://github.com/bloomberg/pasta-sourcemaps/blob/main/spec.md
- */
-export function decodePastaRanges(encodedRanges: string, names: string[]): NamedFunctionRange[] {
-  const result: NamedFunctionRange[] = [];
-
-  let nameIndex = 0;
-  let startLineNumber = 0;
-  let startColumnNumber = 0;
-  let endLineNumber = 0;
-  let endColumnNumber = 0;
-
-  const tokenIter = new TokenIterator(encodedRanges);
-  let atStart = true;
-  while (tokenIter.hasNext()) {
-    if (atStart) {
-      atStart = false;
-    } else if (tokenIter.peek() === ',') {
-      tokenIter.next();
-    } else {
-      // Unexpected character. Return what we have up until now.
-      break;
-    }
-
-    nameIndex += tokenIter.nextVLQ();
-    startLineNumber = endLineNumber + tokenIter.nextVLQ();
-    startColumnNumber += tokenIter.nextVLQ();
-    endLineNumber = startLineNumber + tokenIter.nextVLQ();
-    endColumnNumber += tokenIter.nextVLQ();
-
-    const name = names[nameIndex];
-    if (name === undefined) {
-      // If the range doesn't have a valid name, ignore it.
-      continue;
-    }
-
-    result.push({
-      start: {line: startLineNumber, column: startColumnNumber},
-      end: {line: endLineNumber, column: endColumnNumber},
-      name,
-    });
-  }
-
-  return result;
-}
-
-/** @returns 0 if both positions are equal, a negative number if a < b and a positive number if a > b */
-function comparePositions(a: ScopesCodec.Position, b: ScopesCodec.Position): number {
-  return a.line - b.line || a.column - b.column;
-}

package/lib/front_end/core/sdk/SourceMapManager.ts

@@ -1,239 +0,0 @@
-// Copyright 2017 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import * as Common from '../common/common.js';
-import * as Platform from '../platform/platform.js';
-
-import type {FrameAssociated} from './FrameAssociated.js';
-import {PageResourceLoader, type PageResourceLoadInitiator} from './PageResourceLoader.js';
-import {type DebugId, parseSourceMap, SourceMap, type SourceMapV3} from './SourceMap.js';
-import {SourceMapCache} from './SourceMapCache.js';
-import {type Target, Type} from './Target.js';
-
-export type SourceMapFactory<T> =
-    (compiledURL: Platform.DevToolsPath.UrlString, sourceMappingURL: Platform.DevToolsPath.UrlString,
-     payload: SourceMapV3, client: T) => SourceMap;
-
-export class SourceMapManager<T extends FrameAssociated> extends Common.ObjectWrapper.ObjectWrapper<EventTypes<T>> {
-  readonly #target: Target;
-  readonly #factory: SourceMapFactory<T>;
-  #isEnabled = true;
-  readonly #clientData = new Map<T, ClientData>();
-  readonly #sourceMaps = new Map<SourceMap, T>();
-  #attachingClient: T|null = null;
-
-  constructor(target: Target, factory?: SourceMapFactory<T>) {
-    super();
-
-    this.#target = target;
-    this.#factory =
-        factory ?? ((compiledURL, sourceMappingURL, payload) => new SourceMap(compiledURL, sourceMappingURL, payload));
-  }
-
-  setEnabled(isEnabled: boolean): void {
-    if (isEnabled === this.#isEnabled) {
-      return;
-    }
-
-    // We need this copy, because `this.#clientData` is getting modified
-    // in the loop body and trying to iterate over it at the same time
-    // leads to an infinite loop.
-    const clientData = [...this.#clientData.entries()];
-    for (const [client] of clientData) {
-      this.detachSourceMap(client);
-    }
-    this.#isEnabled = isEnabled;
-    for (const [client, {relativeSourceURL, relativeSourceMapURL}] of clientData) {
-      this.attachSourceMap(client, relativeSourceURL, relativeSourceMapURL);
-    }
-  }
-
-  private static getBaseUrl(target: Target|null): Platform.DevToolsPath.UrlString {
-    while (target && target.type() !== Type.FRAME) {
-      target = target.parentTarget();
-    }
-    return target?.inspectedURL() ?? Platform.DevToolsPath.EmptyUrlString;
-  }
-
-  static resolveRelativeSourceURL(target: Target|null, url: Platform.DevToolsPath.UrlString):
-      Platform.DevToolsPath.UrlString {
-    url = Common.ParsedURL.ParsedURL.completeURL(SourceMapManager.getBaseUrl(target), url) ?? url;
-    return url;
-  }
-
-  sourceMapForClient(client: T): SourceMap|undefined {
-    return this.#clientData.get(client)?.sourceMap;
-  }
-
-  // This method actively awaits the source map, if still loading.
-  sourceMapForClientPromise(client: T): Promise<SourceMap|undefined> {
-    const clientData = this.#clientData.get(client);
-    if (!clientData) {
-      return Promise.resolve(undefined);
-    }
-
-    return clientData.sourceMapPromise;
-  }
-
-  clientForSourceMap(sourceMap: SourceMap): T|undefined {
-    return this.#sourceMaps.get(sourceMap);
-  }
-
-  // TODO(bmeurer): We are lying about the type of |relativeSourceURL| here.
-  attachSourceMap(
-      client: T, relativeSourceURL: Platform.DevToolsPath.UrlString, relativeSourceMapURL: string|undefined): void {
-    if (this.#clientData.has(client)) {
-      throw new Error('SourceMap is already attached or being attached to client');
-    }
-    if (!relativeSourceMapURL) {
-      return;
-    }
-
-    let clientData: ClientData|null = {
-      relativeSourceURL,
-      relativeSourceMapURL,
-      sourceMap: undefined,
-      sourceMapPromise: Promise.resolve(undefined),
-    };
-    if (this.#isEnabled) {
-      // The `// #sourceURL=foo` can be a random string, but is generally an absolute path.
-      // Complete it to inspected page url for relative links.
-      const sourceURL = SourceMapManager.resolveRelativeSourceURL(this.#target, relativeSourceURL);
-      const sourceMapURL = Common.ParsedURL.ParsedURL.completeURL(sourceURL, relativeSourceMapURL);
-      if (sourceMapURL) {
-        if (this.#attachingClient) {
-          // This should not happen
-          console.error('Attaching source map may cancel previously attaching source map');
-        }
-        this.#attachingClient = client;
-        this.dispatchEventToListeners(Events.SourceMapWillAttach, {client});
-
-        if (this.#attachingClient === client) {
-          this.#attachingClient = null;
-          const initiator = client.createPageResourceLoadInitiator();
-          clientData.sourceMapPromise =
-              loadSourceMap(sourceMapURL, client.debugId(), initiator)
-                  .then(
-                      payload => {
-                        const sourceMap = this.#factory(sourceURL, sourceMapURL, payload, client);
-                        if (this.#clientData.get(client) === clientData) {
-                          clientData.sourceMap = sourceMap;
-                          this.#sourceMaps.set(sourceMap, client);
-                          this.dispatchEventToListeners(Events.SourceMapAttached, {client, sourceMap});
-                        }
-                        return sourceMap;
-                      },
-                      () => {
-                        if (this.#clientData.get(client) === clientData) {
-                          this.dispatchEventToListeners(Events.SourceMapFailedToAttach, {client});
-                        }
-                        return undefined;
-                      });
-        } else {
-          // Assume cancelAttachSourceMap was called.
-          if (this.#attachingClient) {
-            // This should not happen
-            console.error('Cancelling source map attach because another source map is attaching');
-          }
-          clientData = null;
-          this.dispatchEventToListeners(Events.SourceMapFailedToAttach, {client});
-        }
-      }
-    }
-    if (clientData) {
-      this.#clientData.set(client, clientData);
-    }
-  }
-
-  cancelAttachSourceMap(client: T): void {
-    if (client === this.#attachingClient) {
-      this.#attachingClient = null;
-      // This should not happen.
-    } else if (this.#attachingClient) {
-      console.error('cancel attach source map requested but a different source map was being attached');
-    } else {
-      console.error('cancel attach source map requested but no source map was being attached');
-    }
-  }
-
-  detachSourceMap(client: T): void {
-    const clientData = this.#clientData.get(client);
-    if (!clientData) {
-      return;
-    }
-    this.#clientData.delete(client);
-    if (!this.#isEnabled) {
-      return;
-    }
-    const {sourceMap} = clientData;
-    if (sourceMap) {
-      this.#sourceMaps.delete(sourceMap);
-      this.dispatchEventToListeners(Events.SourceMapDetached, {client, sourceMap});
-    } else {
-      this.dispatchEventToListeners(Events.SourceMapFailedToAttach, {client});
-    }
-  }
-
-  waitForSourceMapsProcessedForTest(): Promise<unknown> {
-    return Promise.all(this.#sourceMaps.keys().map(sourceMap => sourceMap.scopesFallbackPromiseForTest));
-  }
-}
-
-export async function loadSourceMap(
-    url: Platform.DevToolsPath.UrlString, debugId: DebugId|null,
-    initiator: PageResourceLoadInitiator): Promise<SourceMapV3> {
-  try {
-    if (debugId) {
-      const cachedSourceMap = await SourceMapCache.instance().get(debugId);
-      if (cachedSourceMap) {
-        return cachedSourceMap;
-      }
-    }
-
-    const {content} = await PageResourceLoader.instance().loadResource(url, initiator);
-    const sourceMap = parseSourceMap(content);
-    if ('debugId' in sourceMap && sourceMap.debugId) {
-      // In case something goes wrong with updating the cache, we still want to use the source map.
-      await SourceMapCache.instance().set(sourceMap.debugId as DebugId, sourceMap).catch();
-    }
-    return sourceMap;
-  } catch (cause) {
-    throw new Error(`Could not load content for ${url}: ${cause.message}`, {cause});
-  }
-}
-
-export async function tryLoadSourceMap(
-    url: Platform.DevToolsPath.UrlString, initiator: PageResourceLoadInitiator): Promise<SourceMapV3|null> {
-  try {
-    return await loadSourceMap(url, null, initiator);
-  } catch (cause) {
-    console.error(cause);
-    return null;
-  }
-}
-
-interface ClientData {
-  relativeSourceURL: Platform.DevToolsPath.UrlString;
-  // Stores the raw sourceMappingURL as provided by V8. These are not guaranteed to
-  // be valid URLs and will be checked and resolved once `attachSourceMap` is called.
-  relativeSourceMapURL: string;
-  sourceMap: SourceMap|undefined;
-  sourceMapPromise: Promise<SourceMap|undefined>;
-}
-
-export enum Events {
-  /* eslint-disable @typescript-eslint/naming-convention -- Used by web_tests. */
-  SourceMapWillAttach = 'SourceMapWillAttach',
-  SourceMapFailedToAttach = 'SourceMapFailedToAttach',
-  SourceMapAttached = 'SourceMapAttached',
-  SourceMapDetached = 'SourceMapDetached',
-  /* eslint-enable @typescript-eslint/naming-convention */
-}
-
-export interface EventTypes<T extends FrameAssociated> {
-  [Events.SourceMapWillAttach]: {client: T};
-  [Events.SourceMapFailedToAttach]: {client: T};
-  [Events.SourceMapAttached]: {client: T, sourceMap: SourceMap};
-  [Events.SourceMapDetached]: {client: T, sourceMap: SourceMap};
-}

package/lib/front_end/core/sdk/SourceMapScopeChainEntry.ts

@@ -1,189 +0,0 @@
-// Copyright 2024 The Chromium Authors
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-import * as Protocol from '../../generated/protocol.js';
-import type * as ScopesCodec from '../../third_party/source-map-scopes-codec/source-map-scopes-codec.js';
-import * as i18n from '../i18n/i18n.js';
-
-import type {CallFrame, LocationRange, ScopeChainEntry} from './DebuggerModel.js';
-import {type GetPropertiesResult, type RemoteObject, RemoteObjectImpl, RemoteObjectProperty} from './RemoteObject.js';
-import {contains} from './SourceMapScopesInfo.js';
-
-const UIStrings = {
-  /**
-   * @description Title of a section in the debugger showing local JavaScript variables.
-   */
-  local: 'Local',
-  /**
-   * @description Text that refers to closure as a programming term
-   */
-  closure: 'Closure',
-  /**
-   * @description Noun that represents a section or block of code in the Debugger Model. Shown in the Sources tab, while paused on a breakpoint.
-   */
-  block: 'Block',
-  /**
-   * @description Title of a section in the debugger showing JavaScript variables from the global scope.
-   */
-  global: 'Global',
-  /**
-   * @description Text in Scope Chain Sidebar Pane of the Sources panel
-   */
-  returnValue: 'Return value',
-} as const;
-const str_ = i18n.i18n.registerUIStrings('core/sdk/SourceMapScopeChainEntry.ts', UIStrings);
-const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
-
-export class SourceMapScopeChainEntry implements ScopeChainEntry {
-  readonly #callFrame: CallFrame;
-  readonly #scope: ScopesCodec.OriginalScope;
-  readonly #range?: ScopesCodec.GeneratedRange;
-  readonly #isInnerMostFunction: boolean;
-  readonly #returnValue?: RemoteObject;
-
-  /**
-   * @param isInnerMostFunction If `scope` is the innermost 'function' scope. Only used for labeling as we name the
-   * scope of the paused function 'Local', while other outer 'function' scopes are named 'Closure'.
-   */
-  constructor(
-      callFrame: CallFrame, scope: ScopesCodec.OriginalScope, range: ScopesCodec.GeneratedRange|undefined,
-      isInnerMostFunction: boolean, returnValue: RemoteObject|undefined) {
-    this.#callFrame = callFrame;
-    this.#scope = scope;
-    this.#range = range;
-    this.#isInnerMostFunction = isInnerMostFunction;
-    this.#returnValue = returnValue;
-  }
-
-  extraProperties(): RemoteObjectProperty[] {
-    if (this.#returnValue) {
-      return [new RemoteObjectProperty(
-          i18nString(UIStrings.returnValue), this.#returnValue, undefined, undefined, undefined, undefined, undefined,
-          /* synthetic */ true)];
-    }
-    return [];
-  }
-
-  callFrame(): CallFrame {
-    return this.#callFrame;
-  }
-
-  type(): string {
-    switch (this.#scope.kind) {
-      case 'global':
-        return Protocol.Debugger.ScopeType.Global;
-      case 'function':
-        return this.#isInnerMostFunction ? Protocol.Debugger.ScopeType.Local : Protocol.Debugger.ScopeType.Closure;
-      case 'block':
-        return Protocol.Debugger.ScopeType.Block;
-    }
-    return this.#scope.kind ?? '';
-  }
-
-  typeName(): string {
-    switch (this.#scope.kind) {
-      case 'global':
-        return i18nString(UIStrings.global);
-      case 'function':
-        return this.#isInnerMostFunction ? i18nString(UIStrings.local) : i18nString(UIStrings.closure);
-      case 'block':
-        return i18nString(UIStrings.block);
-    }
-    return this.#scope.kind ?? '';
-  }
-
-  name(): string|undefined {
-    return this.#scope.name;
-  }
-
-  range(): LocationRange|null {
-    return null;
-  }
-
-  object(): RemoteObject {
-    return new SourceMapScopeRemoteObject(this.#callFrame, this.#scope, this.#range);
-  }
-
-  description(): string {
-    return '';
-  }
-
-  icon(): string|undefined {
-    return undefined;
-  }
-}
-
-class SourceMapScopeRemoteObject extends RemoteObjectImpl {
-  readonly #callFrame: CallFrame;
-  readonly #scope: ScopesCodec.OriginalScope;
-  readonly #range?: ScopesCodec.GeneratedRange;
-
-  constructor(callFrame: CallFrame, scope: ScopesCodec.OriginalScope, range: ScopesCodec.GeneratedRange|undefined) {
-    super(
-        callFrame.debuggerModel.runtimeModel(), /* objectId */ undefined, 'object', /* sub type */ undefined,
-        /* value */ null);
-    this.#callFrame = callFrame;
-    this.#scope = scope;
-    this.#range = range;
-  }
-
-  override async doGetProperties(_ownProperties: boolean, accessorPropertiesOnly: boolean, generatePreview: boolean):
-      Promise<GetPropertiesResult> {
-    if (accessorPropertiesOnly) {
-      return {properties: [], internalProperties: []};
-    }
-
-    const properties: RemoteObjectProperty[] = [];
-    for (const [index, variable] of this.#scope.variables.entries()) {
-      const expression = this.#findExpression(index);
-      if (expression === null) {
-        properties.push(SourceMapScopeRemoteObject.#unavailableProperty(variable));
-        continue;
-      }
-
-      // TODO(crbug.com/40277685): Once we can evaluate expressions in scopes other than the innermost one,
-      //         we need to find the find the CDP scope that matches `this.#range` and evaluate in that.
-      const result = await this.#callFrame.evaluate({expression, generatePreview});
-      if ('error' in result || result.exceptionDetails) {
-        // TODO(crbug.com/40277685): Make these errors user-visible to aid tooling developers.
-        //         E.g. show the error on hover or expose it in the developer resources panel.
-        properties.push(SourceMapScopeRemoteObject.#unavailableProperty(variable));
-      } else {
-        properties.push(new RemoteObjectProperty(
-            variable, result.object, /* enumerable */ false, /* writable */ false, /* isOwn */ true,
-            /* wasThrown */ false));
-      }
-    }
-
-    return {properties, internalProperties: []};
-  }
-
-  /** @returns null if the variable is unavailable at the current paused location */
-  #findExpression(index: number): string|null {
-    if (!this.#range) {
-      return null;
-    }
-
-    const expressionOrSubRanges = this.#range.values[index];
-    if (typeof expressionOrSubRanges === 'string') {
-      return expressionOrSubRanges;
-    }
-    if (expressionOrSubRanges === null) {
-      return null;
-    }
-
-    const pausedPosition = this.#callFrame.location();
-    for (const range of expressionOrSubRanges) {
-      if (contains({start: range.from, end: range.to}, pausedPosition.lineNumber, pausedPosition.columnNumber)) {
-        return range.value ?? null;
-      }
-    }
-    return null;
-  }
-
-  static #unavailableProperty(name: string): RemoteObjectProperty {
-    return new RemoteObjectProperty(
-        name, null, /* enumerable */ false, /* writeable */ false, /* isOwn */ true, /* wasThrown */ false);
-  }
-}