Env var run summary data generation (vercel#4529)

This hoists the identification of environment mode much earlier in the process and captures the passthrough environment variables (hashed values included!) for run summary and `--dry=json`.
NicholasLYang · Apr 21, 2023 · c5f6568 · c5f6568
1 parent 6ac45a7
commit c5f6568
Show file tree

Hide file tree

Showing 33 changed files with 450 additions and 73 deletions.
diff --git a/.../strict_env_vars/fixture-configs/all.json → ...fixtures/strict_env_vars_configs/all.json b/.../strict_env_vars/fixture-configs/all.json → ...fixtures/strict_env_vars_configs/all.json
diff --git a/...vars/fixture-configs/global_pt-empty.json → ...ict_env_vars_configs/global_pt-empty.json b/...vars/fixture-configs/global_pt-empty.json → ...ict_env_vars_configs/global_pt-empty.json
diff --git a/...t_env_vars/fixture-configs/global_pt.json → ...es/strict_env_vars_configs/global_pt.json b/...t_env_vars/fixture-configs/global_pt.json → ...es/strict_env_vars_configs/global_pt.json
diff --git a/...v_vars/fixture-configs/task_pt-empty.json → ...trict_env_vars_configs/task_pt-empty.json b/...v_vars/fixture-configs/task_pt-empty.json → ...trict_env_vars_configs/task_pt-empty.json
diff --git a/...ict_env_vars/fixture-configs/task_pt.json → ...ures/strict_env_vars_configs/task_pt.json b/...ict_env_vars/fixture-configs/task_pt.json → ...ures/strict_env_vars_configs/task_pt.json
diff --git a/cli/integration_tests/dry_json/monorepo.t b/cli/integration_tests/dry_json/monorepo.t
@@ -72,6 +72,7 @@ Setup
 
   $ cat tmpjson.log | jq 'keys'
   [
+    "envMode",
     "globalCacheInputs",
     "id",
     "packages",
@@ -122,13 +123,16 @@ Setup
     },
     "expandedOutputs": [],
     "framework": "<NO FRAMEWORK DETECTED>",
+    "envMode": "loose",
     "environmentVariables": {
       "configured": [],
       "inferred": [],
       "global": [
         "SOME_ENV_VAR=",
         "VERCEL_ANALYTICS_ID="
-      ]
+      ],
+      "passthrough": null,
+      "globalPassthrough": null
     }
   }
 
@@ -170,6 +174,7 @@ Setup
     },
     "expandedOutputs": [],
     "framework": "<NO FRAMEWORK DETECTED>",
+    "envMode": "loose",
     "environmentVariables": {
       "configured": [
         "NODE_ENV="
@@ -178,7 +183,9 @@ Setup
       "global": [
         "SOME_ENV_VAR=",
         "VERCEL_ANALYTICS_ID="
-      ]
+      ],
+      "passthrough": null,
+      "globalPassthrough": null
     }
   }
 
@@ -192,7 +199,9 @@ Run again with NODE_ENV set and see the value in the summary. --filter=util work
     "global": [
       "SOME_ENV_VAR=",
       "VERCEL_ANALYTICS_ID="
-    ]
+    ],
+    "passthrough": null,
+    "globalPassthrough": null
   }
 
 Tasks that don't exist throw an error

diff --git a/cli/integration_tests/dry_json/single_package.t b/cli/integration_tests/dry_json/single_package.t
@@ -29,6 +29,7 @@ Setup
         }
       }
     },
+    "envMode": "infer",
     "tasks": [
       {
         "taskId": "build",
@@ -70,12 +71,15 @@ Setup
         },
         "expandedOutputs": [],
         "framework": "\u003cNO FRAMEWORK DETECTED\u003e",
+        "envMode": "loose",
         "environmentVariables": {
           "configured": [],
           "inferred": [],
           "global": [
             "VERCEL_ANALYTICS_ID="
-          ]
+          ],
+          "passthrough": null,
+          "globalPassthrough": null
         }
       }
     ]

diff --git a/cli/integration_tests/dry_json/single_package_no_config.t b/cli/integration_tests/dry_json/single_package_no_config.t
@@ -28,6 +28,7 @@ Setup
         }
       }
     },
+    "envMode": "infer",
     "tasks": [
       {
         "taskId": "build",
@@ -64,12 +65,15 @@ Setup
         },
         "expandedOutputs": [],
         "framework": "\u003cNO FRAMEWORK DETECTED\u003e",
+        "envMode": "loose",
         "environmentVariables": {
           "configured": [],
           "inferred": [],
           "global": [
             "VERCEL_ANALYTICS_ID="
-          ]
+          ],
+          "passthrough": null,
+          "globalPassthrough": null
         }
       }
     ]

diff --git a/cli/integration_tests/dry_json/single_package_with_deps.t b/cli/integration_tests/dry_json/single_package_with_deps.t
@@ -39,6 +39,7 @@ Setup
         }
       }
     },
+    "envMode": "infer",
     "tasks": [
       {
         "taskId": "build",
@@ -81,12 +82,15 @@ Setup
         },
         "expandedOutputs": [],
         "framework": "\u003cNO FRAMEWORK DETECTED\u003e",
+        "envMode": "loose",
         "environmentVariables": {
           "configured": [],
           "inferred": [],
           "global": [
             "VERCEL_ANALYTICS_ID="
-          ]
+          ],
+          "passthrough": null,
+          "globalPassthrough": null
         }
       },
       {
@@ -128,12 +132,15 @@ Setup
         },
         "expandedOutputs": [],
         "framework": "\u003cNO FRAMEWORK DETECTED\u003e",
