feat(clerk-js): Allow token refresh when Client failed to resolve #5345

panteliselef · 2025-03-13T16:17:22Z

Description

Until now we depended on the client to be successfully fetched in order to mark clerk as initialized. This is changing in this PR.

When /client fails for any reason, a 4xx error, a 5xx error, a network error (aka blocked), we are creating a "local" only representation of the client. If the user is already signed in, clerk-js leverages the existing JWT of the __session cookie to create the client based on the existing information (userId, sessionId, orgId etc.).

With this PR, (only for standard browsers) if /client fails, clerk-js always initiates a local-only client to allow for operations like Clerk.session?.getToken() to still operate as expected. That means Clerk.loaded will be true even when we don't have a proper client object in memory.

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

…ent-fails

changeset-bot · 2025-03-13T16:17:27Z

🦋 Changeset detected

Latest commit: 14af574

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

This PR includes changesets to release 22 packages

Name	Type
@clerk/clerk-js	Patch
@clerk/types	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-expo	Patch
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/elements	Patch
@clerk/expo-passkeys	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/localizations	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/shared	Patch
@clerk/tanstack-start	Patch
@clerk/testing	Patch
@clerk/themes	Patch
@clerk/vue	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-03-13T16:17:27Z

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	Mar 18, 2025 8:49am

This reverts commit 843ac1c.

…ent-fails # Conflicts: # packages/clerk-js/bundlewatch.config.json

panteliselef · 2025-03-14T11:57:26Z

packages/clerk-js/src/core/auth/AuthCookieService.ts

-
-    if (isNetworkError(e)) {
-      return;
-    }
-
-    clerkCoreErrorTokenRefreshFailed(e.toString());


We need to stop throwing errors on status 5xx here. These errors are not useful to us, and developers cannot catch them and handle them.

In case of an FAPI outage, the poller would continue to throw errors, that would pollute a customer's Sentry logs

panteliselef · 2025-03-14T15:39:31Z

packages/types/src/json.ts

