fix(clerk-expo): Accept custom redirect URL for SSO callback by LauraBeatris · Pull Request #5102 · clerk/javascript

LauraBeatris · 2025-02-07T20:12:55Z

Description

Context

The ability to pass a custom redirect URL was removed on the first version of useSSO, testing back then, deep linking wasn't working for both platforms (iOS and Android), and the assumption was to leverage a fixed URL to parse the nonce token.

However, deep linking is working on Android and some developers are falling into a 404 context.

Changes

This PR allows providing a custom redirect URL to startSSOFlow, and also returns the result of WebBrowser.openAuthSessionAsync so developers can debug it's output on cases where the native configuration could be wrong, such as lacking permissions to open web browsers from the application manifest.

Here's an OAuth flow deep linking to a custom redirect URL on Android:

CleanShot.Feb.8.2025.mp4

Checklist

pnpm test runs as expected.
pnpm build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

changeset-bot · 2025-02-07T20:13:00Z

🦋 Changeset detected

Latest commit: 36107df

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@clerk/clerk-expo	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-02-07T20:13:00Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 8, 2025 9:23pm

LauraBeatris · 2025-02-07T20:50:33Z

!snapshot

clerk-cookie · 2025-02-07T20:53:01Z

Hey @LauraBeatris - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	2.1.20-snapshot.v20250207205117
@clerk/backend	1.24.0-snapshot.v20250207205117
@clerk/chrome-extension	2.2.8-snapshot.v20250207205117
@clerk/clerk-js	5.52.2-snapshot.v20250207205117
@clerk/elements	0.22.21-snapshot.v20250207205117
@clerk/clerk-expo	2.7.6-snapshot.v20250207205117
@clerk/expo-passkeys	0.1.19-snapshot.v20250207205117
@clerk/express	1.3.47-snapshot.v20250207205117
@clerk/fastify	2.1.20-snapshot.v20250207205117
@clerk/localizations	3.10.5-snapshot.v20250207205117
@clerk/nextjs	6.11.2-snapshot.v20250207205117
@clerk/nuxt	1.1.3-snapshot.v20250207205117
@clerk/clerk-react	5.22.12-snapshot.v20250207205117
@clerk/react-router	1.0.7-snapshot.v20250207205117
@clerk/remix	4.4.23-snapshot.v20250207205117
@clerk/shared	2.21.0-snapshot.v20250207205117
@clerk/tanstack-start	0.9.5-snapshot.v20250207205117
@clerk/testing	1.4.21-snapshot.v20250207205117
@clerk/themes	2.2.17-snapshot.v20250207205117
@clerk/types	4.45.1-snapshot.v20250207205117
@clerk/ui	0.3.22-snapshot.v20250207205117
@clerk/vue	1.1.11-snapshot.v20250207205117

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@2.1.20-snapshot.v20250207205117 --save-exact

@clerk/backend

npm i @clerk/backend@1.24.0-snapshot.v20250207205117 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.2.8-snapshot.v20250207205117 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.52.2-snapshot.v20250207205117 --save-exact

@clerk/elements

npm i @clerk/elements@0.22.21-snapshot.v20250207205117 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.7.6-snapshot.v20250207205117 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.1.19-snapshot.v20250207205117 --save-exact

@clerk/express

npm i @clerk/express@1.3.47-snapshot.v20250207205117 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.1.20-snapshot.v20250207205117 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.10.5-snapshot.v20250207205117 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.11.2-snapshot.v20250207205117 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.1.3-snapshot.v20250207205117 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.22.12-snapshot.v20250207205117 --save-exact

@clerk/react-router

npm i @clerk/react-router@1.0.7-snapshot.v20250207205117 --save-exact

@clerk/remix

npm i @clerk/remix@4.4.23-snapshot.v20250207205117 --save-exact

@clerk/shared

npm i @clerk/shared@2.21.0-snapshot.v20250207205117 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.9.5-snapshot.v20250207205117 --save-exact

@clerk/testing

npm i @clerk/testing@1.4.21-snapshot.v20250207205117 --save-exact

@clerk/themes

npm i @clerk/themes@2.2.17-snapshot.v20250207205117 --save-exact

@clerk/types

npm i @clerk/types@4.45.1-snapshot.v20250207205117 --save-exact

@clerk/ui

npm i @clerk/ui@0.3.22-snapshot.v20250207205117 --save-exact

@clerk/vue

npm i @clerk/vue@1.1.11-snapshot.v20250207205117 --save-exact

LauraBeatris · 2025-02-07T22:07:20Z

