test(vscode-e2e): cover cross-panel view state isolation

Author: easonliang28

apps/vscode-e2e/fixtures/modes.json

@@ -13,6 +13,20 @@
 					}
 				]
 			}
+		},
+		{
+			"match": {
+				"userMessage": "Use the `switch_mode` tool to switch to debug mode."
+			},
+			"response": {
+				"toolCalls": [
+					{
+						"name": "switch_mode",
+						"arguments": "{\"mode_slug\":\"debug\",\"reason\":\"User requested to switch to debug mode.\"}",
+						"id": "call_modes_switch_002"
+					}
+				]
+			}
 		}
 	]
 }

apps/vscode-e2e/src/runTest.ts

@@ -21,6 +21,7 @@ import { addSearchFilesResultFixtures } from "./fixtures/search-files"
 import { addSubtaskFixtures } from "./fixtures/subtasks"
 import { addUseMcpToolResultFixtures } from "./fixtures/use-mcp-tool"
 import { addWriteToFileResultFixtures } from "./fixtures/write-to-file"
+import { toolResultContains } from "./fixtures/tool-result"
 
 function getCliFlagValue(flag: string) {
 	return process.argv.find((arg, index) => process.argv[index - 1] === flag)
@@ -130,6 +131,36 @@ async function main() {
 				addWriteToFileResultFixtures(mock)
 				addDeepSeekV4Fixtures(mock)
 
+				mock.addFixture({
+					match: {
+						predicate: (req) => toolResultContains(req, "call_modes_switch_001", []),
+					},
+					response: {
+						toolCalls: [
+							{
+								name: "attempt_completion",
+								arguments: JSON.stringify({ result: "Switched to ❓ Ask mode as requested." }),
+								id: "call_modes_post_switch_001",
+							},
+						],
+					},
+				})
+
+				mock.addFixture({
+					match: {
+						predicate: (req) => toolResultContains(req, "call_modes_switch_002", []),
+					},
+					response: {
+						toolCalls: [
+							{
+								name: "attempt_completion",
+								arguments: JSON.stringify({ result: "Switched to 🪲 Debug mode as requested." }),
+								id: "call_modes_post_switch_002",
+							},
+						],
+					},
+				})
+
 				// The modes test (switch_mode → ask) triggers a second API call whose last
 				// user message starts with <environment_details> directly — no <user_message>
 				// wrapper. JSON fixtures use substring matching so a bare "<environment_details>"

apps/vscode-e2e/src/suite/view-state.test.ts

@@ -0,0 +1,115 @@
+import * as assert from "assert"
+
+import { isSecretStateKey, RooCodeEventName, type ClineMessage, type GlobalState } from "@roo-code/types"
+
+import { waitUntilCompleted } from "./utils"
+import { setDefaultSuiteTimeout } from "./test-utils"
+
+const findSecretStatePath = (value: unknown, path: string[] = []): string | undefined => {
+	if (!value || typeof value !== "object") {
+		return undefined
+	}
+
+	for (const [key, nestedValue] of Object.entries(value)) {
+		const nextPath = [...path, key]
+
+		if (isSecretStateKey(key)) {
+			return nextPath.join(".")
+		}
+
+		const nestedSecretPath = findSecretStatePath(nestedValue, nextPath)
+		if (nestedSecretPath) {
+			return nestedSecretPath
+		}
+	}
+
+	return undefined
+}
+
+suite("Roo Code View State", function () {
+	setDefaultSuiteTimeout(this)
+
+	teardown(async () => {
+		try {
+			await globalThis.api.cancelCurrentTask()
+		} catch {
+			// Task might not be running.
+		}
+	})
+
+	test("sidebar and tab panel keep mode isolated through the real ContextProxy singleton", async () => {
+		const modeEvents: Array<{ taskId: string; mode: string }> = []
+		const completionHandler = ({ taskId, message }: { taskId: string; message: ClineMessage }) => {
+			if (message.type === "ask" && message.ask === "completion_result") {
+				void globalThis.api.approveTaskAsk(taskId)
+			}
+		}
+
+		globalThis.api.on(RooCodeEventName.TaskModeSwitched, (taskId, mode) => modeEvents.push({ taskId, mode }))
+		globalThis.api.on(RooCodeEventName.Message, completionHandler)
+
+		try {
+			const sidebarTaskId = await globalThis.api.startNewTask({
+				configuration: {
+					mode: "code",
+					alwaysAllowModeSwitch: true,
+					autoApprovalEnabled: true,
+					apiKey: "sidebar-secret-must-not-persist",
+				},
+				text: "Use the `switch_mode` tool to switch to ask mode.",
+			})
+			await waitUntilCompleted({ api: globalThis.api, taskId: sidebarTaskId })
+
+			const tabTaskId = await globalThis.api.startNewTask({
+				configuration: {
+					mode: "code",
+					alwaysAllowModeSwitch: true,
+					autoApprovalEnabled: true,
+					apiKey: "tab-secret-must-not-persist",
+				},
+				text: "Use the `switch_mode` tool to switch to debug mode.",
+				newTab: true,
+			})
+			await waitUntilCompleted({ api: globalThis.api, taskId: tabTaskId })
+
+			// Each task's switch must be attributed to its own taskId only.
+			assert.deepStrictEqual(
+				modeEvents.filter((event) => event.taskId === sidebarTaskId).map((event) => event.mode),
+				["ask"],
+			)
+			assert.deepStrictEqual(
+				modeEvents.filter((event) => event.taskId === tabTaskId).map((event) => event.mode),
+				["debug"],
+			)
+
+			// The tab panel's switch must not overwrite the sidebar's own state.
+			// api.getConfiguration() always reads the sidebar provider.
+			assert.strictEqual(globalThis.api.getConfiguration().mode, "ask")
+
+			const viewStates = globalThis.api.getGlobalState("viewStates") as GlobalState["viewStates"]
+			assert.ok(viewStates, "Expected persisted viewStates to exist")
+
+			const persistedEntries = Object.entries(viewStates)
+			assert.ok(persistedEntries.length >= 2, "Expected at least sidebar and tab persisted view state entries")
+			assert.ok(
+				persistedEntries.some(([, entry]) => entry.mode === "ask"),
+				"Expected one persisted view state entry for the sidebar ask mode",
+			)
+			assert.ok(
+				persistedEntries.some(([, entry]) => entry.mode === "debug"),
+				"Expected one persisted view state entry for the tab debug mode",
+			)
+
+			for (const [viewStateId, entry] of persistedEntries) {
+				const secretStatePath = findSecretStatePath(entry)
+				assert.strictEqual(
+					secretStatePath,
+					undefined,
+					`Persisted viewStates.${viewStateId} leaked secret state at ${secretStatePath}`,
+				)
+			}
+		} finally {
+			globalThis.api.off(RooCodeEventName.Message, completionHandler)
+		}
+	})
+})

packages/types/src/api.ts

@@ -2,7 +2,7 @@ import type { EventEmitter } from "events"
 import type { Socket } from "net"
 
 import type { RooCodeEvents } from "./events.js"
-import type { RooCodeSettings } from "./global-settings.js"
+import type { GlobalState, RooCodeSettings } from "./global-settings.js"
 import type { HistoryItem } from "./history.js"
 import type { ProviderSettingsEntry, ProviderSettings } from "./provider-settings.js"
 import type { IpcMessage, IpcServerEvents } from "./ipc.js"
@@ -92,6 +92,10 @@ export interface RooCodeAPI extends EventEmitter<RooCodeAPIEvents> {
 	 * confirming a completion result. No-ops if no task is active.
 	 */
 	approveCurrentAsk(): Promise<void>
+	/**
+	 * Programmatically approves the pending ask for a task by ID. Intended for use in tests only.
+	 */
+	approveTaskAsk(taskId: string): Promise<boolean>
 	/**
 	 * Returns true if the API is ready to use.
 	 */
@@ -106,6 +110,10 @@ export interface RooCodeAPI extends EventEmitter<RooCodeAPIEvents> {
 	 * @param values An object containing key-value pairs to set.
 	 */
 	setConfiguration(values: RooCodeSettings): Promise<void>
+	/**
+	 * Returns a value from VS Code globalState. Intended for use in tests only.
+	 */
+	getGlobalState<K extends keyof GlobalState>(key: K): GlobalState[K]
 	/**
 	 * Returns a list of all configured profile names
 	 * @returns Array of profile names

src/core/webview/ClineProvider.ts

@@ -3097,7 +3097,7 @@ export class ClineProvider
 	}
 
 	public getValues() {
-		return this.contextProxy.getValues()
+		return { ...this.contextProxy.getValues(), ...this.viewLocalState }
 	}
 
 	public async setValues(values: RooCodeSettings) {

src/extension/api.ts

@@ -8,6 +8,7 @@ import pWaitFor from "p-wait-for"
 
 import {
 	type RooCodeAPI,
+	type GlobalState,
 	type RooCodeSettings,
 	type RooCodeEvents,
 	type ProviderSettings,
@@ -35,6 +36,7 @@ export class API extends EventEmitter<RooCodeEvents> implements RooCodeAPI {
 	private readonly sidebarProvider: ClineProvider
 	private readonly context: vscode.ExtensionContext
 	private readonly ipc?: IpcServer
+	private readonly tasksById = new Map<string, { approveAsk(): void }>()
 	private readonly log: (...args: unknown[]) => void
 	private logfile?: string
 
@@ -309,6 +311,17 @@ export class API extends EventEmitter<RooCodeEvents> implements RooCodeAPI {
 		this.sidebarProvider.getCurrentTask()?.approveAsk()
 	}
 
+	public async approveTaskAsk(taskId: string): Promise<boolean> {
+		const task = this.tasksById.get(taskId)
+
+		if (!task) {
+			return false
+		}
+
+		task.approveAsk()
+		return true
+	}
+
 	public isReady() {
 		return this.sidebarProvider.viewLaunched
 	}
@@ -329,6 +342,8 @@ export class API extends EventEmitter<RooCodeEvents> implements RooCodeAPI {
 
 	private registerListeners(provider: ClineProvider) {
 		provider.on(RooCodeEventName.TaskCreated, (task) => {
+			this.tasksById.set(task.taskId, task)
+
 			// Task Lifecycle
 
 			task.on(RooCodeEventName.TaskStarted, async () => {
@@ -340,6 +355,7 @@ export class API extends EventEmitter<RooCodeEvents> implements RooCodeAPI {
 				this.emit(RooCodeEventName.TaskCompleted, task.taskId, tokenUsage, toolUsage, {
 					isSubtask: !!task.parentTaskId,
 				})
+				this.tasksById.delete(task.taskId)
 
 				await this.fileLog(
 					`[${new Date().toISOString()}] taskCompleted -> ${task.taskId} | ${JSON.stringify(tokenUsage, null, 2)} | ${JSON.stringify(toolUsage, null, 2)}\n`,
@@ -348,6 +364,7 @@ export class API extends EventEmitter<RooCodeEvents> implements RooCodeAPI {
 
 			task.on(RooCodeEventName.TaskAborted, () => {
 				this.emit(RooCodeEventName.TaskAborted, task.taskId)
+				this.tasksById.delete(task.taskId)
 			})
 
 			task.on(RooCodeEventName.TaskFocused, () => {
@@ -508,6 +525,10 @@ export class API extends EventEmitter<RooCodeEvents> implements RooCodeAPI {
 		await this.sidebarProvider.postStateToWebview()
 	}
 
+	public getGlobalState<K extends keyof GlobalState>(key: K): GlobalState[K] {
+		return this.context.globalState.get<GlobalState[K]>(key)
+	}
+
 	public setTerminalProfile(name: string | undefined): void {
 		const previousProfile = Terminal.getTerminalProfile()
 		Terminal.setTerminalProfile(name)