bug #40042 [Doctrine] Restore priority for EventSubscribers (jderusse)

nicolas-grekas · nicolas-grekas · commit d56887f7c553 · 2021-02-04T12:08:06.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [Doctrine] Restore priority for EventSubscribers | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | fix #40031 | License | MIT | Doc PR | - Since #39990, lazy subscribers are called AFTER listeners (which is the opposite of previous implementation). This PR restore the previous behavior. Note: ordered subscribers is implemented in #39978 but is considered as a new feature. Commits ------- 94eac1b Restore priority for eventSubscribers
diff --git a/src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php b/src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php
@@ -164,11 +164,22 @@ private function initializeListeners(string $eventName)
     private function initializeSubscribers()
     {
         $this->initializedSubscribers = true;
+
+        $eventListeners = $this->listeners;
+        // reset eventListener to respect priority: EventSubscribers have a higher priority
+        $this->listeners = [];
         foreach ($this->subscribers as $id => $subscriber) {
             if (\is_string($subscriber)) {
                 parent::addEventSubscriber($this->subscribers[$id] = $this->container->get($subscriber));
             }
         }
+        foreach ($eventListeners as $event => $listeners) {
+            if (!isset($this->listeners[$event])) {
+                $this->listeners[$event] = [];
+            }
+            $this->listeners[$event] += $listeners;
+        }
+        $this->subscribers = [];
     }
 
     /**
diff --git a/src/Symfony/Bridge/Doctrine/Tests/ContainerAwareEventManagerTest.php b/src/Symfony/Bridge/Doctrine/Tests/ContainerAwareEventManagerTest.php
@@ -146,11 +146,14 @@ public function testAddEventListenerAndSubscriberAfterDispatchEvent()
 
     public function testGetListenersForEvent()
     {
+        $this->evm = new ContainerAwareEventManager($this->container, ['lazy2']);
+
         $this->container->set('lazy', $listener1 = new MyListener());
+        $this->container->set('lazy2', $subscriber1 = new MySubscriber(['foo']));
         $this->evm->addEventListener('foo', 'lazy');
         $this->evm->addEventListener('foo', $listener2 = new MyListener());
 
-        $this->assertSame([$listener1, $listener2], array_values($this->evm->getListeners('foo')));
+        $this->assertSame([$subscriber1, $listener1, $listener2], array_values($this->evm->getListeners('foo')));
     }
 
     public function testGetListeners()

Original file line number	Diff line number	Diff line change
`@@ -164,11 +164,22 @@ private function initializeListeners(string $eventName)`
`164`	`164`	`private function initializeSubscribers()`
`165`	`165`	`{`
`166`	`166`	`$this->initializedSubscribers = true;`
	`167`	`+`
	`168`	`+ $eventListeners = $this->listeners;`
	`169`	`+ // reset eventListener to respect priority: EventSubscribers have a higher priority`
	`170`	`+ $this->listeners = [];`
`167`	`171`	`foreach ($this->subscribers as $id => $subscriber) {`
`168`	`172`	`if (\is_string($subscriber)) {`
`169`	`173`	`parent::addEventSubscriber($this->subscribers[$id] = $this->container->get($subscriber));`
`170`	`174`	`}`
`171`	`175`	`}`
	`176`	`+ foreach ($eventListeners as $event => $listeners) {`
	`177`	`+ if (!isset($this->listeners[$event])) {`
	`178`	`+ $this->listeners[$event] = [];`
	`179`	`+ }`
	`180`	`+ $this->listeners[$event] += $listeners;`
	`181`	`+ }`
	`182`	`+ $this->subscribers = [];`
`172`	`183`	`}`
`173`	`184`
`174`	`185`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -146,11 +146,14 @@ public function testAddEventListenerAndSubscriberAfterDispatchEvent()`
`146`	`146`
`147`	`147`	`public function testGetListenersForEvent()`
`148`	`148`	`{`
	`149`	`+ $this->evm = new ContainerAwareEventManager($this->container, ['lazy2']);`
	`150`	`+`
`149`	`151`	`$this->container->set('lazy', $listener1 = new MyListener());`
	`152`	`+ $this->container->set('lazy2', $subscriber1 = new MySubscriber(['foo']));`
`150`	`153`	`$this->evm->addEventListener('foo', 'lazy');`
`151`	`154`	`$this->evm->addEventListener('foo', $listener2 = new MyListener());`
`152`	`155`
`153`		`- $this->assertSame([$listener1, $listener2], array_values($this->evm->getListeners('foo')));`
	`156`	`+ $this->assertSame([$subscriber1, $listener1, $listener2], array_values($this->evm->getListeners('foo')));`
`154`	`157`	`}`
`155`	`158`
`156`	`159`	`public function testGetListeners()`