Be certain that the vitest environment is not trolling our tests -- and fix @glimmer/env support by adding babel-plugin-debug-macros

Author: NullVoxPopuli

files/babel.config.cjs

@@ -4,6 +4,7 @@
  * (and linting)
  */
 const { buildMacros } = require('@embroider/macros/babel');
+const debugMacros = require('babel-plugin-debug-macros');
 
 const {
   babelCompatSupport,
@@ -42,6 +43,22 @@ module.exports = {
       },
     ],
     ...(isCompat ? babelCompatSupport() : macros.babelMacros),
+    // Can be removed if @glimmer/env isn't used in this project's dependency graph.
+    [
+      debugMacros,
+      {
+        flags: [
+          {
+            source: '@glimmer/env',
+            flags: {
+              DEBUG: true,
+              CI: false,
+            },
+          },
+        ],
+      },
+      '@glimmer/env stripping',
+    ],
   ],
 
   generatorOpts: {

files/package.json

@@ -54,6 +54,7 @@
     "@ember/library-tsconfig": "^1.0.0",<% } %>
     "@rollup/plugin-babel": "^6.0.4",<% if (typescript) { %>
     "@types/qunit": "^2.19.12",<% } %>
+    "babel-plugin-debug-macros": "^1.0.2",
     "babel-plugin-ember-template-compilation": "^2.2.5",
     "concurrently": "^9.0.1",
     "ember-qunit": "^9.0.2",

tests/smoke-tests/defaults.test.ts

@@ -36,8 +36,9 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
       addonDir = join(tmpDir, addonName);
       await execa({
         cwd: tmpDir,
+        extendEnv: false,
       })`${localEmberCli} addon ${addonName} -b ${blueprintPath} --skip-npm --skip-git --prefer-local true --${packageManager}`;
-      await execa({ cwd: addonDir })`${packageManager} install`;
+      await execa({ cwd: addonDir, extendEnv: false })`${packageManager} install`;
     });
 
     it('is using the correct packager', async () => {
@@ -97,13 +98,16 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
     // Tests are additive, so when running them in order, we want to check linting
     // before we add files from fixtures
     it('lints with no fixtures all pass', async () => {
-      let { exitCode } = await execa({ cwd: addonDir })`pnpm lint`;
+      let { exitCode } = await execa({ cwd: addonDir, extendEnv: false })`pnpm lint`;
 
       expect(exitCode).toEqual(0);
     });
 
     it('lint:fix with no fixtures', async () => {
-      let { exitCode } = await execa({ cwd: addonDir })`${packageManager} run lint:fix`;
+      let { exitCode } = await execa({
+        cwd: addonDir,
+        extendEnv: false,
+      })`${packageManager} run lint:fix`;
 
       expect(exitCode).toEqual(0);
     });
@@ -123,13 +127,19 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
       });
 
       it('lint:fix', async () => {
-        let { exitCode } = await execa({ cwd: addonDir })`${packageManager} run lint:fix`;
+        let { exitCode } = await execa({
+          cwd: addonDir,
+          extendEnv: false,
+        })`${packageManager} run lint:fix`;
 
         expect(exitCode).toEqual(0);
       });
 
       it('build', async () => {
-        let buildResult = await execa({ cwd: addonDir })`${packageManager} run build`;
+        let buildResult = await execa({
+          cwd: addonDir,
+          extendEnv: false,
+        })`${packageManager} run build`;
 
         expect(buildResult.exitCode).toEqual(0);
 
@@ -142,7 +152,11 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
         // It's important that we ensure that dist directory is empty for this test, because
         await fs.rm(join(addonDir, 'dist'), { recursive: true, force: true });
 
-        let testResult = await execa({ cwd: addonDir })`${packageManager} run test`;
+        console.log('in vitest', process.env.NODE_ENV, process.env.CI);
+        let testResult = await execa({
+          cwd: addonDir,
+          extendEnv: false,
+        })`${packageManager} run test`;
 
         expect(testResult.exitCode).toEqual(0);