Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-astro-v6-cloudflare.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix compatibility with Astro v6 Cloudflare adapter by using `cloudflare:workers` env when `locals.runtime.env` is unavailable
2 changes: 1 addition & 1 deletion packages/astro/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,7 +100,7 @@
"astro": "^5.17.1"
},
"peerDependencies": {
"astro": "^4.15.0 || ^5.0.0"
"astro": "^4.15.0 || ^5.0.0 || ^6.0.0"
},
"engines": {
"node": ">=20.9.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/env.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ interface ImportMeta {

declare namespace App {
interface Locals {
runtime: { env: InternalEnv };
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
Expand Down
130 changes: 130 additions & 0 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,136 @@ function createLocals(overrides: Partial<App.Locals> = {}): App.Locals {
} as unknown as App.Locals;
}

describe('get-safe-env', () => {
beforeEach(() => {
vi.resetModules();
});

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

describe('initCloudflareEnv', () => {
it('caches env from cloudflare:workers when available', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_test_cf' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_test_cf');
});

it('sets cache to null when cloudflare:workers is not available', async () => {
vi.doMock('cloudflare:workers', () => {
throw new Error('Module not found');
});

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

// Should fall through to import.meta.env (undefined in test)
const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBeUndefined();
});

it('only imports once (caches result)', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
return { env: { CLERK_SECRET_KEY: 'sk_test_cf' } };
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});

it('only imports once even when cloudflare:workers throws', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
throw new Error('Module not found');
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});
});

describe('getContextEnvVar fallback chain', () => {
it('reads from locals.runtime.env (Astro v4/v5)', async () => {
const { getSafeEnv } = await import('../get-safe-env');
const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_runtime');
});

it('falls back to cloudflareEnv when locals.runtime.env is absent', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('falls back to cloudflareEnv when locals.runtime throws (Astro v6)', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

// Simulate Astro v6 behavior: accessing runtime throws
const locals = new Proxy(
{},
{
get(_, prop) {
if (prop === 'runtime') {
throw new Error('locals.runtime is not available in Astro v6 Cloudflare');
}
return undefined;
},
},
);

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('prefers cloudflareEnv over locals.runtime.env', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };
const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});
});
});

