Deprecations cause `SourceMapper` to scan all `<source/>` files

[dantleech]

Q	A
PHPUnit version	11.5.3
PHP version	8.3
Installation Method	PHAR + Composer

Summary

Hi 👋

When deprecations are encountered the SouceMapper recursively scans all files for each <source> include and exclude paths.

This causes a siginficant pause in PHPUnit as it scans all these files, initially for 16 seconds until we isolated the issue and refined the <source> list - now it's "only" 3 seconds.

Current behavior

Scans all files when a deprecation is encountered.

How to reproduce

Add a <source> configuration:

    <source>
        <include>
            <directory suffix=".php">src/</directory>
            <directory suffix=".php">perhaps-another-directory-here/</directory>
        </include>
        <exclude>
            <directory suffix=".php">src/SubFolder</directory>
            <!-- maybe serveral more here -->
        </exclude>
    </source>

• Run a test that would trigger a deprecation
• Observe that source mapper will recursively iterate over all the files in the above paths.

https://github.com/sebastianbergmann/phpunit/blob/main/src/Runner/ErrorHandler.php#L178

Expected behavior

That a triggered deprecation would not scan all the files and block the test run for N seconds.

[dantleech]

Thankyou! unfortuantely it doesn't seem to fix the issue. I added some screen recording with some diagnostic output below

recording.mp4

This runs a specific test with --filter. The test triggers an E_DEPRECATION. I've then added debug output in the SourceMapper for each directory scanned.

[dantleech]

sorry had to remove the video due to it including unnecessary context, readded now.

[sebastianbergmann]

I cannot reproduce this:

diff --git a/src/TextUI/Configuration/SourceMapper.php b/src/TextUI/Configuration/SourceMapper.php
index cbe8aa4c65..d173a17ee7 100644
--- a/src/TextUI/Configuration/SourceMapper.php
+++ b/src/TextUI/Configuration/SourceMapper.php
@@ -9,6 +9,8 @@
  */
 namespace PHPUnit\TextUI\Configuration;
 
+use const FILE_APPEND;
+use function file_put_contents;
 use function realpath;
 use SebastianBergmann\FileIterator\Facade as FileIteratorFacade;
 use SplObjectStorage;
@@ -30,6 +32,8 @@ final class SourceMapper
      */
     public function map(Source $source): array
     {
+        file_put_contents('/tmp/debug.txt', '*', FILE_APPEND);
+
         if (self::$files === null) {
             self::$files = new SplObjectStorage;
         }

.
├── phpunit.xml
├── src
│   └── Issue6111.php
└── tests
    └── Issue6111Test.php

phpunit.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="../../../../phpunit.xsd"
         bootstrap="src/Issue6111.php"
>
    <testsuites>
        <testsuite name="default">
            <directory>tests</directory>
        </testsuite>
    </testsuites>

    <source ignoreIndirectDeprecations="true" restrictNotices="true" restrictWarnings="true">
        <include>
            <directory>src</directory>
        </include>
    </source>
</phpunit>

src/Issue6111.php

<?php declare(strict_types=1);
/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PHPUnit\TestFixture\Issue6111;

use const E_USER_DEPRECATED;
use function trigger_error;

final readonly class Issue6111
{
    public function doSomething(): bool
    {
        trigger_error('one', E_USER_DEPRECATED);
        trigger_error('two', E_USER_DEPRECATED);

        return true;
    }
}

src/Issue6111Test.php

<?php declare(strict_types=1);
/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PHPUnit\TestFixture\Issue6111;

use PHPUnit\Framework\TestCase;

final class Issue6111Test extends TestCase
{
    public function testOne(): void
    {
        $o = new Issue6111;

        $this->assertTrue($o->doSomething());
    }
}

❯ rm /tmp/debug.txt
❯ ll /tmp/debug.txt
ls: cannot access '/tmp/debug.txt': No such file or directory
❯ phpunit
PHPUnit 11.5.4-2-g339c2c8aad by Sebastian Bergmann and contributors.

Runtime:       PHP 8.4.3
Configuration: /usr/local/src/phpunit/tests/end-to-end/regression/6111/phpunit.xml

D                                                                   1 / 1 (100%)

Time: 00:00.017, Memory: 10.00 MB

OK, but there were issues!
Tests: 1, Assertions: 1, Deprecations: 2.
❯ cat /tmp/debug.txt
*

As you can see, and unless I am doing something stupid that I am missing, SourceMapper::map() is only called once while ErrorHandler::__invoke() (and ErrorHandler::trigger() in turn) is called twice to handle the two E_USER_DEPRECATED issues.

The only other place from where SourceMapper::map() is called that I can find is https://github.com/sebastianbergmann/phpunit/blob/11.5.4/src/TextUI/Configuration/CodeCoverageFilterRegistry.php#L65. I plan to refactor the code so that SourceMapper::map() is called at most once.

In the current state of PHPUnit 11.5.4, SourceMapper::map() is called at most twice: once when a deprecation needs to be handled, once when code coverage data is processed, and twice when a deprecation needs to be handled and code coverage data is processed.

What am I missing?

[dantleech]

Thanks - the problem is not that SourceMapper::map() is being called multiple times, it's that when it is called it is potentially very expensive as demonstrated in the screen recording (that was a single call to map).

I'll attempt to create a reproduction repo :)