fix(tanstack-start): Fix environment variable loading in runtime contexts by octoper · Pull Request #4743 · clerk/javascript

octoper · 2024-12-10T00:10:06Z

Description

The PR fixes an issue where environment variables are accessed global contexts, which doesn't work in runtimes like Cloudflare that only make them available during the request lifecycle.

Nitro environment variables guideline

Resolves ECO-288 and ECO-274

Checklist

pnpm test runs as expected.
pnpm build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

changeset-bot · 2024-12-10T00:10:09Z

🦋 Changeset detected

Latest commit: 6685212

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@clerk/tanstack-start	Patch

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

vercel · 2024-12-10T00:10:10Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 15, 2025 0:05am

octoper · 2024-12-10T00:10:25Z

!snapshot

clerk-cookie · 2024-12-10T00:12:51Z

Hey @octoper - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	2.0.1-snapshot.v20241210001110
@clerk/backend	1.20.3-snapshot.v20241210001110
@clerk/chrome-extension	2.0.9-snapshot.v20241210001110
@clerk/clerk-js	5.40.3-snapshot.v20241210001110
@clerk/elements	0.21.4-snapshot.v20241210001110
@clerk/clerk-expo	2.4.5-snapshot.v20241210001110
@clerk/expo-passkeys	0.0.17-snapshot.v20241210001110
@clerk/express	1.3.26-snapshot.v20241210001110
@clerk/fastify	2.0.28-snapshot.v20241210001110
@clerk/localizations	3.8.2-snapshot.v20241210001110
@clerk/nextjs	6.8.3-snapshot.v20241210001110
@clerk/nuxt	0.0.13-snapshot.v20241210001110
@clerk/clerk-react	5.19.3-snapshot.v20241210001110
@clerk/react-router	0.0.2-snapshot.v20241210001110
@clerk/remix	4.3.6-snapshot.v20241210001110
@clerk/clerk-sdk-node	5.0.77-snapshot.v20241210001110
@clerk/shared	2.19.4-snapshot.v20241210001110
@clerk/tanstack-start	0.7.0-snapshot.v20241210001110
@clerk/testing	1.3.38-snapshot.v20241210001110
@clerk/themes	2.1.55-snapshot.v20241210001110
@clerk/types	4.39.2-snapshot.v20241210001110
@clerk/ui	0.2.4-snapshot.v20241210001110
@clerk/vue	0.0.17-snapshot.v20241210001110

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/elements

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/expo-passkeys

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/localizations

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/nuxt

npm i @clerk/[email protected] --save-exact

@clerk/clerk-react

npm i @clerk/[email protected] --save-exact

@clerk/react-router

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/clerk-sdk-node

npm i @clerk/[email protected] --save-exact

@clerk/shared

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/themes

npm i @clerk/[email protected] --save-exact

@clerk/types

npm i @clerk/[email protected] --save-exact

@clerk/ui

npm i @clerk/[email protected] --save-exact

@clerk/vue

npm i @clerk/[email protected] --save-exact

…ck-start

…bles

wobsoriano · 2025-01-15T00:00:27Z

!snapshot

clerk-cookie · 2025-01-15T00:02:00Z

Hey @wobsoriano - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	2.1.8-snapshot.v20250115000107
@clerk/backend	1.22.1-snapshot.v20250115000107
@clerk/chrome-extension	2.1.12-snapshot.v20250115000107
@clerk/clerk-js	5.44.1-snapshot.v20250115000107
@clerk/clerk-expo	2.6.11-snapshot.v20250115000107
@clerk/express	1.3.35-snapshot.v20250115000107
@clerk/fastify	2.1.8-snapshot.v20250115000107
@clerk/nextjs	6.9.11-snapshot.v20250115000107
@clerk/nuxt	1.0.4-snapshot.v20250115000107
@clerk/react-router	0.1.9-snapshot.v20250115000107
@clerk/remix	4.4.10-snapshot.v20250115000107
@clerk/tanstack-start	0.8.9-snapshot.v20250115000107
@clerk/testing	1.4.8-snapshot.v20250115000107
@clerk/vue	1.0.3-snapshot.v20250115000107

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/nuxt

npm i @clerk/[email protected] --save-exact

@clerk/react-router

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/vue

npm i @clerk/[email protected] --save-exact

wobsoriano · 2025-01-15T00:16:57Z

+  // Cloudflare context check
+  const cfValue = event?.context?.cloudflare?.env[name];
+  if (cfValue) {
+    return cfValue;
+  }


Nitro injects the runtime env vars to the H3 event context. For Cloudflare, the property is event.context.cloudflare.

We pass this event object in a request lifecycle to make runtime env vars available

I answered the same question here.

