devtools-tracing 1.1.0 → 1.2.0

package/lib/front_end/core/protocol_client/NodeURL.ts

@@ -1,42 +0,0 @@
-// Copyright 2018 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 Host from '../host/host.js';
-import type * as Platform from '../platform/platform.js';
-
-export class NodeURL {
-  static patch(object: {
-    url?: string,
-  }): void {
-    process(object, '');
-
-    function process(object: {url?: string}, path: string): void {
-      if (object.url && NodeURL.isPlatformPath(object.url, Host.Platform.isWin())) {
-        // object.url can be of both types: RawPathString and UrlString
-        object.url = Common.ParsedURL.ParsedURL.rawPathToUrlString(object.url as Platform.DevToolsPath.RawPathString);
-      }
-      for (const entry of Object.entries(object)) {
-        const key = entry[0];
-        const value = entry[1];
-        const entryPath = path + '.' + key;
-        if (entryPath !== '.result.result.value' && value !== null && typeof value === 'object') {
-          process(
-              (value as {
-                url: string,
-              }),
-              entryPath);
-        }
-      }
-    }
-  }
-
-  static isPlatformPath(fileSystemPath: string, isWindows: boolean): boolean {
-    if (isWindows) {
-      const re = /^([a-z]:[\/\\]|\\\\)/i;
-      return re.test(fileSystemPath);
-    }
-    return fileSystemPath.length ? fileSystemPath[0] === '/' : false;
-  }
-}

package/lib/front_end/core/protocol_client/protocol_client.ts

@@ -1,13 +0,0 @@
-// Copyright 2019 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 ConnectionTransport from './ConnectionTransport.js';
-import * as InspectorBackend from './InspectorBackend.js';
-import * as NodeURL from './NodeURL.js';
-
-export {
-  ConnectionTransport,
-  InspectorBackend,
-  NodeURL,
-};

package/lib/front_end/core/root/Runtime.ts

