Files
vscode/src/vs/workbench/contrib/chat/browser/chatViewPane.ts
2025-07-24 15:32:14 -07:00

296 lines
14 KiB
TypeScript

/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { $, getWindow } from '../../../../base/browser/dom.js';
import { CancellationToken } from '../../../../base/common/cancellation.js';
import { DisposableStore } from '../../../../base/common/lifecycle.js';
import { MarshalledId } from '../../../../base/common/marshallingIds.js';
import { URI } from '../../../../base/common/uri.js';
import { IConfigurationService } from '../../../../platform/configuration/common/configuration.js';
import { IContextKeyService } from '../../../../platform/contextkey/common/contextkey.js';
import { IContextMenuService } from '../../../../platform/contextview/browser/contextView.js';
import { IHoverService } from '../../../../platform/hover/browser/hover.js';
import { IInstantiationService } from '../../../../platform/instantiation/common/instantiation.js';
import { ServiceCollection } from '../../../../platform/instantiation/common/serviceCollection.js';
import { IKeybindingService } from '../../../../platform/keybinding/common/keybinding.js';
import { ILayoutService } from '../../../../platform/layout/browser/layoutService.js';
import { ILogService } from '../../../../platform/log/common/log.js';
import { IOpenerService } from '../../../../platform/opener/common/opener.js';
import { IStorageService, StorageScope, StorageTarget } from '../../../../platform/storage/common/storage.js';
import { editorBackground } from '../../../../platform/theme/common/colorRegistry.js';
import { IThemeService } from '../../../../platform/theme/common/themeService.js';
import { IViewPaneOptions, ViewPane } from '../../../browser/parts/views/viewPane.js';
import { Memento } from '../../../common/memento.js';
import { SIDE_BAR_FOREGROUND } from '../../../common/theme.js';
import { IViewDescriptorService, ViewContainerLocation } from '../../../common/views.js';
import { IChatViewTitleActionContext } from '../common/chatActions.js';
import { IChatAgentService } from '../common/chatAgents.js';
import { ChatContextKeys } from '../common/chatContextKeys.js';
import { IChatModel } from '../common/chatModel.js';
import { CHAT_PROVIDER_ID } from '../common/chatParticipantContribTypes.js';
import { IChatService } from '../common/chatService.js';
import { ChatAgentLocation, ChatModeKind } from '../common/constants.js';
import { ChatWidget, IChatViewState } from './chatWidget.js';
import { ChatViewWelcomeController, IViewWelcomeDelegate } from './viewsWelcome/chatViewWelcomeController.js';
interface IViewPaneState extends IChatViewState {
sessionId?: string;
hasMigratedCurrentSession?: boolean;
}
export const CHAT_SIDEBAR_OLD_VIEW_PANEL_ID = 'workbench.panel.chatSidebar';
export const CHAT_SIDEBAR_PANEL_ID = 'workbench.panel.chat';
export class ChatViewPane extends ViewPane implements IViewWelcomeDelegate {
private _widget!: ChatWidget;
get widget(): ChatWidget { return this._widget; }
private readonly modelDisposables = this._register(new DisposableStore());
private memento: Memento;
private readonly viewState: IViewPaneState;
private _restoringSession: Promise<void> | undefined;
constructor(
private readonly chatOptions: { location: ChatAgentLocation.Panel },
options: IViewPaneOptions,
@IKeybindingService keybindingService: IKeybindingService,
@IContextMenuService contextMenuService: IContextMenuService,
@IConfigurationService configurationService: IConfigurationService,
@IContextKeyService contextKeyService: IContextKeyService,
@IViewDescriptorService viewDescriptorService: IViewDescriptorService,
@IInstantiationService instantiationService: IInstantiationService,
@IOpenerService openerService: IOpenerService,
@IThemeService themeService: IThemeService,
@IHoverService hoverService: IHoverService,
@IStorageService private readonly storageService: IStorageService,
@IChatService private readonly chatService: IChatService,
@IChatAgentService private readonly chatAgentService: IChatAgentService,
@ILogService private readonly logService: ILogService,
@ILayoutService private readonly layoutService: ILayoutService,
) {
super(options, keybindingService, contextMenuService, configurationService, contextKeyService, viewDescriptorService, instantiationService, openerService, themeService, hoverService);
// View state for the ViewPane is currently global per-provider basically, but some other strictly per-model state will require a separate memento.
this.memento = new Memento('interactive-session-view-' + CHAT_PROVIDER_ID, this.storageService);
this.viewState = this.memento.getMemento(StorageScope.WORKSPACE, StorageTarget.MACHINE) as IViewPaneState;
if (this.chatOptions.location === ChatAgentLocation.Panel && !this.viewState.hasMigratedCurrentSession) {
const editsMemento = new Memento('interactive-session-view-' + CHAT_PROVIDER_ID + `-edits`, this.storageService);
const lastEditsState = editsMemento.getMemento(StorageScope.WORKSPACE, StorageTarget.MACHINE) as IViewPaneState;
if (lastEditsState.sessionId) {
this.logService.trace(`ChatViewPane: last edits session was ${lastEditsState.sessionId}`);
if (!this.chatService.isPersistedSessionEmpty(lastEditsState.sessionId)) {
this.logService.info(`ChatViewPane: migrating ${lastEditsState.sessionId} to unified view`);
this.viewState.sessionId = lastEditsState.sessionId;
this.viewState.inputValue = lastEditsState.inputValue;
this.viewState.inputState = {
...lastEditsState.inputState,
chatMode: lastEditsState.inputState?.chatMode ?? ChatModeKind.Edit
};
this.viewState.hasMigratedCurrentSession = true;
}
}
}
this._register(this.chatAgentService.onDidChangeAgents(() => {
if (this.chatAgentService.getDefaultAgent(this.chatOptions?.location)) {
if (!this._widget?.viewModel && !this._restoringSession) {
const info = this.getTransferredOrPersistedSessionInfo();
this._restoringSession =
(info.sessionId ? this.chatService.getOrRestoreSession(info.sessionId) : Promise.resolve(undefined)).then(async model => {
if (!this._widget) {
// renderBody has not been called yet
return;
}
// The widget may be hidden at this point, because welcome views were allowed. Use setVisible to
// avoid doing a render while the widget is hidden. This is changing the condition in `shouldShowWelcome`
// so it should fire onDidChangeViewWelcomeState.
const wasVisible = this._widget.visible;
try {
this._widget.setVisible(false);
await this.updateModel(model, info.inputValue || info.mode ? { inputState: { chatMode: info.mode }, inputValue: info.inputValue } : undefined);
} finally {
this.widget.setVisible(wasVisible);
}
});
this._restoringSession.finally(() => this._restoringSession = undefined);
}
}
this._onDidChangeViewWelcomeState.fire();
}));
// Location context key
ChatContextKeys.panelLocation.bindTo(contextKeyService).set(viewDescriptorService.getViewLocationById(options.id) ?? ViewContainerLocation.AuxiliaryBar);
}
override getActionsContext(): IChatViewTitleActionContext | undefined {
return this.widget?.viewModel ? {
sessionId: this.widget.viewModel.sessionId,
$mid: MarshalledId.ChatViewContext
} : undefined;
}
private async updateModel(model?: IChatModel | undefined, viewState?: IChatViewState): Promise<void> {
this.modelDisposables.clear();
model = model ?? (this.chatService.transferredSessionData?.sessionId && this.chatService.transferredSessionData?.location === this.chatOptions.location
? await this.chatService.getOrRestoreSession(this.chatService.transferredSessionData.sessionId)
: this.chatService.startSession(this.chatOptions.location, CancellationToken.None));
if (!model) {
throw new Error('Could not start chat session');
}
if (viewState) {
this.updateViewState(viewState);
}
this.viewState.sessionId = model.sessionId;
this._widget.setModel(model, { ...this.viewState });
// Update the toolbar context with new sessionId
this.updateActions();
}
override shouldShowWelcome(): boolean {
const noPersistedSessions = !this.chatService.hasSessions();
const hasCoreAgent = this.chatAgentService.getAgents().some(agent => agent.isCore && agent.locations.includes(this.chatOptions.location));
const hasDefaultAgent = this.chatAgentService.getDefaultAgent(this.chatOptions.location) !== undefined; // only false when Hide Copilot has run and unregistered the setup agents
const shouldShow = !hasCoreAgent && (!hasDefaultAgent || !this._widget?.viewModel && noPersistedSessions);
this.logService.trace(`ChatViewPane#shouldShowWelcome(${this.chatOptions.location}) = ${shouldShow}: hasCoreAgent=${hasCoreAgent} hasDefaultAgent=${hasDefaultAgent} || noViewModel=${!this._widget?.viewModel} && noPersistedSessions=${noPersistedSessions}`);
return !!shouldShow;
}
private getTransferredOrPersistedSessionInfo(): { sessionId?: string; inputValue?: string; mode?: ChatModeKind } {
if (this.chatService.transferredSessionData?.location === this.chatOptions.location) {
const sessionId = this.chatService.transferredSessionData.sessionId;
return {
sessionId,
inputValue: this.chatService.transferredSessionData.inputValue,
mode: this.chatService.transferredSessionData.mode
};
} else {
return { sessionId: this.viewState.sessionId };
}
}
protected override async renderBody(parent: HTMLElement): Promise<void> {
try {
super.renderBody(parent);
this._register(this.instantiationService.createInstance(ChatViewWelcomeController, parent, this, this.chatOptions.location));
const scopedInstantiationService = this._register(this.instantiationService.createChild(new ServiceCollection([IContextKeyService, this.scopedContextKeyService])));
const locationBasedColors = this.getLocationBasedColors();
const editorOverflowNode = this.layoutService.getContainer(getWindow(parent)).appendChild($('.chat-editor-overflow.monaco-editor'));
this._register({ dispose: () => editorOverflowNode.remove() });
this._widget = this._register(scopedInstantiationService.createInstance(
ChatWidget,
this.chatOptions.location,
{ viewId: this.id },
{
autoScroll: mode => mode !== ChatModeKind.Ask,
renderFollowups: this.chatOptions.location === ChatAgentLocation.Panel,
supportsFileReferences: true,
rendererOptions: {
renderTextEditsAsSummary: (uri) => {
return true;
},
referencesExpandedWhenEmptyResponse: false,
progressMessageAtBottomOfResponse: mode => mode !== ChatModeKind.Ask,
},
editorOverflowWidgetsDomNode: editorOverflowNode,
enableImplicitContext: this.chatOptions.location === ChatAgentLocation.Panel,
enableWorkingSet: 'explicit',
supportsChangingModes: true,
},
{
listForeground: SIDE_BAR_FOREGROUND,
listBackground: locationBasedColors.background,
overlayBackground: locationBasedColors.overlayBackground,
inputEditorBackground: locationBasedColors.background,
resultEditorBackground: editorBackground,
}));
this._register(this.onDidChangeBodyVisibility(visible => {
this._widget.setVisible(visible);
}));
this._register(this._widget.onDidClear(() => this.clear()));
this._widget.render(parent);
const info = this.getTransferredOrPersistedSessionInfo();
const model = info.sessionId ? await this.chatService.getOrRestoreSession(info.sessionId) : undefined;
await this.updateModel(model, info.inputValue || info.mode ? { inputState: { chatMode: info.mode }, inputValue: info.inputValue } : undefined);
} catch (e) {
this.logService.error(e);
throw e;
}
}
acceptInput(query?: string): void {
this._widget.acceptInput(query);
}
private async clear(): Promise<void> {
if (this.widget.viewModel) {
await this.chatService.clearSession(this.widget.viewModel.sessionId);
}
// Grab the widget's latest view state because it will be loaded back into the widget
this.updateViewState();
await this.updateModel(undefined);
// Update the toolbar context with new sessionId
this.updateActions();
}
async loadSession(sessionId: string | URI, viewState?: IChatViewState): Promise<void> {
if (this.widget.viewModel) {
await this.chatService.clearSession(this.widget.viewModel.sessionId);
}
const newModel = await (URI.isUri(sessionId) ? this.chatService.loadSessionForResource(sessionId, ChatAgentLocation.Panel, CancellationToken.None) : this.chatService.getOrRestoreSession(sessionId));
await this.updateModel(newModel, viewState);
}
focusInput(): void {
this._widget.focusInput();
}
override focus(): void {
super.focus();
this._widget.focusInput();
}
protected override layoutBody(height: number, width: number): void {
super.layoutBody(height, width);
this._widget.layout(height, width);
}
override saveState(): void {
if (this._widget) {
// Since input history is per-provider, this is handled by a separate service and not the memento here.
// TODO multiple chat views will overwrite each other
this._widget.saveState();
this.updateViewState();
this.memento.saveMemento();
}
super.saveState();
}
private updateViewState(viewState?: IChatViewState): void {
const newViewState = viewState ?? this._widget.getViewState();
for (const [key, value] of Object.entries(newViewState)) {
// Assign all props to the memento so they get saved
(this.viewState as any)[key] = value;
}
}
}