chore: make env mode strict by default #8182

chris-olszewski · 2024-05-21T04:43:46Z

Description

This change is being introduced to help users not accidentally hit cache. We've heard feedback that it's too easy to forget to add an env key, so this change will make it so your build fails when you do not have the variables needed available in the task runtime to build the package/application.

Note: This isn't foolproof, since the app/package could gracefully handle the missing variable - but it should save a lot of user pain as far as hitting unintended caches.

Commandeered from #8151

Changes default env mode to strict and remove the "infer" option

Testing Instructions

Existing test suite

(Currently some Windows integration tests are failing due to a missing env var, opening for review while I work on this)

vercel · 2024-05-21T04:43:50Z

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

Name	Status	Preview	Comments	Updated (UTC)
examples-basic-web	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	May 21, 2024 11:07pm
examples-nonmonorepo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 21, 2024 11:07pm
rust-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 21, 2024 11:07pm

7 Ignored Deployments

Name	Status	Preview	Updated (UTC)
examples-designsystem-docs	⬜️ Ignored (Inspect)	Visit Preview	May 21, 2024 11:07pm
examples-gatsby-web	⬜️ Ignored (Inspect)	Visit Preview	May 21, 2024 11:07pm
examples-kitchensink-blog	⬜️ Ignored (Inspect)	Visit Preview	May 21, 2024 11:07pm
examples-native-web	⬜️ Ignored (Inspect)	Visit Preview	May 21, 2024 11:07pm
examples-svelte-web	⬜️ Ignored (Inspect)	Visit Preview	May 21, 2024 11:07pm
examples-tailwind-web	⬜️ Ignored (Inspect)	Visit Preview	May 21, 2024 11:07pm
examples-vite-web	⬜️ Ignored (Inspect)	Visit Preview	May 21, 2024 11:07pm

github-actions · 2024-05-21T16:50:46Z

🟢 Turbopack Benchmark CI successful 🟢

Thanks

github-actions · 2024-05-21T17:12:30Z

🟢 CI successful 🟢

Thanks

chris-olszewski · 2024-05-21T23:07:31Z

