Uh oh!
There was an error while loading. Please reload this page.
fix(backend,clerk-js): treat undefined satelliteAutoSync as false - #8001
Conversation
…re 3 default) The JSDoc on satelliteAutoSync says @default false, and the Core 3 upgrade codemod adds satelliteAutoSync={true} to existing satellite configs, but the runtime check used === false (strict equality). This meant undefined (not passing the prop) behaved like true, preserving Core 2 auto-sync behavior instead of the intended Core 3 default of no auto-sync. Change the check from === false to !== true so that undefined is treated the same as false, matching the documented default.
🦋 Changeset detectedLatest commit: e664eb1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 14 packages
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 |
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe PR changes satellite auto-sync behavior: 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
The post-load branch of isSignedOut() returned !!this.clerk.user, which is true when the user IS signed in. This is inverted from what the method name implies. Currently dead code (the only caller runs before clerk.loaded is true), but fixing it prevents a latent bug where signed-in satellite users with satelliteAutoSync=true would get bounced to primary unnecessarily if this method were ever called post-load.
@clerk/agent-toolkit@clerk/astro@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/dev-cli@clerk/expo@clerk/expo-passkeys@clerk/express@clerk/fastify@clerk/hono@clerk/localizations@clerk/nextjs@clerk/nuxt@clerk/react@clerk/react-router@clerk/shared@clerk/tanstack-react-start@clerk/testing@clerk/ui@clerk/upgrade@clerk/vuecommit: |
These tests reset mockClientFetch in their beforeEach but didn't set up a return value. Previously this was fine because #shouldSyncWithPrimary() returned true and the code never reached Client.fetch(). Now that satelliteAutoSync defaults to false, the code falls through to the client fetch, so a mock is needed.
| return this.clientUat.get() <= 0; | ||
| } | ||
| return !!this.clerk.user; | ||
| return !this.clerk.user; |
There was a problem hiding this comment.
This seems to be outside of the scope of this PR. Should we split this out into its own change so it has a changelog entry?
There was a problem hiding this comment.
I think the change is small enough to not warrant a new PR, I also dont think a changeset is needed as its internal behavior
Uh oh!
There was an error while loading. Please reload this page.
Why
Users upgrading to Core 3 expect
satelliteAutoSyncto default tofalseas documented in the JSDoc (@default false) and as the Core 3 upgrade codemod implies (it addssatelliteAutoSync={true}to existing satellite configs to preserve Core 2 behavior).However, the runtime check used
=== false(strict equality), soundefined(not passing the prop) behaved identically totrue, preserving Core 2 auto-sync-on-every-page-load behavior. A customer reported that their satellite domain was redirecting on every page load despite not opting into auto-sync.What changed
=== falseto!== truein both@clerk/backend(SSR middleware path inrequest.ts) and@clerk/clerk-js(CSR initialization inclerk.ts)undefinedandfalsenow both skip automatic satellite handshake, matching the documented Core 3 defaulttruemust be explicitly passed to enable auto-sync (opt-in)__clerk_synced=false(post sign-in redirect) still triggers handshake regardless of the settingTest coverage
satelliteAutoSync: trueundefineddefault behavior (prod + dev, with and without__clerk_synced=false)satelliteAutoSyncto expect 200__clerk_synced=falsestill triggers handshake whensatelliteAutoSyncis unsetPackages affected
@clerk/backend: satellite handshake decision logic inrequest.ts@clerk/clerk-js:#shouldSyncWithPrimaryinclerk.tsSummary by CodeRabbit
Bug Fixes
Tests
Documentation