chrome-devtools-frontend/front_end/panels/ai_assistance/AiAssistancePanel.ts

Chrome DevTools UI

// 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 '../../ui/kit/kit.js';

import * as Common from '../../core/common/common.js';
import * as Host from '../../core/host/host.js';
import * as i18n from '../../core/i18n/i18n.js';
import * as Platform from '../../core/platform/platform.js';
import * as Root from '../../core/root/root.js';
import * as SDK from '../../core/sdk/sdk.js';
import * as AiAssistanceModel from '../../models/ai_assistance/ai_assistance.js';
import * as Annotations from '../../models/annotations/annotations.js';
import * as Badges from '../../models/badges/badges.js';
import * as Greendev from '../../models/greendev/greendev.js';
import type * as LHModel from '../../models/lighthouse/lighthouse.js';
import type * as Trace from '../../models/trace/trace.js';
import * as Workspace from '../../models/workspace/workspace.js';
import * as Buttons from '../../ui/components/buttons/buttons.js';
import * as Snackbars from '../../ui/components/snackbars/snackbars.js';
import * as UIHelpers from '../../ui/helpers/helpers.js';
import * as UI from '../../ui/legacy/legacy.js';
import * as Lit from '../../ui/lit/lit.js';
import * as VisualLogging from '../../ui/visual_logging/visual_logging.js';
import * as LighthousePanel from '../lighthouse/lighthouse.js';
import * as NetworkForward from '../network/forward/forward.js';
import * as NetworkPanel from '../network/network.js';
import * as TimelinePanel from '../timeline/timeline.js';

import aiAssistancePanelStyles from './aiAssistancePanel.css.js';
import {AccessibilityAgentMarkdownRenderer} from './components/AccessibilityAgentMarkdownRenderer.js';
import {
  type AnswerPart,
  ChatMessageEntity,
  type Message,
  type ModelChatMessage,
  type Step,
} from './components/ChatMessage.js';
import {
  ChatView,
  type Props as ChatViewProps,
} from './components/ChatView.js';
import {DisabledWidget} from './components/DisabledWidget.js';
import {ExploreWidget} from './components/ExploreWidget.js';
import {MarkdownRendererWithCodeBlock} from './components/MarkdownRendererWithCodeBlock.js';
import {OptInChangeDialog} from './components/OptInChangeDialog.js';
import {PerformanceAgentMarkdownRenderer} from './components/PerformanceAgentMarkdownRenderer.js';
import {StylingAgentMarkdownRenderer} from './components/StylingAgentMarkdownRenderer.js';
import {
  WalkthroughView,
} from './components/WalkthroughView.js';
import {saveToDisk} from './ExportConversation.js';
import {isAiAssistancePatchingEnabled} from './PatchWidget.js';

const {html} = Lit;
const {widget} = UI.Widget;

const AI_ASSISTANCE_SEND_FEEDBACK = 'https://crbug.com/364805393' as Platform.DevToolsPath.UrlString;
const AI_ASSISTANCE_HELP =
    'https://developer.chrome.com/docs/devtools/ai-assistance' as Platform.DevToolsPath.UrlString;
const WALKTHROUGH_SIDEBAR_BREAKPOINT = 700;
const WALKTHROUGH_SIDEBAR_INITIAL_WIDTH = 400;

const UIStrings = {
  /**
   * @description AI assistance UI text creating a new chat.
   */
  newChat: 'New chat',
  /**
   * @description AI assistance UI tooltip text for the help button.
   */
  help: 'Help',
  /**
   * @description AI assistant UI tooltip text for the settings button (gear icon).
   */
  settings: 'Settings',
  /**
   * @description AI assistant UI tooltip sending feedback.
   */
  sendFeedback: 'Send feedback',
  /**
   * @description Announcement text for screen readers when a new chat is created.
   */
  newChatCreated: 'New chat created',
  /**
   * @description Announcement text for screen readers when the chat is deleted.
   */
  chatDeleted: 'Chat deleted',
  /**
   * @description AI assistance UI text creating selecting a history entry.
   */
  history: 'History',
  /**
   * @description AI assistance UI text deleting the current chat session from local history.
   */
  deleteChat: 'Delete local chat',
  /**
   * @description AI assistance UI text that deletes all local history entries.
   */
  clearChatHistory: 'Clear local chats',
  /**
   *@description AI assistance UI text for the export conversation button.
   */
  exportConversation: 'Export conversation',
  /**
   * @description AI assistance UI text explains that he user had no pas conversations.
   */
  noPastConversations: 'No past conversations',
  /**
   * @description Placeholder text for an inactive text field. When active, it's used for the user's input to the GenAI assistance.
   */
  followTheSteps: 'Follow the steps above to ask a question',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForEmptyState: 'This is an experimental AI feature and won\'t always get it right.',
  /**
   * @description The message shown in a toast when the response is copied to the clipboard.
   */
  responseCopiedToClipboard: 'Response copied to clipboard',
} as const;

