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
16 changes: 16 additions & 0 deletions .changeset/quiet-dev-keys-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
'@clerk/shared': patch
---

Add an env-var shortcut for `unsafe_disableDevelopmentModeConsoleWarning` across the Astro, Nuxt, React Router, and TanStack Start integrations so the development-keys console warning can be suppressed without threading the option through `<ClerkProvider>` manually:

- Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)
- TanStack Start: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)

The Next.js equivalent (`NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`) already existed; the JSDoc on `unsafe_disableDevelopmentModeConsoleWarning` now lists every framework's env-var shortcut and clarifies that suppressing the warning at source also keeps it from being mirrored to the dev-server terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeEnvVarsWithParams } from '../merge-env-vars-with-params';

describe('mergeEnvVarsWithParams', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit unsafe_disableDevelopmentModeConsoleWarning false when env is true', () => {
vi.stubEnv('PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeEnvVarsWithParams({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});
});
4 changes: 4 additions & 0 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const mergeEnvVarsWithParams = (
__internal_clerkUIUrl: paramClerkUIUrl,
__internal_clerkUIVersion: paramClerkUIVersion,
prefetchUI: paramPrefetchUI,
unsafe_disableDevelopmentModeConsoleWarning: paramUnsafeDisableDevelopmentModeConsoleWarning,
...rest
} = params || {};

Expand All@@ -65,6 +66,9 @@ const mergeEnvVarsWithParams = (
disabled: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DISABLED),
debug: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DEBUG),
},
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
Comment thread
jacekradko marked this conversation as resolved.
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,8 @@ export default defineNuxtModule<ModuleOptions>({
// prefetchUI config: can be false or undefined
prefetchUI: options.prefetchUI,
isSatellite: options.isSatellite,
// Listed explicitly so it can be overridden via NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING.
unsafe_disableDevelopmentModeConsoleWarning: options.unsafe_disableDevelopmentModeConsoleWarning,
// Backend specific variables that are safe to share.
// We want them to be overridable like the other public keys (e.g NUXT_PUBLIC_CLERK_PROXY_URL)
proxyUrl: options.proxyUrl,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
__prefetchUI,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__keylessClaimUrl,
__keylessApiKeysUrl,
} = clerkState?.__internal_clerk_state || {};
Expand DownExpand Up@@ -101,6 +102,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
};

const keylessProps = __keylessClaimUrl
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
__keylessClaimUrl?: string;
__keylessApiKeysUrl?: string;
};
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/server/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ export function getResponseClerkState(requestState: RequestStateWithRedirectUrls
__prefetchUI: envVars.prefetchUI,
__telemetryDisabled: envVars.telemetryDisabled,
__telemetryDebug: envVars.telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning: envVars.unsafeDisableDevelopmentModeConsoleWarning,
};