!snapshot

clerk-cookie · 2025-02-07T22:09:45Z

Hey @LauraBeatris - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	2.1.20-snapshot.v20250207220806
@clerk/backend	1.24.0-snapshot.v20250207220806
@clerk/chrome-extension	2.2.8-snapshot.v20250207220806
@clerk/clerk-js	5.52.2-snapshot.v20250207220806
@clerk/elements	0.22.21-snapshot.v20250207220806
@clerk/clerk-expo	2.7.6-snapshot.v20250207220806
@clerk/expo-passkeys	0.1.19-snapshot.v20250207220806
@clerk/express	1.3.47-snapshot.v20250207220806
@clerk/fastify	2.1.20-snapshot.v20250207220806
@clerk/localizations	3.10.5-snapshot.v20250207220806
@clerk/nextjs	6.11.2-snapshot.v20250207220806
@clerk/nuxt	1.1.3-snapshot.v20250207220806
@clerk/clerk-react	5.22.12-snapshot.v20250207220806
@clerk/react-router	1.0.7-snapshot.v20250207220806
@clerk/remix	4.4.23-snapshot.v20250207220806
@clerk/shared	2.21.0-snapshot.v20250207220806
@clerk/tanstack-start	0.9.5-snapshot.v20250207220806
@clerk/testing	1.4.21-snapshot.v20250207220806
@clerk/themes	2.2.17-snapshot.v20250207220806
@clerk/types	4.45.1-snapshot.v20250207220806
@clerk/ui	0.3.22-snapshot.v20250207220806
@clerk/vue	1.1.11-snapshot.v20250207220806

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@2.1.20-snapshot.v20250207220806 --save-exact

@clerk/backend

npm i @clerk/backend@1.24.0-snapshot.v20250207220806 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.2.8-snapshot.v20250207220806 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.52.2-snapshot.v20250207220806 --save-exact

@clerk/elements

npm i @clerk/elements@0.22.21-snapshot.v20250207220806 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.7.6-snapshot.v20250207220806 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.1.19-snapshot.v20250207220806 --save-exact

@clerk/express

npm i @clerk/express@1.3.47-snapshot.v20250207220806 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.1.20-snapshot.v20250207220806 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.10.5-snapshot.v20250207220806 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.11.2-snapshot.v20250207220806 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.1.3-snapshot.v20250207220806 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.22.12-snapshot.v20250207220806 --save-exact

@clerk/react-router

npm i @clerk/react-router@1.0.7-snapshot.v20250207220806 --save-exact

@clerk/remix

npm i @clerk/remix@4.4.23-snapshot.v20250207220806 --save-exact

@clerk/shared

npm i @clerk/shared@2.21.0-snapshot.v20250207220806 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.9.5-snapshot.v20250207220806 --save-exact

@clerk/testing

npm i @clerk/testing@1.4.21-snapshot.v20250207220806 --save-exact

@clerk/themes

npm i @clerk/themes@2.2.17-snapshot.v20250207220806 --save-exact

@clerk/types

npm i @clerk/types@4.45.1-snapshot.v20250207220806 --save-exact

@clerk/ui

npm i @clerk/ui@0.3.22-snapshot.v20250207220806 --save-exact

@clerk/vue

npm i @clerk/vue@1.1.11-snapshot.v20250207220806 --save-exact

LauraBeatris · 2025-02-08T21:21:48Z

!snapshot

clerk-cookie · 2025-02-08T21:24:12Z

Hey @LauraBeatris - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	2.1.20-snapshot.v20250208212231
@clerk/backend	1.24.0-snapshot.v20250208212231
@clerk/chrome-extension	2.2.8-snapshot.v20250208212231
@clerk/clerk-js	5.52.2-snapshot.v20250208212231
@clerk/elements	0.22.21-snapshot.v20250208212231
@clerk/clerk-expo	2.7.6-snapshot.v20250208212231
@clerk/expo-passkeys	0.1.19-snapshot.v20250208212231
@clerk/express	1.3.47-snapshot.v20250208212231
@clerk/fastify	2.1.20-snapshot.v20250208212231
@clerk/localizations	3.10.5-snapshot.v20250208212231
@clerk/nextjs	6.11.2-snapshot.v20250208212231
@clerk/nuxt	1.1.3-snapshot.v20250208212231
@clerk/clerk-react	5.22.12-snapshot.v20250208212231
@clerk/react-router	1.0.7-snapshot.v20250208212231
@clerk/remix	4.4.23-snapshot.v20250208212231
@clerk/shared	2.21.0-snapshot.v20250208212231
@clerk/tanstack-start	0.9.5-snapshot.v20250208212231
@clerk/testing	1.4.21-snapshot.v20250208212231
@clerk/themes	2.2.17-snapshot.v20250208212231
@clerk/types	4.45.1-snapshot.v20250208212231
@clerk/ui	0.3.22-snapshot.v20250208212231
@clerk/vue	1.1.11-snapshot.v20250208212231

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@2.1.20-snapshot.v20250208212231 --save-exact

