-
Notifications
You must be signed in to change notification settings - Fork 775
feat: unify OAuth scope discovery between automatic and manual flows #701
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
cliffhall
merged 3 commits into
modelcontextprotocol:main
from
btiernay:feat/oauth-scope-discovery-consistency
Aug 14, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
import { discoverScopes } from "../auth"; | ||
import { discoverAuthorizationServerMetadata } from "@modelcontextprotocol/sdk/client/auth.js"; | ||
|
||
jest.mock("@modelcontextprotocol/sdk/client/auth.js", () => ({ | ||
discoverAuthorizationServerMetadata: jest.fn(), | ||
})); | ||
|
||
const mockDiscoverAuth = | ||
discoverAuthorizationServerMetadata as jest.MockedFunction< | ||
typeof discoverAuthorizationServerMetadata | ||
>; | ||
|
||
const baseMetadata = { | ||
issuer: "https://test.com", | ||
authorization_endpoint: "https://test.com/authorize", | ||
token_endpoint: "https://test.com/token", | ||
response_types_supported: ["code"], | ||
grant_types_supported: ["authorization_code"], | ||
scopes_supported: ["read", "write"], | ||
}; | ||
|
||
describe("discoverScopes", () => { | ||
beforeEach(() => { | ||
jest.clearAllMocks(); | ||
}); | ||
|
||
const testCases = [ | ||
{ | ||
name: "returns joined scopes from OAuth metadata", | ||
mockResolves: baseMetadata, | ||
serverUrl: "https://example.com", | ||
expected: "read write", | ||
expectedCallUrl: "https://example.com/", | ||
}, | ||
{ | ||
name: "prefers resource metadata over OAuth metadata", | ||
mockResolves: baseMetadata, | ||
serverUrl: "https://example.com", | ||
resourceMetadata: { | ||
resource: "https://example.com", | ||
scopes_supported: ["admin", "full"], | ||
}, | ||
expected: "admin full", | ||
}, | ||
{ | ||
name: "falls back to OAuth when resource has empty scopes", | ||
mockResolves: baseMetadata, | ||
serverUrl: "https://example.com", | ||
resourceMetadata: { | ||
resource: "https://example.com", | ||
scopes_supported: [], | ||
}, | ||
expected: "read write", | ||
}, | ||
{ | ||
name: "normalizes URL with port and path", | ||
mockResolves: baseMetadata, | ||
serverUrl: "https://example.com:8080/some/path", | ||
expected: "read write", | ||
expectedCallUrl: "https://example.com:8080/", | ||
}, | ||
{ | ||
name: "normalizes URL with trailing slash", | ||
mockResolves: baseMetadata, | ||
serverUrl: "https://example.com/", | ||
expected: "read write", | ||
expectedCallUrl: "https://example.com/", | ||
}, | ||
{ | ||
name: "handles single scope", | ||
mockResolves: { ...baseMetadata, scopes_supported: ["admin"] }, | ||
serverUrl: "https://example.com", | ||
expected: "admin", | ||
}, | ||
{ | ||
name: "prefers resource metadata even with fewer scopes", | ||
mockResolves: { | ||
...baseMetadata, | ||
scopes_supported: ["read", "write", "admin", "full"], | ||
}, | ||
serverUrl: "https://example.com", | ||
resourceMetadata: { | ||
resource: "https://example.com", | ||
scopes_supported: ["read"], | ||
}, | ||
expected: "read", | ||
}, | ||
]; | ||
|
||
const undefinedCases = [ | ||
{ | ||
name: "returns undefined when OAuth discovery fails", | ||
mockRejects: new Error("Discovery failed"), | ||
serverUrl: "https://example.com", | ||
}, | ||
{ | ||
name: "returns undefined when OAuth has no scopes", | ||
mockResolves: { ...baseMetadata, scopes_supported: [] }, | ||
serverUrl: "https://example.com", | ||
}, | ||
{ | ||
name: "returns undefined when scopes_supported missing", | ||
mockResolves: (() => { | ||
// eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
const { scopes_supported, ...rest } = baseMetadata; | ||
return rest; | ||
})(), | ||
serverUrl: "https://example.com", | ||
}, | ||
{ | ||
name: "returns undefined with resource metadata but OAuth fails", | ||
mockRejects: new Error("No OAuth metadata"), | ||
serverUrl: "https://example.com", | ||
resourceMetadata: { | ||
resource: "https://example.com", | ||
scopes_supported: ["read", "write"], | ||
}, | ||
}, | ||
]; | ||
|
||
test.each(testCases)( | ||
"$name", | ||
async ({ | ||
mockResolves, | ||
serverUrl, | ||
resourceMetadata, | ||
expected, | ||
expectedCallUrl, | ||
}) => { | ||
mockDiscoverAuth.mockResolvedValue(mockResolves); | ||
|
||
const result = await discoverScopes(serverUrl, resourceMetadata); | ||
|
||
expect(result).toBe(expected); | ||
if (expectedCallUrl) { | ||
expect(mockDiscoverAuth).toHaveBeenCalledWith(new URL(expectedCallUrl)); | ||
} | ||
}, | ||
); | ||
|
||
test.each(undefinedCases)( | ||
"$name", | ||
async ({ mockResolves, mockRejects, serverUrl, resourceMetadata }) => { | ||
if (mockRejects) { | ||
mockDiscoverAuth.mockRejectedValue(mockRejects); | ||
} else { | ||
mockDiscoverAuth.mockResolvedValue(mockResolves); | ||
} | ||
|
||
const result = await discoverScopes(serverUrl, resourceMetadata); | ||
|
||
expect(result).toBeUndefined(); | ||
}, | ||
); | ||
}); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After the OAuth scope discovery commits, 2
AuthDebugger
tests were failing because the test mocks were too simple. TheclientInformation
mock always returnedundefined
instead of checkingsessionStorage
for preregistered client info, and thesaveClientInformation
mock did nothing instead of actually saving data. The OAuth flow expected these mocks to behave like the real OAuth client provider by checkingsessionStorage
for existing client information and saving dynamic registration results when needed. Once we fixed the mocks to simulate this real behavior, the tests started passing again.