-
Notifications
You must be signed in to change notification settings - Fork 357
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
Changes from all commits
27e3600
264af78
c35c6ec
0087719
d51718a
efa1b2d
2112714
190f402
a00c9f4
e01d4f5
File filter
Filter by extension
Conversations
Jump to
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(); | ||
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. 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(); | ||
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 |
---|---|---|
@@ -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.
Show resolved
Hide resolved
|
||
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}` })}> | ||
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
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.
Show resolved
Hide resolved
|
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 loadingSessionTasks
withinSignIn
.I think the tradeoff is worth considering. I didn't want to introduce another
if (sessionTasksContext)
withinOrganizationList
to hijack the logic in there, but rather keep it separate.Ideally, would be nice to use
Suspense
to only download the necessary after-auth steps according toEnviroment
settings.