feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start#9487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
djgould wants to merge 1 commit into from
Closed

feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start #9487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions .changeset/keyless-removal-sweep.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
---

In development, missing Clerk keys no longer activate keyless mode. When the framework's publishable/secret key environment variables are not set, the SDK now throws an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to your env file. Existing apps with configured keys are unaffected.
28 changes: 7 additions & 21 deletions integration/tests/astro/keyless.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
testClaimedAppWithMissingKeys,
testKeylessRemovedAfterEnvAndRestart,
testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.astro.node.clone();

Expand All@@ -21,34 +16,25 @@ test.describe('Keyless mode @astro', () => {
});

let app: Application;
let dashboardUrl = 'https://dashboard.clerk.com/';

test.beforeAll(async () => {
app = await commonSetup.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withKeyless);
if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
dashboardUrl = 'https://dashboard.clerkstage.dev/';
}
await app.dev();
});

test.afterAll(async () => {
await app?.teardown();
});

test('Toggle collapse popover and claim.', async ({ page, context }) => {
await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'astro' });
});

test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
page,
context,
}) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
expect(response?.status()).toBe(500);
const content = await page.content();
expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
});
});
29 changes: 7 additions & 22 deletions integration/tests/nuxt/keyless.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
testClaimedAppWithMissingKeys,
testKeylessRemovedAfterEnvAndRestart,
testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.nuxt.node.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @nuxt', () => {
});

let app: Application;
let dashboardUrl = 'https://dashboard.clerk.com/';

test.beforeAll(async () => {
app = await commonSetup.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withKeyless);
if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
dashboardUrl = 'https://dashboard.clerkstage.dev/';
}
await app.dev();
});

test.afterAll(async () => {
// Keep files for debugging
await app?.teardown();
});

test('Toggle collapse popover and claim.', async ({ page, context }) => {
await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'nuxt' });
});

test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
page,
context,
}) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
expect(response?.status()).toBe(500);
const content = await page.content();
expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
});
});
29 changes: 7 additions & 22 deletions integration/tests/react-router/keyless.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
testClaimedAppWithMissingKeys,
testKeylessRemovedAfterEnvAndRestart,
testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
});

let app: Application;
let dashboardUrl = 'https://dashboard.clerk.com/';

test.beforeAll(async () => {
app = await commonSetup.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withKeyless);
if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
dashboardUrl = 'https://dashboard.clerkstage.dev/';
}
await app.dev();
});

test.afterAll(async () => {
// Keep files for debugging
await app?.teardown();
});

test('Toggle collapse popover and claim.', async ({ page, context }) => {
await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
});

test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
page,
context,
}) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
expect(response?.status()).toBe(500);
const content = await page.content();
expect(content).toContain('A secretKey must be provided');
expect(content).toContain('npx clerk@latest init');
});
});
33 changes: 9 additions & 24 deletions integration/tests/tanstack-start/keyless.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
testClaimedAppWithMissingKeys,
testKeylessRemovedAfterEnvAndRestart,
testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();
const commonSetup = appConfigs.tanstack.reactStart.clone();

test.describe('Keyless mode @react-router', () => {
test.describe('Keyless mode @tanstack-react-start', () => {
test.describe.configure({ mode: 'serial' });
test.setTimeout(90_000);

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
});

let app: Application;
let dashboardUrl = 'https://dashboard.clerk.com/';

test.beforeAll(async () => {
app = await commonSetup.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withKeyless);
if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
dashboardUrl = 'https://dashboard.clerkstage.dev/';
}
await app.dev();
});

test.afterAll(async () => {
// Keep files for debugging
await app?.teardown();
});

test('Toggle collapse popover and claim.', async ({ page, context }) => {
await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
});

test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
page,
context,
}) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
expect(response?.status()).toBe(500);
const content = await page.content();
expect(content).toContain('no secret key provided');
expect(content).toContain('npx clerk@latest init');
});
});
3 changes: 0 additions & 3 deletions packages/astro/src/env.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,6 @@ interface ImportMeta {
declare namespace App {
interface Locals {
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
}
}

Expand Down
8 changes: 1 addition & 7 deletions packages/astro/src/internal/create-clerk-instance.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import type { Ui } from '@clerk/ui/internal';

import { $clerkStore } from '../stores/external';
import { $clerk, $csrState } from '../stores/internal';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions, InternalRuntimeOptions } from '../types';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions } from '../types';
import { invokeClerkAstroJSFunctions } from './invoke-clerk-astro-js-functions';
import { mountAllClerkAstroJSComponents } from './mount-clerk-astro-js-components';
import { runOnce } from './run-once';
Expand DownExpand Up@@ -54,18 +54,12 @@ async function createClerkInstanceInternal<TUi extends Ui = Ui>(options?: AstroC
$clerk.set(clerkJSInstance);
}

const internalOptions = options as AstroClerkCreateInstanceParams<TUi> & InternalRuntimeOptions;
const keylessClaimUrl = internalOptions.__internal_keylessClaimUrl;
const keylessApiKeysUrl = internalOptions.__internal_keylessApiKeysUrl;

const clerkOptions = {
routerPush: createNavigationHandler(window.history.pushState.bind(window.history)),
routerReplace: createNavigationHandler(window.history.replaceState.bind(window.history)),
...options,
// Pass the clerk-ui constructor promise to clerk.load()
ui: { ...options?.ui, ClerkUI },
...(keylessClaimUrl && { __internal_keyless_claimKeylessApplicationUrl: keylessClaimUrl }),
...(keylessApiKeysUrl && { __internal_keyless_copyInstanceKeysUrl: keylessApiKeysUrl }),
} as unknown as ClerkOptions;

initOptions = clerkOptions;
Expand Down
5 changes: 0 additions & 5 deletions packages/astro/src/internal/merge-env-vars-with-params.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,6 @@ const mergeEnvVarsWithParams = (
isSatellite: paramSatellite || import.meta.env.PUBLIC_CLERK_IS_SATELLITE,
proxyUrl: paramProxy || import.meta.env.PUBLIC_CLERK_PROXY_URL,
domain: paramDomain || import.meta.env.PUBLIC_CLERK_DOMAIN,
// In keyless mode, use server-injected publishableKey from params
publishableKey:
paramPublishableKey || internalOptions?.publishableKey || import.meta.env.PUBLIC_CLERK_PUBLISHABLE_KEY || '',
__internal_clerkJSUrl: paramClerkJSUrl || import.meta.env.PUBLIC_CLERK_JS_URL,
Expand All@@ -69,10 +68,6 @@ const mergeEnvVarsWithParams = (
unsafe_disableDevelopmentModeConsoleWarning:
paramUnsafeDisableDevelopmentModeConsoleWarning ??
isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
// Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
// These are dynamically resolved by middleware, not from env vars
__internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
__internal_keylessApiKeysUrl: internalOptions?.keylessApiKeysUrl,
...rest,
};
};
Expand Down
14 changes: 0 additions & 14 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,20 +211,6 @@ describe('getSafeEnv', () => {
expect(env.pk).toBeUndefined();
expect(env.sk).toBeUndefined();
});

it('prefers keylessPublishableKey over all env sources', () => {
process.env.PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_from_process';

const locals = createLocals({
runtime: { env: undefined as unknown as InternalEnv },
keylessPublishableKey: 'pk_keyless',
});
const env = getSafeEnv(locals);

expect(env.pk).toBe('pk_keyless');

delete process.env.PUBLIC_CLERK_PUBLISHABLE_KEY;
});
});

