Skip to content

Commit 68383e7

Browse files
committed
refactor(code-index): route workspace actions through scopes
Extract workspace enablement coordination and status publication, expose full workspace scopes, and replace direct manager access in webview handlers. Add toggle guard and default coverage, sync upstream main, and align the CodeRabbit test with upstream chat access policy. Refs #1594
1 parent 778ad3e commit 68383e7

9 files changed

Lines changed: 326 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

@@ -3219,12 +3219,8 @@ export class ClineProvider
32193219
return true
32203220
}
32213221

3222-
/**
3223-
* Gets the CodeIndexManager for the current active workspace
3224-
* @returns CodeIndexManager instance for the current workspace or the default one
3225-
*/
3226-
public getCurrentWorkspaceCodeIndexManager(): CodeIndexManager | undefined {
3227-
return CodeIndexManagerRegistry.getOrCreate(this.context)
3222+
public getCurrentWorkspaceCodeIndexScope(): CodeIndexWorkspaceScope | undefined {
3223+
return CodeIndexManagerRegistry.getOrCreateScope(this.context)
32283224
}
32293225

32303226
/**

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

Lines changed: 123 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,85 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
32333258
)
32343259
})
32353260

3261+
it("does not toggle indexing or publish status without a workspace scope", async () => {
3262+
const provider = createProvider()
3263+
await webviewMessageHandler(provider, { type: "toggleWorkspaceIndexing", bool: true })
3264+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
3265+
expect(provider.log).toHaveBeenCalledExactlyOnceWith(
3266+
"Cannot toggle workspace indexing: No workspace folder open",
3267+
)
3268+
expect(provider.postMessageToWebview).not.toHaveBeenCalled()
3269+
})
3270+
3271+
it.each([
3272+
{ bool: true, expected: true },
3273+
{ bool: false, expected: false },
3274+
{ bool: undefined, expected: false },
3275+
])("delegates workspace enablement with bool=$bool as $expected", async ({ bool, expected }) => {
3276+
const setEnabled = vi.fn().mockResolvedValue(undefined)
3277+
const provider = createProvider({
3278+
getCurrentWorkspaceCodeIndexScope: vi.fn().mockReturnValue({
3279+
workspaceIndexingEnablementManager: { setEnabled },
3280+
}),
3281+
})
3282+
const message: WebviewMessage = { type: "toggleWorkspaceIndexing" }
3283+
if (bool !== undefined) {
3284+
message.bool = bool
3285+
}
3286+
await webviewMessageHandler(provider, message)
3287+
expect(setEnabled).toHaveBeenCalledExactlyOnceWith(expected, provider)
3288+
// Status publication belongs to the enablement manager, not the handler.
3289+
expect(provider.postMessageToWebview).not.toHaveBeenCalled()
3290+
expect(provider.log).not.toHaveBeenCalled()
3291+
})
3292+
3293+
it("does not stop indexing or publish status without a workspace scope", async () => {
3294+
const provider = createProvider()
3295+
await webviewMessageHandler(provider, { type: "stopIndexing" })
3296+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
3297+
expect(provider.log).toHaveBeenCalledWith("Cannot stop indexing: No workspace folder open")
3298+
expect(provider.postMessageToWebview).not.toHaveBeenCalled()
3299+
})
3300+
3301+
it.each([true, false])("resolves the scope after saving index settings (workspace=%s)", async (hasWorkspace) => {
3302+
const handleSettingsChange = vi.fn().mockResolvedValue(undefined)
3303+
const manager = createIndexManager({ handleSettingsChange, isFeatureEnabled: false })
3304+
const provider = createProvider({
3305+
getCurrentWorkspaceCodeIndexScope: vi
3306+
.fn()
3307+
.mockReturnValue(hasWorkspace ? { codeIndexManager: manager } : undefined),
3308+
})
3309+
3310+
await webviewMessageHandler(provider, {
3311+
type: "saveCodeIndexSettingsAtomic",
3312+
codeIndexSettings: {
3313+
codebaseIndexEnabled: false,
3314+
codebaseIndexQdrantUrl: "http://localhost:6333",
3315+
codebaseIndexEmbedderProvider: providerIdentifiers.openai,
3316+
codebaseIndexEmbedderModelId: "text-embedding-3-small",
3317+
},
3318+
})
3319+
3320+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
3321+
expect(provider.postMessageToWebview).toHaveBeenCalledWith(
3322+
expect.objectContaining({ type: "codeIndexSettingsSaved", success: true }),
3323+
)
3324+
if (hasWorkspace) {
3325+
expect(handleSettingsChange).toHaveBeenCalledOnce()
3326+
} else {
3327+
expect(handleSettingsChange).not.toHaveBeenCalled()
3328+
expect(provider.log).toHaveBeenCalledWith("Cannot save code index settings: No workspace folder open")
3329+
}
3330+
})
3331+
3332+
it("does not update auto-enable defaults without a workspace scope", async () => {
3333+
const provider = createProvider()
3334+
await webviewMessageHandler(provider, { type: "setAutoEnableDefault", bool: true })
3335+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
3336+
expect(provider.log).toHaveBeenCalledWith("Cannot set auto-enable default: No workspace folder open")
3337+
expect(provider.postMessageToWebview).not.toHaveBeenCalled()
3338+
})
3339+
32363340
it("catches auto-enabled indexing failures and posts the resulting status", async () => {
32373341
const { CodeIndexManagerRegistry } = await import("../../../services/code-index/code-index-manager-registry")
32383342
let workspaceEnabled = false
@@ -3247,13 +3351,14 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
32473351
.spyOn(CodeIndexManagerRegistry, "getAllInstances")
32483352
.mockReturnValue([manager] as unknown as ReturnType<typeof CodeIndexManagerRegistry.getAllInstances>)
32493353
const provider = createProvider({
3250-
getCurrentWorkspaceCodeIndexManager: vi.fn().mockReturnValue(manager),
3354+
getCurrentWorkspaceCodeIndexScope: vi.fn().mockReturnValue({ codeIndexManager: manager }),
32513355
})
32523356

32533357
try {
32543358
await webviewMessageHandler(provider, { type: "setAutoEnableDefault", bool: true })
32553359
await Promise.resolve()
32563360

3361+
expect(provider.getCurrentWorkspaceCodeIndexScope).toHaveBeenCalledOnce()
32573362
expect(manager.startIndexing).toHaveBeenCalledOnce()
32583363
expect(provider.log).toHaveBeenCalledWith("Indexing error: Error: auto-enable failure")
32593364
expect(provider.postMessageToWebview).toHaveBeenCalledWith(
@@ -3266,14 +3371,22 @@ describe("webviewMessageHandler no-floating-promises coverage", () => {
32663371

32673372
it("covers changed clear-index response paths", async () => {
32683373
const manager = createIndexManager()
3269-
const getManager = vi.fn().mockReturnValueOnce(undefined).mockReturnValue(manager)
3270-
const provider = createProvider({ getCurrentWorkspaceCodeIndexManager: getManager })
3374+
const getScope = vi.fn().mockReturnValueOnce(undefined).mockReturnValue({ codeIndexManager: manager })
3375+
const provider = createProvider({ getCurrentWorkspaceCodeIndexScope: getScope })
32713376

32723377
await webviewMessageHandler(provider, { type: "clearIndexData" })
3378+
expect(manager.clearIndexData).not.toHaveBeenCalled()
3379+
expect(provider.log).toHaveBeenCalledWith("Cannot clear index data: No workspace folder open")
3380+
expect(provider.postMessageToWebview).toHaveBeenCalledExactlyOnceWith({
3381+
type: "indexCleared",
3382+
values: { success: false, error: expect.any(String) },
3383+
})
32733384
await webviewMessageHandler(provider, { type: "clearIndexData" })
32743385
manager.clearIndexData.mockRejectedValueOnce(new Error("clear failed"))
32753386
await webviewMessageHandler(provider, { type: "clearIndexData" })
32763387

3388+
expect(getScope).toHaveBeenCalledTimes(3)
3389+
expect(manager.clearIndexData).toHaveBeenCalledTimes(2)
32773390
expect(provider.postMessageToWebview).toHaveBeenCalledWith({
32783391
type: "indexCleared",
32793392
values: { success: true },

‎src/core/webview/webviewMessageHandler.ts‎

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

31373137
// Then handle validation and initialization for the current workspace
3138-
const currentCodeIndexManager = provider.getCurrentWorkspaceCodeIndexManager()
3138+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3139+
const currentCodeIndexManager = scope?.codeIndexManager
31393140
if (currentCodeIndexManager) {
31403141
// If embedder provider changed, perform proactive validation
31413142
if (embedderProviderChanged) {
@@ -3214,7 +3215,8 @@ export const webviewMessageHandler = async (
32143215
}
32153216

32163217
case "requestIndexingStatus": {
3217-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3218+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3219+
const manager = scope?.codeIndexManager
32183220
if (!manager) {
32193221
// No workspace open - send error status
32203222
await provider.postMessageToWebview({
@@ -3278,7 +3280,8 @@ export const webviewMessageHandler = async (
32783280
}
32793281
case "startIndexing": {
32803282
try {
3281-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3283+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3284+
const manager = scope?.codeIndexManager
32823285
if (!manager) {
32833286
await provider.postMessageToWebview({
32843287
type: "indexingStatusUpdate",
@@ -3319,15 +3322,15 @@ export const webviewMessageHandler = async (
33193322
}
33203323
case "stopIndexing": {
33213324
try {
3322-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3323-
if (!manager) {
3325+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3326+
if (!scope) {
33243327
provider.log("Cannot stop indexing: No workspace folder open")
33253328
return
33263329
}
3327-
manager.stopIndexing()
3330+
scope.codeIndexManager.stopIndexing()
33283331
await provider.postMessageToWebview({
33293332
type: "indexingStatusUpdate",
3330-
values: manager.getCurrentStatus(),
3333+
values: scope.codeIndexManager.getCurrentStatus(),
33313334
})
33323335
} catch (error) {
33333336
provider.log(`Error stopping indexing: ${error instanceof Error ? error.message : String(error)}`)
@@ -3336,23 +3339,12 @@ export const webviewMessageHandler = async (
33363339
}
33373340
case "toggleWorkspaceIndexing": {
33383341
try {
3339-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3340-
if (!manager) {
3342+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3343+
if (!scope) {
33413344
provider.log("Cannot toggle workspace indexing: No workspace folder open")
33423345
return
33433346
}
3344-
const enabled = message.bool ?? false
3345-
await manager.setWorkspaceEnabled(enabled)
3346-
if (enabled && manager.isFeatureEnabled && manager.isFeatureConfigured) {
3347-
await manager.initialize(provider.contextProxy)
3348-
void manager.startIndexing().catch((err) => provider.log(`Indexing error: ${err}`))
3349-
} else if (!enabled) {
3350-
manager.stopIndexing()
3351-
}
3352-
await provider.postMessageToWebview({
3353-
type: "indexingStatusUpdate",
3354-
values: manager.getCurrentStatus(),
3355-
})
3347+
await scope.workspaceIndexingEnablementManager.setEnabled(message.bool ?? false, provider)
33563348
} catch (error) {
33573349
provider.log(
33583350
`Error toggling workspace indexing: ${error instanceof Error ? error.message : String(error)}`,
@@ -3362,7 +3354,8 @@ export const webviewMessageHandler = async (
33623354
}
33633355
case "setAutoEnableDefault": {
33643356
try {
3365-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3357+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3358+
const manager = scope?.codeIndexManager
33663359
if (!manager) {
33673360
provider.log("Cannot set auto-enable default: No workspace folder open")
33683361
return
@@ -3395,8 +3388,8 @@ export const webviewMessageHandler = async (
33953388
}
33963389
case "clearIndexData": {
33973390
try {
3398-
const manager = provider.getCurrentWorkspaceCodeIndexManager()
3399-
if (!manager) {
3391+
const scope = provider.getCurrentWorkspaceCodeIndexScope()
3392+
if (!scope) {
34003393
provider.log("Cannot clear index data: No workspace folder open")
34013394
await provider.postMessageToWebview({
34023395
type: "indexCleared",
@@ -3407,7 +3400,7 @@ export const webviewMessageHandler = async (
34073400
})
34083401
return
34093402
}
3410-
await manager.clearIndexData()
3403+
await scope.codeIndexManager.clearIndexData()
34113404
await provider.postMessageToWebview({ type: "indexCleared", values: { success: true } })
34123405
} catch (error) {
34133406
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))

0 commit comments

Comments
 (0)