/*
* Strings that don't need to be translated at this time.
*/
const UIStringsNotTranslate = {
  /**
   * @description Announcement text for screen readers when the conversation starts.
   */
  answerLoading: 'Answer loading',
  /**
   * @description Announcement text for screen readers when the answer comes.
   */
  answerReady: 'Answer ready',
  /**
   * @description Title for the first step of the walkthrough.
   */
  analyzingData: 'Analyzing data',
  /**
   * @description Placeholder text for the input shown when the conversation is blocked because a cross-origin context was selected.
   */
  crossOriginError: 'To talk about data from another origin, start a new chat',
  /**
   * @description Placeholder text for the chat UI input.
   */
  inputPlaceholderForStyling: 'Ask a question about the selected element',
  /**
   * @description Placeholder text for the chat UI input.
   */
  inputPlaceholderForNetwork: 'Ask a question about the selected network request',
  /**
   * @description Placeholder text for the chat UI input.
   */
  inputPlaceholderForFile: 'Ask a question about the selected file',
  /**
   * @description Placeholder text for the chat UI input.
   */
  inputPlaceholderForPerformanceWithNoRecording: 'Record a performance trace and select an item to ask a question',
  /**
   * @description Placeholder text for the chat UI input when there is no context selected.
   */
  inputPlaceholderForStylingNoContext: 'Select an element to ask a question',
  /**
   * @description Placeholder text for the chat UI input when there is no context selected.
   */
  inputPlaceholderForNetworkNoContext: 'Select a network request to ask a question',
  /**
   * @description Placeholder text for the chat UI input when there is no context selected.
   */
  inputPlaceholderForFileNoContext: 'Select a file to ask a question',
  /**
   * @description Placeholder text for the chat UI input.
   */
  inputPlaceholderForPerformanceTrace: 'Ask a question about the selected performance trace',
  /**
   *@description Placeholder text for the chat UI input.
   */
  inputPlaceholderForPerformanceTraceNoContext: 'Record or select a performance trace to ask a question',
  /**
   *@description Placeholder text for the chat UI input.
   */
  inputPlaceholderForNoContext: 'Ask AI Assistance',
  /**
   * @description Placeholder text for the chat UI input with branding Gemini (do not translate)
   */
  inputPlaceholderForNoContextBranded: 'Ask Gemini',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForStyling:
      'Chat messages and any data the inspected page can access via Web APIs are sent to Google and may be seen by human reviewers to improve this feature. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForStylingEnterpriseNoLogging:
      'Chat messages and any data the inspected page can access via Web APIs are sent to Google. The content you submit and that is generated by this feature will not be used to improve Google’s AI models. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForNetwork:
      'Chat messages and the selected network request are sent to Google and may be seen by human reviewers to improve this feature. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForNetworkEnterpriseNoLogging:
      'Chat messages and the selected network request are sent to Google. The content you submit and that is generated by this feature will not be used to improve Google’s AI models. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForFile:
      'Chat messages and the selected file are sent to Google and may be seen by human reviewers to improve this feature. This is an experimental AI feature and won\'t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForFileEnterpriseNoLogging:
      'Chat messages and the selected file are sent to Google. The content you submit and that is generated by this feature will not be used to improve Google’s AI models. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForPerformance:
      'Chat messages and trace data from your performance trace are sent to Google and may be seen by human reviewers to improve this feature. This is an experimental AI feature and won\'t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForPerformanceEnterpriseNoLogging:
      'Chat messages and data from your performance trace are sent to Google. The content you submit and that is generated by this feature will not be used to improve Google’s AI models. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForNoContext:
      'Chat messages, any data the inspected page can see using Web APIs, and the items you select such as files, network requests, and performance traces are sent to Google and may be seen by human reviewers to improve this feature. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForNoContextEnterpriseNoLogging:
      'Chat messages, any data the inspected page can see using Web APIs, and the items you select such as files, network requests, and performance traces are sent to Google. This data will not be used to improve Google’s AI models. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Placeholder text for the chat UI input.
   */
  inputPlaceholderForAccessibility: 'Ask a question about the selected Lighthouse report',
  /**
   * @description Placeholder text for the chat UI input when there is no context selected.
   */
  inputPlaceholderForAccessibilityNoContext: 'Generate a Lighthouse report to ask a question',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForAccessibility:
      'Chat messages and the selected Lighthouse report are sent to Google and may be seen by human reviewers to improve this feature. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input.
   */
  inputDisclaimerForAccessibilityEnterpriseNoLogging:
      'Chat messages and the selected Lighthouse report are sent to Google. The content you submit and that is generated by this feature will not be used to improve Google’s AI models. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input when V2 is enabled.
   */
  inputDisclaimerV2:
      'Chat messages, data accessible for this site via DevTools panels and Web APIs, and items you select such as network requests, files, and performance traces are sent to Google and may be seen by human reviewers to improve this feature. This is an experimental AI feature and won’t always get it right.',
  /**
   * @description Disclaimer text right after the chat input when V2 is enabled and enterprise logging is off.
   */
  inputDisclaimerEnterpriseNoLoggingV2:
      'Chat messages, data accessible for this site via DevTools panels and Web APIs, and items you select such as network requests, files, and performance traces are sent to Google. The content submitted to and generated by this feature will not be used to improve Google’s AI models. This is an experimental AI feature and won’t always get it right.',
} as const;

const str_ = i18n.i18n.registerUIStrings('panels/ai_assistance/AiAssistancePanel.ts', UIStrings);
const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
const lockedString = i18n.i18n.lockedString;

function selectedElementFilter(maybeNode: SDK.DOMModel.DOMNode|null): SDK.DOMModel.DOMNode|null {
  if (maybeNode) {
    if (Greendev.Prototypes.instance().isEnabled('emulationCapabilities')) {
      return maybeNode;
    }

    return maybeNode.nodeType() === Node.ELEMENT_NODE ? maybeNode : null;
  }

  return null;
}

