Skip to content

Commit d3ffd83

Browse files
PierrunoYTclaude
andcommitted
fix(profiles): enforce the org allow-list and roll back failed upserts
upsertProviderProfile trusted whatever the webview posted and left state partially updated on a mid-flow failure. Validate against the organization allow-list before any write, snapshot the profile, mode binding, current profile name, list metadata and in-memory settings, and restore them (and the task's API handler) if saving or activating fails. Fixes #2069 Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
1 parent 16425bc commit d3ffd83

3 files changed

Lines changed: 204 additions & 7 deletions

File tree

‎src/core/webview/ClineProvider.ts‎

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1885,21 +1885,104 @@ export class ClineProvider
18851885
providerSettings: ProviderSettings,
18861886
activate: boolean = true,
18871887
): Promise<string | undefined> {
1888+
let partialState = false
1889+
18881890
try {
18891891
return await this.enqueueProviderProfileMutation(
1890-
(signal) => this.persistProviderProfile(name, providerSettings, activate, signal),
1892+
async (signal) => {
1893+
const { organizationAllowList, mode } = await this.getState()
1894+
1895+
// Reject before touching disk or in-memory state.
1896+
if (!ProfileValidator.isProfileAllowed(providerSettings, organizationAllowList)) {
1897+
throw new OrganizationAllowListViolationError(
1898+
t("common:errors.violated_organization_allowlist"),
1899+
)
1900+
}
1901+
1902+
const snapshot = await this.snapshotProviderProfileState(name, mode)
1903+
1904+
try {
1905+
return await this.persistProviderProfile(name, providerSettings, activate, signal)
1906+
} catch (persistError) {
1907+
// Save, activate and propagate are separate writes; put everything back so
1908+
// storage, context settings, the mode binding and the task agree again.
1909+
try {
1910+
await this.restoreProviderProfileState(name, mode, snapshot, activate)
1911+
} catch (restoreError) {
1912+
partialState = true
1913+
this.log(
1914+
`Error restoring profile state after failed upsert: ${JSON.stringify(restoreError, Object.getOwnPropertyNames(restoreError), 2)}`,
1915+
)
1916+
}
1917+
1918+
throw persistError
1919+
}
1920+
},
18911921
{ runToCompletion: true },
18921922
)
18931923
} catch (error) {
18941924
this.log(
18951925
`Error create new api configuration: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
18961926
)
18971927

1898-
vscode.window.showErrorMessage(t("common:errors.create_api_config"))
1928+
vscode.window.showErrorMessage(
1929+
partialState
1930+
? t("common:errors.update_profile_model_partial")
1931+
: error instanceof OrganizationAllowListViolationError
1932+
? error.message
1933+
: t("common:errors.create_api_config"),
1934+
)
18991935
return undefined
19001936
}
19011937
}
19021938

1939+
/** Captures every value `persistProviderProfile` can change, so a failed upsert can be undone. */
1940+
private async snapshotProviderProfileState(name: string, mode: Mode) {
1941+
let previousProfile: Omit<Awaited<ReturnType<ProviderSettingsManager["getProfile"]>>, "name"> | undefined
1942+
1943+
if (await this.providerSettingsManager.hasConfig(name)) {
1944+
const { name: _name, ...stored } = await this.providerSettingsManager.getProfile({ name })
1945+
previousProfile = stored
1946+
}
1947+
1948+
return {
1949+
previousProfile,
1950+
listApiConfigMeta: this.getGlobalState("listApiConfigMeta"),
1951+
currentApiConfigName: this.getGlobalState("currentApiConfigName"),
1952+
modeConfigId: await this.providerSettingsManager.getModeConfigId(mode),
1953+
providerSettings: this.contextProxy.getProviderSettings(),
1954+
}
1955+
}
1956+
1957+
private async restoreProviderProfileState(
1958+
name: string,
1959+
mode: Mode,
1960+
snapshot: Awaited<ReturnType<ClineProvider["snapshotProviderProfileState"]>>,
1961+
activate: boolean,
1962+
): Promise<void> {
1963+
// Run every step even if one fails, then report the first failure.
1964+
const results = await Promise.allSettled([
1965+
snapshot.previousProfile
1966+
? this.providerSettingsManager.saveConfig(name, snapshot.previousProfile)
1967+
: this.providerSettingsManager.hasConfig(name).then(async (exists) => {
1968+
if (exists) await this.providerSettingsManager.deleteConfig(name)
1969+
}),
1970+
this.updateGlobalState("listApiConfigMeta", snapshot.listApiConfigMeta),
1971+
this.updateGlobalState("currentApiConfigName", snapshot.currentApiConfigName),
1972+
snapshot.modeConfigId
1973+
? this.providerSettingsManager.setModeConfig(mode, snapshot.modeConfigId)
1974+
: Promise.resolve(),
1975+
this.contextProxy.setProviderSettings(snapshot.providerSettings),
1976+
])
1977+
1978+
if (activate) {
1979+
this.updateTaskApiHandlerIfNeeded(snapshot.providerSettings, { forceRebuild: true })
1980+
}
1981+
1982+
const failed = results.find((result): result is PromiseRejectedResult => result.status === "rejected")
1983+
if (failed) throw failed.reason
1984+
}
1985+
19031986
/**
19041987
* Applies a model change to the latest stored profile inside the mutation queue,
19051988
* so a stale webview snapshot cannot overwrite newer profile settings.

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

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,8 @@ describe("ClineProvider - API Handler Rebuild Guard", () => {
243243

244244
// Mock providerSettingsManager
245245
;(provider as any).providerSettingsManager = {
246+
hasConfig: vi.fn().mockResolvedValue(false),
247+
deleteConfig: vi.fn().mockResolvedValue(undefined),
246248
saveConfig: vi.fn().mockResolvedValue("test-id"),
247249
listConfig: vi.fn().mockResolvedValue([
248250
{
@@ -338,6 +340,96 @@ describe("ClineProvider - API Handler Rebuild Guard", () => {
338340
expect((mockTask as any).apiConfiguration.modelTemperature).toBe(0.7)
339341
})
340342

343+
test("rejects a profile the organization allow-list forbids without touching any state", async () => {
344+
const realGetState = provider.getState.bind(provider)
345+
vi.spyOn(provider, "getState").mockImplementation(async () => ({
346+
...(await realGetState()),
347+
organizationAllowList: {
348+
allowAll: false,
349+
providers: {
350+
[providerIdentifiers.openrouter]: { allowAll: false, models: ["openai/gpt-4"] },
351+
},
352+
},
353+
}))
354+
const setProviderSettings = vi.spyOn(provider.contextProxy, "setProviderSettings")
355+
356+
const result = await provider.upsertProviderProfile("test-config", {
357+
apiProvider: providerIdentifiers.openrouter,
358+
openRouterModelId: "anthropic/claude",
359+
})
360+
361+
expect(result).toBeUndefined()
362+
expect(provider["providerSettingsManager"].saveConfig).not.toHaveBeenCalled()
363+
expect(provider["providerSettingsManager"].setModeConfig).not.toHaveBeenCalled()
364+
expect(setProviderSettings).not.toHaveBeenCalled()
365+
expect(vscode.window.showErrorMessage).toHaveBeenCalledWith("errors.violated_organization_allowlist")
366+
})
367+
368+
test("accepts a profile the organization allow-list permits", async () => {
369+
const realGetState = provider.getState.bind(provider)
370+
vi.spyOn(provider, "getState").mockImplementation(async () => ({
371+
...(await realGetState()),
372+
organizationAllowList: {
373+
allowAll: false,
374+
providers: {
375+
[providerIdentifiers.openrouter]: { allowAll: false, models: ["openai/gpt-4"] },
376+
},
377+
},
378+
}))
379+
380+
const result = await provider.upsertProviderProfile("test-config", {
381+
apiProvider: providerIdentifiers.openrouter,
382+
openRouterModelId: "openai/gpt-4",
383+
})
384+
385+
expect(result).toBe("test-id")
386+
})
387+
388+
test("restores the previous profile, mode binding and settings when activation fails", async () => {
389+
const manager = provider["providerSettingsManager"]
390+
const previousProfile = {
391+
id: "test-id",
392+
apiProvider: providerIdentifiers.openrouter,
393+
openRouterModelId: "openai/gpt-4",
394+
}
395+
vi.mocked(manager.hasConfig).mockResolvedValue(true)
396+
vi.mocked(manager.getProfile).mockResolvedValue({ name: "test-config", ...previousProfile })
397+
vi.mocked(manager.getModeConfigId).mockResolvedValue("previous-mode-id")
398+
const previousSettings = provider.contextProxy.getProviderSettings()
399+
const setProviderSettings = vi
400+
.spyOn(provider.contextProxy, "setProviderSettings")
401+
.mockRejectedValueOnce(new Error("context write failed"))
402+
403+
const result = await provider.upsertProviderProfile("test-config", {
404+
apiProvider: providerIdentifiers.openrouter,
405+
openRouterModelId: "anthropic/claude",
406+
})
407+
408+
expect(result).toBeUndefined()
409+
// First the new profile is saved, then the snapshot is written back.
410+
expect(manager.saveConfig).toHaveBeenNthCalledWith(1, "test-config", {
411+
apiProvider: providerIdentifiers.openrouter,
412+
openRouterModelId: "anthropic/claude",
413+
})
414+
expect(manager.saveConfig).toHaveBeenLastCalledWith("test-config", previousProfile)
415+
expect(manager.setModeConfig).toHaveBeenLastCalledWith(expect.any(String), "previous-mode-id")
416+
expect(setProviderSettings).toHaveBeenLastCalledWith(previousSettings)
417+
expect(vscode.window.showErrorMessage).toHaveBeenCalledWith("errors.create_api_config")
418+
})
419+
420+
test("deletes a profile that did not exist before when activation fails", async () => {
421+
const manager = provider["providerSettingsManager"]
422+
vi.mocked(manager.hasConfig).mockResolvedValueOnce(false).mockResolvedValue(true)
423+
vi.spyOn(provider.contextProxy, "setProviderSettings").mockRejectedValueOnce(new Error("write failed"))
424+
425+
await provider.upsertProviderProfile("new-config", {
426+
apiProvider: providerIdentifiers.openrouter,
427+
openRouterModelId: "openai/gpt-4",
428+
})
429+
430+
expect(manager.deleteConfig).toHaveBeenCalledWith("new-config")
431+
})
432+
341433
test("calls updateApiConfiguration when provider changes", async () => {
342434
const mockTask = new Task({
343435
...defaultTaskOptions,

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

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2684,6 +2684,8 @@ describe("ClineProvider", () => {
26842684
const messageHandler = (mockWebviewView.webview.onDidReceiveMessage as any).mock.calls[0][0]
26852685

26862686
;(provider as any).providerSettingsManager = {
2687+
hasConfig: vi.fn().mockResolvedValue(false),
2688+
getModeConfigId: vi.fn().mockResolvedValue(undefined),
26872689
listConfig: vi
26882690
.fn()
26892691
.mockResolvedValue([
@@ -3458,6 +3460,8 @@ describe("ClineProvider", () => {
34583460
const messageHandler = (mockWebviewView.webview.onDidReceiveMessage as any).mock.calls[0][0]
34593461

34603462
;(provider as any).providerSettingsManager = {
3463+
hasConfig: vi.fn().mockResolvedValue(false),
3464+
getModeConfigId: vi.fn().mockResolvedValue(undefined),
34613465
setModeConfig: vi.fn(),
34623466
saveConfig: vi.fn().mockResolvedValue(undefined),
34633467
listConfig: vi
@@ -3503,6 +3507,8 @@ describe("ClineProvider", () => {
35033507
throw new Error("API handler error")
35043508
})
35053509
;(provider as any).providerSettingsManager = {
3510+
hasConfig: vi.fn().mockResolvedValue(false),
3511+
getModeConfigId: vi.fn().mockResolvedValue(undefined),
35063512
setModeConfig: vi.fn(),
35073513
saveConfig: vi.fn().mockResolvedValue(undefined),
35083514
listConfig: vi
@@ -3514,6 +3520,13 @@ describe("ClineProvider", () => {
35143520

35153521
// Setup Task instance with auto-mock from the top of the file
35163522
const mockCline = new Task(defaultTaskOptions) // Create a new mocked instance
3523+
// The first rebuild (activation) fails; the rollback's rebuild succeeds.
3524+
mockCline.updateApiConfiguration = vi
3525+
.fn()
3526+
.mockImplementationOnce(() => {
3527+
throw new Error("API handler error")
3528+
})
3529+
.mockImplementation(() => {})
35173530
await provider.addClineToStack(mockCline)
35183531

35193532
const testApiConfig = {
@@ -3534,18 +3547,23 @@ describe("ClineProvider", () => {
35343547
)
35353548
expect(vscode.window.showErrorMessage).toHaveBeenCalledWith("errors.create_api_config")
35363549

3537-
// Verify state was still updated
3538-
expect(mockContext.globalState.update).toHaveBeenCalledWith("listApiConfigMeta", [
3539-
{ name: "test-config", id: "test-id", apiProvider: providerIdentifiers.anthropic },
3540-
])
3541-
expect(mockContext.globalState.update).toHaveBeenCalledWith("currentApiConfigName", "test-config")
3550+
// The failed upsert is rolled back: the new profile is removed from storage and the
3551+
// previously active profile name is put back.
3552+
expect(provider.providerSettingsManager.hasConfig).toHaveBeenCalledWith("test-config")
3553+
const nameWrites = vi
3554+
.mocked(mockContext.globalState.update)
3555+
.mock.calls.filter(([key]) => key === "currentApiConfigName")
3556+
expect(nameWrites.at(0)?.[1]).toBe("test-config")
3557+
expect(nameWrites.at(-1)?.[1]).not.toBe("test-config")
35423558
})
35433559

35443560
test("handles successful saveApiConfiguration", async () => {
35453561
await provider.resolveWebviewView(mockWebviewView)
35463562
const messageHandler = (mockWebviewView.webview.onDidReceiveMessage as any).mock.calls[0][0]
35473563

35483564
;(provider as any).providerSettingsManager = {
3565+
hasConfig: vi.fn().mockResolvedValue(false),
3566+
getModeConfigId: vi.fn().mockResolvedValue(undefined),
35493567
setModeConfig: vi.fn(),
35503568
saveConfig: vi.fn().mockResolvedValue(undefined),
35513569
listConfig: vi
@@ -5907,6 +5925,8 @@ describe("ClineProvider - Comprehensive Edit/Delete Edge Cases", () => {
59075925
vi.spyOn(provider, "postStateToWebview").mockResolvedValue(undefined)
59085926
const postMessageSpy = vi.spyOn(provider, "postMessageToWebview").mockResolvedValue(undefined)
59095927
;(provider as any).providerSettingsManager = {
5928+
hasConfig: vi.fn().mockResolvedValue(false),
5929+
getModeConfigId: vi.fn().mockResolvedValue(undefined),
59105930
listConfig: vi.fn().mockResolvedValue([]),
59115931
}
59125932

@@ -5938,6 +5958,8 @@ describe("ClineProvider - Comprehensive Edit/Delete Edge Cases", () => {
59385958
const saveConfig = vi.fn().mockResolvedValue(undefined)
59395959
vi.spyOn(provider, "postStateToWebview").mockResolvedValue(undefined)
59405960
;(provider as any).providerSettingsManager = {
5961+
hasConfig: vi.fn().mockResolvedValue(false),
5962+
getModeConfigId: vi.fn().mockResolvedValue(undefined),
59415963
listConfig: vi.fn().mockResolvedValue([
59425964
{ name: "Zoo Gateway", apiProvider: providerIdentifiers.zooGateway },
59435965
{ name: "Backup Zoo", apiProvider: providerIdentifiers.zooGateway },

0 commit comments

Comments
 (0)