Skip to content
Open
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
21 changes: 15 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();

Check warning on line 35 in packages/expo/src/hooks/useOAuth.ts

View workflow job for this annotation

GitHub Actions / Static analysis

React Hook "useSignIn" is called conditionally. React Hooks must be called in the exact same order in every component render. Did you accidentally call a React Hook after an early return?
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

Check warning on line 36 in packages/expo/src/hooks/useOAuth.ts

View workflow job for this annotation

GitHub Actions / Static analysis

React Hook "useSignUp" is called conditionally. React Hooks must be called in the exact same order in every component render. Did you accidentally call a React Hook after an early return?

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
if (!isSignInLoaded || !isSignUpLoaded) {
Expand Down Expand Up @@ -77,13 +77,22 @@

const { externalVerificationRedirectURL } = signIn.firstFactorVerification;

const authSessionResult = await WebBrowserModule.openAuthSessionAsync(
// @ts-ignore
externalVerificationRedirectURL.toString(),
oauthRedirectUrl,
);
let authSessionResult: WebBrowser.WebBrowserAuthSessionResult;
try {
authSessionResult = await WebBrowserModule.openAuthSessionAsync(
// @ts-ignore

Check warning on line 83 in packages/expo/src/hooks/useOAuth.ts

View workflow job for this annotation

GitHub Actions / Static analysis

Include a description after the "@ts-ignore" directive to explain why the @ts-ignore is necessary. The description must be 3 characters or longer
externalVerificationRedirectURL.toString(),
oauthRedirectUrl,
);
} finally {
try {
await WebBrowserModule.dismissBrowser();

Check warning on line 89 in packages/expo/src/hooks/useOAuth.ts

View workflow job for this annotation

GitHub Actions / Static analysis

Unexpected `await` of a non-Promise (non-"Thenable") value
} catch {
// Already dismissed
}
}

// @ts-expect-error
// @ts-expect-error - url exists on success result type
const { type, url } = authSessionResult || {};

// TODO: Check all the possible AuthSession results
Expand Down
112 changes: 64 additions & 48 deletions packages/expo/src/hooks/useSSO.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
import { useClerk, useSignIn } from '@clerk/react';

Check failure on line 1 in packages/expo/src/hooks/useSSO.ts

View workflow job for this annotation

GitHub Actions / Static analysis

Run autofix to sort these imports!
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { OAuthStrategy, EnterpriseSSOStrategy } from '@clerk/shared/types';
import * as SecureStore from 'expo-secure-store';
import type * as WebBrowser from 'expo-web-browser';

import { CLERK_CLIENT_JWT_KEY } from '../constants';
import { errorThrower } from '../utils/errors';

export type StartSSOFlowParams = {
Expand All @@ -27,27 +24,20 @@
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();
const clerk = useClerk();
const { signIn } = useSignIn();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
if (!isSignInLoaded || !isSignUpLoaded) {
if (!signIn || !clerk.client) {
return {
createdSessionId: null,
authSessionResult: null,
signIn,
signUp,
setActive,
};
}

// Dynamically import expo-auth-session and expo-web-browser only when needed
// eslint-disable-next-line @typescript-eslint/consistent-type-imports -- dynamic import of optional dependency
let AuthSession: typeof import('expo-auth-session');
// eslint-disable-next-line @typescript-eslint/consistent-type-imports -- dynamic import of optional dependency
Expand All @@ -61,63 +51,89 @@
);
}

const { strategy, unsafeMetadata, authSessionOptions } = startSSOFlowParams ?? {};
const { strategy, authSessionOptions } = startSSOFlowParams ?? {};

/**
* Creates a redirect URL based on the application platform
* It must be whitelisted, either via Clerk Dashboard, or BAPI, in order
* to include the `rotating_token_nonce` on SSO callback
* @ref https://clerk.com/docs/reference/backend-api/tag/Redirect-URLs#operation/CreateRedirectURL
*/
const redirectUrl =
startSSOFlowParams.redirectUrl ??
AuthSession.makeRedirectUri({
path: 'sso-callback',
});

await signIn.create({
const createParams = {
strategy,
redirectUrl,
...(startSSOFlowParams.strategy === 'enterprise_sso' ? { identifier: startSSOFlowParams.identifier } : {}),
});
};

// Create the sign-in attempt. If a stale session exists (e.g. JWT persisted
// in SecureStore after an incomplete sign-out), clear the token and retry.
// The error can surface as either a thrown exception (client-side "already signed in"
// guard) or a returned { error } (FAPI "session_exists" response).
try {
const createResult = await signIn.create(createParams);
if (createResult.error) {
throw createResult.error;
}
} catch (err) {
const isSessionExists = isClerkAPIResponseError(err) && err.errors.some(e => e.code === 'session_exists');
const isAlreadySignedIn = err instanceof Error && err.message?.includes('already signed in');

if (isSessionExists || isAlreadySignedIn) {
await SecureStore.deleteItemAsync(CLERK_CLIENT_JWT_KEY);
const retryResult = await signIn.create(createParams);
if (retryResult.error) {
throw retryResult.error;
}
} else {
throw err;
}
}

const { externalVerificationRedirectURL } = signIn.firstFactorVerification;
if (!externalVerificationRedirectURL) {
return errorThrower.throw('Missing external verification redirect URL for SSO flow');
}

const authSessionResult = await WebBrowserModule.openAuthSessionAsync(
externalVerificationRedirectURL.toString(),
redirectUrl,
authSessionOptions,
);
// Open the in-app browser for the OAuth/SSO provider.
let authSessionResult: WebBrowser.WebBrowserAuthSessionResult;
try {
authSessionResult = await WebBrowserModule.openAuthSessionAsync(
externalVerificationRedirectURL.toString(),
redirectUrl,
authSessionOptions,
);
} finally {
// Dismiss the browser to prevent it from lingering in the background,
// which can cause subsequent SSO attempts to fail or appear frozen.
try {
await WebBrowserModule.dismissBrowser();

Check warning on line 109 in packages/expo/src/hooks/useSSO.ts

View workflow job for this annotation

GitHub Actions / Static analysis

Unexpected `await` of a non-Promise (non-"Thenable") value
} catch {
// Already dismissed (e.g. iOS ASWebAuthenticationSession auto-dismisses on success)
}
}

if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
signIn,
signUp,
authSessionResult,
};
}

const params = new URL(authSessionResult.url).searchParams;
const rotatingTokenNonce = params.get('rotating_token_nonce') ?? '';
await signIn.reload({ rotatingTokenNonce });
const callbackParams = new URL(authSessionResult.url).searchParams;
const createdSessionId = callbackParams.get('created_session_id');
const rotatingTokenNonce = callbackParams.get('rotating_token_nonce') ?? '';

const userNeedsToBeCreated = signIn.firstFactorVerification.status === 'transferable';
if (userNeedsToBeCreated) {
await signUp.create({
transfer: true,
unsafeMetadata,
});
// Pass the nonce to FAPI to verify the OAuth callback and update the client
// with the newly created session. The FAPI response populates the client's
// session list as a side effect, which is required for setActive to work.
await clerk.client.signIn.reload({ rotatingTokenNonce });

if (createdSessionId) {
await clerk.setActive({ session: createdSessionId });
}

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
signIn,
signUp,
createdSessionId,
authSessionResult,
};
}
Expand Down
Loading