async function getEmptyStateSuggestions(conversation?: AiAssistanceModel.AiConversation.AiConversation):
    Promise<AiAssistanceModel.AiAgent.ConversationSuggestion[]> {
  const context = conversation?.selectedContext;

  if (context) {
    const specialSuggestions = await context.getSuggestions();

    if (specialSuggestions) {
      return specialSuggestions;
    }
  }

  if (!conversation?.type || conversation.isReadOnly) {
    return [];
  }

  switch (conversation.type) {
    case AiAssistanceModel.AiHistoryStorage.ConversationType.STYLING:
      return [
        {title: 'What can you help me with?', jslogContext: 'styling-default'},
        {title: 'Why isn’t this element visible?', jslogContext: 'styling-default'},
        {
          title: Greendev.Prototypes.instance().isEnabled('emulationCapabilities') ?
              'Are there display issues on this page for people using an Android phone?' :
              'How do I center this element?',
          jslogContext: 'styling-default'
        },
      ];
    case AiAssistanceModel.AiHistoryStorage.ConversationType.FILE:
      return [
        {title: 'What does this script do?', jslogContext: 'file-default'},
        {title: 'Is the script optimized for performance?', jslogContext: 'file-default'},
        {title: 'Does the script handle user input safely?', jslogContext: 'file-default'},
      ];
    case AiAssistanceModel.AiHistoryStorage.ConversationType.ACCESSIBILITY:
      return [
        {title: 'How can I fix accessibility issues on my page?', jslogContext: 'accessibility-default'},
        {title: 'What accessibility issues exist on my page?', jslogContext: 'accessibility-default'},
      ];
    case AiAssistanceModel.AiHistoryStorage.ConversationType.NETWORK:

      return [
        {title: 'Why is this network request taking so long?', jslogContext: 'network-default'},
        {title: 'Are there any security headers present?', jslogContext: 'network-default'},
        {title: 'Why is the request failing?', jslogContext: 'network-default'},
      ];
    case AiAssistanceModel.AiHistoryStorage.ConversationType.PERFORMANCE: {
      return [
        {title: 'What performance issues exist with my page?', jslogContext: 'performance-default'},
      ];
    }
    case AiAssistanceModel.AiHistoryStorage.ConversationType.BREAKPOINT: {
      return [
        {title: 'Why did the code pause here?'},
        {title: 'What function does this breakpoint belong to?'},
        {title: 'Why is this error thrown?'},
      ];
    }

    case AiAssistanceModel.AiHistoryStorage.ConversationType.NONE: {
      return [
        {title: 'What can you help me with?', jslogContext: 'empty'},
        {title: 'What performance issues exist on the page?', jslogContext: 'empty'},
        {title: 'What are the slowest network requests on this page?', jslogContext: 'empty'},
      ];
    }

    case AiAssistanceModel.AiHistoryStorage.ConversationType.STORAGE: {
      return [
        {title: 'How is localStorage used on this page?', jslogContext: 'storage-default'},
        {title: 'How is sessionStorage used on this page?', jslogContext: 'storage-default'},
      ];
    }

    default:
      Platform.assertNever(conversation.type, 'Unknown conversation type');
  }
}

function getMarkdownRenderer(conversation?: AiAssistanceModel.AiConversation.AiConversation):
    MarkdownRendererWithCodeBlock {
  const context = conversation?.selectedContext;

  if (context instanceof AiAssistanceModel.PerformanceAgent.PerformanceTraceContext) {
    if (!context.external) {
      const focus = context.getItem();
      return new PerformanceAgentMarkdownRenderer(
          focus.parsedTrace.data.Meta.mainFrameId, focus.lookupEvent.bind(focus));
    }
  } else if (conversation?.type === AiAssistanceModel.AiHistoryStorage.ConversationType.PERFORMANCE) {
    // Handle historical conversations (can't linkify anything).
    return new PerformanceAgentMarkdownRenderer();
  } else if (
      Greendev.Prototypes.instance().isEnabled('emulationCapabilities') &&
      conversation?.type === AiAssistanceModel.AiHistoryStorage.ConversationType.STYLING &&
      SDK.TargetManager.TargetManager.instance().primaryPageTarget()?.model(SDK.DOMModel.DOMModel)) {
    const domModel = SDK.TargetManager.TargetManager.instance().primaryPageTarget()?.model(SDK.DOMModel.DOMModel);
    const resourceTreeModel = domModel?.target().model(SDK.ResourceTreeModel.ResourceTreeModel);
    const mainFrameId = resourceTreeModel?.mainFrame?.id;
    return new StylingAgentMarkdownRenderer(mainFrameId);
  } else if (conversation?.type === AiAssistanceModel.AiHistoryStorage.ConversationType.ACCESSIBILITY) {
    const domModel = SDK.TargetManager.TargetManager.instance().primaryPageTarget()?.model(SDK.DOMModel.DOMModel);
    const resourceTreeModel = domModel?.target().model(SDK.ResourceTreeModel.ResourceTreeModel);
    const mainFrameId = resourceTreeModel?.mainFrame?.id;
    return new AccessibilityAgentMarkdownRenderer(mainFrameId);
  }

  return new MarkdownRendererWithCodeBlock();
}

interface ToolbarViewInput {
  onNewChatClick: () => void;
  populateHistoryMenu: (contextMenu: UI.ContextMenu.ContextMenu) => void;
  onDeleteClick: () => void;
  onExportConversationClick: () => void;
  onHelpClick: () => void;
  onSettingsClick: () => void;

  showChatActions: boolean;
  showActiveConversationActions: boolean;
  isLoading: boolean;
}

export const enum ViewState {
  DISABLED_VIEW = 'disabled-view',
  CHAT_VIEW = 'chat-view',
  EXPLORE_VIEW = 'explore-view'
}

type PanelViewInput = {
  state: ViewState.CHAT_VIEW,
  props: ChatViewProps,
}|{
  state: ViewState.DISABLED_VIEW,
  props: {aidaAvailability: Host.AidaClient.AidaAccessPreconditions},
}|{
  state: ViewState.EXPLORE_VIEW,
};

export type ViewInput = ToolbarViewInput&PanelViewInput;
export interface PanelViewOutput {
  chatView?: ChatView;
}

type View = (input: ViewInput, output: PanelViewOutput, target: HTMLElement) => void;

