Facade.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\Event;

use function assert;
use function interface_exists;
use PHPUnit\Event\Telemetry\HRTime;
use PHPUnit\Event\Telemetry\SystemGarbageCollectorStatusProvider;
use PHPUnit\Runner\DeprecationCollector\Facade as DeprecationCollector;

/**
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
 *
 * @internal This class is not covered by the backward compatibility promise for PHPUnit
 */
final class Facade
{
    private static ?self $instance = null;
    private Emitter $emitter;
    private ?TypeMap $typeMap                          = null;
    private ?DeferringDispatcher $deferringDispatcher  = null;
    private ?CollectingDispatcher $isolationDispatcher = null;
    private bool $sealed                               = false;

    public static function instance(): self
    {
        if (self::$instance === null) {
            self::$instance = new self;
        }

        return self::$instance;
    }

    public static function emitter(): Emitter
    {
        return self::instance()->emitter;
    }

    public function __construct()
    {
        $this->emitter = $this->createDispatchingEmitter();
    }

    /**
     * @throws EventFacadeIsSealedException
     * @throws UnknownSubscriberTypeException
     */
    public function registerSubscribers(Subscriber ...$subscribers): void
    {
        foreach ($subscribers as $subscriber) {
            $this->registerSubscriber($subscriber);
        }
    }

    /**
     * @throws EventFacadeIsSealedException
     * @throws UnknownSubscriberTypeException
     */
    public function registerSubscriber(Subscriber $subscriber): void
    {
        if ($this->sealed) {
            throw new EventFacadeIsSealedException;
        }

        $this->deferredDispatcher()->registerSubscriber($subscriber);
    }

    /**
     * @throws EventFacadeIsSealedException
     */
    public function registerTracer(Tracer\Tracer $tracer): void
    {
        if ($this->sealed) {
            throw new EventFacadeIsSealedException;
        }

        $this->deferredDispatcher()->registerTracer($tracer);
    }

    /**
     * @codeCoverageIgnore
     *
     * @noinspection PhpUnused
     */
    public function initForIsolation(HRTime $offset): CollectingDispatcher
    {
        DeprecationCollector::initForIsolation();

        $dispatcher = new CollectingDispatcher(
            new DirectDispatcher($this->typeMap()),
        );

        $this->emitter = new DispatchingEmitter(
            $dispatcher,
            new Telemetry\System(
                new Telemetry\SystemStopWatchWithOffset($offset),
                new Telemetry\SystemMemoryMeter,
                new SystemGarbageCollectorStatusProvider,
                new Telemetry\SystemCpuTimeMeter,
            ),
        );

        $this->sealed = true;

        $this->isolationDispatcher = $dispatcher;

        return $dispatcher;
    }

    /**
     * Mint an emitter that collects its events into an independent collection,
     * without sealing this facade or replacing its emitter. Unlike
     * initForIsolation(), which can only establish one isolated emitter for the
     * whole process, any number of these can be in use at once; the parallel
     * test runner uses one per concurrently running PHPT test.
     */
    public function collectingEmitter(): CollectingEmitter
    {
        $dispatcher = new CollectingDispatcher(
            new DirectDispatcher($this->typeMap()),
        );

        return new CollectingEmitter(
            new DispatchingEmitter(
                $dispatcher,
                $this->createTelemetrySystem(),
            ),
            $dispatcher,
        );
    }

    public function forward(EventCollection $events): void
    {
        if ($this->isolationDispatcher !== null) {
            $dispatcher = $this->isolationDispatcher;
        } else {
            $dispatcher = $this->deferredDispatcher();
        }

        foreach ($events as $event) {
            $dispatcher->dispatch($event);
        }
    }

    /**
     * In a process whose event facade was initialized for isolation — a
     * parallel test runner worker, for example — the collection window is
     * opened on the isolation dispatcher, because that is the dispatcher the
     * emitter dispatches to there; the deferring dispatcher is unused in such
     * a process.
     */
    public function startCollectingEvents(): void
    {
        if ($this->isolationDispatcher !== null) {
            $this->isolationDispatcher->startCollectingEvents();

            return;
        }

        $this->deferredDispatcher()->startCollectingEvents();
    }

    public function stopCollectingEvents(): EventCollection
    {
        if ($this->isolationDispatcher !== null) {
            return $this->isolationDispatcher->stopCollectingEvents();
        }

        return $this->deferredDispatcher()->stopCollectingEvents();
    }

    public function seal(): void
    {
        $this->deferredDispatcher()->flush();

        $this->sealed = true;

        $this->emitter->testRunnerEventFacadeSealed();
    }

    private function createDispatchingEmitter(): DispatchingEmitter
    {
        return new DispatchingEmitter(
            $this->deferredDispatcher(),
            $this->createTelemetrySystem(),
        );
    }

    private function createTelemetrySystem(): Telemetry\System
    {
        return new Telemetry\System(
            new Telemetry\SystemStopWatch,
            new Telemetry\SystemMemoryMeter,
            new SystemGarbageCollectorStatusProvider,
            new Telemetry\SystemCpuTimeMeter,
        );
    }

