Add build mode tests (ensuring isDevelopingApp and isTesting are appropriately true when they need to be (as well as assert-stripping))

.gitignore

@@ -1,3 +1,3 @@
 /node_modules/
 .log/
-/my-addon/
+my-addon/

.prettierignore

@@ -3,6 +3,7 @@
 *.md
 files/
 tests/fixtures/
+my-addon/
 
 node_modules/
 

files/gitignore

@@ -15,3 +15,6 @@ ember-cli-build.cjs
 node_modules/
 .eslintcache
 .prettiercache
+
+# potentially containing secrets
+*.local

files/package.json

@@ -46,7 +46,7 @@
     "@embroider/addon-dev": "^8.1.0",
     "@embroider/compat": "^4.1.0",
     "@embroider/core": "^4.1.0",
-    "@embroider/macros": "^1.18.0",
+    "@embroider/macros": "^1.20.1",
     "@embroider/vite": "^1.1.5",
     "@eslint/js": "^9.17.0",
     "@glimmer/component": "^2.0.0<% if (typescript) { %>",

files/tests/test-helper.__ext__

@@ -4,6 +4,7 @@ import * as QUnit from 'qunit';
 import { setApplication } from '@ember/test-helpers';
 import { setup } from 'qunit-dom';
 import { start as qunitStart, setupEmberOnerrorValidation } from 'ember-qunit';
