Implement ugly workaround to not emit Test\AssertionSucceeded and Test\AssertionFailed events when they have no subscribers

Author: sebastianbergmann

ChangeLog-10.0.md

@@ -2,6 +2,13 @@
 
 All notable changes of the PHPUnit 10.0 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
 
+## [10.0.14] - 2023-MM-DD
+
+### Changed
+
+* The `PHPUnit\Event\Test\AssertionSucceeded` and `PHPUnit\Event\Test\AssertionFailed` events are no longer emitted when they have no subscribers
+* The `PHPUnit\Event\Test\AssertionSucceeded::value()` method is no longer deprecated and return the exported value again
+
 ## [10.0.13] - 2023-02-27
 
 ### Fixed
@@ -50,7 +57,7 @@ All notable changes of the PHPUnit 10.0 release series are documented in this fi
 
 ### Changed
 
-* The `PHPUnit\Event\Test\AssertionSucceeded::value()` method is now deprecated and always returns `''`
+* The `PHPUnit\Event\Test\AssertionSucceeded::value()` method is now deprecated and always returns `''` (reverted in PHPUnit 10.0.14)
 
 ### Fixed
 
@@ -228,6 +235,7 @@ All notable changes of the PHPUnit 10.0 release series are documented in this fi
 * PHP 7.3, PHP 7.4, and PHP 8.0 are no longer supported
 * `phpunit/php-code-coverage` [no longer supports PHPDBG and Xdebug 2](https://github.com/sebastianbergmann/php-code-coverage/blob/10.0.0/ChangeLog.md#1000---2023-02-03)
 
+[10.0.14]: https://github.com/sebastianbergmann/phpunit/compare/10.0.13...10.0
 [10.0.13]: https://github.com/sebastianbergmann/phpunit/compare/10.0.12...10.0.13
 [10.0.12]: https://github.com/sebastianbergmann/phpunit/compare/10.0.11...10.0.12
 [10.0.11]: https://github.com/sebastianbergmann/phpunit/compare/10.0.10...10.0.11

src/Event/Dispatcher/DeferringDispatcher.php

@@ -34,6 +34,17 @@ public function registerSubscriber(Subscriber $subscriber): void
         $this->dispatcher->registerSubscriber($subscriber);
     }
 
