Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/quiet-moons-shine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Enable self-serve OIDC configuration for every application. Organization admins can now select an OIDC provider in the `<OrganizationProfile />` Security tab without the `experimental.oidcSelfServe` option, and existing OIDC connections open their configuration steps instead of the unsupported-provider state. The `experimental.oidcSelfServe` option no longer does anything and can be removed from `<ClerkProvider />` and `Clerk.load()`.
4 changes: 0 additions & 4 deletions packages/shared/src/types/clerk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1513,10 +1513,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
* directly with the provided Clerk instance. Used by React Native / Expo.
*/
runtimeEnvironment: 'headless';
/**
* Temporary flag that gates the self-serve OIDC flow in `<ConfigureSSO />`. Remove once the self-serve OIDC flow reaches GA.
*/
oidcSelfServe: boolean;
},
Record<string, any>
>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import type { EnterpriseConnectionResource, OrganizationDomainResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

import { useOptions } from '@/contexts';

import type { OrganizationEnterpriseConnection } from './domain/organizationEnterpriseConnection';
import type {
EnterpriseConnectionMutations,
Expand All @@ -28,8 +26,6 @@ export interface ConfigureSSOData {
testRuns: TestRunsView;
organizationDomains: OrganizationDomainResource[] | undefined;
onExit?: () => void;
/** Temporary gate for the self-serve OIDC flow; remove at OIDC GA. */
isOIDCFlowEnabled: boolean;
}

interface ConfigureSSOProviderProps {
Expand Down Expand Up @@ -57,8 +53,6 @@ export const ConfigureSSOProvider = ({
onExit,
children,
}: PropsWithChildren<ConfigureSSOProviderProps>): JSX.Element => {
const isOIDCFlowEnabled = useOptions().experimental?.oidcSelfServe ?? false;

const value = React.useMemo<ConfigureSSOData>(
() => ({
contentRef,
Expand All @@ -69,7 +63,6 @@ export const ConfigureSSOProvider = ({
enterpriseConnectionMutations,
organizationDomainMutations,
onExit,
isOIDCFlowEnabled,
}),
[
contentRef,
Expand All @@ -80,7 +73,6 @@ export const ConfigureSSOProvider = ({
organizationDomains,
enterpriseConnection,
onExit,
isOIDCFlowEnabled,
],
);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import type { EnterpriseConnectionProviderType } from '../../../types';
// left undefined so that footer self-hides in this isolated render.
const contextState = vi.hoisted(() => ({
provider: undefined as string | undefined,
isOIDCFlowEnabled: true,
enterpriseConnection: undefined as
| {
id: string;
Expand Down Expand Up @@ -45,7 +44,6 @@ vi.mock('../../../ConfigureSSOContext', () => ({
provider: contextState.provider,
hasConnection: true,
},
isOIDCFlowEnabled: contextState.isOIDCFlowEnabled,
}),
}));

Expand All @@ -63,34 +61,28 @@ const { createFixtures } = bindCreateFixtures('ConfigureSSO');

describe('resolveConfigureSteps', () => {
it('dispatches custom and legacy OIDC provider keys to the OIDC sub-flow', () => {
expect(resolveConfigureSteps('oauth_custom_clerk_dev', true)).toBe(OidcCustomConfigureSteps);
expect(resolveConfigureSteps('oidc_clerk_dev', true)).toBe(OidcCustomConfigureSteps);
expect(resolveConfigureSteps('oidc_ghe_acme', true)).toBe(OidcCustomConfigureSteps);
expect(resolveConfigureSteps('oidc_gitlab_ent_acme', true)).toBe(OidcCustomConfigureSteps);
expect(resolveConfigureSteps('oidc_custom', true)).toBe(OidcCustomConfigureSteps);
});

it('does not dispatch OIDC providers while the experimental flow is disabled', () => {
expect(resolveConfigureSteps('oauth_custom_clerk_dev', false)).toBeUndefined();
expect(resolveConfigureSteps('oidc_clerk_dev', false)).toBeUndefined();
expect(resolveConfigureSteps('oauth_custom_clerk_dev')).toBe(OidcCustomConfigureSteps);
expect(resolveConfigureSteps('oidc_clerk_dev')).toBe(OidcCustomConfigureSteps);
expect(resolveConfigureSteps('oidc_ghe_acme')).toBe(OidcCustomConfigureSteps);
expect(resolveConfigureSteps('oidc_gitlab_ent_acme')).toBe(OidcCustomConfigureSteps);
expect(resolveConfigureSteps('oidc_custom')).toBe(OidcCustomConfigureSteps);
});

it('dispatches SAML providers by exact literal', () => {
expect(resolveConfigureSteps('saml_okta', false)).toBe(SamlOktaConfigureSteps);
expect(resolveConfigureSteps('saml_custom', false)).toBe(SamlCustomConfigureSteps);
expect(resolveConfigureSteps('saml_google', false)).toBe(SamlGoogleConfigureSteps);
expect(resolveConfigureSteps('saml_microsoft', false)).toBe(SamlMicrosoftConfigureSteps);
expect(resolveConfigureSteps('saml_okta')).toBe(SamlOktaConfigureSteps);
expect(resolveConfigureSteps('saml_custom')).toBe(SamlCustomConfigureSteps);
expect(resolveConfigureSteps('saml_google')).toBe(SamlGoogleConfigureSteps);
expect(resolveConfigureSteps('saml_microsoft')).toBe(SamlMicrosoftConfigureSteps);
});

it('returns undefined for an unrecognized provider so the caller can degrade', () => {
expect(resolveConfigureSteps('ldap_enterprise' as EnterpriseConnectionProviderType, true)).toBeUndefined();
expect(resolveConfigureSteps('ldap_enterprise' as EnterpriseConnectionProviderType)).toBeUndefined();
});
});

describe('ConfigureProviderStep', () => {
beforeEach(() => {
contextState.provider = undefined;
contextState.isOIDCFlowEnabled = true;
contextState.enterpriseConnection = undefined;
updateConnection.mockReset();
});
Expand Down Expand Up @@ -469,15 +461,4 @@ describe('ConfigureProviderStep', () => {

expect(await screen.findByText(/unsupported provider/i)).toBeInTheDocument();
});

it('degrades to the unsupported-provider state for an existing OIDC connection when the flag is off', async () => {
contextState.provider = 'oauth_custom_clerk_dev';
contextState.isOIDCFlowEnabled = false;
const { wrapper } = await createFixtures();

renderStep(wrapper);

expect(await screen.findByText(/unsupported provider/i)).toBeInTheDocument();
expect(screen.queryByText(/create a new oidc application/i)).not.toBeInTheDocument();
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,8 @@ const STEPS_BY_SAML_PROVIDER: Record<SamlProviderType, ConfigureStepsComponent>

export const resolveConfigureSteps = (
provider: EnterpriseConnectionProviderType,
isOIDCFlowEnabled: boolean,
): ConfigureStepsComponent | undefined => {
if (isOidcProvider(provider)) {
return isOIDCFlowEnabled ? OidcCustomConfigureSteps : undefined;
}
return STEPS_BY_SAML_PROVIDER[provider];
};
): ConfigureStepsComponent | undefined =>
isOidcProvider(provider) ? OidcCustomConfigureSteps : STEPS_BY_SAML_PROVIDER[provider];

export const ConfigureStep = (): JSX.Element => {
const { organizationEnterpriseConnection: c } = useConfigureSSO();
Expand Down Expand Up @@ -68,13 +63,13 @@ export const ConfigureStep = (): JSX.Element => {
};

export const ConfigureProviderStep = (): JSX.Element | null => {
const { organizationEnterpriseConnection: c, isOIDCFlowEnabled } = useConfigureSSO();
const { organizationEnterpriseConnection: c } = useConfigureSSO();

if (!c.provider) {
return null;
}

const ConfigureSteps = resolveConfigureSteps(c.provider, isOIDCFlowEnabled);
const ConfigureSteps = resolveConfigureSteps(c.provider);

return (
<Flow.Part part='configureCreateApp'>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,10 @@ export const SelectProviderStep = (): JSX.Element => {
organizationEnterpriseConnection: c,
enterpriseConnectionMutations: { createConnection, changeProvider },
contentRef,
isOIDCFlowEnabled,
} = useConfigureSSO();
const { goNext, goPrev, isFirstStep } = useWizard();
const { t } = useLocalizations();

const providerGroups = React.useMemo(
() => PROVIDER_GROUPS.filter(group => group.id !== 'oidc' || isOIDCFlowEnabled),
[isOIDCFlowEnabled],
);

const currentCard = c.provider ? toProviderCard(c.provider) : null;

const [selected, setSelected] = React.useState<ProviderType | null>(currentCard);
Expand Down Expand Up @@ -166,7 +160,7 @@ export const SelectProviderStep = (): JSX.Element => {

<Step.Body>
<Step.Section sx={theme => ({ gap: theme.space.$5 })}>
{providerGroups.map(group => (
{PROVIDER_GROUPS.map(group => (
<Col
key={group.id}
elementDescriptor={descriptors.configureSSOProviderGroup}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ const changeProvider = vi.fn();
const contextState = vi.hoisted(() => ({
provider: undefined as 'saml_okta' | 'saml_custom' | 'saml_google' | undefined,
hasConnection: false,
isOIDCFlowEnabled: false,
}));

vi.mock('../../ConfigureSSOContext', () => ({
Expand All @@ -40,7 +39,6 @@ vi.mock('../../ConfigureSSOContext', () => ({
provider: contextState.provider,
hasConnection: contextState.hasConnection,
},
isOIDCFlowEnabled: contextState.isOIDCFlowEnabled,
}),
}));

Expand All @@ -64,7 +62,6 @@ const resetMocks = () => {
changeProvider.mockResolvedValue(undefined);
contextState.provider = undefined;
contextState.hasConnection = false;
contextState.isOIDCFlowEnabled = false;
};

describe('SelectProviderStep', () => {
Expand Down Expand Up @@ -96,7 +93,7 @@ describe('SelectProviderStep', () => {
// Each provider card is a <label> wrapping a visually-hidden native radio; the
// aria-hidden icon span lives inside it.
const iconSpans = Array.from(container.querySelectorAll('label span[aria-hidden]'));
expect(iconSpans).toHaveLength(4);
expect(iconSpans).toHaveLength(5);

const collectedStyles = [
...Array.from(document.head.querySelectorAll('style')).map(s => s.textContent ?? ''),
Expand All @@ -106,26 +103,16 @@ describe('SelectProviderStep', () => {
expect(collectedStyles).toMatch(/img\.clerk\.com\/static\/okta\.svg/);
expect(collectedStyles).toMatch(/img\.clerk\.com\/static\/saml\.svg/);
expect(collectedStyles).toMatch(/img\.clerk\.com\/static\/google\.svg/);
expect(collectedStyles).toMatch(/img\.clerk\.com\/static\/oidc\.svg/);
});

describe('OIDC provider (experimental flag)', () => {
it('hides the OIDC provider tile when the flag is off', async () => {
resetMocks();
const { wrapper } = await createFixtures();
const { container } = renderStep(wrapper);

expect(screen.getByRole('radio', { name: 'Okta Workforce' })).toBeInTheDocument();
expect(container.querySelector('input[value="oidc_custom"]')).not.toBeInTheDocument();
});

it('shows the OIDC provider tile when the flag is on', async () => {
resetMocks();
contextState.isOIDCFlowEnabled = true;
const { wrapper } = await createFixtures();
const { container } = renderStep(wrapper);
it('renders the OIDC provider tile', async () => {
resetMocks();
const { wrapper } = await createFixtures();
const { container } = renderStep(wrapper);

expect(container.querySelector('input[value="oidc_custom"]')).toBeInTheDocument();
});
expect(screen.getByRole('radio', { name: 'Okta Workforce' })).toBeInTheDocument();
expect(container.querySelector('input[value="oidc_custom"]')).toBeInTheDocument();
});

it('disables Continue when no provider is selected', async () => {
Expand Down
Loading