@clerk/backend

npm i @clerk/backend@1.24.0-snapshot.v20250208212231 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.2.8-snapshot.v20250208212231 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.52.2-snapshot.v20250208212231 --save-exact

@clerk/elements

npm i @clerk/elements@0.22.21-snapshot.v20250208212231 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.7.6-snapshot.v20250208212231 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.1.19-snapshot.v20250208212231 --save-exact

@clerk/express

npm i @clerk/express@1.3.47-snapshot.v20250208212231 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.1.20-snapshot.v20250208212231 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.10.5-snapshot.v20250208212231 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.11.2-snapshot.v20250208212231 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.1.3-snapshot.v20250208212231 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.22.12-snapshot.v20250208212231 --save-exact

@clerk/react-router

npm i @clerk/react-router@1.0.7-snapshot.v20250208212231 --save-exact

@clerk/remix

npm i @clerk/remix@4.4.23-snapshot.v20250208212231 --save-exact

@clerk/shared

npm i @clerk/shared@2.21.0-snapshot.v20250208212231 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.9.5-snapshot.v20250208212231 --save-exact

@clerk/testing

npm i @clerk/testing@1.4.21-snapshot.v20250208212231 --save-exact

@clerk/themes

npm i @clerk/themes@2.2.17-snapshot.v20250208212231 --save-exact

@clerk/types

npm i @clerk/types@4.45.1-snapshot.v20250208212231 --save-exact

@clerk/ui

npm i @clerk/ui@0.3.22-snapshot.v20250208212231 --save-exact

@clerk/vue

npm i @clerk/vue@1.1.11-snapshot.v20250208212231 --save-exact

panteliselef

However, deep linking is working on Android
Did it got fixed in a specific version ? Regarding iOS, "not working" results to a noop or an error ?

panteliselef · 2025-02-10T09:39:06Z

+    const redirectUrl =
+      startSSOFlowParams.redirectUrl ??
+      AuthSession.makeRedirectUri({
+        path: 'sso-callback',
+      });


❓ Should redirectUrl be any string ? Should we be more strict and do

Suggested change

const redirectUrl =

startSSOFlowParams.redirectUrl ??

AuthSession.makeRedirectUri({

path: 'sso-callback',

});

const redirectUrl =

AuthSession.makeRedirectUri({

path: startSSOFlowParams.redirectUrl ?? 'sso-callback',

});

There are cases where developers might want to have more flexibility here, such as:

Directly passing the scheme as a property, even tho Expo inherits from the current build:

startSSOFlow({ redirectUrl: AuthSession.makeRedirectUri({ scheme: "myapp", }); })

Deep-link to the current route, without passing a path:

startSSOFlow({ redirectUrl: // Defaults to the current route AuthSession.makeRedirectUri(); })

Or using the expo-linking package:

startSSOFlow({ redirectUrl: Linking.createURL("dashboard") })

LauraBeatris · 2025-02-10T12:22:04Z

@panteliselef

Did it got fixed in a specific version ? Regarding iOS, "not working" results to a noop or an error ?

I haven't seen latest fixes on https://github.com/expo/expo/blob/main/packages/expo-auth-session/CHANGELOG.md, so I presume something was wrong on my latest deep linking tests when running Android on a simulator

Here's the behavior for iOS providing exp://192.168.0.235:8081/--/dashboard as redirectUrl:

CleanShot.2025-02-10.at.09.19.21.mp4

The auth browser session returns with type: success, however, deep linking is not performed. Now, it could be either a bug (expo/expo#34187), or something related to the iOS setup since I'm running the dev server, and not a development/production build.

The deep linking provided to AuthSession.openAuthSessionAsync is indeed valid if you try to test with the uri-scheme CLI tool:

CleanShot.2025-02-10.at.09.20.10.mp4

clerk-cookie added the expo label Feb 7, 2025

LauraBeatris force-pushed the laura/fix-use-sso-return branch from 1f2839f to 51f56ba Compare February 7, 2025 20:13

vercel Bot deployed to Preview February 7, 2025 20:15 View deployment

LauraBeatris self-assigned this Feb 7, 2025

LauraBeatris force-pushed the laura/fix-use-sso-return branch from 51f56ba to 272bc3f Compare February 7, 2025 21:41

vercel Bot deployed to Preview February 7, 2025 21:43 View deployment

LauraBeatris force-pushed the laura/fix-use-sso-return branch from 272bc3f to 41c7bbc Compare February 7, 2025 21:53

vercel Bot deployed to Preview February 7, 2025 21:55 View deployment

LauraBeatris force-pushed the laura/fix-use-sso-return branch from 41c7bbc to 5a152f7 Compare February 7, 2025 22:04

vercel Bot deployed to Preview February 7, 2025 22:05 View deployment

LauraBeatris force-pushed the laura/fix-use-sso-return branch from 5a152f7 to 4350565 Compare February 8, 2025 20:59

vercel Bot deployed to Preview February 8, 2025 21:01 View deployment

LauraBeatris changed the title ~~fix(expo): Accept custom redirect URL for SSO callback~~ fix(clerk-expo): Accept custom redirect URL for SSO callback Feb 8, 2025

LauraBeatris force-pushed the laura/fix-use-sso-return branch from 4350565 to e5ba1b1 Compare February 8, 2025 21:20

Add authSessionResult on return type

36107df

LauraBeatris force-pushed the laura/fix-use-sso-return branch from e5ba1b1 to 36107df Compare February 8, 2025 21:21

vercel Bot deployed to Preview February 8, 2025 21:23 View deployment

LauraBeatris marked this pull request as ready for review February 8, 2025 21:38

LauraBeatris mentioned this pull request Feb 8, 2025

(expo/use-sso) Add redirectUrl parameter to startSSOFlow; remove expo partials clerk/clerk-docs#2005

Merged

3 tasks

panteliselef reviewed Feb 10, 2025

View reviewed changes

LauraBeatris requested a review from panteliselef February 10, 2025 12:33

panteliselef approved these changes Feb 10, 2025

View reviewed changes

LauraBeatris merged commit bc78aa2 into main Feb 10, 2025

LauraBeatris deleted the laura/fix-use-sso-return branch February 10, 2025 21:37

clerk-cookie mentioned this pull request Feb 10, 2025

ci(repo): Version packages #5127

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(clerk-expo): Accept custom redirect URL for SSO callback#5102

fix(clerk-expo): Accept custom redirect URL for SSO callback#5102
LauraBeatris merged 1 commit into
mainfrom
laura/fix-use-sso-return

LauraBeatris commented Feb 7, 2025 •

edited

Loading

Uh oh!

changeset-bot Bot commented Feb 7, 2025 •

edited

Loading

Uh oh!

vercel Bot commented Feb 7, 2025 •

edited

Loading

Uh oh!

LauraBeatris commented Feb 7, 2025

Uh oh!

clerk-cookie commented Feb 7, 2025

Uh oh!

LauraBeatris commented Feb 7, 2025

Uh oh!

clerk-cookie commented Feb 7, 2025

Uh oh!

LauraBeatris commented Feb 8, 2025

Uh oh!

clerk-cookie commented Feb 8, 2025

Uh oh!

panteliselef left a comment

Uh oh!

panteliselef Feb 10, 2025

Uh oh!

LauraBeatris Feb 10, 2025

Uh oh!

LauraBeatris commented Feb 10, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

LauraBeatris commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Context

Changes

Checklist

Type of change

Uh oh!

changeset-bot Bot commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel Bot commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LauraBeatris commented Feb 7, 2025

Uh oh!

clerk-cookie commented Feb 7, 2025

Uh oh!

LauraBeatris commented Feb 7, 2025

Uh oh!

clerk-cookie commented Feb 7, 2025

Uh oh!

LauraBeatris commented Feb 8, 2025

Uh oh!

clerk-cookie commented Feb 8, 2025

Uh oh!

panteliselef left a comment

Choose a reason for hiding this comment

Uh oh!

panteliselef Feb 10, 2025

Choose a reason for hiding this comment

Uh oh!

LauraBeatris Feb 10, 2025

Choose a reason for hiding this comment

Uh oh!

LauraBeatris commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LauraBeatris commented Feb 7, 2025 •

edited

Loading

changeset-bot Bot commented Feb 7, 2025 •

edited

Loading

vercel Bot commented Feb 7, 2025 •

edited

Loading

LauraBeatris commented Feb 10, 2025 •

edited

Loading