+import { setTesting } from '@embroider/macros';
 
 class Router extends EmberRouter {
   location = 'none';
@@ -21,6 +22,7 @@ class TestApp extends EmberApp {
 Router.map(function () {});
 
 export function start() {
+  setTesting(true);
   setApplication(
     TestApp.create({
       autoboot: false,

tests/fixtures/build-mode-tests/debug-utils-test.js

@@ -0,0 +1,33 @@
+import { test, module } from 'qunit';
+import { assert } from '@ember/debug';
+import { DEBUG } from '@glimmer/env';
+import { isDevelopingApp, isTesting } from '@embroider/macros';
+
+module('debug utils remain in the build', function () {
+  test('assert', function(qAssert) {
+    // If we get the build mode wrong, e.g.: `NODE_ENV` != 'development'
+    //   then the assert won't exist, causing qAssert to not detect a thrown Error 
+    qAssert.throws(() => {
+      assert('should throw');
+    }, /should throw/, `The error "should throw" is thrown`);
+  });
+
+  test('isTesting', function (assert) {
+    assert.strictEqual(isTesting(), true, `isTesting() === true`);
+  });
+
+  test('isDevelopingApp', function (assert) {
+    assert.strictEqual(isDevelopingApp(), true, `isDevelopingApp() === true`);
+  });
+
+
+  module('not supported', function () {
+    test('DEBUG', function (assert) {
+      if (DEBUG) {
+        assert.step('DEBUG');
+      }
+
+      assert.verifySteps([]);
+    });
+  });
+});

tests/helpers/utils.ts

@@ -48,6 +48,26 @@ export async function createTmp() {
   return tmpDirPath;
 }
 
+/**
+ * Returns a copy of the current process env with EMBER_, VITE_, and NODE_
+ * prefixed vars removed.
+ *
+ * Useful when spawning child processes with `extendEnv: false` so that
+ * vitest's NODE_ENV=test (and similar) doesn't leak into the child and
+ * interfere with the build-time / runtime macro mode detection.
+ */
+export function safeExecaEnv(): Record<string, string | undefined> {
+  let env = { ...process.env };
+
+  for (let key of Object.keys(env)) {
+    if (key.startsWith('EMBER_') || key.startsWith('VITE_') || key.startsWith('NODE_')) {
+      delete env[key];
+    }
+  }
+
+  return env;
+}
+
 /**
  * Abstraction for install, as the blueprint supports multiple package managers
  */

tests/package.json

@@ -10,7 +10,7 @@
     "@vitest/ui": "^0.18.0",
     "c8": "^7.11.3",
     "ember-cli": "github:ember-cli/ember-cli#master",
-    "execa": "^9.5.2",
+    "execa": "^9.6.0",
     "fixturify": "^3.0.0",
     "fs-extra": "^10.0.0",
     "globby": "^14.1.0",

tests/smoke-tests/--typescript.test.ts

@@ -7,9 +7,9 @@ import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
 
 import {
   assertGeneratedCorrectly,
-  dirContents,
   filesMatching,
   SUPPORTED_PACKAGE_MANAGERS,
+  safeExecaEnv,
 } from '../helpers.js';
 const blueprintPath = path.join(__dirname, '../..');
 let localEmberCli = require.resolve('ember-cli/bin/ember');
@@ -25,6 +25,8 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
         cwd: addonDir,
         shell: true,
         preferLocal: true,
+        extendEnv: false,
+        env: safeExecaEnv(),
         // Allows us to not fail yet when the command fails
         // but we'd still fail appropriately with the exitCode check below.
         // When we fail, we want to check for git diffs for debugging purposes.
@@ -50,13 +52,14 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
       addonDir = join(tmpDir, addonName);
       await execa({
         cwd: tmpDir,
+        extendEnv: false,
       })`${localEmberCli} addon ${addonName} -b ${blueprintPath} --skip-npm --prefer-local true --${packageManager} --typescript`;
       // Have to use --force because NPM is *stricter* when you use tags in package.json
       // than pnpm (in that tags don't match any specified stable version)
       if (packageManager === 'npm') {
-        await execa({ cwd: addonDir })`npm install --force`;
+        await execa({ cwd: addonDir, extendEnv: false })`npm install --force`;
       } else if (packageManager === 'pnpm') {
-        await execa({ cwd: addonDir })`pnpm install`;
+        await execa({ cwd: addonDir, extendEnv: false })`pnpm install`;
       }
     });
 

tests/smoke-tests/defaults.test.ts

@@ -14,6 +14,7 @@ import {
   dirContents,
   matchesFixture,
   packageJsonAt,
+  safeExecaEnv,
   SUPPORTED_PACKAGE_MANAGERS,
 } from '../helpers.js';
 import { existsSync } from 'node:fs';
@@ -38,8 +39,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 () => {
@@ -99,13 +101,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);
     });
@@ -124,16 +129,27 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
 
         let testFixture = fixturify.readSync('./fixtures/rendering-tests');
         fixturify.writeSync(join(addonDir, 'tests/rendering'), testFixture);
+
+        fixturify.writeSync(
+          join(addonDir, 'tests/unit'),
+          fixturify.readSync('./fixtures/build-mode-tests'),
+        );
       });
 
       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);
 
@@ -146,13 +162,24 @@ 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`;
+        let testResult = await execa({
+          cwd: addonDir,
+          extendEnv: false,
+          // a modified env required with extendEnv, else we still inherit/merge the env of vitest
+          // which overrides our NODE_ENV from our .env.development file (read by vite)
+          // (because in-shell ENV vars override .env files)
+          env: safeExecaEnv(),
+        })`${packageManager} run test`;
 
         expect(testResult.exitCode).toEqual(0);
 
+        expect(testResult.stdout).includes('debug utils remain in the build: assert');
+        expect(testResult.stdout).includes(
+          'debug utils remain in the build > not supported: DEBUG',
+        );
         expect(testResult.stdout).includes(
-          `# tests 2
-# pass  2
+          `# tests 6
+# pass  6
 # skip  0
 # todo  0
 # fail  0

tests/smoke-tests/try-scenarios.test.ts

@@ -23,7 +23,7 @@ describe('try-scenarios', () => {
         let addonDir = join(tmpDir, addonName);
 
         function runInAddon(command: string) {
-          const env = { ...scenario.env };
+          const env = { ...scenario.env, NODE_ENV: 'development' };
           console.log(`Running \`${command}\` with ${JSON.stringify(env)}`);
           return execa({ shell: true, preferLocal: true, cwd: addonDir, env })(command);
         }