    private function deferredDispatcher(): DeferringDispatcher
    {
        if ($this->deferringDispatcher === null) {
            $this->deferringDispatcher = new DeferringDispatcher(
                new DirectDispatcher($this->typeMap()),
            );
        }

        return $this->deferringDispatcher;
    }

    private function typeMap(): TypeMap
    {
        if ($this->typeMap === null) {
            $typeMap = new TypeMap;

            $this->registerDefaultTypes($typeMap);

            $this->typeMap = $typeMap;
        }

        return $this->typeMap;
    }

    private function registerDefaultTypes(TypeMap $typeMap): void
    {
        $defaultEvents = [
            Application\Started::class,
            Application\Finished::class,

            Test\DataProviderMethodCalled::class,
            Test\DataProviderMethodFinished::class,
            Test\MarkedIncomplete::class,
            Test\AfterLastTestMethodCalled::class,
            Test\AfterLastTestMethodErrored::class,
            Test\AfterLastTestMethodFailed::class,
            Test\AfterLastTestMethodFinished::class,
            Test\AfterTestMethodCalled::class,
            Test\AfterTestMethodErrored::class,
            Test\AfterTestMethodFailed::class,
            Test\AfterTestMethodFinished::class,
            Test\BeforeFirstTestMethodCalled::class,
            Test\BeforeFirstTestMethodErrored::class,
            Test\BeforeFirstTestMethodFailed::class,
            Test\BeforeFirstTestMethodFinished::class,
            Test\BeforeTestMethodCalled::class,
            Test\BeforeTestMethodErrored::class,
            Test\BeforeTestMethodFailed::class,
            Test\BeforeTestMethodFinished::class,
            Test\AdditionalInformationProvided::class,
            Test\ComparatorRegistered::class,
            Test\CustomTestMethodInvocationUsed::class,
            Test\ConsideredRisky::class,
            Test\AttemptErrored::class,
            Test\AttemptFailed::class,
            Test\DeprecationTriggered::class,
            Test\Errored::class,
            Test\ErrorTriggered::class,
            Test\Failed::class,
            Test\Finished::class,
            Test\NoticeTriggered::class,
            Test\Passed::class,
            Test\PhpDeprecationTriggered::class,
            Test\PhpNoticeTriggered::class,
            Test\PhpunitDeprecationTriggered::class,
            Test\PhpunitNoticeTriggered::class,
            Test\PhpunitErrorTriggered::class,
            Test\PhpunitWarningTriggered::class,
            Test\PhpWarningTriggered::class,
            Test\PostConditionCalled::class,
            Test\PostConditionErrored::class,
            Test\PostConditionFailed::class,
            Test\PostConditionFinished::class,
            Test\PreConditionCalled::class,
            Test\PreConditionErrored::class,
            Test\PreConditionFailed::class,
            Test\PreConditionFinished::class,
            Test\PreparationStarted::class,
            Test\Prepared::class,
            Test\PreparationErrored::class,
            Test\PreparationFailed::class,
            Test\PrintedUnexpectedOutput::class,
            Test\Skipped::class,
            Test\WarningTriggered::class,

            Test\MockObjectCreated::class,
            Test\MockObjectForIntersectionOfInterfacesCreated::class,
            Test\PartialMockObjectCreated::class,
            Test\TestStubCreated::class,
            Test\TestStubForIntersectionOfInterfacesCreated::class,

            TestRunner\BootstrapFinished::class,
            TestRunner\Configured::class,
            TestRunner\EventFacadeSealed::class,
            TestRunner\ExecutionAborted::class,
            TestRunner\ExecutionFinished::class,
            TestRunner\ExecutionStarted::class,
            TestRunner\ExtensionLoadedFromPhar::class,
            TestRunner\ExtensionBootstrapped::class,
            TestRunner\Finished::class,
            TestRunner\Started::class,
            TestRunner\DeprecationTriggered::class,
            TestRunner\NoticeTriggered::class,
            TestRunner\WarningTriggered::class,
            TestRunner\Issue\DeprecationTriggered::class,
            TestRunner\ErrorTriggered::class,
            TestRunner\Issue\NoticeTriggered::class,
            TestRunner\PhpDeprecationTriggered::class,
            TestRunner\PhpNoticeTriggered::class,
            TestRunner\PhpWarningTriggered::class,
            TestRunner\Issue\WarningTriggered::class,
            TestRunner\GarbageCollectionDisabled::class,
            TestRunner\GarbageCollectionTriggered::class,
            TestRunner\GarbageCollectionEnabled::class,
            TestRunner\ChildProcessStarted::class,
            TestRunner\ChildProcessErrored::class,
            TestRunner\ChildProcessFinished::class,
            TestRunner\StaticAnalysisForCodeCoverageFinished::class,
            TestRunner\StaticAnalysisForCodeCoverageStarted::class,

            TestSuite\Filtered::class,
            TestSuite\Finished::class,
            TestSuite\Loaded::class,
            TestSuite\Skipped::class,
            TestSuite\Sorted::class,
            TestSuite\Started::class,
        ];

        foreach ($defaultEvents as $eventClass) {
            $subscriberInterface = $eventClass . 'Subscriber';

            assert(interface_exists($subscriberInterface));

            $typeMap->addMapping($subscriberInterface, $eventClass);
        }
    }
}