if (canUseKeyless && __keylessClaimUrl) {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-router/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ export const getPublicEnvVariables = (context: AppLoadContext | undefined) => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
signInForceRedirectUrl: getValue('CLERK_SIGN_IN_FORCE_REDIRECT_URL'),
signUpForceRedirectUrl: getValue('CLERK_SIGN_UP_FORCE_REDIRECT_URL'),
signInFallbackRedirectUrl: getValue('CLERK_SIGN_IN_FALLBACK_REDIRECT_URL'),
Expand Down
12 changes: 11 additions & 1 deletion packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1123,7 +1123,17 @@ type ClerkOptionsNavigation =

type ClerkUnsafeOptions = {
/**
* Disables the console warning that is logged when Clerk is initialized with development keys.
* Disables the `Clerk has been loaded with development keys` console warning that is logged when Clerk is
* initialized with development keys. The warning is emitted by `clerk-js` to the browser console; in dev servers
* that mirror browser logs to the terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`), setting
* this option also stops it from showing up there.
*
* Each framework integration also exposes an env-var shortcut so you don't need to thread the option through
* `<ClerkProvider>` manually:
* - Next.js: `NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - TanStack Start / React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
*
* [WARNING] The development mode warning is intended to ensure that you don't go to production with a non-production
* Clerk instance. If you're disabling it, please make sure you don't ship with a non-production Clerk instance!
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import type { RequestState } from '@clerk/backend/internal';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeWithPublicEnvs, pickFromClerkInitState } from '../client/utils';
import { getResponseClerkState } from '../server/utils';

const createRequestState = (): RequestState =>
({
domain: undefined,
isSatellite: false,
publishableKey: 'pk_test_xxx',
proxyUrl: undefined,
signInUrl: undefined,
signUpUrl: undefined,
toAuth: () => ({}),
}) as RequestState;

describe('unsafe_disableDevelopmentModeConsoleWarning', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit false from the initial state when public env is true', () => {
vi.stubEnv('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeWithPublicEnvs({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});

it('hydrates the unprefixed env value from server state', () => {
vi.stubEnv('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const clerkInitialState = getResponseClerkState(createRequestState());
const pickedState = pickFromClerkInitState(clerkInitialState.__internal_clerk_state);
const result = mergeWithPublicEnvs(pickedState);

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(true);
});
});
1 change: 1 addition & 0 deletions packages/tanstack-react-start/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
};
};

Expand Down
4 changes: 4 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const pickFromClerkInitState = (
__clerkUIVersion,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__signInForceRedirectUrl,
__signUpForceRedirectUrl,
__signInFallbackRedirectUrl,
Expand All@@ -53,6 +54,7 @@ export const pickFromClerkInitState = (
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
signInForceRedirectUrl: __signInForceRedirectUrl,
signUpForceRedirectUrl: __signUpForceRedirectUrl,
signInFallbackRedirectUrl: __signInFallbackRedirectUrl,
Expand All@@ -77,6 +79,8 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
__internal_clerkUIVersion: restInitState.__internal_clerkUIVersion || envVars.clerkUIVersion,
signInForceRedirectUrl: restInitState.signInForceRedirectUrl,
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
unsafe_disableDevelopmentModeConsoleWarning:
restInitState.unsafe_disableDevelopmentModeConsoleWarning ?? envVars.unsafeDisableDevelopmentModeConsoleWarning,
};
};

Expand Down
9 changes: 9 additions & 0 deletions packages/tanstack-react-start/src/server/utils/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@ function getPrefetchUIFromEnv(): boolean | undefined {
return undefined;
}

function getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(): boolean | undefined {
const value =
getEnvVariable('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING') ||
getEnvVariable('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING');

return value ? isTruthy(value) : undefined;
}

export function getResponseClerkState(requestState: RequestState, additionalStateOptions: AdditionalStateOptions = {}) {
const { reason, message, isSignedIn, ...rest } = requestState;

Expand All@@ -48,6 +56,7 @@ export function getResponseClerkState(requestState: RequestState, additionalStat
__prefetchUI: getPrefetchUIFromEnv(),
__telemetryDisabled: isTruthy(getEnvVariable('CLERK_TELEMETRY_DISABLED')),
__telemetryDebug: isTruthy(getEnvVariable('CLERK_TELEMETRY_DEBUG')),
__unsafeDisableDevelopmentModeConsoleWarning: getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(),
__signInForceRedirectUrl:
additionalStateOptions.signInForceRedirectUrl || getEnvVariable('CLERK_SIGN_IN_FORCE_REDIRECT_URL') || '',
__signUpForceRedirectUrl:
Expand Down
3 changes: 3 additions & 0 deletions packages/tanstack-react-start/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,9 @@ export const getPublicEnvVariables = () => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
afterSignInUrl: getValue('CLERK_AFTER_SIGN_IN_URL'),
afterSignUpUrl: getValue('CLERK_AFTER_SIGN_UP_URL'),
newSubscriptionRedirectUrl: getValue('CLERK_CHECKOUT_CONTINUE_URL'),
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" + '
feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning by jacekradko · Pull Request #8402 · 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
16 changes: 16 additions & 0 deletions .changeset/quiet-dev-keys-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
'@clerk/shared': patch
---

Add an env-var shortcut for `unsafe_disableDevelopmentModeConsoleWarning` across the Astro, Nuxt, React Router, and TanStack Start integrations so the development-keys console warning can be suppressed without threading the option through `<ClerkProvider>` manually:

- Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)
- TanStack Start: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)

The Next.js equivalent (`NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`) already existed; the JSDoc on `unsafe_disableDevelopmentModeConsoleWarning` now lists every framework's env-var shortcut and clarifies that suppressing the warning at source also keeps it from being mirrored to the dev-server terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeEnvVarsWithParams } from '../merge-env-vars-with-params';

describe('mergeEnvVarsWithParams', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit unsafe_disableDevelopmentModeConsoleWarning false when env is true', () => {
vi.stubEnv('PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeEnvVarsWithParams({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});
});
4 changes: 4 additions & 0 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const mergeEnvVarsWithParams = (
__internal_clerkUIUrl: paramClerkUIUrl,
__internal_clerkUIVersion: paramClerkUIVersion,
prefetchUI: paramPrefetchUI,
unsafe_disableDevelopmentModeConsoleWarning: paramUnsafeDisableDevelopmentModeConsoleWarning,
...rest
} = params || {};

Expand All@@ -65,6 +66,9 @@ const mergeEnvVarsWithParams = (
disabled: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DISABLED),
debug: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DEBUG),
},
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
Comment thread
jacekradko marked this conversation as resolved.
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,8 @@ export default defineNuxtModule<ModuleOptions>({
// prefetchUI config: can be false or undefined
prefetchUI: options.prefetchUI,
isSatellite: options.isSatellite,
// Listed explicitly so it can be overridden via NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING.
unsafe_disableDevelopmentModeConsoleWarning: options.unsafe_disableDevelopmentModeConsoleWarning,
// Backend specific variables that are safe to share.
// We want them to be overridable like the other public keys (e.g NUXT_PUBLIC_CLERK_PROXY_URL)
proxyUrl: options.proxyUrl,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
__prefetchUI,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__keylessClaimUrl,
__keylessApiKeysUrl,
} = clerkState?.__internal_clerk_state || {};
Expand DownExpand Up@@ -101,6 +102,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
};

const keylessProps = __keylessClaimUrl
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
__keylessClaimUrl?: string;
__keylessApiKeysUrl?: string;
};
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/server/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ export function getResponseClerkState(requestState: RequestStateWithRedirectUrls
__prefetchUI: envVars.prefetchUI,
__telemetryDisabled: envVars.telemetryDisabled,
__telemetryDebug: envVars.telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning: envVars.unsafeDisableDevelopmentModeConsoleWarning,
};

if (canUseKeyless && __keylessClaimUrl) {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-router/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ export const getPublicEnvVariables = (context: AppLoadContext | undefined) => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
signInForceRedirectUrl: getValue('CLERK_SIGN_IN_FORCE_REDIRECT_URL'),
signUpForceRedirectUrl: getValue('CLERK_SIGN_UP_FORCE_REDIRECT_URL'),
signInFallbackRedirectUrl: getValue('CLERK_SIGN_IN_FALLBACK_REDIRECT_URL'),
Expand Down
12 changes: 11 additions & 1 deletion packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1123,7 +1123,17 @@ type ClerkOptionsNavigation =

type ClerkUnsafeOptions = {
/**
* Disables the console warning that is logged when Clerk is initialized with development keys.
* Disables the `Clerk has been loaded with development keys` console warning that is logged when Clerk is
* initialized with development keys. The warning is emitted by `clerk-js` to the browser console; in dev servers
* that mirror browser logs to the terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`), setting
* this option also stops it from showing up there.
*
* Each framework integration also exposes an env-var shortcut so you don't need to thread the option through
* `<ClerkProvider>` manually:
* - Next.js: `NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - TanStack Start / React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
*
* [WARNING] The development mode warning is intended to ensure that you don't go to production with a non-production
* Clerk instance. If you're disabling it, please make sure you don't ship with a non-production Clerk instance!
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import type { RequestState } from '@clerk/backend/internal';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeWithPublicEnvs, pickFromClerkInitState } from '../client/utils';
import { getResponseClerkState } from '../server/utils';

const createRequestState = (): RequestState =>
({
domain: undefined,
isSatellite: false,
publishableKey: 'pk_test_xxx',
proxyUrl: undefined,
signInUrl: undefined,
signUpUrl: undefined,
toAuth: () => ({}),
}) as RequestState;

describe('unsafe_disableDevelopmentModeConsoleWarning', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit false from the initial state when public env is true', () => {
vi.stubEnv('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeWithPublicEnvs({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});

it('hydrates the unprefixed env value from server state', () => {
vi.stubEnv('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const clerkInitialState = getResponseClerkState(createRequestState());
const pickedState = pickFromClerkInitState(clerkInitialState.__internal_clerk_state);
const result = mergeWithPublicEnvs(pickedState);

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(true);
});
});
1 change: 1 addition & 0 deletions packages/tanstack-react-start/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
};
};

Expand Down
4 changes: 4 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const pickFromClerkInitState = (
__clerkUIVersion,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__signInForceRedirectUrl,
__signUpForceRedirectUrl,
__signInFallbackRedirectUrl,
Expand All@@ -53,6 +54,7 @@ export const pickFromClerkInitState = (
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
signInForceRedirectUrl: __signInForceRedirectUrl,
signUpForceRedirectUrl: __signUpForceRedirectUrl,
signInFallbackRedirectUrl: __signInFallbackRedirectUrl,
Expand All@@ -77,6 +79,8 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
__internal_clerkUIVersion: restInitState.__internal_clerkUIVersion || envVars.clerkUIVersion,
signInForceRedirectUrl: restInitState.signInForceRedirectUrl,
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
unsafe_disableDevelopmentModeConsoleWarning:
restInitState.unsafe_disableDevelopmentModeConsoleWarning ?? envVars.unsafeDisableDevelopmentModeConsoleWarning,
};
};

Expand Down
9 changes: 9 additions & 0 deletions packages/tanstack-react-start/src/server/utils/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@ function getPrefetchUIFromEnv(): boolean | undefined {
return undefined;
}

function getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(): boolean | undefined {
const value =
getEnvVariable('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING') ||
getEnvVariable('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING');

return value ? isTruthy(value) : undefined;
}

export function getResponseClerkState(requestState: RequestState, additionalStateOptions: AdditionalStateOptions = {}) {
const { reason, message, isSignedIn, ...rest } = requestState;

Expand All@@ -48,6 +56,7 @@ export function getResponseClerkState(requestState: RequestState, additionalStat
__prefetchUI: getPrefetchUIFromEnv(),
__telemetryDisabled: isTruthy(getEnvVariable('CLERK_TELEMETRY_DISABLED')),
__telemetryDebug: isTruthy(getEnvVariable('CLERK_TELEMETRY_DEBUG')),
__unsafeDisableDevelopmentModeConsoleWarning: getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(),
__signInForceRedirectUrl:
additionalStateOptions.signInForceRedirectUrl || getEnvVariable('CLERK_SIGN_IN_FORCE_REDIRECT_URL') || '',
__signUpForceRedirectUrl:
Expand Down
3 changes: 3 additions & 0 deletions packages/tanstack-react-start/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,9 @@ export const getPublicEnvVariables = () => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
afterSignInUrl: getValue('CLERK_AFTER_SIGN_IN_URL'),
afterSignUpUrl: getValue('CLERK_AFTER_SIGN_UP_URL'),
newSubscriptionRedirectUrl: getValue('CLERK_CHECKOUT_CONTINUE_URL'),
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('^' + ".*" + ' feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning by jacekradko · Pull Request #8402 · 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
16 changes: 16 additions & 0 deletions .changeset/quiet-dev-keys-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
'@clerk/shared': patch
---

Add an env-var shortcut for `unsafe_disableDevelopmentModeConsoleWarning` across the Astro, Nuxt, React Router, and TanStack Start integrations so the development-keys console warning can be suppressed without threading the option through `<ClerkProvider>` manually:

- Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)
- TanStack Start: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)

The Next.js equivalent (`NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`) already existed; the JSDoc on `unsafe_disableDevelopmentModeConsoleWarning` now lists every framework's env-var shortcut and clarifies that suppressing the warning at source also keeps it from being mirrored to the dev-server terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeEnvVarsWithParams } from '../merge-env-vars-with-params';

describe('mergeEnvVarsWithParams', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit unsafe_disableDevelopmentModeConsoleWarning false when env is true', () => {
vi.stubEnv('PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeEnvVarsWithParams({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});
});
4 changes: 4 additions & 0 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const mergeEnvVarsWithParams = (
__internal_clerkUIUrl: paramClerkUIUrl,
__internal_clerkUIVersion: paramClerkUIVersion,
prefetchUI: paramPrefetchUI,
unsafe_disableDevelopmentModeConsoleWarning: paramUnsafeDisableDevelopmentModeConsoleWarning,
...rest
} = params || {};

Expand All@@ -65,6 +66,9 @@ const mergeEnvVarsWithParams = (
disabled: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DISABLED),
debug: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DEBUG),
},
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
Comment thread
jacekradko marked this conversation as resolved.
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,8 @@ export default defineNuxtModule<ModuleOptions>({
// prefetchUI config: can be false or undefined
prefetchUI: options.prefetchUI,
isSatellite: options.isSatellite,
// Listed explicitly so it can be overridden via NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING.
unsafe_disableDevelopmentModeConsoleWarning: options.unsafe_disableDevelopmentModeConsoleWarning,
// Backend specific variables that are safe to share.
// We want them to be overridable like the other public keys (e.g NUXT_PUBLIC_CLERK_PROXY_URL)
proxyUrl: options.proxyUrl,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
__prefetchUI,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__keylessClaimUrl,
__keylessApiKeysUrl,
} = clerkState?.__internal_clerk_state || {};
Expand DownExpand Up@@ -101,6 +102,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
};

const keylessProps = __keylessClaimUrl
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
__keylessClaimUrl?: string;
__keylessApiKeysUrl?: string;
};
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/server/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ export function getResponseClerkState(requestState: RequestStateWithRedirectUrls
__prefetchUI: envVars.prefetchUI,
__telemetryDisabled: envVars.telemetryDisabled,
__telemetryDebug: envVars.telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning: envVars.unsafeDisableDevelopmentModeConsoleWarning,
};

if (canUseKeyless && __keylessClaimUrl) {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-router/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ export const getPublicEnvVariables = (context: AppLoadContext | undefined) => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
signInForceRedirectUrl: getValue('CLERK_SIGN_IN_FORCE_REDIRECT_URL'),
signUpForceRedirectUrl: getValue('CLERK_SIGN_UP_FORCE_REDIRECT_URL'),
signInFallbackRedirectUrl: getValue('CLERK_SIGN_IN_FALLBACK_REDIRECT_URL'),
Expand Down
12 changes: 11 additions & 1 deletion packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1123,7 +1123,17 @@ type ClerkOptionsNavigation =

type ClerkUnsafeOptions = {
/**
* Disables the console warning that is logged when Clerk is initialized with development keys.
* Disables the `Clerk has been loaded with development keys` console warning that is logged when Clerk is
* initialized with development keys. The warning is emitted by `clerk-js` to the browser console; in dev servers
* that mirror browser logs to the terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`), setting
* this option also stops it from showing up there.
*
* Each framework integration also exposes an env-var shortcut so you don't need to thread the option through
* `<ClerkProvider>` manually:
* - Next.js: `NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - TanStack Start / React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
*
* [WARNING] The development mode warning is intended to ensure that you don't go to production with a non-production
* Clerk instance. If you're disabling it, please make sure you don't ship with a non-production Clerk instance!
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import type { RequestState } from '@clerk/backend/internal';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeWithPublicEnvs, pickFromClerkInitState } from '../client/utils';
import { getResponseClerkState } from '../server/utils';

const createRequestState = (): RequestState =>
({
domain: undefined,
isSatellite: false,
publishableKey: 'pk_test_xxx',
proxyUrl: undefined,
signInUrl: undefined,
signUpUrl: undefined,
toAuth: () => ({}),
}) as RequestState;

describe('unsafe_disableDevelopmentModeConsoleWarning', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit false from the initial state when public env is true', () => {
vi.stubEnv('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeWithPublicEnvs({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});

it('hydrates the unprefixed env value from server state', () => {
vi.stubEnv('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const clerkInitialState = getResponseClerkState(createRequestState());
const pickedState = pickFromClerkInitState(clerkInitialState.__internal_clerk_state);
const result = mergeWithPublicEnvs(pickedState);

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(true);
});
});
1 change: 1 addition & 0 deletions packages/tanstack-react-start/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
};
};

Expand Down
4 changes: 4 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const pickFromClerkInitState = (
__clerkUIVersion,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__signInForceRedirectUrl,
__signUpForceRedirectUrl,
__signInFallbackRedirectUrl,
Expand All@@ -53,6 +54,7 @@ export const pickFromClerkInitState = (
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
signInForceRedirectUrl: __signInForceRedirectUrl,
signUpForceRedirectUrl: __signUpForceRedirectUrl,
signInFallbackRedirectUrl: __signInFallbackRedirectUrl,
Expand All@@ -77,6 +79,8 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
__internal_clerkUIVersion: restInitState.__internal_clerkUIVersion || envVars.clerkUIVersion,
signInForceRedirectUrl: restInitState.signInForceRedirectUrl,
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
unsafe_disableDevelopmentModeConsoleWarning:
restInitState.unsafe_disableDevelopmentModeConsoleWarning ?? envVars.unsafeDisableDevelopmentModeConsoleWarning,
};
};

Expand Down
9 changes: 9 additions & 0 deletions packages/tanstack-react-start/src/server/utils/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@ function getPrefetchUIFromEnv(): boolean | undefined {
return undefined;
}

function getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(): boolean | undefined {
const value =
getEnvVariable('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING') ||
getEnvVariable('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING');

return value ? isTruthy(value) : undefined;
}

export function getResponseClerkState(requestState: RequestState, additionalStateOptions: AdditionalStateOptions = {}) {
const { reason, message, isSignedIn, ...rest } = requestState;

Expand All@@ -48,6 +56,7 @@ export function getResponseClerkState(requestState: RequestState, additionalStat
__prefetchUI: getPrefetchUIFromEnv(),
__telemetryDisabled: isTruthy(getEnvVariable('CLERK_TELEMETRY_DISABLED')),
__telemetryDebug: isTruthy(getEnvVariable('CLERK_TELEMETRY_DEBUG')),
__unsafeDisableDevelopmentModeConsoleWarning: getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(),
__signInForceRedirectUrl:
additionalStateOptions.signInForceRedirectUrl || getEnvVariable('CLERK_SIGN_IN_FORCE_REDIRECT_URL') || '',
__signUpForceRedirectUrl:
Expand Down
3 changes: 3 additions & 0 deletions packages/tanstack-react-start/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,9 @@ export const getPublicEnvVariables = () => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
afterSignInUrl: getValue('CLERK_AFTER_SIGN_IN_URL'),
afterSignUpUrl: getValue('CLERK_AFTER_SIGN_UP_URL'),
newSubscriptionRedirectUrl: getValue('CLERK_CHECKOUT_CONTINUE_URL'),
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('^' + ".*" + ' feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning by jacekradko · Pull Request #8402 · 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
16 changes: 16 additions & 0 deletions .changeset/quiet-dev-keys-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
'@clerk/shared': patch
---

Add an env-var shortcut for `unsafe_disableDevelopmentModeConsoleWarning` across the Astro, Nuxt, React Router, and TanStack Start integrations so the development-keys console warning can be suppressed without threading the option through `<ClerkProvider>` manually:

- Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)
- TanStack Start: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)

The Next.js equivalent (`NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`) already existed; the JSDoc on `unsafe_disableDevelopmentModeConsoleWarning` now lists every framework's env-var shortcut and clarifies that suppressing the warning at source also keeps it from being mirrored to the dev-server terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeEnvVarsWithParams } from '../merge-env-vars-with-params';

describe('mergeEnvVarsWithParams', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit unsafe_disableDevelopmentModeConsoleWarning false when env is true', () => {
vi.stubEnv('PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeEnvVarsWithParams({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});
});
4 changes: 4 additions & 0 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const mergeEnvVarsWithParams = (
__internal_clerkUIUrl: paramClerkUIUrl,
__internal_clerkUIVersion: paramClerkUIVersion,
prefetchUI: paramPrefetchUI,
unsafe_disableDevelopmentModeConsoleWarning: paramUnsafeDisableDevelopmentModeConsoleWarning,
...rest
} = params || {};

Expand All@@ -65,6 +66,9 @@ const mergeEnvVarsWithParams = (
disabled: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DISABLED),
debug: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DEBUG),
},
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
Comment thread
jacekradko marked this conversation as resolved.
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,8 @@ export default defineNuxtModule<ModuleOptions>({
// prefetchUI config: can be false or undefined
prefetchUI: options.prefetchUI,
isSatellite: options.isSatellite,
// Listed explicitly so it can be overridden via NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING.
unsafe_disableDevelopmentModeConsoleWarning: options.unsafe_disableDevelopmentModeConsoleWarning,
// Backend specific variables that are safe to share.
// We want them to be overridable like the other public keys (e.g NUXT_PUBLIC_CLERK_PROXY_URL)
proxyUrl: options.proxyUrl,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
__prefetchUI,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__keylessClaimUrl,
__keylessApiKeysUrl,
} = clerkState?.__internal_clerk_state || {};
Expand DownExpand Up@@ -101,6 +102,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
};

const keylessProps = __keylessClaimUrl
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
__keylessClaimUrl?: string;
__keylessApiKeysUrl?: string;
};
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/server/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ export function getResponseClerkState(requestState: RequestStateWithRedirectUrls
__prefetchUI: envVars.prefetchUI,
__telemetryDisabled: envVars.telemetryDisabled,
__telemetryDebug: envVars.telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning: envVars.unsafeDisableDevelopmentModeConsoleWarning,
};

if (canUseKeyless && __keylessClaimUrl) {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-router/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ export const getPublicEnvVariables = (context: AppLoadContext | undefined) => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
signInForceRedirectUrl: getValue('CLERK_SIGN_IN_FORCE_REDIRECT_URL'),
signUpForceRedirectUrl: getValue('CLERK_SIGN_UP_FORCE_REDIRECT_URL'),
signInFallbackRedirectUrl: getValue('CLERK_SIGN_IN_FALLBACK_REDIRECT_URL'),
Expand Down
12 changes: 11 additions & 1 deletion packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1123,7 +1123,17 @@ type ClerkOptionsNavigation =

type ClerkUnsafeOptions = {
/**
* Disables the console warning that is logged when Clerk is initialized with development keys.
* Disables the `Clerk has been loaded with development keys` console warning that is logged when Clerk is
* initialized with development keys. The warning is emitted by `clerk-js` to the browser console; in dev servers
* that mirror browser logs to the terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`), setting
* this option also stops it from showing up there.
*
* Each framework integration also exposes an env-var shortcut so you don't need to thread the option through
* `<ClerkProvider>` manually:
* - Next.js: `NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - TanStack Start / React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
*
* [WARNING] The development mode warning is intended to ensure that you don't go to production with a non-production
* Clerk instance. If you're disabling it, please make sure you don't ship with a non-production Clerk instance!
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import type { RequestState } from '@clerk/backend/internal';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeWithPublicEnvs, pickFromClerkInitState } from '../client/utils';
import { getResponseClerkState } from '../server/utils';

const createRequestState = (): RequestState =>
({
domain: undefined,
isSatellite: false,
publishableKey: 'pk_test_xxx',
proxyUrl: undefined,
signInUrl: undefined,
signUpUrl: undefined,
toAuth: () => ({}),
}) as RequestState;

describe('unsafe_disableDevelopmentModeConsoleWarning', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit false from the initial state when public env is true', () => {
vi.stubEnv('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeWithPublicEnvs({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});

it('hydrates the unprefixed env value from server state', () => {
vi.stubEnv('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const clerkInitialState = getResponseClerkState(createRequestState());
const pickedState = pickFromClerkInitState(clerkInitialState.__internal_clerk_state);
const result = mergeWithPublicEnvs(pickedState);

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(true);
});
});
1 change: 1 addition & 0 deletions packages/tanstack-react-start/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
};
};

Expand Down
4 changes: 4 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const pickFromClerkInitState = (
__clerkUIVersion,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__signInForceRedirectUrl,
__signUpForceRedirectUrl,
__signInFallbackRedirectUrl,
Expand All@@ -53,6 +54,7 @@ export const pickFromClerkInitState = (
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
signInForceRedirectUrl: __signInForceRedirectUrl,
signUpForceRedirectUrl: __signUpForceRedirectUrl,
signInFallbackRedirectUrl: __signInFallbackRedirectUrl,
Expand All@@ -77,6 +79,8 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
__internal_clerkUIVersion: restInitState.__internal_clerkUIVersion || envVars.clerkUIVersion,
signInForceRedirectUrl: restInitState.signInForceRedirectUrl,
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
unsafe_disableDevelopmentModeConsoleWarning:
restInitState.unsafe_disableDevelopmentModeConsoleWarning ?? envVars.unsafeDisableDevelopmentModeConsoleWarning,
};
};

Expand Down
9 changes: 9 additions & 0 deletions packages/tanstack-react-start/src/server/utils/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@ function getPrefetchUIFromEnv(): boolean | undefined {
return undefined;
}

function getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(): boolean | undefined {
const value =
getEnvVariable('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING') ||
getEnvVariable('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING');

return value ? isTruthy(value) : undefined;
}

export function getResponseClerkState(requestState: RequestState, additionalStateOptions: AdditionalStateOptions = {}) {
const { reason, message, isSignedIn, ...rest } = requestState;

Expand All@@ -48,6 +56,7 @@ export function getResponseClerkState(requestState: RequestState, additionalStat
__prefetchUI: getPrefetchUIFromEnv(),
__telemetryDisabled: isTruthy(getEnvVariable('CLERK_TELEMETRY_DISABLED')),
__telemetryDebug: isTruthy(getEnvVariable('CLERK_TELEMETRY_DEBUG')),
__unsafeDisableDevelopmentModeConsoleWarning: getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(),
__signInForceRedirectUrl:
additionalStateOptions.signInForceRedirectUrl || getEnvVariable('CLERK_SIGN_IN_FORCE_REDIRECT_URL') || '',
__signUpForceRedirectUrl:
Expand Down
3 changes: 3 additions & 0 deletions packages/tanstack-react-start/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,9 @@ export const getPublicEnvVariables = () => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
afterSignInUrl: getValue('CLERK_AFTER_SIGN_IN_URL'),
afterSignUpUrl: getValue('CLERK_AFTER_SIGN_UP_URL'),
newSubscriptionRedirectUrl: getValue('CLERK_CHECKOUT_CONTINUE_URL'),
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" + ' feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning by jacekradko · Pull Request #8402 · 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
16 changes: 16 additions & 0 deletions .changeset/quiet-dev-keys-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
'@clerk/shared': patch
---

Add an env-var shortcut for `unsafe_disableDevelopmentModeConsoleWarning` across the Astro, Nuxt, React Router, and TanStack Start integrations so the development-keys console warning can be suppressed without threading the option through `<ClerkProvider>` manually:

- Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)
- TanStack Start: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)

The Next.js equivalent (`NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`) already existed; the JSDoc on `unsafe_disableDevelopmentModeConsoleWarning` now lists every framework's env-var shortcut and clarifies that suppressing the warning at source also keeps it from being mirrored to the dev-server terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeEnvVarsWithParams } from '../merge-env-vars-with-params';

describe('mergeEnvVarsWithParams', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit unsafe_disableDevelopmentModeConsoleWarning false when env is true', () => {
vi.stubEnv('PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeEnvVarsWithParams({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});
});
4 changes: 4 additions & 0 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const mergeEnvVarsWithParams = (
__internal_clerkUIUrl: paramClerkUIUrl,
__internal_clerkUIVersion: paramClerkUIVersion,
prefetchUI: paramPrefetchUI,
unsafe_disableDevelopmentModeConsoleWarning: paramUnsafeDisableDevelopmentModeConsoleWarning,
...rest
} = params || {};

Expand All@@ -65,6 +66,9 @@ const mergeEnvVarsWithParams = (
disabled: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DISABLED),
debug: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DEBUG),
},
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
Comment thread
jacekradko marked this conversation as resolved.
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,8 @@ export default defineNuxtModule<ModuleOptions>({
// prefetchUI config: can be false or undefined
prefetchUI: options.prefetchUI,
isSatellite: options.isSatellite,
// Listed explicitly so it can be overridden via NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING.
unsafe_disableDevelopmentModeConsoleWarning: options.unsafe_disableDevelopmentModeConsoleWarning,
// Backend specific variables that are safe to share.
// We want them to be overridable like the other public keys (e.g NUXT_PUBLIC_CLERK_PROXY_URL)
proxyUrl: options.proxyUrl,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
__prefetchUI,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__keylessClaimUrl,
__keylessApiKeysUrl,
} = clerkState?.__internal_clerk_state || {};
Expand DownExpand Up@@ -101,6 +102,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
};

const keylessProps = __keylessClaimUrl
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
__keylessClaimUrl?: string;
__keylessApiKeysUrl?: string;
};
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/server/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ export function getResponseClerkState(requestState: RequestStateWithRedirectUrls
__prefetchUI: envVars.prefetchUI,
__telemetryDisabled: envVars.telemetryDisabled,
__telemetryDebug: envVars.telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning: envVars.unsafeDisableDevelopmentModeConsoleWarning,
};

if (canUseKeyless && __keylessClaimUrl) {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-router/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ export const getPublicEnvVariables = (context: AppLoadContext | undefined) => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
signInForceRedirectUrl: getValue('CLERK_SIGN_IN_FORCE_REDIRECT_URL'),
signUpForceRedirectUrl: getValue('CLERK_SIGN_UP_FORCE_REDIRECT_URL'),
signInFallbackRedirectUrl: getValue('CLERK_SIGN_IN_FALLBACK_REDIRECT_URL'),
Expand Down
12 changes: 11 additions & 1 deletion packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1123,7 +1123,17 @@ type ClerkOptionsNavigation =

type ClerkUnsafeOptions = {
/**
* Disables the console warning that is logged when Clerk is initialized with development keys.
* Disables the `Clerk has been loaded with development keys` console warning that is logged when Clerk is
* initialized with development keys. The warning is emitted by `clerk-js` to the browser console; in dev servers
* that mirror browser logs to the terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`), setting
* this option also stops it from showing up there.
*
* Each framework integration also exposes an env-var shortcut so you don't need to thread the option through
* `<ClerkProvider>` manually:
* - Next.js: `NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - TanStack Start / React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
*
* [WARNING] The development mode warning is intended to ensure that you don't go to production with a non-production
* Clerk instance. If you're disabling it, please make sure you don't ship with a non-production Clerk instance!
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import type { RequestState } from '@clerk/backend/internal';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeWithPublicEnvs, pickFromClerkInitState } from '../client/utils';
import { getResponseClerkState } from '../server/utils';

const createRequestState = (): RequestState =>
({
domain: undefined,
isSatellite: false,
publishableKey: 'pk_test_xxx',
proxyUrl: undefined,
signInUrl: undefined,
signUpUrl: undefined,
toAuth: () => ({}),
}) as RequestState;

describe('unsafe_disableDevelopmentModeConsoleWarning', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit false from the initial state when public env is true', () => {
vi.stubEnv('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeWithPublicEnvs({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});

it('hydrates the unprefixed env value from server state', () => {
vi.stubEnv('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const clerkInitialState = getResponseClerkState(createRequestState());
const pickedState = pickFromClerkInitState(clerkInitialState.__internal_clerk_state);
const result = mergeWithPublicEnvs(pickedState);

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(true);
});
});
1 change: 1 addition & 0 deletions packages/tanstack-react-start/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
};
};

Expand Down
4 changes: 4 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const pickFromClerkInitState = (
__clerkUIVersion,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__signInForceRedirectUrl,
__signUpForceRedirectUrl,
__signInFallbackRedirectUrl,
Expand All@@ -53,6 +54,7 @@ export const pickFromClerkInitState = (
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
signInForceRedirectUrl: __signInForceRedirectUrl,
signUpForceRedirectUrl: __signUpForceRedirectUrl,
signInFallbackRedirectUrl: __signInFallbackRedirectUrl,
Expand All@@ -77,6 +79,8 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
__internal_clerkUIVersion: restInitState.__internal_clerkUIVersion || envVars.clerkUIVersion,
signInForceRedirectUrl: restInitState.signInForceRedirectUrl,
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
unsafe_disableDevelopmentModeConsoleWarning:
restInitState.unsafe_disableDevelopmentModeConsoleWarning ?? envVars.unsafeDisableDevelopmentModeConsoleWarning,
};
};

Expand Down
9 changes: 9 additions & 0 deletions packages/tanstack-react-start/src/server/utils/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@ function getPrefetchUIFromEnv(): boolean | undefined {
return undefined;
}

function getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(): boolean | undefined {
const value =
getEnvVariable('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING') ||
getEnvVariable('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING');

return value ? isTruthy(value) : undefined;
}

export function getResponseClerkState(requestState: RequestState, additionalStateOptions: AdditionalStateOptions = {}) {
const { reason, message, isSignedIn, ...rest } = requestState;

Expand All@@ -48,6 +56,7 @@ export function getResponseClerkState(requestState: RequestState, additionalStat
__prefetchUI: getPrefetchUIFromEnv(),
__telemetryDisabled: isTruthy(getEnvVariable('CLERK_TELEMETRY_DISABLED')),
__telemetryDebug: isTruthy(getEnvVariable('CLERK_TELEMETRY_DEBUG')),
__unsafeDisableDevelopmentModeConsoleWarning: getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(),
__signInForceRedirectUrl:
additionalStateOptions.signInForceRedirectUrl || getEnvVariable('CLERK_SIGN_IN_FORCE_REDIRECT_URL') || '',
__signUpForceRedirectUrl:
Expand Down
3 changes: 3 additions & 0 deletions packages/tanstack-react-start/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,9 @@ export const getPublicEnvVariables = () => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
afterSignInUrl: getValue('CLERK_AFTER_SIGN_IN_URL'),
afterSignUpUrl: getValue('CLERK_AFTER_SIGN_UP_URL'),
newSubscriptionRedirectUrl: getValue('CLERK_CHECKOUT_CONTINUE_URL'),
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('^' + ".*" + ' feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning by jacekradko · Pull Request #8402 · 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
16 changes: 16 additions & 0 deletions .changeset/quiet-dev-keys-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
'@clerk/shared': patch
---

Add an env-var shortcut for `unsafe_disableDevelopmentModeConsoleWarning` across the Astro, Nuxt, React Router, and TanStack Start integrations so the development-keys console warning can be suppressed without threading the option through `<ClerkProvider>` manually:

- Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)
- TanStack Start: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)

The Next.js equivalent (`NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`) already existed; the JSDoc on `unsafe_disableDevelopmentModeConsoleWarning` now lists every framework's env-var shortcut and clarifies that suppressing the warning at source also keeps it from being mirrored to the dev-server terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeEnvVarsWithParams } from '../merge-env-vars-with-params';

describe('mergeEnvVarsWithParams', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit unsafe_disableDevelopmentModeConsoleWarning false when env is true', () => {
vi.stubEnv('PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeEnvVarsWithParams({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});
});
4 changes: 4 additions & 0 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const mergeEnvVarsWithParams = (
__internal_clerkUIUrl: paramClerkUIUrl,
__internal_clerkUIVersion: paramClerkUIVersion,
prefetchUI: paramPrefetchUI,
unsafe_disableDevelopmentModeConsoleWarning: paramUnsafeDisableDevelopmentModeConsoleWarning,
...rest
} = params || {};

Expand All@@ -65,6 +66,9 @@ const mergeEnvVarsWithParams = (
disabled: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DISABLED),
debug: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DEBUG),
},
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
Comment thread
jacekradko marked this conversation as resolved.
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,8 @@ export default defineNuxtModule<ModuleOptions>({
// prefetchUI config: can be false or undefined
prefetchUI: options.prefetchUI,
isSatellite: options.isSatellite,
// Listed explicitly so it can be overridden via NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING.
unsafe_disableDevelopmentModeConsoleWarning: options.unsafe_disableDevelopmentModeConsoleWarning,
// Backend specific variables that are safe to share.
// We want them to be overridable like the other public keys (e.g NUXT_PUBLIC_CLERK_PROXY_URL)
proxyUrl: options.proxyUrl,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
__prefetchUI,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__keylessClaimUrl,
__keylessApiKeysUrl,
} = clerkState?.__internal_clerk_state || {};
Expand DownExpand Up@@ -101,6 +102,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
};

const keylessProps = __keylessClaimUrl
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
__keylessClaimUrl?: string;
__keylessApiKeysUrl?: string;
};
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/server/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ export function getResponseClerkState(requestState: RequestStateWithRedirectUrls
__prefetchUI: envVars.prefetchUI,
__telemetryDisabled: envVars.telemetryDisabled,
__telemetryDebug: envVars.telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning: envVars.unsafeDisableDevelopmentModeConsoleWarning,
};

if (canUseKeyless && __keylessClaimUrl) {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-router/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ export const getPublicEnvVariables = (context: AppLoadContext | undefined) => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
signInForceRedirectUrl: getValue('CLERK_SIGN_IN_FORCE_REDIRECT_URL'),
signUpForceRedirectUrl: getValue('CLERK_SIGN_UP_FORCE_REDIRECT_URL'),
signInFallbackRedirectUrl: getValue('CLERK_SIGN_IN_FALLBACK_REDIRECT_URL'),
Expand Down
12 changes: 11 additions & 1 deletion packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1123,7 +1123,17 @@ type ClerkOptionsNavigation =

type ClerkUnsafeOptions = {
/**
* Disables the console warning that is logged when Clerk is initialized with development keys.
* Disables the `Clerk has been loaded with development keys` console warning that is logged when Clerk is
* initialized with development keys. The warning is emitted by `clerk-js` to the browser console; in dev servers
* that mirror browser logs to the terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`), setting
* this option also stops it from showing up there.
*
* Each framework integration also exposes an env-var shortcut so you don't need to thread the option through
* `<ClerkProvider>` manually:
* - Next.js: `NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - TanStack Start / React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
*
* [WARNING] The development mode warning is intended to ensure that you don't go to production with a non-production
* Clerk instance. If you're disabling it, please make sure you don't ship with a non-production Clerk instance!
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import type { RequestState } from '@clerk/backend/internal';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeWithPublicEnvs, pickFromClerkInitState } from '../client/utils';
import { getResponseClerkState } from '../server/utils';

const createRequestState = (): RequestState =>
({
domain: undefined,
isSatellite: false,
publishableKey: 'pk_test_xxx',
proxyUrl: undefined,
signInUrl: undefined,
signUpUrl: undefined,
toAuth: () => ({}),
}) as RequestState;

describe('unsafe_disableDevelopmentModeConsoleWarning', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit false from the initial state when public env is true', () => {
vi.stubEnv('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeWithPublicEnvs({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});

it('hydrates the unprefixed env value from server state', () => {
vi.stubEnv('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const clerkInitialState = getResponseClerkState(createRequestState());
const pickedState = pickFromClerkInitState(clerkInitialState.__internal_clerk_state);
const result = mergeWithPublicEnvs(pickedState);

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(true);
});
});
1 change: 1 addition & 0 deletions packages/tanstack-react-start/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
};
};

Expand Down
4 changes: 4 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const pickFromClerkInitState = (
__clerkUIVersion,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__signInForceRedirectUrl,
__signUpForceRedirectUrl,
__signInFallbackRedirectUrl,
Expand All@@ -53,6 +54,7 @@ export const pickFromClerkInitState = (
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
signInForceRedirectUrl: __signInForceRedirectUrl,
signUpForceRedirectUrl: __signUpForceRedirectUrl,
signInFallbackRedirectUrl: __signInFallbackRedirectUrl,
Expand All@@ -77,6 +79,8 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
__internal_clerkUIVersion: restInitState.__internal_clerkUIVersion || envVars.clerkUIVersion,
signInForceRedirectUrl: restInitState.signInForceRedirectUrl,
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
unsafe_disableDevelopmentModeConsoleWarning:
restInitState.unsafe_disableDevelopmentModeConsoleWarning ?? envVars.unsafeDisableDevelopmentModeConsoleWarning,
};
};

Expand Down
9 changes: 9 additions & 0 deletions packages/tanstack-react-start/src/server/utils/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@ function getPrefetchUIFromEnv(): boolean | undefined {
return undefined;
}

function getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(): boolean | undefined {
const value =
getEnvVariable('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING') ||
getEnvVariable('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING');

return value ? isTruthy(value) : undefined;
}

export function getResponseClerkState(requestState: RequestState, additionalStateOptions: AdditionalStateOptions = {}) {
const { reason, message, isSignedIn, ...rest } = requestState;

Expand All@@ -48,6 +56,7 @@ export function getResponseClerkState(requestState: RequestState, additionalStat
__prefetchUI: getPrefetchUIFromEnv(),
__telemetryDisabled: isTruthy(getEnvVariable('CLERK_TELEMETRY_DISABLED')),
__telemetryDebug: isTruthy(getEnvVariable('CLERK_TELEMETRY_DEBUG')),
__unsafeDisableDevelopmentModeConsoleWarning: getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(),
__signInForceRedirectUrl:
additionalStateOptions.signInForceRedirectUrl || getEnvVariable('CLERK_SIGN_IN_FORCE_REDIRECT_URL') || '',
__signUpForceRedirectUrl:
Expand Down
3 changes: 3 additions & 0 deletions packages/tanstack-react-start/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,9 @@ export const getPublicEnvVariables = () => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
afterSignInUrl: getValue('CLERK_AFTER_SIGN_IN_URL'),
afterSignUpUrl: getValue('CLERK_AFTER_SIGN_UP_URL'),
newSubscriptionRedirectUrl: getValue('CLERK_CHECKOUT_CONTINUE_URL'),
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('^' + ".*" + ' feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning by jacekradko · Pull Request #8402 · 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
16 changes: 16 additions & 0 deletions .changeset/quiet-dev-keys-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
'@clerk/shared': patch
---

Add an env-var shortcut for `unsafe_disableDevelopmentModeConsoleWarning` across the Astro, Nuxt, React Router, and TanStack Start integrations so the development-keys console warning can be suppressed without threading the option through `<ClerkProvider>` manually:

- Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)
- TanStack Start: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)

The Next.js equivalent (`NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`) already existed; the JSDoc on `unsafe_disableDevelopmentModeConsoleWarning` now lists every framework's env-var shortcut and clarifies that suppressing the warning at source also keeps it from being mirrored to the dev-server terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeEnvVarsWithParams } from '../merge-env-vars-with-params';

describe('mergeEnvVarsWithParams', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit unsafe_disableDevelopmentModeConsoleWarning false when env is true', () => {
vi.stubEnv('PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeEnvVarsWithParams({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});
});
4 changes: 4 additions & 0 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const mergeEnvVarsWithParams = (
__internal_clerkUIUrl: paramClerkUIUrl,
__internal_clerkUIVersion: paramClerkUIVersion,
prefetchUI: paramPrefetchUI,
unsafe_disableDevelopmentModeConsoleWarning: paramUnsafeDisableDevelopmentModeConsoleWarning,
...rest
} = params || {};

Expand All@@ -65,6 +66,9 @@ const mergeEnvVarsWithParams = (
disabled: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DISABLED),
debug: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DEBUG),
},
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
Comment thread
jacekradko marked this conversation as resolved.
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,8 @@ export default defineNuxtModule<ModuleOptions>({
// prefetchUI config: can be false or undefined
prefetchUI: options.prefetchUI,
isSatellite: options.isSatellite,
// Listed explicitly so it can be overridden via NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING.
unsafe_disableDevelopmentModeConsoleWarning: options.unsafe_disableDevelopmentModeConsoleWarning,
// Backend specific variables that are safe to share.
// We want them to be overridable like the other public keys (e.g NUXT_PUBLIC_CLERK_PROXY_URL)
proxyUrl: options.proxyUrl,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
__prefetchUI,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__keylessClaimUrl,
__keylessApiKeysUrl,
} = clerkState?.__internal_clerk_state || {};
Expand DownExpand Up@@ -101,6 +102,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
};

const keylessProps = __keylessClaimUrl
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
__keylessClaimUrl?: string;
__keylessApiKeysUrl?: string;
};
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/server/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ export function getResponseClerkState(requestState: RequestStateWithRedirectUrls
__prefetchUI: envVars.prefetchUI,
__telemetryDisabled: envVars.telemetryDisabled,
__telemetryDebug: envVars.telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning: envVars.unsafeDisableDevelopmentModeConsoleWarning,
};

if (canUseKeyless && __keylessClaimUrl) {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-router/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ export const getPublicEnvVariables = (context: AppLoadContext | undefined) => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
signInForceRedirectUrl: getValue('CLERK_SIGN_IN_FORCE_REDIRECT_URL'),
signUpForceRedirectUrl: getValue('CLERK_SIGN_UP_FORCE_REDIRECT_URL'),
signInFallbackRedirectUrl: getValue('CLERK_SIGN_IN_FALLBACK_REDIRECT_URL'),
Expand Down
12 changes: 11 additions & 1 deletion packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1123,7 +1123,17 @@ type ClerkOptionsNavigation =

type ClerkUnsafeOptions = {
/**
* Disables the console warning that is logged when Clerk is initialized with development keys.
* Disables the `Clerk has been loaded with development keys` console warning that is logged when Clerk is
* initialized with development keys. The warning is emitted by `clerk-js` to the browser console; in dev servers
* that mirror browser logs to the terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`), setting
* this option also stops it from showing up there.
*
* Each framework integration also exposes an env-var shortcut so you don't need to thread the option through
* `<ClerkProvider>` manually:
* - Next.js: `NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - TanStack Start / React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
*
* [WARNING] The development mode warning is intended to ensure that you don't go to production with a non-production
* Clerk instance. If you're disabling it, please make sure you don't ship with a non-production Clerk instance!
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import type { RequestState } from '@clerk/backend/internal';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeWithPublicEnvs, pickFromClerkInitState } from '../client/utils';
import { getResponseClerkState } from '../server/utils';

const createRequestState = (): RequestState =>
({
domain: undefined,
isSatellite: false,
publishableKey: 'pk_test_xxx',
proxyUrl: undefined,
signInUrl: undefined,
signUpUrl: undefined,
toAuth: () => ({}),
}) as RequestState;

describe('unsafe_disableDevelopmentModeConsoleWarning', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit false from the initial state when public env is true', () => {
vi.stubEnv('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeWithPublicEnvs({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});

it('hydrates the unprefixed env value from server state', () => {
vi.stubEnv('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const clerkInitialState = getResponseClerkState(createRequestState());
const pickedState = pickFromClerkInitState(clerkInitialState.__internal_clerk_state);
const result = mergeWithPublicEnvs(pickedState);

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(true);
});
});
1 change: 1 addition & 0 deletions packages/tanstack-react-start/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
};
};

Expand Down
4 changes: 4 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const pickFromClerkInitState = (
__clerkUIVersion,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__signInForceRedirectUrl,
__signUpForceRedirectUrl,
__signInFallbackRedirectUrl,
Expand All@@ -53,6 +54,7 @@ export const pickFromClerkInitState = (
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
signInForceRedirectUrl: __signInForceRedirectUrl,
signUpForceRedirectUrl: __signUpForceRedirectUrl,
signInFallbackRedirectUrl: __signInFallbackRedirectUrl,
Expand All@@ -77,6 +79,8 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
__internal_clerkUIVersion: restInitState.__internal_clerkUIVersion || envVars.clerkUIVersion,
signInForceRedirectUrl: restInitState.signInForceRedirectUrl,
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
unsafe_disableDevelopmentModeConsoleWarning:
restInitState.unsafe_disableDevelopmentModeConsoleWarning ?? envVars.unsafeDisableDevelopmentModeConsoleWarning,
};
};

Expand Down
9 changes: 9 additions & 0 deletions packages/tanstack-react-start/src/server/utils/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@ function getPrefetchUIFromEnv(): boolean | undefined {
return undefined;
}

function getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(): boolean | undefined {
const value =
getEnvVariable('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING') ||
getEnvVariable('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING');

return value ? isTruthy(value) : undefined;
}

export function getResponseClerkState(requestState: RequestState, additionalStateOptions: AdditionalStateOptions = {}) {
const { reason, message, isSignedIn, ...rest } = requestState;

Expand All@@ -48,6 +56,7 @@ export function getResponseClerkState(requestState: RequestState, additionalStat
__prefetchUI: getPrefetchUIFromEnv(),
__telemetryDisabled: isTruthy(getEnvVariable('CLERK_TELEMETRY_DISABLED')),
__telemetryDebug: isTruthy(getEnvVariable('CLERK_TELEMETRY_DEBUG')),
__unsafeDisableDevelopmentModeConsoleWarning: getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(),
__signInForceRedirectUrl:
additionalStateOptions.signInForceRedirectUrl || getEnvVariable('CLERK_SIGN_IN_FORCE_REDIRECT_URL') || '',
__signUpForceRedirectUrl:
Expand Down
3 changes: 3 additions & 0 deletions packages/tanstack-react-start/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,9 @@ export const getPublicEnvVariables = () => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
afterSignInUrl: getValue('CLERK_AFTER_SIGN_IN_URL'),
afterSignUpUrl: getValue('CLERK_AFTER_SIGN_UP_URL'),
newSubscriptionRedirectUrl: getValue('CLERK_CHECKOUT_CONTINUE_URL'),
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); } })(); })(); feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning by jacekradko · Pull Request #8402 · 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
16 changes: 16 additions & 0 deletions .changeset/quiet-dev-keys-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
'@clerk/shared': patch
---

Add an env-var shortcut for `unsafe_disableDevelopmentModeConsoleWarning` across the Astro, Nuxt, React Router, and TanStack Start integrations so the development-keys console warning can be suppressed without threading the option through `<ClerkProvider>` manually:

- Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
- React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)
- TanStack Start: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING` (or `CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`)

The Next.js equivalent (`NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`) already existed; the JSDoc on `unsafe_disableDevelopmentModeConsoleWarning` now lists every framework's env-var shortcut and clarifies that suppressing the warning at source also keeps it from being mirrored to the dev-server terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeEnvVarsWithParams } from '../merge-env-vars-with-params';

describe('mergeEnvVarsWithParams', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit unsafe_disableDevelopmentModeConsoleWarning false when env is true', () => {
vi.stubEnv('PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeEnvVarsWithParams({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});
});
4 changes: 4 additions & 0 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const mergeEnvVarsWithParams = (
__internal_clerkUIUrl: paramClerkUIUrl,
__internal_clerkUIVersion: paramClerkUIVersion,
prefetchUI: paramPrefetchUI,
unsafe_disableDevelopmentModeConsoleWarning: paramUnsafeDisableDevelopmentModeConsoleWarning,
...rest
} = params || {};

Expand All@@ -65,6 +66,9 @@ const mergeEnvVarsWithParams = (
disabled: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DISABLED),
debug: isTruthy(import.meta.env.PUBLIC_CLERK_TELEMETRY_DEBUG),
},
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
Comment thread
jacekradko marked this conversation as resolved.
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
Expand Down
2 changes: 2 additions & 0 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,8 @@ export default defineNuxtModule<ModuleOptions>({
// prefetchUI config: can be false or undefined
prefetchUI: options.prefetchUI,
isSatellite: options.isSatellite,
// Listed explicitly so it can be overridden via NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING.
unsafe_disableDevelopmentModeConsoleWarning: options.unsafe_disableDevelopmentModeConsoleWarning,
// Backend specific variables that are safe to share.
// We want them to be overridable like the other public keys (e.g NUXT_PUBLIC_CLERK_PROXY_URL)
proxyUrl: options.proxyUrl,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
__prefetchUI,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__keylessClaimUrl,
__keylessApiKeysUrl,
} = clerkState?.__internal_clerk_state || {};
Expand DownExpand Up@@ -101,6 +102,7 @@ function ClerkProviderBase<TUi extends Ui = Ui>({ children, ...rest }: ClerkProv
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
};

const keylessProps = __keylessClaimUrl
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
__keylessClaimUrl?: string;
__keylessApiKeysUrl?: string;
};
Expand Down
1 change: 1 addition & 0 deletions packages/react-router/src/server/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ export function getResponseClerkState(requestState: RequestStateWithRedirectUrls
__prefetchUI: envVars.prefetchUI,
__telemetryDisabled: envVars.telemetryDisabled,
__telemetryDebug: envVars.telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning: envVars.unsafeDisableDevelopmentModeConsoleWarning,
};

if (canUseKeyless && __keylessClaimUrl) {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-router/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ export const getPublicEnvVariables = (context: AppLoadContext | undefined) => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
signInForceRedirectUrl: getValue('CLERK_SIGN_IN_FORCE_REDIRECT_URL'),
signUpForceRedirectUrl: getValue('CLERK_SIGN_UP_FORCE_REDIRECT_URL'),
signInFallbackRedirectUrl: getValue('CLERK_SIGN_IN_FALLBACK_REDIRECT_URL'),
Expand Down
12 changes: 11 additions & 1 deletion packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1123,7 +1123,17 @@ type ClerkOptionsNavigation =

type ClerkUnsafeOptions = {
/**
* Disables the console warning that is logged when Clerk is initialized with development keys.
* Disables the `Clerk has been loaded with development keys` console warning that is logged when Clerk is
* initialized with development keys. The warning is emitted by `clerk-js` to the browser console; in dev servers
* that mirror browser logs to the terminal (e.g. Next.js with `experimental.browserDebugInfoInTerminal`), setting
* this option also stops it from showing up there.
*
* Each framework integration also exposes an env-var shortcut so you don't need to thread the option through
* `<ClerkProvider>` manually:
* - Next.js: `NEXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Astro: `PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - TanStack Start / React Router: `VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
* - Nuxt: `NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING`
*
* [WARNING] The development mode warning is intended to ensure that you don't go to production with a non-production
* Clerk instance. If you're disabling it, please make sure you don't ship with a non-production Clerk instance!
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import type { RequestState } from '@clerk/backend/internal';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { mergeWithPublicEnvs, pickFromClerkInitState } from '../client/utils';
import { getResponseClerkState } from '../server/utils';

const createRequestState = (): RequestState =>
({
domain: undefined,
isSatellite: false,
publishableKey: 'pk_test_xxx',
proxyUrl: undefined,
signInUrl: undefined,
signUpUrl: undefined,
toAuth: () => ({}),
}) as RequestState;

describe('unsafe_disableDevelopmentModeConsoleWarning', () => {
afterEach(() => {
vi.unstubAllEnvs();
});

it('preserves an explicit false from the initial state when public env is true', () => {
vi.stubEnv('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const result = mergeWithPublicEnvs({
unsafe_disableDevelopmentModeConsoleWarning: false,
});

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(false);
});

it('hydrates the unprefixed env value from server state', () => {
vi.stubEnv('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING', 'true');

const clerkInitialState = getResponseClerkState(createRequestState());
const pickedState = pickFromClerkInitState(clerkInitialState.__internal_clerk_state);
const result = mergeWithPublicEnvs(pickedState);

expect(result.unsafe_disableDevelopmentModeConsoleWarning).toBe(true);
});
});
1 change: 1 addition & 0 deletions packages/tanstack-react-start/src/client/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ export type ClerkState = {
__prefetchUI: boolean | undefined;
__telemetryDisabled: boolean | undefined;
__telemetryDebug: boolean | undefined;
__unsafeDisableDevelopmentModeConsoleWarning: boolean | undefined;
};
};

Expand Down
4 changes: 4 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const pickFromClerkInitState = (
__clerkUIVersion,
__telemetryDisabled,
__telemetryDebug,
__unsafeDisableDevelopmentModeConsoleWarning,
__signInForceRedirectUrl,
__signUpForceRedirectUrl,
__signInFallbackRedirectUrl,
Expand All@@ -53,6 +54,7 @@ export const pickFromClerkInitState = (
disabled: __telemetryDisabled,
debug: __telemetryDebug,
},
unsafe_disableDevelopmentModeConsoleWarning: __unsafeDisableDevelopmentModeConsoleWarning,
signInForceRedirectUrl: __signInForceRedirectUrl,
signUpForceRedirectUrl: __signUpForceRedirectUrl,
signInFallbackRedirectUrl: __signInFallbackRedirectUrl,
Expand All@@ -77,6 +79,8 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
__internal_clerkUIVersion: restInitState.__internal_clerkUIVersion || envVars.clerkUIVersion,
signInForceRedirectUrl: restInitState.signInForceRedirectUrl,
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
unsafe_disableDevelopmentModeConsoleWarning:
restInitState.unsafe_disableDevelopmentModeConsoleWarning ?? envVars.unsafeDisableDevelopmentModeConsoleWarning,
};
};

Expand Down
9 changes: 9 additions & 0 deletions packages/tanstack-react-start/src/server/utils/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,14 @@ function getPrefetchUIFromEnv(): boolean | undefined {
return undefined;
}

function getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(): boolean | undefined {
const value =
getEnvVariable('VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING') ||
getEnvVariable('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING');

return value ? isTruthy(value) : undefined;
}

export function getResponseClerkState(requestState: RequestState, additionalStateOptions: AdditionalStateOptions = {}) {
const { reason, message, isSignedIn, ...rest } = requestState;

Expand All@@ -48,6 +56,7 @@ export function getResponseClerkState(requestState: RequestState, additionalStat
__prefetchUI: getPrefetchUIFromEnv(),
__telemetryDisabled: isTruthy(getEnvVariable('CLERK_TELEMETRY_DISABLED')),
__telemetryDebug: isTruthy(getEnvVariable('CLERK_TELEMETRY_DEBUG')),
__unsafeDisableDevelopmentModeConsoleWarning: getUnsafeDisableDevelopmentModeConsoleWarningFromEnv(),
__signInForceRedirectUrl:
additionalStateOptions.signInForceRedirectUrl || getEnvVariable('CLERK_SIGN_IN_FORCE_REDIRECT_URL') || '',
__signUpForceRedirectUrl:
Expand Down
3 changes: 3 additions & 0 deletions packages/tanstack-react-start/src/utils/env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,9 @@ export const getPublicEnvVariables = () => {
prefetchUI: getValue('CLERK_PREFETCH_UI') === 'false' ? false : undefined,
telemetryDisabled: isTruthy(getValue('CLERK_TELEMETRY_DISABLED')),
telemetryDebug: isTruthy(getValue('CLERK_TELEMETRY_DEBUG')),
unsafeDisableDevelopmentModeConsoleWarning: isTruthy(
getValue('CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING'),
),
afterSignInUrl: getValue('CLERK_AFTER_SIGN_IN_URL'),
afterSignUpUrl: getValue('CLERK_AFTER_SIGN_UP_URL'),
newSubscriptionRedirectUrl: getValue('CLERK_CHECKOUT_CONTINUE_URL'),
Expand Down
Loading