@@ -68,7 +71,6 @@ export interface EnvironmentJSON extends ClerkResourceJSON {
 export interface ClientJSON extends ClerkResourceJSON {
  object: 'client';
  id: string;
-  status: any;


this is safe to remove

packages/types/src/jwt.ts

panteliselef · 2025-03-17T09:37:50Z

packages/clerk-js/src/core/clerk.ts

+            .then(res => this.updateClient(res))
+            .catch(async e => {
+              if (isClerkAPIResponseError(e) && e.errors[0].code === 'requires_captcha') {
+                throw e;
+              }
+
+              const jwtInCookie = this.#authService?.getSessionCookie();
+              const localClient = createClientFromJwt(jwtInCookie);
+
+              this.updateClient(localClient);
+
+              // Always grab a fresh token
+              await this.session?.getToken({ skipCache: true });
+
+              // Allows for Clerk to be marked as loaded with the client and session created from the JWT.
+              return null;
+            });


I wouldn't focus too much on where this code is located, we might refactor once both this and #5287 are merged.

panteliselef · 2025-03-17T09:39:05Z

packages/types/src/json.ts

+  external_id: string | null;
+  primary_email_address_id: string | null;
+  primary_phone_number_id: string | null;
+  primary_web3_wallet_id: string | null;


Per our fapi docs

panteliselef · 2025-03-17T09:39:08Z

packages/types/src/json.ts

  image_url: string;
  has_image: boolean;
-  username: string;
+  username: string | null;


Per our fapi docs

panteliselef · 2025-03-17T09:39:12Z

packages/types/src/json.ts

+  first_name: string | null;
+  last_name: string | null;


Per our fapi docs

panteliselef · 2025-03-17T09:39:21Z

packages/types/src/json.ts

@@ -275,7 +277,7 @@ export interface UserJSON extends ClerkResourceJSON {
  created_at: number;
 }

-export interface PublicUserDataJSON extends ClerkResourceJSON {
+export interface PublicUserDataJSON {


Per our fapi docs

…ent-fails # Conflicts: # packages/clerk-js/bundlewatch.config.json # packages/types/src/jwt.ts

…ent-fails

packages/clerk-js/src/core/auth/cookies/session.ts

packages/clerk-js/src/core/jwt-client.ts

LauraBeatris · 2025-03-17T13:18:27Z

packages/clerk-js/src/core/jwt-client.ts

+      {
+        object: 'session',
+        id: sid,
+        status: 'active',


This could be added in a later PR, but we now have a new claim in the JWT: sts - it's only added when a session is in a pending status

We should extract it here and default to active: sts ?? 'active' -> happy to open up another PR later to update the JWT types and apply it here as well!

Doing this in another PR sounds proper. TBH i don't think it is that important, because it might force redirect you to the appropriate page, but clerk will be down so you will not be able to proceed.

packages/clerk-js/src/core/jwt-client.ts

jacekradko

…sh-when-client-fails # Conflicts: # packages/clerk-js/bundlewatch.config.json

panteliselef added 5 commits March 12, 2025 19:38

feat(clerk-js): Allow token refresh when Client failed to resolve

506a6f6

Merge branch 'main' into elef/sdki-915-support-token-refresh-when-cli…

7c6a61f

…ent-fails

cleanup

3bf2569

second cleanup

a932787

third cleanup

964cdc4

clerk-cookie added types clerk-js labels Mar 13, 2025

vercel bot deployed to Preview March 13, 2025 16:18 View deployment

changeset

5a6ff31

vercel bot deployed to Preview March 13, 2025 16:20 View deployment

panteliselef self-assigned this Mar 13, 2025

panteliselef added 4 commits March 13, 2025 22:05

reduce status

8d87d26

add defaults to classes instead

843ac1c

Revert "add defaults to classes instead"

c6ffed9

This reverts commit 843ac1c.

replace (??) with (||) for less bundle size

c3451bd

vercel bot deployed to Preview March 13, 2025 20:27 View deployment

panteliselef added 2 commits March 14, 2025 13:50

add missing type

0fcfedc

add e2e test

ffb0146

clerk-cookie added the integration label Mar 14, 2025

vercel bot deployed to Preview March 14, 2025 11:52 View deployment

panteliselef added 2 commits March 14, 2025 17:00

update bundlewatch.config.json

7839ed2

Merge branch 'main' into elef/sdki-915-support-token-refresh-when-cli…

4c5ccae

…ent-fails # Conflicts: # packages/clerk-js/bundlewatch.config.json

vercel bot deployed to Preview March 14, 2025 15:10 View deployment

revert explicit poller start

2b40678

vercel bot deployed to Preview March 14, 2025 15:41 View deployment

panteliselef commented Mar 14, 2025

View reviewed changes

panteliselef commented Mar 17, 2025

View reviewed changes

panteliselef added 3 commits March 17, 2025 11:42

Merge branch 'main' into elef/sdki-915-support-token-refresh-when-cli…

11bc05b

…ent-fails # Conflicts: # packages/clerk-js/bundlewatch.config.json # packages/types/src/jwt.ts

bundle bump

8ef5751

cleanup

d5c76c6

vercel bot deployed to Preview March 17, 2025 09:52 View deployment

panteliselef marked this pull request as ready for review March 17, 2025 11:02

Merge branch 'main' into elef/sdki-915-support-token-refresh-when-cli…

d5ef0fc

…ent-fails

vercel bot deployed to Preview March 17, 2025 11:03 View deployment

panteliselef added 2 commits March 17, 2025 13:25

attempt to fix flaky test

0eba411

typo

cdbb27c

vercel bot deployed to Preview March 17, 2025 11:26 View deployment

panteliselef requested a review from a team March 17, 2025 11:28

LauraBeatris reviewed Mar 17, 2025

View reviewed changes

panteliselef added 2 commits March 17, 2025 17:37

address PR feedback

b9bd3fc

wip flaky test

ffdee07

vercel bot deployed to Preview March 17, 2025 15:39 View deployment

jacekradko approved these changes Mar 17, 2025

View reviewed changes

panteliselef added 3 commits March 18, 2025 10:39

rename

5bca248

remove flaky part

7820390

Merge branch 'refs/heads/main' into elef/sdki-915-support-token-refre…

78cd87c

…sh-when-client-fails # Conflicts: # packages/clerk-js/bundlewatch.config.json

vercel bot deployed to Preview March 18, 2025 08:43 View deployment

bump bundlewatch.config.json

14af574

vercel bot deployed to Preview March 18, 2025 08:49 View deployment

panteliselef merged commit 3dddcda into main Mar 18, 2025
30 checks passed

panteliselef deleted the elef/sdki-915-support-token-refresh-when-client-fails branch March 18, 2025 09:12

clerk-cookie mentioned this pull request Mar 18, 2025

ci(repo): Version packages #5332

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(clerk-js): Allow token refresh when Client failed to resolve #5345

feat(clerk-js): Allow token refresh when Client failed to resolve #5345

panteliselef commented Mar 13, 2025 •

edited

Loading

changeset-bot bot commented Mar 13, 2025 •

edited

Loading

vercel bot commented Mar 13, 2025 •

edited

Loading

panteliselef Mar 14, 2025

panteliselef Mar 14, 2025

panteliselef Mar 17, 2025

panteliselef Mar 17, 2025

panteliselef Mar 17, 2025

panteliselef Mar 17, 2025

panteliselef Mar 17, 2025

LauraBeatris Mar 17, 2025

panteliselef Mar 17, 2025

jacekradko left a comment

feat(clerk-js): Allow token refresh when Client failed to resolve #5345

feat(clerk-js): Allow token refresh when Client failed to resolve #5345

Conversation

panteliselef commented Mar 13, 2025 • edited Loading

Description

Checklist

Type of change

changeset-bot bot commented Mar 13, 2025 • edited Loading

🦋 Changeset detected

vercel bot commented Mar 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacekradko left a comment

Choose a reason for hiding this comment

panteliselef commented Mar 13, 2025 •

edited

Loading

changeset-bot bot commented Mar 13, 2025 •

edited

Loading

vercel bot commented Mar 13, 2025 •

edited

Loading