Repository navigation
fix(react): notify status listener on subscribe so ClerkLoading resolves after remount #10465
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
Closed
Closed
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/react': patch | ||
| --- | ||
|
|
||
| Fix `<ClerkLoading>` staying rendered and `<ClerkLoaded>` never rendering when a `<ClerkProvider>` remounts after Clerk has already loaded, for example after navigating away from and back to a layout that contains it. |
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
38 changes: 38 additions & 0 deletions
38
packages/react/src/contexts/__tests__/ClerkProvider.status.test.tsx
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,38 @@ | ||
| import { render } from '@testing-library/react'; | ||
| import React from 'react'; | ||
| import { describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| import { IsomorphicClerk } from '../../isomorphicClerk'; | ||
| import { ClerkProvider } from '../ClerkProvider'; | ||
|
|
||
| vi.mock('../../isomorphicClerk', () => { | ||
| let instance: any; | ||
| class IsomorphicClerk { | ||
| status = 'loading'; | ||
| on = vi.fn(); | ||
| off = vi.fn(); | ||
| __internal_updateProps = vi.fn().mockResolvedValue(undefined); | ||
| static getOrCreateInstance() { | ||
| instance ??= new IsomorphicClerk(); | ||
| return instance; | ||
| } | ||
| static clearInstance() { | ||
| instance = undefined; | ||
| } | ||
| } | ||
| return { IsomorphicClerk }; | ||
| }); | ||
|
|
||
| describe('ClerkProvider status subscription', () => { | ||
| it('subscribes with notify so a remount receives the current status', () => { | ||
| const { unmount } = render( | ||
| <ClerkProvider publishableKey='pk_test_Y2xlcmsuY2xlcmsuZGV2JA'> | ||
| <div /> | ||
| </ClerkProvider>, | ||
| ); | ||
| const instance = IsomorphicClerk.getOrCreateInstance({} as any) as any; | ||
|
|
||
| expect(instance.on).toHaveBeenCalledWith('status', expect.any(Function), { notify: true }); | ||
| unmount(); | ||
| }); | ||
| }); | ||
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.
Script executed:
Repository: clerk/javascript
Length of output: 3361
Script executed:
Repository: clerk/javascript
Length of output: 8469
Script executed:
Repository: clerk/javascript
Length of output: 34020
Test the remount behavior.
The mocked
onmethod never invokes the status listener. The test renders oneClerkProvider, checks the subscription arguments, and unmounts it. It does not verify that a remounted provider updatesClerkLoadingandClerkLoaded.