function toolbarView(input: ToolbarViewInput): Lit.LitTemplate {
  const hasAiV2 = Boolean(Root.Runtime.hostConfig.devToolsAiAssistanceV2?.enabled);
  // clang-format off
  return html`
    <div class="toolbar-container" role="toolbar" jslog=${VisualLogging.toolbar()}>
      <devtools-toolbar class="freestyler-left-toolbar" role="presentation">
      ${input.showChatActions
        ? html`<devtools-button
          title=${i18nString(UIStrings.newChat)}
          aria-label=${i18nString(UIStrings.newChat)}
          .iconName=${'plus'}
          .jslogContext=${'freestyler.new-chat'}
          .variant=${Buttons.Button.Variant.TOOLBAR}
          @click=${input.onNewChatClick}></devtools-button>
        <div class="toolbar-divider"></div>
        <devtools-menu-button
          title=${i18nString(UIStrings.history)}
          aria-label=${i18nString(UIStrings.history)}
          .iconName=${'history'}
          .jslogContext=${'freestyler.history'}
          .populateMenuCall=${input.populateHistoryMenu}
        ></devtools-menu-button>`
          : Lit.nothing}
        ${input.showActiveConversationActions ? html`
          <devtools-button
              title=${i18nString(UIStrings.deleteChat)}
              aria-label=${i18nString(UIStrings.deleteChat)}
              .iconName=${'bin'}
              .jslogContext=${'freestyler.delete'}
              .variant=${Buttons.Button.Variant.TOOLBAR}
              @click=${input.onDeleteClick}>
          </devtools-button>
          ${hasAiV2 ? Lit.nothing : html`
            <devtools-button
              title=${i18nString(UIStrings.exportConversation)}
              aria-label=${i18nString(UIStrings.exportConversation)}
              .iconName=${'download'}
              .disabled=${input.isLoading}
              .jslogContext=${'export-ai-conversation'}
              .variant=${Buttons.Button.Variant.TOOLBAR}
              @click=${input.onExportConversationClick}>
            </devtools-button>
            `
          }` : Lit.nothing}
      </devtools-toolbar>
      <devtools-toolbar class="freestyler-right-toolbar" role="presentation">
        <devtools-link
          class="toolbar-feedback-link"
          title=${i18nString(UIStrings.sendFeedback)}
          href=${AI_ASSISTANCE_SEND_FEEDBACK}
          jslogcontext=${'freestyler.send-feedback'}
        >${i18nString(UIStrings.sendFeedback)}</devtools-link>
        <div class="toolbar-divider"></div>
        <devtools-button
          title=${i18nString(UIStrings.help)}
          aria-label=${i18nString(UIStrings.help)}
          .iconName=${'help'}
          .jslogContext=${'freestyler.help'}
          .variant=${Buttons.Button.Variant.TOOLBAR}
          @click=${input.onHelpClick}></devtools-button>
        <devtools-button
          title=${i18nString(UIStrings.settings)}
          aria-label=${i18nString(UIStrings.settings)}
          .iconName=${'gear'}
          .jslogContext=${'freestyler.settings'}
          .variant=${Buttons.Button.Variant.TOOLBAR}
          @click=${input.onSettingsClick}></devtools-button>
      </devtools-toolbar>
    </div>
  `;
  // clang-format on
}

function defaultView(input: ViewInput, output: PanelViewOutput, target: HTMLElement): void {
  // clang-format off
  function renderState(): Lit.TemplateResult {
    switch (input.state) {
      case ViewState.CHAT_VIEW: {
        return html`<devtools-ai-chat-view
          .props=${input.props}
          ${Lit.Directives.ref(el => {
            if (!el || !(el instanceof ChatView)) {
              return;
            }

            output.chatView = el;
          })}
        ></devtools-ai-chat-view>`;
      }
      case ViewState.EXPLORE_VIEW:
        return html`<devtools-widget class="fill-panel" ${widget(ExploreWidget)}>
                    </devtools-widget>`;

      case ViewState.DISABLED_VIEW:
        return html`<devtools-widget class="fill-panel" ${widget(DisabledWidget, input.props)}>
                    </devtools-widget>`;
    }
  }

  if (Root.Runtime.hostConfig.devToolsAiAssistanceV2?.enabled ||
    Greendev.Prototypes.instance().isEnabled('breakpointDebuggerAgent')) {

    const shouldShowWalkthrough = input.state === ViewState.CHAT_VIEW && input.props.walkthrough.isExpanded;
    /**
     * We want to mark the walkthrough as loading only if it's showing the last
     * message. Otherwise, a previous walkthrough will show as loading if we
     * rely only on the isLoading flag.
     */
    let walkthroughIsForLastMessage = false;
    if(input.state === ViewState.CHAT_VIEW) {
      const lastMessage = input.props.messages.at(-1);
      if(lastMessage && input.props.walkthrough.activeSidebarMessage?.id === lastMessage.id) {
        walkthroughIsForLastMessage = true;
      }
    }

    Lit.render(html`
      ${toolbarView(input)}
      <div class="ai-assistance-view-container">
        <devtools-split-view
          name="ai-assistance-split-view-state"
          direction="column"
          sidebar-position="second"
          sidebar-visibility=${shouldShowWalkthrough && !input.props.walkthrough.isInlined ? 'visible' : 'hidden'}
          sidebar-initial-size=${WALKTHROUGH_SIDEBAR_INITIAL_WIDTH}
        >
          <div slot="main" class="main-view">
            ${renderState()}
          </div>
          ${shouldShowWalkthrough ? html`
            <devtools-widget slot="sidebar" ${widget(WalkthroughView, {
              message: input.props.walkthrough.activeSidebarMessage,
              isLoading: input.props.isLoading && walkthroughIsForLastMessage,
              markdownRenderer: input.props.markdownRenderer,
              onToggle: input.props.walkthrough.onToggle,
            })}></devtools-widget>` : Lit.nothing}
        </devtools-split-view>
      </div>
    `, target);
  } else {
    Lit.render(html`
      ${toolbarView(input)}
      <div class="ai-assistance-view-container">${renderState()}</div>
    `, target);
  }
  // clang-format on
}

function createNodeContext(node: SDK.DOMModel.DOMNode|null): AiAssistanceModel.StylingAgent.NodeContext|null {
  if (!node) {
    return null;
  }
  return new AiAssistanceModel.StylingAgent.NodeContext(node);
}

function createFileContext(file: Workspace.UISourceCode.UISourceCode|null): AiAssistanceModel.FileAgent.FileContext|
    null {
  if (!file) {
    return null;
  }
  return new AiAssistanceModel.FileAgent.FileContext(file);
}

function createBreakpointContext(uiLocation: Workspace.UISourceCode.UILocation|null):
    AiAssistanceModel.BreakpointDebuggerAgent.BreakpointContext|null {
  if (!uiLocation) {
    return null;
  }
  return new AiAssistanceModel.BreakpointDebuggerAgent.BreakpointContext(uiLocation);
}

function createAccessibilityContext(report: LighthousePanel.LighthousePanel.ActiveLighthouseReport|null):
    AiAssistanceModel.AccessibilityAgent.AccessibilityContext|null {
  if (!report) {
    return null;
  }
  return new AiAssistanceModel.AccessibilityAgent.AccessibilityContext(report.report);
}

