Skip to content

Commit 8cb827e

Browse files
fix(mcp): close OAuth lifecycle gaps (#2096)
1 parent ec652a7 commit 8cb827e

4 files changed

Lines changed: 200 additions & 5 deletions

File tree

‎src/services/mcp/McpHub.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -723,6 +723,7 @@ export class McpHub {
723723
// Set up file watchers for enabled servers
724724
this.setupFileWatcher(name, config, source)
725725

726+
let pendingAuthProvider: McpOAuthClientProvider | undefined
726727
try {
727728
const client = new Client(
728729
{
@@ -840,6 +841,11 @@ export class McpHub {
840841
skipDiscovery,
841842
...configInjected.oauth,
842843
})
844+
pendingAuthProvider = authProvider
845+
if (this.isDisposed) {
846+
await authProvider.close()
847+
return
848+
}
843849

844850
// Pre-register the OAuth client so the SDK can skip its own
845851
// registration step (broken for path-prefixed issuers — see
@@ -991,6 +997,7 @@ export class McpHub {
991997
authProvider: streamableHttpAuthProvider,
992998
}
993999
this.connections.push(connection)
1000+
pendingAuthProvider = undefined
9941001

9951002
// Connect (this will automatically start the transport)
9961003
try {
@@ -1045,6 +1052,7 @@ export class McpHub {
10451052
connection.server.resources = await this.fetchResourcesList(name, source)
10461053
connection.server.resourceTemplates = await this.fetchResourceTemplatesList(name, source)
10471054
} catch (error) {
1055+
await pendingAuthProvider?.close()
10481056
// Update status with error
10491057
const connection = this.findConnection(name, source)
10501058
if (connection) {
@@ -1104,6 +1112,7 @@ export class McpHub {
11041112
const existing = await this.secretStorage.getOAuthData(serverUrl, oauthClientId)
11051113
if (this.isDisposed) {
11061114
unsubscribeCrossWindow()
1115+
await authProvider.close()
11071116
return
11081117
}
11091118
// If the first read missed but the watcher fired during it, re-read — a write

‎src/services/mcp/McpOAuthClientProvider.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -624,8 +624,12 @@ export class McpOAuthClientProvider implements OAuthClientProvider {
624624
}
625625

626626
const tokens = (await response.json()) as OAuthTokens
627-
await this.saveTokens(tokens, clientId)
628-
return tokens
627+
const mergedTokens: OAuthTokens = {
628+
...tokens,
629+
refresh_token: tokens.refresh_token ?? refreshToken,
630+
}
631+
await this.saveTokens(mergedTokens, clientId)
632+
return mergedTokens
629633
}
630634

631635
/** Close the local callback server. Always call this when done. */

‎src/services/mcp/__tests__/McpHub.spec.ts‎

Lines changed: 146 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@ import * as path from "path"
33

44
import type { Mock } from "vitest"
55
import type { ExtensionContext, Uri } from "vscode"
6+
import type { Client } from "@modelcontextprotocol/sdk/client/index.js"
7+
import type { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
68

79
import type { ClineProvider } from "../../../core/webview/ClineProvider"
10+
import type { SecretStorageService } from "../SecretStorageService"
811

912
import type { McpHub as McpHubType, McpConnection, ConnectedMcpConnection, DisconnectedMcpConnection } from "../McpHub"
1013
import { ServerConfigSchema, McpHub } from "../McpHub"
14+
import { McpOAuthClientProvider } from "../McpOAuthClientProvider"
1115
import { OAUTH_FLOW_TIMEOUT_MS } from "../constants"
1216
import { t } from "../../../i18n"
1317

@@ -128,6 +132,18 @@ vi.mock("@modelcontextprotocol/sdk/client/index.js", () => ({
128132
Client: vi.fn(),
129133
}))
130134

135+
vi.mock("@modelcontextprotocol/sdk/client/streamableHttp.js", () => ({
136+
StreamableHTTPClientTransport: vi.fn(),
137+
}))
138+
139+
vi.mock("../McpOAuthClientProvider", () => ({
140+
McpOAuthClientProvider: {
141+
create: vi.fn(),
142+
isKnownNonOAuth: vi.fn().mockReturnValue(false),
143+
clearNonOAuthCache: vi.fn(),
144+
},
145+
}))
146+
131147
// Mock chokidar
132148
vi.mock("chokidar", () => ({
133149
default: {
@@ -392,6 +408,111 @@ describe("McpHub", () => {
392408
})
393409
})
394410

411+
describe("static OAuth connection wiring", () => {
412+
it("passes static OAuth options, performs discovery, and skips dynamic registration", async () => {
413+
const streamableModule = await import("@modelcontextprotocol/sdk/client/streamableHttp.js")
414+
const StreamableHTTPClientTransport = streamableModule.StreamableHTTPClientTransport as ReturnType<
415+
typeof vi.fn
416+
>
417+
const clientModule = await import("@modelcontextprotocol/sdk/client/index.js")
418+
const Client = clientModule.Client as ReturnType<typeof vi.fn>
419+
const mockAuthProvider = {
420+
registerClientIfNeeded: vi.fn(),
421+
close: vi.fn().mockResolvedValue(undefined),
422+
}
423+
vi.mocked(McpOAuthClientProvider.create).mockResolvedValue(
424+
mockAuthProvider as unknown as McpOAuthClientProvider,
425+
)
426+
const mockTransport = { close: vi.fn().mockResolvedValue(undefined) }
427+
StreamableHTTPClientTransport.mockImplementation(function () {
428+
return mockTransport as unknown as StreamableHTTPClientTransport
429+
})
430+
Client.mockImplementation(function () {
431+
return {
432+
connect: vi.fn().mockResolvedValue(undefined),
433+
close: vi.fn().mockResolvedValue(undefined),
434+
getInstructions: vi.fn(),
435+
request: vi.fn().mockResolvedValue({ tools: [], resources: [], resourceTemplates: [] }),
436+
} as unknown as Client
437+
})
438+
const secretStorage = {
439+
hasOAuthData: vi.fn().mockResolvedValue(false),
440+
} as unknown as SecretStorageService
441+
const oauth = {
442+
clientId: "registered-client",
443+
scope: "openid offline_access",
444+
redirectUri: "http://localhost:33418/callback",
445+
resource: false as const,
446+
}
447+
vi.mocked(fs.readFile).mockResolvedValue(
448+
JSON.stringify({
449+
mcpServers: {
450+
"static-oauth-server": {
451+
type: "streamable-http",
452+
url: "https://example.com/mcp",
453+
oauth,
454+
},
455+
},
456+
}),
457+
)
458+
459+
const hub = new McpHub(mockProvider as ClineProvider, secretStorage)
460+
await hub.waitUntilReady()
461+
462+
expect(McpOAuthClientProvider.create).toHaveBeenCalledWith(
463+
"https://example.com/mcp",
464+
secretStorage,
465+
"static-oauth-server",
466+
{ skipDiscovery: false, ...oauth },
467+
)
468+
expect(mockAuthProvider.registerClientIfNeeded).not.toHaveBeenCalled()
469+
expect(StreamableHTTPClientTransport).toHaveBeenCalledWith(
470+
new URL("https://example.com/mcp"),
471+
expect.objectContaining({ authProvider: mockAuthProvider }),
472+
)
473+
})
474+
475+
it("closes a static OAuth provider when the hub is disposed during provider creation", async () => {
476+
const streamableModule = await import("@modelcontextprotocol/sdk/client/streamableHttp.js")
477+
const StreamableHTTPClientTransport = streamableModule.StreamableHTTPClientTransport as ReturnType<
478+
typeof vi.fn
479+
>
480+
let resolveProvider!: (provider: McpOAuthClientProvider) => void
481+
vi.mocked(McpOAuthClientProvider.create).mockReturnValueOnce(
482+
new Promise<McpOAuthClientProvider>((resolve) => {
483+
resolveProvider = resolve
484+
}),
485+
)
486+
const mockAuthProvider = {
487+
registerClientIfNeeded: vi.fn(),
488+
close: vi.fn().mockResolvedValue(undefined),
489+
} as unknown as McpOAuthClientProvider
490+
const secretStorage = {
491+
hasOAuthData: vi.fn().mockResolvedValue(false),
492+
} as unknown as SecretStorageService
493+
vi.mocked(fs.readFile).mockResolvedValue(
494+
JSON.stringify({
495+
mcpServers: {
496+
"static-oauth-server": {
497+
type: "streamable-http",
498+
url: "https://example.com/mcp",
499+
oauth: { clientId: "registered-client" },
500+
},
501+
},
502+
}),
503+
)
504+
505+
const hub = new McpHub(mockProvider as ClineProvider, secretStorage)
506+
await Promise.resolve()
507+
await hub.dispose()
508+
resolveProvider(mockAuthProvider)
509+
await hub.waitUntilReady()
510+
511+
expect(mockAuthProvider.close).toHaveBeenCalledTimes(1)
512+
expect(StreamableHTTPClientTransport).not.toHaveBeenCalled()
513+
})
514+
})
515+
395516
describe("Discriminated union type handling", () => {
396517
it("should create connected connections with proper type", async () => {
397518
// Mock StdioClientTransport
@@ -2669,7 +2790,7 @@ describe("McpHub", () => {
26692790
const serverName = "oauth-server"
26702791
const serverUrl = "https://example.com/mcp"
26712792
const source = "global" as const
2672-
const config = { url: serverUrl }
2793+
const config = ServerConfigSchema.parse({ type: "streamable-http", url: serverUrl })
26732794

26742795
let mockAuthProvider: any
26752796
let mockTransport: any
@@ -3055,6 +3176,30 @@ describe("McpHub", () => {
30553176
expect(mockAuthProvider.close).toHaveBeenCalled()
30563177
})
30573178

3179+
it("should close the provider when the hub is disposed during the initial token read", async () => {
3180+
let resolveTokenRead!: (value: null) => void
3181+
mockSecretStorage.getOAuthData.mockReturnValueOnce(
3182+
new Promise<null>((resolve) => {
3183+
resolveTokenRead = resolve
3184+
}),
3185+
)
3186+
3187+
const flowPromise = mcpHub["_initiateOAuthFlow"](
3188+
serverName,
3189+
source,
3190+
config,
3191+
mockAuthProvider,
3192+
mockTransport,
3193+
mockConnection,
3194+
)
3195+
mcpHub["isDisposed"] = true
3196+
resolveTokenRead(null)
3197+
await flowPromise
3198+
3199+
expect(mockAuthProvider.close).toHaveBeenCalledTimes(1)
3200+
expect(vsc.window.withProgress).not.toHaveBeenCalled()
3201+
})
3202+
30583203
it("should not reconnect when hub is disposed while cross-window tokens arrive", async () => {
30593204
vi.useFakeTimers()
30603205
vsc.window.showInformationMessage.mockImplementation(() => {

‎src/services/mcp/__tests__/McpOAuthClientProvider.spec.ts‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { describe, it, expect, vi, beforeEach, afterAll } from "vitest"
2+
import type { OAuthClientInformationFull } from "@modelcontextprotocol/sdk/shared/auth.js"
23

34
// Mock vscode
45
vi.mock("vscode", () => ({
@@ -435,7 +436,6 @@ describe("McpOAuthClientProvider", () => {
435436
}
436437
const refreshedTokens = {
437438
access_token: "new-access",
438-
refresh_token: "new-refresh",
439439
token_type: "Bearer",
440440
expires_in: 3600,
441441
}
@@ -453,13 +453,50 @@ describe("McpOAuthClientProvider", () => {
453453
})
454454

455455
const result = await provider.tokens()
456-
expect(result).toEqual(refreshedTokens)
456+
expect(result).toEqual({ ...refreshedTokens, refresh_token: "valid-refresh" })
457457
expect(mockFetch).toHaveBeenCalledWith(
458458
expect.stringContaining("/token"),
459459
expect.objectContaining({
460460
body: expect.stringContaining("grant_type=refresh_token"),
461461
}),
462462
)
463+
expect((await secretStorage.getOAuthData("https://example.com/mcp"))?.tokens.refresh_token).toBe(
464+
"valid-refresh",
465+
)
466+
await provider.close()
467+
})
468+
469+
it("should use a rotated refresh token when the server returns one", async () => {
470+
setupCallbackServerMock()
471+
const secretStorage = createMockSecretStorage()
472+
const provider = await McpOAuthClientProvider.create("https://example.com/mcp", secretStorage)
473+
await provider.saveClientInformation({ client_id: "id", redirect_uris: [] } as OAuthClientInformationFull)
474+
await secretStorage.saveOAuthData("https://example.com/mcp", {
475+
tokens: {
476+
access_token: "expired-access",
477+
refresh_token: "old-refresh",
478+
token_type: "Bearer",
479+
},
480+
expires_at: Date.now() - 1000,
481+
issuer: "https://auth.example.com",
482+
})
483+
mockFetch.mockResolvedValueOnce({
484+
ok: true,
485+
json: () =>
486+
Promise.resolve({
487+
access_token: "new-access",
488+
refresh_token: "new-refresh",
489+
token_type: "Bearer",
490+
expires_in: 3600,
491+
}),
492+
})
493+
494+
const result = await provider.tokens()
495+
496+
expect(result?.refresh_token).toBe("new-refresh")
497+
expect((await secretStorage.getOAuthData("https://example.com/mcp"))?.tokens.refresh_token).toBe(
498+
"new-refresh",
499+
)
463500
await provider.close()
464501
})
465502

0 commit comments

Comments
 (0)