Skip to content

Commit 842b37e

Browse files
authored
fix(webview): route code actions to the last active chat (Zoo-Code-Org#1946)
* fix(webview): route code actions to the last active chat (Zoo-Code-Org#1944) * test(webview): cover shared focus tracker wiring and cleanup * fix(webview): isolate focus tracker listener cleanup failures * refactor(api): inject provider factory for editor chats * test(webview): assert distinct provider factory results * fix(webview): fall back when the last active chat is hidden
1 parent e69c6a6 commit 842b37e

46 files changed

Lines changed: 1893 additions & 73 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/types/src/vscode-extension-host.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,7 @@ export interface WebviewMessage {
473473
| "getListApiConfiguration"
474474
| "customInstructions"
475475
| "webviewDidLaunch"
476+
| "webviewDidFocus"
476477
| "newTask"
477478
| "askResponse"
478479
| "terminalOperation"

‎src/__tests__/api-subtask.spec.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ vi.mock("@roo-code/ipc", () => ({
2929
vi.mock("../services/command/commands", () => ({ getCommands: vi.fn().mockResolvedValue([]) }))
3030

3131
import { API } from "../extension/api"
32+
import { makeClineProviderFactory } from "../test-utils/provider"
3233

3334
function makeProviderMock() {
3435
const emitter = new EventEmitter()
@@ -63,7 +64,7 @@ describe("API.clearCurrentTask()", () => {
6364
beforeEach(() => {
6465
vi.clearAllMocks()
6566
provider = makeProviderMock()
66-
api = new API({} as any, provider as any)
67+
api = new API({} as any, provider as any, makeClineProviderFactory())
6768
})
6869

6970
it("calls evictCurrentTask then postStateToWebview on sidebarProvider", async () => {
@@ -84,7 +85,7 @@ describe("API.abandonSubtask()", () => {
8485
beforeEach(() => {
8586
vi.clearAllMocks()
8687
provider = makeProviderMock()
87-
api = new API({} as any, provider as any)
88+
api = new API({} as any, provider as any, makeClineProviderFactory())
8889
})
8990

9091
it("delegates to sidebarProvider.abandonSubtask and returns its result", async () => {

‎src/__tests__/extension.spec.ts‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
// npx vitest run __tests__/extension.spec.ts
22

33
import type * as vscode from "vscode"
4+
import type { WebviewMessage } from "@roo-code/types"
5+
6+
import { makeCompositeDisposable, makeEventEmitter, makeExtensionContext } from "../test-utils/vscode"
47

58
vi.mock("vscode", () => ({
9+
Disposable: { from: (...subscriptions: vscode.Disposable[]) => makeCompositeDisposable(...subscriptions) },
610
window: {
711
createOutputChannel: vi.fn().mockReturnValue({
812
appendLine: vi.fn(),
@@ -166,6 +170,8 @@ vi.mock("../extension/api", () => ({
166170
}),
167171
}))
168172

173+
vi.mock("../activate/registerCommands", () => ({ openClineInNewTab: vi.fn() }))
174+
169175
vi.mock("../activate", () => ({
170176
handleUri: vi.fn(),
171177
registerCommands: vi.fn(),
@@ -239,6 +245,103 @@ describe("extension.ts", () => {
239245
settingsUpdatedHandler = undefined
240246
})
241247

248+
test("shares the extension-owned focus tracker with the sidebar and code actions and disposes its listeners", async () => {
249+
vi.resetModules()
250+
const { WebviewFocusTracker } = await import("../core/webview/WebviewFocusTracker")
251+
const { ClineProvider } = await import("../core/webview/ClineProvider")
252+
const { ContextProxy } = await import("../core/config/ContextProxy")
253+
const { registerCodeActions } = await import("../activate")
254+
const vscode = await import("vscode")
255+
const { activate } = await import("../extension")
256+
257+
await activate(mockContext)
258+
259+
const trackers = mockContext.subscriptions.filter((entry) => entry instanceof WebviewFocusTracker)
260+
expect(trackers).toHaveLength(1)
261+
const tracker = trackers[0]
262+
const outputChannel = vi.mocked(vscode.window.createOutputChannel).mock.results[0].value
263+
expect(ClineProvider).toHaveBeenCalledExactlyOnceWith(
264+
mockContext,
265+
outputChannel,
266+
"sidebar",
267+
await ContextProxy.getInstance(mockContext),
268+
tracker,
269+
null,
270+
)
271+
expect(registerCodeActions).toHaveBeenCalledExactlyOnceWith(mockContext, tracker)
272+
273+
const messages = makeEventEmitter<WebviewMessage>()
274+
const disposed = makeEventEmitter<void>()
275+
const provider = ClineProvider.getVisibleInstance()!
276+
tracker.init(provider, { webview: { onDidReceiveMessage: messages.event }, onDidDispose: disposed.event })
277+
messages.fire({ type: "webviewDidFocus" })
278+
expect(tracker.getLastActiveProvider()).toBe(provider)
279+
280+
// Dispose the exact instance owned by the extension, rather than a separate test tracker.
281+
tracker.dispose()
282+
messages.fire({ type: "webviewDidFocus" })
283+
expect(tracker.getLastActiveProvider()).toBeUndefined()
284+
})
285+
286+
test("keeps focus trackers independent across extension activations", async () => {
287+
vi.resetModules()
288+
const { WebviewFocusTracker } = await import("../core/webview/WebviewFocusTracker")
289+
const { registerCodeActions } = await import("../activate")
290+
const { activate } = await import("../extension")
291+
const secretChanges = makeEventEmitter<vscode.SecretStorageChangeEvent>()
292+
const secondContext = makeExtensionContext({
293+
secrets: {
294+
get: vi.fn().mockResolvedValue(undefined),
295+
store: vi.fn().mockResolvedValue(undefined),
296+
delete: vi.fn().mockResolvedValue(undefined),
297+
onDidChange: secretChanges.event,
298+
},
299+
})
300+
301+
await activate(mockContext)
302+
await activate(secondContext)
303+
304+
const firstTracker = mockContext.subscriptions.find((entry) => entry instanceof WebviewFocusTracker)
305+
const secondTracker = secondContext.subscriptions.find((entry) => entry instanceof WebviewFocusTracker)
306+
expect(firstTracker).toBeInstanceOf(WebviewFocusTracker)
307+
expect(secondTracker).toBeInstanceOf(WebviewFocusTracker)
308+
expect(secondTracker).not.toBe(firstTracker)
309+
expect(registerCodeActions).toHaveBeenNthCalledWith(1, mockContext, firstTracker)
310+
expect(registerCodeActions).toHaveBeenNthCalledWith(2, secondContext, secondTracker)
311+
firstTracker?.dispose()
312+
secondTracker?.dispose()
313+
secretChanges.dispose()
314+
})
315+
316+
test("injects a factory instance with this activation's dependencies without reading the sidebar tracker", async () => {
317+
vi.resetModules()
318+
const { API } = await import("../extension/api")
319+
const { openClineInNewTab } = await import("../activate/registerCommands")
320+
const { ClineProviderFactory } = await import("../core/webview/ClineProviderFactory")
321+
const { WebviewFocusTracker } = await import("../core/webview/WebviewFocusTracker")
322+
const { ClineProvider } = await import("../core/webview/ClineProvider")
323+
const { activate } = await import("../extension")
324+
const vscode = await import("vscode")
325+
await activate(mockContext)
326+
327+
const tracker = mockContext.subscriptions.find((entry) => entry instanceof WebviewFocusTracker)
328+
const outputChannel = vi.mocked(vscode.window.createOutputChannel).mock.results[0].value
329+
const sidebar = vi.mocked(ClineProvider).mock.results[0].value
330+
const providerFactory = vi.mocked(API).mock.calls[0][2]
331+
expect(providerFactory).toBeInstanceOf(ClineProviderFactory)
332+
expect(sidebar.webviewFocusTracker).toBeUndefined()
333+
expect(openClineInNewTab).not.toHaveBeenCalled()
334+
vi.mocked(openClineInNewTab).mockResolvedValueOnce(sidebar)
335+
336+
await expect(providerFactory.createInNewTab()).resolves.toBe(sidebar)
337+
expect(openClineInNewTab).toHaveBeenCalledExactlyOnceWith({
338+
context: mockContext,
339+
outputChannel,
340+
webviewFocusTracker: tracker,
341+
})
342+
tracker?.dispose()
343+
})
344+
242345
test("initializes the code index scope and registers it for extension cleanup", async () => {
243346
vi.resetModules()
244347
const { CodeIndexScope } = await import("../services/code-index/code-index-scope")

‎src/__tests__/single-open-invariant.spec.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { type Task } from "../core/task/Task"
99
import { API } from "../extension/api"
1010
import * as ProfileValidatorMod from "../shared/ProfileValidator"
1111
import { providerIdentifiers } from "@roo-code/types/provider-identifiers"
12+
import { makeClineProviderFactory } from "../test-utils/provider"
1213

1314
type PrivateClineProviderMethods = {
1415
createTask: (
@@ -406,7 +407,7 @@ describe("Single-open-task invariant", () => {
406407
} as unknown as ClineProvider
407408

408409
const output = { appendLine: vi.fn() } as unknown as OutputChannel
409-
const api = new API(output, provider, undefined, false)
410+
const api = new API(output, provider, makeClineProviderFactory(), undefined, false)
410411

411412
const taskId = await api.startNewTask({
412413
configuration: {},
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
import * as vscode from "vscode"
2+
3+
import { handleNewTask } from "../handleTask"
4+
import { ClineProvider } from "../../core/webview/ClineProvider"
5+
import { WebviewFocusTracker } from "../../core/webview/WebviewFocusTracker"
6+
import { Package } from "../../shared/package"
7+
8+
vi.mock("vscode", () => ({
9+
window: { showInputBox: vi.fn() },
10+
commands: { executeCommand: vi.fn().mockResolvedValue(undefined) },
11+
}))
12+
vi.mock("../../core/webview/ClineProvider", () => ({
13+
ClineProvider: class {
14+
static getInstance = vi.fn()
15+
get isViewVisible() {
16+
return true
17+
}
18+
},
19+
}))
20+
vi.mock("../../i18n", () => ({ t: (key: string) => key }))
21+
22+
describe("handleNewTask", () => {
23+
let provider: ClineProvider
24+
let tracker: WebviewFocusTracker
25+
26+
beforeEach(() => {
27+
vi.clearAllMocks()
28+
tracker = new WebviewFocusTracker()
29+
provider = Object.create(ClineProvider.prototype) as ClineProvider
30+
provider.handleCodeAction = vi.fn().mockResolvedValue(undefined)
31+
vi.mocked(ClineProvider.getInstance).mockResolvedValue(provider)
32+
vi.mocked(vscode.window.showInputBox).mockResolvedValue(undefined)
33+
})
34+
35+
it("executes the supplied prompt on the resolved provider", async () => {
36+
await handleNewTask({ prompt: "new task" }, tracker)
37+
expect(ClineProvider.getInstance).toHaveBeenCalledOnce()
38+
expect(vscode.window.showInputBox).not.toHaveBeenCalled()
39+
expect(provider.handleCodeAction).toHaveBeenCalledWith("newTask", "NEW_TASK", { userInput: "new task" })
40+
})
41+
42+
it("executes the prompt entered in the input dialog", async () => {
43+
vi.mocked(vscode.window.showInputBox).mockResolvedValue("entered task")
44+
await handleNewTask(undefined, tracker)
45+
expect(provider.handleCodeAction).toHaveBeenCalledWith("newTask", "NEW_TASK", { userInput: "entered task" })
46+
})
47+
48+
it("focuses the sidebar without executing an action when input is cancelled", async () => {
49+
const getLastActive = vi.spyOn(tracker, "getLastActiveProvider")
50+
await handleNewTask(undefined, tracker)
51+
expect(vscode.commands.executeCommand).toHaveBeenCalledWith(`${Package.name}.SidebarProvider.focus`)
52+
expect(ClineProvider.getInstance).not.toHaveBeenCalled()
53+
expect(getLastActive).not.toHaveBeenCalled()
54+
expect(provider.handleCodeAction).not.toHaveBeenCalled()
55+
})
56+
57+
it("does nothing when no provider can be resolved", async () => {
58+
vi.mocked(ClineProvider.getInstance).mockResolvedValue(undefined)
59+
await handleNewTask({ prompt: "new task" }, tracker)
60+
expect(provider.handleCodeAction).not.toHaveBeenCalled()
61+
})
62+
63+
it("awaits the provider action and propagates its error", async () => {
64+
const error = new Error("Task creation failed")
65+
vi.mocked(provider.handleCodeAction).mockRejectedValue(error)
66+
await expect(handleNewTask({ prompt: "new task" }, tracker)).rejects.toBe(error)
67+
})
68+
69+
it.each(["supplied", "dialog"])(
70+
"uses the last active visible chat for a %s prompt without resolving another provider",
71+
async (source) => {
72+
vi.spyOn(tracker, "getLastActiveProvider").mockReturnValue(provider)
73+
const fallback = Object.create(ClineProvider.prototype) as ClineProvider
74+
fallback.handleCodeAction = vi.fn().mockResolvedValue(undefined)
75+
vi.mocked(ClineProvider.getInstance).mockResolvedValue(fallback)
76+
vi.mocked(vscode.window.showInputBox).mockResolvedValue("new task")
77+
await handleNewTask(source === "supplied" ? { prompt: "new task" } : undefined, tracker)
78+
expect(provider.handleCodeAction).toHaveBeenCalledWith("newTask", "NEW_TASK", { userInput: "new task" })
79+
expect(ClineProvider.getInstance).not.toHaveBeenCalled()
80+
expect(fallback.handleCodeAction).not.toHaveBeenCalled()
81+
},
82+
)
83+
84+
it.each(["supplied", "dialog"])(
85+
"uses the fallback for a %s prompt when the last active chat is hidden",
86+
async (source) => {
87+
vi.spyOn(provider, "isViewVisible", "get").mockReturnValue(false)
88+
vi.spyOn(tracker, "getLastActiveProvider").mockReturnValue(provider)
89+
const fallback = Object.create(ClineProvider.prototype) as ClineProvider
90+
fallback.handleCodeAction = vi.fn().mockResolvedValue(undefined)
91+
vi.mocked(ClineProvider.getInstance).mockResolvedValue(fallback)
92+
vi.mocked(vscode.window.showInputBox).mockResolvedValue("new task")
93+
94+
await handleNewTask(source === "supplied" ? { prompt: "new task" } : undefined, tracker)
95+
96+
expect(ClineProvider.getInstance).toHaveBeenCalledOnce()
97+
expect(provider.handleCodeAction).not.toHaveBeenCalled()
98+
expect(fallback.handleCodeAction).toHaveBeenCalledExactlyOnceWith("newTask", "NEW_TASK", {
99+
userInput: "new task",
100+
})
101+
},
102+
)
103+
104+
it.each(["supplied", "dialog"])(
105+
"does not execute a %s prompt on a hidden chat when fallback finds no provider",
106+
async (source) => {
107+
vi.spyOn(provider, "isViewVisible", "get").mockReturnValue(false)
108+
vi.spyOn(tracker, "getLastActiveProvider").mockReturnValue(provider)
109+
vi.mocked(ClineProvider.getInstance).mockResolvedValue(undefined)
110+
vi.mocked(vscode.window.showInputBox).mockResolvedValue("new task")
111+
112+
await expect(
113+
handleNewTask(source === "supplied" ? { prompt: "new task" } : undefined, tracker),
114+
).resolves.toBeUndefined()
115+
116+
expect(ClineProvider.getInstance).toHaveBeenCalledOnce()
117+
expect(provider.handleCodeAction).not.toHaveBeenCalled()
118+
},
119+
)
120+
})

0 commit comments

Comments
 (0)