function createRequestContext(request: SDK.NetworkRequest.NetworkRequest|null):
    AiAssistanceModel.NetworkAgent.RequestContext|null {
  if (!request) {
    return null;
  }
  const calculator = NetworkPanel.NetworkPanel.NetworkPanel.instance().networkLogView.timeCalculator();
  return new AiAssistanceModel.NetworkAgent.RequestContext(request, calculator);
}

function createPerformanceTraceContext(focus: AiAssistanceModel.AIContext.AgentFocus|null):
    AiAssistanceModel.PerformanceAgent.PerformanceTraceContext|null {
  if (!focus) {
    return null;
  }
  return new AiAssistanceModel.PerformanceAgent.PerformanceTraceContext(focus);
}

function createStorageContext(item: AiAssistanceModel.StorageItem.StorageItem|null):
    AiAssistanceModel.StorageAgent.StorageContext|null {
  if (!item) {
    return null;
  }
  return new AiAssistanceModel.StorageAgent.StorageContext(item);
}

/**
 * State relating to the visibility of the Walkthrough.
 *
 * We track both an `activeSidebarMessage` and a list of `inlineExpandedMessages` because:
 * 1. In Narrow (inline) mode, multiple walkthroughs can be expanded at once,
 *    so we need to track them all to render them correctly in the chat.
 * 2. In Wide (sidebar) mode, only one walkthrough can be visible at a time.
 *    The `activeSidebarMessage` tracks which one is shown in the sidebar.
 * 3. When transitioning from Narrow to Wide, we use the last message in
 *    `inlineExpandedMessages` to determine which one should stay expanded
 *    in the sidebar.
 */
interface WalkthroughState {
  /**
   * Whether to show the walkthrough inline (done at narrow widths) or in a side panel.
   */
  isInlined: boolean;
  /**
   * If the walkthrough UI is currently visible (either in the sidebar, or inlined)
   */
  isExpanded: boolean;
  /**
   * The message that the walkthrough is showing all the steps for. In Wide mode,
   * this is the message shown in the sidebar. In Narrow mode, it tracks the
   * most recently interacted message.
   */
  activeSidebarMessage: ModelChatMessage|null;
  /**
   * Tracks which messages are expanded in inline mode.
   */
  inlineExpandedMessages: ModelChatMessage[];
}

let panelInstance: AiAssistancePanel;
export class AiAssistancePanel extends UI.Panel.Panel {
  static panelName = 'freestyler';

  // NodeJS debugging does not have Elements panel, thus this action might not exist.
  #toggleSearchElementAction?: UI.ActionRegistration.Action;
  #aidaClient: Host.AidaClient.AidaClient;
  #conversationSummaryAgent?: AiAssistanceModel.ConversationSummaryAgent.ConversationSummaryAgent;
  #viewOutput: PanelViewOutput = {};
  #serverSideLoggingEnabled = isAiAssistanceServerSideLoggingEnabled();
  #aiAssistanceEnabledSetting: Common.Settings.Setting<boolean>|undefined;
  #changeManager = new AiAssistanceModel.ChangeManager.ChangeManager();
  #mutex = new Common.Mutex.Mutex();

  #conversation?: AiAssistanceModel.AiConversation.AiConversation;

  #selectedFile: AiAssistanceModel.FileAgent.FileContext|null = null;
  #selectedElement: AiAssistanceModel.StylingAgent.NodeContext|null = null;
  #selectedPerformanceTrace: AiAssistanceModel.PerformanceAgent.PerformanceTraceContext|null = null;
  #selectedRequest: AiAssistanceModel.NetworkAgent.RequestContext|null = null;
  #selectedBreakpoint: AiAssistanceModel.BreakpointDebuggerAgent.BreakpointContext|null = null;
  #selectedAccessibility: AiAssistanceModel.AccessibilityAgent.AccessibilityContext|null = null;
  #selectedStorage: AiAssistanceModel.StorageAgent.StorageContext|null = null;

  // Messages displayed in the `ChatView` component.

  #messages: Message[] = [];

