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
2 changes: 2 additions & 0 deletions .changeset/thin-eagles-lay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
26 changes: 1 addition & 25 deletions packages/expo/src/hooks/useHostedAuth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import type * as WebBrowser from 'expo-web-browser';
import { Platform } from 'react-native';

import { getClerkInstance } from '../provider/singleton';
import { getExpoAppIdentifier } from '../utils/appIdentifier';
import { errorThrower } from '../utils/errors';
import type { HostedAuthClerkInstance, HostedAuthMode } from '../utils/hostedAuth';
import { applyHostedAuthClientJSON, createHostedAuth, redeemHostedAuth } from '../utils/hostedAuth';
import { isExpoGo } from '../utils/runtime';

export type { HostedAuthMode };

Expand Down Expand Up @@ -237,30 +237,6 @@ function warnAndroidDefaultRedirectOnce(): void {
}
}

function getExpoAppIdentifier(): string | undefined {
try {
// expo-constants is already an optional @clerk/expo peer and is present in
// standard Expo projects. Keep the fallback below for Expo Go and bare apps.
// eslint-disable-next-line @typescript-eslint/no-require-imports
const constantsModule = require('expo-constants') as {
default?: {
expoConfig?: {
ios?: { bundleIdentifier?: string };
android?: { package?: string };
};
};
};
if (isExpoGo()) {
return undefined;
}

const expoConfig = constantsModule.default?.expoConfig;
return Platform.OS === 'ios' ? expoConfig?.ios?.bundleIdentifier : expoConfig?.android?.package;
} catch {
return undefined;
}
}

