Skip to content

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

Merged
5 changes: 5 additions & 0 deletions .changeset/common-mice-ring.md
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
12 changes: 6 additions & 6 deletions packages/clerk-js/bundlewatch.config.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "610.32kB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "70.2KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "108.75KB" },
{ "path": "./dist/clerk.js", "maxSize": "612kB" },
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CleanShot 2025-06-18 at 13 21 54

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 loading SessionTasks within SignIn.

I think the tradeoff is worth considering. I didn't want to introduce another if (sessionTasksContext) within OrganizationList 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 to Enviroment settings.

{ "path": "./dist/clerk.browser.js", "maxSize": "72.2KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "115KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "110KB" },
{ "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand All @@ -25,6 +25,6 @@
{ "path": "./dist/paymentSources*.js", "maxSize": "9.17KB" },
{ "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
{ "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
{ "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
{ "path": "./dist/sessionTasks*.js", "maxSize": "1.5KB" }
]
}
24 changes: 21 additions & 3 deletions packages/clerk-js/src/core/clerk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand All @@ -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();
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not need the transitive state here. It was causing the SignIn component to unmount due to withCoreSessionGuard that does not render its children when session === undefined

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here you can see SignIn getting unmounted due to this.#setTransitiveState();:

CleanShot.2025-06-18.at.11.44.35.mp4


await tracker.track(async () => {
await this.navigate(redirectUrlComplete ?? defaultRedirectUrlComplete);
});
Expand All @@ -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 => {
Expand Down
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';
Expand All @@ -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';
Expand All @@ -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({
Expand Down Expand Up @@ -87,6 +89,11 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
Copy link
Member Author

Choose a reason for hiding this comment

The 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:

  1. Create an organization
  2. Update it to the active session
  3. Verify if there are remaining tasks, and if so, navigate to the next one.

I've moved it inside of here now instead of passing it within onComplete prop so that we can await for it. onComplete is a sync property and I don't think we should turn into a promise in order to avoid side effects.

return;
}

if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand All @@ -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?.();
};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useContext, useState } from 'react';
import { useState } from 'react';

import { Action, Actions } from '@/ui/elements/Actions';
import { Card } from '@/ui/elements/Card';
import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { Header } from '@/ui/elements/Header';

import { useEnvironment, useOrganizationListContext } from '../../contexts';
import { SessionTasksContext } from '../../contexts/components/SessionTasks';
import { Box, Col, descriptors, Flex, localizationKeys, Spinner } from '../../customizables';
import { useInView } from '../../hooks';
import { Add } from '../../icons';
Expand Down Expand Up @@ -116,7 +115,6 @@ export const OrganizationListPage = withCardStateProvider(() => {
const OrganizationListFlows = ({ showListInitially }: { showListInitially: boolean }) => {
const { navigateAfterCreateOrganization, skipInvitationScreen, hideSlug } = useOrganizationListContext();
const [isCreateOrganizationFlow, setCreateOrganizationFlow] = useState(!showListInitially);
const sessionTasksContext = useContext(SessionTasksContext);
return (
<>
{!isCreateOrganizationFlow && (
Expand All @@ -131,7 +129,6 @@ const OrganizationListFlows = ({ showListInitially }: { showListInitially: boole
>
<CreateOrganizationForm
flow='organizationList'
onComplete={sessionTasksContext?.nextTask}
startPage={{ headerTitle: localizationKeys('organizationList.createOrganization') }}
skipInvitationScreen={skipInvitationScreen}
navigateAfterCreateOrganization={org =>
Expand All @@ -148,7 +145,7 @@ const OrganizationListFlows = ({ showListInitially }: { showListInitially: boole
);
};

const OrganizationListPageList = (props: { onCreateOrganizationClick: () => void }) => {
export const OrganizationListPageList = (props: { onCreateOrganizationClick: () => void }) => {
const environment = useEnvironment();

const { ref, userMemberships, userSuggestions, userInvitations } = useOrganizationListInView();
Expand Down
64 changes: 37 additions & 27 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
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();
Expand All @@ -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 />
Expand All @@ -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]);

const nextTask = useCallback(
() => clerk.__experimental_navigateToTask({ redirectUrlComplete }),
[clerk, redirectUrlComplete],
);
const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk.__experimental_navigateToTask({ redirectUrlComplete }).finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);

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);

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}` })}>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're resetting the padding on the boundaries in order to have the divider:

image

Otherwise it'd stay like that:

image

<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
Copy link
Member Author

Choose a reason for hiding this comment

The 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 useOrganizationList query to finish.

>
<Spinner
size='xl'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
/>
</Flex>
);
Loading
Loading