  // Whether the UI should show loading or not.
  #isLoading = false;
  // Stores the availability status of the `AidaClient` and the reason for unavailability, if any.
  #aidaAvailability: Host.AidaClient.AidaAccessPreconditions;
  #timelinePanelInstance: TimelinePanel.TimelinePanel.TimelinePanel|null = null;
  #runAbortController = new AbortController();
  #walkthrough: WalkthroughState = {
    isInlined: false,
    isExpanded: false,
    activeSidebarMessage: null,
    inlineExpandedMessages: [],
  };

  constructor(private view: View = defaultView, {aidaClient, aidaAvailability}: {
    aidaClient: Host.AidaClient.AidaClient,
    aidaAvailability: Host.AidaClient.AidaAccessPreconditions,
  }) {
    super(AiAssistancePanel.panelName);
    this.registerRequiredCSS(aiAssistancePanelStyles);
    this.#aiAssistanceEnabledSetting = this.#getAiAssistanceEnabledSetting();

    this.#aidaClient = aidaClient;
    this.#aidaAvailability = aidaAvailability;

    if (UI.ActionRegistry.ActionRegistry.instance().hasAction('elements.toggle-element-search')) {
      this.#toggleSearchElementAction =
          UI.ActionRegistry.ActionRegistry.instance().getAction('elements.toggle-element-search');
    }
    AiAssistanceModel.AiHistoryStorage.AiHistoryStorage.instance().addEventListener(
        AiAssistanceModel.AiHistoryStorage.Events.HISTORY_DELETED, this.#onHistoryDeleted, this);
  }

  #getToolbarInput(): ToolbarViewInput {
    return {
      isLoading: this.#isLoading,
      showChatActions: this.#shouldShowChatActions(),
      showActiveConversationActions: Boolean(this.#conversation && !this.#conversation.isEmpty),
      onNewChatClick: this.#handleNewChatRequest.bind(this),
      populateHistoryMenu: this.#populateHistoryMenu.bind(this),
      onDeleteClick: this.#onDeleteClicked.bind(this),
      onExportConversationClick: this.#onExportConversationClick.bind(this),
      onHelpClick: () => {
        UIHelpers.openInNewTab(AI_ASSISTANCE_HELP);
      },
      onSettingsClick: () => {
        void UI.ViewManager.ViewManager.instance().showView('chrome-ai');
      },
    };
  }

  async #getPanelViewInput(): Promise<PanelViewInput> {
    const blockedByAge = Root.Runtime.hostConfig.aidaAvailability?.blockedByAge === true;

    if (this.#aidaAvailability !== Host.AidaClient.AidaAccessPreconditions.AVAILABLE ||
        !this.#aiAssistanceEnabledSetting?.getIfNotDisabled() || blockedByAge) {
      return {
        state: ViewState.DISABLED_VIEW,
        props: {
          aidaAvailability: this.#aidaAvailability,
        },
      };
    }

    if (this.#conversation) {
      const emptyStateSuggestions = await getEmptyStateSuggestions(this.#conversation);
      const markdownRenderer = getMarkdownRenderer(this.#conversation);
      let onContextAdd: (() => void)|null = null;
      if (isAiAssistanceContextSelectionAgentEnabled() &&
          // Only add it the button if can have anything already selected
          this.#getConversationContext(this.#getDefaultConversationType())) {
        onContextAdd = this.#handleContextAdd.bind(this);
      }

      return {
        state: ViewState.CHAT_VIEW,
        props: {
          blockedByCrossOrigin: this.#conversation.isBlockedByOrigin,
          isLoading: this.#isLoading,
          messages: this.#messages,
          /**
           * We pass either the selected context with isContextSelected=true
           * to make sure the pill is show with normal styling and a remove button.
           * Or we pass the panels default context with isContextSelected=false
           * to display a placeholder pill with neutral styling and an add button.
           */
          context:
              this.#conversation.selectedContext ?? this.#getConversationContext(this.#getDefaultConversationType()),
          isContextSelected: Boolean(this.#conversation.selectedContext),
          conversationType: this.#conversation.type,
          isReadOnly: this.#conversation.isReadOnly ?? false,
          changeSummary: this.#getChangeSummary(),
          inspectElementToggled: this.#toggleSearchElementAction?.toggled() ?? false,
          canShowFeedbackForm: this.#serverSideLoggingEnabled,
          multimodalInputEnabled: isAiAssistanceMultimodalInputEnabled() &&
              this.#conversation.type === AiAssistanceModel.AiHistoryStorage.ConversationType.STYLING,
          isTextInputDisabled: this.#isTextInputDisabled(),
          emptyStateSuggestions,
          inputPlaceholder: this.#getChatInputPlaceholder(),
          disclaimerText: this.#getDisclaimerText(),
          onExportConversation: this.#onExportConversationClick.bind(this),
          changeManager: this.#changeManager,
          uploadImageInputEnabled: isAiAssistanceMultimodalUploadInputEnabled() &&
              this.#conversation.type === AiAssistanceModel.AiHistoryStorage.ConversationType.STYLING,
          markdownRenderer,
          conversationMarkdown: this.#conversation.getConversationMarkdown(),
          generateConversationSummary: async (markdown: string) => {
            if (!this.#conversationSummaryAgent) {
              this.#conversationSummaryAgent = new AiAssistanceModel.ConversationSummaryAgent.ConversationSummaryAgent({
                aidaClient: this.#aidaClient,
                serverSideLoggingEnabled: this.#serverSideLoggingEnabled,
              });
            }
            return await this.#conversationSummaryAgent.summarizeConversation(markdown);
          },
          onTextSubmit: async (
              text: string, imageInput?: Host.AidaClient.Part,
              multimodalInputType?: AiAssistanceModel.AiAgent.MultimodalInputType) => {
            const submit = (): void => {
              Host.userMetrics.actionTaken(Host.UserMetrics.Action.AiAssistanceQuerySubmitted);
              void this.#startConversation(text, imageInput, multimodalInputType);
            };

            const isAIV2Enabled = Root.Runtime.hostConfig.devToolsAiAssistanceV2?.enabled;
            const seenSetting =
                Common.Settings.Settings.instance().moduleSetting('ai-assistance-v2-opt-in-change-dialog-seen');
            if (isAIV2Enabled && !seenSetting.get()) {
              OptInChangeDialog.show({
                onGotIt: () => {
                  seenSetting.set(true);
                  submit();
                },
                onManageSettings: () => {
                  seenSetting.set(true);
                  this.#viewOutput.chatView?.setInputValue(text);
                  void UI.ViewManager.ViewManager.instance().showView('chrome-ai');
                },
              });
              return;
            }

            submit();
          },
          onInspectElementClick: this.#handleSelectElementClick.bind(this),
          onFeedbackSubmit: this.#handleFeedbackSubmit.bind(this),
          onCancelClick: this.#cancel.bind(this),
          onContextClick: this.#handleContextClick.bind(this),
          onNewConversation: this.#handleNewChatRequest.bind(this),
          onCopyResponseClick: this.#onCopyResponseClick.bind(this),
          onContextRemoved: isAiAssistanceContextSelectionAgentEnabled() ? this.#handleContextRemoved.bind(this) : null,
          onContextAdd,
          walkthrough: {
            onToggle: this.#toggleWalkthrough.bind(this),
            onOpen: this.#openWalkthrough.bind(this),
            isExpanded: this.#walkthrough.isExpanded,
            isInlined: this.#walkthrough.isInlined,
            activeSidebarMessage: this.#walkthrough.activeSidebarMessage,
            inlineExpandedMessages: this.#walkthrough.inlineExpandedMessages,
          },
        }
      };
    }

    return {
      state: ViewState.EXPLORE_VIEW,
    };
  }

  // Responsive logic for Walkthrough
  override onResize(): void {
    super.onResize();
    if (Root.Runtime.hostConfig.devToolsAiAssistanceV2?.enabled) {
      this.#updateWalkthroughResponsiveness();
    }
  }

  #updateWalkthroughResponsiveness(): void {
    const isNarrow = this.contentElement.offsetWidth < WALKTHROUGH_SIDEBAR_BREAKPOINT;
    if (isNarrow === this.#walkthrough.isInlined) {
      return;
    }

    this.#walkthrough.isInlined = isNarrow;

    if (!this.#walkthrough.isExpanded) {
      // If nothing was expanded, we just ensure the state is clean.
      this.#walkthrough.activeSidebarMessage = null;
      this.#walkthrough.inlineExpandedMessages = [];
      this.requestUpdate();
      return;
    }

    if (isNarrow) {
      // Wide -> Inline: the walkthrough that was open stays expanded
      this.#walkthrough.inlineExpandedMessages =
          this.#walkthrough.activeSidebarMessage ? [this.#walkthrough.activeSidebarMessage] : [];
    } else {
      // Inline -> Wide: the last walkthrough that the user opened stays expanded
      this.#walkthrough.activeSidebarMessage = this.#walkthrough.inlineExpandedMessages.at(-1) ?? null;
    }

    this.requestUpdate();
  }

  #openWalkthrough(message: ModelChatMessage): void {
    if (!this.#walkthrough.inlineExpandedMessages.some(m => m.id === message.id)) {
      this.#walkthrough.inlineExpandedMessages.push(message);
    }
    this.#walkthrough.activeSidebarMessage = message;
    this.#walkthrough.isExpanded = true;
    this.requestUpdate();
  }

  /**
   * Toggles the expanded state of a walkthrough.
   *
   * In Wide (sidebar) mode:
   * - Opening a message's walkthrough shows the sidebar for that message.
   * - Closing the sidebar hides the walkthrough for the currently active message.
   *
   * In Narrow (inline) mode:
   * - Any number of walkthroughs can be open at once.
   * - Opening/closing a message's walkthrough only affects that message's inline display.
   */
  #toggleWalkthrough(isOpen: boolean, message: ModelChatMessage): void {
    if (isOpen) {  // If we are opening a walkthrough, ensure it's in our list of expanded messages.
      this.#openWalkthrough(message);
      return;
    }

    // If we are closing a walkthrough, remove it from the list of expanded messages.
    this.#walkthrough.inlineExpandedMessages =
        this.#walkthrough.inlineExpandedMessages.filter(m => m.id !== message.id);

    if (this.#walkthrough.isInlined) {
      // In Narrow mode, the global expanded state tracks if at least one walkthrough is open.
      this.#walkthrough.isExpanded = this.#walkthrough.inlineExpandedMessages.length > 0;
      // If the message we just closed was the active one, we pick a new active message
      // from the remaining open ones (if any). This ensures that if the user
      // re-opens the sidebar later, it shows the most recently opened walkthrough.
      if (this.#walkthrough.activeSidebarMessage?.id === message.id) {
        this.#walkthrough.activeSidebarMessage = this.#walkthrough.inlineExpandedMessages.at(-1) ?? null;
      }
    } else {
      // In Wide mode, closing the sidebar means we are no longer expanded globally.
      this.#walkthrough.isExpanded = false;
      this.#walkthrough.activeSidebarMessage = null;
    }

    this.requestUpdate();
  }

  #getAiAssistanceEnabledSetting(): Common.Settings.Setting<boolean>|undefined {
    try {
      return Common.Settings.moduleSetting('ai-assistance-enabled') as Common.Settings.Setting<boolean>;
    } catch {
      return;
    }
  }

  static async instance(opts: {
    forceNew: boolean|null,
  }|undefined = {forceNew: null}): Promise<AiAssistancePanel> {
    const {forceNew} = opts;
    if (!panelInstance || forceNew) {
      const aidaClient = new Host.AidaClient.AidaClient();
      const aidaAvailability = await Host.AidaClient.AidaClient.checkAccessPreconditions();
      panelInstance = new AiAssistancePanel(defaultView, {aidaClient, aidaAvailability});
    }

    return panelInstance;
  }

  /**
   * Called when the TimelinePanel instance changes. We use this to listen to
   * the status of if the user is viewing a trace or not, and update the
   * placeholder text in the panel accordingly. We do this because if the user
   * has an active trace, we show different text than if they are viewing
   * the performance panel but have no trace imported.
   */
  #bindTimelineTraceListener(): void {
    const timelinePanel = UI.Context.Context.instance().flavor(TimelinePanel.TimelinePanel.TimelinePanel);

    // Avoid binding multiple times.
    if (timelinePanel === this.#timelinePanelInstance) {
      return;
    }

    // Ensure we clear up any listener from the old TimelinePanel instance.
    this.#timelinePanelInstance?.removeEventListener(
        TimelinePanel.TimelinePanel.Events.IS_VIEWING_TRACE, this.requestUpdate, this);
    this.#timelinePanelInstance = timelinePanel;

    if (this.#timelinePanelInstance) {
      this.#timelinePanelInstance.addEventListener(
          TimelinePanel.TimelinePanel.Events.IS_VIEWING_TRACE, this.requestUpdate, this);
    }
  }

  async #handlePerformanceRecordAndReload(): Promise<Trace.TraceModel.ParsedTrace> {
    return await TimelinePanel.TimelinePanel.TimelinePanel.executeRecordAndReload();
  }

  async #handleLighthouseRun(overrides?: LHModel.RunTypes.RunOverrides):
      Promise<LHModel.ReporterTypes.ReportJSON|null> {
    return await LighthousePanel.LighthousePanel.LighthousePanel.executeLighthouseRecording({
      isAIControlled: true,
      ...overrides,
    });
  }

  #getDefaultConversationType(): AiAssistanceModel.AiHistoryStorage.ConversationType|undefined {
    const {hostConfig} = Root.Runtime;
    const viewManager = UI.ViewManager.ViewManager.instance();
    const isElementsPanelVisible = viewManager.isViewVisible('elements');
    const isNetworkPanelVisible = viewManager.isViewVisible('network');
    const isSourcesPanelVisible = viewManager.isViewVisible('sources');
    const isPerformancePanelVisible = viewManager.isViewVisible('timeline');
    const isLighthousePanelVisible = viewManager.isViewVisible('lighthouse');
    const isApplicationPanelVisible = viewManager.isViewVisible('resources');

    let targetConversationType: AiAssistanceModel.AiHistoryStorage.ConversationType|undefined;
    if (isElementsPanelVisible && hostConfig.devToolsFreestyler?.enabled) {
      targetConversationType = AiAssistanceModel.AiHistoryStorage.ConversationType.STYLING;
    } else if (isNetworkPanelVisible && hostConfig.devToolsAiAssistanceNetworkAgent?.enabled) {
      targetConversationType = AiAssistanceModel.AiHistoryStorage.ConversationType.NETWORK;
    } else if (
        isSourcesPanelVisible &&
        this.#conversation?.type === AiAssistanceModel.AiHistoryStorage.ConversationType.BREAKPOINT) {
      targetConversationType = AiAssistanceModel.AiHistoryStorage.ConversationType.BREAKPOINT;
    } else if (isSourcesPanelVisible && hostConfig.devToolsAiAssistanceFileAgent?.enabled) {
      targetConversationType = AiAssistanceModel.AiHistoryStorage.ConversationType.FILE;
    } else if (isPerformancePanelVisible && hostConfig.devToolsAiAssistancePerformanceAgent?.enabled) {
      targetConversationType = AiAssistanceModel.AiHistoryStorage.ConversationType.PERFORMANCE;
    } else if (isLighthousePanelVisible && hostConfig.devToolsAiAssistanceAccessibilityAgent?.enabled) {
      targetConversationType = AiAssistanceModel.AiHistoryStorage.ConversationType.ACCESSIBILITY;
    } else if (isApplicationPanelVisible && hostConfig.devToolsAiAssistanceStorageAgent?.enabled) {
      targetConversationType = AiAssistanceModel.AiHistoryStorage.ConversationType.STORAGE;
    }

    if (isAiAssistanceContextSelectionAgentEnabled() && !targetConversationType) {
      return AiAssistanceModel.AiHistoryStorage.ConversationType.NONE;
    }

    return targetConversationType;
  }

  // We select the default agent based on the open panels if
  // there isn't any active conversation.
  #selectDefaultAgentIfNeeded(): void {
    // We don't change the current agent when there is a message in flight.
    if (this.#isLoading) {
      this.requestUpdate();
      return;
    }

    // If there already is an agent and if it is not empty,
    // we don't automatically change the agent.
    if (this.#conversation && !this.#conversation.isEmpty) {
      this.requestUpdate();
      return;
    }

    const targetConversationType = this.#getDefaultConversationType();
    if (this.#conversation?.type === targetConversationType) {
      this.requestUpdate();
      // The above if makes sure even if we have an active agent it's empty
      // So we can just reuse it
      return;
    }
    const conversation = targetConversationType ? new AiAssistanceModel.AiConversation.AiConversation({
      type: targetConversationType,
      data: [],
      isReadOnly: false,
      aidaClient: this.#aidaClient,
      changeManager: this.#changeManager,
      isExternal: false,
      performanceRecordAndReload: this.#handlePerformanceRecordAndReload.bind(this),
      onInspectElement: this.#handleInspectElement.bind(this),
      networkTimeCalculator: NetworkPanel.NetworkPanel.NetworkPanel.instance().networkLogView.timeCalculator(),
      lighthouseRecording: this.#handleLighthouseRun.bind(this),
    }) :
                                                  undefined;

    this.#updateConversationState(conversation);
  }

  #updateConversationState(
      conversation?: AiAssistanceModel.AiConversation.AiConversation,
      ): void {
    if (this.#conversation !== conversation) {
      // Cancel any previous conversation
      this.#cancel();
      this.#messages = [];
      this.#isLoading = false;
      this.#conversation?.archiveConversation();

      if (!conversation) {
        const conversationType = this.#getDefaultConversationType();
        if (conversationType) {
          conversation = new AiAssistanceModel.AiConversation.AiConversation({
            type: conversationType,
            data: [],
            isReadOnly: false,
            aidaClient: this.#aidaClient,
            changeManager: this.#changeManager,
            isExternal: false,
            performanceRecordAndReload: this.#handlePerformanceRecordAndReload.bind(this),
            onInspectElement: this.#handleInspectElement.bind(this),
            networkTimeCalculator: NetworkPanel.NetworkPanel.NetworkPanel.instance().networkLogView.timeCalculator(),
            lighthouseRecording: this.#handleLighthouseRun.bind(this),
          });
        }
      }

      this.#conversation = conversation;
    }

    if (this.#conversation) {
      if (this.#conversation.isEmpty && isAiAssistanceContextSelectionAgentEnabled()) {
        const context = this.#getConversationContext(this.#getDefaultConversationType());
        this.#conversation.setContext(context);
      } else {
        const context = this.#getConversationContext(this.#conversation.type);
        // Don't reset to the context selection agent if
        // we remove context automatically.
        // Require explicit user action.
        if (context || !isAiAssistanceContextSelectionAgentEnabled()) {
          this.#conversation.setContext(context);
        }
      }
    }

    this.requestUpdate();
  }

  async handleBreakpointConversation(uiLocation: Workspace.UISourceCode.UILocation, errorMsg?: string): Promise<void> {
    const context = new AiAssistanceModel.BreakpointDebuggerAgent.BreakpointContext(uiLocation);
    this.#selectedBreakpoint = context;
    const conversation = new AiAssistanceModel.AiConversation.AiConversation({
      type: AiAssistanceModel.AiHistoryStorage.ConversationType.BREAKPOINT,
      data: [],
      isReadOnly: false,
      aidaClient: this.#aidaClient,
      changeManager: this.#changeManager,
      isExternal: false,
      performanceRecordAndReload: this.#handlePerformanceRecordAndReload.bind(this),
      onInspectElement: this.#handleInspectElement.bind(this),
      networkTimeCalculator: NetworkPanel.NetworkPanel.NetworkPanel.instance().networkLogView.timeCalculator(),
      lighthouseRecording: this.#handleLighthouseRun.bind(