crates/turborepo-lib/src/task_hash.rs

                let mut pass_through_env = EnvironmentVariableMap::default();
                let default_env_var_pass_through_map =
                    self.env_at_execution_start.from_wildcards(&[
                        "SHELL",
                        // Command Prompt casing of env variables
+                        "APPDATA",


This is necessary due to older versions of pnpm not having pnpm/npm-conf#10 which results in pnpm crashing if APPDATA isn't defined.

Technically we could have users define this instead of baking it into turbo itself, but considering the popularity of pnpm and the amount of digging it took to find that PR, it seems nice to include it.

### Description Commandeered from #8151 Changes default env mode to strict and remove the "infer" option ### Testing Instructions Existing test suite (Currently some Windows integration tests are failing due to a missing env var, opening for review while I work on this) --------- Co-authored-by: nicholaslyang <[email protected]>

andrevenancio · 2024-06-11T14:42:10Z

What was the motivation to change how environment variables are handled? I'm failing to understand based on your changelog's on turbo 2.0 and this PR (which you link from the changelog) WHY was this necessary. Why am I allowed to build and the environment variables aren't provided by default. My app if failing on vercel.com and the environment variables are there. Why do I need to be explicit on my turbo.json file to include variable A B or C? If the env variables are defined on my project dashboard then they all should be available.

I'm running turborepo 2.0 and my build isn't working anymore. even with --env-mode=loose.

Would be great to read somewhere why this change was necessary.
Thank you

Wizzel1 · 2024-06-20T20:00:39Z

What was the motivation to change how environment variables are handled? I'm failing to understand based on your changelog's on turbo 2.0 and this PR (which you link from the changelog) WHY was this necessary. Why am I allowed to build and the environment variables aren't provided by default. My app if failing on vercel.com and the environment variables are there. Why do I need to be explicit on my turbo.json file to include variable A B or C? If the env variables are defined on my project dashboard then they all should be available.

I'm running turborepo 2.0 and my build isn't working anymore. even with --env-mode=loose.

Would be great to read somewhere why this change was necessary. Thank you

Facing the same problem. After migration my environment variables are missing. Did you find a solution?

Turbo 2 requires being explicit about the env vars consumed in each task (not inheriting the parent tasks') vercel/turborepo#8182

* chore: Update turborepo to v2 * chore: Fix env bursting for e2e run task Turbo 2 requires being explicit about the env vars consumed in each task (not inheriting the parent tasks') vercel/turborepo#8182

yashsway · 2024-08-01T12:02:25Z

What was the motivation to change how environment variables are handled? I'm failing to understand based on your changelog's on turbo 2.0 and this PR (which you link from the changelog) WHY was this necessary. Why am I allowed to build and the environment variables aren't provided by default. My app if failing on vercel.com and the environment variables are there. Why do I need to be explicit on my turbo.json file to include variable A B or C? If the env variables are defined on my project dashboard then they all should be available.
I'm running turborepo 2.0 and my build isn't working anymore. even with --env-mode=loose.
Would be great to read somewhere why this change was necessary. Thank you

Facing the same problem. After migration my environment variables are missing. Did you find a solution?

Have the exact same issue as both of you @Wizzel1 @andrevenancio ! I've tried using env, globalEnv, globalPassThroughEnv, and --env-mode=loose directly and none of it is letting my CircleCI environment variables through. 😢 I know for sure that this is because of the 2.0 upgrade because it stopped working right after I upgraded Turbo to 2.0 which I've double-checked in the CircleCI workflow logs.

@chris-olszewski any idea what might be causing this?

turbo.json:

{
  "$schema": "https://turbo.build/schema.json",
  "globalDependencies": [
    "**/.env.*",
    "tsconfig.json",
    "tsconfig.base.json",
    "tsconfig.lib.json"
  ],
  "globalPassThroughEnv": ["CIRCLE_*", "VERCEL_*"],
  "tasks": {
    "build": {
      "dependsOn": ["^build"],
      "outputs": [
        "dist/**",
        "build/**",
        ".next/**",
        "!.next/cache/**",
        "lib/**"
      ]
    },
    "build:stage": {
      "dependsOn": ["^build"],
      "outputs": [
        "dist/**",
        "build/**",
        ".next/**",
        "!.next/cache/**",
        "lib/**"
      ]
    },
    "build:integration": {
      "dependsOn": ["^build"],
      "outputs": [
        "dist/**",
        "build/**",
        ".next/**",
        "!.next/cache/**",
        "lib/**"
      ]
    },
    "build:prod": {
      "dependsOn": ["^build"],
      "outputs": [
        "dist/**",
        "build/**",
        ".next/**",
        "!.next/cache/**",
        "lib/**"
      ]
    },
   // ... excluded rest for brevity
  }
}

package.json:

  "scripts": {
    "analyze": "turbo run analyze",
    "build": "turbo run build",
    "build:integration": "turbo --env-mode=loose run build:integration",
    "build:prod": "turbo --env-mode=loose run build:prod",
    "build:stage": "turbo --env-mode=loose run build:stage",
    // ... excluded rest for brevity
 }

turbo-orchestrator bot added created-by: turborepo owned-by: turborepo labels May 21, 2024

vercel bot deployed to Preview – rust-docs May 21, 2024 04:45 View deployment

chris-olszewski force-pushed the chrisolszewski/turbo-2706-make-env-mode-strict-by-default branch from 8643947 to 37c3c59 Compare May 21, 2024 16:49

vercel bot deployed to Preview – examples-nonmonorepo May 21, 2024 16:50 View deployment

NicholasLYang and others added 6 commits May 21, 2024 10:37

Removing infer env mode

2d73b7d

Update tests

7460895

Fixing bugs from moving to strict mode

8db7ec4

chore: fix clippy

e6b1b22

chore: update integration tests

56c1d88

chore: fix integration merge conflicts

e59b85c

chris-olszewski force-pushed the chrisolszewski/turbo-2706-make-env-mode-strict-by-default branch from 37c3c59 to e59b85c Compare May 21, 2024 18:46

vercel bot deployed to Preview – examples-nonmonorepo May 21, 2024 18:47 View deployment

vercel bot deployed to Preview – rust-docs May 21, 2024 18:49 View deployment

chore: fix snapshots

e8eb910

vercel bot deployed to Preview – examples-nonmonorepo May 21, 2024 20:40 View deployment

chore: fix regex for windows paths

afe4935

vercel bot deployed to Preview – examples-nonmonorepo May 21, 2024 20:50 View deployment

chore: fix windows paths

da26e0b

vercel bot deployed to Preview – examples-nonmonorepo May 21, 2024 21:35 View deployment

chris-olszewski marked this pull request as ready for review May 21, 2024 22:36

chris-olszewski requested a review from a team as a code owner May 21, 2024 22:36

chris-olszewski requested review from Zertsov, paulogdm, mehulkar and tknickman and removed request for paulogdm May 21, 2024 22:36

feat: pass through AppData by default

d95f107

vercel bot deployed to Preview – examples-nonmonorepo May 21, 2024 23:05 View deployment

vercel bot deployed to Preview – rust-docs May 21, 2024 23:07 View deployment

chris-olszewski commented May 21, 2024

View reviewed changes

mehulkar approved these changes May 22, 2024

View reviewed changes

chris-olszewski merged commit 68ab221 into turborepo_2 May 22, 2024
55 checks passed

chris-olszewski deleted the chrisolszewski/turbo-2706-make-env-mode-strict-by-default branch May 22, 2024 02:16

This was referenced Jun 19, 2024

Unauthorized cache warning #6765

Open

Turborepo hanging in CI #8281

Open

franky47 added a commit to 47ng/nuqs that referenced this pull request Jun 26, 2024

chore: Fix env bursting for e2e run task

b042599

Turbo 2 requires being explicit about the env vars consumed in each task (not inheriting the parent tasks') vercel/turborepo#8182

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: make env mode strict by default #8182

chore: make env mode strict by default #8182

chris-olszewski commented May 21, 2024 •

edited by anthonyshew

Loading

vercel bot commented May 21, 2024 •

edited

Loading

github-actions bot commented May 21, 2024 •

edited

Loading

github-actions bot commented May 21, 2024 •

edited

Loading

chris-olszewski May 21, 2024

andrevenancio commented Jun 11, 2024

Wizzel1 commented Jun 20, 2024

yashsway commented Aug 1, 2024 •

edited

Loading

chore: make env mode strict by default #8182

chore: make env mode strict by default #8182

Conversation

chris-olszewski commented May 21, 2024 • edited by anthonyshew Loading

Description

Testing Instructions

vercel bot commented May 21, 2024 • edited Loading

github-actions bot commented May 21, 2024 • edited Loading

🟢 Turbopack Benchmark CI successful 🟢

github-actions bot commented May 21, 2024 • edited Loading

🟢 CI successful 🟢

chris-olszewski May 21, 2024

Choose a reason for hiding this comment

andrevenancio commented Jun 11, 2024

Wizzel1 commented Jun 20, 2024

yashsway commented Aug 1, 2024 • edited Loading

chris-olszewski commented May 21, 2024 •

edited by anthonyshew

Loading

vercel bot commented May 21, 2024 •

edited

Loading

github-actions bot commented May 21, 2024 •

edited

Loading

github-actions bot commented May 21, 2024 •

edited

Loading

yashsway commented Aug 1, 2024 •

edited

Loading