+    /**
+     * @todo Remove this method once we found a better way to avoid creating event objects
+     *       that are expensive to create when there are no subscribers registered for them
+     *
+     * @see https://github.com/sebastianbergmann/phpunit/issues/5261
+     */
+    public function seal(): void
+    {
+        $this->dispatcher->seal();
+    }
+
     public function dispatch(Event $event): void
     {
         if ($this->recording) {

src/Event/Dispatcher/DirectDispatcher.php

@@ -10,9 +10,12 @@
 namespace PHPUnit\Event;
 
 use function array_key_exists;
+use function assert;
 use function dirname;
 use function sprintf;
 use function str_starts_with;
+use PHPUnit\Event\Test\AssertionFailedSubscriber;
+use PHPUnit\Event\Test\AssertionSucceededSubscriber;
 use Throwable;
 
 /**
@@ -37,6 +40,34 @@ public function __construct(TypeMap $map)
         $this->typeMap = $map;
     }
 
+    /**
+     * @todo Remove this method once we found a better way to avoid creating event objects
+     *       that are expensive to create when there are no subscribers registered for them
+     *
+     * @see https://github.com/sebastianbergmann/phpunit/issues/5261
+     */
+    public function seal(): void
+    {
+        $emitter = Facade::emitter();
+
+        assert($emitter instanceof DispatchingEmitter);
+
+        if (!empty($this->tracers)) {
+            $emitter->emitAssertionSucceededEvents();
+            $emitter->emitAssertionFailedEvents();
+
+            return;
+        }
+
+        if (isset($this->subscribers[AssertionSucceededSubscriber::class])) {
+            $emitter->emitAssertionSucceededEvents();
+        }
+
+        if (isset($this->subscribers[AssertionFailedSubscriber::class])) {
+            $emitter->emitAssertionFailedEvents();
+        }
+    }
+
     public function registerTracer(Tracer\Tracer $tracer): void
     {
         $this->tracers[] = $tracer;

src/Event/Dispatcher/SubscribableDispatcher.php

@@ -20,4 +20,12 @@ interface SubscribableDispatcher extends Dispatcher
     public function registerSubscriber(Subscriber $subscriber): void;
 
     public function registerTracer(Tracer\Tracer $tracer): void;
+
+    /**
+     * @todo Remove this method once we found a better way to avoid creating event objects
+     *       that are expensive to create when there are no subscribers registered for them
+     *
+     * @see https://github.com/sebastianbergmann/phpunit/issues/5261
+     */
+    public function seal(): void;
 }

src/Event/Emitter/DispatchingEmitter.php

@@ -31,6 +31,8 @@ final class DispatchingEmitter implements Emitter
     private readonly Telemetry\System $system;
     private readonly Telemetry\Snapshot $startSnapshot;
     private Telemetry\Snapshot $previousSnapshot;
+    private bool $emitAssertionSucceededEvents = false;
+    private bool $emitAssertionFailedEvents    = false;
 
     public function __construct(Dispatcher $dispatcher, Telemetry\System $system)
     {
@@ -41,6 +43,50 @@ public function __construct(Dispatcher $dispatcher, Telemetry\System $system)
         $this->previousSnapshot = $system->snapshot();
     }
 
+    /**
+     * @todo Remove this method once we found a better way to avoid creating event objects
+     *       that are expensive to create when there are no subscribers registered for them
+     *
+     * @see https://github.com/sebastianbergmann/phpunit/issues/5261
+     */
+    public function emitAssertionSucceededEvents(): void
+    {
+        $this->emitAssertionSucceededEvents = true;
+    }
+
+    /**
+     * @todo Remove this method once we found a better way to avoid creating event objects
+     *       that are expensive to create when there are no subscribers registered for them
+     *
+     * @see https://github.com/sebastianbergmann/phpunit/issues/5261
+     */
+    public function emitsAssertionSucceededEvents(): bool
+    {
+        return $this->emitAssertionSucceededEvents;
+    }
+
+    /**
+     * @todo Remove this method once we found a better way to avoid creating event objects
+     *       that are expensive to create when there are no subscribers registered for them
+     *
+     * @see https://github.com/sebastianbergmann/phpunit/issues/5261
+     */
+    public function emitAssertionFailedEvents(): void
+    {
+        $this->emitAssertionFailedEvents = true;
+    }
+
+    /**
+     * @todo Remove this method once we found a better way to avoid creating event objects
+     *       that are expensive to create when there are no subscribers registered for them
+     *
+     * @see https://github.com/sebastianbergmann/phpunit/issues/5261
+     */
+    public function emitsAssertionFailedEvents(): bool
+    {
+        return $this->emitAssertionFailedEvents;
+    }
+
     /**
      * @throws InvalidArgumentException
      * @throws UnknownEventTypeException
@@ -400,10 +446,14 @@ public function testRegisteredComparator(string $className): void
      */
     public function testAssertionSucceeded(mixed $value, Constraint\Constraint $constraint, string $message): void
     {
+        if (!$this->emitAssertionSucceededEvents) {
+            return;
+        }
+
         $this->dispatcher->dispatch(
             new Test\AssertionSucceeded(
                 $this->telemetryInfo(),
-                '',
+                (new Exporter)->export($value),
                 $constraint->toString(),
                 $constraint->count(),
                 $message,
@@ -417,6 +467,10 @@ public function testAssertionSucceeded(mixed $value, Constraint\Constraint $cons
      */
     public function testAssertionFailed(mixed $value, Constraint\Constraint $constraint, string $message): void
     {
+        if (!$this->emitAssertionFailedEvents) {
+            return;
+        }
+
         $this->dispatcher->dispatch(
             new Test\AssertionFailed(
                 $this->telemetryInfo(),

src/Event/Events/Test/Assertion/AssertionSucceeded.php

@@ -19,13 +19,15 @@
 final class AssertionSucceeded implements Event
 {
     private readonly Telemetry\Info $telemetryInfo;
+    private readonly string $value;
     private readonly string $constraint;
     private readonly int $count;
     private readonly string $message;
 
     public function __construct(Telemetry\Info $telemetryInfo, string $value, string $constraint, int $count, string $message)
     {
         $this->telemetryInfo = $telemetryInfo;
+        $this->value         = $value;
         $this->constraint    = $constraint;
         $this->count         = $count;
         $this->message       = $message;
@@ -36,12 +38,9 @@ public function telemetryInfo(): Telemetry\Info
         return $this->telemetryInfo;
     }
 
-    /**
-     * @deprecated https://github.com/sebastianbergmann/phpunit/issues/5183
-     */
     public function value(): string
     {
-        return '';
+        return $this->value;
     }
 
     public function count(): int
@@ -66,8 +65,9 @@ public function asString(): string
         }
 
         return sprintf(
-            'Assertion Succeeded (Constraint: %s%s)',
+            'Assertion Succeeded (Constraint: %s, Value: %s%s)',
             $this->constraint,
+            $this->value,
             $message
         );
     }

src/Event/Facade.php

@@ -68,7 +68,7 @@ public static function emitter(): Emitter
     }
 
     /** @noinspection PhpUnused */
-    public static function initForIsolation(HRTime $offset): CollectingDispatcher
+    public static function initForIsolation(HRTime $offset, bool $emitAssertionSucceededEvents, bool $emitAssertionFailedEvents): CollectingDispatcher
     {
         $dispatcher = new CollectingDispatcher;
 
@@ -80,6 +80,14 @@ public static function initForIsolation(HRTime $offset): CollectingDispatcher
             )
         );
 
+        if ($emitAssertionSucceededEvents) {
+            self::$emitter->emitAssertionSucceededEvents();
+        }
+
+        if ($emitAssertionFailedEvents) {
+            self::$emitter->emitAssertionFailedEvents();
+        }
+
         self::$sealed = true;
 
         return $dispatcher;
@@ -100,6 +108,7 @@ public static function forward(EventCollection $events): void
 
     public static function seal(): void
     {
+        self::deferredDispatcher()->seal();
         self::deferredDispatcher()->flush();
 
         self::$sealed = true;

src/Framework/TestRunner.php

@@ -272,6 +272,13 @@ public function runInSeparateProcess(TestCase $test, bool $runEntireClass, bool
         $includedFiles = '';
         $iniSettings   = '';
 
+        $emitter = Event\Facade::emitter();
+
+        assert($emitter instanceof Event\DispatchingEmitter);
+
+        $emitAssertionSucceededEvents = $emitter->emitsAssertionSucceededEvents() ? 'true' : 'false';
+        $emitAssertionFailedEvents    = $emitter->emitsAssertionFailedEvents() ? 'true' : 'false';
+
         if (ConfigurationRegistry::get()->hasBootstrap()) {
             $bootstrap = ConfigurationRegistry::get()->bootstrap();
         }
@@ -331,6 +338,8 @@ public function runInSeparateProcess(TestCase $test, bool $runEntireClass, bool
             'offsetSeconds'                  => $offset[0],
             'offsetNanoseconds'              => $offset[1],
             'serializedConfiguration'        => $serializedConfiguration,
+            'emitAssertionSucceededEvents'   => $emitAssertionSucceededEvents,
+            'emitAssertionFailedEvents'      => $emitAssertionFailedEvents,
         ];
 
         if (!$runEntireClass) {

src/Util/PHP/Template/TestCaseClass.tpl

@@ -37,7 +37,9 @@ function __phpunit_run_isolated_test()
         PHPUnit\Event\Telemetry\HRTime::fromSecondsAndNanoseconds(
             {offsetSeconds},
             {offsetNanoseconds}
-        )
+        ),
+        {emitAssertionSucceededEvents},
+        {emitAssertionFailedEvents}
     );
 
     require_once '{filename}';

src/Util/PHP/Template/TestCaseMethod.tpl

@@ -37,7 +37,9 @@ function __phpunit_run_isolated_test()
         PHPUnit\Event\Telemetry\HRTime::fromSecondsAndNanoseconds(
             {offsetSeconds},
             {offsetNanoseconds}
-        )
+        ),
+        {emitAssertionSucceededEvents},
+        {emitAssertionFailedEvents}
     );
 
     require_once '{filename}';