chrome-devtools-frontend/front_end/models/ai_assistance/tools/RecordPerformanceTrace.ts

Chrome DevTools UI

// Copyright 2026 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 Host from '../../../core/host/host.js';
import * as i18n from '../../../core/i18n/i18n.js';
import {PerformanceTraceContext} from '../contexts/PerformanceTraceContext.js';
import type {AgentFocus} from '../performance/AIContext.js';

import {
  type BaseToolCapability,
  type ContextHandlerResult,
  type ContextTool,
  type PerformanceRecordingCapability,
  ToolName,
} from './Tool.js';

const UIStringsNotTranslate = {
  recordingPerformanceTrace: 'Recording a performance trace',
} as const;

const lockedString = i18n.i18n.lockedString;

export class RecordPerformanceTraceTool implements
    ContextTool<Record<string, never>, AgentFocus, BaseToolCapability&PerformanceRecordingCapability> {
  readonly name = ToolName.RECORD_PERFORMANCE_TRACE;
  readonly description = 'Records a new performance trace to measure, analyze, and debug page performance.';

  readonly parameters: Host.AidaClient.FunctionObjectParam<never> = {
    type: Host.AidaClient.ParametersTypes.OBJECT,
    description: 'Parameters for recording a performance trace.',
    nullable: false,
    properties: {},
    required: [],
  };

  displayInfoFromArgs(): {
    title: string,
    action: string,
  } {
    return {
      title: lockedString(UIStringsNotTranslate.recordingPerformanceTrace),
      action: 'recordPerformanceTrace()',
    };
  }

  async handler(_params: Record<string, never>, capabilities: BaseToolCapability&PerformanceRecordingCapability):
      Promise<ContextHandlerResult<AgentFocus>> {
    if (!capabilities.performanceRecordAndReload) {
      return {error: 'Performance recording is not available.'};
    }
    try {
      const result = await capabilities.performanceRecordAndReload();
      return {
        context: PerformanceTraceContext.fromParsedTrace(result),
        description: 'User recorded a performance trace',
        widgets: [{name: 'PERFORMANCE_TRACE', data: {parsedTrace: result}}],
      };
    } catch (err) {
      return {error: `Failed to record performance trace: ${err instanceof Error ? err.message : String(err)}`};
    }
  }
}