Skip to content

Commit 3730aeb

Browse files
committed
refactor(code-index): route workspace actions through scopes
Extract workspace indexing enablement coordination and status publication. Expose complete workspace scopes and replace direct manager access in webview handlers. Refs #1594
1 parent 269d490 commit 3730aeb

9 files changed

Lines changed: 294 additions & 44 deletions

‎src/core/webview/ClineProvider.ts‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ import { McpHub } from "../../services/mcp/McpHub"
9090
import { McpServerManager } from "../../services/mcp/McpServerManager"
9191
import { MarketplaceManager } from "../../services/marketplace"
9292
import { ShadowCheckpointService } from "../../services/checkpoints/ShadowCheckpointService"
93-
import type { CodeIndexManager } from "../../services/code-index/manager"
9493
import { CodeIndexManagerRegistry } from "../../services/code-index/code-index-manager-registry"
94+
import type { CodeIndexWorkspaceScope } from "../../services/code-index/code-index-workspace-scope"
9595
import { MdmService } from "../../services/mdm/MdmService"
9696
import { SkillsManager } from "../../services/skills/SkillsManager"
9797

@@ -3287,12 +3287,8 @@ export class ClineProvider
32873287
return true
32883288
}
32893289

3290-
/**
3291-
* Gets the CodeIndexManager for the current active workspace
3292-
* @returns CodeIndexManager instance for the current workspace or the default one
3293-
*/
3294-
public getCurrentWorkspaceCodeIndexManager(): CodeIndexManager | undefined {
3295-
return CodeIndexManagerRegistry.getOrCreate(this.context)
3290+
public getCurrentWorkspaceCodeIndexScope(): CodeIndexWorkspaceScope | undefined {
3291+
return CodeIndexManagerRegistry.getOrCreateScope(this.context)
32963292
}
32973293

32983294
/**

‎src/core/webview/__tests__/ClineProvider.spec.ts‎

Lines changed: 91 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { defaultModeSlug } from "../../../shared/modes"
2727
import { experimentDefault } from "../../../shared/experiments"
2828
import { setTtsEnabled } from "../../../utils/tts"
2929
import { ContextProxy } from "../../config/ContextProxy"
30+
import { WorkspaceIndexingEnablementManager } from "../../../services/code-index/workspace-indexing-enablement-manager"
3031
import { Task, TaskOptions } from "../../task/Task"
3132
import { safeWriteJson } from "../../../utils/safeWriteJson"
3233

@@ -2966,7 +2967,7 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
29662967
postMessageToWebview: vi.fn().mockResolvedValue(true),
29672968
postStateToWebview: vi.fn().mockResolvedValue(undefined),
29682969
getCurrentTask: vi.fn(),
2969-
getCurrentWorkspaceCodeIndexManager: vi.fn(),
2970+
getCurrentWorkspaceCodeIndexScope: vi.fn(),
29702971
getMcpHub: vi.fn().mockReturnValue({
29712972
getMcpSettingsFilePath: vi.fn().mockResolvedValue("/test/mcp.json"),
29722973
}),
@@ -3022,10 +3023,11 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
30223023
startIndexing: vi.fn().mockReturnValue(indexingPromise),
30233024
})
30243025
const provider = createProvider({
3025-
getCurrentWorkspaceCodeIndexManager: vi.fn().mockReturnValue(manager),
3026+
getCurrentWorkspaceCodeIndexScope: vi.fn().mockReturnValue({ codeIndexManager: manager }),
30263027
})
30273028

30283029
await expect(webviewMessageHandler(provider, { type: "startIndexing" })).resolves.toBeUndefined()
3030+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
30293031
expect(manager.startIndexing).toHaveBeenCalledOnce()
30303032

30313033
rejectIndexing(new Error("boom"))
@@ -3179,14 +3181,29 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
31793181

31803182
it("covers changed indexing status, secret, and missing-manager responses", async () => {
31813183
const manager = createIndexManager()
3182-
const getManager = vi.fn().mockReturnValueOnce(undefined).mockReturnValue(manager)
3183-
const provider = createProvider({ getCurrentWorkspaceCodeIndexManager: getManager })
3184+
const getScope = vi.fn().mockReturnValueOnce(undefined).mockReturnValue({ codeIndexManager: manager })
3185+
const provider = createProvider({
3186+
getCurrentWorkspaceCodeIndexScope: getScope,
3187+
})
31843188

31853189
await webviewMessageHandler(provider, { type: "requestIndexingStatus" })
3190+
expect(manager.getCurrentStatus).not.toHaveBeenCalled()
3191+
expect(provider.postMessageToWebview).toHaveBeenCalledWith({
3192+
type: "indexingStatusUpdate",
3193+
values: expect.objectContaining({ systemStatus: "Error", message: expect.any(String) }),
3194+
})
31863195
await webviewMessageHandler(provider, { type: "requestIndexingStatus" })
3196+
expect(getScope).toHaveBeenCalledTimes(2)
3197+
expect(manager.getCurrentStatus).toHaveBeenCalledOnce()
3198+
expect(provider.postMessageToWebview).toHaveBeenLastCalledWith({
3199+
type: "indexingStatusUpdate",
3200+
values: manager.getCurrentStatus.mock.results[0].value,
3201+
})
31873202
await webviewMessageHandler(provider, { type: "requestCodeIndexSecretStatus" })
3188-
getManager.mockReturnValueOnce(undefined)
3203+
getScope.mockReturnValueOnce(undefined)
31893204
await webviewMessageHandler(provider, { type: "startIndexing" })
3205+
expect(getScope).toHaveBeenCalledTimes(3)
3206+
expect(manager.setWorkspaceEnabled).not.toHaveBeenCalled()
31903207

31913208
expect(provider.postMessageToWebview).toHaveBeenCalledWith(
31923209
expect.objectContaining({ type: "codeIndexSecretStatus" }),
@@ -3203,7 +3220,7 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
32033220
.mockRejectedValueOnce(new Error("second failure")),
32043221
})
32053222
const provider = createProvider({
3206-
getCurrentWorkspaceCodeIndexManager: vi.fn().mockReturnValue(manager),
3223+
getCurrentWorkspaceCodeIndexScope: vi.fn().mockReturnValue({ codeIndexManager: manager }),
32073224
})
32083225

32093226
await webviewMessageHandler(provider, { type: "startIndexing" })
@@ -3219,10 +3236,18 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
32193236
startIndexing: vi.fn().mockRejectedValue(new Error("toggle failure")),
32203237
})
32213238
const provider = createProvider({
3222-
getCurrentWorkspaceCodeIndexManager: vi.fn().mockReturnValue(manager),
3239+
getCurrentWorkspaceCodeIndexScope: vi.fn().mockReturnValue({
3240+
codeIndexManager: manager,
3241+
workspaceIndexingEnablementManager: new WorkspaceIndexingEnablementManager(manager),
3242+
}),
32233243
})
32243244

32253245
await webviewMessageHandler(provider, { type: "stopIndexing" })
3246+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
3247+
expect(provider.postMessageToWebview).toHaveBeenCalledExactlyOnceWith({
3248+
type: "indexingStatusUpdate",
3249+
values: manager.getCurrentStatus(),
3250+
})
32263251
await webviewMessageHandler(provider, { type: "toggleWorkspaceIndexing", bool: true })
32273252
await Promise.resolve()
32283253

@@ -3233,6 +3258,53 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
32333258
)
32343259
})
32353260

3261+
it("does not stop indexing or publish status without a workspace scope", async () => {
3262+
const provider = createProvider()
3263+
await webviewMessageHandler(provider, { type: "stopIndexing" })
3264+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
3265+
expect(provider.log).toHaveBeenCalledWith("Cannot stop indexing: No workspace folder open")
3266+
expect(provider.postMessageToWebview).not.toHaveBeenCalled()
3267+
})
3268+
3269+
it.each([true, false])("resolves the scope after saving index settings (workspace=%s)", async (hasWorkspace) => {
3270+
const handleSettingsChange = vi.fn().mockResolvedValue(undefined)
3271+
const manager = createIndexManager({ handleSettingsChange, isFeatureEnabled: false })
3272+
const provider = createProvider({
3273+
getCurrentWorkspaceCodeIndexScope: vi
3274+
.fn()
3275+
.mockReturnValue(hasWorkspace ? { codeIndexManager: manager } : undefined),
3276+
})
3277+
3278+
await webviewMessageHandler(provider, {
3279+
type: "saveCodeIndexSettingsAtomic",
3280+
codeIndexSettings: {
3281+
codebaseIndexEnabled: false,
3282+
codebaseIndexQdrantUrl: "http://localhost:6333",
3283+
codebaseIndexEmbedderProvider: providerIdentifiers.openai,
3284+
codebaseIndexEmbedderModelId: "text-embedding-3-small",
3285+
},
3286+
})
3287+
3288+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
3289+
expect(provider.postMessageToWebview).toHaveBeenCalledWith(
3290+
expect.objectContaining({ type: "codeIndexSettingsSaved", success: true }),
3291+
)
3292+
if (hasWorkspace) {
3293+
expect(handleSettingsChange).toHaveBeenCalledOnce()
3294+
} else {
3295+
expect(handleSettingsChange).not.toHaveBeenCalled()
3296+
expect(provider.log).toHaveBeenCalledWith("Cannot save code index settings: No workspace folder open")
3297+
}
3298+
})
3299+
3300+
it("does not update auto-enable defaults without a workspace scope", async () => {
3301+
const provider = createProvider()
3302+
await webviewMessageHandler(provider, { type: "setAutoEnableDefault", bool: true })
3303+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
3304+
expect(provider.log).toHaveBeenCalledWith("Cannot set auto-enable default: No workspace folder open")
3305+
expect(provider.postMessageToWebview).not.toHaveBeenCalled()
3306+
})
3307+
32363308
it("catches auto-enabled indexing failures and posts the resulting status", async () => {
32373309
const { CodeIndexManagerRegistry } = await import("../../../services/code-index/code-index-manager-registry")
32383310
let workspaceEnabled = false
@@ -3247,13 +3319,14 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
32473319
.spyOn(CodeIndexManagerRegistry, "getAllInstances")
32483320
.mockReturnValue([manager] as unknown as ReturnType<typeof CodeIndexManagerRegistry.getAllInstances>)
32493321
const provider = createProvider({
3250-
getCurrentWorkspaceCodeIndexManager: vi.fn().mockReturnValue(manager),
3322+
getCurrentWorkspaceCodeIndexScope: vi.fn().mockReturnValue({ codeIndexManager: manager }),
32513323
})
32523324

32533325
try {
32543326
await webviewMessageHandler(provider, { type: "setAutoEnableDefault", bool: true })
32553327
await Promise.resolve()
32563328

3329+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
32573330
expect(manager.startIndexing).toHaveBeenCalledOnce()
32583331
expect(provider.log).toHaveBeenCalledWith("Indexing error: Error: auto-enable failure")
32593332
expect(provider.postMessageToWebview).toHaveBeenCalledWith(
@@ -3266,14 +3339,22 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
32663339

32673340
it("covers changed clear-index response paths", async () => {
32683341
const manager = createIndexManager()
3269-
const getManager = vi.fn().mockReturnValueOnce(undefined).mockReturnValue(manager)
3270-
const provider = createProvider({ getCurrentWorkspaceCodeIndexManager: getManager })
3342+
const getScope = vi.fn().mockReturnValueOnce(undefined).mockReturnValue({ codeIndexManager: manager })
3343+
const provider = createProvider({ getCurrentWorkspaceCodeIndexScope: getScope })
32713344

32723345
await webviewMessageHandler(provider, { type: "clearIndexData" })
3346+
expect(manager.clearIndexData).not.toHaveBeenCalled()
3347+
expect(provider.log).toHaveBeenCalledWith("Cannot clear index data: No workspace folder open")
3348+
expect(provider.postMessageToWebview).toHaveBeenCalledExactlyOnceWith({
3349+
type: "indexCleared",
3350+
values: { success: false, error: expect.any(String) },
3351+
})
32733352
await webviewMessageHandler(provider, { type: "clearIndexData" })
32743353
manager.clearIndexData.mockRejectedValueOnce(new Error("clear failed"))
32753354
await webviewMessageHandler(provider, { type: "clearIndexData" })
32763355

3356+
expect(getScope).toHaveBeenCalledTimes(3)
3357+
expect(manager.clearIndexData).toHaveBeenCalledTimes(2)
32773358
expect(provider.postMessageToWebview).toHaveBeenCalledWith({
32783359
type: "indexCleared",
32793360
values: { success: true },

‎src/core/webview/webviewMessageHandler.ts‎

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3078,7 +3078,8 @@ export const webviewMessageHandler = async (
30783078
await provider.postStateToWebview()
30793079

30803080
// Then handle validation and initialization for the current workspace
3081-
const currentCodeIndexManager = provider.getCurrentWorkspaceCodeIndexManager()
3081+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3082+
const currentCodeIndexManager = scope?.codeIndexManager
30823083
if (currentCodeIndexManager) {
30833084
// If embedder provider changed, perform proactive validation
30843085
if (embedderProviderChanged) {
@@ -3157,7 +3158,8 @@ export const webviewMessageHandler = async (
31573158
}
31583159

31593160
case "requestIndexingStatus": {
3160-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3161+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3162+
const manager = scope?.codeIndexManager
31613163
if (!manager) {
31623164
// No workspace open - send error status
31633165
await provider.postMessageToWebview({
@@ -3221,7 +3223,8 @@ export const webviewMessageHandler = async (
32213223
}
32223224
case "startIndexing": {
32233225
try {
3224-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3226+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3227+
const manager = scope?.codeIndexManager
32253228
if (!manager) {
32263229
await provider.postMessageToWebview({
32273230
type: "indexingStatusUpdate",
@@ -3262,15 +3265,15 @@ export const webviewMessageHandler = async (
32623265
}
32633266
case "stopIndexing": {
32643267
try {
3265-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3266-
if (!manager) {
3268+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3269+
if (!scope) {
32673270
provider.log("Cannot stop indexing: No workspace folder open")
32683271
return
32693272
}
3270-
manager.stopIndexing()
3273+
scope.codeIndexManager.stopIndexing()
32713274
await provider.postMessageToWebview({
32723275
type: "indexingStatusUpdate",
3273-
values: manager.getCurrentStatus(),
3276+
values: scope.codeIndexManager.getCurrentStatus(),
32743277
})
32753278
} catch (error) {
32763279
provider.log(`Error stopping indexing: ${error instanceof Error ? error.message : String(error)}`)
@@ -3279,23 +3282,12 @@ export const webviewMessageHandler = async (
32793282
}
32803283
case "toggleWorkspaceIndexing": {
32813284
try {
3282-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3283-
if (!manager) {
3285+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3286+
if (!scope) {
32843287
provider.log("Cannot toggle workspace indexing: No workspace folder open")
32853288
return
32863289
}
3287-
const enabled = message.bool ?? false
3288-
await manager.setWorkspaceEnabled(enabled)
3289-
if (enabled && manager.isFeatureEnabled && manager.isFeatureConfigured) {
3290-
await manager.initialize(provider.contextProxy)
3291-
void manager.startIndexing().catch((err) => provider.log(`Indexing error: ${err}`))
3292-
} else if (!enabled) {
3293-
manager.stopIndexing()
3294-
}
3295-
await provider.postMessageToWebview({
3296-
type: "indexingStatusUpdate",
3297-
values: manager.getCurrentStatus(),
3298-
})
3290+
await scope.workspaceIndexingEnablementManager.setEnabled(message.bool ?? false, provider)
32993291
} catch (error) {
33003292
provider.log(
33013293
`Error toggling workspace indexing: ${error instanceof Error ? error.message : String(error)}`,
@@ -3305,7 +3297,8 @@ export const webviewMessageHandler = async (
33053297
}
33063298
case "setAutoEnableDefault": {
33073299
try {
3308-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3300+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3301+
const manager = scope?.codeIndexManager
33093302
if (!manager) {
33103303
provider.log("Cannot set auto-enable default: No workspace folder open")
33113304
return
@@ -3338,8 +3331,8 @@ export const webviewMessageHandler = async (
33383331
}
33393332
case "clearIndexData": {
33403333
try {
3341-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3342-
if (!manager) {
3334+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3335+
if (!scope) {
33433336
provider.log("Cannot clear index data: No workspace folder open")
33443337
await provider.postMessageToWebview({
33453338
type: "indexCleared",
@@ -3350,7 +3343,7 @@ export const webviewMessageHandler = async (
33503343
})
33513344
return
33523345
}
3353-
await manager.clearIndexData()
3346+
await scope.codeIndexManager.clearIndexData()
33543347
await provider.postMessageToWebview({ type: "indexCleared", values: { success: true } })
33553348
} catch (error) {
33563349
provider.log(`Error clearing index data: ${error instanceof Error ? error.message : String(error)}`)

‎src/services/code-index/__tests__/code-index-manager-registry.spec.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,21 @@ describe("CodeIndexManagerRegistry", () => {
4343
it.each([{ folders: undefined }, { folders: [] }])("returns no manager with folders=$folders", ({ folders }) => {
4444
Object.defineProperty(vscode.workspace, "workspaceFolders", { configurable: true, value: folders })
4545
expect(CodeIndexManagerRegistry.getOrCreate(context)).toBeUndefined()
46+
expect(CodeIndexManagerRegistry.getOrCreateScope(context)).toBeUndefined()
4647
expect(CodeIndexManager).not.toHaveBeenCalled()
4748
})
4849

50+
it("returns the complete cached scope shared with the manager API", () => {
51+
const scope = CodeIndexManagerRegistry.getOrCreateScope(context)!
52+
expect(scope).toBeInstanceOf(CodeIndexWorkspaceScope)
53+
expect(scope.workspaceIndexingEnablementManager).toBeDefined()
54+
expect(CodeIndexManagerRegistry.getOrCreateScope(context, "/first")).toBe(scope)
55+
expect(CodeIndexManagerRegistry.getOrCreate(context)).toBe(scope.codeIndexManager)
56+
expect(CodeIndexManagerRegistry.getOrCreateScope(context, "/second")).not.toBe(scope)
57+
CodeIndexManagerRegistry.disposeAll()
58+
expect(CodeIndexManagerRegistry.getOrCreateScope(context)).not.toBe(scope)
59+
})
60+
4961
it("uses the first workspace when there is no active editor", () => {
5062
CodeIndexManagerRegistry.getOrCreate(context)
5163
expect(CodeIndexManager).toHaveBeenCalledWith("/first", first.uri, context, expect.any(CodeIndexStateManager))

‎src/services/code-index/__tests__/code-index-workspace-scope.spec.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { makeExtensionContext, makeUri } from "../../../test-utils/vscode"
22
import { CodeIndexManager } from "../manager"
33
import { CodeIndexWorkspaceScope } from "../code-index-workspace-scope"
44
import { CodeIndexStateManager } from "../state-manager"
5+
import { WorkspaceIndexingEnablementManager } from "../workspace-indexing-enablement-manager"
56

67
vi.mock("../state-manager")
78

@@ -14,6 +15,19 @@ vi.mock("../manager", () => ({
1415
describe("CodeIndexWorkspaceScope", () => {
1516
beforeEach(() => vi.clearAllMocks())
1617

18+
it("owns a guarded workspace indexing manager and recreates it after disposal", () => {
19+
const scope = new CodeIndexWorkspaceScope("/workspace", makeUri("/workspace"), makeExtensionContext())
20+
expect(() => scope.workspaceIndexingEnablementManager).toThrow("not initialized")
21+
scope.init()
22+
const indexing = scope.workspaceIndexingEnablementManager
23+
expect(indexing).toBeInstanceOf(WorkspaceIndexingEnablementManager)
24+
expect(indexing["manager"]).toBe(scope.codeIndexManager)
25+
scope.dispose()
26+
expect(() => scope.workspaceIndexingEnablementManager).toThrow("not initialized")
27+
scope.init()
28+
expect(scope.workspaceIndexingEnablementManager).not.toBe(indexing)
29+
})
30+
1731
it("guards generic values and preserves defined falsy values", () => {
1832
const scope = new CodeIndexWorkspaceScope("/workspace", makeUri("/workspace"), makeExtensionContext())
1933
expect(() => scope["ensureInitialized"](42)).toThrow("Code index workspace scope is not initialized")

0 commit comments

Comments
 (0)