Skip to content

Commit f444d9a

Browse files
committed
fix(provider): transactional context rollback and serialized mutation queue
1 parent cae6900 commit f444d9a

2 files changed

Lines changed: 104 additions & 20 deletions

File tree

‎src/core/webview/ClineProvider.ts‎

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -259,19 +259,31 @@ export class ClineProvider
259259
private taskHistoryStoreInitialized = false
260260
public static readonly PENDING_OPERATION_TIMEOUT_MS = 30000 // 30 seconds
261261
private providerProfileMutationQueue = Promise.resolve()
262+
private providerProfileMutationAbortController = new AbortController()
262263
private historyTaskCreationQueue = Promise.resolve()
263264

264265
private runDelegationTransition<T>(parentTaskId: string, fn: () => Promise<T>): Promise<T> {
265266
return runDelegationTransition(ClineProvider.delegationTransitionLocks, parentTaskId, fn)
266267
}
267268

268269
private enqueueProviderProfileMutation<T>(fn: (signal: AbortSignal) => Promise<T>): Promise<T> {
270+
if (this._disposed) {
271+
return Promise.reject(new Error("ClineProvider is disposed"))
272+
}
273+
269274
const controller = new AbortController()
275+
const onProviderDispose = () => controller.abort()
276+
this.providerProfileMutationAbortController.signal.addEventListener("abort", onProviderDispose, { once: true })
277+
270278
// Run fn after either outcome so a rejected mutation never poisons the queue.
271-
const run = this.providerProfileMutationQueue.then(
272-
() => fn(controller.signal),
273-
() => fn(controller.signal),
274-
)
279+
const run = this.providerProfileMutationQueue
280+
.then(
281+
() => fn(controller.signal),
282+
() => fn(controller.signal),
283+
)
284+
.finally(() => {
285+
this.providerProfileMutationAbortController.signal.removeEventListener("abort", onProviderDispose)
286+
})
275287
const callerResult = this.withProviderProfileMutationTimeout(run, () => {
276288
controller.abort()
277289
this.log("Provider profile mutation timed out; aborting in-flight mutation")
@@ -294,9 +306,8 @@ export class ClineProvider
294306
},
295307
)
296308

297-
// Advance from the timeout-bounded result. Each fn checks its AbortSignal before
298-
// writing state, so advancing the queue on timeout cannot produce stale overwrites.
299-
this.providerProfileMutationQueue = callerResult.then(
309+
// Keep serialization in place until the timed-out mutation and its rollback settle.
310+
this.providerProfileMutationQueue = run.then(
300311
() => undefined,
301312
() => undefined,
302313
)
@@ -848,6 +859,7 @@ export class ClineProvider
848859

849860
this._disposed = true
850861
this._postStateToWebviewThrottled.cancel()
862+
this.providerProfileMutationAbortController.abort()
851863
this.log("Disposing ClineProvider...")
852864

853865
// Reject any tasks still waiting for a scheduler permit so they don't
@@ -1963,8 +1975,14 @@ export class ClineProvider
19631975
* from is dropped instead of saved and reactivated.
19641976
*/
19651977
async updateProfileModel(name: string, expectedProvider: string, patch: Record<string, unknown>): Promise<void> {
1978+
if (this._disposed) {
1979+
return
1980+
}
1981+
19661982
try {
19671983
await this.enqueueProviderProfileMutation(async (signal) => {
1984+
if (signal.aborted || this._disposed) return
1985+
19681986
// Mirrors the profile name the webview is shown (see getStateToPostToWebview).
19691987
const task = this.getCurrentTask()
19701988
const { currentApiConfigName, organizationAllowList: stateOrganizationAllowList } =
@@ -1978,7 +1996,7 @@ export class ClineProvider
19781996

19791997
const { name: _name, id, ...stored } = await this.providerSettingsManager.getProfile({ name })
19801998

1981-
if (signal.aborted) return
1999+
if (signal.aborted || this._disposed) return
19822000

19832001
// A profile without an explicit provider is treated as OpenRouter, matching the chat ModelSelector.
19842002
const storedProvider = stored.apiProvider ?? providerIdentifiers.openrouter
@@ -2038,35 +2056,33 @@ export class ClineProvider
20382056
}
20392057

20402058
let savedConfig = false
2041-
let updatedContext = false
2059+
let shouldRollbackContext = false
2060+
const originalContextSettings: ProviderSettings = { ...stored, id } as ProviderSettings
20422061
try {
20432062
await this.providerSettingsManager.saveConfig(name, merged as ProviderSettings)
20442063
savedConfig = true
20452064

2046-
if (signal.aborted) {
2065+
if (signal.aborted || this._disposed) {
20472066
throw new Error("Provider profile mutation aborted")
20482067
}
20492068

20502069
await this.updateGlobalState("listApiConfigMeta", await this.providerSettingsManager.listConfig())
20512070
if (name === currentApiConfigName) {
2071+
shouldRollbackContext = true
20522072
await this.contextProxy.setProviderSettings(merged as ProviderSettings)
2053-
updatedContext = true
20542073
}
20552074

2056-
if (signal.aborted) {
2075+
if (signal.aborted || this._disposed) {
20572076
throw new Error("Provider profile mutation aborted")
20582077
}
20592078
} catch (updateError) {
20602079
if (savedConfig) {
20612080
try {
2062-
await this.providerSettingsManager.saveConfig(name, { ...stored, id } as ProviderSettings)
2081+
await this.providerSettingsManager.saveConfig(name, originalContextSettings)
20632082
await this.updateGlobalState(
20642083
"listApiConfigMeta",
20652084
await this.providerSettingsManager.listConfig(),
20662085
)
2067-
if (updatedContext) {
2068-
await this.contextProxy.setProviderSettings({ ...stored, id } as ProviderSettings)
2069-
}
20702086
} catch (rollbackError) {
20712087
this.log(
20722088
`Failed to rollback profile '${name}' after update failure: ${
@@ -2075,10 +2091,21 @@ export class ClineProvider
20752091
)
20762092
}
20772093
}
2094+
if (shouldRollbackContext) {
2095+
try {
2096+
await this.contextProxy.setProviderSettings(originalContextSettings)
2097+
} catch (rollbackError) {
2098+
this.log(
2099+
`Failed to rollback context settings for '${name}' after update failure: ${
2100+
rollbackError instanceof Error ? rollbackError.message : String(rollbackError)
2101+
}`,
2102+
)
2103+
}
2104+
}
20782105
throw updateError
20792106
}
20802107

2081-
if (signal.aborted) {
2108+
if (signal.aborted || this._disposed) {
20822109
return
20832110
}
20842111

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

Lines changed: 60 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -411,9 +411,12 @@ describe("ClineProvider - updateProfileModel", () => {
411411
expect(manager().saveConfig).toHaveBeenCalledTimes(1)
412412
})
413413

414-
it("rejects a model update when the authenticated organization policy is unavailable", async () => {
414+
it("rejects a model update when the authenticated organization policy is unavailable or throws", async () => {
415415
mockStoredProfile({ apiProvider: providerIdentifiers.openrouter, openRouterModelId: "allowed/model" })
416-
provider["getOrganizationAllowListForProfileMutation"] = vi.fn().mockReturnValue(undefined)
416+
mockCloudInstance.isAuthenticated.mockReturnValue(true)
417+
mockCloudInstance.getOrganizationSettings.mockImplementation(() => {
418+
throw new Error("Failed to fetch settings")
419+
})
417420

418421
await provider.updateProfileModel("test-config", providerIdentifiers.openrouter, {
419422
openRouterModelId: "blocked/model",
@@ -612,7 +615,9 @@ describe("ClineProvider - updateProfileModel", () => {
612615
return fn(controller.signal)
613616
})
614617

615-
vi.spyOn(provider.contextProxy, "setProviderSettings").mockImplementationOnce(async () => {
618+
const originalSetProviderSettings = provider.contextProxy.setProviderSettings.bind(provider.contextProxy)
619+
vi.spyOn(provider.contextProxy, "setProviderSettings").mockImplementationOnce(async (settings) => {
620+
await originalSetProviderSettings(settings)
616621
controller.abort()
617622
})
618623

@@ -621,7 +626,59 @@ describe("ClineProvider - updateProfileModel", () => {
621626
})
622627

623628
expect(manager().saveConfig).toHaveBeenCalledTimes(2)
629+
expect(manager().saveConfig).toHaveBeenNthCalledWith(
630+
2,
631+
"test-config",
632+
expect.objectContaining({ openRouterModelId: "openai/gpt-4", openRouterApiKey: "my-key" }),
633+
)
634+
expect(provider.contextProxy.getValues().openRouterModelId).toBe("openai/gpt-4")
624635
expect(mockTask.updateApiConfiguration).not.toHaveBeenCalled()
625636
expect(vscode.window.showErrorMessage).toHaveBeenCalledWith("common:errors.save_api_config")
626637
})
638+
639+
it("rolls back saved profile and restores context when contextProxy.setProviderSettings fails", async () => {
640+
mockStoredProfile({
641+
apiProvider: providerIdentifiers.openrouter,
642+
openRouterModelId: "openai/gpt-4",
643+
openRouterApiKey: "my-key",
644+
})
645+
646+
let setSettingsCalls = 0
647+
const originalSetProviderSettings = provider.contextProxy.setProviderSettings.bind(provider.contextProxy)
648+
vi.spyOn(provider.contextProxy, "setProviderSettings").mockImplementation(async (settings) => {
649+
setSettingsCalls++
650+
if (setSettingsCalls === 1) {
651+
throw new Error("Context secret storage write failed")
652+
}
653+
return originalSetProviderSettings(settings)
654+
})
655+
656+
await provider.updateProfileModel("test-config", providerIdentifiers.openrouter, {
657+
openRouterModelId: "openai/gpt-4.5",
658+
})
659+
660+
expect(manager().saveConfig).toHaveBeenCalledTimes(2)
661+
expect(manager().saveConfig).toHaveBeenNthCalledWith(
662+
2,
663+
"test-config",
664+
expect.objectContaining({ openRouterModelId: "openai/gpt-4", openRouterApiKey: "my-key" }),
665+
)
666+
expect(provider.contextProxy.setProviderSettings).toHaveBeenCalledTimes(2)
667+
expect(vscode.window.showErrorMessage).toHaveBeenCalledWith("common:errors.save_api_config")
668+
})
669+
670+
it("aborts active and queued profile mutations upon provider disposal", async () => {
671+
mockStoredProfile({
672+
apiProvider: providerIdentifiers.openrouter,
673+
openRouterModelId: "openai/gpt-4",
674+
})
675+
676+
await provider.dispose()
677+
678+
await provider.updateProfileModel("test-config", providerIdentifiers.openrouter, {
679+
openRouterModelId: "openai/gpt-4.5",
680+
})
681+
682+
expect(manager().saveConfig).not.toHaveBeenCalled()
683+
})
627684
})

0 commit comments

Comments
 (0)