Fix file path of trait errors reported directly in the trait by janedbal · Pull Request #5780 · phpstan/phpstan-src · GitHub

Problem

Since 2.2.0, an error originating inside a trait that is collapsed into a single error and reported once directly in the trait (via the new ConstantConditionInTraitRule → Error::removeTraitContext() path) ends up with an inconsistent file pair:

getFile() → the trait file (correct)
getFilePath() → the using class's file (stale)
getTraitFilePath() → null

removeTraitContext() moved file onto the trait file but left filePath pointing at the using-class file. Two things break as a result:

Inline @phpstan-ignore no longer suppresses the error (the regression reported in #14718). AnalyserResultFinalizer looks up line-ignores by getFilePath(), which points at the using-class file, so the ignore registered for the trait never matches.
The editorUrl link points at the wrong file. TableErrorFormatter builds it from getTraitFilePath() ?? getFilePath() → null ?? <using-class file>, i.e. the using-class file glued to the trait's line number.

Both worked correctly in 2.1.x.

Fix

Make filePath follow file onto the trait file in removeTraitContext(), the same way changeFilePath() keeps file and filePath in sync. One line.

Verification

Minimal reproduction: https://github.com/janedbal/phpstan-bug-14718-repro

Before (2.2.0): error reported despite the inline ignore, editor link → using-class file.
After: getFile() === getFilePath() === <trait file>, getTraitFilePath() === null.

Added a unit test in ErrorTest covering removeTraitContext().

Co-Authored-By: Claude Code

When an error inside a trait is reported once directly in the trait (Error::removeTraitContext()), the displayed file is moved to the trait file but filePath was left pointing at the using-class file. This broke inline @PHPStan-Ignore matching (looked up by filePath) and the editorUrl (getTraitFilePath() ?? getFilePath()), both resolving to the wrong file. Make filePath follow the file onto the trait, matching changeFilePath(). Fixes phpstan/phpstan#14718 Co-Authored-By: Claude Code

Would be nice to have the repro repo here in e2e/ and e2e-tests, showing all the behaviour described in the issue - non-working ignore comment, impossible baseline generation, problem disappearing with primed result cache etc.

Covers the behaviours from the issue against the fix: - inline @PHPStan-Ignore on a trait-deduplicated error suppresses it, consistently with an empty and a primed result cache - with the ignore removed, the error is reported in the trait file and a generated baseline records the trait file path, not the using-class file Co-Authored-By: Claude Code

Added e2e/bug-14718 + an e2e-tests job. The fixture is a trait used by two classes, with the deduplicated identical.alwaysFalse error reported directly in the trait. The job asserts, on the fixed build:

an inline // @phpstan-ignore on that error suppresses it (exit 0) — and stays suppressed with a primed result cache (the run is repeated without clearing);
with the ignore removed, the error is reported in the trait file, and --generate-baseline writes path: src/FooTrait.php (the trait file), not the using-class file.

For comparison, reverting the one-line fix flips all of these: the ignore is skipped, the editor URL / baseline path point at the using-class file (src/Foo.php).

One honest caveat: I could not reproduce the "error disappears on the second (primed-cache) run" facet in this minimal two-file fixture — it's deterministic across cache states here, so I didn't encode an assertion for it. That facet looks like it depends on the ConstantConditionInTraitRule dedup count() being sensitive to which files' collected data is restored from cache, which may need a larger setup (or be a separate concern). Happy to dig further or restructure the fixture if you have a setup in mind that triggers it.

Standalone repro repo (same case): https://github.com/janedbal/phpstan-bug-14718-repro

Note: (Claude anwering)

Superb, please fix the build and mark it as ready.

The phrase tripped PHPStan's own ignore.parseError rule during self-analysis. Reword the comment. Co-Authored-By: Claude Code

The identical.alwaysFalse error in MbFunctionsReturnTypeExtensionTrait (used by StrSplitFunctionReturnTypeExtension) is now attributed to the trait file instead of the using class, so move its baseline entry. Co-Authored-By: Claude Code

This pull request has been marked as ready for review.

Isn't this a BC break? The ignore work correctly before. It's a bit awkward, but for errors reported in traits, I think on current stable version, both the trait or the class path can be used in path in ignoreErrors.

This is achieved here:

phpstan-src/src/Analyser/Ignore/IgnoredErrorHelperResult.php

Lines 158 to 187 in 04d314d

    
           $filePath = $this->fileHelper->normalizePath($error->getFilePath()); 
        
           if (isset($this->ignoreErrorsByFile[$filePath])) { 
        
           	foreach ($this->ignoreErrorsByFile[$filePath] as $ignoreError) { 
        
           		$i = $ignoreError['index']; 
        
           		$ignore = $ignoreError['ignoreError']; 
        
           		$result = $processIgnoreError($error, $i, $ignore); 
        
           		if (!$result) { 
        
           			unset($errors[$errorIndex]); 
        
           			$ignoredErrors[] = [$error, $ignore]; 
        
           			continue 2; 
        
           		} 
        
           	} 
        
           } 
        
           $traitFilePath = $error->getTraitFilePath(); 
        
           if ($traitFilePath !== null) { 
        
           	$normalizedTraitFilePath = $this->fileHelper->normalizePath($traitFilePath); 
        
           	if (isset($this->ignoreErrorsByFile[$normalizedTraitFilePath])) { 
        
           		foreach ($this->ignoreErrorsByFile[$normalizedTraitFilePath] as $ignoreError) { 
        
           			$i = $ignoreError['index']; 
        
           			$ignore = $ignoreError['ignoreError']; 
        
           			$result = $processIgnoreError($error, $i, $ignore); 
        
           			if (!$result) { 
        
           				unset($errors[$errorIndex]); 
        
           				$ignoredErrors[] = [$error, $ignore]; 
        
           				continue 2; 
        
           			} 
        
           		} 
        
           	} 
        
           }

I suspect, wouldn't be a better place to fix this in FileAnalyser where @phpstan-ignore are processed?

The previous approach overwrote filePath with the trait path in removeTraitContext(), which broke ignoreErrors/baseline entries keyed on the using-class path - a BC break (both paths used to match). Instead, removeTraitContext() now keeps traitFilePath set, leaving filePath as the using-class file. As a result: - the editor URL resolves to the trait via getTraitFilePath() - IgnoredErrorHelperResult keeps matching BOTH the using-class path and the trait path, so no existing ignore/baseline breaks The inline @PHPStan-Ignore lookup for these collector errors is fixed at its actual processing site (AnalyserResultFinalizer, where collector errors are finalized) by selecting the ignore bucket with getTraitFilePath() ?? getFilePath(). Reverts the self-analysis baseline relocation, and reworks the e2e to assert both ignore paths and a clean baseline round-trip. Co-Authored-By: Claude Code

You're right that the previous commit was a BC break — overwriting filePath with the trait path made ignoreErrors/baseline entries keyed on the using-class path stop matching (the relocated self-analysis baseline entry was the tell).

New approach, pushed: removeTraitContext() now keeps traitFilePath instead of nulling it, and leaves filePath as the using-class file. So:

the editor URL resolves to the trait via getTraitFilePath();
IgnoredErrorHelperResult keeps matching both the using-class path and the trait path (the L158-187 dual lookup you linked) — no existing ignore/baseline breaks;
the self-analysis baseline relocation is reverted.

On your FileAnalyser suggestion: for these specific errors the inline @phpstan-ignore isn't processed in FileAnalyser — they're collector errors from ConstantConditionInTraitRule, deduplicated and finalized in AnalyserResultFinalizer, which is where the local-ignore lookup happens. The bug was that it picked the ignore bucket by getFilePath() (using-class) while the comment lives in the trait file, so I fixed it there by selecting the bucket with getTraitFilePath() ?? getFilePath(). Happy to move it if you had a different spot in mind.

The e2e now asserts both the trait-path and using-class-path ignoreErrors suppress the error, plus a clean --generate-baseline round-trip, across empty and primed result cache.

Note: (Claude answering)

Thank you!

janedbal added 2 commits May 29, 2026 15:19

Avoid literal ignore annotation in test comment

4066e77

The phrase tripped PHPStan's own ignore.parseError rule during self-analysis. Reword the comment. Co-Authored-By: Claude Code

janedbal marked this pull request as ready for review May 29, 2026 13:47

ondrejmirtes requested changes May 29, 2026

View reviewed changes

ondrejmirtes approved these changes Jun 2, 2026

View reviewed changes

ondrejmirtes merged commit c77c491 into phpstan:2.2.x Jun 2, 2026
665 of 668 checks passed

phpstan-bot mentioned this pull request Aug 3, 2026

Look up line ignores under the analysed file for trait errors reported in the context of a class #6174

Open

               			identifier: identical.alwaysFalse
               			count: 1
-              			path: ../src/Type/Php/StrSplitFunctionReturnTypeExtension.php
+              			path: ../src/Type/Php/MbFunctionsReturnTypeExtensionTrait.php

Fix file path of trait errors reported directly in the trait by janedbal · Pull Request #5780 · phpstan/phpstan-src · GitHub

Uh oh!

Fix file path of trait errors reported directly in the trait - #5780

Fix file path of trait errors reported directly in the trait#5780
ondrejmirtes merged 5 commits into
phpstan:2.2.xfrom
janedbal:fix-trait-error-file-path

janedbal commented May 29, 2026

Uh oh!

ondrejmirtes commented May 29, 2026

Uh oh!

janedbal commented May 29, 2026 •
edited
Loading

Uh oh!

Uh oh!

ondrejmirtes commented May 29, 2026

Uh oh!

phpstan-bot commented May 29, 2026

Uh oh!

ondrejmirtes May 29, 2026

Uh oh!

ondrejmirtes May 29, 2026

Uh oh!

janedbal commented Jun 1, 2026

Uh oh!

Uh oh!

ondrejmirtes commented Jun 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	$filePath = $this->fileHelper->normalizePath($error->getFilePath());
	if (isset($this->ignoreErrorsByFile[$filePath])) {
	foreach ($this->ignoreErrorsByFile[$filePath] as $ignoreError) {
	$i = $ignoreError['index'];
	$ignore = $ignoreError['ignoreError'];
	$result = $processIgnoreError($error, $i, $ignore);
	if (!$result) {
	unset($errors[$errorIndex]);
	$ignoredErrors[] = [$error, $ignore];
	continue 2;
	}
	}
	}

	$traitFilePath = $error->getTraitFilePath();
	if ($traitFilePath !== null) {
	$normalizedTraitFilePath = $this->fileHelper->normalizePath($traitFilePath);
	if (isset($this->ignoreErrorsByFile[$normalizedTraitFilePath])) {
	foreach ($this->ignoreErrorsByFile[$normalizedTraitFilePath] as $ignoreError) {
	$i = $ignoreError['index'];
	$ignore = $ignoreError['ignoreError'];
	$result = $processIgnoreError($error, $i, $ignore);
	if (!$result) {
	unset($errors[$errorIndex]);
	$ignoredErrors[] = [$error, $ignore];
	continue 2;
	}
	}
	}
	}

Fix file path of trait errors reported directly in the trait by janedbal · Pull Request #5780 · phpstan/phpstan-src · GitHub

Uh oh!

Fix file path of trait errors reported directly in the trait - #5780

Fix file path of trait errors reported directly in the trait#5780ondrejmirtes merged 5 commits intophpstan:2.2.xphpstan/phpstan-src:2.2.xfrom janedbal:fix-trait-error-file-pathjanedbal/phpstan-src:fix-trait-error-file-pathCopy head branch name to clipboard

Conversation

janedbal commented May 29, 2026

Problem

Fix

Verification

Uh oh!

ondrejmirtes commented May 29, 2026

Uh oh!

janedbal commented May 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ondrejmirtes commented May 29, 2026

Uh oh!

phpstan-bot commented May 29, 2026

Uh oh!

ondrejmirtes May 29, 2026

Choose a reason for hiding this comment

Uh oh!

ondrejmirtes May 29, 2026

Choose a reason for hiding this comment

Uh oh!

janedbal commented Jun 1, 2026

Uh oh!

Uh oh!

ondrejmirtes commented Jun 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix file path of trait errors reported directly in the trait#5780
ondrejmirtes merged 5 commits into
phpstan:2.2.xfrom
janedbal:fix-trait-error-file-path

janedbal commented May 29, 2026 •
edited
Loading