describe('getSafeEnv', () => {
beforeEach(() => {
vi.stubEnv('PUBLIC_CLERK_PUBLISHABLE_KEY', '');
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/server/clerk-middleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ 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 } from './get-safe-env';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
Expand DownExpand Up@@ -79,6 +79,8 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
return next();
}

await initCloudflareEnv();

const clerkRequest = createClerkRequest(context.request);

// Resolve keyless URLs per-request in development
Expand Down
46 changes: 43 additions & 3 deletions packages/astro/src/server/get-safe-env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,55 @@ import type { APIContext } from 'astro';

type ContextOrLocals = APIContext | APIContext['locals'];

/**
* Cached env object from `cloudflare:workers` for Astro v6+ Cloudflare adapter.
* - `undefined`: not yet attempted
* - `null`: attempted but not available (non-Cloudflare environment)
* - object: the env object from `cloudflare:workers`
*/
let cloudflareEnv: Record<string, string> | null | undefined;

/**
* @internal
* Attempts to import env from `cloudflare:workers` and caches the result.
* This is needed for Astro v6+ where `locals.runtime.env` is no longer available.
* Safe to call in non-Cloudflare environments — will no-op.
*/
async function initCloudflareEnv(): Promise<void> {
if (cloudflareEnv !== undefined) {
return;
}
try {
// Use a variable to prevent TypeScript from resolving the module specifier
const moduleName = 'cloudflare:workers';
const mod = await import(/* @vite-ignore */ moduleName);
cloudflareEnv = mod.env;
} catch {
cloudflareEnv = null;
}
}
Comment on lines +6 to +32

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Check whether any tests were changed in this PR
git diff --name-only origin/main...HEAD | rg -i '(__tests__|test|spec)\.(ts|tsx|js|jsx)$'# Search for existing tests covering the new Cloudflare env fallback path
rg -n 'initCloudflareEnv|getContextEnvVar|cloudflare:workers' \
-g '**/__tests__/**' -g '*.{test,spec}.{ts,tsx,js,jsx}'2>/dev/null ||true

Repository: clerk/javascript

Length of output: 100


🏁 Script executed:

#!/bin/bash# Find the packages/astro directory and look for test files
find packages/astro -type f \( -name '*.test.ts' -o -name '*.test.tsx' -o -name '*.spec.ts' -o -name '*.spec.tsx' -o -path '*/__tests__/*'\)| head -20
# Also check the structure of the packages/astro directoryecho"=== packages/astro structure ==="
find packages/astro -type d | head -20
# Search across all test files for cloudflare-related testsecho"=== Searching for cloudflare env tests ==="
rg 'cloudflare.*env|initCloudflareEnv' --type ts --type tsx 2>/dev/null ||echo"No matches found"# Look for getContextEnvVar or get-safe-env related testsecho"=== Searching for get-safe-env tests ==="
rg 'getSafeEnv|getContextEnvVar|get-safe-env' --type ts --type tsx 2>/dev/null | head -20 ||echo"No matches found"

Repository: clerk/javascript

Length of output: 995


🏁 Script executed:

#!/bin/bash# Read the complete get-safe-env.ts fileecho"=== packages/astro/src/server/get-safe-env.ts ==="
cat packages/astro/src/server/get-safe-env.ts
echo""echo"=== Checking if any test files import get-safe-env ==="
rg 'get-safe-env|getSafeEnv' packages/astro/src --type ts --type tsx
echo""echo"=== Contents of the existing test file ==="
cat packages/astro/src/internal/__tests__/create-clerk-instance.test.ts | head -100

Repository: clerk/javascript

Length of output: 8030


Add tests for the Cloudflare env fallback logic.

The new initCloudflareEnv() function and the cloudflareEnv fallback path in getContextEnvVar() (lines 20–33 and 47–50) lack test coverage. Add tests to verify that the fallback correctly imports from cloudflare:workers in Cloudflare environments and gracefully handles non-Cloudflare environments.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/astro/src/server/get-safe-env.ts` around lines 6 - 32, Add unit
tests covering the Cloudflare env fallback: write tests for initCloudflareEnv,
the cached cloudflareEnv value, and getContextEnvVar's fallback behavior when
cloudflare:workers is present and when it throws. In one test mock dynamic
import of the moduleName 'cloudflare:workers' to return an object with env
(e.g., {env: {KEY: "value"}}), call initCloudflareEnv() and assert cloudflareEnv
is set and getContextEnvVar('KEY') returns the mocked value; in another test
mock the dynamic import to throw, call initCloudflareEnv(), assert cloudflareEnv
becomes null and getContextEnvVar('KEY') falls back to the non-Cloudflare path.
Ensure tests reset/clear the cloudflareEnv cache between cases so caching
behavior is validated.


/**
* @internal
* Isomorphic handler for reading environment variables defined from Vite or are injected in the request context (CF Pages)
*/
function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: ContextOrLocals): string | undefined {
const locals = 'locals' in contextOrLocals ? contextOrLocals.locals : contextOrLocals;

if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
// Astro v6+ Cloudflare adapter: env from cloudflare:workers
// Checked first to avoid the expensive try/catch on locals.runtime.env,
// which throws on every call in Astro v6 Cloudflare environments.
if (cloudflareEnv) {
return cloudflareEnv[envVarName];
}

// Astro v4/v5 Cloudflare adapter: env is on locals.runtime.env
try {
if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
}
} catch {
// Astro v6 Cloudflare adapter throws when accessing locals.runtime.env
}

// Prefer process.env for runtime environments (e.g., Node.js adapter)
Expand DownExpand Up@@ -79,4 +119,4 @@ function getClientSafeEnv(context: ContextOrLocals) {
};
}

export { getSafeEnv, getClientSafeEnv };
export { getSafeEnv, getClientSafeEnv, initCloudflareEnv };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-astro-v6-cloudflare.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix compatibility with Astro v6 Cloudflare adapter by using `cloudflare:workers` env when `locals.runtime.env` is unavailable
2 changes: 1 addition & 1 deletion packages/astro/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,7 +100,7 @@
"astro": "^5.17.1"
},
"peerDependencies": {
"astro": "^4.15.0 || ^5.0.0"
"astro": "^4.15.0 || ^5.0.0 || ^6.0.0"
},
"engines": {
"node": ">=20.9.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/env.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ interface ImportMeta {

declare namespace App {
interface Locals {
runtime: { env: InternalEnv };
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
Expand Down
130 changes: 130 additions & 0 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,136 @@ function createLocals(overrides: Partial<App.Locals> = {}): App.Locals {
} as unknown as App.Locals;
}

describe('get-safe-env', () => {
beforeEach(() => {
vi.resetModules();
});

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

describe('initCloudflareEnv', () => {
it('caches env from cloudflare:workers when available', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_test_cf' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_test_cf');
});

it('sets cache to null when cloudflare:workers is not available', async () => {
vi.doMock('cloudflare:workers', () => {
throw new Error('Module not found');
});

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

// Should fall through to import.meta.env (undefined in test)
const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBeUndefined();
});

it('only imports once (caches result)', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
return { env: { CLERK_SECRET_KEY: 'sk_test_cf' } };
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});

it('only imports once even when cloudflare:workers throws', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
throw new Error('Module not found');
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});
});

describe('getContextEnvVar fallback chain', () => {
it('reads from locals.runtime.env (Astro v4/v5)', async () => {
const { getSafeEnv } = await import('../get-safe-env');
const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_runtime');
});

it('falls back to cloudflareEnv when locals.runtime.env is absent', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('falls back to cloudflareEnv when locals.runtime throws (Astro v6)', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

// Simulate Astro v6 behavior: accessing runtime throws
const locals = new Proxy(
{},
{
get(_, prop) {
if (prop === 'runtime') {
throw new Error('locals.runtime is not available in Astro v6 Cloudflare');
}
return undefined;
},
},
);

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('prefers cloudflareEnv over locals.runtime.env', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };
const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});
});
});

describe('getSafeEnv', () => {
beforeEach(() => {
vi.stubEnv('PUBLIC_CLERK_PUBLISHABLE_KEY', '');
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/server/clerk-middleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ 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 } from './get-safe-env';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
Expand DownExpand Up@@ -79,6 +79,8 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
return next();
}

await initCloudflareEnv();

const clerkRequest = createClerkRequest(context.request);

// Resolve keyless URLs per-request in development
Expand Down
46 changes: 43 additions & 3 deletions packages/astro/src/server/get-safe-env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,55 @@ import type { APIContext } from 'astro';

type ContextOrLocals = APIContext | APIContext['locals'];

/**
* Cached env object from `cloudflare:workers` for Astro v6+ Cloudflare adapter.
* - `undefined`: not yet attempted
* - `null`: attempted but not available (non-Cloudflare environment)
* - object: the env object from `cloudflare:workers`
*/
let cloudflareEnv: Record<string, string> | null | undefined;

/**
* @internal
* Attempts to import env from `cloudflare:workers` and caches the result.
* This is needed for Astro v6+ where `locals.runtime.env` is no longer available.
* Safe to call in non-Cloudflare environments — will no-op.
*/
async function initCloudflareEnv(): Promise<void> {
if (cloudflareEnv !== undefined) {
return;
}
try {
// Use a variable to prevent TypeScript from resolving the module specifier
const moduleName = 'cloudflare:workers';
const mod = await import(/* @vite-ignore */ moduleName);
cloudflareEnv = mod.env;
} catch {
cloudflareEnv = null;
}
}
Comment on lines +6 to +32

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Check whether any tests were changed in this PR
git diff --name-only origin/main...HEAD | rg -i '(__tests__|test|spec)\.(ts|tsx|js|jsx)$'# Search for existing tests covering the new Cloudflare env fallback path
rg -n 'initCloudflareEnv|getContextEnvVar|cloudflare:workers' \
-g '**/__tests__/**' -g '*.{test,spec}.{ts,tsx,js,jsx}'2>/dev/null ||true

Repository: clerk/javascript

Length of output: 100


🏁 Script executed:

#!/bin/bash# Find the packages/astro directory and look for test files
find packages/astro -type f \( -name '*.test.ts' -o -name '*.test.tsx' -o -name '*.spec.ts' -o -name '*.spec.tsx' -o -path '*/__tests__/*'\)| head -20
# Also check the structure of the packages/astro directoryecho"=== packages/astro structure ==="
find packages/astro -type d | head -20
# Search across all test files for cloudflare-related testsecho"=== Searching for cloudflare env tests ==="
rg 'cloudflare.*env|initCloudflareEnv' --type ts --type tsx 2>/dev/null ||echo"No matches found"# Look for getContextEnvVar or get-safe-env related testsecho"=== Searching for get-safe-env tests ==="
rg 'getSafeEnv|getContextEnvVar|get-safe-env' --type ts --type tsx 2>/dev/null | head -20 ||echo"No matches found"

Repository: clerk/javascript

Length of output: 995


🏁 Script executed:

#!/bin/bash# Read the complete get-safe-env.ts fileecho"=== packages/astro/src/server/get-safe-env.ts ==="
cat packages/astro/src/server/get-safe-env.ts
echo""echo"=== Checking if any test files import get-safe-env ==="
rg 'get-safe-env|getSafeEnv' packages/astro/src --type ts --type tsx
echo""echo"=== Contents of the existing test file ==="
cat packages/astro/src/internal/__tests__/create-clerk-instance.test.ts | head -100

Repository: clerk/javascript

Length of output: 8030


Add tests for the Cloudflare env fallback logic.

The new initCloudflareEnv() function and the cloudflareEnv fallback path in getContextEnvVar() (lines 20–33 and 47–50) lack test coverage. Add tests to verify that the fallback correctly imports from cloudflare:workers in Cloudflare environments and gracefully handles non-Cloudflare environments.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/astro/src/server/get-safe-env.ts` around lines 6 - 32, Add unit
tests covering the Cloudflare env fallback: write tests for initCloudflareEnv,
the cached cloudflareEnv value, and getContextEnvVar's fallback behavior when
cloudflare:workers is present and when it throws. In one test mock dynamic
import of the moduleName 'cloudflare:workers' to return an object with env
(e.g., {env: {KEY: "value"}}), call initCloudflareEnv() and assert cloudflareEnv
is set and getContextEnvVar('KEY') returns the mocked value; in another test
mock the dynamic import to throw, call initCloudflareEnv(), assert cloudflareEnv
becomes null and getContextEnvVar('KEY') falls back to the non-Cloudflare path.
Ensure tests reset/clear the cloudflareEnv cache between cases so caching
behavior is validated.


/**
* @internal
* Isomorphic handler for reading environment variables defined from Vite or are injected in the request context (CF Pages)
*/
function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: ContextOrLocals): string | undefined {
const locals = 'locals' in contextOrLocals ? contextOrLocals.locals : contextOrLocals;

if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
// Astro v6+ Cloudflare adapter: env from cloudflare:workers
// Checked first to avoid the expensive try/catch on locals.runtime.env,
// which throws on every call in Astro v6 Cloudflare environments.
if (cloudflareEnv) {
return cloudflareEnv[envVarName];
}

// Astro v4/v5 Cloudflare adapter: env is on locals.runtime.env
try {
if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
}
} catch {
// Astro v6 Cloudflare adapter throws when accessing locals.runtime.env
}

// Prefer process.env for runtime environments (e.g., Node.js adapter)
Expand DownExpand Up@@ -79,4 +119,4 @@ function getClientSafeEnv(context: ContextOrLocals) {
};
}

