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
5 changes: 5 additions & 0 deletions .changeset/shared-navigator-service-worker.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Resolve the browser connectivity heuristics (`isValidBrowser`, `isBrowserOnline`, and therefore `isValidBrowserOnline`) from the worker's `navigator` when `window` is unavailable but the code runs inside a `WorkerGlobalScope`. In a Web/Service Worker — most notably an MV3 extension background **service worker** (where `@clerk/chrome-extension` loads the background client) — there is no `window`, so these checks previously always reported "invalid/offline". That caused `getToken()` failures to be re-thrown as a misleading `clerk_offline` error and capped network retries lower than intended. The checks now read real connectivity from the worker's `navigator`. Server-side rendering continues to report `false` (the fallback requires a real worker scope, so a bare `globalThis.navigator` such as the one modern Node exposes is not treated as a browser), and behavior in standard browsers and React Native is unchanged.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.18KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.24KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "114KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "72KB" },
Expand Down
70 changes: 69 additions & 1 deletion packages/shared/src/__tests__/browser.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,24 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { inBrowser, isValidBrowser, isValidBrowserOnline, userAgentIsRobot } from '../browser';

/**
* Simulates a Web/Service Worker global scope (e.g. an MV3 background service worker):
* no `window`, but a `WorkerGlobalScope` exposing a `WorkerNavigator` as `self.navigator`.
* Reuses the existing jsdom navigator (with its property spies) as the worker navigator so
* userAgent/onLine/webdriver getters keep applying.
*/
function mockServiceWorkerScope() {
const workerNavigator = window.navigator;
class WorkerGlobalScope {}
const workerSelf = Object.create(WorkerGlobalScope.prototype);
workerSelf.navigator = workerNavigator;
vi.stubGlobal('WorkerGlobalScope', WorkerGlobalScope);
vi.stubGlobal('self', workerSelf);
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);
}

describe('inBrowser()', () => {
afterEach(() => {
vi.restoreAllMocks();
Expand DownExpand Up@@ -36,16 +54,29 @@ describe('isValidBrowser', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns false if not in browser', () => {
it('returns false when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowser()).toBe(false);
});

it('returns true in a service worker (no window) when a valid WorkerNavigator is present', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);

expect(isValidBrowser()).toBe(true);
});

it('returns true if in browser, navigator is not a bot, and webdriver is not enabled', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -131,6 +162,11 @@ describe('isValidBrowserOnline', () => {
connectionGetter = vi.spyOn(window.navigator, 'connection', 'get');
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns TRUE if connection is online, navigator is online, has disabled webdriver, and not a bot', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -207,4 +243,36 @@ describe('isValidBrowserOnline', () => {

expect(isValidBrowserOnline()).toBe(true);
});

it('returns TRUE in a service worker (no window) when the WorkerNavigator reports online', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(true);

expect(isValidBrowserOnline()).toBe(true);
});

it('returns FALSE in a service worker (no window) when the WorkerNavigator reports offline', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(false);

expect(isValidBrowserOnline()).toBe(false);
});

it('returns FALSE when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowserOnline()).toBe(false);
});
});
36 changes: 34 additions & 2 deletions packages/shared/src/browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,45 @@ export function userAgentIsRobot(userAgent: string): boolean {
return !userAgent ? false : botAgentRegex.test(userAgent);
}

/**
* Resolves the `Navigator` object from either the DOM `window` (standard browsers)
* or a Web/Service Worker global scope. An MV3 extension background service worker
* has no `window`, but runs inside a `WorkerGlobalScope` that exposes a
* `WorkerNavigator` as `self.navigator` with the `onLine`/`userAgent` properties
* our heuristics rely on.
*
* We intentionally gate the worker fallback on a real `WorkerGlobalScope` rather than
* accepting any global `navigator`. Modern Node exposes `globalThis.navigator`, so a
* blanket global-navigator check would make Node SSR look like a browser; requiring a
* `WorkerGlobalScope` keeps SSR returning `null`.
*
* @returns
*/
function getNavigator(): Navigator | null {
if (typeof window !== 'undefined' && window.navigator) {
return window.navigator;
}
const workerScope = globalThis as unknown as {
WorkerGlobalScope?: new (...args: never[]) => { navigator?: Navigator };
self?: { navigator?: Navigator };
};
if (
typeof workerScope.WorkerGlobalScope === 'function' &&
workerScope.self instanceof workerScope.WorkerGlobalScope &&
workerScope.self.navigator
) {
return workerScope.self.navigator;
}
return null;
}