function getHostedAuthClerk(): HostedAuthClerkInstance {
const hostedAuthClerk = getClerkInstance() as Partial<HostedAuthClerkInstance> | undefined;
if (typeof hostedAuthClerk?.getFapiClient !== 'function') {
Expand Down
25 changes: 25 additions & 0 deletions packages/expo/src/utils/appIdentifier.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Platform } from 'react-native';

import { isExpoGo } from './runtime';

export function getExpoAppIdentifier(): string | undefined {
try {
// eslint-disable-next-line @typescript-eslint/no-require-imports
const constantsModule = require('expo-constants') as {
default?: {
expoConfig?: {
ios?: { bundleIdentifier?: string };
android?: { package?: string };
};
};
};
if (isExpoGo()) {
return undefined;
}

const expoConfig = constantsModule.default?.expoConfig;
return Platform.OS === 'ios' ? expoConfig?.ios?.bundleIdentifier : expoConfig?.android?.package;
} catch {
return undefined;
}
}
72 changes: 72 additions & 0 deletions packages/expo/src/utils/fapiRequest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import { ClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIErrorJSON } from '@clerk/shared/types';

export type FapiPayload<R extends { object: string }> = {
response?: R;
errors?: ClerkAPIErrorJSON[];
};

export type FapiResponse<R extends { object: string }> = {
ok: boolean;
status: number;
statusText: string;
headers?: Headers;
payload: FapiPayload<R> | null;
};

export async function requestWithSignedOutRetry<R extends { object: string }>(
request: () => Promise<FapiResponse<R>>,
): Promise<FapiResponse<R>> {
const response = await request();
if (
!response.ok &&
response.status === 401 &&
getFapiErrors(response.payload).some(error => error.code === 'signed_out')
) {
// The Expo response hook has already persisted the replacement device token.
return request();
}

return response;
}

export function getResponseJSON<R extends { object: string }, O extends R['object']>(
payload: FapiPayload<R> | null,
object: O,
): Extract<R, { object: O }> | null {
const response = payload?.response;
return !!response && typeof response === 'object' && isResponseObject(response, object) ? response : null;
}

function isResponseObject<R extends { object: string }, O extends R['object']>(
response: R,
object: O,
): response is Extract<R, { object: O }> {
return response.object === object;
}

export function toClerkAPIResponseError(
response: FapiResponse<{ object: string }>,
fallbackMessage: string,
): ClerkAPIResponseError {
const errors = getFapiErrors(response.payload);
return new ClerkAPIResponseError(errors[0]?.long_message || response.statusText || fallbackMessage, {
data: errors,
status: response.status,
retryAfter: getRetryAfter(response.headers),
});
}

function getFapiErrors(payload: FapiPayload<{ object: string }> | null): ClerkAPIErrorJSON[] {
return payload?.errors ?? [];
}

function getRetryAfter(headers: Headers | undefined): number | undefined {
const retryAfter = headers?.get('retry-after');
if (!retryAfter) {
return undefined;
}

const retryAfterSeconds = parseInt(retryAfter, 10);
return Number.isNaN(retryAfterSeconds) ? undefined : retryAfterSeconds;
}
67 changes: 7 additions & 60 deletions packages/expo/src/utils/hostedAuth.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { ClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIErrorJSON, ClientJSON, ClientResource } from '@clerk/shared/types';
import type { ClientJSON, ClientResource } from '@clerk/shared/types';

import { errorThrower } from './errors';
import type { FapiResponse } from './fapiRequest';
import { getResponseJSON, requestWithSignedOutRetry, toClerkAPIResponseError } from './fapiRequest';

/**
* Controls which Account Portal auth screen opens for hosted auth.
Expand All @@ -25,18 +26,7 @@ type HostedAuthJSON = {
url: string;
};

type HostedAuthPayload = {
response?: HostedAuthJSON | ClientJSON;
errors?: ClerkAPIErrorJSON[];
};

type HostedAuthResponse = {
ok: boolean;
status: number;
statusText: string;
headers?: Headers;
payload: HostedAuthPayload | null;
};
type HostedAuthResponse = FapiResponse<HostedAuthJSON | ClientJSON>;

type FapiClient = {
request: (requestInit: {
Expand All @@ -62,18 +52,9 @@ export async function createHostedAuth(
body: params,
});

let response = await request();
if (
!response.ok &&
response.status === 401 &&
getHostedAuthErrors(response.payload).some(error => error.code === 'signed_out')
) {
// The Expo response hook has already persisted the replacement device token.
response = await request();
}

const response = await requestWithSignedOutRetry(request);
if (!response.ok) {
throw buildHostedAuthAPIResponseError(response);
throw toClerkAPIResponseError(response, 'Hosted auth request failed.');
}

const hostedAuthJSON = getResponseJSON(response.payload, 'hosted_auth');
Expand Down Expand Up @@ -110,13 +91,6 @@ export async function redeemHostedAuth(
return clientJSON;
}

function getResponseJSON(payload: HostedAuthResponse['payload'], object: 'hosted_auth'): HostedAuthJSON | null;
function getResponseJSON(payload: HostedAuthResponse['payload'], object: 'client'): ClientJSON | null;
function getResponseJSON(payload: HostedAuthResponse['payload'], object: string): HostedAuthJSON | ClientJSON | null {
const response = payload?.response;
return !!response && typeof response === 'object' && response.object === object ? response : null;
}

export function applyHostedAuthClientJSON(client: ClientResource, clientJSON: ClientJSON): ClientResource {
// Hosted auth gets the same /client payload as Client.reload(), but its verifier-bound
// exchange uses a request body. Apply it to the existing ClerkJS client instance here
Expand All @@ -140,32 +114,5 @@ async function throwHostedAuthAPIResponseError(
await clerk.handleUnauthenticated?.();
}

throw buildHostedAuthAPIResponseError(response);
}

function buildHostedAuthAPIResponseError(response: HostedAuthResponse) {
const errors = getHostedAuthErrors(response.payload);
return new ClerkAPIResponseError(errors[0]?.long_message || response.statusText || 'Hosted auth request failed.', {
data: errors,
status: response.status,
retryAfter: getRetryAfter(response.headers),
});
}

function getHostedAuthErrors(payload: HostedAuthResponse['payload']): ClerkAPIErrorJSON[] {
if (!payload || !('errors' in payload)) {
return [];
}

return payload.errors ?? [];
}

function getRetryAfter(headers: Headers | undefined): number | undefined {
const retryAfter = headers?.get('retry-after');
if (!retryAfter) {
return undefined;
}

const retryAfterSeconds = parseInt(retryAfter, 10);
return Number.isNaN(retryAfterSeconds) ? undefined : retryAfterSeconds;
throw toClerkAPIResponseError(response, 'Hosted auth request failed.');
}
Loading