export { getSafeEnv, getClientSafeEnv };
export { getSafeEnv, getClientSafeEnv, initCloudflareEnv };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-astro-v6-cloudflare.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix compatibility with Astro v6 Cloudflare adapter by using `cloudflare:workers` env when `locals.runtime.env` is unavailable
2 changes: 1 addition & 1 deletion packages/astro/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,7 +100,7 @@
"astro": "^5.17.1"
},
"peerDependencies": {
"astro": "^4.15.0 || ^5.0.0"
"astro": "^4.15.0 || ^5.0.0 || ^6.0.0"
},
"engines": {
"node": ">=20.9.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/env.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ interface ImportMeta {

declare namespace App {
interface Locals {
runtime: { env: InternalEnv };
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
Expand Down
130 changes: 130 additions & 0 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,136 @@ function createLocals(overrides: Partial<App.Locals> = {}): App.Locals {
} as unknown as App.Locals;
}

describe('get-safe-env', () => {
beforeEach(() => {
vi.resetModules();
});

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

describe('initCloudflareEnv', () => {
it('caches env from cloudflare:workers when available', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_test_cf' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_test_cf');
});

it('sets cache to null when cloudflare:workers is not available', async () => {
vi.doMock('cloudflare:workers', () => {
throw new Error('Module not found');
});

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

// Should fall through to import.meta.env (undefined in test)
const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBeUndefined();
});

it('only imports once (caches result)', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
return { env: { CLERK_SECRET_KEY: 'sk_test_cf' } };
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});

it('only imports once even when cloudflare:workers throws', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
throw new Error('Module not found');
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});
});

describe('getContextEnvVar fallback chain', () => {
it('reads from locals.runtime.env (Astro v4/v5)', async () => {
const { getSafeEnv } = await import('../get-safe-env');
const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_runtime');
});

it('falls back to cloudflareEnv when locals.runtime.env is absent', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('falls back to cloudflareEnv when locals.runtime throws (Astro v6)', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

// Simulate Astro v6 behavior: accessing runtime throws
const locals = new Proxy(
{},
{
get(_, prop) {
if (prop === 'runtime') {
throw new Error('locals.runtime is not available in Astro v6 Cloudflare');
}
return undefined;
},
},
);

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('prefers cloudflareEnv over locals.runtime.env', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };
const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});
});
});

