Merge pull request #1971 from codeflash-ai/fix/vitest-coverage-excluded-files

fix: Improve error messaging for files excluded from Vitest coverage

Author: Saga4

codeflash/languages/function_optimizer.py

@@ -2787,6 +2787,25 @@ def establish_original_code_baseline(
             did_pass_all_tests = all(result.did_pass for result in behavioral_results)
             if not did_pass_all_tests:
                 return Failure("Tests failed to pass for the original code.")
+
+            # Check if coverage data was not found (file excluded from coverage)
+            from codeflash.models.models import CoverageStatus
+
+            if coverage_results and coverage_results.status == CoverageStatus.NOT_FOUND:
+                # File was not found in coverage data - likely excluded by test framework config
+                logger.warning(
+                    f"No coverage data found for {self.function_to_optimize.file_path}. "
+                    f"This file may be excluded from coverage collection by your test framework configuration "
+                    f"(e.g., coverage.exclude in vitest.config.ts for Vitest, or testMatch/coveragePathIgnorePatterns "
+                    f"for Jest). Tests ran successfully but coverage cannot be measured."
+                )
+                return Failure(
+                    f"Coverage data not found for {self.function_to_optimize.file_path}. "
+                    f"The file may be excluded from coverage by your test framework config. "
+                    f"Check coverage.exclude patterns in vitest.config.ts or jest.config.js."
+                )
+
+            # Normal coverage failure (tests ran but coverage below threshold)
             coverage_pct = coverage_results.coverage if coverage_results else 0
             return Failure(
                 f"Test coverage is {coverage_pct}%, which is below the required threshold of {COVERAGE_THRESHOLD}%."

tests/languages/javascript/test_vitest_coverage_exclusions.py

@@ -0,0 +1,125 @@
+"""Tests for handling Vitest coverage exclusions.
+
+These tests verify that Codeflash correctly detects and handles files
+that are excluded from coverage by vitest.config.ts, preventing false
+0% coverage reports.
+"""
+
+from __future__ import annotations
+
+import json
+import tempfile
+from pathlib import Path
+
+import pytest
+
+from codeflash.models.models import CodeOptimizationContext, CoverageStatus
+from codeflash.verification.coverage_utils import JestCoverageUtils
+
+
+class TestVitestCoverageExclusions:
+    """Tests for Vitest coverage exclusion handling."""
+
+    def test_missing_coverage_returns_not_found_status(self) -> None:
+        """Should return NOT_FOUND status when file is not in coverage data.
+
+        When a file is excluded from Vitest coverage (via coverage.exclude),
+        it won't appear in coverage-final.json. Codeflash should return
+        NOT_FOUND status (not PARSED_SUCCESSFULLY).
+
+        This test verifies the current behavior is correct at the coverage
+        parsing level. The issue is at a higher level (function_optimizer.py)
+        where NOT_FOUND status needs better handling.
+        """
+        with tempfile.TemporaryDirectory() as tmp_dir:
+            tmp_path = Path(tmp_dir)
+
+            # Create mock coverage-final.json that's missing the target file
+            coverage_file = tmp_path / "coverage-final.json"
+            coverage_data = {
+                "/workspace/project/src/utils/helpers.ts": {
+                    "fnMap": {},
+                    "s": {},
+                },
+                # src/agents/sandbox/fs-paths.ts is NOT here (excluded by Vitest)
+            }
+            with coverage_file.open("w") as f:
+                json.dump(coverage_data, f)
+
+            # Try to load coverage for a missing file
+            missing_file = Path("/workspace/project/src/agents/sandbox/fs-paths.ts")
+            from codeflash.models.models import CodeStringsMarkdown
+
+            mock_context = CodeOptimizationContext(
+                testgen_context=CodeStringsMarkdown(language="typescript"),
+                read_writable_code=CodeStringsMarkdown(language="typescript"),
+                helper_functions=[],
+                preexisting_objects=set(),
+            )
+
+            result = JestCoverageUtils.load_from_jest_json(
+                coverage_json_path=coverage_file,
+                function_name="parseSandboxBindMount",
+                code_context=mock_context,
+                source_code_path=missing_file,
+            )
+
+            # Should return NOT_FOUND when file not in coverage
+            assert result.status == CoverageStatus.NOT_FOUND, (
+                f"Expected NOT_FOUND for missing file, got {result.status}"
+            )
+            assert result.coverage == 0.0
+
+    def test_handles_included_file_normally(self) -> None:
+        """Should handle files that ARE included in coverage normally.
+
+        This test verifies that the fix doesn't break normal coverage parsing
+        for files that are NOT excluded.
+        """
+        with tempfile.TemporaryDirectory() as tmp_dir:
+            tmp_path = Path(tmp_dir)
+
+            # Create mock coverage-final.json with a valid file
+            coverage_file = tmp_path / "coverage-final.json"
+            test_file = "/workspace/project/src/utils/helpers.ts"
+            coverage_data = {
+                test_file: {
+                    "fnMap": {
+                        "0": {"name": "someHelper", "loc": {"start": {"line": 1}, "end": {"line": 5}}}
+                    },
+                    "statementMap": {
+                        "0": {"start": {"line": 2}, "end": {"line": 2}},
+                        "1": {"start": {"line": 3}, "end": {"line": 3}},
+                    },
+                    "s": {"0": 5, "1": 5},  # Both statements executed
+                    "branchMap": {},
+                    "b": {},
+                }
+            }
+            with coverage_file.open("w") as f:
+                json.dump(coverage_data, f)
+
+            source_file = Path(test_file)
+            from codeflash.models.models import CodeStringsMarkdown
+
+            mock_context = CodeOptimizationContext(
+                testgen_context=CodeStringsMarkdown(language="typescript"),
+                read_writable_code=CodeStringsMarkdown(language="typescript"),
+                helper_functions=[],
+                preexisting_objects=set(),
+            )
+
+            result = JestCoverageUtils.load_from_jest_json(
+                coverage_json_path=coverage_file,
+                function_name="someHelper",
+                code_context=mock_context,
+                source_code_path=source_file,
+            )
+
+            # Should parse successfully for non-excluded files
+            assert result.status == CoverageStatus.PARSED_SUCCESSFULLY
+            assert result.coverage > 0.0  # Should have actual coverage
+
+
+if __name__ == "__main__":
+    pytest.main([__file__, "-v"])

tests/languages/test_coverage_exclusion_message.py

@@ -0,0 +1,45 @@
+"""Test for coverage exclusion error message (Bug #5 regression test)."""
+
+from pathlib import Path
+
+from codeflash.models.function_types import FunctionToOptimize
+from codeflash.models.models import CodePosition
+
+
+def test_function_to_optimize_has_file_path_not_source_file_path():
+    """Test that FunctionToOptimize has file_path attribute, not source_file_path.
+
+    Regression test for Bug #5: Bug #1's fix used wrong attribute name 'source_file_path'
+    instead of 'file_path', causing AttributeError when constructing coverage error messages.
+
+    The bug occurred in function_optimizer.py lines 2797 and 2803:
+        f"No coverage data found for {self.function_to_optimize.source_file_path}."
+
+    This should be:
+        f"No coverage data found for {self.function_to_optimize.file_path}."
+
+    Trace ID: 5c4a75fb-d8eb-4f75-9e57-893f0c44b9c7
+    """
+    # Create a FunctionToOptimize object
+    func = FunctionToOptimize(
+        function_name="testFunc",
+        file_path=Path("/workspace/target/src/test.ts"),
+        starting_line=1,
+        ending_line=10,
+        code_position=CodePosition(line_no=1, col_no=0),
+        file_path_relative_to_project_root="src/test.ts",
+    )
+
+    # Verify correct attribute exists
+    assert hasattr(func, "file_path"), "FunctionToOptimize should have 'file_path' attribute"
+    assert func.file_path == Path("/workspace/target/src/test.ts")
+
+    # Verify wrong attribute does NOT exist
+    assert not hasattr(
+        func, "source_file_path"
+    ), "FunctionToOptimize should NOT have 'source_file_path' attribute (it's a typo/bug)"
+
+    # Verify we can access file_path in string formatting (like the bug location does)
+    error_message = f"No coverage data found for {func.file_path}."
+    assert "test.ts" in error_message
+    # This should NOT raise AttributeError