Uh oh!
There was an error while loading. Please reload this page.
feat(shared): Add cloudflare:workers env fallback to getEnvVariable - #8196
feat(shared): Add cloudflare:workers env fallback to getEnvVariable#8196Chat-JPTeasdale wants to merge 1 commit into
Conversation
Add initCloudflareWorkersEnv() and cloudflare:workers module env check to the shared getEnvVariable() function. This allows Clerk to read environment variables directly from the Cloudflare Workers runtime, following the same pattern used in @clerk/astro (PRs clerk#7889, clerk#8136). Needed for TanStack Start, Hono, and other frameworks on CF Workers where process.env and import.meta.env are not available at runtime.
🦋 Changeset detectedLatest commit: 009a22c The changes in this PR will be included in the next version bump. This PR includes changesets to release 21 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
@ChatJPTeasdale is attempting to deploy a commit to the Clerk Production Team on Vercel. A member of the Team first needs to authorize it. |
JPTeasdale
commented
Mar 28, 2026
I’m JPTeasdale and I approve this message. It’s also possible that the tanstack-react-start package should be changed to pass in the context or locals parameter that already exists. Please advise on the best way to do this. |
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughA changeset and code modifications were introduced to 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
On Cloudflare Workers, process.env and import.meta.env are not available. This adds cloudflare:workers module env resolution to the TanStack Start package, following the pattern used in @clerk/react-router where loader context is passed to getEnvVariable(). - Add cloudflareEnv.ts with initCloudflareWorkerEnv() + getCloudflareWorkerEnv() - Initialize CF env in clerkMiddleware (no-op on non-CF runtimes) - Pass CF env context through commonEnvs() → getEnvVariable(name, context) - Update getPublicEnvVariables to accept optional context Related: clerk#8197 Alternative approach to PR clerk#8196 (shared-level fix)
Hello 👋 We currently close PRs after 60 days of inactivity. It's been 50 days since the last update here. If we missed this PR, please reply here. Otherwise, we'll close this PR in 10 days. Thanks for being a part of the Clerk community! 🙏 |
Description
Add
initCloudflareWorkersEnv()and acloudflare:workersmodule env check to the sharedgetEnvVariable()function in@clerk/shared.This allows Clerk to read environment variables (e.g.,
CLERK_SECRET_KEY,CLERK_PUBLISHABLE_KEY) directly from the Cloudflare Workers runtime environment, following the same pattern already used in@clerk/astro(PRs #7889, #8136).Problem
When using Clerk with frameworks running on Cloudflare Workers (e.g., TanStack Start, Hono),
process.envandimport.meta.envare not available at runtime. The currentgetEnvVariable()only falls back toglobalThis[name]for Workers, which doesn't work because Worker env vars are not set as globals — they're passed via the fetch handler'senvparameter or accessible via thecloudflare:workersmodule.Solution
cloudflareWorkersEnvvariable (same pattern as@clerk/astro'sget-safe-env.ts)initCloudflareWorkersEnv()that dynamically importscloudflare:workersand caches the env objectcloudflareWorkersEnv[name]before falling through to context-based checksWhy in
@clerk/shared?The Astro package has its own
get-safe-env.tswith this pattern, but other framework packages (@clerk/tanstack-react-start,@clerk/backend) importgetEnvVariablefrom@clerk/shared. Adding thecloudflare:workersfallback to the shared utility benefits all framework packages running on CF Workers without requiring per-package fixes.Checklist
pnpm buildruns as expected (no breaking changes — new export is additive)Type of change
Summary by CodeRabbit