describe('getSafeEnv', () => {
beforeEach(() => {
vi.stubEnv('PUBLIC_CLERK_PUBLISHABLE_KEY', '');
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/server/clerk-middleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ 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 } from './get-safe-env';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
Expand DownExpand Up@@ -79,6 +79,8 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
return next();
}

await initCloudflareEnv();

const clerkRequest = createClerkRequest(context.request);

// Resolve keyless URLs per-request in development
Expand Down
46 changes: 43 additions & 3 deletions packages/astro/src/server/get-safe-env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,55 @@ import type { APIContext } from 'astro';

type ContextOrLocals = APIContext | APIContext['locals'];

/**
* Cached env object from `cloudflare:workers` for Astro v6+ Cloudflare adapter.
* - `undefined`: not yet attempted
* - `null`: attempted but not available (non-Cloudflare environment)
* - object: the env object from `cloudflare:workers`
*/
let cloudflareEnv: Record<string, string> | null | undefined;

/**
* @internal
* Attempts to import env from `cloudflare:workers` and caches the result.
* This is needed for Astro v6+ where `locals.runtime.env` is no longer available.
* Safe to call in non-Cloudflare environments — will no-op.
*/
async function initCloudflareEnv(): Promise<void> {
if (cloudflareEnv !== undefined) {
return;
}
try {
// Use a variable to prevent TypeScript from resolving the module specifier
const moduleName = 'cloudflare:workers';
const mod = await import(/* @vite-ignore */ moduleName);
cloudflareEnv = mod.env;
} catch {
cloudflareEnv = null;
}
}
Comment on lines +6 to +32

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Check whether any tests were changed in this PR
git diff --name-only origin/main...HEAD | rg -i '(__tests__|test|spec)\.(ts|tsx|js|jsx)$'# Search for existing tests covering the new Cloudflare env fallback path
rg -n 'initCloudflareEnv|getContextEnvVar|cloudflare:workers' \
-g '**/__tests__/**' -g '*.{test,spec}.{ts,tsx,js,jsx}'2>/dev/null ||true

Repository: clerk/javascript

Length of output: 100


🏁 Script executed:

#!/bin/bash# Find the packages/astro directory and look for test files
find packages/astro -type f \( -name '*.test.ts' -o -name '*.test.tsx' -o -name '*.spec.ts' -o -name '*.spec.tsx' -o -path '*/__tests__/*'\)| head -20
# Also check the structure of the packages/astro directoryecho"=== packages/astro structure ==="
find packages/astro -type d | head -20
# Search across all test files for cloudflare-related testsecho"=== Searching for cloudflare env tests ==="
rg 'cloudflare.*env|initCloudflareEnv' --type ts --type tsx 2>/dev/null ||echo"No matches found"# Look for getContextEnvVar or get-safe-env related testsecho"=== Searching for get-safe-env tests ==="
rg 'getSafeEnv|getContextEnvVar|get-safe-env' --type ts --type tsx 2>/dev/null | head -20 ||echo"No matches found"

Repository: clerk/javascript

Length of output: 995


🏁 Script executed:

#!/bin/bash# Read the complete get-safe-env.ts fileecho"=== packages/astro/src/server/get-safe-env.ts ==="
cat packages/astro/src/server/get-safe-env.ts
echo""echo"=== Checking if any test files import get-safe-env ==="
rg 'get-safe-env|getSafeEnv' packages/astro/src --type ts --type tsx
echo""echo"=== Contents of the existing test file ==="
cat packages/astro/src/internal/__tests__/create-clerk-instance.test.ts | head -100

Repository: clerk/javascript

Length of output: 8030


Add tests for the Cloudflare env fallback logic.

The new initCloudflareEnv() function and the cloudflareEnv fallback path in getContextEnvVar() (lines 20–33 and 47–50) lack test coverage. Add tests to verify that the fallback correctly imports from cloudflare:workers in Cloudflare environments and gracefully handles non-Cloudflare environments.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/astro/src/server/get-safe-env.ts` around lines 6 - 32, Add unit
tests covering the Cloudflare env fallback: write tests for initCloudflareEnv,
the cached cloudflareEnv value, and getContextEnvVar's fallback behavior when
cloudflare:workers is present and when it throws. In one test mock dynamic
import of the moduleName 'cloudflare:workers' to return an object with env
(e.g., {env: {KEY: "value"}}), call initCloudflareEnv() and assert cloudflareEnv
is set and getContextEnvVar('KEY') returns the mocked value; in another test
mock the dynamic import to throw, call initCloudflareEnv(), assert cloudflareEnv
becomes null and getContextEnvVar('KEY') falls back to the non-Cloudflare path.
Ensure tests reset/clear the cloudflareEnv cache between cases so caching
behavior is validated.


/**
* @internal
* Isomorphic handler for reading environment variables defined from Vite or are injected in the request context (CF Pages)
*/
function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: ContextOrLocals): string | undefined {
const locals = 'locals' in contextOrLocals ? contextOrLocals.locals : contextOrLocals;

if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
// Astro v6+ Cloudflare adapter: env from cloudflare:workers
// Checked first to avoid the expensive try/catch on locals.runtime.env,
// which throws on every call in Astro v6 Cloudflare environments.
if (cloudflareEnv) {
return cloudflareEnv[envVarName];
}

// Astro v4/v5 Cloudflare adapter: env is on locals.runtime.env
try {
if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
}
} catch {
// Astro v6 Cloudflare adapter throws when accessing locals.runtime.env
}

// Prefer process.env for runtime environments (e.g., Node.js adapter)
Expand DownExpand Up@@ -79,4 +119,4 @@ function getClientSafeEnv(context: ContextOrLocals) {
};
}

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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-astro-v6-cloudflare.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix compatibility with Astro v6 Cloudflare adapter by using `cloudflare:workers` env when `locals.runtime.env` is unavailable
2 changes: 1 addition & 1 deletion packages/astro/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,7 +100,7 @@
"astro": "^5.17.1"
},
"peerDependencies": {
"astro": "^4.15.0 || ^5.0.0"
"astro": "^4.15.0 || ^5.0.0 || ^6.0.0"
},
"engines": {
"node": ">=20.9.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/env.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ interface ImportMeta {

declare namespace App {
interface Locals {
runtime: { env: InternalEnv };
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
Expand Down
130 changes: 130 additions & 0 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,136 @@ function createLocals(overrides: Partial<App.Locals> = {}): App.Locals {
} as unknown as App.Locals;
}

describe('get-safe-env', () => {
beforeEach(() => {
vi.resetModules();
});

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

describe('initCloudflareEnv', () => {
it('caches env from cloudflare:workers when available', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_test_cf' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_test_cf');
});

it('sets cache to null when cloudflare:workers is not available', async () => {
vi.doMock('cloudflare:workers', () => {
throw new Error('Module not found');
});

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

// Should fall through to import.meta.env (undefined in test)
const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBeUndefined();
});

it('only imports once (caches result)', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
return { env: { CLERK_SECRET_KEY: 'sk_test_cf' } };
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});

it('only imports once even when cloudflare:workers throws', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
throw new Error('Module not found');
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});
});

describe('getContextEnvVar fallback chain', () => {
it('reads from locals.runtime.env (Astro v4/v5)', async () => {
const { getSafeEnv } = await import('../get-safe-env');
const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_runtime');
});

it('falls back to cloudflareEnv when locals.runtime.env is absent', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('falls back to cloudflareEnv when locals.runtime throws (Astro v6)', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

// Simulate Astro v6 behavior: accessing runtime throws
const locals = new Proxy(
{},
{
get(_, prop) {
if (prop === 'runtime') {
throw new Error('locals.runtime is not available in Astro v6 Cloudflare');
}
return undefined;
},
},
);

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('prefers cloudflareEnv over locals.runtime.env', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };
const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});
});
});

describe('getSafeEnv', () => {
beforeEach(() => {
vi.stubEnv('PUBLIC_CLERK_PUBLISHABLE_KEY', '');
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/server/clerk-middleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ 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 } from './get-safe-env';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
Expand DownExpand Up@@ -79,6 +79,8 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
return next();
}

await initCloudflareEnv();

const clerkRequest = createClerkRequest(context.request);

// Resolve keyless URLs per-request in development
Expand Down
46 changes: 43 additions & 3 deletions packages/astro/src/server/get-safe-env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,55 @@ import type { APIContext } from 'astro';

type ContextOrLocals = APIContext | APIContext['locals'];

/**
* Cached env object from `cloudflare:workers` for Astro v6+ Cloudflare adapter.
* - `undefined`: not yet attempted
* - `null`: attempted but not available (non-Cloudflare environment)
* - object: the env object from `cloudflare:workers`
*/
let cloudflareEnv: Record<string, string> | null | undefined;

/**
* @internal
* Attempts to import env from `cloudflare:workers` and caches the result.
* This is needed for Astro v6+ where `locals.runtime.env` is no longer available.
* Safe to call in non-Cloudflare environments — will no-op.
*/
async function initCloudflareEnv(): Promise<void> {
if (cloudflareEnv !== undefined) {
return;
}
try {
// Use a variable to prevent TypeScript from resolving the module specifier
const moduleName = 'cloudflare:workers';
const mod = await import(/* @vite-ignore */ moduleName);
cloudflareEnv = mod.env;
} catch {
cloudflareEnv = null;
}
}
Comment on lines +6 to +32

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Check whether any tests were changed in this PR
git diff --name-only origin/main...HEAD | rg -i '(__tests__|test|spec)\.(ts|tsx|js|jsx)$'# Search for existing tests covering the new Cloudflare env fallback path
rg -n 'initCloudflareEnv|getContextEnvVar|cloudflare:workers' \
-g '**/__tests__/**' -g '*.{test,spec}.{ts,tsx,js,jsx}'2>/dev/null ||true

Repository: clerk/javascript

Length of output: 100


🏁 Script executed:

#!/bin/bash# Find the packages/astro directory and look for test files
find packages/astro -type f \( -name '*.test.ts' -o -name '*.test.tsx' -o -name '*.spec.ts' -o -name '*.spec.tsx' -o -path '*/__tests__/*'\)| head -20
# Also check the structure of the packages/astro directoryecho"=== packages/astro structure ==="
find packages/astro -type d | head -20
# Search across all test files for cloudflare-related testsecho"=== Searching for cloudflare env tests ==="
rg 'cloudflare.*env|initCloudflareEnv' --type ts --type tsx 2>/dev/null ||echo"No matches found"# Look for getContextEnvVar or get-safe-env related testsecho"=== Searching for get-safe-env tests ==="
rg 'getSafeEnv|getContextEnvVar|get-safe-env' --type ts --type tsx 2>/dev/null | head -20 ||echo"No matches found"

Repository: clerk/javascript

Length of output: 995


🏁 Script executed:

#!/bin/bash# Read the complete get-safe-env.ts fileecho"=== packages/astro/src/server/get-safe-env.ts ==="
cat packages/astro/src/server/get-safe-env.ts
echo""echo"=== Checking if any test files import get-safe-env ==="
rg 'get-safe-env|getSafeEnv' packages/astro/src --type ts --type tsx
echo""echo"=== Contents of the existing test file ==="
cat packages/astro/src/internal/__tests__/create-clerk-instance.test.ts | head -100

Repository: clerk/javascript

Length of output: 8030


Add tests for the Cloudflare env fallback logic.

The new initCloudflareEnv() function and the cloudflareEnv fallback path in getContextEnvVar() (lines 20–33 and 47–50) lack test coverage. Add tests to verify that the fallback correctly imports from cloudflare:workers in Cloudflare environments and gracefully handles non-Cloudflare environments.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/astro/src/server/get-safe-env.ts` around lines 6 - 32, Add unit
tests covering the Cloudflare env fallback: write tests for initCloudflareEnv,
the cached cloudflareEnv value, and getContextEnvVar's fallback behavior when
cloudflare:workers is present and when it throws. In one test mock dynamic
import of the moduleName 'cloudflare:workers' to return an object with env
(e.g., {env: {KEY: "value"}}), call initCloudflareEnv() and assert cloudflareEnv
is set and getContextEnvVar('KEY') returns the mocked value; in another test
mock the dynamic import to throw, call initCloudflareEnv(), assert cloudflareEnv
becomes null and getContextEnvVar('KEY') falls back to the non-Cloudflare path.
Ensure tests reset/clear the cloudflareEnv cache between cases so caching
behavior is validated.


/**
* @internal
* Isomorphic handler for reading environment variables defined from Vite or are injected in the request context (CF Pages)
*/
function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: ContextOrLocals): string | undefined {
const locals = 'locals' in contextOrLocals ? contextOrLocals.locals : contextOrLocals;

if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
// Astro v6+ Cloudflare adapter: env from cloudflare:workers
// Checked first to avoid the expensive try/catch on locals.runtime.env,
// which throws on every call in Astro v6 Cloudflare environments.
if (cloudflareEnv) {
return cloudflareEnv[envVarName];
}

// Astro v4/v5 Cloudflare adapter: env is on locals.runtime.env
try {
if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
}
} catch {
// Astro v6 Cloudflare adapter throws when accessing locals.runtime.env
}

// Prefer process.env for runtime environments (e.g., Node.js adapter)
Expand DownExpand Up@@ -79,4 +119,4 @@ function getClientSafeEnv(context: ContextOrLocals) {
};
}

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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-astro-v6-cloudflare.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix compatibility with Astro v6 Cloudflare adapter by using `cloudflare:workers` env when `locals.runtime.env` is unavailable
2 changes: 1 addition & 1 deletion packages/astro/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,7 +100,7 @@
"astro": "^5.17.1"
},
"peerDependencies": {
"astro": "^4.15.0 || ^5.0.0"
"astro": "^4.15.0 || ^5.0.0 || ^6.0.0"
},
"engines": {
"node": ">=20.9.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/env.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ interface ImportMeta {

declare namespace App {
interface Locals {
runtime: { env: InternalEnv };
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
Expand Down
130 changes: 130 additions & 0 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,136 @@ function createLocals(overrides: Partial<App.Locals> = {}): App.Locals {
} as unknown as App.Locals;
}

describe('get-safe-env', () => {
beforeEach(() => {
vi.resetModules();
});

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

describe('initCloudflareEnv', () => {
it('caches env from cloudflare:workers when available', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_test_cf' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_test_cf');
});

it('sets cache to null when cloudflare:workers is not available', async () => {
vi.doMock('cloudflare:workers', () => {
throw new Error('Module not found');
});

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

// Should fall through to import.meta.env (undefined in test)
const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBeUndefined();
});

it('only imports once (caches result)', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
return { env: { CLERK_SECRET_KEY: 'sk_test_cf' } };
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});

it('only imports once even when cloudflare:workers throws', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
throw new Error('Module not found');
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});
});