+        "envMode": "loose",
         "environmentVariables": {
           "configured": [],
           "inferred": [],
           "global": [
             "VERCEL_ANALYTICS_ID="
-          ]
+          ],
+          "passthrough": null,
+          "globalPassthrough": null
         }
       }
     ]

diff --git a/cli/integration_tests/run_summary/error.t b/cli/integration_tests/run_summary/error.t
@@ -63,13 +63,16 @@ Validate that we got a full task summary for the failed task with an error in .e
     },
     "expandedOutputs": [],
     "framework": "",
+    "envMode": "loose",
     "environmentVariables": {
       "configured": [],
       "inferred": [],
       "global": [
         "SOME_ENV_VAR=",
         "VERCEL_ANALYTICS_ID="
-      ]
+      ],
+      "passthrough": null,
+      "globalPassthrough": null
     },
     "execution": {
       "startTime": [0-9]+, (re)

diff --git a/cli/integration_tests/run_summary/single-package.t b/cli/integration_tests/run_summary/single-package.t
@@ -51,6 +51,7 @@ Check
     "command",
     "dependencies",
     "dependents",
+    "envMode",
     "environmentVariables",
     "excludedOutputs",
     "execution",

diff --git a/cli/integration_tests/run_summary/strict_env.t b/cli/integration_tests/run_summary/strict_env.t
@@ -0,0 +1,206 @@
+Setup
+  $ . ${TESTDIR}/../_helpers/setup.sh
+  $ . ${TESTDIR}/../_helpers/setup_monorepo.sh $(pwd) strict_env_vars
+
+Set the env vars
+  $ export GLOBAL_VAR_PT=higlobalpt
+  $ export GLOBAL_VAR_DEP=higlobaldep
+  $ export LOCAL_VAR_PT=hilocalpt
+  $ export LOCAL_VAR_DEP=hilocaldep
+  $ export OTHER_VAR=hiother
+  $ export SYSTEMROOT=hisysroot
+
+Run as `infer`
+  $ rm -rf .turbo/runs
+  $ ${TURBO} run build --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  infer
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": null,
+    "globalPassthrough": null
+  }
+
+Run as `strict`
+  $ rm -rf .turbo/runs
+  $ ${TURBO} run build --experimental-env-mode=strict --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": null,
+    "globalPassthrough": null
+  }
+
+Run as `loose`
+  $ rm -rf .turbo/runs
+  $ ${TURBO} run build --experimental-env-mode=loose --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": null,
+    "globalPassthrough": null
+  }
+
+All specified + infer
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/all.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": [
+      "LOCAL_VAR_PT=7cd1bb19c058cf4d6ad6aa579d685bddddf3ab587b78bdcb1e6e488fb6f47a3b"
+    ],
+    "globalPassthrough": [
+      "GLOBAL_VAR_PT=cecd31fff1e723588eac8fe1edff89a6d2ec072f5c3bd884a98297487670b1f0"
+    ]
+  }
+
+All specified + loose
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/all.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --experimental-env-mode=loose --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": [
+      "LOCAL_VAR_PT=7cd1bb19c058cf4d6ad6aa579d685bddddf3ab587b78bdcb1e6e488fb6f47a3b"
+    ],
+    "globalPassthrough": [
+      "GLOBAL_VAR_PT=cecd31fff1e723588eac8fe1edff89a6d2ec072f5c3bd884a98297487670b1f0"
+    ]
+  }
+
+Global passthrough specified empty array + infer
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/global_pt-empty.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": null,
+    "globalPassthrough": []
+  }
+
+Global passthrough specified value + infer
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/global_pt.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": null,
+    "globalPassthrough": [
+      "GLOBAL_VAR_PT=cecd31fff1e723588eac8fe1edff89a6d2ec072f5c3bd884a98297487670b1f0"
+    ]
+  }
+
+Global passthrough specified empty array + loose
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/global_pt-empty.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --experimental-env-mode=loose --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": null,
+    "globalPassthrough": []
+  }
+
+Global passthrough specified value + loose
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/global_pt.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --experimental-env-mode=loose --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": null,
+    "globalPassthrough": [
+      "GLOBAL_VAR_PT=cecd31fff1e723588eac8fe1edff89a6d2ec072f5c3bd884a98297487670b1f0"
+    ]
+  }
+
+Task passthrough specified empty array + infer
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/task_pt-empty.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  infer
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": [],
+    "globalPassthrough": null
+  }
+
+Task passthrough specified value + infer
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/task_pt.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  infer
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  strict
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": [
+      "LOCAL_VAR_PT=7cd1bb19c058cf4d6ad6aa579d685bddddf3ab587b78bdcb1e6e488fb6f47a3b"
+    ],
+    "globalPassthrough": null
+  }
+
+Task passthrough specified empty array + loose
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/task_pt-empty.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --experimental-env-mode=loose --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": [],
+    "globalPassthrough": null
+  }
+
+Task passthrough specified value + loose
+  $ rm -rf .turbo/runs
+  $ cp "$TESTDIR/../_fixtures/strict_env_vars_configs/task_pt.json" "$(pwd)/turbo.json" && git commit --allow-empty -am "no comment" --quiet
+  $ ${TURBO} run build --experimental-env-mode=loose --summarize > /dev/null
+  $ cat .turbo/runs/*.json | jq -r '.envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].envMode'
+  loose
+  $ cat .turbo/runs/*.json | jq -r '.tasks[0].environmentVariables | {passthrough, globalPassthrough}'
+  {
+    "passthrough": [
+      "LOCAL_VAR_PT=7cd1bb19c058cf4d6ad6aa579d685bddddf3ab587b78bdcb1e6e488fb6f47a3b"
+    ],
+    "globalPassthrough": null
+  }