Comment thread
royanger marked this conversation as resolved.
/**
* Checks if the current environment is a browser and the user agent is not a bot.
*
* @returns
*/
export function isValidBrowser(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand All@@ -68,7 +100,7 @@ export function isValidBrowser(): boolean {
* @returns
*/
export function isBrowserOnline(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/webauthn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,10 @@ import { isValidBrowser } from './browser';
*/
function isWebAuthnSupported() {
return (
// `isValidBrowser()` now also returns true in environments that expose a global
// `navigator` but no `window` (e.g. service workers). WebAuthn requires the DOM
// `window` (it reads `window.PublicKeyCredential`), so guard on it explicitly.
typeof window !== 'undefined' &&
isValidBrowser() &&
// Check if `PublicKeyCredential` is a constructor
typeof window.PublicKeyCredential === 'function'
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(shared): Added support for global navigator check to isValidBrowser by royanger · Pull Request #8827 · 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
5 changes: 5 additions & 0 deletions .changeset/shared-navigator-service-worker.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Resolve the browser connectivity heuristics (`isValidBrowser`, `isBrowserOnline`, and therefore `isValidBrowserOnline`) from the worker's `navigator` when `window` is unavailable but the code runs inside a `WorkerGlobalScope`. In a Web/Service Worker — most notably an MV3 extension background **service worker** (where `@clerk/chrome-extension` loads the background client) — there is no `window`, so these checks previously always reported "invalid/offline". That caused `getToken()` failures to be re-thrown as a misleading `clerk_offline` error and capped network retries lower than intended. The checks now read real connectivity from the worker's `navigator`. Server-side rendering continues to report `false` (the fallback requires a real worker scope, so a bare `globalThis.navigator` such as the one modern Node exposes is not treated as a browser), and behavior in standard browsers and React Native is unchanged.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.18KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.24KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "114KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "72KB" },
Expand Down
70 changes: 69 additions & 1 deletion packages/shared/src/__tests__/browser.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,24 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { inBrowser, isValidBrowser, isValidBrowserOnline, userAgentIsRobot } from '../browser';

/**
* Simulates a Web/Service Worker global scope (e.g. an MV3 background service worker):
* no `window`, but a `WorkerGlobalScope` exposing a `WorkerNavigator` as `self.navigator`.
* Reuses the existing jsdom navigator (with its property spies) as the worker navigator so
* userAgent/onLine/webdriver getters keep applying.
*/
function mockServiceWorkerScope() {
const workerNavigator = window.navigator;
class WorkerGlobalScope {}
const workerSelf = Object.create(WorkerGlobalScope.prototype);
workerSelf.navigator = workerNavigator;
vi.stubGlobal('WorkerGlobalScope', WorkerGlobalScope);
vi.stubGlobal('self', workerSelf);
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);
}

describe('inBrowser()', () => {
afterEach(() => {
vi.restoreAllMocks();
Expand DownExpand Up@@ -36,16 +54,29 @@ describe('isValidBrowser', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns false if not in browser', () => {
it('returns false when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowser()).toBe(false);
});

it('returns true in a service worker (no window) when a valid WorkerNavigator is present', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);

expect(isValidBrowser()).toBe(true);
});

it('returns true if in browser, navigator is not a bot, and webdriver is not enabled', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -131,6 +162,11 @@ describe('isValidBrowserOnline', () => {
connectionGetter = vi.spyOn(window.navigator, 'connection', 'get');
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns TRUE if connection is online, navigator is online, has disabled webdriver, and not a bot', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -207,4 +243,36 @@ describe('isValidBrowserOnline', () => {

expect(isValidBrowserOnline()).toBe(true);
});

it('returns TRUE in a service worker (no window) when the WorkerNavigator reports online', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(true);

expect(isValidBrowserOnline()).toBe(true);
});

it('returns FALSE in a service worker (no window) when the WorkerNavigator reports offline', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(false);

expect(isValidBrowserOnline()).toBe(false);
});

it('returns FALSE when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowserOnline()).toBe(false);
});
});
36 changes: 34 additions & 2 deletions packages/shared/src/browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,45 @@ export function userAgentIsRobot(userAgent: string): boolean {
return !userAgent ? false : botAgentRegex.test(userAgent);
}

/**
* Resolves the `Navigator` object from either the DOM `window` (standard browsers)
* or a Web/Service Worker global scope. An MV3 extension background service worker
* has no `window`, but runs inside a `WorkerGlobalScope` that exposes a
* `WorkerNavigator` as `self.navigator` with the `onLine`/`userAgent` properties
* our heuristics rely on.
*
* We intentionally gate the worker fallback on a real `WorkerGlobalScope` rather than
* accepting any global `navigator`. Modern Node exposes `globalThis.navigator`, so a
* blanket global-navigator check would make Node SSR look like a browser; requiring a
* `WorkerGlobalScope` keeps SSR returning `null`.
*
* @returns
*/
function getNavigator(): Navigator | null {
if (typeof window !== 'undefined' && window.navigator) {
return window.navigator;
}
const workerScope = globalThis as unknown as {
WorkerGlobalScope?: new (...args: never[]) => { navigator?: Navigator };
self?: { navigator?: Navigator };
};
if (
typeof workerScope.WorkerGlobalScope === 'function' &&
workerScope.self instanceof workerScope.WorkerGlobalScope &&
workerScope.self.navigator
) {
return workerScope.self.navigator;
}
return null;
}

Comment thread
royanger marked this conversation as resolved.
/**
* Checks if the current environment is a browser and the user agent is not a bot.
*
* @returns
*/
export function isValidBrowser(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand All@@ -68,7 +100,7 @@ export function isValidBrowser(): boolean {
* @returns
*/
export function isBrowserOnline(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/webauthn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,10 @@ import { isValidBrowser } from './browser';
*/
function isWebAuthnSupported() {
return (
// `isValidBrowser()` now also returns true in environments that expose a global
// `navigator` but no `window` (e.g. service workers). WebAuthn requires the DOM
// `window` (it reads `window.PublicKeyCredential`), so guard on it explicitly.
typeof window !== 'undefined' &&
isValidBrowser() &&
// Check if `PublicKeyCredential` is a constructor
typeof window.PublicKeyCredential === 'function'
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(shared): Added support for global navigator check to isValidBrowser by royanger · Pull Request #8827 · 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
5 changes: 5 additions & 0 deletions .changeset/shared-navigator-service-worker.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Resolve the browser connectivity heuristics (`isValidBrowser`, `isBrowserOnline`, and therefore `isValidBrowserOnline`) from the worker's `navigator` when `window` is unavailable but the code runs inside a `WorkerGlobalScope`. In a Web/Service Worker — most notably an MV3 extension background **service worker** (where `@clerk/chrome-extension` loads the background client) — there is no `window`, so these checks previously always reported "invalid/offline". That caused `getToken()` failures to be re-thrown as a misleading `clerk_offline` error and capped network retries lower than intended. The checks now read real connectivity from the worker's `navigator`. Server-side rendering continues to report `false` (the fallback requires a real worker scope, so a bare `globalThis.navigator` such as the one modern Node exposes is not treated as a browser), and behavior in standard browsers and React Native is unchanged.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.18KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.24KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "114KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "72KB" },
Expand Down
70 changes: 69 additions & 1 deletion packages/shared/src/__tests__/browser.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,24 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { inBrowser, isValidBrowser, isValidBrowserOnline, userAgentIsRobot } from '../browser';

/**
* Simulates a Web/Service Worker global scope (e.g. an MV3 background service worker):
* no `window`, but a `WorkerGlobalScope` exposing a `WorkerNavigator` as `self.navigator`.
* Reuses the existing jsdom navigator (with its property spies) as the worker navigator so
* userAgent/onLine/webdriver getters keep applying.
*/
function mockServiceWorkerScope() {
const workerNavigator = window.navigator;
class WorkerGlobalScope {}
const workerSelf = Object.create(WorkerGlobalScope.prototype);
workerSelf.navigator = workerNavigator;
vi.stubGlobal('WorkerGlobalScope', WorkerGlobalScope);
vi.stubGlobal('self', workerSelf);
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);
}

describe('inBrowser()', () => {
afterEach(() => {
vi.restoreAllMocks();
Expand DownExpand Up@@ -36,16 +54,29 @@ describe('isValidBrowser', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns false if not in browser', () => {
it('returns false when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowser()).toBe(false);
});

it('returns true in a service worker (no window) when a valid WorkerNavigator is present', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);

expect(isValidBrowser()).toBe(true);
});

it('returns true if in browser, navigator is not a bot, and webdriver is not enabled', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -131,6 +162,11 @@ describe('isValidBrowserOnline', () => {
connectionGetter = vi.spyOn(window.navigator, 'connection', 'get');
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns TRUE if connection is online, navigator is online, has disabled webdriver, and not a bot', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -207,4 +243,36 @@ describe('isValidBrowserOnline', () => {

expect(isValidBrowserOnline()).toBe(true);
});

it('returns TRUE in a service worker (no window) when the WorkerNavigator reports online', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(true);

expect(isValidBrowserOnline()).toBe(true);
});

it('returns FALSE in a service worker (no window) when the WorkerNavigator reports offline', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(false);

expect(isValidBrowserOnline()).toBe(false);
});

it('returns FALSE when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowserOnline()).toBe(false);
});
});
36 changes: 34 additions & 2 deletions packages/shared/src/browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,45 @@ export function userAgentIsRobot(userAgent: string): boolean {
return !userAgent ? false : botAgentRegex.test(userAgent);
}

/**
* Resolves the `Navigator` object from either the DOM `window` (standard browsers)
* or a Web/Service Worker global scope. An MV3 extension background service worker
* has no `window`, but runs inside a `WorkerGlobalScope` that exposes a
* `WorkerNavigator` as `self.navigator` with the `onLine`/`userAgent` properties
* our heuristics rely on.
*
* We intentionally gate the worker fallback on a real `WorkerGlobalScope` rather than
* accepting any global `navigator`. Modern Node exposes `globalThis.navigator`, so a
* blanket global-navigator check would make Node SSR look like a browser; requiring a
* `WorkerGlobalScope` keeps SSR returning `null`.
*
* @returns
*/
function getNavigator(): Navigator | null {
if (typeof window !== 'undefined' && window.navigator) {
return window.navigator;
}
const workerScope = globalThis as unknown as {
WorkerGlobalScope?: new (...args: never[]) => { navigator?: Navigator };
self?: { navigator?: Navigator };
};
if (
typeof workerScope.WorkerGlobalScope === 'function' &&
workerScope.self instanceof workerScope.WorkerGlobalScope &&
workerScope.self.navigator
) {
return workerScope.self.navigator;
}
return null;
}

Comment thread
royanger marked this conversation as resolved.
/**
* Checks if the current environment is a browser and the user agent is not a bot.
*
* @returns
*/
export function isValidBrowser(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand All@@ -68,7 +100,7 @@ export function isValidBrowser(): boolean {
* @returns
*/
export function isBrowserOnline(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/webauthn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,10 @@ import { isValidBrowser } from './browser';
*/
function isWebAuthnSupported() {
return (
// `isValidBrowser()` now also returns true in environments that expose a global
// `navigator` but no `window` (e.g. service workers). WebAuthn requires the DOM
// `window` (it reads `window.PublicKeyCredential`), so guard on it explicitly.
typeof window !== 'undefined' &&
isValidBrowser() &&
// Check if `PublicKeyCredential` is a constructor
typeof window.PublicKeyCredential === 'function'
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(shared): Added support for global navigator check to isValidBrowser by royanger · Pull Request #8827 · 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
5 changes: 5 additions & 0 deletions .changeset/shared-navigator-service-worker.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Resolve the browser connectivity heuristics (`isValidBrowser`, `isBrowserOnline`, and therefore `isValidBrowserOnline`) from the worker's `navigator` when `window` is unavailable but the code runs inside a `WorkerGlobalScope`. In a Web/Service Worker — most notably an MV3 extension background **service worker** (where `@clerk/chrome-extension` loads the background client) — there is no `window`, so these checks previously always reported "invalid/offline". That caused `getToken()` failures to be re-thrown as a misleading `clerk_offline` error and capped network retries lower than intended. The checks now read real connectivity from the worker's `navigator`. Server-side rendering continues to report `false` (the fallback requires a real worker scope, so a bare `globalThis.navigator` such as the one modern Node exposes is not treated as a browser), and behavior in standard browsers and React Native is unchanged.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.18KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.24KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "114KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "72KB" },
Expand Down
70 changes: 69 additions & 1 deletion packages/shared/src/__tests__/browser.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,24 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { inBrowser, isValidBrowser, isValidBrowserOnline, userAgentIsRobot } from '../browser';

/**
* Simulates a Web/Service Worker global scope (e.g. an MV3 background service worker):
* no `window`, but a `WorkerGlobalScope` exposing a `WorkerNavigator` as `self.navigator`.
* Reuses the existing jsdom navigator (with its property spies) as the worker navigator so
* userAgent/onLine/webdriver getters keep applying.
*/
function mockServiceWorkerScope() {
const workerNavigator = window.navigator;
class WorkerGlobalScope {}
const workerSelf = Object.create(WorkerGlobalScope.prototype);
workerSelf.navigator = workerNavigator;
vi.stubGlobal('WorkerGlobalScope', WorkerGlobalScope);
vi.stubGlobal('self', workerSelf);
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);
}

describe('inBrowser()', () => {
afterEach(() => {
vi.restoreAllMocks();
Expand DownExpand Up@@ -36,16 +54,29 @@ describe('isValidBrowser', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns false if not in browser', () => {
it('returns false when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowser()).toBe(false);
});

it('returns true in a service worker (no window) when a valid WorkerNavigator is present', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);

expect(isValidBrowser()).toBe(true);
});

it('returns true if in browser, navigator is not a bot, and webdriver is not enabled', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -131,6 +162,11 @@ describe('isValidBrowserOnline', () => {
connectionGetter = vi.spyOn(window.navigator, 'connection', 'get');
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns TRUE if connection is online, navigator is online, has disabled webdriver, and not a bot', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -207,4 +243,36 @@ describe('isValidBrowserOnline', () => {

expect(isValidBrowserOnline()).toBe(true);
});

it('returns TRUE in a service worker (no window) when the WorkerNavigator reports online', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(true);

expect(isValidBrowserOnline()).toBe(true);
});

it('returns FALSE in a service worker (no window) when the WorkerNavigator reports offline', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(false);

expect(isValidBrowserOnline()).toBe(false);
});

it('returns FALSE when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowserOnline()).toBe(false);
});
});
36 changes: 34 additions & 2 deletions packages/shared/src/browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,45 @@ export function userAgentIsRobot(userAgent: string): boolean {
return !userAgent ? false : botAgentRegex.test(userAgent);
}

/**
* Resolves the `Navigator` object from either the DOM `window` (standard browsers)
* or a Web/Service Worker global scope. An MV3 extension background service worker
* has no `window`, but runs inside a `WorkerGlobalScope` that exposes a
* `WorkerNavigator` as `self.navigator` with the `onLine`/`userAgent` properties
* our heuristics rely on.
*
* We intentionally gate the worker fallback on a real `WorkerGlobalScope` rather than
* accepting any global `navigator`. Modern Node exposes `globalThis.navigator`, so a
* blanket global-navigator check would make Node SSR look like a browser; requiring a
* `WorkerGlobalScope` keeps SSR returning `null`.
*
* @returns
*/
function getNavigator(): Navigator | null {
if (typeof window !== 'undefined' && window.navigator) {
return window.navigator;
}
const workerScope = globalThis as unknown as {
WorkerGlobalScope?: new (...args: never[]) => { navigator?: Navigator };
self?: { navigator?: Navigator };
};
if (
typeof workerScope.WorkerGlobalScope === 'function' &&
workerScope.self instanceof workerScope.WorkerGlobalScope &&
workerScope.self.navigator
) {
return workerScope.self.navigator;
}
return null;
}

Comment thread
royanger marked this conversation as resolved.
/**
* Checks if the current environment is a browser and the user agent is not a bot.
*
* @returns
*/
export function isValidBrowser(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand All@@ -68,7 +100,7 @@ export function isValidBrowser(): boolean {
* @returns
*/
export function isBrowserOnline(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/webauthn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,10 @@ import { isValidBrowser } from './browser';
*/
function isWebAuthnSupported() {
return (
// `isValidBrowser()` now also returns true in environments that expose a global
// `navigator` but no `window` (e.g. service workers). WebAuthn requires the DOM
// `window` (it reads `window.PublicKeyCredential`), so guard on it explicitly.
typeof window !== 'undefined' &&
isValidBrowser() &&
// Check if `PublicKeyCredential` is a constructor
typeof window.PublicKeyCredential === 'function'
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(shared): Added support for global navigator check to isValidBrowser by royanger · Pull Request #8827 · 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
5 changes: 5 additions & 0 deletions .changeset/shared-navigator-service-worker.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Resolve the browser connectivity heuristics (`isValidBrowser`, `isBrowserOnline`, and therefore `isValidBrowserOnline`) from the worker's `navigator` when `window` is unavailable but the code runs inside a `WorkerGlobalScope`. In a Web/Service Worker — most notably an MV3 extension background **service worker** (where `@clerk/chrome-extension` loads the background client) — there is no `window`, so these checks previously always reported "invalid/offline". That caused `getToken()` failures to be re-thrown as a misleading `clerk_offline` error and capped network retries lower than intended. The checks now read real connectivity from the worker's `navigator`. Server-side rendering continues to report `false` (the fallback requires a real worker scope, so a bare `globalThis.navigator` such as the one modern Node exposes is not treated as a browser), and behavior in standard browsers and React Native is unchanged.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.18KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.24KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "114KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "72KB" },
Expand Down
70 changes: 69 additions & 1 deletion packages/shared/src/__tests__/browser.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,24 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { inBrowser, isValidBrowser, isValidBrowserOnline, userAgentIsRobot } from '../browser';

/**
* Simulates a Web/Service Worker global scope (e.g. an MV3 background service worker):
* no `window`, but a `WorkerGlobalScope` exposing a `WorkerNavigator` as `self.navigator`.
* Reuses the existing jsdom navigator (with its property spies) as the worker navigator so
* userAgent/onLine/webdriver getters keep applying.
*/
function mockServiceWorkerScope() {
const workerNavigator = window.navigator;
class WorkerGlobalScope {}
const workerSelf = Object.create(WorkerGlobalScope.prototype);
workerSelf.navigator = workerNavigator;
vi.stubGlobal('WorkerGlobalScope', WorkerGlobalScope);
vi.stubGlobal('self', workerSelf);
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);
}

describe('inBrowser()', () => {
afterEach(() => {
vi.restoreAllMocks();
Expand DownExpand Up@@ -36,16 +54,29 @@ describe('isValidBrowser', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns false if not in browser', () => {
it('returns false when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowser()).toBe(false);
});

it('returns true in a service worker (no window) when a valid WorkerNavigator is present', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);

expect(isValidBrowser()).toBe(true);
});

it('returns true if in browser, navigator is not a bot, and webdriver is not enabled', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -131,6 +162,11 @@ describe('isValidBrowserOnline', () => {
connectionGetter = vi.spyOn(window.navigator, 'connection', 'get');
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns TRUE if connection is online, navigator is online, has disabled webdriver, and not a bot', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -207,4 +243,36 @@ describe('isValidBrowserOnline', () => {

expect(isValidBrowserOnline()).toBe(true);
});

it('returns TRUE in a service worker (no window) when the WorkerNavigator reports online', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(true);

expect(isValidBrowserOnline()).toBe(true);
});

it('returns FALSE in a service worker (no window) when the WorkerNavigator reports offline', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(false);

expect(isValidBrowserOnline()).toBe(false);
});

it('returns FALSE when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowserOnline()).toBe(false);
});
});
36 changes: 34 additions & 2 deletions packages/shared/src/browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,45 @@ export function userAgentIsRobot(userAgent: string): boolean {
return !userAgent ? false : botAgentRegex.test(userAgent);
}

/**
* Resolves the `Navigator` object from either the DOM `window` (standard browsers)
* or a Web/Service Worker global scope. An MV3 extension background service worker
* has no `window`, but runs inside a `WorkerGlobalScope` that exposes a
* `WorkerNavigator` as `self.navigator` with the `onLine`/`userAgent` properties
* our heuristics rely on.
*
* We intentionally gate the worker fallback on a real `WorkerGlobalScope` rather than
* accepting any global `navigator`. Modern Node exposes `globalThis.navigator`, so a
* blanket global-navigator check would make Node SSR look like a browser; requiring a
* `WorkerGlobalScope` keeps SSR returning `null`.
*
* @returns
*/
function getNavigator(): Navigator | null {
if (typeof window !== 'undefined' && window.navigator) {
return window.navigator;
}
const workerScope = globalThis as unknown as {
WorkerGlobalScope?: new (...args: never[]) => { navigator?: Navigator };
self?: { navigator?: Navigator };
};
if (
typeof workerScope.WorkerGlobalScope === 'function' &&
workerScope.self instanceof workerScope.WorkerGlobalScope &&
workerScope.self.navigator
) {
return workerScope.self.navigator;
}
return null;
}

Comment thread
royanger marked this conversation as resolved.
/**
* Checks if the current environment is a browser and the user agent is not a bot.
*
* @returns
*/
export function isValidBrowser(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand All@@ -68,7 +100,7 @@ export function isValidBrowser(): boolean {
* @returns
*/
export function isBrowserOnline(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/webauthn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,10 @@ import { isValidBrowser } from './browser';
*/
function isWebAuthnSupported() {
return (
// `isValidBrowser()` now also returns true in environments that expose a global
// `navigator` but no `window` (e.g. service workers). WebAuthn requires the DOM
// `window` (it reads `window.PublicKeyCredential`), so guard on it explicitly.
typeof window !== 'undefined' &&
isValidBrowser() &&
// Check if `PublicKeyCredential` is a constructor
typeof window.PublicKeyCredential === 'function'
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(shared): Added support for global navigator check to isValidBrowser by royanger · Pull Request #8827 · 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
5 changes: 5 additions & 0 deletions .changeset/shared-navigator-service-worker.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Resolve the browser connectivity heuristics (`isValidBrowser`, `isBrowserOnline`, and therefore `isValidBrowserOnline`) from the worker's `navigator` when `window` is unavailable but the code runs inside a `WorkerGlobalScope`. In a Web/Service Worker — most notably an MV3 extension background **service worker** (where `@clerk/chrome-extension` loads the background client) — there is no `window`, so these checks previously always reported "invalid/offline". That caused `getToken()` failures to be re-thrown as a misleading `clerk_offline` error and capped network retries lower than intended. The checks now read real connectivity from the worker's `navigator`. Server-side rendering continues to report `false` (the fallback requires a real worker scope, so a bare `globalThis.navigator` such as the one modern Node exposes is not treated as a browser), and behavior in standard browsers and React Native is unchanged.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.18KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.24KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "114KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "72KB" },
Expand Down
70 changes: 69 additions & 1 deletion packages/shared/src/__tests__/browser.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,24 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { inBrowser, isValidBrowser, isValidBrowserOnline, userAgentIsRobot } from '../browser';

/**
* Simulates a Web/Service Worker global scope (e.g. an MV3 background service worker):
* no `window`, but a `WorkerGlobalScope` exposing a `WorkerNavigator` as `self.navigator`.
* Reuses the existing jsdom navigator (with its property spies) as the worker navigator so
* userAgent/onLine/webdriver getters keep applying.
*/
function mockServiceWorkerScope() {
const workerNavigator = window.navigator;
class WorkerGlobalScope {}
const workerSelf = Object.create(WorkerGlobalScope.prototype);
workerSelf.navigator = workerNavigator;
vi.stubGlobal('WorkerGlobalScope', WorkerGlobalScope);
vi.stubGlobal('self', workerSelf);
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);
}

describe('inBrowser()', () => {
afterEach(() => {
vi.restoreAllMocks();
Expand DownExpand Up@@ -36,16 +54,29 @@ describe('isValidBrowser', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns false if not in browser', () => {
it('returns false when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowser()).toBe(false);
});

it('returns true in a service worker (no window) when a valid WorkerNavigator is present', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);

expect(isValidBrowser()).toBe(true);
});

it('returns true if in browser, navigator is not a bot, and webdriver is not enabled', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -131,6 +162,11 @@ describe('isValidBrowserOnline', () => {
connectionGetter = vi.spyOn(window.navigator, 'connection', 'get');
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns TRUE if connection is online, navigator is online, has disabled webdriver, and not a bot', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -207,4 +243,36 @@ describe('isValidBrowserOnline', () => {

expect(isValidBrowserOnline()).toBe(true);
});

it('returns TRUE in a service worker (no window) when the WorkerNavigator reports online', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(true);

expect(isValidBrowserOnline()).toBe(true);
});

it('returns FALSE in a service worker (no window) when the WorkerNavigator reports offline', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(false);

expect(isValidBrowserOnline()).toBe(false);
});

it('returns FALSE when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowserOnline()).toBe(false);
});
});
36 changes: 34 additions & 2 deletions packages/shared/src/browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,45 @@ export function userAgentIsRobot(userAgent: string): boolean {
return !userAgent ? false : botAgentRegex.test(userAgent);
}

/**
* Resolves the `Navigator` object from either the DOM `window` (standard browsers)
* or a Web/Service Worker global scope. An MV3 extension background service worker
* has no `window`, but runs inside a `WorkerGlobalScope` that exposes a
* `WorkerNavigator` as `self.navigator` with the `onLine`/`userAgent` properties
* our heuristics rely on.
*
* We intentionally gate the worker fallback on a real `WorkerGlobalScope` rather than
* accepting any global `navigator`. Modern Node exposes `globalThis.navigator`, so a
* blanket global-navigator check would make Node SSR look like a browser; requiring a
* `WorkerGlobalScope` keeps SSR returning `null`.
*
* @returns
*/
function getNavigator(): Navigator | null {
if (typeof window !== 'undefined' && window.navigator) {
return window.navigator;
}
const workerScope = globalThis as unknown as {
WorkerGlobalScope?: new (...args: never[]) => { navigator?: Navigator };
self?: { navigator?: Navigator };
};
if (
typeof workerScope.WorkerGlobalScope === 'function' &&
workerScope.self instanceof workerScope.WorkerGlobalScope &&
workerScope.self.navigator
) {
return workerScope.self.navigator;
}
return null;
}

Comment thread
royanger marked this conversation as resolved.
/**
* Checks if the current environment is a browser and the user agent is not a bot.
*
* @returns
*/
export function isValidBrowser(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand All@@ -68,7 +100,7 @@ export function isValidBrowser(): boolean {
* @returns
*/
export function isBrowserOnline(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/webauthn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,10 @@ import { isValidBrowser } from './browser';
*/
function isWebAuthnSupported() {
return (
// `isValidBrowser()` now also returns true in environments that expose a global
// `navigator` but no `window` (e.g. service workers). WebAuthn requires the DOM
// `window` (it reads `window.PublicKeyCredential`), so guard on it explicitly.
typeof window !== 'undefined' &&
isValidBrowser() &&
// Check if `PublicKeyCredential` is a constructor
typeof window.PublicKeyCredential === 'function'
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(shared): Added support for global navigator check to isValidBrowser by royanger · Pull Request #8827 · 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
5 changes: 5 additions & 0 deletions .changeset/shared-navigator-service-worker.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Resolve the browser connectivity heuristics (`isValidBrowser`, `isBrowserOnline`, and therefore `isValidBrowserOnline`) from the worker's `navigator` when `window` is unavailable but the code runs inside a `WorkerGlobalScope`. In a Web/Service Worker — most notably an MV3 extension background **service worker** (where `@clerk/chrome-extension` loads the background client) — there is no `window`, so these checks previously always reported "invalid/offline". That caused `getToken()` failures to be re-thrown as a misleading `clerk_offline` error and capped network retries lower than intended. The checks now read real connectivity from the worker's `navigator`. Server-side rendering continues to report `false` (the fallback requires a real worker scope, so a bare `globalThis.navigator` such as the one modern Node exposes is not treated as a browser), and behavior in standard browsers and React Native is unchanged.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.18KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.24KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "114KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "72KB" },
Expand Down
70 changes: 69 additions & 1 deletion packages/shared/src/__tests__/browser.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,24 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { inBrowser, isValidBrowser, isValidBrowserOnline, userAgentIsRobot } from '../browser';

/**
* Simulates a Web/Service Worker global scope (e.g. an MV3 background service worker):
* no `window`, but a `WorkerGlobalScope` exposing a `WorkerNavigator` as `self.navigator`.
* Reuses the existing jsdom navigator (with its property spies) as the worker navigator so
* userAgent/onLine/webdriver getters keep applying.
*/
function mockServiceWorkerScope() {
const workerNavigator = window.navigator;
class WorkerGlobalScope {}
const workerSelf = Object.create(WorkerGlobalScope.prototype);
workerSelf.navigator = workerNavigator;
vi.stubGlobal('WorkerGlobalScope', WorkerGlobalScope);
vi.stubGlobal('self', workerSelf);
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);
}

describe('inBrowser()', () => {
afterEach(() => {
vi.restoreAllMocks();
Expand DownExpand Up@@ -36,16 +54,29 @@ describe('isValidBrowser', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns false if not in browser', () => {
it('returns false when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowser()).toBe(false);
});

it('returns true in a service worker (no window) when a valid WorkerNavigator is present', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);

expect(isValidBrowser()).toBe(true);
});

it('returns true if in browser, navigator is not a bot, and webdriver is not enabled', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -131,6 +162,11 @@ describe('isValidBrowserOnline', () => {
connectionGetter = vi.spyOn(window.navigator, 'connection', 'get');
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns TRUE if connection is online, navigator is online, has disabled webdriver, and not a bot', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -207,4 +243,36 @@ describe('isValidBrowserOnline', () => {

expect(isValidBrowserOnline()).toBe(true);
});

it('returns TRUE in a service worker (no window) when the WorkerNavigator reports online', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(true);

expect(isValidBrowserOnline()).toBe(true);
});

it('returns FALSE in a service worker (no window) when the WorkerNavigator reports offline', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(false);

expect(isValidBrowserOnline()).toBe(false);
});

it('returns FALSE when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowserOnline()).toBe(false);
});
});
36 changes: 34 additions & 2 deletions packages/shared/src/browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,45 @@ export function userAgentIsRobot(userAgent: string): boolean {
return !userAgent ? false : botAgentRegex.test(userAgent);
}

/**
* Resolves the `Navigator` object from either the DOM `window` (standard browsers)
* or a Web/Service Worker global scope. An MV3 extension background service worker
* has no `window`, but runs inside a `WorkerGlobalScope` that exposes a
* `WorkerNavigator` as `self.navigator` with the `onLine`/`userAgent` properties
* our heuristics rely on.
*
* We intentionally gate the worker fallback on a real `WorkerGlobalScope` rather than
* accepting any global `navigator`. Modern Node exposes `globalThis.navigator`, so a
* blanket global-navigator check would make Node SSR look like a browser; requiring a
* `WorkerGlobalScope` keeps SSR returning `null`.
*
* @returns
*/
function getNavigator(): Navigator | null {
if (typeof window !== 'undefined' && window.navigator) {
return window.navigator;
}
const workerScope = globalThis as unknown as {
WorkerGlobalScope?: new (...args: never[]) => { navigator?: Navigator };
self?: { navigator?: Navigator };
};
if (
typeof workerScope.WorkerGlobalScope === 'function' &&
workerScope.self instanceof workerScope.WorkerGlobalScope &&
workerScope.self.navigator
) {
return workerScope.self.navigator;
}
return null;
}

Comment thread
royanger marked this conversation as resolved.
/**
* Checks if the current environment is a browser and the user agent is not a bot.
*
* @returns
*/
export function isValidBrowser(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand All@@ -68,7 +100,7 @@ export function isValidBrowser(): boolean {
* @returns
*/
export function isBrowserOnline(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/webauthn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,10 @@ import { isValidBrowser } from './browser';
*/
function isWebAuthnSupported() {
return (
// `isValidBrowser()` now also returns true in environments that expose a global
// `navigator` but no `window` (e.g. service workers). WebAuthn requires the DOM
// `window` (it reads `window.PublicKeyCredential`), so guard on it explicitly.
typeof window !== 'undefined' &&
isValidBrowser() &&
// Check if `PublicKeyCredential` is a constructor
typeof window.PublicKeyCredential === 'function'
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(shared): Added support for global navigator check to isValidBrowser by royanger · Pull Request #8827 · 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
5 changes: 5 additions & 0 deletions .changeset/shared-navigator-service-worker.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Resolve the browser connectivity heuristics (`isValidBrowser`, `isBrowserOnline`, and therefore `isValidBrowserOnline`) from the worker's `navigator` when `window` is unavailable but the code runs inside a `WorkerGlobalScope`. In a Web/Service Worker — most notably an MV3 extension background **service worker** (where `@clerk/chrome-extension` loads the background client) — there is no `window`, so these checks previously always reported "invalid/offline". That caused `getToken()` failures to be re-thrown as a misleading `clerk_offline` error and capped network retries lower than intended. The checks now read real connectivity from the worker's `navigator`. Server-side rendering continues to report `false` (the fallback requires a real worker scope, so a bare `globalThis.navigator` such as the one modern Node exposes is not treated as a browser), and behavior in standard browsers and React Native is unchanged.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.18KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "71.24KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "114KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "72KB" },
Expand Down
70 changes: 69 additions & 1 deletion packages/shared/src/__tests__/browser.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,24 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { inBrowser, isValidBrowser, isValidBrowserOnline, userAgentIsRobot } from '../browser';

/**
* Simulates a Web/Service Worker global scope (e.g. an MV3 background service worker):
* no `window`, but a `WorkerGlobalScope` exposing a `WorkerNavigator` as `self.navigator`.
* Reuses the existing jsdom navigator (with its property spies) as the worker navigator so
* userAgent/onLine/webdriver getters keep applying.
*/
function mockServiceWorkerScope() {
const workerNavigator = window.navigator;
class WorkerGlobalScope {}
const workerSelf = Object.create(WorkerGlobalScope.prototype);
workerSelf.navigator = workerNavigator;
vi.stubGlobal('WorkerGlobalScope', WorkerGlobalScope);
vi.stubGlobal('self', workerSelf);
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);
}

describe('inBrowser()', () => {
afterEach(() => {
vi.restoreAllMocks();
Expand DownExpand Up@@ -36,16 +54,29 @@ describe('isValidBrowser', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns false if not in browser', () => {
it('returns false when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowser()).toBe(false);
});

it('returns true in a service worker (no window) when a valid WorkerNavigator is present', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);

expect(isValidBrowser()).toBe(true);
});

it('returns true if in browser, navigator is not a bot, and webdriver is not enabled', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -131,6 +162,11 @@ describe('isValidBrowserOnline', () => {
connectionGetter = vi.spyOn(window.navigator, 'connection', 'get');
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
});

it('returns TRUE if connection is online, navigator is online, has disabled webdriver, and not a bot', () => {
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0',
Expand DownExpand Up@@ -207,4 +243,36 @@ describe('isValidBrowserOnline', () => {

expect(isValidBrowserOnline()).toBe(true);
});

it('returns TRUE in a service worker (no window) when the WorkerNavigator reports online', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(true);

expect(isValidBrowserOnline()).toBe(true);
});

it('returns FALSE in a service worker (no window) when the WorkerNavigator reports offline', () => {
mockServiceWorkerScope();
userAgentGetter.mockReturnValue(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
);
webdriverGetter.mockReturnValue(false);
onLineGetter.mockReturnValue(false);

expect(isValidBrowserOnline()).toBe(false);
});

it('returns FALSE when there is no window and no WorkerGlobalScope (e.g. Node SSR)', () => {
// Modern Node exposes `globalThis.navigator`, so the bare global navigator stays
// defined here. Without a `WorkerGlobalScope`, SSR must still be treated as non-browser.
const windowSpy = vi.spyOn(global, 'window', 'get');
// @ts-ignore - Test
windowSpy.mockReturnValue(undefined);

expect(isValidBrowserOnline()).toBe(false);
});
});
36 changes: 34 additions & 2 deletions packages/shared/src/browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,45 @@ export function userAgentIsRobot(userAgent: string): boolean {
return !userAgent ? false : botAgentRegex.test(userAgent);
}

/**
* Resolves the `Navigator` object from either the DOM `window` (standard browsers)
* or a Web/Service Worker global scope. An MV3 extension background service worker
* has no `window`, but runs inside a `WorkerGlobalScope` that exposes a
* `WorkerNavigator` as `self.navigator` with the `onLine`/`userAgent` properties
* our heuristics rely on.
*
* We intentionally gate the worker fallback on a real `WorkerGlobalScope` rather than
* accepting any global `navigator`. Modern Node exposes `globalThis.navigator`, so a
* blanket global-navigator check would make Node SSR look like a browser; requiring a
* `WorkerGlobalScope` keeps SSR returning `null`.
*
* @returns
*/
function getNavigator(): Navigator | null {
if (typeof window !== 'undefined' && window.navigator) {
return window.navigator;
}
const workerScope = globalThis as unknown as {
WorkerGlobalScope?: new (...args: never[]) => { navigator?: Navigator };
self?: { navigator?: Navigator };
};
if (
typeof workerScope.WorkerGlobalScope === 'function' &&
workerScope.self instanceof workerScope.WorkerGlobalScope &&
workerScope.self.navigator
) {
return workerScope.self.navigator;
}
return null;
}

Comment thread
royanger marked this conversation as resolved.
/**
* Checks if the current environment is a browser and the user agent is not a bot.
*
* @returns
*/
export function isValidBrowser(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand All@@ -68,7 +100,7 @@ export function isValidBrowser(): boolean {
* @returns
*/
export function isBrowserOnline(): boolean {
const navigator = inBrowser() ? window?.navigator : null;
const navigator = getNavigator();
if (!navigator) {
return false;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/webauthn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,10 @@ import { isValidBrowser } from './browser';
*/
function isWebAuthnSupported() {
return (
// `isValidBrowser()` now also returns true in environments that expose a global
// `navigator` but no `window` (e.g. service workers). WebAuthn requires the DOM
// `window` (it reads `window.PublicKeyCredential`), so guard on it explicitly.
typeof window !== 'undefined' &&
isValidBrowser() &&
// Check if `PublicKeyCredential` is a constructor
typeof window.PublicKeyCredential === 'function'
Expand Down
Loading