[EventDispatcher] Fix TraceableEventDispatcher FC/BC layer

Robin Chalas · Robin Chalas · commit c5b3b34b51a0 · 2019-04-27T15:05:39.000+02:00
diff --git a/src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php b/src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php
@@ -18,6 +18,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
+use Symfony\Component\EventDispatcher\LegacyEventProxy;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\Stopwatch\Stopwatch;
 use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;
@@ -295,7 +296,7 @@ public function __call($method, $arguments)
      */
     protected function beforeDispatch(string $eventName, $event)
     {
-        $this->preDispatch($eventName, $event);
+        $this->preDispatch($eventName, $event instanceof Event ? $event : new LegacyEventProxy($event));
     }
 
     /**
@@ -305,7 +306,7 @@ protected function beforeDispatch(string $eventName, $event)
      */
     protected function afterDispatch(string $eventName, $event)
     {
-        $this->postDispatch($eventName, $event);
+        $this->postDispatch($eventName, $event instanceof Event ? $event : new LegacyEventProxy($event));
     }
 
     /**
diff --git a/src/Symfony/Component/EventDispatcher/Debug/WrappedListener.php b/src/Symfony/Component/EventDispatcher/Debug/WrappedListener.php
@@ -14,7 +14,7 @@
 use Psr\EventDispatcher\StoppableEventInterface;
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\EventDispatcher\WrappedEvent;
+use Symfony\Component\EventDispatcher\LegacyEventProxy;
 use Symfony\Component\Stopwatch\Stopwatch;
 use Symfony\Component\VarDumper\Caster\ClassStub;
 use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;
@@ -112,8 +112,8 @@ public function getInfo($eventName)
 
     public function __invoke(Event $event, $eventName, EventDispatcherInterface $dispatcher)
     {
-        if ($event instanceof WrappedEvent) {
-            $event = $event->getWrappedEvent();
+        if ($event instanceof LegacyEventProxy) {
+            $event = $event->getEvent();
         }
 
         $dispatcher = $this->dispatcher ?: $dispatcher;
diff --git a/src/Symfony/Component/EventDispatcher/EventDispatcher.php b/src/Symfony/Component/EventDispatcher/EventDispatcher.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\EventDispatcher;
 
 use Psr\EventDispatcher\StoppableEventInterface;
+use Symfony\Component\EventDispatcher\Debug\WrappedListener;
 use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;
 
 /**
@@ -242,7 +243,8 @@ protected function callListeners(iterable $listeners, string $eventName, $event)
             if ($stoppable && $event->isPropagationStopped()) {
                 break;
             }
-            $listener($event instanceof Event ? $event : new WrappedEvent($event), $eventName, $this);
+            // @deprecated: the ternary operator is part of a BC layer and should be removed in 5.0
+            $listener($listener instanceof WrappedListener ? new LegacyEventProxy($event) : $event, $eventName, $this);
         }
     }
 
@@ -296,7 +298,7 @@ private function optimizeListeners(string $eventName): array
                         ($closure = \Closure::fromCallable($listener))(...$args);
                     };
                 } else {
-                    $closure = $listener instanceof \Closure ? $listener : \Closure::fromCallable($listener);
+                    $closure = $listener instanceof \Closure || $listener instanceof WrappedListener ? $listener : \Closure::fromCallable($listener);
                 }
             }
         }
diff --git a/src/Symfony/Component/EventDispatcher/LegacyEventProxy.php b/src/Symfony/Component/EventDispatcher/LegacyEventProxy.php
@@ -17,7 +17,7 @@
 /**
  * @internal to be removed in 5.0.
  */
-final class WrappedEvent extends Event
+final class LegacyEventProxy extends Event
 {
     private $event;
 
@@ -32,7 +32,7 @@ public function __construct($event)
     /**
      * @return object $event
      */
-    public function getWrappedEvent()
+    public function getEvent()
     {
         return $this->event;
     }
@@ -54,4 +54,9 @@ public function stopPropagation()
 
         $this->event->stopPropagation();
     }
+
+    public function __call($name, $args)
+    {
+        return $this->event->{$name}(...$args);
+    }
 }
diff --git a/src/Symfony/Component/EventDispatcher/Tests/Debug/TraceableEventDispatcherTest.php b/src/Symfony/Component/EventDispatcher/Tests/Debug/TraceableEventDispatcherTest.php
@@ -18,6 +18,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;
 
 class TraceableEventDispatcherTest extends TestCase
 {
@@ -139,6 +140,19 @@ public function testClearCalledListeners()
         $this->assertEquals([['event' => 'foo', 'pretty' => 'closure', 'priority' => 5]], $listeners);
     }
 