…exts (#4743) Co-authored-by: Robert Soriano <[email protected]>

fix(tanstack-start): Fix ENV variable loading

f3a0440

clerk-cookie added the tanstack label Dec 10, 2024

Merge branch 'main' into vaggelis/eco-274-env-loading-issue-in-tansta…

3d3d3f6

…ck-start

vercel Bot deployed to Preview January 14, 2025 16:47 View deployment

chore(tanstack-start): Account for cloudflare env vars

cbe7a8a

vercel Bot temporarily deployed to Preview January 14, 2025 18:49 Inactive

chore(tanstack-start): Add vinxi import to external

ead2d4c

vercel Bot temporarily deployed to Preview January 14, 2025 20:26 Inactive

clerk deleted a comment from clerk-cookie Jan 14, 2025

chore(tanstack-start): Make sure vinxi imports run only on server

485b030

vercel Bot temporarily deployed to Preview January 14, 2025 20:46 Inactive

chore(tanstack-start): Pass event object when accessing runtime varia…

1ef88e5

…bles

vercel Bot temporarily deployed to Preview January 14, 2025 23:50 Inactive

chore(tanstack-start): Update event type

3a7d838

vercel Bot temporarily deployed to Preview January 14, 2025 23:55 Inactive

wobsoriano changed the title ~~fix(tanstack-start): Fix ENV variable loading~~ fix(tanstack-start): Improve environment variable resolution for runtime context Jan 14, 2025

chore: add changeset

b809d99

wobsoriano changed the title ~~fix(tanstack-start): Improve environment variable resolution for runtime context~~ fix(tanstack-start): Fix environment variable resolution for runtime context Jan 15, 2025

wobsoriano changed the title ~~fix(tanstack-start): Fix environment variable resolution for runtime context~~ fix(tanstack-start): Fix environment variable loading in runtime contexts Jan 15, 2025

chore: update changeset

6685212

vercel Bot deployed to Preview January 15, 2025 00:05 View deployment

wobsoriano reviewed Jan 15, 2025

View reviewed changes

wobsoriano marked this pull request as ready for review January 15, 2025 00:53

wobsoriano mentioned this pull request Jan 15, 2025

Unable to use @clerk/tanstack-start w/ Cloudflare deployment or local development #4632

Closed

4 tasks

wobsoriano requested review from LekoArts, anagstef and panteliselef January 15, 2025 14:12

LekoArts approved these changes Jan 15, 2025

View reviewed changes

wobsoriano merged commit bd5f050 into main Jan 15, 2025

wobsoriano deleted the vaggelis/eco-274-env-loading-issue-in-tanstack-start branch January 15, 2025 15:30

clerk-cookie mentioned this pull request Jan 15, 2025

ci(repo): Version packages #4885

Merged

wobsoriano mentioned this pull request Jan 21, 2025

does not find env vars when deployed to cloudflare using nextjs connector #4877

Closed

4 tasks

wobsoriano added a commit that referenced this pull request Feb 8, 2025

fix(tanstack-start): Fix environment variable loading in runtime cont…

3f7a4d7

…exts (#4743) Co-authored-by: Robert Soriano <[email protected]>

Navigation Menu

Uh oh!

fix(tanstack-start): Fix environment variable loading in runtime contexts - #4743

fix(tanstack-start): Fix environment variable loading in runtime contexts#4743
wobsoriano merged 9 commits into
mainfrom
vaggelis/eco-274-env-loading-issue-in-tanstack-start

octoper commented Dec 10, 2024 •

edited by wobsoriano

Loading

Uh oh!

changeset-bot Bot commented Dec 10, 2024 •

edited

Loading

Uh oh!

vercel Bot commented Dec 10, 2024 •

edited

Loading

Uh oh!

octoper commented Dec 10, 2024

Uh oh!

clerk-cookie commented Dec 10, 2024

Uh oh!

wobsoriano commented Jan 15, 2025

Uh oh!

clerk-cookie commented Jan 15, 2025

Uh oh!

wobsoriano Jan 15, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

octoper commented Dec 10, 2024 • edited by wobsoriano Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Uh oh!

changeset-bot Bot commented Dec 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel Bot commented Dec 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

octoper commented Dec 10, 2024

Uh oh!

clerk-cookie commented Dec 10, 2024

Uh oh!

wobsoriano commented Jan 15, 2025

Uh oh!

clerk-cookie commented Jan 15, 2025

Uh oh!

wobsoriano Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

octoper commented Dec 10, 2024 •

edited by wobsoriano

Loading

changeset-bot Bot commented Dec 10, 2024 •

edited

Loading

vercel Bot commented Dec 10, 2024 •

edited

Loading

wobsoriano Jan 15, 2025 •

edited

Loading