describe('getContextEnvVar fallback chain', () => {
it('reads from locals.runtime.env (Astro v4/v5)', async () => {
const { getSafeEnv } = await import('../get-safe-env');
const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_runtime');
});

it('falls back to cloudflareEnv when locals.runtime.env is absent', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('falls back to cloudflareEnv when locals.runtime throws (Astro v6)', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

// Simulate Astro v6 behavior: accessing runtime throws
const locals = new Proxy(
{},
{
get(_, prop) {
if (prop === 'runtime') {
throw new Error('locals.runtime is not available in Astro v6 Cloudflare');
}
return undefined;
},
},
);

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('prefers cloudflareEnv over locals.runtime.env', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };
const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});
});
});

describe('getSafeEnv', () => {
beforeEach(() => {
vi.stubEnv('PUBLIC_CLERK_PUBLISHABLE_KEY', '');
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/server/clerk-middleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ 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 } from './get-safe-env';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
Expand DownExpand Up@@ -79,6 +79,8 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
return next();
}

await initCloudflareEnv();

const clerkRequest = createClerkRequest(context.request);

// Resolve keyless URLs per-request in development
Expand Down
46 changes: 43 additions & 3 deletions packages/astro/src/server/get-safe-env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,55 @@ import type { APIContext } from 'astro';

type ContextOrLocals = APIContext | APIContext['locals'];

/**
* Cached env object from `cloudflare:workers` for Astro v6+ Cloudflare adapter.
* - `undefined`: not yet attempted
* - `null`: attempted but not available (non-Cloudflare environment)
* - object: the env object from `cloudflare:workers`
*/
let cloudflareEnv: Record<string, string> | null | undefined;

/**
* @internal
* Attempts to import env from `cloudflare:workers` and caches the result.
* This is needed for Astro v6+ where `locals.runtime.env` is no longer available.
* Safe to call in non-Cloudflare environments — will no-op.
*/
async function initCloudflareEnv(): Promise<void> {
if (cloudflareEnv !== undefined) {
return;
}
try {
// Use a variable to prevent TypeScript from resolving the module specifier
const moduleName = 'cloudflare:workers';
const mod = await import(/* @vite-ignore */ moduleName);
cloudflareEnv = mod.env;
} catch {
cloudflareEnv = null;
}
}
Comment on lines +6 to +32

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Check whether any tests were changed in this PR
git diff --name-only origin/main...HEAD | rg -i '(__tests__|test|spec)\.(ts|tsx|js|jsx)$'# Search for existing tests covering the new Cloudflare env fallback path
rg -n 'initCloudflareEnv|getContextEnvVar|cloudflare:workers' \
-g '**/__tests__/**' -g '*.{test,spec}.{ts,tsx,js,jsx}'2>/dev/null ||true

Repository: clerk/javascript

Length of output: 100


🏁 Script executed:

#!/bin/bash# Find the packages/astro directory and look for test files
find packages/astro -type f \( -name '*.test.ts' -o -name '*.test.tsx' -o -name '*.spec.ts' -o -name '*.spec.tsx' -o -path '*/__tests__/*'\)| head -20
# Also check the structure of the packages/astro directoryecho"=== packages/astro structure ==="
find packages/astro -type d | head -20
# Search across all test files for cloudflare-related testsecho"=== Searching for cloudflare env tests ==="
rg 'cloudflare.*env|initCloudflareEnv' --type ts --type tsx 2>/dev/null ||echo"No matches found"# Look for getContextEnvVar or get-safe-env related testsecho"=== Searching for get-safe-env tests ==="
rg 'getSafeEnv|getContextEnvVar|get-safe-env' --type ts --type tsx 2>/dev/null | head -20 ||echo"No matches found"

Repository: clerk/javascript

Length of output: 995


🏁 Script executed:

#!/bin/bash# Read the complete get-safe-env.ts fileecho"=== packages/astro/src/server/get-safe-env.ts ==="
cat packages/astro/src/server/get-safe-env.ts
echo""echo"=== Checking if any test files import get-safe-env ==="
rg 'get-safe-env|getSafeEnv' packages/astro/src --type ts --type tsx
echo""echo"=== Contents of the existing test file ==="
cat packages/astro/src/internal/__tests__/create-clerk-instance.test.ts | head -100

Repository: clerk/javascript

Length of output: 8030


Add tests for the Cloudflare env fallback logic.

The new initCloudflareEnv() function and the cloudflareEnv fallback path in getContextEnvVar() (lines 20–33 and 47–50) lack test coverage. Add tests to verify that the fallback correctly imports from cloudflare:workers in Cloudflare environments and gracefully handles non-Cloudflare environments.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/astro/src/server/get-safe-env.ts` around lines 6 - 32, Add unit
tests covering the Cloudflare env fallback: write tests for initCloudflareEnv,
the cached cloudflareEnv value, and getContextEnvVar's fallback behavior when
cloudflare:workers is present and when it throws. In one test mock dynamic
import of the moduleName 'cloudflare:workers' to return an object with env
(e.g., {env: {KEY: "value"}}), call initCloudflareEnv() and assert cloudflareEnv
is set and getContextEnvVar('KEY') returns the mocked value; in another test
mock the dynamic import to throw, call initCloudflareEnv(), assert cloudflareEnv
becomes null and getContextEnvVar('KEY') falls back to the non-Cloudflare path.
Ensure tests reset/clear the cloudflareEnv cache between cases so caching
behavior is validated.


/**
* @internal
* Isomorphic handler for reading environment variables defined from Vite or are injected in the request context (CF Pages)
*/
function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: ContextOrLocals): string | undefined {
const locals = 'locals' in contextOrLocals ? contextOrLocals.locals : contextOrLocals;

if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
// Astro v6+ Cloudflare adapter: env from cloudflare:workers
// Checked first to avoid the expensive try/catch on locals.runtime.env,
// which throws on every call in Astro v6 Cloudflare environments.
if (cloudflareEnv) {
return cloudflareEnv[envVarName];
}

// Astro v4/v5 Cloudflare adapter: env is on locals.runtime.env
try {
if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
}
} catch {
// Astro v6 Cloudflare adapter throws when accessing locals.runtime.env
}

// Prefer process.env for runtime environments (e.g., Node.js adapter)
Expand DownExpand Up@@ -79,4 +119,4 @@ function getClientSafeEnv(context: ContextOrLocals) {
};
}

export { getSafeEnv, getClientSafeEnv };
export { getSafeEnv, getClientSafeEnv, initCloudflareEnv };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-astro-v6-cloudflare.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix compatibility with Astro v6 Cloudflare adapter by using `cloudflare:workers` env when `locals.runtime.env` is unavailable
2 changes: 1 addition & 1 deletion packages/astro/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,7 +100,7 @@
"astro": "^5.17.1"
},
"peerDependencies": {
"astro": "^4.15.0 || ^5.0.0"
"astro": "^4.15.0 || ^5.0.0 || ^6.0.0"
},
"engines": {
"node": ">=20.9.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/env.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ interface ImportMeta {

declare namespace App {
interface Locals {
runtime: { env: InternalEnv };
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
Expand Down
130 changes: 130 additions & 0 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,136 @@ function createLocals(overrides: Partial<App.Locals> = {}): App.Locals {
} as unknown as App.Locals;
}

describe('get-safe-env', () => {
beforeEach(() => {
vi.resetModules();
});

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

describe('initCloudflareEnv', () => {
it('caches env from cloudflare:workers when available', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_test_cf' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_test_cf');
});

it('sets cache to null when cloudflare:workers is not available', async () => {
vi.doMock('cloudflare:workers', () => {
throw new Error('Module not found');
});

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

// Should fall through to import.meta.env (undefined in test)
const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBeUndefined();
});

it('only imports once (caches result)', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
return { env: { CLERK_SECRET_KEY: 'sk_test_cf' } };
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});

it('only imports once even when cloudflare:workers throws', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
throw new Error('Module not found');
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});
});

describe('getContextEnvVar fallback chain', () => {
it('reads from locals.runtime.env (Astro v4/v5)', async () => {
const { getSafeEnv } = await import('../get-safe-env');
const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_runtime');
});

it('falls back to cloudflareEnv when locals.runtime.env is absent', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('falls back to cloudflareEnv when locals.runtime throws (Astro v6)', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

// Simulate Astro v6 behavior: accessing runtime throws
const locals = new Proxy(
{},
{
get(_, prop) {
if (prop === 'runtime') {
throw new Error('locals.runtime is not available in Astro v6 Cloudflare');
}
return undefined;
},
},
);

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('prefers cloudflareEnv over locals.runtime.env', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };
const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});
});
});

describe('getSafeEnv', () => {
beforeEach(() => {
vi.stubEnv('PUBLIC_CLERK_PUBLISHABLE_KEY', '');
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/server/clerk-middleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ 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 } from './get-safe-env';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
Expand DownExpand Up@@ -79,6 +79,8 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
return next();
}

await initCloudflareEnv();

const clerkRequest = createClerkRequest(context.request);

// Resolve keyless URLs per-request in development
Expand Down
46 changes: 43 additions & 3 deletions packages/astro/src/server/get-safe-env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,55 @@ import type { APIContext } from 'astro';

type ContextOrLocals = APIContext | APIContext['locals'];

/**
* Cached env object from `cloudflare:workers` for Astro v6+ Cloudflare adapter.
* - `undefined`: not yet attempted
* - `null`: attempted but not available (non-Cloudflare environment)
* - object: the env object from `cloudflare:workers`
*/
let cloudflareEnv: Record<string, string> | null | undefined;

/**
* @internal
* Attempts to import env from `cloudflare:workers` and caches the result.
* This is needed for Astro v6+ where `locals.runtime.env` is no longer available.
* Safe to call in non-Cloudflare environments — will no-op.
*/
async function initCloudflareEnv(): Promise<void> {
if (cloudflareEnv !== undefined) {
return;
}
try {
// Use a variable to prevent TypeScript from resolving the module specifier
const moduleName = 'cloudflare:workers';
const mod = await import(/* @vite-ignore */ moduleName);
cloudflareEnv = mod.env;
} catch {
cloudflareEnv = null;
}
}
Comment on lines +6 to +32

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Check whether any tests were changed in this PR
git diff --name-only origin/main...HEAD | rg -i '(__tests__|test|spec)\.(ts|tsx|js|jsx)$'# Search for existing tests covering the new Cloudflare env fallback path
rg -n 'initCloudflareEnv|getContextEnvVar|cloudflare:workers' \
-g '**/__tests__/**' -g '*.{test,spec}.{ts,tsx,js,jsx}'2>/dev/null ||true

Repository: clerk/javascript

Length of output: 100


🏁 Script executed:

#!/bin/bash# Find the packages/astro directory and look for test files
find packages/astro -type f \( -name '*.test.ts' -o -name '*.test.tsx' -o -name '*.spec.ts' -o -name '*.spec.tsx' -o -path '*/__tests__/*'\)| head -20
# Also check the structure of the packages/astro directoryecho"=== packages/astro structure ==="
find packages/astro -type d | head -20
# Search across all test files for cloudflare-related testsecho"=== Searching for cloudflare env tests ==="
rg 'cloudflare.*env|initCloudflareEnv' --type ts --type tsx 2>/dev/null ||echo"No matches found"# Look for getContextEnvVar or get-safe-env related testsecho"=== Searching for get-safe-env tests ==="
rg 'getSafeEnv|getContextEnvVar|get-safe-env' --type ts --type tsx 2>/dev/null | head -20 ||echo"No matches found"

Repository: clerk/javascript

Length of output: 995


🏁 Script executed:

#!/bin/bash# Read the complete get-safe-env.ts fileecho"=== packages/astro/src/server/get-safe-env.ts ==="
cat packages/astro/src/server/get-safe-env.ts
echo""echo"=== Checking if any test files import get-safe-env ==="
rg 'get-safe-env|getSafeEnv' packages/astro/src --type ts --type tsx
echo""echo"=== Contents of the existing test file ==="
cat packages/astro/src/internal/__tests__/create-clerk-instance.test.ts | head -100

Repository: clerk/javascript

Length of output: 8030


Add tests for the Cloudflare env fallback logic.

The new initCloudflareEnv() function and the cloudflareEnv fallback path in getContextEnvVar() (lines 20–33 and 47–50) lack test coverage. Add tests to verify that the fallback correctly imports from cloudflare:workers in Cloudflare environments and gracefully handles non-Cloudflare environments.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/astro/src/server/get-safe-env.ts` around lines 6 - 32, Add unit
tests covering the Cloudflare env fallback: write tests for initCloudflareEnv,
the cached cloudflareEnv value, and getContextEnvVar's fallback behavior when
cloudflare:workers is present and when it throws. In one test mock dynamic
import of the moduleName 'cloudflare:workers' to return an object with env
(e.g., {env: {KEY: "value"}}), call initCloudflareEnv() and assert cloudflareEnv
is set and getContextEnvVar('KEY') returns the mocked value; in another test
mock the dynamic import to throw, call initCloudflareEnv(), assert cloudflareEnv
becomes null and getContextEnvVar('KEY') falls back to the non-Cloudflare path.
Ensure tests reset/clear the cloudflareEnv cache between cases so caching
behavior is validated.


/**
* @internal
* Isomorphic handler for reading environment variables defined from Vite or are injected in the request context (CF Pages)
*/
function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: ContextOrLocals): string | undefined {
const locals = 'locals' in contextOrLocals ? contextOrLocals.locals : contextOrLocals;

if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
// Astro v6+ Cloudflare adapter: env from cloudflare:workers
// Checked first to avoid the expensive try/catch on locals.runtime.env,
// which throws on every call in Astro v6 Cloudflare environments.
if (cloudflareEnv) {
return cloudflareEnv[envVarName];
}

// Astro v4/v5 Cloudflare adapter: env is on locals.runtime.env
try {
if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
}
} catch {
// Astro v6 Cloudflare adapter throws when accessing locals.runtime.env
}

// Prefer process.env for runtime environments (e.g., Node.js adapter)
Expand DownExpand Up@@ -79,4 +119,4 @@ function getClientSafeEnv(context: ContextOrLocals) {
};
}

