Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fix-satellite-auto-sync-default.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/backend": patch
"@clerk/clerk-js": patch
---

Fix `satelliteAutoSync` to default to `false` as documented. Previously, not passing the prop resulted in `undefined`, which was treated as `true` due to a strict equality check (`=== false`). This preserved Core 2 auto-sync behavior instead of the intended Core 3 default. The check is now `!== true`, so both `undefined` and `false` skip automatic satellite sync.
36 changes: 26 additions & 10 deletions integration/tests/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -529,7 +529,7 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with sec-fetch-dest=document - prod', async () => {
test('signed out satellite with sec-fetch-dest=document skips handshake by default (satelliteAutoSync unset) - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -543,13 +543,8 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('redirect_url')).toBe(`${app.serverUrl}/`);
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
expect(locationUrl.searchParams.has('__clerk_api_version')).toBe(true);
expect(locationUrl.searchParams.get('suffixed_cookies')).toBe('false');
// In Core 3, satelliteAutoSync defaults to false, so no handshake redirect
expect(res.status).toBe(200);
});

test('signed out satellite - dev', async () => {
Expand DownExpand Up@@ -628,7 +623,28 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with satelliteAutoSync=true (default) triggers handshake - prod', async () => {
test('signed out satellite with satelliteAutoSync unset triggers handshake when __clerk_synced=false - prod', async () => {
const config = generateConfig({
mode: 'live',
});
const res = await fetch(app.serverUrl + '/?__clerk_synced=false', {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Satellite': 'true',
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
// Even without satelliteAutoSync, __clerk_synced=false (post sign-in) should trigger handshake
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
});

test('signed out satellite with satelliteAutoSync=true (explicit opt-in) triggers handshake - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -643,7 +659,7 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
// Should redirect to handshake with default/true satelliteAutoSync
// Should redirect to handshake when satelliteAutoSync is explicitly true
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
Expand Down
114 changes: 112 additions & 2 deletions packages/backend/src/tokens/__tests__/request.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -651,7 +651,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState).toBeSignedOutToAuth();
});

test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async () => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite with satelliteAutoSync=true and not is synced [11y]', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -671,6 +671,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand All@@ -684,7 +685,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeNull();
});

test('cookieToken: redirects to signInUrl when is satellite dev and not synced', async () => {
test('cookieToken: redirects to signInUrl when is satellite dev with satelliteAutoSync=true and not synced', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -705,6 +706,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand DownExpand Up@@ -873,6 +875,114 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedOutToAuth();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
`http://satellite.dev/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
signInUrl: 'https://primary.dev/sign-in',
isSatellite: true,
domain: 'satellite.dev',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.headers.get('location')).toEqual(
`https://primary.dev/sign-in?__clerk_redirect_url=http%3A%2F%2Fexample.com%2Fpath%3F__clerk_synced%3Dfalse`,
);
});

