More reliable environment setup for Jest running context

Author: yoannmoinet

packages/tests/src/_jest/globalSetup.ts

@@ -2,11 +2,15 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2019-Present Datadog, Inc.
 
-import { logTips } from './helpers/tips';
+import { getEnv, logEnv, setupEnv } from './helpers/env';
 
 const globalSetup = () => {
+    const env = getEnv(process.argv);
+    // Setup the environment.
+    setupEnv(env);
     // Log some tips to the console.
-    logTips();
+    logEnv(env);
+
 };
 
 export default globalSetup;

packages/tests/src/_jest/helpers/constants.ts

@@ -20,17 +20,3 @@ export const BUNDLER_VERSIONS: Record<BundlerFullName, string> = {
     webpack4: require('webpack4').version,
     webpack5: require('webpack5').version,
 };
-
-// Handle --cleanup flag.
-export const NO_CLEANUP = process.argv.includes('--cleanup=0');
-
-// Handle --build flag.
-export const NEED_BUILD = process.argv.includes('--build=1');
-
-// Handle --bundlers flag.
-export const REQUESTED_BUNDLERS = process.argv.includes('--bundlers')
-    ? process.argv[process.argv.indexOf('--bundlers') + 1].split(',')
-    : process.argv
-          .find((arg) => arg.startsWith('--bundlers='))
-          ?.split('=')[1]
-          .split(',') ?? [];

packages/tests/src/_jest/helpers/tips.ts renamed to packages/tests/src/_jest/helpers/env.ts

@@ -6,15 +6,59 @@ import { FULL_NAME_BUNDLERS } from '@dd/core/constants';
 import type { BundlerFullName } from '@dd/core/types';
 import { bgYellow, dim, green, red } from '@dd/tools/helpers';
 
-import { NEED_BUILD, NO_CLEANUP, REQUESTED_BUNDLERS } from './constants';
+type TestEnv = {
+    NO_CLEANUP: boolean;
+    NEED_BUILD: boolean;
+    REQUESTED_BUNDLERS: string[];
+};
+
+export const getEnv = (argv: string[]): TestEnv => {
+    // Handle --cleanup flag.
+    const NO_CLEANUP = argv.includes('--cleanup=0');
+
+    // Handle --build flag.
+    const NEED_BUILD = argv.includes('--build=1');
+
+    // Handle --bundlers flag.
+    const REQUESTED_BUNDLERS = argv.includes('--bundlers')
+        ? argv[argv.indexOf('--bundlers') + 1].split(',')
+        : argv
+              .find((arg) => arg.startsWith('--bundlers='))
+              ?.split('=')[1]
+              .split(',') ?? [];
+
+    return {
+        NO_CLEANUP,
+        NEED_BUILD,
+        REQUESTED_BUNDLERS,
+    };
+};
+
+export const setupEnv = (env: TestEnv): void => {
+    const { NO_CLEANUP, NEED_BUILD, REQUESTED_BUNDLERS } = env;
 
-export const logTips = () => {
     if (NO_CLEANUP) {
-        console.log(bgYellow(" Won't clean up "));
+        process.env.NO_CLEANUP = '1';
     }
 
     if (NEED_BUILD) {
-        console.log(bgYellow(' Will also build used plugins '));
+        process.env.NEED_BUILD = '1';
+    }
+
+    if (REQUESTED_BUNDLERS.length) {
+        process.env.REQUESTED_BUNDLERS = REQUESTED_BUNDLERS.join(',');
+    }
+};
+
+export const logEnv = (env: TestEnv) => {
+    const { NO_CLEANUP, NEED_BUILD, REQUESTED_BUNDLERS } = env;
+    const envLogs = [];
+    if (NO_CLEANUP) {
+        envLogs.push(bgYellow(" Won't clean up "));
+    }
+
+    if (NEED_BUILD) {
+        envLogs.push(bgYellow(' Will also build used plugins '));
     }
 
     if (REQUESTED_BUNDLERS.length) {
@@ -32,7 +76,7 @@ export const logTips = () => {
             );
         }
         const bundlersList = REQUESTED_BUNDLERS.map((bundler) => green(bundler)).join(', ');
-        console.log(`Running ${bgYellow(' ONLY ')} for ${bundlersList}.`);
+        envLogs.push(`Running ${bgYellow(' ONLY ')} for ${bundlersList}.`);
     }
 
     if (!NO_CLEANUP || !NEED_BUILD || REQUESTED_BUNDLERS.length) {
@@ -46,6 +90,10 @@ export const logTips = () => {
         if (!REQUESTED_BUNDLERS.length) {
             tips.push(`  ${green('--bundlers=webpack4,esbuild')} to only use specified bundlers.`);
         }
-        console.log(dim(`\nYou can also use : \n${tips.join('\n')}\n`));
+        envLogs.push(dim(`\nYou can also use : \n${tips.join('\n')}\n`));
+    }
+
+    if (envLogs.length) {
+        console.log(`\n${envLogs.join('\n')}\n`);
     }
 };

packages/tests/src/_jest/helpers/runBundlers.ts

@@ -20,9 +20,9 @@ import {
     getWebpack4Options,
     getWebpack5Options,
 } from './configBundlers';
-import { NEED_BUILD, NO_CLEANUP, PLUGIN_VERSIONS, REQUESTED_BUNDLERS } from './constants';
-import { defaultDestination } from './mocks';
-import type { Bundler, BundlerRunFunction, CleanupFn } from './types';
+
+// Get the environment variables.
+const { NO_CLEANUP, NEED_BUILD, REQUESTED_BUNDLERS } = process.env;
 
 const xpackCallback = (
     err: Error | null,
@@ -272,8 +272,9 @@ const allBundlers: Bundler[] = [
     },
 ];
 
+const requestedBundlers = REQUESTED_BUNDLERS ? REQUESTED_BUNDLERS.split(',') : [];
 export const BUNDLERS: Bundler[] = allBundlers.filter(
-    (bundler) => REQUESTED_BUNDLERS.length === 0 || REQUESTED_BUNDLERS.includes(bundler.name),
+    (bundler) => requestedBundlers.length === 0 || requestedBundlers.includes(bundler.name),
 );
 
 // Build only if needed.
@@ -284,6 +285,7 @@ if (NEED_BUILD) {
 
     for (const bundler of bundlersToBuild) {
         console.log(`Building ${green(bundler)}...`);
+        // Can't do parallel builds because no await at root.
         executeSync('yarn', ['workspace', bundler, 'run', 'build']);
     }
 }