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(clerk-js): Do not display organization list after creating organization throw tasks flow#6117
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
27e3600264af78c35c6ec0087719d51718aefa1b2d2112714190f402a00c9f4e01d4f5File 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/clerk-js': patch | ||
| --- | ||
| Prevent organization list from displaying after creating an organization through the force organization selection flow |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1283,7 +1283,16 @@ export class Clerk implements ClerkInterface { | ||
| }; | ||
| public __experimental_navigateToTask = async ({ redirectUrlComplete }: NextTaskParams = {}): Promise<void> => { | ||
| const session = await this.session?.reload(); | ||
| /** | ||
| * Invalidate previously cache pages with auth state before navigating | ||
| */ | ||
| const onBeforeSetActive: SetActiveHook = | ||
| typeof window !== 'undefined' && typeof window.__unstable__onBeforeSetActive === 'function' | ||
| ? window.__unstable__onBeforeSetActive | ||
| : noop; | ||
| await onBeforeSetActive(); | ||
| const session = this.session; | ||
| if (!session || !this.environment) { | ||
| return; | ||
| } | ||
| @@ -1301,8 +1310,6 @@ export class Clerk implements ClerkInterface { | ||
| const tracker = createBeforeUnloadTracker(this.#options.standardBrowser); | ||
| const defaultRedirectUrlComplete = this.client?.signUp ? this.buildAfterSignUpUrl() : this.buildAfterSignInUrl(); | ||
| this.#setTransitiveState(); | ||
ContributorAuthor 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 do not need the transitive state here. It was causing the It makes sense when we're going from an empty session to an actual session, but since in this case we already have one, then I don't see the reason why to set a transitive state here. ContributorAuthor 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. Here you can see CleanShot.2025-06-18.at.11.44.35.mp4 | ||
| await tracker.track(async () => { | ||
| await this.navigate(redirectUrlComplete ?? defaultRedirectUrlComplete); | ||
| }); | ||
| @@ -1313,6 +1320,17 @@ export class Clerk implements ClerkInterface { | ||
| this.#setAccessors(session); | ||
| this.#emit(); | ||
| /** | ||
| * Invoke the Next.js middleware to synchronize server and client state after resolving a session task. | ||
| * This ensures that any server-side logic depending on the session status (like middleware-based | ||
| * redirects or protected routes) correctly reflects the updated client authentication state. | ||
| */ | ||
| const onAfterSetActive: SetActiveHook = | ||
| typeof window !== 'undefined' && typeof window.__unstable__onAfterSetActive === 'function' | ||
| ? window.__unstable__onAfterSetActive | ||
| : noop; | ||
| await onAfterSetActive(); | ||
| }; | ||
| public addListener = (listener: ListenerCallback): UnsubscribeCallback => { | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,8 @@ | ||
| import { useOrganization, useOrganizationList } from '@clerk/shared/react'; | ||
| import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types'; | ||
| import React from 'react'; | ||
| import React, { useContext } from 'react'; | ||
| import { SessionTasksContext } from '@/ui/contexts/components/SessionTasks'; | ||
| import { useCardState, withCardStateProvider } from '@/ui/elements/contexts'; | ||
| import { Form } from '@/ui/elements/Form'; | ||
| import { FormButtonContainer } from '@/ui/elements/FormButtons'; | ||
| @@ -23,7 +24,7 @@ import { organizationListParams } from '../OrganizationSwitcher/utils'; | ||
| type CreateOrganizationFormProps = { | ||
| skipInvitationScreen: boolean; | ||
| navigateAfterCreateOrganization: (organization: OrganizationResource) => Promise<unknown>; | ||
| navigateAfterCreateOrganization?: (organization: OrganizationResource) => Promise<unknown>; | ||
| onCancel?: () => void; | ||
| onComplete?: () => void; | ||
| flow: 'default' | 'organizationList'; | ||
| @@ -37,6 +38,7 @@ type CreateOrganizationFormProps = { | ||
| export const CreateOrganizationForm = withCardStateProvider((props: CreateOrganizationFormProps) => { | ||
| const card = useCardState(); | ||
| const wizard = useWizard({ onNextStep: () => card.setError(undefined) }); | ||
| const sessionTasksContext = useContext(SessionTasksContext); | ||
| const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null); | ||
| const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({ | ||
| @@ -87,6 +89,11 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani | ||
| void userMemberships.revalidate?.(); | ||
| if (sessionTasksContext) { | ||
| await sessionTasksContext.nextTask(); | ||
ContributorAuthor 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. This is a pretty similar order as we'd have for custom flows:
I've moved it inside of here now instead of passing it within | ||
| return; | ||
| } | ||
| if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) { | ||
| return completeFlow(); | ||
| } | ||
| @@ -100,7 +107,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani | ||
| const completeFlow = () => { | ||
| // We are confident that lastCreatedOrganizationRef.current will never be null | ||
| // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
| void props.navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!); | ||
| void props.navigateAfterCreateOrganization?.(lastCreatedOrganizationRef.current!); | ||
| props.onComplete?.(); | ||
| }; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,18 @@ | ||
| import { useClerk } from '@clerk/shared/react'; | ||
| import { eventComponentMounted } from '@clerk/shared/telemetry'; | ||
| import type { SessionTask } from '@clerk/types'; | ||
| import { useCallback, useContext, useEffect } from 'react'; | ||
| import { useCallback, useContext, useEffect, useState } from 'react'; | ||
| import { Card } from '@/ui/elements/Card'; | ||
| import { withCardStateProvider } from '@/ui/elements/contexts'; | ||
| import { LoadingCardContainer } from '@/ui/elements/LoadingCard'; | ||
| import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks'; | ||
| import { OrganizationListContext, SignInContext, SignUpContext } from '../../../ui/contexts'; | ||
| import { | ||
| SessionTasksContext as SessionTasksContext, | ||
| useSessionTasksContext, | ||
| } from '../../contexts/components/SessionTasks'; | ||
| import { SignInContext, SignUpContext } from '../../../ui/contexts'; | ||
| import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks'; | ||
| import { Route, Switch, useRouter } from '../../router'; | ||
| import { OrganizationList } from '../OrganizationList'; | ||
| import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection'; | ||
| const SessionTasksStart = withCardStateProvider(() => { | ||
| const SessionTasksStart = () => { | ||
| const clerk = useClerk(); | ||
| const { navigate } = useRouter(); | ||
| const { redirectUrlComplete } = useSessionTasksContext(); | ||
| @@ -37,20 +33,13 @@ const SessionTasksStart = withCardStateProvider(() => { | ||
| <Card.Footer /> | ||
| </Card.Root> | ||
| ); | ||
| }); | ||
| }; | ||
| function SessionTaskRoutes(): JSX.Element { | ||
| return ( | ||
| <Switch> | ||
| <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}> | ||
| <OrganizationListContext.Provider | ||
| value={{ | ||
| componentName: 'OrganizationList', | ||
| skipInvitationScreen: true, | ||
| }} | ||
| > | ||
| <OrganizationList /> | ||
| </OrganizationListContext.Provider> | ||
| <ForceOrganizationSelectionTask /> | ||
| </Route> | ||
| <Route index> | ||
| <SessionTasksStart /> | ||
| @@ -62,34 +51,55 @@ function SessionTaskRoutes(): JSX.Element { | ||
| /** | ||
| * @internal | ||
| */ | ||
| export function SessionTask(): JSX.Element { | ||
| export const SessionTask = withCardStateProvider(() => { | ||
| const clerk = useClerk(); | ||
| const { navigate } = useRouter(); | ||
| const signInContext = useContext(SignInContext); | ||
| const signUpContext = useContext(SignUpContext); | ||
| const [isNavigatingToTask, setIsNavigatingToTask] = useState(false); | ||
| const redirectUrlComplete = | ||
| signInContext?.afterSignInUrl ?? signUpContext?.afterSignUpUrl ?? clerk?.buildAfterSignInUrl(); | ||
| // If there are no pending tasks, navigate away from the tasks flow. | ||
| // This handles cases where a user with an active session returns to the tasks URL, | ||
| // for example by using browser back navigation. Since there are no pending tasks, | ||
| // we redirect them to their intended destination. | ||
| useEffect(() => { | ||
| const task = clerk.session?.currentTask; | ||
| if (isNavigatingToTask) { | ||
| return; | ||
| } | ||
| if (!task) { | ||
| // Tasks can only exist on pending sessions, but we check both conditions | ||
| // here to be defensive and ensure proper redirection | ||
| const task = clerk.session?.currentTask; | ||
| if (!task || clerk.session?.status === 'active') { | ||
| void navigate(redirectUrlComplete); | ||
| return; | ||
| } | ||
| clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key })); | ||
| }, [clerk, navigate, redirectUrlComplete]); | ||
| }, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]); | ||
LauraBeatris marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| const nextTask = useCallback( | ||
| () => clerk.__experimental_navigateToTask({ redirectUrlComplete }), | ||
| [clerk, redirectUrlComplete], | ||
| ); | ||
| const nextTask = useCallback(() => { | ||
| setIsNavigatingToTask(true); | ||
| return clerk.__experimental_navigateToTask({ redirectUrlComplete }).finally(() => setIsNavigatingToTask(false)); | ||
| }, [clerk, redirectUrlComplete]); | ||
LauraBeatris marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| if (!clerk.session?.currentTask) { | ||
| return ( | ||
| <Card.Root> | ||
| <Card.Content> | ||
| <LoadingCardContainer /> | ||
| </Card.Content> | ||
| <Card.Footer /> | ||
| </Card.Root> | ||
| ); | ||
| } | ||
| return ( | ||
| <SessionTasksContext.Provider value={{ nextTask, redirectUrlComplete }}> | ||
| <SessionTaskRoutes /> | ||
| </SessionTasksContext.Provider> | ||
| ); | ||
| } | ||
| }); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import { useOrganizationList } from '@clerk/shared/react/index'; | ||
| import type { PropsWithChildren } from 'react'; | ||
| import { useState } from 'react'; | ||
| import { OrganizationListContext } from '@/ui/contexts'; | ||
| import { Card } from '@/ui/elements/Card'; | ||
| import { useCardState, withCardStateProvider } from '@/ui/elements/contexts'; | ||
| import { Box, descriptors, Flex, localizationKeys, Spinner } from '../../../customizables'; | ||
| import { CreateOrganizationForm } from '../../CreateOrganization/CreateOrganizationForm'; | ||
| import { OrganizationListPageList } from '../../OrganizationList/OrganizationListPage'; | ||
| import { organizationListParams } from '../../OrganizationSwitcher/utils'; | ||
| /** | ||
| * @internal | ||
| */ | ||
| export const ForceOrganizationSelectionTask = withCardStateProvider(() => { | ||
| const { userMemberships, userInvitations, userSuggestions } = useOrganizationList(organizationListParams); | ||
| const isLoading = userMemberships?.isLoading || userInvitations?.isLoading || userSuggestions?.isLoading; | ||
| const hasData = !!(userMemberships?.count || userInvitations?.count || userSuggestions?.count); | ||
LauraBeatris marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| if (isLoading) { | ||
| return ( | ||
| <FlowCard> | ||
| <FlowLoadingState /> | ||
| </FlowCard> | ||
| ); | ||
| } | ||
| if (hasData) { | ||
| return <OrganizationSelectionPage />; | ||
| } | ||
| return <CreateOrganizationPage />; | ||
| }); | ||
| const OrganizationSelectionPage = () => { | ||
| const [showCreateOrganizationForm, setShowCreateOrganizationForm] = useState(false); | ||
| return ( | ||
| <OrganizationListContext.Provider | ||
| value={{ | ||
| componentName: 'OrganizationList', | ||
| skipInvitationScreen: true, | ||
| }} | ||
| > | ||
| <FlowCard> | ||
| {showCreateOrganizationForm ? ( | ||
| <Box | ||
| sx={t => ({ | ||
| padding: `${t.space.$none} ${t.space.$5} ${t.space.$5}`, | ||
| })} | ||
| > | ||
| <CreateOrganizationForm | ||
| flow='default' | ||
| startPage={{ headerTitle: localizationKeys('organizationList.createOrganization') }} | ||
| skipInvitationScreen | ||
| onCancel={() => setShowCreateOrganizationForm(false)} | ||
| /> | ||
| </Box> | ||
| ) : ( | ||
| <OrganizationListPageList onCreateOrganizationClick={() => setShowCreateOrganizationForm(true)} /> | ||
| )} | ||
| </FlowCard> | ||
| </OrganizationListContext.Provider> | ||
| ); | ||
| }; | ||
| const CreateOrganizationPage = () => { | ||
| return ( | ||
| <FlowCard> | ||
| <Box | ||
| sx={t => ({ | ||
| padding: `${t.space.$none} ${t.space.$5} ${t.space.$5}`, | ||
| })} | ||
| > | ||
| <CreateOrganizationForm | ||
| flow='default' | ||
| startPage={{ headerTitle: localizationKeys('organizationList.createOrganization') }} | ||
| skipInvitationScreen | ||
| /> | ||
| </Box> | ||
| </FlowCard> | ||
| ); | ||
| }; | ||
| const FlowCard = ({ children }: PropsWithChildren) => { | ||
| const card = useCardState(); | ||
| return ( | ||
| <Card.Root> | ||
| <Card.Content sx={t => ({ padding: `${t.space.$8} ${t.space.$none} ${t.space.$none}` })}> | ||
ContributorAuthor 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. | ||
| <Card.Alert sx={t => ({ margin: `${t.space.$none} ${t.space.$5}` })}>{card.error}</Card.Alert> | ||
| {children} | ||
| </Card.Content> | ||
| <Card.Footer /> | ||
| </Card.Root> | ||
| ); | ||
| }; | ||
| const FlowLoadingState = () => ( | ||
| <Flex | ||
| direction='row' | ||
| center | ||
| sx={t => ({ | ||
| height: '100%', | ||
| minHeight: t.sizes.$60, | ||
| })} | ||
Comment on lines
+105
to
+108
ContributorAuthor 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 need to set a min-height on the loading state while the create organization form isn't rendered. Ideally, the loading container should have a similar height as the create organization form / organization list, however it's not possible to know ahead of time since we need to wait for the | ||
| > | ||
| <Spinner | ||
| size='xl' | ||
| colorScheme='primary' | ||
| elementDescriptor={descriptors.spinner} | ||
| /> | ||
| </Flex> | ||
| ); | ||
LauraBeatris marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
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.
The bundle increased around 4KB since I extracted the force-an-org flow outside of
OrganizationList. It increased the general bundle, but we are lazy loadingSessionTaskswithinSignIn.I think the tradeoff is worth considering. I didn't want to introduce another
if (sessionTasksContext)withinOrganizationListto hijack the logic in there, but rather keep it separate.Ideally, would be nice to use
Suspenseto only download the necessary after-auth steps according toEnviromentsettings.