@@ -1,609 +0,0 @@
-// Copyright 2020 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 Platform from '../platform/platform.js';
-
-let runtimePlatform = '';
-
-let runtimeInstance: Runtime|undefined;
-let isNode: boolean|undefined;
-let isTraceAppEntry: boolean|undefined;
-
-/**
- * Returns the base URL (similar to `<base>`).
- * Used to resolve the relative URLs of any additional DevTools files (locale strings, etc) needed.
- * See: https://cs.chromium.org/remoteBase+f:devtools_window
- */
-export function getRemoteBase(location: string = self.location.toString()): {
-  base: string,
-  version: string,
-}|null {
-  const url = new URL(location);
-  const remoteBase = url.searchParams.get('remoteBase');
-  if (!remoteBase) {
-    return null;
-  }
-
-  const version = /\/serve_file\/(@[0-9a-zA-Z]+)\/?$/.exec(remoteBase);
-  if (!version) {
-    return null;
-  }
-
-  return {base: `devtools://devtools/remote/serve_file/${version[1]}/`, version: version[1]};
-}
-
-export function getPathName(): string {
-  return window.location.pathname;
-}
-
-export function isNodeEntry(pathname: string): boolean {
-  const nodeEntryPoints = ['node_app', 'js_app'];
-  return nodeEntryPoints.some(component => pathname.includes(component));
-}
-
-export const getChromeVersion = (): string => {
-  const chromeRegex = /(?:^|\W)(?:Chrome|HeadlessChrome)\/(\S+)/;
-  const chromeMatch = navigator.userAgent.match(chromeRegex);
-  if (chromeMatch && chromeMatch.length > 1) {
-    return chromeMatch[1];
-  }
-  return '';
-};
-
-export class Runtime {
-  private constructor() {
-  }
-
-  static instance(opts: {
-    forceNew: boolean|null,
-  }|undefined = {forceNew: null}): Runtime {
-    const {forceNew} = opts;
-    if (!runtimeInstance || forceNew) {
-      runtimeInstance = new Runtime();
-    }
-
-    return runtimeInstance;
-  }
-
-  static removeInstance(): void {
-    runtimeInstance = undefined;
-  }
-
-  static queryParamsObject: URLSearchParams;
-
-  static getSearchParams(): URLSearchParams {
-    if (!Runtime.queryParamsObject) {
-      Runtime.queryParamsObject = new URLSearchParams(location.search);
-    }
-    return Runtime.queryParamsObject;
-  }
-
-  static queryParam(name: string): string|null {
-    return Runtime.getSearchParams().get(name);
-  }
-
-  static setQueryParamForTesting(name: string, value: string): void {
-    Runtime.getSearchParams().set(name, value);
-  }
-
-  static isNode(): boolean {
-    if (isNode === undefined) {
-      isNode = isNodeEntry(getPathName());
-    }
-    return isNode;
-  }
-
-  /**
-   * Returns true if viewing the slimmed-down devtools meant for just viewing a
-   * performance trace, e.g. devtools://devtools/bundled/trace_app.html?traceURL=http://...
-   */
-  static isTraceApp(): boolean {
-    if (isTraceAppEntry === undefined) {
-      isTraceAppEntry = getPathName().includes('trace_app');
-    }
-    return isTraceAppEntry;
-  }
-
-  static setPlatform(platform: string): void {
-    runtimePlatform = platform;
-  }
-
-  static platform(): string {
-    return runtimePlatform;
-  }
-
-  static isDescriptorEnabled(descriptor: {experiment?: string|null, condition?: Condition}): boolean {
-    const {experiment} = descriptor;
-    if (experiment === '*') {
-      return true;
-    }
-    if (experiment && experiment.startsWith('!') && experiments.isEnabled(experiment.substring(1))) {
-      return false;
-    }
-    if (experiment && !experiment.startsWith('!') && !experiments.isEnabled(experiment)) {
-      return false;
-    }
-    const {condition} = descriptor;
-    return condition ? condition(hostConfig) : true;
-  }
-
-  loadLegacyModule(modulePath: string): Promise<unknown> {
-    // eslint-disable-next-line no-console
-    console.log('Loading legacy module: ' + modulePath);
-    const importPath =
-        `../../${modulePath}`;  // Extracted as a variable so esbuild doesn't attempt to bundle all the things.
-    return import(importPath).then(m => {
-      // eslint-disable-next-line no-console
-      console.log('Loaded legacy module: ' + modulePath);
-      return m;
-    });
-  }
-}
-
-export interface Option {
-  title: string;
-  value: string|boolean;
-  raw?: boolean;
-  text?: string;
-}
-
-export class ExperimentsSupport {
-  #experiments: Experiment[] = [];
-  readonly #experimentNames = new Set<string>();
-  readonly #enabledTransiently = new Set<string>();
-  readonly #enabledByDefault = new Set<string>();
-  readonly #serverEnabled = new Set<string>();
-  readonly #storage = new ExperimentStorage();
-
-  allConfigurableExperiments(): Experiment[] {
-    const result = [];
-    for (const experiment of this.#experiments) {
-      if (!this.#enabledTransiently.has(experiment.name)) {
-        result.push(experiment);
-      }
-    }
-    return result;
-  }
-
-  register(
-      experimentName: string, experimentTitle: string, unstable?: boolean, docLink?: string,
-      feedbackLink?: string): void {
-    if (this.#experimentNames.has(experimentName)) {
-      throw new Error(`Duplicate registration of experiment '${experimentName}'`);
-    }
-    this.#experimentNames.add(experimentName);
-    this.#experiments.push(new Experiment(
-        this, experimentName, experimentTitle, Boolean(unstable),
-        docLink as Platform.DevToolsPath.UrlString ?? Platform.DevToolsPath.EmptyUrlString,
-        feedbackLink as Platform.DevToolsPath.UrlString ?? Platform.DevToolsPath.EmptyUrlString));
-  }
-
-  isEnabled(experimentName: string): boolean {
-    this.checkExperiment(experimentName);
-    // Check for explicitly disabled #experiments first - the code could call setEnable(false) on the experiment enabled
-    // by default and we should respect that.
-    if (this.#storage.get(experimentName) === false) {
-      return false;
-    }
-    if (this.#enabledTransiently.has(experimentName) || this.#enabledByDefault.has(experimentName)) {
-      return true;
-    }
-    if (this.#serverEnabled.has(experimentName)) {
-      return true;
-    }
-
-    return Boolean(this.#storage.get(experimentName));
-  }
-
-  setEnabled(experimentName: string, enabled: boolean): void {
-    this.checkExperiment(experimentName);
-    this.#storage.set(experimentName, enabled);
-  }
-
-  enableExperimentsTransiently(experimentNames: string[]): void {
-    for (const experimentName of experimentNames) {
-      this.checkExperiment(experimentName);
-      this.#enabledTransiently.add(experimentName);
-    }
-  }
-
-  enableExperimentsByDefault(experimentNames: string[]): void {
-    for (const experimentName of experimentNames) {
-      this.checkExperiment(experimentName);
-      this.#enabledByDefault.add(experimentName);
-    }
-  }
-
-  setServerEnabledExperiments(experimentNames: string[]): void {
-    for (const experiment of experimentNames) {
-      this.checkExperiment(experiment);
-      this.#serverEnabled.add(experiment);
-    }
-  }
-
-  enableForTest(experimentName: string): void {
-    this.checkExperiment(experimentName);
-    this.#enabledTransiently.add(experimentName);
-  }
-
-  disableForTest(experimentName: string): void {
-    this.checkExperiment(experimentName);
-    this.#enabledTransiently.delete(experimentName);
-  }
-
-  clearForTest(): void {
-    this.#experiments = [];
-    this.#experimentNames.clear();
-    this.#enabledTransiently.clear();
-    this.#enabledByDefault.clear();
-    this.#serverEnabled.clear();
-  }
-
-  cleanUpStaleExperiments(): void {
-    this.#storage.cleanUpStaleExperiments(this.#experimentNames);
-  }
-
-  private checkExperiment(experimentName: string): void {
-    if (!this.#experimentNames.has(experimentName)) {
-      throw new Error(`Unknown experiment '${experimentName}'`);
-    }
-  }
-}
-
-/** Manages the 'experiments' dictionary in self.localStorage */
-class ExperimentStorage {
-  readonly #experiments: Record<string, boolean|undefined> = {};
-
-  constructor() {
-    try {
-      const storedExperiments = self.localStorage?.getItem('experiments');
-      if (storedExperiments) {
-        this.#experiments = JSON.parse(storedExperiments);
-      }
-    } catch {
-      console.error('Failed to parse localStorage[\'experiments\']');
-    }
-  }
-
-  /**
-   * Experiments are stored with a tri-state:
-   *   - true: Explicitly enabled.
-   *   - false: Explicitly disabled.
-   *   - undefined: Disabled.
-   */
-  get(experimentName: string): boolean|undefined {
-    return this.#experiments[experimentName];
-  }
-
-  set(experimentName: string, enabled: boolean): void {
-    this.#experiments[experimentName] = enabled;
-    this.#syncToLocalStorage();
-  }
-
-  cleanUpStaleExperiments(validExperiments: Set<string>): void {
-    for (const [key] of Object.entries(this.#experiments)) {
-      if (!validExperiments.has(key)) {
-        delete this.#experiments[key];
-      }
-    }
-    this.#syncToLocalStorage();
-  }
-
-  #syncToLocalStorage(): void {
-    self.localStorage?.setItem('experiments', JSON.stringify(this.#experiments));
-  }
-}
-
-export class Experiment {
-  name: string;
-  title: string;
-  unstable: boolean;
-  docLink?: Platform.DevToolsPath.UrlString;
-  readonly feedbackLink?: Platform.DevToolsPath.UrlString;
-  readonly #experiments: ExperimentsSupport;
-  constructor(
-      experiments: ExperimentsSupport, name: string, title: string, unstable: boolean,
-      docLink: Platform.DevToolsPath.UrlString, feedbackLink: Platform.DevToolsPath.UrlString) {
-    this.name = name;
-    this.title = title;
-    this.unstable = unstable;
-    this.docLink = docLink;
-    this.feedbackLink = feedbackLink;
-    this.#experiments = experiments;
-  }
-
-  isEnabled(): boolean {
-    return this.#experiments.isEnabled(this.name);
-  }
-
-  setEnabled(enabled: boolean): void {
-    this.#experiments.setEnabled(this.name, enabled);
-  }
-}
-
-/** This must be constructed after the query parameters have been parsed. **/
-export const experiments = new ExperimentsSupport();
-
-/**
- * @deprecated Experiments should not be used anymore, instead use base::Feature.
- * See docs/contributing/settings-experiments-features.md
- */
-export const enum ExperimentName {
-  CAPTURE_NODE_CREATION_STACKS = 'capture-node-creation-stacks',
-  CSS_OVERVIEW = 'css-overview',
-  LIVE_HEAP_PROFILE = 'live-heap-profile',
-  ALL = '*',
-  PROTOCOL_MONITOR = 'protocol-monitor',
-  FULL_ACCESSIBILITY_TREE = 'full-accessibility-tree',
-  HEADER_OVERRIDES = 'header-overrides',
-  INSTRUMENTATION_BREAKPOINTS = 'instrumentation-breakpoints',
-  AUTHORED_DEPLOYED_GROUPING = 'authored-deployed-grouping',
-  JUST_MY_CODE = 'just-my-code',
-  USE_SOURCE_MAP_SCOPES = 'use-source-map-scopes',
-  TIMELINE_SHOW_POST_MESSAGE_EVENTS = 'timeline-show-postmessage-events',
-  TIMELINE_DEBUG_MODE = 'timeline-debug-mode',
-  // Adding or removing an entry from this enum?
-  // You will need to update:
-  // 1. REGISTERED_EXPERIMENTS in EnvironmentHelpers.ts (to create this experiment in the test env)
-  // 2. DevToolsExperiments enum in host/UserMetrics.ts
-}
-
-export enum GenAiEnterprisePolicyValue {
-  ALLOW = 0,
-  ALLOW_WITHOUT_LOGGING = 1,
-  DISABLE = 2,
-}
-
-export interface AidaAvailability {
-  enabled: boolean;
-  blockedByAge: boolean;
-  blockedByEnterprisePolicy: boolean;
-  blockedByGeo: boolean;
-  disallowLogging: boolean;
-  enterprisePolicyValue: number;
-}
-
-type Channel = 'stable'|'beta'|'dev'|'canary';
-
-export interface HostConfigConsoleInsights {
-  modelId: string;
-  temperature: number;
-  enabled: boolean;
-}
-
-export enum HostConfigFreestylerExecutionMode {
-  ALL_SCRIPTS = 'ALL_SCRIPTS',
-  SIDE_EFFECT_FREE_SCRIPTS_ONLY = 'SIDE_EFFECT_FREE_SCRIPTS_ONLY',
-  NO_SCRIPTS = 'NO_SCRIPTS',
-}
-
-export interface HostConfigFreestyler {
-  modelId: string;
-  temperature: number;
-  enabled: boolean;
-  userTier: string;
-  executionMode?: HostConfigFreestylerExecutionMode;
-  patching?: boolean;
-  multimodal?: boolean;
-  multimodalUploadInput?: boolean;
-  functionCalling?: boolean;
-  featureName?: string;
-}
-
-export interface HostConfigAiAssistanceNetworkAgent {
-  modelId: string;
-  temperature: number;
-  enabled: boolean;
-  userTier: string;
-  featureName?: string;
-}
-
-export interface HostConfigAiAssistancePerformanceAgent {
-  modelId: string;
-  temperature: number;
-  enabled: boolean;
-  userTier: string;
-  featureName?: string;
-}
-
-export interface HostConfigAiAssistanceFileAgent {
-  modelId: string;
-  temperature: number;
-  enabled: boolean;
-  userTier: string;
-  featureName?: string;
-}
-
-export interface HostConfigAiCodeCompletion {
-  modelId: string;
-  temperature: number;
-  enabled: boolean;
-  userTier: string;
-}
-
-export interface HostConfigDeepLinksViaExtensibilityApi {
-  enabled: boolean;
-}
-
-export interface HostConfigVeLogging {
-  enabled: boolean;
-  testing: boolean;
-}
-
-/**
- * @see https://goo.gle/devtools-json-design
- */
-export interface HostConfigWellKnown {
-  enabled: boolean;
-}
-
-export interface HostConfigPrivacyUI {
-  enabled: boolean;
-}
-
-export interface HostConfigEnableOriginBoundCookies {
-  portBindingEnabled: boolean;
-  schemeBindingEnabled: boolean;
-}
-
-export interface HostConfigAnimationStylesInStylesTab {
-  enabled: boolean;
-}
-
-export interface HostConfigThirdPartyCookieControls {
-  thirdPartyCookieRestrictionEnabled: boolean;
-  thirdPartyCookieMetadataEnabled: boolean;
-  thirdPartyCookieHeuristicsEnabled: boolean;
-  managedBlockThirdPartyCookies: string|boolean;
-}
-
-export interface HostConfigIPProtection {
-  enabled: boolean;
-}
-
-interface AiGeneratedTimelineLabels {
-  enabled: boolean;
-}
-
-interface AllowPopoverForcing {
-  enabled: boolean;
-}
-
-interface AiSubmenuPrompts {
-  enabled: boolean;
-  featureName?: string;
-}
-
-interface IpProtectionInDevTools {
-  enabled: boolean;
-}
-
-interface AiDebugWithAi {
-  enabled: boolean;
-  featureName?: string;
-}
-
-interface GlobalAiButton {
-  enabled: boolean;
-  promotionEnabled: boolean;
-}
-
-interface GdpProfiles {
-  enabled: boolean;
-  badgesEnabled: boolean;
-  starterBadgeEnabled: boolean;
-}
-
-export enum GdpProfilesEnterprisePolicyValue {
-  ENABLED = 0,
-  ENABLED_WITHOUT_BADGES = 1,
-  DISABLED = 2,
-}
-
-interface GdpProfilesAvailability {
-  // Whether GDP profiles can be enabled on this host (only possible on branded builds).
-  enabled: boolean;
-  enterprisePolicyValue: GdpProfilesEnterprisePolicyValue;
-}
-
-interface LiveEdit {
-  enabled: boolean;
-}
-
-interface DevToolsFlexibleLayout {
-  verticalDrawerEnabled: boolean;
-}
-
-interface DevToolsStartingStyleDebugging {
-  enabled: boolean;
-}
-
-interface AiPromptApi {
-  enabled: boolean;
-}
-
-interface DevToolsIndividualRequestThrottling {
-  enabled: boolean;
-}
-
-export interface DevToolsEnableDurableMessages {
-  enabled: boolean;
-}
-
-/**
- * The host configuration that we expect from the DevTools back-end.
- *
- * We use `RecursivePartial` here to enforce that DevTools code is able to
- * handle `HostConfig` objects of an unexpected shape. This can happen if
- * the implementation in the Chromium backend is changed without correctly
- * updating the DevTools frontend. Or if remote debugging a different version
- * of Chrome, resulting in the local browser window and the local DevTools
- * window being of different versions, and consequently potentially having
- * differently shaped `HostConfig`s.
- *
- * @see hostConfig
- */
-export type HostConfig = Platform.TypeScriptUtilities.RecursivePartial<{
-  aidaAvailability: AidaAvailability,
-  channel: Channel,
-  devToolsConsoleInsights: HostConfigConsoleInsights,
-  devToolsDeepLinksViaExtensibilityApi: HostConfigDeepLinksViaExtensibilityApi,
-  devToolsFreestyler: HostConfigFreestyler,
-  devToolsAiAssistanceNetworkAgent: HostConfigAiAssistanceNetworkAgent,
-  devToolsAiDebugWithAi: AiDebugWithAi,
-  devToolsAiAssistanceFileAgent: HostConfigAiAssistanceFileAgent,
-  devToolsAiAssistancePerformanceAgent: HostConfigAiAssistancePerformanceAgent,
-  devToolsAiCodeCompletion: HostConfigAiCodeCompletion,
-  devToolsVeLogging: HostConfigVeLogging,
-  devToolsWellKnown: HostConfigWellKnown,
-  devToolsPrivacyUI: HostConfigPrivacyUI,
-  devToolsIndividualRequestThrottling: DevToolsIndividualRequestThrottling,
-  devToolsIpProtectionPanelInDevTools: HostConfigIPProtection,
-  /**
-   * OffTheRecord here indicates that the user's profile is either incognito,
-   * or guest mode, rather than a "normal" profile.
-   */
-  isOffTheRecord: boolean,
-  devToolsEnableOriginBoundCookies: HostConfigEnableOriginBoundCookies,
-  devToolsAnimationStylesInStylesTab: HostConfigAnimationStylesInStylesTab,
-  thirdPartyCookieControls: HostConfigThirdPartyCookieControls,
-  devToolsAiGeneratedTimelineLabels: AiGeneratedTimelineLabels,
-  devToolsAllowPopoverForcing: AllowPopoverForcing,
-  devToolsAiSubmenuPrompts: AiSubmenuPrompts,
-  devToolsIpProtectionInDevTools: IpProtectionInDevTools,
-  devToolsGlobalAiButton: GlobalAiButton,
-  devToolsGdpProfiles: GdpProfiles,
-  devToolsGdpProfilesAvailability: GdpProfilesAvailability,
-  devToolsLiveEdit: LiveEdit,
-  devToolsFlexibleLayout: DevToolsFlexibleLayout,
-  devToolsStartingStyleDebugging: DevToolsStartingStyleDebugging,
-  devToolsAiPromptApi: AiPromptApi,
-  devToolsEnableDurableMessages: DevToolsEnableDurableMessages,
-}>;
-
-/**
- * The host configuration for this DevTools instance.
- *
- * This is initialized early during app startup and should not be modified
- * afterwards. In some cases it can be necessary to re-request the host
- * configuration from Chrome while DevTools is already running. In these
- * cases, the new host configuration should be reflected here, e.g.:
- *
- * ```js
- * const config = await new Promise<Root.Runtime.HostConfig>(
- *   resolve => InspectorFrontendHostInstance.getHostConfig(resolve));
- * Object.assign(Root.runtime.hostConfig, config);
- * ```
- */
-export const hostConfig: Platform.TypeScriptUtilities.RecursiveReadonly<HostConfig> = Object.create(null);
-
-/**
- * When defining conditions make sure that objects used by the function have
- * been instantiated.
- */
-export type Condition = (config?: HostConfig) => boolean;
-
-export const conditions = {
-  canDock: () => Boolean(Runtime.queryParam('can_dock')),
-};

package/lib/front_end/core/root/root.ts

@@ -1,6 +0,0 @@
-// Copyright 2020 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 Runtime from './Runtime.js';
-
-export {Runtime};