Jest test file discovery is now performed uninstrumented

Author: cbasitodx

internal/framework/jest.go

@@ -18,7 +18,14 @@ import (
 	"github.com/DataDog/ddtest/internal/utils"
 )
 
-const binJestPath = "node_modules/.bin/jest"
+const (
+	binJestPath            = "node_modules/.bin/jest"
+	nodeOptionsEnvVar      = "NODE_OPTIONS"
+	ddTraceCIInitModule    = "dd-trace/ci/init"
+	nodeRequireShortArg    = "-r"
+	nodeRequireLongArg     = "--require"
+	nodeRequireLongArgWith = nodeRequireLongArg + "="
+)
 
 var ErrFullTestDiscoveryUnsupported = errors.New("full test discovery is not supported")
 
@@ -98,7 +105,7 @@ func (j *Jest) DiscoverTestFiles(ctx context.Context, testFiles discovery.TestFi
 	}
 
 	slog.Info("Discovering Jest test files with command", "command", command, "args", args)
-	output, err := j.executor.CombinedOutput(ctx, command, args, j.platformEnv)
+	output, err := j.executor.CombinedOutput(ctx, command, args, j.discoveryEnv())
 	if err != nil {
 		message := strings.TrimSpace(string(output))
 		if message == "" {
@@ -124,6 +131,23 @@ func (j *Jest) RunTests(ctx context.Context, testFiles []string, envMap map[stri
 	return j.executor.Run(ctx, command, args, mergedEnv)
 }
 
+func (j *Jest) discoveryEnv() map[string]string {
+	envMap := make(map[string]string, len(j.platformEnv)+1)
+	maps.Copy(envMap, j.platformEnv)
+
+	nodeOptions, ok := envMap[nodeOptionsEnvVar]
+	if !ok {
+		var found bool
+		nodeOptions, found = os.LookupEnv(nodeOptionsEnvVar)
+		if !found {
+			return envMap
+		}
+	}
+
+	envMap[nodeOptionsEnvVar] = stripNodeOptionsRequire(nodeOptions, ddTraceCIInitModule)
+	return envMap
+}
+
 // Decide between user custom command, local jest binary and npx jest
 func (j *Jest) getJestCommand() (string, []string) {
 	if len(j.commandOverride) > 0 {
@@ -143,6 +167,33 @@ func jestTestFileExtensionPattern() string {
 	return "{" + strings.Join(jestTestFileExtensions, ",") + "}"
 }
 
+func stripNodeOptionsRequire(nodeOptions string, module string) string {
+	fields := strings.Fields(nodeOptions)
+	stripped := make([]string, 0, len(fields))
+	for i := 0; i < len(fields); i++ {
+		field := fields[i]
+
+		if field == nodeRequireShortArg || field == nodeRequireLongArg {
+			if i+1 < len(fields) && fields[i+1] == module {
+				i++
+				continue
+			}
+		}
+
+		if strings.HasPrefix(field, nodeRequireShortArg) && strings.TrimPrefix(field, nodeRequireShortArg) == module {
+			continue
+		}
+
+		if strings.HasPrefix(field, nodeRequireLongArgWith) && strings.TrimPrefix(field, nodeRequireLongArgWith) == module {
+			continue
+		}
+
+		stripped = append(stripped, field)
+	}
+
+	return strings.Join(stripped, " ")
+}
+
 func parseJestListTestsOutput(output []byte) []string {
 	cwd, _ := os.Getwd()
 	if resolvedCwd, err := filepath.EvalSymlinks(cwd); err == nil {

internal/framework/jest_test.go

@@ -143,7 +143,7 @@ func TestJest_DiscoverTestFiles_UsesLocalJestListTests(t *testing.T) {
 	}
 	jest := &Jest{
 		executor:    mockExecutor,
-		platformEnv: map[string]string{"NODE_OPTIONS": "-r dd-trace/ci/init"},
+		platformEnv: map[string]string{"NODE_OPTIONS": "-r dd-trace/ci/init --max-old-space-size=4096", "CUSTOM_ENV": "value"},
 	}
 	files, err := jest.DiscoverTestFiles(context.Background(), discovery.TestFileSet{Pattern: jest.TestPattern()})
 	if err != nil {
@@ -157,8 +157,11 @@ func TestJest_DiscoverTestFiles_UsesLocalJestListTests(t *testing.T) {
 	if !slices.Equal(capturedArgs, expectedArgs) {
 		t.Errorf("expected args %v, got %v", expectedArgs, capturedArgs)
 	}
-	if mockExecutor.capturedEnvMap["NODE_OPTIONS"] != "-r dd-trace/ci/init" {
-		t.Errorf("expected NODE_OPTIONS from platform env, got %q", mockExecutor.capturedEnvMap["NODE_OPTIONS"])
+	if mockExecutor.capturedEnvMap["NODE_OPTIONS"] != "--max-old-space-size=4096" {
+		t.Errorf("expected NODE_OPTIONS without dd-trace init, got %q", mockExecutor.capturedEnvMap["NODE_OPTIONS"])
+	}
+	if mockExecutor.capturedEnvMap["CUSTOM_ENV"] != "value" {
+		t.Errorf("expected CUSTOM_ENV from platform env, got %q", mockExecutor.capturedEnvMap["CUSTOM_ENV"])
 	}
 
 	expectedFiles := []string{"src/b.test.ts", "src/foo.test.js"}
@@ -167,6 +170,40 @@ func TestJest_DiscoverTestFiles_UsesLocalJestListTests(t *testing.T) {
 	}
 }
 
+func TestJest_DiscoverTestFiles_StripsInheritedNodeOptions(t *testing.T) {
+	t.Setenv("NODE_OPTIONS", "--require dd-trace/ci/init --max-old-space-size=4096")
+
+	tempDir := t.TempDir()
+	oldWd, _ := os.Getwd()
+	defer func() { _ = os.Chdir(oldWd) }()
+	if err := os.Chdir(tempDir); err != nil {
+		t.Fatalf("failed to chdir: %v", err)
+	}
+	if err := os.MkdirAll("src", 0755); err != nil {
+		t.Fatalf("failed to create src dir: %v", err)
+	}
+	if err := os.WriteFile(filepath.Join("src", "a.test.js"), []byte("test"), 0644); err != nil {
+		t.Fatalf("failed to create test file: %v", err)
+	}
+
+	mockExecutor := &jestCommandExecutor{
+		output: []byte(filepath.Join(tempDir, "src", "a.test.js") + "\n"),
+	}
+	jest := &Jest{executor: mockExecutor, platformEnv: make(map[string]string)}
+
+	files, err := jest.DiscoverTestFiles(context.Background(), discovery.TestFileSet{Pattern: jest.TestPattern()})
+	if err != nil {
+		t.Fatalf("DiscoverTestFiles failed: %v", err)
+	}
+
+	if mockExecutor.capturedEnvMap["NODE_OPTIONS"] != "--max-old-space-size=4096" {
+		t.Errorf("expected inherited NODE_OPTIONS without dd-trace init, got %q", mockExecutor.capturedEnvMap["NODE_OPTIONS"])
+	}
+	if !slices.Equal(files, []string{"src/a.test.js"}) {
+		t.Errorf("expected discovered file, got %v", files)
+	}
+}
+
 func TestJest_DiscoverTestFiles_WithTestsLocationUsesTestMatch(t *testing.T) {
 	tempDir := t.TempDir()
 	oldWd, _ := os.Getwd()