Enable workbench.action.chat.open to switch to custom modes (microsoft#253120)

* Enable workbench.action.chat.open to switch to custom modes

* Fix build

Author: roblourens

src/vs/workbench/contrib/chat/browser/actions/chatActions.ts

@@ -50,12 +50,12 @@ import { IChatAgentService } from '../../common/chatAgents.js';
 import { ChatContextKeys } from '../../common/chatContextKeys.js';
 import { IChatEditingSession, ModifiedFileEntryState } from '../../common/chatEditingService.js';
 import { ChatEntitlement, IChatEntitlementService } from '../../common/chatEntitlementService.js';
-import { ChatMode, IChatMode } from '../../common/chatModes.js';
+import { ChatMode, IChatMode, IChatModeService } from '../../common/chatModes.js';
 import { extractAgentAndCommand } from '../../common/chatParserTypes.js';
 import { IChatDetail, IChatService } from '../../common/chatService.js';
 import { IChatRequestViewModel, IChatResponseViewModel, isRequestVM } from '../../common/chatViewModel.js';
 import { IChatWidgetHistoryService } from '../../common/chatWidgetHistoryService.js';
-import { ChatAgentLocation, ChatConfiguration, ChatModeKind, validateChatMode } from '../../common/constants.js';
+import { ChatAgentLocation, ChatConfiguration, ChatModeKind } from '../../common/constants.js';
 import { CopilotUsageExtensionFeatureId } from '../../common/languageModelStats.js';
 import { ILanguageModelToolsService } from '../../common/languageModelToolsService.js';
 import { ChatViewId, IChatWidget, IChatWidgetService, showChatView, showCopilotView } from '../chat.js';
@@ -100,9 +100,9 @@ export interface IChatViewOpenOptions {
 	 */
 	attachFiles?: URI[];
 	/**
-	 * The mode to open the chat in.
+	 * The mode ID or name to open the chat in.
 	 */
-	mode?: ChatModeKind;
+	mode?: ChatModeKind | string;
 }
 
 export interface IChatViewOpenRequestEntry {
@@ -139,6 +139,7 @@ abstract class OpenChatGlobalAction extends Action2 {
 		const chatAgentService = accessor.get(IChatAgentService);
 		const instaService = accessor.get(IInstantiationService);
 		const commandService = accessor.get(ICommandService);
+		const chatModeService = accessor.get(IChatModeService);
 
 		let chatWidget = widgetService.lastFocusedWidget;
 		// When this was invoked to switch to a mode via keybinding, and some chat widget is focused, use that one.
@@ -151,11 +152,12 @@ abstract class OpenChatGlobalAction extends Action2 {
 			return;
 		}
 
-		let switchToMode = opts?.mode ?? this.mode;
+		const switchToModeInput = opts?.mode ?? this.mode;
+		let switchToMode = switchToModeInput && (chatModeService.findModeById(switchToModeInput) ?? chatModeService.findModeByName(switchToModeInput));
 		if (!switchToMode) {
-			switchToMode = opts?.query?.startsWith('@') ? ChatModeKind.Ask : undefined;
+			switchToMode = opts?.query?.startsWith('@') ? ChatMode.Ask : undefined;
 		}
-		if (switchToMode && validateChatMode(switchToMode)) {
+		if (switchToMode) {
 			await this.handleSwitchToMode(switchToMode, chatWidget, instaService, commandService);
 		}
 
@@ -203,17 +205,17 @@ abstract class OpenChatGlobalAction extends Action2 {
 		chatWidget.focusInput();
 	}
 
-	private async handleSwitchToMode(switchToMode: ChatModeKind, chatWidget: IChatWidget, instaService: IInstantiationService, commandService: ICommandService): Promise<void> {
+	private async handleSwitchToMode(switchToMode: IChatMode, chatWidget: IChatWidget, instaService: IInstantiationService, commandService: ICommandService): Promise<void> {
 		const currentMode = chatWidget.input.currentModeKind;
 
 		if (switchToMode) {
 			const editingSession = chatWidget.viewModel?.model.editingSession;
 			const requestCount = chatWidget.viewModel?.model.getRequests().length ?? 0;
-			const chatModeCheck = await instaService.invokeFunction(handleModeSwitch, currentMode, switchToMode, requestCount, editingSession);
+			const chatModeCheck = await instaService.invokeFunction(handleModeSwitch, currentMode, switchToMode.kind, requestCount, editingSession);
 			if (!chatModeCheck) {
 				return;
 			}
-			chatWidget.input.setChatMode(switchToMode);
+			chatWidget.input.setChatMode(switchToMode.id);
 
 			if (chatModeCheck.needToClearSession) {
 				await commandService.executeCommand(ACTION_ID_NEW_CHAT);

src/vs/workbench/contrib/chat/common/chatModes.ts

@@ -15,7 +15,7 @@ import { ILogService } from '../../../../platform/log/common/log.js';
 import { IStorageService, StorageScope, StorageTarget } from '../../../../platform/storage/common/storage.js';
 import { IChatAgentService } from './chatAgents.js';
 import { ChatContextKeys } from './chatContextKeys.js';
-import { ChatModeKind, modeToString } from './constants.js';
+import { ChatModeKind } from './constants.js';
 import { ICustomChatMode, IPromptsService } from './promptSyntax/service/promptsService.js';
 
 export const IChatModeService = createDecorator<IChatModeService>('chatModeService');
@@ -26,6 +26,7 @@ export interface IChatModeService {
 	onDidChangeChatModes: Event<void>;
 	getModes(): { builtin: readonly IChatMode[]; custom: readonly IChatMode[] };
 	findModeById(id: string): IChatMode | undefined;
+	findModeByName(name: string): IChatMode | undefined;
 }
 
 export class ChatModeService extends Disposable implements IChatModeService {
@@ -163,13 +164,19 @@ export class ChatModeService extends Disposable implements IChatModeService {
 		return { builtin: this.getBuiltinModes(), custom: Array.from(this._customModeInstances.values()) };
 	}
 
-	findModeById(id: string | ChatModeKind): IChatMode | undefined {
+	private getFlatModes(): IChatMode[] {
 		const allModes = this.getModes();
-		const builtinMode = allModes.builtin.find(mode => mode.id === id);
-		if (builtinMode) {
-			return builtinMode;
-		}
-		return allModes.custom.find(mode => mode.id === id);
+		return [...allModes.builtin, ...allModes.custom];
+	}
+
+	findModeById(id: string | ChatModeKind): IChatMode | undefined {
+		const allModes = this.getFlatModes();
+		return allModes.find(mode => mode.id === id);
+	}
+
+	findModeByName(name: string): IChatMode | undefined {
+		const allModes = this.getFlatModes();
+		return allModes.find(mode => mode.name === name);
 	}
 
 	private getBuiltinModes(): IChatMode[] {
@@ -298,13 +305,12 @@ export class CustomChatMode implements IChatMode {
 
 export class BuiltinChatMode implements IChatMode {
 	public readonly description: IObservable<string>;
-	public readonly name: string;
 
 	constructor(
 		public readonly kind: ChatModeKind,
+		public readonly name: string,
 		description: string
 	) {
-		this.name = modeToString(this.kind);
 		this.description = observableValue('description', description);
 	}
 
@@ -327,9 +333,9 @@ export class BuiltinChatMode implements IChatMode {
 }
 
 export namespace ChatMode {
-	export const Ask = new BuiltinChatMode(ChatModeKind.Ask, localize('chatDescription', "Ask Copilot"));
-	export const Edit = new BuiltinChatMode(ChatModeKind.Edit, localize('editsDescription', "Edit files in your workspace"));
-	export const Agent = new BuiltinChatMode(ChatModeKind.Agent, localize('agentDescription', "Edit files in your workspace in agent mode"));
+	export const Ask = new BuiltinChatMode(ChatModeKind.Ask, 'Ask', localize('chatDescription', "Ask Copilot"));
+	export const Edit = new BuiltinChatMode(ChatModeKind.Edit, 'Edit', localize('editsDescription', "Edit files in your workspace"));
+	export const Agent = new BuiltinChatMode(ChatModeKind.Agent, 'Agent', localize('agentDescription', "Edit files in your workspace in agent mode"));
 }
 
 export function isBuiltinChatMode(mode: IChatMode): boolean {

src/vs/workbench/contrib/chat/common/constants.ts

@@ -20,18 +20,6 @@ export enum ChatModeKind {
 	Agent = 'agent'
 }
 
-export function modeToString(mode: ChatModeKind) {
-	switch (mode) {
-		case ChatModeKind.Agent:
-			return 'Agent';
-		case ChatModeKind.Edit:
-			return 'Edit';
-		case ChatModeKind.Ask:
-		default:
-			return 'Ask';
-	}
-}
-
 export function validateChatMode(mode: unknown): ChatModeKind | undefined {
 	switch (mode) {
 		case ChatModeKind.Ask:

src/vs/workbench/contrib/chat/test/common/mockChatModeService.ts

@@ -19,11 +19,15 @@ export class MockChatModeService implements IChatModeService {
 	}
 
 	findModeById(id: string): IChatMode | undefined {
+		return this.getFlatModes().find(mode => mode.id === id);
+	}
+
+	findModeByName(name: string): IChatMode | undefined {
+		return this.getFlatModes().find(mode => mode.name === name);
+	}
+
+	private getFlatModes(): IChatMode[] {
 		const allModes = this.getModes();
-		const builtinMode = allModes.builtin.find(mode => mode.id === id);
-		if (builtinMode) {
-			return builtinMode;
-		}
-		return allModes.custom.find(mode => mode.id === id);
+		return [...allModes.builtin, ...allModes.custom];
 	}
 }