describe('getClientSafeEnv', () => {
Expand Down
47 changes: 1 addition & 46 deletions packages/astro/src/server/clerk-middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,12 +27,10 @@ import type { APIContext } from 'astro';

import { authAsyncStorage } from '#async-local-storage';

import { canUseKeyless } from '../utils/feature-flags';
import { buildClerkHotloadScript } from './build-clerk-hotload-script';
import { clerkClient } from './clerk-client';
import { createCurrentUser } from './current-user';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
AstroMiddleware,
Expand DownExpand Up@@ -87,42 +85,9 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
const patchedRequest = patchRequest(context.request);
const clerkRequest = createClerkRequest(patchedRequest);

// Resolve keyless URLs per-request in development
let keylessClaimUrl: string | undefined;
let keylessApiKeysUrl: string | undefined;
let keylessOptions = options;

if (canUseKeyless) {
try {
const env = getSafeEnv(context);
const configuredPublishableKey = options?.publishableKey || env.pk;
const configuredSecretKey = options?.secretKey || env.sk;

const keylessResult = await resolveKeysWithKeylessFallback(
configuredPublishableKey,
configuredSecretKey,
context,
);

keylessClaimUrl = keylessResult.claimUrl;
keylessApiKeysUrl = keylessResult.apiKeysUrl;

// Override keys with keyless values if returned
if (keylessResult.publishableKey || keylessResult.secretKey) {
keylessOptions = {
...options,
...(keylessResult.publishableKey && { publishableKey: keylessResult.publishableKey }),
...(keylessResult.secretKey && { secretKey: keylessResult.secretKey }),
};
}
} catch {
// Silently fail - continue without keyless
}
}

const requestState = await clerkClient(context).authenticateRequest(
clerkRequest,
createAuthenticateRequestOptions(clerkRequest, keylessOptions, context),
createAuthenticateRequestOptions(clerkRequest, options, context),
);

const locationHeader = requestState.headers.get(constants.Headers.Location);
Expand All@@ -145,16 +110,6 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {

decorateAstroLocal(clerkRequest, authObjectFn, context, requestState);

// Store keyless data for injection into client
if (keylessClaimUrl || keylessApiKeysUrl) {
context.locals.keylessClaimUrl = keylessClaimUrl;
context.locals.keylessApiKeysUrl = keylessApiKeysUrl;
// Also store the resolved publishable key so client can use it
if (keylessOptions?.publishableKey) {
context.locals.keylessPublishableKey = keylessOptions.publishableKey;
}
}

/**
* ALS is crucial for guaranteeing SSR in UI frameworks like React.
* This currently powers the `useAuth()` React hook and any other hook or Component that depends on it.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start#9487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start
#9487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/keyless-removal-sweep.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
---

In development, missing Clerk keys no longer activate keyless mode. When the framework's publishable/secret key environment variables are not set, the SDK now throws an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to your env file. Existing apps with configured keys are unaffected.

28 changes: 7 additions & 21 deletions
integration/tests/astro/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.astro.node.clone();

Expand All@@ -21,34 +16,25 @@ test.describe('Keyless mode @astro', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'astro' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/nuxt/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.nuxt.node.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @nuxt', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'nuxt' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/react-router/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('A secretKey must be provided');
expect(content).toContain('npx clerk@latest init');
 });
});

33 changes: 9 additions & 24 deletions
integration/tests/tanstack-start/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();
const commonSetup = appConfigs.tanstack.reactStart.clone();

test.describe('Keyless mode @react-router', () => {
test.describe('Keyless mode @tanstack-react-start', () => {
 test.describe.configure({ mode: 'serial' });
 test.setTimeout(90_000);

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('no secret key provided');
expect(content).toContain('npx clerk@latest init');
 });
});

3 changes: 0 additions & 3 deletions
packages/astro/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,6 @@ interface ImportMeta {
declare namespace App {
 interface Locals {
 runtime?: { env: InternalEnv };
 keylessClaimUrl?: string;
 keylessApiKeysUrl?: string;
 keylessPublishableKey?: string;
 }
}

Expand Down

8 changes: 1 addition & 7 deletions
packages/astro/src/internal/create-clerk-instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import type { Ui } from '@clerk/ui/internal';

import { $clerkStore } from '../stores/external';
import { $clerk, $csrState } from '../stores/internal';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions, InternalRuntimeOptions } from '../types';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions } from '../types';
import { invokeClerkAstroJSFunctions } from './invoke-clerk-astro-js-functions';
import { mountAllClerkAstroJSComponents } from './mount-clerk-astro-js-components';
import { runOnce } from './run-once';
Expand DownExpand Up@@ -54,18 +54,12 @@ async function createClerkInstanceInternal<TUi extends Ui = Ui>(options?: AstroC
 $clerk.set(clerkJSInstance);
 }

 const internalOptions = options as AstroClerkCreateInstanceParams<TUi> & InternalRuntimeOptions;
 const keylessClaimUrl = internalOptions.__internal_keylessClaimUrl;
 const keylessApiKeysUrl = internalOptions.__internal_keylessApiKeysUrl;

 const clerkOptions = {
 routerPush: createNavigationHandler(window.history.pushState.bind(window.history)),
 routerReplace: createNavigationHandler(window.history.replaceState.bind(window.history)),
 ...options,
 // Pass the clerk-ui constructor promise to clerk.load()
 ui: { ...options?.ui, ClerkUI },
 ...(keylessClaimUrl && { __internal_keyless_claimKeylessApplicationUrl: keylessClaimUrl }),
 ...(keylessApiKeysUrl && { __internal_keyless_copyInstanceKeysUrl: keylessApiKeysUrl }),
 } as unknown as ClerkOptions;

 initOptions = clerkOptions;
Expand Down

5 changes: 0 additions & 5 deletions
packages/astro/src/internal/merge-env-vars-with-params.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,6 @@ const mergeEnvVarsWithParams = (
 isSatellite: paramSatellite || import.meta.env.PUBLIC_CLERK_IS_SATELLITE,
 proxyUrl: paramProxy || import.meta.env.PUBLIC_CLERK_PROXY_URL,
 domain: paramDomain || import.meta.env.PUBLIC_CLERK_DOMAIN,
 // In keyless mode, use server-injected publishableKey from params
 publishableKey:
 paramPublishableKey || internalOptions?.publishableKey || import.meta.env.PUBLIC_CLERK_PUBLISHABLE_KEY || '',
 __internal_clerkJSUrl: paramClerkJSUrl || import.meta.env.PUBLIC_CLERK_JS_URL,
Expand All@@ -69,10 +68,6 @@ const mergeEnvVarsWithParams = (
 unsafe_disableDevelopmentModeConsoleWarning:
 paramUnsafeDisableDevelopmentModeConsoleWarning ??
 isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
 // Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
 // These are dynamically resolved by middleware, not from env vars
 __internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
 __internal_keylessApiKeysUrl: internalOptions?.keylessApiKeysUrl,
 ...rest,
 };
};
Expand Down

14 changes: 0 additions & 14 deletions
packages/astro/src/server/__tests__/get-safe-env.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -211,20 +211,6 @@ describe('getSafeEnv', () => {
 expect(env.pk).toBeUndefined();
 expect(env.sk).toBeUndefined();
 });

 it('prefers keylessPublishableKey over all env sources', () => {
 process.env.PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_from_process';

 const locals = createLocals({
 runtime: { env: undefined as unknown as InternalEnv },
 keylessPublishableKey: 'pk_keyless',
 });
 const env = getSafeEnv(locals);

 expect(env.pk).toBe('pk_keyless');

 delete process.env.PUBLIC_CLERK_PUBLISHABLE_KEY;
 });
});

describe('getClientSafeEnv', () => {
Expand Down

47 changes: 1 addition & 46 deletions
packages/astro/src/server/clerk-middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,12 +27,10 @@ import type { APIContext } from 'astro';

import { authAsyncStorage } from '#async-local-storage';

import { canUseKeyless } from '../utils/feature-flags';
import { buildClerkHotloadScript } from './build-clerk-hotload-script';
import { clerkClient } from './clerk-client';
import { createCurrentUser } from './current-user';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
 AstroMiddleware,
Expand DownExpand Up@@ -87,42 +85,9 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
 const patchedRequest = patchRequest(context.request);
 const clerkRequest = createClerkRequest(patchedRequest);

 // Resolve keyless URLs per-request in development
 let keylessClaimUrl: string | undefined;
 let keylessApiKeysUrl: string | undefined;
 let keylessOptions = options;

 if (canUseKeyless) {
 try {
 const env = getSafeEnv(context);
 const configuredPublishableKey = options?.publishableKey || env.pk;
 const configuredSecretKey = options?.secretKey || env.sk;

 const keylessResult = await resolveKeysWithKeylessFallback(
 configuredPublishableKey,
 configuredSecretKey,
 context,
 );

 keylessClaimUrl = keylessResult.claimUrl;
 keylessApiKeysUrl = keylessResult.apiKeysUrl;

 // Override keys with keyless values if returned
 if (keylessResult.publishableKey || keylessResult.secretKey) {
 keylessOptions = {
 ...options,
 ...(keylessResult.publishableKey && { publishableKey: keylessResult.publishableKey }),
 ...(keylessResult.secretKey && { secretKey: keylessResult.secretKey }),
 };
 }
 } catch {
 // Silently fail - continue without keyless
 }
 }

 const requestState = await clerkClient(context).authenticateRequest(
 clerkRequest,
 createAuthenticateRequestOptions(clerkRequest, keylessOptions, context),
 createAuthenticateRequestOptions(clerkRequest, options, context),
 );

 const locationHeader = requestState.headers.get(constants.Headers.Location);
Expand All@@ -145,16 +110,6 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {

 decorateAstroLocal(clerkRequest, authObjectFn, context, requestState);

 // Store keyless data for injection into client
 if (keylessClaimUrl || keylessApiKeysUrl) {
 context.locals.keylessClaimUrl = keylessClaimUrl;
 context.locals.keylessApiKeysUrl = keylessApiKeysUrl;
 // Also store the resolved publishable key so client can use it
 if (keylessOptions?.publishableKey) {
 context.locals.keylessPublishableKey = keylessOptions.publishableKey;
 }
 }

 /**
 * ALS is crucial for guaranteeing SSR in UI frameworks like React.
 * This currently powers the `useAuth()` React hook and any other hook or Component that depends on it.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start#9487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start
#9487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/keyless-removal-sweep.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
---

In development, missing Clerk keys no longer activate keyless mode. When the framework's publishable/secret key environment variables are not set, the SDK now throws an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to your env file. Existing apps with configured keys are unaffected.

28 changes: 7 additions & 21 deletions
integration/tests/astro/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.astro.node.clone();

Expand All@@ -21,34 +16,25 @@ test.describe('Keyless mode @astro', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'astro' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/nuxt/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.nuxt.node.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @nuxt', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'nuxt' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/react-router/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('A secretKey must be provided');
expect(content).toContain('npx clerk@latest init');
 });
});

33 changes: 9 additions & 24 deletions
integration/tests/tanstack-start/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();
const commonSetup = appConfigs.tanstack.reactStart.clone();

test.describe('Keyless mode @react-router', () => {
test.describe('Keyless mode @tanstack-react-start', () => {
 test.describe.configure({ mode: 'serial' });
 test.setTimeout(90_000);

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('no secret key provided');
expect(content).toContain('npx clerk@latest init');
 });
});

3 changes: 0 additions & 3 deletions
packages/astro/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,6 @@ interface ImportMeta {
declare namespace App {
 interface Locals {
 runtime?: { env: InternalEnv };
 keylessClaimUrl?: string;
 keylessApiKeysUrl?: string;
 keylessPublishableKey?: string;
 }
}

Expand Down

8 changes: 1 addition & 7 deletions
packages/astro/src/internal/create-clerk-instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import type { Ui } from '@clerk/ui/internal';

import { $clerkStore } from '../stores/external';
import { $clerk, $csrState } from '../stores/internal';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions, InternalRuntimeOptions } from '../types';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions } from '../types';
import { invokeClerkAstroJSFunctions } from './invoke-clerk-astro-js-functions';
import { mountAllClerkAstroJSComponents } from './mount-clerk-astro-js-components';
import { runOnce } from './run-once';
Expand DownExpand Up@@ -54,18 +54,12 @@ async function createClerkInstanceInternal<TUi extends Ui = Ui>(options?: AstroC
 $clerk.set(clerkJSInstance);
 }

 const internalOptions = options as AstroClerkCreateInstanceParams<TUi> & InternalRuntimeOptions;
 const keylessClaimUrl = internalOptions.__internal_keylessClaimUrl;
 const keylessApiKeysUrl = internalOptions.__internal_keylessApiKeysUrl;

 const clerkOptions = {
 routerPush: createNavigationHandler(window.history.pushState.bind(window.history)),
 routerReplace: createNavigationHandler(window.history.replaceState.bind(window.history)),
 ...options,
 // Pass the clerk-ui constructor promise to clerk.load()
 ui: { ...options?.ui, ClerkUI },
 ...(keylessClaimUrl && { __internal_keyless_claimKeylessApplicationUrl: keylessClaimUrl }),
 ...(keylessApiKeysUrl && { __internal_keyless_copyInstanceKeysUrl: keylessApiKeysUrl }),
 } as unknown as ClerkOptions;

 initOptions = clerkOptions;
Expand Down

5 changes: 0 additions & 5 deletions
packages/astro/src/internal/merge-env-vars-with-params.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,6 @@ const mergeEnvVarsWithParams = (
 isSatellite: paramSatellite || import.meta.env.PUBLIC_CLERK_IS_SATELLITE,
 proxyUrl: paramProxy || import.meta.env.PUBLIC_CLERK_PROXY_URL,
 domain: paramDomain || import.meta.env.PUBLIC_CLERK_DOMAIN,
 // In keyless mode, use server-injected publishableKey from params
 publishableKey:
 paramPublishableKey || internalOptions?.publishableKey || import.meta.env.PUBLIC_CLERK_PUBLISHABLE_KEY || '',
 __internal_clerkJSUrl: paramClerkJSUrl || import.meta.env.PUBLIC_CLERK_JS_URL,
Expand All@@ -69,10 +68,6 @@ const mergeEnvVarsWithParams = (
 unsafe_disableDevelopmentModeConsoleWarning:
 paramUnsafeDisableDevelopmentModeConsoleWarning ??
 isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
 // Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
 // These are dynamically resolved by middleware, not from env vars
 __internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
 __internal_keylessApiKeysUrl: internalOptions?.keylessApiKeysUrl,
 ...rest,
 };
};
Expand Down

14 changes: 0 additions & 14 deletions
packages/astro/src/server/__tests__/get-safe-env.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -211,20 +211,6 @@ describe('getSafeEnv', () => {
 expect(env.pk).toBeUndefined();
 expect(env.sk).toBeUndefined();
 });

 it('prefers keylessPublishableKey over all env sources', () => {
 process.env.PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_from_process';

 const locals = createLocals({
 runtime: { env: undefined as unknown as InternalEnv },
 keylessPublishableKey: 'pk_keyless',
 });
 const env = getSafeEnv(locals);

 expect(env.pk).toBe('pk_keyless');

 delete process.env.PUBLIC_CLERK_PUBLISHABLE_KEY;
 });
});

describe('getClientSafeEnv', () => {
Expand Down

47 changes: 1 addition & 46 deletions
packages/astro/src/server/clerk-middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,12 +27,10 @@ import type { APIContext } from 'astro';

import { authAsyncStorage } from '#async-local-storage';

import { canUseKeyless } from '../utils/feature-flags';
import { buildClerkHotloadScript } from './build-clerk-hotload-script';
import { clerkClient } from './clerk-client';
import { createCurrentUser } from './current-user';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
 AstroMiddleware,
Expand DownExpand Up@@ -87,42 +85,9 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
 const patchedRequest = patchRequest(context.request);
 const clerkRequest = createClerkRequest(patchedRequest);

 // Resolve keyless URLs per-request in development
 let keylessClaimUrl: string | undefined;
 let keylessApiKeysUrl: string | undefined;
 let keylessOptions = options;

 if (canUseKeyless) {
 try {
 const env = getSafeEnv(context);
 const configuredPublishableKey = options?.publishableKey || env.pk;
 const configuredSecretKey = options?.secretKey || env.sk;

 const keylessResult = await resolveKeysWithKeylessFallback(
 configuredPublishableKey,
 configuredSecretKey,
 context,
 );

 keylessClaimUrl = keylessResult.claimUrl;
 keylessApiKeysUrl = keylessResult.apiKeysUrl;

 // Override keys with keyless values if returned
 if (keylessResult.publishableKey || keylessResult.secretKey) {
 keylessOptions = {
 ...options,
 ...(keylessResult.publishableKey && { publishableKey: keylessResult.publishableKey }),
 ...(keylessResult.secretKey && { secretKey: keylessResult.secretKey }),
 };
 }
 } catch {
 // Silently fail - continue without keyless
 }
 }

 const requestState = await clerkClient(context).authenticateRequest(
 clerkRequest,
 createAuthenticateRequestOptions(clerkRequest, keylessOptions, context),
 createAuthenticateRequestOptions(clerkRequest, options, context),
 );

 const locationHeader = requestState.headers.get(constants.Headers.Location);
Expand All@@ -145,16 +110,6 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {

 decorateAstroLocal(clerkRequest, authObjectFn, context, requestState);

 // Store keyless data for injection into client
 if (keylessClaimUrl || keylessApiKeysUrl) {
 context.locals.keylessClaimUrl = keylessClaimUrl;
 context.locals.keylessApiKeysUrl = keylessApiKeysUrl;
 // Also store the resolved publishable key so client can use it
 if (keylessOptions?.publishableKey) {
 context.locals.keylessPublishableKey = keylessOptions.publishableKey;
 }
 }

 /**
 * ALS is crucial for guaranteeing SSR in UI frameworks like React.
 * This currently powers the `useAuth()` React hook and any other hook or Component that depends on it.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start#9487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start
#9487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/keyless-removal-sweep.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
---

In development, missing Clerk keys no longer activate keyless mode. When the framework's publishable/secret key environment variables are not set, the SDK now throws an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to your env file. Existing apps with configured keys are unaffected.

28 changes: 7 additions & 21 deletions
integration/tests/astro/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.astro.node.clone();

Expand All@@ -21,34 +16,25 @@ test.describe('Keyless mode @astro', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'astro' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/nuxt/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.nuxt.node.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @nuxt', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'nuxt' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/react-router/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('A secretKey must be provided');
expect(content).toContain('npx clerk@latest init');
 });
});

33 changes: 9 additions & 24 deletions
integration/tests/tanstack-start/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();
const commonSetup = appConfigs.tanstack.reactStart.clone();

test.describe('Keyless mode @react-router', () => {
test.describe('Keyless mode @tanstack-react-start', () => {
 test.describe.configure({ mode: 'serial' });
 test.setTimeout(90_000);

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('no secret key provided');
expect(content).toContain('npx clerk@latest init');
 });
});

3 changes: 0 additions & 3 deletions
packages/astro/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,6 @@ interface ImportMeta {
declare namespace App {
 interface Locals {
 runtime?: { env: InternalEnv };
 keylessClaimUrl?: string;
 keylessApiKeysUrl?: string;
 keylessPublishableKey?: string;
 }
}

Expand Down

8 changes: 1 addition & 7 deletions
packages/astro/src/internal/create-clerk-instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import type { Ui } from '@clerk/ui/internal';

import { $clerkStore } from '../stores/external';
import { $clerk, $csrState } from '../stores/internal';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions, InternalRuntimeOptions } from '../types';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions } from '../types';
import { invokeClerkAstroJSFunctions } from './invoke-clerk-astro-js-functions';
import { mountAllClerkAstroJSComponents } from './mount-clerk-astro-js-components';
import { runOnce } from './run-once';
Expand DownExpand Up@@ -54,18 +54,12 @@ async function createClerkInstanceInternal<TUi extends Ui = Ui>(options?: AstroC
 $clerk.set(clerkJSInstance);
 }

 const internalOptions = options as AstroClerkCreateInstanceParams<TUi> & InternalRuntimeOptions;
 const keylessClaimUrl = internalOptions.__internal_keylessClaimUrl;
 const keylessApiKeysUrl = internalOptions.__internal_keylessApiKeysUrl;

 const clerkOptions = {
 routerPush: createNavigationHandler(window.history.pushState.bind(window.history)),
 routerReplace: createNavigationHandler(window.history.replaceState.bind(window.history)),
 ...options,
 // Pass the clerk-ui constructor promise to clerk.load()
 ui: { ...options?.ui, ClerkUI },
 ...(keylessClaimUrl && { __internal_keyless_claimKeylessApplicationUrl: keylessClaimUrl }),
 ...(keylessApiKeysUrl && { __internal_keyless_copyInstanceKeysUrl: keylessApiKeysUrl }),
 } as unknown as ClerkOptions;

 initOptions = clerkOptions;
Expand Down

5 changes: 0 additions & 5 deletions
packages/astro/src/internal/merge-env-vars-with-params.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,6 @@ const mergeEnvVarsWithParams = (
 isSatellite: paramSatellite || import.meta.env.PUBLIC_CLERK_IS_SATELLITE,
 proxyUrl: paramProxy || import.meta.env.PUBLIC_CLERK_PROXY_URL,
 domain: paramDomain || import.meta.env.PUBLIC_CLERK_DOMAIN,
 // In keyless mode, use server-injected publishableKey from params
 publishableKey:
 paramPublishableKey || internalOptions?.publishableKey || import.meta.env.PUBLIC_CLERK_PUBLISHABLE_KEY || '',
 __internal_clerkJSUrl: paramClerkJSUrl || import.meta.env.PUBLIC_CLERK_JS_URL,
Expand All@@ -69,10 +68,6 @@ const mergeEnvVarsWithParams = (
 unsafe_disableDevelopmentModeConsoleWarning:
 paramUnsafeDisableDevelopmentModeConsoleWarning ??
 isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
 // Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
 // These are dynamically resolved by middleware, not from env vars
 __internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
 __internal_keylessApiKeysUrl: internalOptions?.keylessApiKeysUrl,
 ...rest,
 };
};
Expand Down

14 changes: 0 additions & 14 deletions
packages/astro/src/server/__tests__/get-safe-env.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -211,20 +211,6 @@ describe('getSafeEnv', () => {
 expect(env.pk).toBeUndefined();
 expect(env.sk).toBeUndefined();
 });

 it('prefers keylessPublishableKey over all env sources', () => {
 process.env.PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_from_process';

 const locals = createLocals({
 runtime: { env: undefined as unknown as InternalEnv },
 keylessPublishableKey: 'pk_keyless',
 });
 const env = getSafeEnv(locals);

 expect(env.pk).toBe('pk_keyless');

 delete process.env.PUBLIC_CLERK_PUBLISHABLE_KEY;
 });
});

describe('getClientSafeEnv', () => {
Expand Down

47 changes: 1 addition & 46 deletions
packages/astro/src/server/clerk-middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,12 +27,10 @@ import type { APIContext } from 'astro';

import { authAsyncStorage } from '#async-local-storage';

import { canUseKeyless } from '../utils/feature-flags';
import { buildClerkHotloadScript } from './build-clerk-hotload-script';
import { clerkClient } from './clerk-client';
import { createCurrentUser } from './current-user';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
 AstroMiddleware,
Expand DownExpand Up@@ -87,42 +85,9 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
 const patchedRequest = patchRequest(context.request);
 const clerkRequest = createClerkRequest(patchedRequest);

 // Resolve keyless URLs per-request in development
 let keylessClaimUrl: string | undefined;
 let keylessApiKeysUrl: string | undefined;
 let keylessOptions = options;

 if (canUseKeyless) {
 try {
 const env = getSafeEnv(context);
 const configuredPublishableKey = options?.publishableKey || env.pk;
 const configuredSecretKey = options?.secretKey || env.sk;

 const keylessResult = await resolveKeysWithKeylessFallback(
 configuredPublishableKey,
 configuredSecretKey,
 context,
 );

 keylessClaimUrl = keylessResult.claimUrl;
 keylessApiKeysUrl = keylessResult.apiKeysUrl;

 // Override keys with keyless values if returned
 if (keylessResult.publishableKey || keylessResult.secretKey) {
 keylessOptions = {
 ...options,
 ...(keylessResult.publishableKey && { publishableKey: keylessResult.publishableKey }),
 ...(keylessResult.secretKey && { secretKey: keylessResult.secretKey }),
 };
 }
 } catch {
 // Silently fail - continue without keyless
 }
 }

 const requestState = await clerkClient(context).authenticateRequest(
 clerkRequest,
 createAuthenticateRequestOptions(clerkRequest, keylessOptions, context),
 createAuthenticateRequestOptions(clerkRequest, options, context),
 );

 const locationHeader = requestState.headers.get(constants.Headers.Location);
Expand All@@ -145,16 +110,6 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {

 decorateAstroLocal(clerkRequest, authObjectFn, context, requestState);

 // Store keyless data for injection into client
 if (keylessClaimUrl || keylessApiKeysUrl) {
 context.locals.keylessClaimUrl = keylessClaimUrl;
 context.locals.keylessApiKeysUrl = keylessApiKeysUrl;
 // Also store the resolved publishable key so client can use it
 if (keylessOptions?.publishableKey) {
 context.locals.keylessPublishableKey = keylessOptions.publishableKey;
 }
 }

 /**
 * ALS is crucial for guaranteeing SSR in UI frameworks like React.
 * This currently powers the `useAuth()` React hook and any other hook or Component that depends on it.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start#9487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start
#9487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/keyless-removal-sweep.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
---

In development, missing Clerk keys no longer activate keyless mode. When the framework's publishable/secret key environment variables are not set, the SDK now throws an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to your env file. Existing apps with configured keys are unaffected.

28 changes: 7 additions & 21 deletions
integration/tests/astro/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.astro.node.clone();

Expand All@@ -21,34 +16,25 @@ test.describe('Keyless mode @astro', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'astro' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/nuxt/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.nuxt.node.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @nuxt', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'nuxt' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/react-router/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('A secretKey must be provided');
expect(content).toContain('npx clerk@latest init');
 });
});

33 changes: 9 additions & 24 deletions
integration/tests/tanstack-start/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();
const commonSetup = appConfigs.tanstack.reactStart.clone();

test.describe('Keyless mode @react-router', () => {
test.describe('Keyless mode @tanstack-react-start', () => {
 test.describe.configure({ mode: 'serial' });
 test.setTimeout(90_000);

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('no secret key provided');
expect(content).toContain('npx clerk@latest init');
 });
});

3 changes: 0 additions & 3 deletions
packages/astro/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,6 @@ interface ImportMeta {
declare namespace App {
 interface Locals {
 runtime?: { env: InternalEnv };
 keylessClaimUrl?: string;
 keylessApiKeysUrl?: string;
 keylessPublishableKey?: string;
 }
}

Expand Down

8 changes: 1 addition & 7 deletions
packages/astro/src/internal/create-clerk-instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import type { Ui } from '@clerk/ui/internal';

import { $clerkStore } from '../stores/external';
import { $clerk, $csrState } from '../stores/internal';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions, InternalRuntimeOptions } from '../types';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions } from '../types';
import { invokeClerkAstroJSFunctions } from './invoke-clerk-astro-js-functions';
import { mountAllClerkAstroJSComponents } from './mount-clerk-astro-js-components';
import { runOnce } from './run-once';
Expand DownExpand Up@@ -54,18 +54,12 @@ async function createClerkInstanceInternal<TUi extends Ui = Ui>(options?: AstroC
 $clerk.set(clerkJSInstance);
 }

 const internalOptions = options as AstroClerkCreateInstanceParams<TUi> & InternalRuntimeOptions;
 const keylessClaimUrl = internalOptions.__internal_keylessClaimUrl;
 const keylessApiKeysUrl = internalOptions.__internal_keylessApiKeysUrl;

 const clerkOptions = {
 routerPush: createNavigationHandler(window.history.pushState.bind(window.history)),
 routerReplace: createNavigationHandler(window.history.replaceState.bind(window.history)),
 ...options,
 // Pass the clerk-ui constructor promise to clerk.load()
 ui: { ...options?.ui, ClerkUI },
 ...(keylessClaimUrl && { __internal_keyless_claimKeylessApplicationUrl: keylessClaimUrl }),
 ...(keylessApiKeysUrl && { __internal_keyless_copyInstanceKeysUrl: keylessApiKeysUrl }),
 } as unknown as ClerkOptions;

 initOptions = clerkOptions;
Expand Down

5 changes: 0 additions & 5 deletions
packages/astro/src/internal/merge-env-vars-with-params.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,6 @@ const mergeEnvVarsWithParams = (
 isSatellite: paramSatellite || import.meta.env.PUBLIC_CLERK_IS_SATELLITE,
 proxyUrl: paramProxy || import.meta.env.PUBLIC_CLERK_PROXY_URL,
 domain: paramDomain || import.meta.env.PUBLIC_CLERK_DOMAIN,
 // In keyless mode, use server-injected publishableKey from params
 publishableKey:
 paramPublishableKey || internalOptions?.publishableKey || import.meta.env.PUBLIC_CLERK_PUBLISHABLE_KEY || '',
 __internal_clerkJSUrl: paramClerkJSUrl || import.meta.env.PUBLIC_CLERK_JS_URL,
Expand All@@ -69,10 +68,6 @@ const mergeEnvVarsWithParams = (
 unsafe_disableDevelopmentModeConsoleWarning:
 paramUnsafeDisableDevelopmentModeConsoleWarning ??
 isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
 // Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
 // These are dynamically resolved by middleware, not from env vars
 __internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
 __internal_keylessApiKeysUrl: internalOptions?.keylessApiKeysUrl,
 ...rest,
 };
};
Expand Down

14 changes: 0 additions & 14 deletions
packages/astro/src/server/__tests__/get-safe-env.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -211,20 +211,6 @@ describe('getSafeEnv', () => {
 expect(env.pk).toBeUndefined();
 expect(env.sk).toBeUndefined();
 });

 it('prefers keylessPublishableKey over all env sources', () => {
 process.env.PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_from_process';

 const locals = createLocals({
 runtime: { env: undefined as unknown as InternalEnv },
 keylessPublishableKey: 'pk_keyless',
 });
 const env = getSafeEnv(locals);

 expect(env.pk).toBe('pk_keyless');

 delete process.env.PUBLIC_CLERK_PUBLISHABLE_KEY;
 });
});

describe('getClientSafeEnv', () => {
Expand Down

47 changes: 1 addition & 46 deletions
packages/astro/src/server/clerk-middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,12 +27,10 @@ import type { APIContext } from 'astro';

import { authAsyncStorage } from '#async-local-storage';

import { canUseKeyless } from '../utils/feature-flags';
import { buildClerkHotloadScript } from './build-clerk-hotload-script';
import { clerkClient } from './clerk-client';
import { createCurrentUser } from './current-user';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
 AstroMiddleware,
Expand DownExpand Up@@ -87,42 +85,9 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
 const patchedRequest = patchRequest(context.request);
 const clerkRequest = createClerkRequest(patchedRequest);

 // Resolve keyless URLs per-request in development
 let keylessClaimUrl: string | undefined;
 let keylessApiKeysUrl: string | undefined;
 let keylessOptions = options;

 if (canUseKeyless) {
 try {
 const env = getSafeEnv(context);
 const configuredPublishableKey = options?.publishableKey || env.pk;
 const configuredSecretKey = options?.secretKey || env.sk;

 const keylessResult = await resolveKeysWithKeylessFallback(
 configuredPublishableKey,
 configuredSecretKey,
 context,
 );

 keylessClaimUrl = keylessResult.claimUrl;
 keylessApiKeysUrl = keylessResult.apiKeysUrl;

 // Override keys with keyless values if returned
 if (keylessResult.publishableKey || keylessResult.secretKey) {
 keylessOptions = {
 ...options,
 ...(keylessResult.publishableKey && { publishableKey: keylessResult.publishableKey }),
 ...(keylessResult.secretKey && { secretKey: keylessResult.secretKey }),
 };
 }
 } catch {
 // Silently fail - continue without keyless
 }
 }

 const requestState = await clerkClient(context).authenticateRequest(
 clerkRequest,
 createAuthenticateRequestOptions(clerkRequest, keylessOptions, context),
 createAuthenticateRequestOptions(clerkRequest, options, context),
 );

 const locationHeader = requestState.headers.get(constants.Headers.Location);
Expand All@@ -145,16 +110,6 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {

 decorateAstroLocal(clerkRequest, authObjectFn, context, requestState);

 // Store keyless data for injection into client
 if (keylessClaimUrl || keylessApiKeysUrl) {
 context.locals.keylessClaimUrl = keylessClaimUrl;
 context.locals.keylessApiKeysUrl = keylessApiKeysUrl;
 // Also store the resolved publishable key so client can use it
 if (keylessOptions?.publishableKey) {
 context.locals.keylessPublishableKey = keylessOptions.publishableKey;
 }
 }

 /**
 * ALS is crucial for guaranteeing SSR in UI frameworks like React.
 * This currently powers the `useAuth()` React hook and any other hook or Component that depends on it.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start#9487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start
#9487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/keyless-removal-sweep.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
---

In development, missing Clerk keys no longer activate keyless mode. When the framework's publishable/secret key environment variables are not set, the SDK now throws an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to your env file. Existing apps with configured keys are unaffected.

28 changes: 7 additions & 21 deletions
integration/tests/astro/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.astro.node.clone();

Expand All@@ -21,34 +16,25 @@ test.describe('Keyless mode @astro', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'astro' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/nuxt/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.nuxt.node.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @nuxt', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'nuxt' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/react-router/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('A secretKey must be provided');
expect(content).toContain('npx clerk@latest init');
 });
});

33 changes: 9 additions & 24 deletions
integration/tests/tanstack-start/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();
const commonSetup = appConfigs.tanstack.reactStart.clone();

test.describe('Keyless mode @react-router', () => {
test.describe('Keyless mode @tanstack-react-start', () => {
 test.describe.configure({ mode: 'serial' });
 test.setTimeout(90_000);

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('no secret key provided');
expect(content).toContain('npx clerk@latest init');
 });
});

3 changes: 0 additions & 3 deletions
packages/astro/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,6 @@ interface ImportMeta {
declare namespace App {
 interface Locals {
 runtime?: { env: InternalEnv };
 keylessClaimUrl?: string;
 keylessApiKeysUrl?: string;
 keylessPublishableKey?: string;
 }
}

Expand Down

8 changes: 1 addition & 7 deletions
packages/astro/src/internal/create-clerk-instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import type { Ui } from '@clerk/ui/internal';

import { $clerkStore } from '../stores/external';
import { $clerk, $csrState } from '../stores/internal';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions, InternalRuntimeOptions } from '../types';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions } from '../types';
import { invokeClerkAstroJSFunctions } from './invoke-clerk-astro-js-functions';
import { mountAllClerkAstroJSComponents } from './mount-clerk-astro-js-components';
import { runOnce } from './run-once';
Expand DownExpand Up@@ -54,18 +54,12 @@ async function createClerkInstanceInternal<TUi extends Ui = Ui>(options?: AstroC
 $clerk.set(clerkJSInstance);
 }

 const internalOptions = options as AstroClerkCreateInstanceParams<TUi> & InternalRuntimeOptions;
 const keylessClaimUrl = internalOptions.__internal_keylessClaimUrl;
 const keylessApiKeysUrl = internalOptions.__internal_keylessApiKeysUrl;

 const clerkOptions = {
 routerPush: createNavigationHandler(window.history.pushState.bind(window.history)),
 routerReplace: createNavigationHandler(window.history.replaceState.bind(window.history)),
 ...options,
 // Pass the clerk-ui constructor promise to clerk.load()
 ui: { ...options?.ui, ClerkUI },
 ...(keylessClaimUrl && { __internal_keyless_claimKeylessApplicationUrl: keylessClaimUrl }),
 ...(keylessApiKeysUrl && { __internal_keyless_copyInstanceKeysUrl: keylessApiKeysUrl }),
 } as unknown as ClerkOptions;

 initOptions = clerkOptions;
Expand Down

5 changes: 0 additions & 5 deletions
packages/astro/src/internal/merge-env-vars-with-params.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,6 @@ const mergeEnvVarsWithParams = (
 isSatellite: paramSatellite || import.meta.env.PUBLIC_CLERK_IS_SATELLITE,
 proxyUrl: paramProxy || import.meta.env.PUBLIC_CLERK_PROXY_URL,
 domain: paramDomain || import.meta.env.PUBLIC_CLERK_DOMAIN,
 // In keyless mode, use server-injected publishableKey from params
 publishableKey:
 paramPublishableKey || internalOptions?.publishableKey || import.meta.env.PUBLIC_CLERK_PUBLISHABLE_KEY || '',
 __internal_clerkJSUrl: paramClerkJSUrl || import.meta.env.PUBLIC_CLERK_JS_URL,
Expand All@@ -69,10 +68,6 @@ const mergeEnvVarsWithParams = (
 unsafe_disableDevelopmentModeConsoleWarning:
 paramUnsafeDisableDevelopmentModeConsoleWarning ??
 isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
 // Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
 // These are dynamically resolved by middleware, not from env vars
 __internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
 __internal_keylessApiKeysUrl: internalOptions?.keylessApiKeysUrl,
 ...rest,
 };
};
Expand Down

14 changes: 0 additions & 14 deletions
packages/astro/src/server/__tests__/get-safe-env.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -211,20 +211,6 @@ describe('getSafeEnv', () => {
 expect(env.pk).toBeUndefined();
 expect(env.sk).toBeUndefined();
 });

 it('prefers keylessPublishableKey over all env sources', () => {
 process.env.PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_from_process';

 const locals = createLocals({
 runtime: { env: undefined as unknown as InternalEnv },
 keylessPublishableKey: 'pk_keyless',
 });
 const env = getSafeEnv(locals);

 expect(env.pk).toBe('pk_keyless');

 delete process.env.PUBLIC_CLERK_PUBLISHABLE_KEY;
 });
});

describe('getClientSafeEnv', () => {
Expand Down

47 changes: 1 addition & 46 deletions
packages/astro/src/server/clerk-middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,12 +27,10 @@ import type { APIContext } from 'astro';

import { authAsyncStorage } from '#async-local-storage';

import { canUseKeyless } from '../utils/feature-flags';
import { buildClerkHotloadScript } from './build-clerk-hotload-script';
import { clerkClient } from './clerk-client';
import { createCurrentUser } from './current-user';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
 AstroMiddleware,
Expand DownExpand Up@@ -87,42 +85,9 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
 const patchedRequest = patchRequest(context.request);
 const clerkRequest = createClerkRequest(patchedRequest);

 // Resolve keyless URLs per-request in development
 let keylessClaimUrl: string | undefined;
 let keylessApiKeysUrl: string | undefined;
 let keylessOptions = options;

 if (canUseKeyless) {
 try {
 const env = getSafeEnv(context);
 const configuredPublishableKey = options?.publishableKey || env.pk;
 const configuredSecretKey = options?.secretKey || env.sk;

 const keylessResult = await resolveKeysWithKeylessFallback(
 configuredPublishableKey,
 configuredSecretKey,
 context,
 );

 keylessClaimUrl = keylessResult.claimUrl;
 keylessApiKeysUrl = keylessResult.apiKeysUrl;

 // Override keys with keyless values if returned
 if (keylessResult.publishableKey || keylessResult.secretKey) {
 keylessOptions = {
 ...options,
 ...(keylessResult.publishableKey && { publishableKey: keylessResult.publishableKey }),
 ...(keylessResult.secretKey && { secretKey: keylessResult.secretKey }),
 };
 }
 } catch {
 // Silently fail - continue without keyless
 }
 }

 const requestState = await clerkClient(context).authenticateRequest(
 clerkRequest,
 createAuthenticateRequestOptions(clerkRequest, keylessOptions, context),
 createAuthenticateRequestOptions(clerkRequest, options, context),
 );

 const locationHeader = requestState.headers.get(constants.Headers.Location);
Expand All@@ -145,16 +110,6 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {

 decorateAstroLocal(clerkRequest, authObjectFn, context, requestState);

 // Store keyless data for injection into client
 if (keylessClaimUrl || keylessApiKeysUrl) {
 context.locals.keylessClaimUrl = keylessClaimUrl;
 context.locals.keylessApiKeysUrl = keylessApiKeysUrl;
 // Also store the resolved publishable key so client can use it
 if (keylessOptions?.publishableKey) {
 context.locals.keylessPublishableKey = keylessOptions.publishableKey;
 }
 }

 /**
 * ALS is crucial for guaranteeing SSR in UI frameworks like React.
 * This currently powers the `useAuth()` React hook and any other hook or Component that depends on it.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start#9487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start
#9487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/keyless-removal-sweep.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
---

In development, missing Clerk keys no longer activate keyless mode. When the framework's publishable/secret key environment variables are not set, the SDK now throws an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to your env file. Existing apps with configured keys are unaffected.

28 changes: 7 additions & 21 deletions
integration/tests/astro/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.astro.node.clone();

Expand All@@ -21,34 +16,25 @@ test.describe('Keyless mode @astro', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'astro' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/nuxt/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.nuxt.node.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @nuxt', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'nuxt' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/react-router/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('A secretKey must be provided');
expect(content).toContain('npx clerk@latest init');
 });
});

33 changes: 9 additions & 24 deletions
integration/tests/tanstack-start/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();
const commonSetup = appConfigs.tanstack.reactStart.clone();

test.describe('Keyless mode @react-router', () => {
test.describe('Keyless mode @tanstack-react-start', () => {
 test.describe.configure({ mode: 'serial' });
 test.setTimeout(90_000);

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('no secret key provided');
expect(content).toContain('npx clerk@latest init');
 });
});

3 changes: 0 additions & 3 deletions
packages/astro/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,6 @@ interface ImportMeta {
declare namespace App {
 interface Locals {
 runtime?: { env: InternalEnv };
 keylessClaimUrl?: string;
 keylessApiKeysUrl?: string;
 keylessPublishableKey?: string;
 }
}

Expand Down

8 changes: 1 addition & 7 deletions
packages/astro/src/internal/create-clerk-instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import type { Ui } from '@clerk/ui/internal';

import { $clerkStore } from '../stores/external';
import { $clerk, $csrState } from '../stores/internal';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions, InternalRuntimeOptions } from '../types';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions } from '../types';
import { invokeClerkAstroJSFunctions } from './invoke-clerk-astro-js-functions';
import { mountAllClerkAstroJSComponents } from './mount-clerk-astro-js-components';
import { runOnce } from './run-once';
Expand DownExpand Up@@ -54,18 +54,12 @@ async function createClerkInstanceInternal<TUi extends Ui = Ui>(options?: AstroC
 $clerk.set(clerkJSInstance);
 }

 const internalOptions = options as AstroClerkCreateInstanceParams<TUi> & InternalRuntimeOptions;
 const keylessClaimUrl = internalOptions.__internal_keylessClaimUrl;
 const keylessApiKeysUrl = internalOptions.__internal_keylessApiKeysUrl;

 const clerkOptions = {
 routerPush: createNavigationHandler(window.history.pushState.bind(window.history)),
 routerReplace: createNavigationHandler(window.history.replaceState.bind(window.history)),
 ...options,
 // Pass the clerk-ui constructor promise to clerk.load()
 ui: { ...options?.ui, ClerkUI },
 ...(keylessClaimUrl && { __internal_keyless_claimKeylessApplicationUrl: keylessClaimUrl }),
 ...(keylessApiKeysUrl && { __internal_keyless_copyInstanceKeysUrl: keylessApiKeysUrl }),
 } as unknown as ClerkOptions;

 initOptions = clerkOptions;
Expand Down

5 changes: 0 additions & 5 deletions
packages/astro/src/internal/merge-env-vars-with-params.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,6 @@ const mergeEnvVarsWithParams = (
 isSatellite: paramSatellite || import.meta.env.PUBLIC_CLERK_IS_SATELLITE,
 proxyUrl: paramProxy || import.meta.env.PUBLIC_CLERK_PROXY_URL,
 domain: paramDomain || import.meta.env.PUBLIC_CLERK_DOMAIN,
 // In keyless mode, use server-injected publishableKey from params
 publishableKey:
 paramPublishableKey || internalOptions?.publishableKey || import.meta.env.PUBLIC_CLERK_PUBLISHABLE_KEY || '',
 __internal_clerkJSUrl: paramClerkJSUrl || import.meta.env.PUBLIC_CLERK_JS_URL,
Expand All@@ -69,10 +68,6 @@ const mergeEnvVarsWithParams = (
 unsafe_disableDevelopmentModeConsoleWarning:
 paramUnsafeDisableDevelopmentModeConsoleWarning ??
 isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
 // Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
 // These are dynamically resolved by middleware, not from env vars
 __internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
 __internal_keylessApiKeysUrl: internalOptions?.keylessApiKeysUrl,
 ...rest,
 };
};
Expand Down

14 changes: 0 additions & 14 deletions
packages/astro/src/server/__tests__/get-safe-env.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -211,20 +211,6 @@ describe('getSafeEnv', () => {
 expect(env.pk).toBeUndefined();
 expect(env.sk).toBeUndefined();
 });

 it('prefers keylessPublishableKey over all env sources', () => {
 process.env.PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_from_process';

 const locals = createLocals({
 runtime: { env: undefined as unknown as InternalEnv },
 keylessPublishableKey: 'pk_keyless',
 });
 const env = getSafeEnv(locals);

 expect(env.pk).toBe('pk_keyless');

 delete process.env.PUBLIC_CLERK_PUBLISHABLE_KEY;
 });
});

describe('getClientSafeEnv', () => {
Expand Down

47 changes: 1 addition & 46 deletions
packages/astro/src/server/clerk-middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,12 +27,10 @@ import type { APIContext } from 'astro';

import { authAsyncStorage } from '#async-local-storage';

import { canUseKeyless } from '../utils/feature-flags';
import { buildClerkHotloadScript } from './build-clerk-hotload-script';
import { clerkClient } from './clerk-client';
import { createCurrentUser } from './current-user';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
 AstroMiddleware,
Expand DownExpand Up@@ -87,42 +85,9 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
 const patchedRequest = patchRequest(context.request);
 const clerkRequest = createClerkRequest(patchedRequest);

 // Resolve keyless URLs per-request in development
 let keylessClaimUrl: string | undefined;
 let keylessApiKeysUrl: string | undefined;
 let keylessOptions = options;

 if (canUseKeyless) {
 try {
 const env = getSafeEnv(context);
 const configuredPublishableKey = options?.publishableKey || env.pk;
 const configuredSecretKey = options?.secretKey || env.sk;

 const keylessResult = await resolveKeysWithKeylessFallback(
 configuredPublishableKey,
 configuredSecretKey,
 context,
 );

 keylessClaimUrl = keylessResult.claimUrl;
 keylessApiKeysUrl = keylessResult.apiKeysUrl;

 // Override keys with keyless values if returned
 if (keylessResult.publishableKey || keylessResult.secretKey) {
 keylessOptions = {
 ...options,
 ...(keylessResult.publishableKey && { publishableKey: keylessResult.publishableKey }),
 ...(keylessResult.secretKey && { secretKey: keylessResult.secretKey }),
 };
 }
 } catch {
 // Silently fail - continue without keyless
 }
 }

 const requestState = await clerkClient(context).authenticateRequest(
 clerkRequest,
 createAuthenticateRequestOptions(clerkRequest, keylessOptions, context),
 createAuthenticateRequestOptions(clerkRequest, options, context),
 );

 const locationHeader = requestState.headers.get(constants.Headers.Location);
Expand All@@ -145,16 +110,6 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {

 decorateAstroLocal(clerkRequest, authObjectFn, context, requestState);

 // Store keyless data for injection into client
 if (keylessClaimUrl || keylessApiKeysUrl) {
 context.locals.keylessClaimUrl = keylessClaimUrl;
 context.locals.keylessApiKeysUrl = keylessApiKeysUrl;
 // Also store the resolved publishable key so client can use it
 if (keylessOptions?.publishableKey) {
 context.locals.keylessPublishableKey = keylessOptions.publishableKey;
 }
 }

 /**
 * ALS is crucial for guaranteeing SSR in UI frameworks like React.
 * This currently powers the `useAuth()` React hook and any other hook or Component that depends on it.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start#9487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(*): remove keyless bootstrap from astro, nuxt, react-router, and tanstack-react-start
#9487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
.changeset/keyless-removal-sweep.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/astro': minor
'@clerk/nuxt': minor
'@clerk/react-router': minor
'@clerk/tanstack-react-start': minor
---

In development, missing Clerk keys no longer activate keyless mode. When the framework's publishable/secret key environment variables are not set, the SDK now throws an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to your env file. Existing apps with configured keys are unaffected.

28 changes: 7 additions & 21 deletions
integration/tests/astro/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.astro.node.clone();

Expand All@@ -21,34 +16,25 @@ test.describe('Keyless mode @astro', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'astro' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/nuxt/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.nuxt.node.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @nuxt', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'nuxt' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('Publishable key is missing');
expect(content).toContain('npx clerk@latest init');
 });
});

29 changes: 7 additions & 22 deletions
integration/tests/react-router/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('A secretKey must be provided');
expect(content).toContain('npx clerk@latest init');
 });
});

33 changes: 9 additions & 24 deletions
integration/tests/tanstack-start/keyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
import { test } from '@playwright/test';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import {
 testClaimedAppWithMissingKeys,
 testKeylessRemovedAfterEnvAndRestart,
 testToggleCollapsePopoverAndClaim,
} from '../../testUtils/keylessHelpers';

const commonSetup = appConfigs.reactRouter.reactRouterNode.clone();
const commonSetup = appConfigs.tanstack.reactStart.clone();

test.describe('Keyless mode @react-router', () => {
test.describe('Keyless mode @tanstack-react-start', () => {
 test.describe.configure({ mode: 'serial' });
 test.setTimeout(90_000);

Expand All@@ -21,35 +16,25 @@ test.describe('Keyless mode @react-router', () => {
 });

 let app: Application;
 let dashboardUrl = 'https://dashboard.clerk.com/';

 test.beforeAll(async () => {
 app = await commonSetup.commit();
 await app.setup();
 await app.withEnv(appConfigs.envs.withKeyless);
 if (appConfigs.envs.withKeyless.privateVariables.get('CLERK_API_URL')?.includes('clerkstage')) {
 dashboardUrl = 'https://dashboard.clerkstage.dev/';
 }
 await app.dev();
 });

 test.afterAll(async () => {
 // Keep files for debugging
 await app?.teardown();
 });

 test('Toggle collapse popover and claim.', async ({ page, context }) => {
 await testToggleCollapsePopoverAndClaim({ page, context, app, dashboardUrl, framework: 'react-router' });
 });

 test('Lands on claimed application with missing explicit keys, expanded by default, click to get keys from dashboard.', async ({
 test('Without keys, the app fails with the missing env vars error instead of keyless bootstrap.', async ({
 page,
 context,
 }) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
const response = await page.goto(`${app.serverUrl}/`);
 expect(response?.status()).toBe(500);
 const content = await page.content();
 expect(content).toContain('no secret key provided');
expect(content).toContain('npx clerk@latest init');
 });
});

3 changes: 0 additions & 3 deletions
packages/astro/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,6 @@ interface ImportMeta {
declare namespace App {
 interface Locals {
 runtime?: { env: InternalEnv };
 keylessClaimUrl?: string;
 keylessApiKeysUrl?: string;
 keylessPublishableKey?: string;
 }
}

Expand Down

8 changes: 1 addition & 7 deletions
packages/astro/src/internal/create-clerk-instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import type { Ui } from '@clerk/ui/internal';

import { $clerkStore } from '../stores/external';
import { $clerk, $csrState } from '../stores/internal';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions, InternalRuntimeOptions } from '../types';
import type { AstroClerkCreateInstanceParams, AstroClerkUpdateOptions } from '../types';
import { invokeClerkAstroJSFunctions } from './invoke-clerk-astro-js-functions';
import { mountAllClerkAstroJSComponents } from './mount-clerk-astro-js-components';
import { runOnce } from './run-once';
Expand DownExpand Up@@ -54,18 +54,12 @@ async function createClerkInstanceInternal<TUi extends Ui = Ui>(options?: AstroC
 $clerk.set(clerkJSInstance);
 }

 const internalOptions = options as AstroClerkCreateInstanceParams<TUi> & InternalRuntimeOptions;
 const keylessClaimUrl = internalOptions.__internal_keylessClaimUrl;
 const keylessApiKeysUrl = internalOptions.__internal_keylessApiKeysUrl;

 const clerkOptions = {
 routerPush: createNavigationHandler(window.history.pushState.bind(window.history)),
 routerReplace: createNavigationHandler(window.history.replaceState.bind(window.history)),
 ...options,
 // Pass the clerk-ui constructor promise to clerk.load()
 ui: { ...options?.ui, ClerkUI },
 ...(keylessClaimUrl && { __internal_keyless_claimKeylessApplicationUrl: keylessClaimUrl }),
 ...(keylessApiKeysUrl && { __internal_keyless_copyInstanceKeysUrl: keylessApiKeysUrl }),
 } as unknown as ClerkOptions;

 initOptions = clerkOptions;
Expand Down

5 changes: 0 additions & 5 deletions
packages/astro/src/internal/merge-env-vars-with-params.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,6 @@ const mergeEnvVarsWithParams = (
 isSatellite: paramSatellite || import.meta.env.PUBLIC_CLERK_IS_SATELLITE,
 proxyUrl: paramProxy || import.meta.env.PUBLIC_CLERK_PROXY_URL,
 domain: paramDomain || import.meta.env.PUBLIC_CLERK_DOMAIN,
 // In keyless mode, use server-injected publishableKey from params
 publishableKey:
 paramPublishableKey || internalOptions?.publishableKey || import.meta.env.PUBLIC_CLERK_PUBLISHABLE_KEY || '',
 __internal_clerkJSUrl: paramClerkJSUrl || import.meta.env.PUBLIC_CLERK_JS_URL,
Expand All@@ -69,10 +68,6 @@ const mergeEnvVarsWithParams = (
 unsafe_disableDevelopmentModeConsoleWarning:
 paramUnsafeDisableDevelopmentModeConsoleWarning ??
 isTruthy(import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING),
 // Read from params (server-injected via __CLERK_ASTRO_SAFE_VARS__)
 // These are dynamically resolved by middleware, not from env vars
 __internal_keylessClaimUrl: internalOptions?.keylessClaimUrl,
 __internal_keylessApiKeysUrl: internalOptions?.keylessApiKeysUrl,
 ...rest,
 };
};
Expand Down

14 changes: 0 additions & 14 deletions
packages/astro/src/server/__tests__/get-safe-env.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -211,20 +211,6 @@ describe('getSafeEnv', () => {
 expect(env.pk).toBeUndefined();
 expect(env.sk).toBeUndefined();
 });

 it('prefers keylessPublishableKey over all env sources', () => {
 process.env.PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_from_process';

 const locals = createLocals({
 runtime: { env: undefined as unknown as InternalEnv },
 keylessPublishableKey: 'pk_keyless',
 });
 const env = getSafeEnv(locals);

 expect(env.pk).toBe('pk_keyless');

 delete process.env.PUBLIC_CLERK_PUBLISHABLE_KEY;
 });
});

describe('getClientSafeEnv', () => {
Expand Down

47 changes: 1 addition & 46 deletions
packages/astro/src/server/clerk-middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,12 +27,10 @@ import type { APIContext } from 'astro';

import { authAsyncStorage } from '#async-local-storage';

import { canUseKeyless } from '../utils/feature-flags';
import { buildClerkHotloadScript } from './build-clerk-hotload-script';
import { clerkClient } from './clerk-client';
import { createCurrentUser } from './current-user';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
 AstroMiddleware,
Expand DownExpand Up@@ -87,42 +85,9 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
 const patchedRequest = patchRequest(context.request);
 const clerkRequest = createClerkRequest(patchedRequest);

 // Resolve keyless URLs per-request in development
 let keylessClaimUrl: string | undefined;
 let keylessApiKeysUrl: string | undefined;
 let keylessOptions = options;

 if (canUseKeyless) {
 try {
 const env = getSafeEnv(context);
 const configuredPublishableKey = options?.publishableKey || env.pk;
 const configuredSecretKey = options?.secretKey || env.sk;

 const keylessResult = await resolveKeysWithKeylessFallback(
 configuredPublishableKey,
 configuredSecretKey,
 context,
 );

 keylessClaimUrl = keylessResult.claimUrl;
 keylessApiKeysUrl = keylessResult.apiKeysUrl;

 // Override keys with keyless values if returned
 if (keylessResult.publishableKey || keylessResult.secretKey) {
 keylessOptions = {
 ...options,
 ...(keylessResult.publishableKey && { publishableKey: keylessResult.publishableKey }),
 ...(keylessResult.secretKey && { secretKey: keylessResult.secretKey }),
 };
 }
 } catch {
 // Silently fail - continue without keyless
 }
 }

 const requestState = await clerkClient(context).authenticateRequest(
 clerkRequest,
 createAuthenticateRequestOptions(clerkRequest, keylessOptions, context),
 createAuthenticateRequestOptions(clerkRequest, options, context),
 );

 const locationHeader = requestState.headers.get(constants.Headers.Location);
Expand All@@ -145,16 +110,6 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {

 decorateAstroLocal(clerkRequest, authObjectFn, context, requestState);

 // Store keyless data for injection into client
 if (keylessClaimUrl || keylessApiKeysUrl) {
 context.locals.keylessClaimUrl = keylessClaimUrl;
 context.locals.keylessApiKeysUrl = keylessApiKeysUrl;
 // Also store the resolved publishable key so client can use it
 if (keylessOptions?.publishableKey) {
 context.locals.keylessPublishableKey = keylessOptions.publishableKey;
 }
 }

 /**
 * ALS is crucial for guaranteeing SSR in UI frameworks like React.
 * This currently powers the `useAuth()` React hook and any other hook or Component that depends on it.
Expand Down
Loading