Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/astro-keyless-cli-init-error.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@clerk/astro': minor
'@clerk/shared': patch
---

In development, missing Clerk keys no longer activate keyless mode. When `PUBLIC_CLERK_PUBLISHABLE_KEY` and `CLERK_SECRET_KEY` are not set, the SDK now fails with an error directing you to run `npx clerk@latest init`, which provisions a Clerk application and writes the keys to `.env`. Existing apps with configured or claimed keys are unaffected.
58 changes: 38 additions & 20 deletions integration/tests/astro/keyless.test.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import { test } from '@playwright/test';
import * as path from 'node:path';

import { expect, test } from '@playwright/test';

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

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

Expand All @@ -21,34 +20,53 @@ 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();
// Without keys the app 500s on every request, so readiness can't wait for a 2xx
await app.dev({ acceptAnyResponse: true });
});

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, requests fail with the missing env vars error instead of keyless bootstrap.', async ({
page,
context,
}) => {
await testClaimedAppWithMissingKeys({ page, context, app, dashboardUrl });
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');
});

test('Keyless popover is removed after adding keys to .env and restarting.', async ({ page, context }) => {
await testKeylessRemovedAfterEnvAndRestart({ page, context, app });
test('Claimed application with keys inside .env renders without the keyless popover.', async ({ page, context }) => {
/**
* Seed claimed keyless state directly: the SDK no longer mints keys, so write the
* keys fixture to `.clerk/.tmp/keyless.json` and copy the matching keys into `.env`.
*/
const publishableKey = appConfigs.envs.withEmailCodes.publicVariables.get('CLERK_PUBLISHABLE_KEY');
const secretKey = appConfigs.envs.withEmailCodes.privateVariables.get('CLERK_SECRET_KEY');
await fs.ensureDir(path.join(app.appDir, '.clerk', '.tmp'));
await fs.writeJSON(path.join(app.appDir, '.clerk', '.tmp', 'keyless.json'), {
publishableKey,
secretKey,
claimUrl: 'https://dashboard.clerk.com/apps/claim',
apiKeysUrl: 'https://dashboard.clerk.com/last-active?path=api-keys',
});
await app.keylessToEnv();
// Restart the dev server to pick up new env vars (Vite doesn't hot-reload .env)
await app.restart();

const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.waitForClerkJsLoaded();
await u.po.expect.toBeSignedOut();

// Claimed apps with configured keys run without any keyless UI
await u.po.keylessPopover.waitForUnmounted();
});
});
3 changes: 0 additions & 3 deletions packages/astro/src/env.d.ts
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff 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 Down Expand 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
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff 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
42 changes: 4 additions & 38 deletions packages/astro/src/server/clerk-middleware.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ 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 { completeOnboardingIfClaimed } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
AstroMiddleware,
Expand Down Expand Up @@ -87,42 +87,18 @@ 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 }),
};
}
await completeOnboardingIfClaimed(options?.publishableKey || env.pk, context);
} catch {
// Silently fail - continue without keyless
// Silently fail - claimed-keys onboarding must not break requests
}
}

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 +121,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
16 changes: 2 additions & 14 deletions packages/astro/src/server/get-safe-env.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,11 @@ function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: Contex
* @internal
*/
function getSafeEnv(context: ContextOrLocals) {
const locals = 'locals' in context ? context.locals : context;

return {
domain: getContextEnvVar('PUBLIC_CLERK_DOMAIN', context),
isSatellite: getContextEnvVar('PUBLIC_CLERK_IS_SATELLITE', context) === 'true',
proxyUrl: getContextEnvVar('PUBLIC_CLERK_PROXY_URL', context),
// Use keyless publishable key if available, otherwise read from env
pk: locals.keylessPublishableKey || getContextEnvVar('PUBLIC_CLERK_PUBLISHABLE_KEY', context),
pk: getContextEnvVar('PUBLIC_CLERK_PUBLISHABLE_KEY', context),
sk: getContextEnvVar('CLERK_SECRET_KEY', context),
machineSecretKey: getContextEnvVar('CLERK_MACHINE_SECRET_KEY', context),
signInUrl: getContextEnvVar('PUBLIC_CLERK_SIGN_IN_URL', context),
Expand All @@ -94,9 +91,6 @@ function getSafeEnv(context: ContextOrLocals) {
apiUrl: getContextEnvVar('CLERK_API_URL', context),
telemetryDisabled: isTruthy(getContextEnvVar('PUBLIC_CLERK_TELEMETRY_DISABLED', context)),
telemetryDebug: isTruthy(getContextEnvVar('PUBLIC_CLERK_TELEMETRY_DEBUG', context)),
// Read from locals (set by middleware) instead of env vars
keylessClaimUrl: locals.keylessClaimUrl,
keylessApiKeysUrl: locals.keylessApiKeysUrl,
};
}

Expand All @@ -108,19 +102,13 @@ function getSafeEnv(context: ContextOrLocals) {
* This is a way to get around it.
*/
function getClientSafeEnv(context: ContextOrLocals) {
const locals = 'locals' in context ? context.locals : context;

return {
domain: getContextEnvVar('PUBLIC_CLERK_DOMAIN', context),
isSatellite: getContextEnvVar('PUBLIC_CLERK_IS_SATELLITE', context) === 'true',
proxyUrl: getContextEnvVar('PUBLIC_CLERK_PROXY_URL', context),
signInUrl: getContextEnvVar('PUBLIC_CLERK_SIGN_IN_URL', context),
signUpUrl: getContextEnvVar('PUBLIC_CLERK_SIGN_UP_URL', context),
// In keyless mode, pass the resolved publishable key to client
publishableKey: locals.keylessPublishableKey || getContextEnvVar('PUBLIC_CLERK_PUBLISHABLE_KEY', context),
// Read from locals (set by middleware) instead of env vars
keylessClaimUrl: locals.keylessClaimUrl,
keylessApiKeysUrl: locals.keylessApiKeysUrl,
publishableKey: getContextEnvVar('PUBLIC_CLERK_PUBLISHABLE_KEY', context),
};
}

Expand Down
10 changes: 0 additions & 10 deletions packages/astro/src/server/keyless/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,6 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
Expand Down
42 changes: 29 additions & 13 deletions packages/astro/src/server/keyless/utils.ts
Original file line number Diff line number Diff line change
@@ -1,23 +1,39 @@
import { resolveKeysWithKeylessFallback as sharedResolveKeysWithKeylessFallback } from '@clerk/shared/keyless';
import { clerkDevelopmentCache, createConfirmationMessage } from '@clerk/shared/keyless';
import type { APIContext } from 'astro';
export type { KeylessResult } from '@clerk/shared/keyless';

import { canUseKeyless } from '../../utils/feature-flags';
import { keyless } from './index';

/**
* Resolves Clerk keys, falling back to keyless mode in development if configured keys are missing.
* Notifies the dashboard that a claimed keyless application is now running with its
* keys configured, and logs a one-time confirmation. No-ops unless the configured
* publishable key matches the locally stored keyless keys.
*/
export async function resolveKeysWithKeylessFallback(
export async function completeOnboardingIfClaimed(
configuredPublishableKey: string | undefined,
configuredSecretKey: string | undefined,
context: APIContext,
) {
const keylessService = await keyless(context);
return sharedResolveKeysWithKeylessFallback(
configuredPublishableKey,
configuredSecretKey,
keylessService,
canUseKeyless,
);
): Promise<void> {
if (!canUseKeyless || !configuredPublishableKey) {
return;
}

const keylessService = keyless(context);
const locallyStoredKeys = keylessService.readKeys();
if (locallyStoredKeys?.publishableKey !== configuredPublishableKey) {
return;
}

try {
await clerkDevelopmentCache?.run(() => keylessService.completeOnboarding(), {
cacheKey: `${locallyStoredKeys.publishableKey}_complete`,
onSuccessStale: 24 * 60 * 60 * 1000, // 24 hours
});
} catch {
// noop
}

clerkDevelopmentCache?.log({
cacheKey: `${locallyStoredKeys.publishableKey}_claimed`,
msg: createConfirmationMessage(),
});
}
20 changes: 2 additions & 18 deletions packages/astro/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,29 +45,13 @@ type AstroClerkCreateInstanceParams<TUi extends Ui = Ui> = AstroClerkIntegration

/**
* @internal
* Internal runtime options injected by the server for keyless mode support.
* Internal runtime options injected by the server.
*/
export type InternalRuntimeOptions = {
/**
* Server-injected publishable key from keyless mode or context.locals
* Server-injected publishable key from the request context environment
*/
publishableKey?: string;
/**
* Keyless claim URL injected by middleware for the client-side banner
*/
keylessClaimUrl?: string;
/**
* Keyless API keys URL injected by middleware for the client-side banner
*/
keylessApiKeysUrl?: string;
/**
* Internal keyless claim URL passed to Clerk.load()
*/
__internal_keylessClaimUrl?: string;
/**
* Internal keyless API keys URL passed to Clerk.load()
*/
__internal_keylessApiKeysUrl?: string;
};

// Copied from `@clerk/react`
Expand Down
Loading
Loading