export { getSafeEnv, getClientSafeEnv };
export { getSafeEnv, getClientSafeEnv, initCloudflareEnv };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-astro-v6-cloudflare.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix compatibility with Astro v6 Cloudflare adapter by using `cloudflare:workers` env when `locals.runtime.env` is unavailable
2 changes: 1 addition & 1 deletion packages/astro/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,7 +100,7 @@
"astro": "^5.17.1"
},
"peerDependencies": {
"astro": "^4.15.0 || ^5.0.0"
"astro": "^4.15.0 || ^5.0.0 || ^6.0.0"
},
"engines": {
"node": ">=20.9.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/env.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ interface ImportMeta {

declare namespace App {
interface Locals {
runtime: { env: InternalEnv };
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
Expand Down
130 changes: 130 additions & 0 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,136 @@ function createLocals(overrides: Partial<App.Locals> = {}): App.Locals {
} as unknown as App.Locals;
}

describe('get-safe-env', () => {
beforeEach(() => {
vi.resetModules();
});

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

describe('initCloudflareEnv', () => {
it('caches env from cloudflare:workers when available', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_test_cf' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_test_cf');
});

it('sets cache to null when cloudflare:workers is not available', async () => {
vi.doMock('cloudflare:workers', () => {
throw new Error('Module not found');
});

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

// Should fall through to import.meta.env (undefined in test)
const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBeUndefined();
});

it('only imports once (caches result)', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
return { env: { CLERK_SECRET_KEY: 'sk_test_cf' } };
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});

it('only imports once even when cloudflare:workers throws', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
throw new Error('Module not found');
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});
});