+    public function testDispatchContractsEvent()
+    {
+        $expectedEvent = new ContractsEvent();
+        $tdispatcher = new TraceableEventDispatcher(new EventDispatcher(), new Stopwatch());
+        $tdispatcher->addListener('foo', function ($event) use ($expectedEvent) {
+            $this->assertSame($event, $expectedEvent);
+        }, 5);
+        $tdispatcher->dispatch($expectedEvent, 'foo');
+
+        $listeners = $tdispatcher->getCalledListeners();
+        $this->assertArrayHasKey('stub', $listeners[0]);
+    }
+
     public function testDispatchAfterReset()
     {
         $tdispatcher = new TraceableEventDispatcher(new EventDispatcher(), new Stopwatch());

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`use Symfony\Component\EventDispatcher\EventDispatcherInterface;`
`19`	`19`	`use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
`20`	`20`	`use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;`
	`21`	`+use Symfony\Component\EventDispatcher\LegacyEventProxy;`
`21`	`22`	`use Symfony\Component\HttpFoundation\RequestStack;`
`22`	`23`	`use Symfony\Component\Stopwatch\Stopwatch;`
`23`	`24`	`use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;`
`@@ -295,7 +296,7 @@ public function __call($method, $arguments)`
`295`	`296`	`*/`
`296`	`297`	`protected function beforeDispatch(string $eventName, $event)`
`297`	`298`	`{`
`298`		`- $this->preDispatch($eventName, $event);`
	`299`	`+ $this->preDispatch($eventName, $event instanceof Event ? $event : new LegacyEventProxy($event));`
`299`	`300`	`}`
`300`	`301`
`301`	`302`	`/**`
`@@ -305,7 +306,7 @@ protected function beforeDispatch(string $eventName, $event)`
`305`	`306`	`*/`
`306`	`307`	`protected function afterDispatch(string $eventName, $event)`
`307`	`308`	`{`
`308`		`- $this->postDispatch($eventName, $event);`
	`309`	`+ $this->postDispatch($eventName, $event instanceof Event ? $event : new LegacyEventProxy($event));`
`309`	`310`	`}`
`310`	`311`
`311`	`312`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\EventDispatcher;`
`13`	`13`
`14`	`14`	`use Psr\EventDispatcher\StoppableEventInterface;`
	`15`	`+use Symfony\Component\EventDispatcher\Debug\WrappedListener;`
`15`	`16`	`use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;`
`16`	`17`
`17`	`18`	`/**`
`@@ -242,7 +243,8 @@ protected function callListeners(iterable $listeners, string $eventName, $event)`
`242`	`243`	`if ($stoppable && $event->isPropagationStopped()) {`
`243`	`244`	`break;`
`244`	`245`	`}`
`245`		`- $listener($event instanceof Event ? $event : new WrappedEvent($event), $eventName, $this);`
	`246`	`+ // @deprecated: the ternary operator is part of a BC layer and should be removed in 5.0`
	`247`	`+ $listener($listener instanceof WrappedListener ? new LegacyEventProxy($event) : $event, $eventName, $this);`
`246`	`248`	`}`
`247`	`249`	`}`
`248`	`250`
`@@ -296,7 +298,7 @@ private function optimizeListeners(string $eventName): array`
`296`	`298`	`($closure = \Closure::fromCallable($listener))(...$args);`
`297`	`299`	`};`
`298`	`300`	`} else {`
`299`		`- $closure = $listener instanceof \Closure ? $listener : \Closure::fromCallable($listener);`
	`301`	`+ $closure = $listener instanceof \Closure \|\| $listener instanceof WrappedListener ? $listener : \Closure::fromCallable($listener);`
`300`	`302`	`}`
`301`	`303`	`}`
`302`	`304`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`/**`
`18`	`18`	`* @internal to be removed in 5.0.`
`19`	`19`	`*/`
`20`		`-final class WrappedEvent extends Event`
	`20`	`+final class LegacyEventProxy extends Event`
`21`	`21`	`{`
`22`	`22`	`private $event;`
`23`	`23`
`@@ -32,7 +32,7 @@ public function __construct($event)`
`32`	`32`	`/**`
`33`	`33`	`* @return object $event`
`34`	`34`	`*/`
`35`		`- public function getWrappedEvent()`
	`35`	`+ public function getEvent()`
`36`	`36`	`{`
`37`	`37`	`return $this->event;`
`38`	`38`	`}`
`@@ -54,4 +54,9 @@ public function stopPropagation()`
`54`	`54`
`55`	`55`	`$this->event->stopPropagation();`
`56`	`56`	`}`
	`57`	`+`
	`58`	`+ public function __call($name, $args)`
	`59`	`+ {`
	`60`	`+ return $this->event->{$name}(...$args);`
	`61`	`+ }`
`57`	`62`	`}`