Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 469
fix(vue): Defer useOrganization environment check until Clerk is loaded#7982
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
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@clerk/vue": patch | ||
| --- | ||
| Fixed an issue where `useOrganization` would show an incorrect warning and dialog due to checking environment settings before Clerk was fully loaded. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| import type { Clerk } from '@clerk/shared/types'; | ||
| import { render } from '@testing-library/vue'; | ||
| import { vi } from 'vitest'; | ||
| import { defineComponent, shallowRef } from 'vue'; | ||
| import { useOrganization } from '../useOrganization'; | ||
| const mockAttemptToEnableEnvironmentSetting = vi.fn(); | ||
| const mockLoaded = shallowRef(false); | ||
| const mockClerk = shallowRef<Partial<Clerk> | null>(null); | ||
| vi.mock('../useClerkContext', () => ({ | ||
| useClerkContext: () => ({ | ||
| loaded: mockLoaded, | ||
| clerk: mockClerk, | ||
| organizationCtx: shallowRef(undefined), | ||
| }), | ||
| })); | ||
| vi.mock('../useSession', () => ({ | ||
| useSession: () => ({ | ||
| session: shallowRef(null), | ||
| }), | ||
| })); | ||
| describe('useOrganization', () => { | ||
| beforeEach(() => { | ||
| vi.clearAllMocks(); | ||
| mockLoaded.value = false; | ||
| mockClerk.value = null; | ||
| }); | ||
| it('should not call __internal_attemptToEnableEnvironmentSetting before Clerk is loaded', () => { | ||
| mockClerk.value = { | ||
| __internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting, | ||
| }; | ||
| const Component = defineComponent(() => { | ||
| useOrganization(); | ||
| return () => null; | ||
| }); | ||
| render(Component); | ||
| expect(mockAttemptToEnableEnvironmentSetting).not.toHaveBeenCalled(); | ||
| }); | ||
| it('should call __internal_attemptToEnableEnvironmentSetting after Clerk is loaded', async () => { | ||
| mockClerk.value = { | ||
| __internal_attemptToEnableEnvironmentSetting: mockAttemptToEnableEnvironmentSetting, | ||
| }; | ||
| const Component = defineComponent(() => { | ||
| useOrganization(); | ||
| return () => null; | ||
| }); | ||
| render(Component); | ||
| mockLoaded.value = true; | ||
| await vi.waitFor(() => { | ||
| expect(mockAttemptToEnableEnvironmentSetting).toHaveBeenCalledWith({ | ||
| for: 'organizations', | ||
| caller: 'useOrganization', | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -53,21 +53,23 @@ type UseOrganization = () => ToComputedRefs<UseOrganizationReturn>; | ||
| * </template> | ||
| */ | ||
| export const useOrganization: UseOrganization = () => { | ||
| const { clerk, organizationCtx } = useClerkContext('useOrganization'); | ||
| const { loaded, clerk, organizationCtx } = useClerkContext('useOrganization'); | ||
| const { session } = useSession(); | ||
| watch( | ||
| clerk, | ||
| loaded, | ||
| value => { | ||
| if (value) { | ||
| // Optional chaining is important for `@clerk/vue` usage with older clerk-js versions that don't have the method | ||
| value.__internal_attemptToEnableEnvironmentSetting?.({ | ||
| clerk.value?.__internal_attemptToEnableEnvironmentSetting?.({ | ||
MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We are confident that | ||
| for: 'organizations', | ||
| caller: 'useOrganization', | ||
| }); | ||
| } | ||
| }, | ||
| { once: true }, | ||
| { | ||
| once: true, | ||
| }, | ||
| ); | ||
| const result = computed<UseOrganizationReturn>(() => { | ||
| @@ -80,7 +82,7 @@ export const useOrganization: UseOrganization = () => { | ||
| } | ||
| /** In SSR context we include only the organization object when loadOrg is set to true. */ | ||
| if (!clerk.value?.loaded) { | ||
| if (!loaded.value) { | ||
| return { | ||
| isLoaded: true, | ||
| organization: organizationCtx.value, | ||
| @@ -89,7 +91,7 @@ export const useOrganization: UseOrganization = () => { | ||
| } | ||
| return { | ||
| isLoaded: clerk.value.loaded, | ||
| isLoaded: loaded.value, | ||
| organization: organizationCtx.value, | ||
| membership: getCurrentOrganizationMembership( | ||
| // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
Uh oh!
There was an error while loading. Please reload this page.
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.
This
loadedref is set totruewhenClerk.load()succeeds so this is more reliable