debug err

Author: RulaKhaled

dev-packages/node-integration-tests/utils/runner.ts

@@ -14,10 +14,10 @@ import type {
 import { normalize } from '@sentry/core';
 import { createBasicSentryServer } from '@sentry-internal/test-utils';
 import { execSync, spawn, spawnSync } from 'child_process';
-import { existsSync, mkdirSync, readFileSync, rmSync, unlinkSync, writeFileSync } from 'fs';
+import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'fs';
 import { basename, join } from 'path';
 import { inspect } from 'util';
-import { afterAll, beforeAll, describe, test } from 'vitest';
+import { afterAll, describe, test } from 'vitest';
 import {
   assertEnvelopeHeader,
   assertSentryCheckIn,
@@ -187,38 +187,29 @@ export function createEsmAndCjsTests(
     throw new Error(`Instrument file not found: ${mjsInstrumentPath}`);
   }
 
-  // If additionalDependencies are provided, we create a dedicated tmp directory that includes
-  // copied ESM & CJS scenario/instrument files and a nested package.json with those dependencies installed.
-  const useTmpDir = Boolean(options?.additionalDependencies && Object.keys(options.additionalDependencies).length > 0);
-
-  let tmpDirPath: string | undefined;
-  let esmScenarioPathForRun = mjsScenarioPath;
-  let esmInstrumentPathForRun = mjsInstrumentPath;
-  let cjsScenarioPath = join(cwd, `tmp_${scenarioPath.replace('.mjs', '.cjs')}`);
-  let cjsInstrumentPath = join(cwd, `tmp_${instrumentPath.replace('.mjs', '.cjs')}`);
-
-  if (useTmpDir) {
-    // Create unique tmp directory within the suite folder
-    const uniqueId = `${Date.now().toString(36)}_${Math.random().toString(36).slice(2, 8)}`;
-    tmpDirPath = join(cwd, `tmp_${uniqueId}`);
-    mkdirSync(tmpDirPath);
-
-    // Copy ESM files as-is into tmp dir
-    const esmScenarioBasename = basename(scenarioPath);
-    const esmInstrumentBasename = basename(instrumentPath);
-    esmScenarioPathForRun = join(tmpDirPath, esmScenarioBasename);
-    esmInstrumentPathForRun = join(tmpDirPath, esmInstrumentBasename);
-    writeFileSync(esmScenarioPathForRun, readFileSync(mjsScenarioPath, 'utf8'));
-    writeFileSync(esmInstrumentPathForRun, readFileSync(mjsInstrumentPath, 'utf8'));
-
-    // Pre-create CJS converted files inside tmp dir
-    cjsScenarioPath = join(tmpDirPath, esmScenarioBasename.replace('.mjs', '.cjs'));
-    cjsInstrumentPath = join(tmpDirPath, esmInstrumentBasename.replace('.mjs', '.cjs'));
-    convertEsmFileToCjs(esmScenarioPathForRun, cjsScenarioPath);
-    convertEsmFileToCjs(esmInstrumentPathForRun, cjsInstrumentPath);
-
-    // Create a minimal package.json with requested dependencies
-    const additionalDependencies = options?.additionalDependencies ?? {};
+  // Create a dedicated tmp directory that includes copied ESM & CJS scenario/instrument files.
+  // If additionalDependencies are provided, we also create a nested package.json and install them there.
+  const uniqueId = `${Date.now().toString(36)}_${Math.random().toString(36).slice(2, 8)}`;
+  const tmpDirPath = join(cwd, `tmp_${uniqueId}`);
+  mkdirSync(tmpDirPath);
+
+  // Copy ESM files as-is into tmp dir
+  const esmScenarioBasename = basename(scenarioPath);
+  const esmInstrumentBasename = basename(instrumentPath);
+  const esmScenarioPathForRun = join(tmpDirPath, esmScenarioBasename);
+  const esmInstrumentPathForRun = join(tmpDirPath, esmInstrumentBasename);
+  writeFileSync(esmScenarioPathForRun, readFileSync(mjsScenarioPath, 'utf8'));
+  writeFileSync(esmInstrumentPathForRun, readFileSync(mjsInstrumentPath, 'utf8'));
+
+  // Pre-create CJS converted files inside tmp dir
+  const cjsScenarioPath = join(tmpDirPath, esmScenarioBasename.replace('.mjs', '.cjs'));
+  const cjsInstrumentPath = join(tmpDirPath, esmInstrumentBasename.replace('.mjs', '.cjs'));
+  convertEsmFileToCjs(esmScenarioPathForRun, cjsScenarioPath);
+  convertEsmFileToCjs(esmInstrumentPathForRun, cjsInstrumentPath);
+
+  // Create a minimal package.json with requested dependencies (if any) and install them
+  const additionalDependencies = options?.additionalDependencies ?? {};
+  if (Object.keys(additionalDependencies).length > 0) {
     const packageJson = {
       name: 'tmp-integration-test',
       private: true,
@@ -228,7 +219,6 @@ export function createEsmAndCjsTests(
 
     writeFileSync(join(tmpDirPath, 'package.json'), JSON.stringify(packageJson, null, 2));
 
-    // Install the requested dependencies using yarn
     try {
       const deps = Object.entries(additionalDependencies).map(([name, range]) => {
         if (!range || typeof range !== 'string') {
@@ -238,11 +228,30 @@ export function createEsmAndCjsTests(
       });
 
       if (deps.length > 0) {
-        // Run yarn add non-interactively, keep output visible when DEBUG is set
-        spawnSync('yarn', ['add', '--non-interactive', ...deps], {
+        const result = spawnSync('yarn', ['add', '--non-interactive', ...deps], {
           cwd: tmpDirPath,
-          stdio: process.env.DEBUG ? 'inherit' : 'ignore',
+          encoding: 'utf8',
         });
+
+        if (process.env.DEBUG) {
+          // eslint-disable-next-line no-console
+          console.log('[additionalDependencies]', deps.join(' '));
+          // eslint-disable-next-line no-console
+          console.log('[yarn stdout]', result.stdout);
+          // eslint-disable-next-line no-console
+          console.log('[yarn stderr]', result.stderr);
+        }
+
+        if (result.error) {
+          throw new Error(`Failed to install additionalDependencies in tmp dir ${tmpDirPath}: ${result.error.message}`);
+        }
+        if (typeof result.status === 'number' && result.status !== 0) {
+          throw new Error(
+            `Failed to install additionalDependencies in tmp dir ${tmpDirPath} (exit ${result.status}):\n${
+              result.stderr || result.stdout || '(no output)'
+            }`,
+          );
+        }
       }
     } catch (e) {
       // eslint-disable-next-line no-console
@@ -257,40 +266,17 @@ export function createEsmAndCjsTests(
   });
 
   describe('cjs', () => {
-    if (!useTmpDir) {
-      beforeAll(() => {
-        // For the CJS runner, we create some temporary files...
-        convertEsmFileToCjs(mjsScenarioPath, cjsScenarioPath);
-        convertEsmFileToCjs(mjsInstrumentPath, cjsInstrumentPath);
-      });
-
-      afterAll(() => {
-        try {
-          unlinkSync(cjsInstrumentPath);
-        } catch {
-          // Ignore errors here
-        }
-        try {
-          unlinkSync(cjsScenarioPath);
-        } catch {
-          // Ignore errors here
+    // Clean up the tmp directory once CJS tests are finished
+    afterAll(() => {
+      try {
+        rmSync(tmpDirPath, { recursive: true, force: true });
+      } catch {
+        if (process.env.DEBUG) {
+          // eslint-disable-next-line no-console
+          console.error(`Failed to remove tmp dir: ${tmpDirPath}`);
         }
-      });
-    } else {
-      // When using a tmp dir, clean up the entire directory once CJS tests are finished
-      afterAll(() => {
-        if (tmpDirPath) {
-          try {
-            rmSync(tmpDirPath, { recursive: true, force: true });
-          } catch {
-            if (process.env.DEBUG) {
-              // eslint-disable-next-line no-console
-              console.error(`Failed to remove tmp dir: ${tmpDirPath}`);
-            }
-          }
-        }
-      });
-    }
+      }
+    });
 
     const testFn = options?.failsOnCjs ? test.fails : test;
     callback(() => createRunner(cjsScenarioPath).withFlags('--require', cjsInstrumentPath), testFn, 'cjs');