-
Notifications
You must be signed in to change notification settings - Fork 288
feat: add passkey API support for signup and login methods #1114
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
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
32e27cf
feat: add passkey API support for signup and login methods
amitsingh05667 b26245e
fix test case
amitsingh05667 e8450f7
Merge branch 'main' into SDK-8775
amitsingh05667 e6d1945
docs: add passkeys section with setup, signup, login, and error handl…
amitsingh05667 3574bf2
docs: add Passkey API support documentation with usage examples and t…
amitsingh05667 28b6c01
docs: add important note on using refresh tokens with passkeys
amitsingh05667 20277e3
remove unused passkey-related types from index export
amitsingh05667 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
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,143 @@ | ||
| import { Auth0Client, TokenEndpointResponse } from '@auth0/auth0-spa-js'; | ||
| import { act, renderHook, waitFor } from '@testing-library/react'; | ||
| import useAuth0 from '../src/use-auth0'; | ||
| import { createWrapper } from './helpers'; | ||
|
|
||
| const clientMock = jest.mocked(new Auth0Client({ clientId: '', domain: '' })); | ||
|
|
||
| describe('Passkey API', () => { | ||
| describe('Basic Availability', () => { | ||
| it('should provide passkey client through useAuth0', async () => { | ||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => { | ||
| expect(result.current.passkey).toBeDefined(); | ||
| }); | ||
| }); | ||
|
|
||
| it('should provide signup and login methods', async () => { | ||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => { | ||
| expect(result.current.passkey.signup).toBeDefined(); | ||
| expect(result.current.passkey.login).toBeDefined(); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('passkey.signup', () => { | ||
| it('should return token response', async () => { | ||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => expect(result.current.isLoading).toBe(false)); | ||
|
|
||
| let tokenResponse: TokenEndpointResponse | undefined; | ||
| await act(async () => { | ||
| tokenResponse = await result.current.passkey.signup({ email: 'user@example.com' }); | ||
| }); | ||
|
|
||
| expect(tokenResponse).toBeDefined(); | ||
| expect(tokenResponse?.access_token).toBe('passkey-token'); | ||
| expect(tokenResponse?.id_token).toBe('passkey-id-token'); | ||
| }); | ||
|
|
||
| it('should dispatch state update after signup', async () => { | ||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => expect(result.current.isLoading).toBe(false)); | ||
|
|
||
| await act(async () => { | ||
| await result.current.passkey.signup({ email: 'user@example.com' }); | ||
| }); | ||
|
|
||
| await waitFor(() => { | ||
| expect(result.current.isLoading).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| it('should rethrow errors from passkey.signup', async () => { | ||
| clientMock.passkey.signup.mockRejectedValueOnce(new Error('WebAuthn not supported')); | ||
|
|
||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => expect(result.current.isLoading).toBe(false)); | ||
|
|
||
| await expect( | ||
| act(async () => { | ||
| await result.current.passkey.signup({ email: 'user@example.com' }); | ||
| }) | ||
| ).rejects.toThrow('WebAuthn not supported'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('passkey.login', () => { | ||
| it('should return token response', async () => { | ||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => expect(result.current.isLoading).toBe(false)); | ||
|
|
||
| let tokenResponse: TokenEndpointResponse | undefined; | ||
| await act(async () => { | ||
| tokenResponse = await result.current.passkey.login(); | ||
| }); | ||
|
|
||
| expect(tokenResponse).toBeDefined(); | ||
| expect(tokenResponse?.access_token).toBe('passkey-token'); | ||
| }); | ||
|
|
||
| it('should forward options to the underlying client', async () => { | ||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => expect(result.current.isLoading).toBe(false)); | ||
|
|
||
| await act(async () => { | ||
| await result.current.passkey.login({ | ||
| realm: 'Username-Password-Authentication', | ||
| scope: 'openid profile email', | ||
| }); | ||
| }); | ||
|
|
||
| expect(clientMock.passkey.login).toHaveBeenCalledWith({ | ||
| realm: 'Username-Password-Authentication', | ||
| scope: 'openid profile email', | ||
| }); | ||
| }); | ||
|
|
||
| it('should dispatch state update after login', async () => { | ||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => expect(result.current.isLoading).toBe(false)); | ||
|
|
||
| await act(async () => { | ||
| await result.current.passkey.login(); | ||
| }); | ||
|
|
||
| await waitFor(() => { | ||
| expect(result.current.isLoading).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| it('should rethrow errors from passkey.login', async () => { | ||
| clientMock.passkey.login.mockRejectedValueOnce(new Error('User cancelled')); | ||
|
|
||
| const wrapper = createWrapper(); | ||
| const { result } = renderHook(() => useAuth0(), { wrapper }); | ||
|
|
||
| await waitFor(() => expect(result.current.isLoading).toBe(false)); | ||
|
|
||
| await expect( | ||
| act(async () => { | ||
| await result.current.passkey.login(); | ||
| }) | ||
| ).rejects.toThrow('User cancelled'); | ||
| }); | ||
| }); | ||
| }); |
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.
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.
Uh oh!
There was an error while loading. Please reload this page.