describe('getContextEnvVar fallback chain', () => {
it('reads from locals.runtime.env (Astro v4/v5)', async () => {
const { getSafeEnv } = await import('../get-safe-env');
const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_runtime');
});

it('falls back to cloudflareEnv when locals.runtime.env is absent', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('falls back to cloudflareEnv when locals.runtime throws (Astro v6)', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

// Simulate Astro v6 behavior: accessing runtime throws
const locals = new Proxy(
{},
{
get(_, prop) {
if (prop === 'runtime') {
throw new Error('locals.runtime is not available in Astro v6 Cloudflare');
}
return undefined;
},
},
);

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('prefers cloudflareEnv over locals.runtime.env', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };
const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});
});
});

describe('getSafeEnv', () => {
beforeEach(() => {
vi.stubEnv('PUBLIC_CLERK_PUBLISHABLE_KEY', '');
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/server/clerk-middleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ 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 } from './get-safe-env';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
Expand DownExpand Up@@ -79,6 +79,8 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
return next();
}

await initCloudflareEnv();

const clerkRequest = createClerkRequest(context.request);

// Resolve keyless URLs per-request in development
Expand Down
46 changes: 43 additions & 3 deletions packages/astro/src/server/get-safe-env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,55 @@ import type { APIContext } from 'astro';

type ContextOrLocals = APIContext | APIContext['locals'];

/**
* Cached env object from `cloudflare:workers` for Astro v6+ Cloudflare adapter.
* - `undefined`: not yet attempted
* - `null`: attempted but not available (non-Cloudflare environment)
* - object: the env object from `cloudflare:workers`
*/
let cloudflareEnv: Record<string, string> | null | undefined;

/**
* @internal
* Attempts to import env from `cloudflare:workers` and caches the result.
* This is needed for Astro v6+ where `locals.runtime.env` is no longer available.
* Safe to call in non-Cloudflare environments — will no-op.
*/
async function initCloudflareEnv(): Promise<void> {
if (cloudflareEnv !== undefined) {
return;
}
try {
// Use a variable to prevent TypeScript from resolving the module specifier
const moduleName = 'cloudflare:workers';
const mod = await import(/* @vite-ignore */ moduleName);
cloudflareEnv = mod.env;
} catch {
cloudflareEnv = null;
}
}
Comment on lines +6 to +32

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Check whether any tests were changed in this PR
git diff --name-only origin/main...HEAD | rg -i '(__tests__|test|spec)\.(ts|tsx|js|jsx)$'# Search for existing tests covering the new Cloudflare env fallback path
rg -n 'initCloudflareEnv|getContextEnvVar|cloudflare:workers' \
-g '**/__tests__/**' -g '*.{test,spec}.{ts,tsx,js,jsx}'2>/dev/null ||true

Repository: clerk/javascript

Length of output: 100


🏁 Script executed:

#!/bin/bash# Find the packages/astro directory and look for test files
find packages/astro -type f \( -name '*.test.ts' -o -name '*.test.tsx' -o -name '*.spec.ts' -o -name '*.spec.tsx' -o -path '*/__tests__/*'\)| head -20
# Also check the structure of the packages/astro directoryecho"=== packages/astro structure ==="
find packages/astro -type d | head -20
# Search across all test files for cloudflare-related testsecho"=== Searching for cloudflare env tests ==="
rg 'cloudflare.*env|initCloudflareEnv' --type ts --type tsx 2>/dev/null ||echo"No matches found"# Look for getContextEnvVar or get-safe-env related testsecho"=== Searching for get-safe-env tests ==="
rg 'getSafeEnv|getContextEnvVar|get-safe-env' --type ts --type tsx 2>/dev/null | head -20 ||echo"No matches found"

Repository: clerk/javascript

Length of output: 995


🏁 Script executed:

#!/bin/bash# Read the complete get-safe-env.ts fileecho"=== packages/astro/src/server/get-safe-env.ts ==="
cat packages/astro/src/server/get-safe-env.ts
echo""echo"=== Checking if any test files import get-safe-env ==="
rg 'get-safe-env|getSafeEnv' packages/astro/src --type ts --type tsx
echo""echo"=== Contents of the existing test file ==="
cat packages/astro/src/internal/__tests__/create-clerk-instance.test.ts | head -100

Repository: clerk/javascript

Length of output: 8030


Add tests for the Cloudflare env fallback logic.

The new initCloudflareEnv() function and the cloudflareEnv fallback path in getContextEnvVar() (lines 20–33 and 47–50) lack test coverage. Add tests to verify that the fallback correctly imports from cloudflare:workers in Cloudflare environments and gracefully handles non-Cloudflare environments.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/astro/src/server/get-safe-env.ts` around lines 6 - 32, Add unit
tests covering the Cloudflare env fallback: write tests for initCloudflareEnv,
the cached cloudflareEnv value, and getContextEnvVar's fallback behavior when
cloudflare:workers is present and when it throws. In one test mock dynamic
import of the moduleName 'cloudflare:workers' to return an object with env
(e.g., {env: {KEY: "value"}}), call initCloudflareEnv() and assert cloudflareEnv
is set and getContextEnvVar('KEY') returns the mocked value; in another test
mock the dynamic import to throw, call initCloudflareEnv(), assert cloudflareEnv
becomes null and getContextEnvVar('KEY') falls back to the non-Cloudflare path.
Ensure tests reset/clear the cloudflareEnv cache between cases so caching
behavior is validated.


/**
* @internal
* Isomorphic handler for reading environment variables defined from Vite or are injected in the request context (CF Pages)
*/
function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: ContextOrLocals): string | undefined {
const locals = 'locals' in contextOrLocals ? contextOrLocals.locals : contextOrLocals;

if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
// Astro v6+ Cloudflare adapter: env from cloudflare:workers
// Checked first to avoid the expensive try/catch on locals.runtime.env,
// which throws on every call in Astro v6 Cloudflare environments.
if (cloudflareEnv) {
return cloudflareEnv[envVarName];
}

// Astro v4/v5 Cloudflare adapter: env is on locals.runtime.env
try {
if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
}
} catch {
// Astro v6 Cloudflare adapter throws when accessing locals.runtime.env
}

// Prefer process.env for runtime environments (e.g., Node.js adapter)
Expand DownExpand Up@@ -79,4 +119,4 @@ function getClientSafeEnv(context: ContextOrLocals) {
};
}

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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-astro-v6-cloudflare.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': patch
---

Fix compatibility with Astro v6 Cloudflare adapter by using `cloudflare:workers` env when `locals.runtime.env` is unavailable
2 changes: 1 addition & 1 deletion packages/astro/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,7 +100,7 @@
"astro": "^5.17.1"
},
"peerDependencies": {
"astro": "^4.15.0 || ^5.0.0"
"astro": "^4.15.0 || ^5.0.0 || ^6.0.0"
},
"engines": {
"node": ">=20.9.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/env.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ interface ImportMeta {

declare namespace App {
interface Locals {
runtime: { env: InternalEnv };
runtime?: { env: InternalEnv };
keylessClaimUrl?: string;
keylessApiKeysUrl?: string;
keylessPublishableKey?: string;
Expand Down
130 changes: 130 additions & 0 deletions packages/astro/src/server/__tests__/get-safe-env.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,136 @@ function createLocals(overrides: Partial<App.Locals> = {}): App.Locals {
} as unknown as App.Locals;
}

describe('get-safe-env', () => {
beforeEach(() => {
vi.resetModules();
});

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

describe('initCloudflareEnv', () => {
it('caches env from cloudflare:workers when available', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_test_cf' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_test_cf');
});

it('sets cache to null when cloudflare:workers is not available', async () => {
vi.doMock('cloudflare:workers', () => {
throw new Error('Module not found');
});

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');

await initCloudflareEnv();

// Should fall through to import.meta.env (undefined in test)
const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBeUndefined();
});

it('only imports once (caches result)', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
return { env: { CLERK_SECRET_KEY: 'sk_test_cf' } };
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});

it('only imports once even when cloudflare:workers throws', async () => {
let importCount = 0;
vi.doMock('cloudflare:workers', () => {
importCount++;
throw new Error('Module not found');
});

const { initCloudflareEnv } = await import('../get-safe-env');

await initCloudflareEnv();
await initCloudflareEnv();

expect(importCount).toBe(1);
});
});

describe('getContextEnvVar fallback chain', () => {
it('reads from locals.runtime.env (Astro v4/v5)', async () => {
const { getSafeEnv } = await import('../get-safe-env');
const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_runtime');
});

it('falls back to cloudflareEnv when locals.runtime.env is absent', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const env = getSafeEnv({ locals: {} } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('falls back to cloudflareEnv when locals.runtime throws (Astro v6)', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

// Simulate Astro v6 behavior: accessing runtime throws
const locals = new Proxy(
{},
{
get(_, prop) {
if (prop === 'runtime') {
throw new Error('locals.runtime is not available in Astro v6 Cloudflare');
}
return undefined;
},
},
);

const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});

it('prefers cloudflareEnv over locals.runtime.env', async () => {
vi.doMock('cloudflare:workers', () => ({
env: { CLERK_SECRET_KEY: 'sk_from_cf_workers' },
}));

const { initCloudflareEnv, getSafeEnv } = await import('../get-safe-env');
await initCloudflareEnv();

const locals = { runtime: { env: { CLERK_SECRET_KEY: 'sk_from_runtime' } } };
const env = getSafeEnv({ locals } as any);
expect(env.sk).toBe('sk_from_cf_workers');
});
});
});

describe('getSafeEnv', () => {
beforeEach(() => {
vi.stubEnv('PUBLIC_CLERK_PUBLISHABLE_KEY', '');
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/server/clerk-middleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ 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 } from './get-safe-env';
import { getClientSafeEnv, getSafeEnv, initCloudflareEnv } from './get-safe-env';
import { resolveKeysWithKeylessFallback } from './keyless/utils';
import { serverRedirectWithAuth } from './server-redirect-with-auth';
import type {
Expand DownExpand Up@@ -79,6 +79,8 @@ export const clerkMiddleware: ClerkMiddleware = (...args: unknown[]): any => {
return next();
}

await initCloudflareEnv();

const clerkRequest = createClerkRequest(context.request);

// Resolve keyless URLs per-request in development
Expand Down
46 changes: 43 additions & 3 deletions packages/astro/src/server/get-safe-env.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,55 @@ import type { APIContext } from 'astro';

type ContextOrLocals = APIContext | APIContext['locals'];

/**
* Cached env object from `cloudflare:workers` for Astro v6+ Cloudflare adapter.
* - `undefined`: not yet attempted
* - `null`: attempted but not available (non-Cloudflare environment)
* - object: the env object from `cloudflare:workers`
*/
let cloudflareEnv: Record<string, string> | null | undefined;

/**
* @internal
* Attempts to import env from `cloudflare:workers` and caches the result.
* This is needed for Astro v6+ where `locals.runtime.env` is no longer available.
* Safe to call in non-Cloudflare environments — will no-op.
*/
async function initCloudflareEnv(): Promise<void> {
if (cloudflareEnv !== undefined) {
return;
}
try {
// Use a variable to prevent TypeScript from resolving the module specifier
const moduleName = 'cloudflare:workers';
const mod = await import(/* @vite-ignore */ moduleName);
cloudflareEnv = mod.env;
} catch {
cloudflareEnv = null;
}
}
Comment on lines +6 to +32

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Check whether any tests were changed in this PR
git diff --name-only origin/main...HEAD | rg -i '(__tests__|test|spec)\.(ts|tsx|js|jsx)$'# Search for existing tests covering the new Cloudflare env fallback path
rg -n 'initCloudflareEnv|getContextEnvVar|cloudflare:workers' \
-g '**/__tests__/**' -g '*.{test,spec}.{ts,tsx,js,jsx}'2>/dev/null ||true

Repository: clerk/javascript

Length of output: 100


🏁 Script executed:

#!/bin/bash# Find the packages/astro directory and look for test files
find packages/astro -type f \( -name '*.test.ts' -o -name '*.test.tsx' -o -name '*.spec.ts' -o -name '*.spec.tsx' -o -path '*/__tests__/*'\)| head -20
# Also check the structure of the packages/astro directoryecho"=== packages/astro structure ==="
find packages/astro -type d | head -20
# Search across all test files for cloudflare-related testsecho"=== Searching for cloudflare env tests ==="
rg 'cloudflare.*env|initCloudflareEnv' --type ts --type tsx 2>/dev/null ||echo"No matches found"# Look for getContextEnvVar or get-safe-env related testsecho"=== Searching for get-safe-env tests ==="
rg 'getSafeEnv|getContextEnvVar|get-safe-env' --type ts --type tsx 2>/dev/null | head -20 ||echo"No matches found"

Repository: clerk/javascript

Length of output: 995


🏁 Script executed:

#!/bin/bash# Read the complete get-safe-env.ts fileecho"=== packages/astro/src/server/get-safe-env.ts ==="
cat packages/astro/src/server/get-safe-env.ts
echo""echo"=== Checking if any test files import get-safe-env ==="
rg 'get-safe-env|getSafeEnv' packages/astro/src --type ts --type tsx
echo""echo"=== Contents of the existing test file ==="
cat packages/astro/src/internal/__tests__/create-clerk-instance.test.ts | head -100

Repository: clerk/javascript

Length of output: 8030


Add tests for the Cloudflare env fallback logic.

The new initCloudflareEnv() function and the cloudflareEnv fallback path in getContextEnvVar() (lines 20–33 and 47–50) lack test coverage. Add tests to verify that the fallback correctly imports from cloudflare:workers in Cloudflare environments and gracefully handles non-Cloudflare environments.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/astro/src/server/get-safe-env.ts` around lines 6 - 32, Add unit
tests covering the Cloudflare env fallback: write tests for initCloudflareEnv,
the cached cloudflareEnv value, and getContextEnvVar's fallback behavior when
cloudflare:workers is present and when it throws. In one test mock dynamic
import of the moduleName 'cloudflare:workers' to return an object with env
(e.g., {env: {KEY: "value"}}), call initCloudflareEnv() and assert cloudflareEnv
is set and getContextEnvVar('KEY') returns the mocked value; in another test
mock the dynamic import to throw, call initCloudflareEnv(), assert cloudflareEnv
becomes null and getContextEnvVar('KEY') falls back to the non-Cloudflare path.
Ensure tests reset/clear the cloudflareEnv cache between cases so caching
behavior is validated.


/**
* @internal
* Isomorphic handler for reading environment variables defined from Vite or are injected in the request context (CF Pages)
*/
function getContextEnvVar(envVarName: keyof InternalEnv, contextOrLocals: ContextOrLocals): string | undefined {
const locals = 'locals' in contextOrLocals ? contextOrLocals.locals : contextOrLocals;

if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
// Astro v6+ Cloudflare adapter: env from cloudflare:workers
// Checked first to avoid the expensive try/catch on locals.runtime.env,
// which throws on every call in Astro v6 Cloudflare environments.
if (cloudflareEnv) {
return cloudflareEnv[envVarName];
}

// Astro v4/v5 Cloudflare adapter: env is on locals.runtime.env
try {
if (locals?.runtime?.env) {
return locals.runtime.env[envVarName];
}
} catch {
// Astro v6 Cloudflare adapter throws when accessing locals.runtime.env
}

// Prefer process.env for runtime environments (e.g., Node.js adapter)
Expand DownExpand Up@@ -79,4 +119,4 @@ function getClientSafeEnv(context: ContextOrLocals) {
};
}

export { getSafeEnv, getClientSafeEnv };
export { getSafeEnv, getClientSafeEnv, initCloudflareEnv };
Loading