test('cookieToken: returns handshake when app is not satellite and responds to syncing on dev instances[12y]', async () => {
const sp = new URLSearchParams();
sp.set('__clerk_redirect_url', 'http://localhost:3000');
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/tokens/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -484,7 +484,7 @@ export const authenticateRequest: AuthenticateRequest = (async (
* - 'false' (NeedsSync): Trigger sync - satellite returning from primary sign-in
* - 'true' (Completed): Sync done - prevents re-sync loop
*
* With satelliteAutoSync=false:
* With satelliteAutoSync=false or unset (Core 3 default):
* - Skip handshake on first visit if no cookies exist (return signedOut immediately)
* - Trigger handshake when __clerk_synced=false is present (post sign-in redirect)
* - Allow normal token verification flow when cookies exist (enables refresh)
Expand All@@ -499,8 +499,8 @@ export const authenticateRequest: AuthenticateRequest = (async (
const hasCookies = hasSessionToken || hasActiveClient;

// Determine if we should skip handshake for satellites with no cookies
// satelliteAutoSync defaults to true, so we only skip when explicitly set to false
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync === false && !hasCookies && !needsSync;
// satelliteAutoSync defaults to false (Core 3), so we skip unless explicitly set to true
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync !== true && !hasCookies && !needsSync;

if (authenticateContext.instanceType === 'production' && isRequestEligibleForMultiDomainSync && !syncCompleted) {
// With satelliteAutoSync=false: skip handshake if no cookies and no sync trigger
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2386,6 +2386,7 @@ describe('Clerk singleton', () => {
describe('Clerk().isSatellite and Clerk().domain getters', () => {
beforeEach(() => {
mockClientFetch.mockReset();
mockClientFetch.mockReturnValue(Promise.resolve({ signedInSessions: [] }));
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/auth/AuthCookieService.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ export class AuthCookieService {
if (!this.clerk.loaded) {
return this.clientUat.get() <= 0;
}
return !!this.clerk.user;
return !this.clerk.user;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

public async handleUnauthenticatedDevBrowser() {
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2845,10 +2845,9 @@ export class Clerk implements ClerkInterface {
return true;
}

// Check if satelliteAutoSync is disabled - if so, skip automatic sync
// unless explicitly triggered via __clerk_synced=false
if (this.#options.satelliteAutoSync === false) {
// Skip automatic sync when satelliteAutoSync is false
// Check if satelliteAutoSync is enabled - only auto-sync when explicitly opted in
// In Core 3, satelliteAutoSync defaults to false (undefined is treated as false)
if (this.#options.satelliteAutoSync !== true) {
return false;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(backend,clerk-js): treat undefined satelliteAutoSync as false by nikosdouvlis · Pull Request #8001 · clerk/javascript · GitHub
Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fix-satellite-auto-sync-default.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/backend": patch
"@clerk/clerk-js": patch
---

Fix `satelliteAutoSync` to default to `false` as documented. Previously, not passing the prop resulted in `undefined`, which was treated as `true` due to a strict equality check (`=== false`). This preserved Core 2 auto-sync behavior instead of the intended Core 3 default. The check is now `!== true`, so both `undefined` and `false` skip automatic satellite sync.
36 changes: 26 additions & 10 deletions integration/tests/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -529,7 +529,7 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with sec-fetch-dest=document - prod', async () => {
test('signed out satellite with sec-fetch-dest=document skips handshake by default (satelliteAutoSync unset) - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -543,13 +543,8 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('redirect_url')).toBe(`${app.serverUrl}/`);
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
expect(locationUrl.searchParams.has('__clerk_api_version')).toBe(true);
expect(locationUrl.searchParams.get('suffixed_cookies')).toBe('false');
// In Core 3, satelliteAutoSync defaults to false, so no handshake redirect
expect(res.status).toBe(200);
});

test('signed out satellite - dev', async () => {
Expand DownExpand Up@@ -628,7 +623,28 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with satelliteAutoSync=true (default) triggers handshake - prod', async () => {
test('signed out satellite with satelliteAutoSync unset triggers handshake when __clerk_synced=false - prod', async () => {
const config = generateConfig({
mode: 'live',
});
const res = await fetch(app.serverUrl + '/?__clerk_synced=false', {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Satellite': 'true',
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
// Even without satelliteAutoSync, __clerk_synced=false (post sign-in) should trigger handshake
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
});

test('signed out satellite with satelliteAutoSync=true (explicit opt-in) triggers handshake - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -643,7 +659,7 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
// Should redirect to handshake with default/true satelliteAutoSync
// Should redirect to handshake when satelliteAutoSync is explicitly true
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
Expand Down
114 changes: 112 additions & 2 deletions packages/backend/src/tokens/__tests__/request.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -651,7 +651,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState).toBeSignedOutToAuth();
});

test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async () => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite with satelliteAutoSync=true and not is synced [11y]', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -671,6 +671,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand All@@ -684,7 +685,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeNull();
});

test('cookieToken: redirects to signInUrl when is satellite dev and not synced', async () => {
test('cookieToken: redirects to signInUrl when is satellite dev with satelliteAutoSync=true and not synced', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -705,6 +706,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand DownExpand Up@@ -873,6 +875,114 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedOutToAuth();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
`http://satellite.dev/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
signInUrl: 'https://primary.dev/sign-in',
isSatellite: true,
domain: 'satellite.dev',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.headers.get('location')).toEqual(
`https://primary.dev/sign-in?__clerk_redirect_url=http%3A%2F%2Fexample.com%2Fpath%3F__clerk_synced%3Dfalse`,
);
});

test('cookieToken: returns handshake when app is not satellite and responds to syncing on dev instances[12y]', async () => {
const sp = new URLSearchParams();
sp.set('__clerk_redirect_url', 'http://localhost:3000');
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/tokens/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -484,7 +484,7 @@ export const authenticateRequest: AuthenticateRequest = (async (
* - 'false' (NeedsSync): Trigger sync - satellite returning from primary sign-in
* - 'true' (Completed): Sync done - prevents re-sync loop
*
* With satelliteAutoSync=false:
* With satelliteAutoSync=false or unset (Core 3 default):
* - Skip handshake on first visit if no cookies exist (return signedOut immediately)
* - Trigger handshake when __clerk_synced=false is present (post sign-in redirect)
* - Allow normal token verification flow when cookies exist (enables refresh)
Expand All@@ -499,8 +499,8 @@ export const authenticateRequest: AuthenticateRequest = (async (
const hasCookies = hasSessionToken || hasActiveClient;

// Determine if we should skip handshake for satellites with no cookies
// satelliteAutoSync defaults to true, so we only skip when explicitly set to false
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync === false && !hasCookies && !needsSync;
// satelliteAutoSync defaults to false (Core 3), so we skip unless explicitly set to true
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync !== true && !hasCookies && !needsSync;

if (authenticateContext.instanceType === 'production' && isRequestEligibleForMultiDomainSync && !syncCompleted) {
// With satelliteAutoSync=false: skip handshake if no cookies and no sync trigger
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2386,6 +2386,7 @@ describe('Clerk singleton', () => {
describe('Clerk().isSatellite and Clerk().domain getters', () => {
beforeEach(() => {
mockClientFetch.mockReset();
mockClientFetch.mockReturnValue(Promise.resolve({ signedInSessions: [] }));
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/auth/AuthCookieService.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ export class AuthCookieService {
if (!this.clerk.loaded) {
return this.clientUat.get() <= 0;
}
return !!this.clerk.user;
return !this.clerk.user;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

public async handleUnauthenticatedDevBrowser() {
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2845,10 +2845,9 @@ export class Clerk implements ClerkInterface {
return true;
}

// Check if satelliteAutoSync is disabled - if so, skip automatic sync
// unless explicitly triggered via __clerk_synced=false
if (this.#options.satelliteAutoSync === false) {
// Skip automatic sync when satelliteAutoSync is false
// Check if satelliteAutoSync is enabled - only auto-sync when explicitly opted in
// In Core 3, satelliteAutoSync defaults to false (undefined is treated as false)
if (this.#options.satelliteAutoSync !== true) {
return false;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend,clerk-js): treat undefined satelliteAutoSync as false by nikosdouvlis · Pull Request #8001 · clerk/javascript · GitHub
Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fix-satellite-auto-sync-default.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/backend": patch
"@clerk/clerk-js": patch
---

Fix `satelliteAutoSync` to default to `false` as documented. Previously, not passing the prop resulted in `undefined`, which was treated as `true` due to a strict equality check (`=== false`). This preserved Core 2 auto-sync behavior instead of the intended Core 3 default. The check is now `!== true`, so both `undefined` and `false` skip automatic satellite sync.
36 changes: 26 additions & 10 deletions integration/tests/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -529,7 +529,7 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with sec-fetch-dest=document - prod', async () => {
test('signed out satellite with sec-fetch-dest=document skips handshake by default (satelliteAutoSync unset) - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -543,13 +543,8 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('redirect_url')).toBe(`${app.serverUrl}/`);
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
expect(locationUrl.searchParams.has('__clerk_api_version')).toBe(true);
expect(locationUrl.searchParams.get('suffixed_cookies')).toBe('false');
// In Core 3, satelliteAutoSync defaults to false, so no handshake redirect
expect(res.status).toBe(200);
});

test('signed out satellite - dev', async () => {
Expand DownExpand Up@@ -628,7 +623,28 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with satelliteAutoSync=true (default) triggers handshake - prod', async () => {
test('signed out satellite with satelliteAutoSync unset triggers handshake when __clerk_synced=false - prod', async () => {
const config = generateConfig({
mode: 'live',
});
const res = await fetch(app.serverUrl + '/?__clerk_synced=false', {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Satellite': 'true',
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
// Even without satelliteAutoSync, __clerk_synced=false (post sign-in) should trigger handshake
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
});

test('signed out satellite with satelliteAutoSync=true (explicit opt-in) triggers handshake - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -643,7 +659,7 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
// Should redirect to handshake with default/true satelliteAutoSync
// Should redirect to handshake when satelliteAutoSync is explicitly true
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
Expand Down
114 changes: 112 additions & 2 deletions packages/backend/src/tokens/__tests__/request.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -651,7 +651,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState).toBeSignedOutToAuth();
});

test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async () => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite with satelliteAutoSync=true and not is synced [11y]', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -671,6 +671,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand All@@ -684,7 +685,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeNull();
});

test('cookieToken: redirects to signInUrl when is satellite dev and not synced', async () => {
test('cookieToken: redirects to signInUrl when is satellite dev with satelliteAutoSync=true and not synced', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -705,6 +706,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand DownExpand Up@@ -873,6 +875,114 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedOutToAuth();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
`http://satellite.dev/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
signInUrl: 'https://primary.dev/sign-in',
isSatellite: true,
domain: 'satellite.dev',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.headers.get('location')).toEqual(
`https://primary.dev/sign-in?__clerk_redirect_url=http%3A%2F%2Fexample.com%2Fpath%3F__clerk_synced%3Dfalse`,
);
});

test('cookieToken: returns handshake when app is not satellite and responds to syncing on dev instances[12y]', async () => {
const sp = new URLSearchParams();
sp.set('__clerk_redirect_url', 'http://localhost:3000');
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/tokens/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -484,7 +484,7 @@ export const authenticateRequest: AuthenticateRequest = (async (
* - 'false' (NeedsSync): Trigger sync - satellite returning from primary sign-in
* - 'true' (Completed): Sync done - prevents re-sync loop
*
* With satelliteAutoSync=false:
* With satelliteAutoSync=false or unset (Core 3 default):
* - Skip handshake on first visit if no cookies exist (return signedOut immediately)
* - Trigger handshake when __clerk_synced=false is present (post sign-in redirect)
* - Allow normal token verification flow when cookies exist (enables refresh)
Expand All@@ -499,8 +499,8 @@ export const authenticateRequest: AuthenticateRequest = (async (
const hasCookies = hasSessionToken || hasActiveClient;

// Determine if we should skip handshake for satellites with no cookies
// satelliteAutoSync defaults to true, so we only skip when explicitly set to false
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync === false && !hasCookies && !needsSync;
// satelliteAutoSync defaults to false (Core 3), so we skip unless explicitly set to true
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync !== true && !hasCookies && !needsSync;

if (authenticateContext.instanceType === 'production' && isRequestEligibleForMultiDomainSync && !syncCompleted) {
// With satelliteAutoSync=false: skip handshake if no cookies and no sync trigger
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2386,6 +2386,7 @@ describe('Clerk singleton', () => {
describe('Clerk().isSatellite and Clerk().domain getters', () => {
beforeEach(() => {
mockClientFetch.mockReset();
mockClientFetch.mockReturnValue(Promise.resolve({ signedInSessions: [] }));
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/auth/AuthCookieService.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ export class AuthCookieService {
if (!this.clerk.loaded) {
return this.clientUat.get() <= 0;
}
return !!this.clerk.user;
return !this.clerk.user;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

public async handleUnauthenticatedDevBrowser() {
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2845,10 +2845,9 @@ export class Clerk implements ClerkInterface {
return true;
}

// Check if satelliteAutoSync is disabled - if so, skip automatic sync
// unless explicitly triggered via __clerk_synced=false
if (this.#options.satelliteAutoSync === false) {
// Skip automatic sync when satelliteAutoSync is false
// Check if satelliteAutoSync is enabled - only auto-sync when explicitly opted in
// In Core 3, satelliteAutoSync defaults to false (undefined is treated as false)
if (this.#options.satelliteAutoSync !== true) {
return false;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend,clerk-js): treat undefined satelliteAutoSync as false by nikosdouvlis · Pull Request #8001 · clerk/javascript · GitHub
Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fix-satellite-auto-sync-default.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/backend": patch
"@clerk/clerk-js": patch
---

Fix `satelliteAutoSync` to default to `false` as documented. Previously, not passing the prop resulted in `undefined`, which was treated as `true` due to a strict equality check (`=== false`). This preserved Core 2 auto-sync behavior instead of the intended Core 3 default. The check is now `!== true`, so both `undefined` and `false` skip automatic satellite sync.
36 changes: 26 additions & 10 deletions integration/tests/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -529,7 +529,7 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with sec-fetch-dest=document - prod', async () => {
test('signed out satellite with sec-fetch-dest=document skips handshake by default (satelliteAutoSync unset) - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -543,13 +543,8 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('redirect_url')).toBe(`${app.serverUrl}/`);
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
expect(locationUrl.searchParams.has('__clerk_api_version')).toBe(true);
expect(locationUrl.searchParams.get('suffixed_cookies')).toBe('false');
// In Core 3, satelliteAutoSync defaults to false, so no handshake redirect
expect(res.status).toBe(200);
});

test('signed out satellite - dev', async () => {
Expand DownExpand Up@@ -628,7 +623,28 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with satelliteAutoSync=true (default) triggers handshake - prod', async () => {
test('signed out satellite with satelliteAutoSync unset triggers handshake when __clerk_synced=false - prod', async () => {
const config = generateConfig({
mode: 'live',
});
const res = await fetch(app.serverUrl + '/?__clerk_synced=false', {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Satellite': 'true',
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
// Even without satelliteAutoSync, __clerk_synced=false (post sign-in) should trigger handshake
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
});

test('signed out satellite with satelliteAutoSync=true (explicit opt-in) triggers handshake - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -643,7 +659,7 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
// Should redirect to handshake with default/true satelliteAutoSync
// Should redirect to handshake when satelliteAutoSync is explicitly true
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
Expand Down
114 changes: 112 additions & 2 deletions packages/backend/src/tokens/__tests__/request.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -651,7 +651,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState).toBeSignedOutToAuth();
});

test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async () => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite with satelliteAutoSync=true and not is synced [11y]', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -671,6 +671,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand All@@ -684,7 +685,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeNull();
});

test('cookieToken: redirects to signInUrl when is satellite dev and not synced', async () => {
test('cookieToken: redirects to signInUrl when is satellite dev with satelliteAutoSync=true and not synced', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -705,6 +706,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand DownExpand Up@@ -873,6 +875,114 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedOutToAuth();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
`http://satellite.dev/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
signInUrl: 'https://primary.dev/sign-in',
isSatellite: true,
domain: 'satellite.dev',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.headers.get('location')).toEqual(
`https://primary.dev/sign-in?__clerk_redirect_url=http%3A%2F%2Fexample.com%2Fpath%3F__clerk_synced%3Dfalse`,
);
});

test('cookieToken: returns handshake when app is not satellite and responds to syncing on dev instances[12y]', async () => {
const sp = new URLSearchParams();
sp.set('__clerk_redirect_url', 'http://localhost:3000');
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/tokens/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -484,7 +484,7 @@ export const authenticateRequest: AuthenticateRequest = (async (
* - 'false' (NeedsSync): Trigger sync - satellite returning from primary sign-in
* - 'true' (Completed): Sync done - prevents re-sync loop
*
* With satelliteAutoSync=false:
* With satelliteAutoSync=false or unset (Core 3 default):
* - Skip handshake on first visit if no cookies exist (return signedOut immediately)
* - Trigger handshake when __clerk_synced=false is present (post sign-in redirect)
* - Allow normal token verification flow when cookies exist (enables refresh)
Expand All@@ -499,8 +499,8 @@ export const authenticateRequest: AuthenticateRequest = (async (
const hasCookies = hasSessionToken || hasActiveClient;

// Determine if we should skip handshake for satellites with no cookies
// satelliteAutoSync defaults to true, so we only skip when explicitly set to false
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync === false && !hasCookies && !needsSync;
// satelliteAutoSync defaults to false (Core 3), so we skip unless explicitly set to true
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync !== true && !hasCookies && !needsSync;

if (authenticateContext.instanceType === 'production' && isRequestEligibleForMultiDomainSync && !syncCompleted) {
// With satelliteAutoSync=false: skip handshake if no cookies and no sync trigger
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2386,6 +2386,7 @@ describe('Clerk singleton', () => {
describe('Clerk().isSatellite and Clerk().domain getters', () => {
beforeEach(() => {
mockClientFetch.mockReset();
mockClientFetch.mockReturnValue(Promise.resolve({ signedInSessions: [] }));
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/auth/AuthCookieService.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ export class AuthCookieService {
if (!this.clerk.loaded) {
return this.clientUat.get() <= 0;
}
return !!this.clerk.user;
return !this.clerk.user;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

public async handleUnauthenticatedDevBrowser() {
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2845,10 +2845,9 @@ export class Clerk implements ClerkInterface {
return true;
}

// Check if satelliteAutoSync is disabled - if so, skip automatic sync
// unless explicitly triggered via __clerk_synced=false
if (this.#options.satelliteAutoSync === false) {
// Skip automatic sync when satelliteAutoSync is false
// Check if satelliteAutoSync is enabled - only auto-sync when explicitly opted in
// In Core 3, satelliteAutoSync defaults to false (undefined is treated as false)
if (this.#options.satelliteAutoSync !== true) {
return false;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(backend,clerk-js): treat undefined satelliteAutoSync as false by nikosdouvlis · Pull Request #8001 · clerk/javascript · GitHub
Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fix-satellite-auto-sync-default.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/backend": patch
"@clerk/clerk-js": patch
---

Fix `satelliteAutoSync` to default to `false` as documented. Previously, not passing the prop resulted in `undefined`, which was treated as `true` due to a strict equality check (`=== false`). This preserved Core 2 auto-sync behavior instead of the intended Core 3 default. The check is now `!== true`, so both `undefined` and `false` skip automatic satellite sync.
36 changes: 26 additions & 10 deletions integration/tests/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -529,7 +529,7 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with sec-fetch-dest=document - prod', async () => {
test('signed out satellite with sec-fetch-dest=document skips handshake by default (satelliteAutoSync unset) - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -543,13 +543,8 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('redirect_url')).toBe(`${app.serverUrl}/`);
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
expect(locationUrl.searchParams.has('__clerk_api_version')).toBe(true);
expect(locationUrl.searchParams.get('suffixed_cookies')).toBe('false');
// In Core 3, satelliteAutoSync defaults to false, so no handshake redirect
expect(res.status).toBe(200);
});

test('signed out satellite - dev', async () => {
Expand DownExpand Up@@ -628,7 +623,28 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with satelliteAutoSync=true (default) triggers handshake - prod', async () => {
test('signed out satellite with satelliteAutoSync unset triggers handshake when __clerk_synced=false - prod', async () => {
const config = generateConfig({
mode: 'live',
});
const res = await fetch(app.serverUrl + '/?__clerk_synced=false', {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Satellite': 'true',
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
// Even without satelliteAutoSync, __clerk_synced=false (post sign-in) should trigger handshake
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
});

test('signed out satellite with satelliteAutoSync=true (explicit opt-in) triggers handshake - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -643,7 +659,7 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
// Should redirect to handshake with default/true satelliteAutoSync
// Should redirect to handshake when satelliteAutoSync is explicitly true
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
Expand Down
114 changes: 112 additions & 2 deletions packages/backend/src/tokens/__tests__/request.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -651,7 +651,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState).toBeSignedOutToAuth();
});

test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async () => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite with satelliteAutoSync=true and not is synced [11y]', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -671,6 +671,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand All@@ -684,7 +685,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeNull();
});

test('cookieToken: redirects to signInUrl when is satellite dev and not synced', async () => {
test('cookieToken: redirects to signInUrl when is satellite dev with satelliteAutoSync=true and not synced', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -705,6 +706,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand DownExpand Up@@ -873,6 +875,114 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedOutToAuth();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
`http://satellite.dev/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
signInUrl: 'https://primary.dev/sign-in',
isSatellite: true,
domain: 'satellite.dev',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.headers.get('location')).toEqual(
`https://primary.dev/sign-in?__clerk_redirect_url=http%3A%2F%2Fexample.com%2Fpath%3F__clerk_synced%3Dfalse`,
);
});

test('cookieToken: returns handshake when app is not satellite and responds to syncing on dev instances[12y]', async () => {
const sp = new URLSearchParams();
sp.set('__clerk_redirect_url', 'http://localhost:3000');
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/tokens/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -484,7 +484,7 @@ export const authenticateRequest: AuthenticateRequest = (async (
* - 'false' (NeedsSync): Trigger sync - satellite returning from primary sign-in
* - 'true' (Completed): Sync done - prevents re-sync loop
*
* With satelliteAutoSync=false:
* With satelliteAutoSync=false or unset (Core 3 default):
* - Skip handshake on first visit if no cookies exist (return signedOut immediately)
* - Trigger handshake when __clerk_synced=false is present (post sign-in redirect)
* - Allow normal token verification flow when cookies exist (enables refresh)
Expand All@@ -499,8 +499,8 @@ export const authenticateRequest: AuthenticateRequest = (async (
const hasCookies = hasSessionToken || hasActiveClient;

// Determine if we should skip handshake for satellites with no cookies
// satelliteAutoSync defaults to true, so we only skip when explicitly set to false
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync === false && !hasCookies && !needsSync;
// satelliteAutoSync defaults to false (Core 3), so we skip unless explicitly set to true
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync !== true && !hasCookies && !needsSync;

if (authenticateContext.instanceType === 'production' && isRequestEligibleForMultiDomainSync && !syncCompleted) {
// With satelliteAutoSync=false: skip handshake if no cookies and no sync trigger
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2386,6 +2386,7 @@ describe('Clerk singleton', () => {
describe('Clerk().isSatellite and Clerk().domain getters', () => {
beforeEach(() => {
mockClientFetch.mockReset();
mockClientFetch.mockReturnValue(Promise.resolve({ signedInSessions: [] }));
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/auth/AuthCookieService.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ export class AuthCookieService {
if (!this.clerk.loaded) {
return this.clientUat.get() <= 0;
}
return !!this.clerk.user;
return !this.clerk.user;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

public async handleUnauthenticatedDevBrowser() {
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2845,10 +2845,9 @@ export class Clerk implements ClerkInterface {
return true;
}

// Check if satelliteAutoSync is disabled - if so, skip automatic sync
// unless explicitly triggered via __clerk_synced=false
if (this.#options.satelliteAutoSync === false) {
// Skip automatic sync when satelliteAutoSync is false
// Check if satelliteAutoSync is enabled - only auto-sync when explicitly opted in
// In Core 3, satelliteAutoSync defaults to false (undefined is treated as false)
if (this.#options.satelliteAutoSync !== true) {
return false;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend,clerk-js): treat undefined satelliteAutoSync as false by nikosdouvlis · Pull Request #8001 · clerk/javascript · GitHub
Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fix-satellite-auto-sync-default.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/backend": patch
"@clerk/clerk-js": patch
---

Fix `satelliteAutoSync` to default to `false` as documented. Previously, not passing the prop resulted in `undefined`, which was treated as `true` due to a strict equality check (`=== false`). This preserved Core 2 auto-sync behavior instead of the intended Core 3 default. The check is now `!== true`, so both `undefined` and `false` skip automatic satellite sync.
36 changes: 26 additions & 10 deletions integration/tests/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -529,7 +529,7 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with sec-fetch-dest=document - prod', async () => {
test('signed out satellite with sec-fetch-dest=document skips handshake by default (satelliteAutoSync unset) - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -543,13 +543,8 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('redirect_url')).toBe(`${app.serverUrl}/`);
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
expect(locationUrl.searchParams.has('__clerk_api_version')).toBe(true);
expect(locationUrl.searchParams.get('suffixed_cookies')).toBe('false');
// In Core 3, satelliteAutoSync defaults to false, so no handshake redirect
expect(res.status).toBe(200);
});

test('signed out satellite - dev', async () => {
Expand DownExpand Up@@ -628,7 +623,28 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with satelliteAutoSync=true (default) triggers handshake - prod', async () => {
test('signed out satellite with satelliteAutoSync unset triggers handshake when __clerk_synced=false - prod', async () => {
const config = generateConfig({
mode: 'live',
});
const res = await fetch(app.serverUrl + '/?__clerk_synced=false', {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Satellite': 'true',
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
// Even without satelliteAutoSync, __clerk_synced=false (post sign-in) should trigger handshake
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
});

test('signed out satellite with satelliteAutoSync=true (explicit opt-in) triggers handshake - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -643,7 +659,7 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
// Should redirect to handshake with default/true satelliteAutoSync
// Should redirect to handshake when satelliteAutoSync is explicitly true
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
Expand Down
114 changes: 112 additions & 2 deletions packages/backend/src/tokens/__tests__/request.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -651,7 +651,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState).toBeSignedOutToAuth();
});

test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async () => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite with satelliteAutoSync=true and not is synced [11y]', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -671,6 +671,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand All@@ -684,7 +685,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeNull();
});

test('cookieToken: redirects to signInUrl when is satellite dev and not synced', async () => {
test('cookieToken: redirects to signInUrl when is satellite dev with satelliteAutoSync=true and not synced', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -705,6 +706,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand DownExpand Up@@ -873,6 +875,114 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedOutToAuth();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
`http://satellite.dev/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
signInUrl: 'https://primary.dev/sign-in',
isSatellite: true,
domain: 'satellite.dev',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.headers.get('location')).toEqual(
`https://primary.dev/sign-in?__clerk_redirect_url=http%3A%2F%2Fexample.com%2Fpath%3F__clerk_synced%3Dfalse`,
);
});

test('cookieToken: returns handshake when app is not satellite and responds to syncing on dev instances[12y]', async () => {
const sp = new URLSearchParams();
sp.set('__clerk_redirect_url', 'http://localhost:3000');
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/tokens/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -484,7 +484,7 @@ export const authenticateRequest: AuthenticateRequest = (async (
* - 'false' (NeedsSync): Trigger sync - satellite returning from primary sign-in
* - 'true' (Completed): Sync done - prevents re-sync loop
*
* With satelliteAutoSync=false:
* With satelliteAutoSync=false or unset (Core 3 default):
* - Skip handshake on first visit if no cookies exist (return signedOut immediately)
* - Trigger handshake when __clerk_synced=false is present (post sign-in redirect)
* - Allow normal token verification flow when cookies exist (enables refresh)
Expand All@@ -499,8 +499,8 @@ export const authenticateRequest: AuthenticateRequest = (async (
const hasCookies = hasSessionToken || hasActiveClient;

// Determine if we should skip handshake for satellites with no cookies
// satelliteAutoSync defaults to true, so we only skip when explicitly set to false
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync === false && !hasCookies && !needsSync;
// satelliteAutoSync defaults to false (Core 3), so we skip unless explicitly set to true
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync !== true && !hasCookies && !needsSync;

if (authenticateContext.instanceType === 'production' && isRequestEligibleForMultiDomainSync && !syncCompleted) {
// With satelliteAutoSync=false: skip handshake if no cookies and no sync trigger
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2386,6 +2386,7 @@ describe('Clerk singleton', () => {
describe('Clerk().isSatellite and Clerk().domain getters', () => {
beforeEach(() => {
mockClientFetch.mockReset();
mockClientFetch.mockReturnValue(Promise.resolve({ signedInSessions: [] }));
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/auth/AuthCookieService.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ export class AuthCookieService {
if (!this.clerk.loaded) {
return this.clientUat.get() <= 0;
}
return !!this.clerk.user;
return !this.clerk.user;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

public async handleUnauthenticatedDevBrowser() {
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2845,10 +2845,9 @@ export class Clerk implements ClerkInterface {
return true;
}

// Check if satelliteAutoSync is disabled - if so, skip automatic sync
// unless explicitly triggered via __clerk_synced=false
if (this.#options.satelliteAutoSync === false) {
// Skip automatic sync when satelliteAutoSync is false
// Check if satelliteAutoSync is enabled - only auto-sync when explicitly opted in
// In Core 3, satelliteAutoSync defaults to false (undefined is treated as false)
if (this.#options.satelliteAutoSync !== true) {
return false;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend,clerk-js): treat undefined satelliteAutoSync as false by nikosdouvlis · Pull Request #8001 · clerk/javascript · GitHub
Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fix-satellite-auto-sync-default.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/backend": patch
"@clerk/clerk-js": patch
---

Fix `satelliteAutoSync` to default to `false` as documented. Previously, not passing the prop resulted in `undefined`, which was treated as `true` due to a strict equality check (`=== false`). This preserved Core 2 auto-sync behavior instead of the intended Core 3 default. The check is now `!== true`, so both `undefined` and `false` skip automatic satellite sync.
36 changes: 26 additions & 10 deletions integration/tests/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -529,7 +529,7 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with sec-fetch-dest=document - prod', async () => {
test('signed out satellite with sec-fetch-dest=document skips handshake by default (satelliteAutoSync unset) - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -543,13 +543,8 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('redirect_url')).toBe(`${app.serverUrl}/`);
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
expect(locationUrl.searchParams.has('__clerk_api_version')).toBe(true);
expect(locationUrl.searchParams.get('suffixed_cookies')).toBe('false');
// In Core 3, satelliteAutoSync defaults to false, so no handshake redirect
expect(res.status).toBe(200);
});

test('signed out satellite - dev', async () => {
Expand DownExpand Up@@ -628,7 +623,28 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with satelliteAutoSync=true (default) triggers handshake - prod', async () => {
test('signed out satellite with satelliteAutoSync unset triggers handshake when __clerk_synced=false - prod', async () => {
const config = generateConfig({
mode: 'live',
});
const res = await fetch(app.serverUrl + '/?__clerk_synced=false', {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Satellite': 'true',
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
// Even without satelliteAutoSync, __clerk_synced=false (post sign-in) should trigger handshake
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
});

test('signed out satellite with satelliteAutoSync=true (explicit opt-in) triggers handshake - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -643,7 +659,7 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
// Should redirect to handshake with default/true satelliteAutoSync
// Should redirect to handshake when satelliteAutoSync is explicitly true
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
Expand Down
114 changes: 112 additions & 2 deletions packages/backend/src/tokens/__tests__/request.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -651,7 +651,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState).toBeSignedOutToAuth();
});

test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async () => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite with satelliteAutoSync=true and not is synced [11y]', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -671,6 +671,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand All@@ -684,7 +685,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeNull();
});

test('cookieToken: redirects to signInUrl when is satellite dev and not synced', async () => {
test('cookieToken: redirects to signInUrl when is satellite dev with satelliteAutoSync=true and not synced', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -705,6 +706,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand DownExpand Up@@ -873,6 +875,114 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedOutToAuth();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
`http://satellite.dev/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
signInUrl: 'https://primary.dev/sign-in',
isSatellite: true,
domain: 'satellite.dev',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.headers.get('location')).toEqual(
`https://primary.dev/sign-in?__clerk_redirect_url=http%3A%2F%2Fexample.com%2Fpath%3F__clerk_synced%3Dfalse`,
);
});

test('cookieToken: returns handshake when app is not satellite and responds to syncing on dev instances[12y]', async () => {
const sp = new URLSearchParams();
sp.set('__clerk_redirect_url', 'http://localhost:3000');
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/tokens/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -484,7 +484,7 @@ export const authenticateRequest: AuthenticateRequest = (async (
* - 'false' (NeedsSync): Trigger sync - satellite returning from primary sign-in
* - 'true' (Completed): Sync done - prevents re-sync loop
*
* With satelliteAutoSync=false:
* With satelliteAutoSync=false or unset (Core 3 default):
* - Skip handshake on first visit if no cookies exist (return signedOut immediately)
* - Trigger handshake when __clerk_synced=false is present (post sign-in redirect)
* - Allow normal token verification flow when cookies exist (enables refresh)
Expand All@@ -499,8 +499,8 @@ export const authenticateRequest: AuthenticateRequest = (async (
const hasCookies = hasSessionToken || hasActiveClient;

// Determine if we should skip handshake for satellites with no cookies
// satelliteAutoSync defaults to true, so we only skip when explicitly set to false
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync === false && !hasCookies && !needsSync;
// satelliteAutoSync defaults to false (Core 3), so we skip unless explicitly set to true
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync !== true && !hasCookies && !needsSync;

if (authenticateContext.instanceType === 'production' && isRequestEligibleForMultiDomainSync && !syncCompleted) {
// With satelliteAutoSync=false: skip handshake if no cookies and no sync trigger
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2386,6 +2386,7 @@ describe('Clerk singleton', () => {
describe('Clerk().isSatellite and Clerk().domain getters', () => {
beforeEach(() => {
mockClientFetch.mockReset();
mockClientFetch.mockReturnValue(Promise.resolve({ signedInSessions: [] }));
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/auth/AuthCookieService.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ export class AuthCookieService {
if (!this.clerk.loaded) {
return this.clientUat.get() <= 0;
}
return !!this.clerk.user;
return !this.clerk.user;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

public async handleUnauthenticatedDevBrowser() {
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2845,10 +2845,9 @@ export class Clerk implements ClerkInterface {
return true;
}

// Check if satelliteAutoSync is disabled - if so, skip automatic sync
// unless explicitly triggered via __clerk_synced=false
if (this.#options.satelliteAutoSync === false) {
// Skip automatic sync when satelliteAutoSync is false
// Check if satelliteAutoSync is enabled - only auto-sync when explicitly opted in
// In Core 3, satelliteAutoSync defaults to false (undefined is treated as false)
if (this.#options.satelliteAutoSync !== true) {
return false;
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(backend,clerk-js): treat undefined satelliteAutoSync as false by nikosdouvlis · Pull Request #8001 · clerk/javascript · GitHub
Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fix-satellite-auto-sync-default.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/backend": patch
"@clerk/clerk-js": patch
---

Fix `satelliteAutoSync` to default to `false` as documented. Previously, not passing the prop resulted in `undefined`, which was treated as `true` due to a strict equality check (`=== false`). This preserved Core 2 auto-sync behavior instead of the intended Core 3 default. The check is now `!== true`, so both `undefined` and `false` skip automatic satellite sync.
36 changes: 26 additions & 10 deletions integration/tests/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -529,7 +529,7 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with sec-fetch-dest=document - prod', async () => {
test('signed out satellite with sec-fetch-dest=document skips handshake by default (satelliteAutoSync unset) - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -543,13 +543,8 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('redirect_url')).toBe(`${app.serverUrl}/`);
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
expect(locationUrl.searchParams.has('__clerk_api_version')).toBe(true);
expect(locationUrl.searchParams.get('suffixed_cookies')).toBe('false');
// In Core 3, satelliteAutoSync defaults to false, so no handshake redirect
expect(res.status).toBe(200);
});

test('signed out satellite - dev', async () => {
Expand DownExpand Up@@ -628,7 +623,28 @@ test.describe('Client handshake @generic', () => {
expect(res.status).toBe(200);
});

test('signed out satellite with satelliteAutoSync=true (default) triggers handshake - prod', async () => {
test('signed out satellite with satelliteAutoSync unset triggers handshake when __clerk_synced=false - prod', async () => {
const config = generateConfig({
mode: 'live',
});
const res = await fetch(app.serverUrl + '/?__clerk_synced=false', {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Satellite': 'true',
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
// Even without satelliteAutoSync, __clerk_synced=false (post sign-in) should trigger handshake
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
expect(locationUrl.searchParams.get('__clerk_hs_reason')).toBe('satellite-needs-syncing');
});

test('signed out satellite with satelliteAutoSync=true (explicit opt-in) triggers handshake - prod', async () => {
const config = generateConfig({
mode: 'live',
});
Expand All@@ -643,7 +659,7 @@ test.describe('Client handshake @generic', () => {
}),
redirect: 'manual',
});
// Should redirect to handshake with default/true satelliteAutoSync
// Should redirect to handshake when satelliteAutoSync is explicitly true
expect(res.status).toBe(307);
const locationUrl = new URL(res.headers.get('location'));
expect(locationUrl.origin + locationUrl.pathname).toBe('https://clerk.example.com/v1/client/handshake');
Expand Down
114 changes: 112 additions & 2 deletions packages/backend/src/tokens/__tests__/request.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -651,7 +651,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState).toBeSignedOutToAuth();
});

test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async () => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite with satelliteAutoSync=true and not is synced [11y]', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -671,6 +671,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand All@@ -684,7 +685,7 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeNull();
});

test('cookieToken: redirects to signInUrl when is satellite dev and not synced', async () => {
test('cookieToken: redirects to signInUrl when is satellite dev with satelliteAutoSync=true and not synced', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
Expand All@@ -705,6 +706,7 @@ describe('tokens.authenticateRequest(options)', () => {
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
satelliteAutoSync: true,
}),
);

Expand DownExpand Up@@ -873,6 +875,114 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedOutToAuth();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: returns signed out without handshake when satelliteAutoSync is not set (defaults to false) and no cookies - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
isSatellite: true,
signInUrl: 'https://primary.dev/sign-in',
domain: 'satellite.dev',
}),
);

expect(requestState).toBeSignedOut({
reason: AuthErrorReason.SessionTokenAndUATMissing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.toAuth()).toBeSignedOutToAuth();
expect(requestState.headers.get('location')).toBeNull();
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - prod', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{ __client_uat: '0' },
`http://satellite.example/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'deadbeef',
publishableKey: PK_LIVE,
signInUrl: 'https://primary.example/sign-in',
isSatellite: true,
domain: 'satellite.example',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.example',
signInUrl: 'https://primary.example/sign-in',
});
});

test('cookieToken: triggers handshake when satelliteAutoSync is not set but __clerk_synced=false is present - dev', async () => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{ ...defaultHeaders, 'sec-fetch-dest': 'document' },
{
__client_uat: '0',
__clerk_db_jwt: mockJwt,
},
`http://satellite.dev/path?__clerk_synced=false`,
),
mockOptions({
secretKey: 'sk_test_deadbeef',
publishableKey: PK_TEST,
signInUrl: 'https://primary.dev/sign-in',
isSatellite: true,
domain: 'satellite.dev',
}),
);

expect(requestState).toMatchHandshake({
reason: AuthErrorReason.SatelliteCookieNeedsSyncing,
isSatellite: true,
domain: 'satellite.dev',
signInUrl: 'https://primary.dev/sign-in',
});
expect(requestState.headers.get('location')).toEqual(
`https://primary.dev/sign-in?__clerk_redirect_url=http%3A%2F%2Fexample.com%2Fpath%3F__clerk_synced%3Dfalse`,
);
});

test('cookieToken: returns handshake when app is not satellite and responds to syncing on dev instances[12y]', async () => {
const sp = new URLSearchParams();
sp.set('__clerk_redirect_url', 'http://localhost:3000');
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/tokens/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -484,7 +484,7 @@ export const authenticateRequest: AuthenticateRequest = (async (
* - 'false' (NeedsSync): Trigger sync - satellite returning from primary sign-in
* - 'true' (Completed): Sync done - prevents re-sync loop
*
* With satelliteAutoSync=false:
* With satelliteAutoSync=false or unset (Core 3 default):
* - Skip handshake on first visit if no cookies exist (return signedOut immediately)
* - Trigger handshake when __clerk_synced=false is present (post sign-in redirect)
* - Allow normal token verification flow when cookies exist (enables refresh)
Expand All@@ -499,8 +499,8 @@ export const authenticateRequest: AuthenticateRequest = (async (
const hasCookies = hasSessionToken || hasActiveClient;

// Determine if we should skip handshake for satellites with no cookies
// satelliteAutoSync defaults to true, so we only skip when explicitly set to false
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync === false && !hasCookies && !needsSync;
// satelliteAutoSync defaults to false (Core 3), so we skip unless explicitly set to true
const shouldSkipSatelliteHandshake = authenticateContext.satelliteAutoSync !== true && !hasCookies && !needsSync;

if (authenticateContext.instanceType === 'production' && isRequestEligibleForMultiDomainSync && !syncCompleted) {
// With satelliteAutoSync=false: skip handshake if no cookies and no sync trigger
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2386,6 +2386,7 @@ describe('Clerk singleton', () => {
describe('Clerk().isSatellite and Clerk().domain getters', () => {
beforeEach(() => {
mockClientFetch.mockReset();
mockClientFetch.mockReturnValue(Promise.resolve({ signedInSessions: [] }));
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/auth/AuthCookieService.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ export class AuthCookieService {
if (!this.clerk.loaded) {
return this.clientUat.get() <= 0;
}
return !!this.clerk.user;
return !this.clerk.user;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

public async handleUnauthenticatedDevBrowser() {
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2845,10 +2845,9 @@ export class Clerk implements ClerkInterface {
return true;
}

// Check if satelliteAutoSync is disabled - if so, skip automatic sync
// unless explicitly triggered via __clerk_synced=false
if (this.#options.satelliteAutoSync === false) {
// Skip automatic sync when satelliteAutoSync is false
// Check if satelliteAutoSync is enabled - only auto-sync when explicitly opted in
// In Core 3, satelliteAutoSync defaults to false (undefined is treated as false)
if (this.#options.satelliteAutoSync !== true) {
return false;
}

Expand Down
Loading