-
Notifications
You must be signed in to change notification settings - Fork 462
feat(clerk-js): Use FAPI for OAuth popup callbacks #9174
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
Open
brkalow
wants to merge
3
commits into
main
Choose a base branch
from
brk/clerk-js-fapi-popup-callback
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@clerk/clerk-js': patch | ||
| --- | ||
|
|
||
| Use the Frontend API for OAuth popup callbacks so popup authentication no longer depends on the Account Portal hostname. |
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
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
141 changes: 141 additions & 0 deletions
141
packages/clerk-js/src/utils/__tests__/authenticateWithPopup.test.ts
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,141 @@ | ||
| import { afterEach, describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| import type { Clerk } from '../../core/clerk'; | ||
| import { createFapiClient } from '../../core/fapiClient'; | ||
| import { _authenticateWithPopup, _futureAuthenticateWithPopup, wrapWithPopupRoutes } from '../authenticateWithPopup'; | ||
|
|
||
| const createClerk = (proxyUrl?: string) => { | ||
| const fapiClient = createFapiClient({ | ||
| frontendApi: 'clerk.example.com', | ||
| proxyUrl, | ||
| instanceType: 'production', | ||
| getSessionId: () => undefined, | ||
| }); | ||
|
|
||
| return { | ||
| client: {}, | ||
| buildUrlWithAuth: vi.fn((url: string) => url), | ||
| getFapiClient: () => fapiClient, | ||
| } as unknown as Clerk; | ||
| }; | ||
|
|
||
| afterEach(() => { | ||
| vi.restoreAllMocks(); | ||
| }); | ||
|
|
||
| describe('wrapWithPopupRoutes', () => { | ||
| it.each([ | ||
| [undefined, 'https://clerk.example.com/v1/popup_auth_callback'], | ||
| ['https://app.example.com/__clerk', 'https://app.example.com/__clerk/v1/popup_auth_callback'], | ||
| ])('uses the effective FAPI URL when proxyUrl is %s', (proxyUrl, expectedCallbackUrl) => { | ||
| const routes = wrapWithPopupRoutes(createClerk(proxyUrl), { | ||
| redirectCallbackUrl: 'https://app.example.com/sso-callback', | ||
| redirectUrl: 'https://app.example.com/dashboard', | ||
| }); | ||
|
|
||
| const completeUrl = new URL(routes.redirectUrl); | ||
| const callbackUrl = new URL(routes.redirectCallbackUrl); | ||
|
|
||
| expect(`${completeUrl.origin}${completeUrl.pathname}`).toBe(expectedCallbackUrl); | ||
| expect(`${callbackUrl.origin}${callbackUrl.pathname}`).toBe(expectedCallbackUrl); | ||
| expect(completeUrl.searchParams.get('state')).toBe(routes.state); | ||
| expect(callbackUrl.searchParams.get('state')).toBe(routes.state); | ||
| expect(routes.state).toMatch(/^[a-f0-9]{64}$/); | ||
| expect(callbackUrl.searchParams.get('return_url')).toContain('https://app.example.com/sso-callback'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('_authenticateWithPopup', () => { | ||
| it('only accepts a message from the FAPI origin, expected popup, and generated state', async () => { | ||
| const clerk = createClerk(); | ||
| const popup = { location: { href: '' } } as unknown as Window; | ||
| const navigate = vi.fn(); | ||
| const authenticateMethod = vi.fn().mockResolvedValue(undefined); | ||
| Object.assign(clerk, { navigate }); | ||
|
|
||
| await _authenticateWithPopup( | ||
| clerk, | ||
| 'signIn', | ||
| authenticateMethod, | ||
| { | ||
| popup, | ||
| strategy: 'oauth_google', | ||
| redirectUrl: 'https://app.example.com/sso-callback', | ||
| redirectUrlComplete: 'https://app.example.com/dashboard', | ||
| }, | ||
| vi.fn(), | ||
| ); | ||
|
|
||
| const callbackUrl = new URL(authenticateMethod.mock.calls[0][0].redirectUrl); | ||
| const state = callbackUrl.searchParams.get('state'); | ||
| const returnUrl = callbackUrl.searchParams.get('return_url'); | ||
|
|
||
| window.dispatchEvent( | ||
| new MessageEvent('message', { | ||
| data: { return_url: returnUrl, state }, | ||
| origin: 'https://accounts.example.com', | ||
| source: popup, | ||
| }), | ||
| ); | ||
| expect(navigate).not.toHaveBeenCalled(); | ||
|
|
||
| window.dispatchEvent( | ||
| new MessageEvent('message', { | ||
| data: { return_url: returnUrl, state }, | ||
| origin: 'https://clerk.example.com', | ||
| source: popup, | ||
| }), | ||
| ); | ||
| expect(navigate).toHaveBeenCalledWith(returnUrl); | ||
| }); | ||
| }); | ||
|
|
||
| describe('_futureAuthenticateWithPopup', () => { | ||
| it('only accepts a message from the FAPI origin, expected popup, and expected state', async () => { | ||
| const clerk = createClerk('https://app.example.com/__clerk'); | ||
| const popup = { location: { href: '' } } as unknown as Window; | ||
| const otherPopup = { location: { href: '' } } as unknown as Window; | ||
| const removeEventListener = vi.spyOn(window, 'removeEventListener'); | ||
| const authentication = _futureAuthenticateWithPopup(clerk, { | ||
| popup, | ||
| externalVerificationRedirectURL: new URL('https://oauth.example.com/authorize'), | ||
| state: 'expected_state', | ||
| }); | ||
|
|
||
| window.dispatchEvent( | ||
| new MessageEvent('message', { | ||
| data: { session: 'sess_123', state: 'expected_state' }, | ||
| origin: 'https://accounts.example.com', | ||
| source: popup, | ||
| }), | ||
| ); | ||
| window.dispatchEvent( | ||
| new MessageEvent('message', { | ||
| data: { session: 'sess_123', state: 'expected_state' }, | ||
| origin: 'https://app.example.com', | ||
| source: otherPopup, | ||
| }), | ||
| ); | ||
| window.dispatchEvent( | ||
| new MessageEvent('message', { | ||
| data: { session: 'sess_123', state: 'wrong_state' }, | ||
| origin: 'https://app.example.com', | ||
| source: popup, | ||
| }), | ||
| ); | ||
|
|
||
| expect(removeEventListener).not.toHaveBeenCalled(); | ||
|
|
||
| window.dispatchEvent( | ||
| new MessageEvent('message', { | ||
| data: { session: 'sess_123', state: 'expected_state' }, | ||
| origin: 'https://app.example.com', | ||
| source: popup, | ||
| }), | ||
| ); | ||
|
|
||
| await expect(authentication).resolves.toBeUndefined(); | ||
| expect(popup.location.href).toBe('https://oauth.example.com/authorize'); | ||
| expect(removeEventListener).toHaveBeenCalledWith('message', expect.any(Function)); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
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.
🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win
Cover direct popup state and source rejection.
This test only rejects an incorrect origin. Add valid-FAPI-origin events with an incorrect
stateand incorrectsourcebefore the matching event, so regressions in the new_authenticateWithPopupchecks cannot permit unintended navigation.Suggested coverage
As per coding guidelines, “Unit tests are required for all new functionality” and “Verify proper error handling and edge cases.”
📝 Committable suggestion
🤖 Prompt for AI Agents
Source: Coding guidelines