Merge pull request #6154 from wallabag/fix/event-dispatcher

Fix EventDispatcher & events
wallabag · Dec 16, 2022 · 9c16dd7 · 9c16dd7
2 parents 35c77c1 + d47c208
commit 9c16dd7
Show file tree

Hide file tree

Showing 15 changed files with 30 additions and 48 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -84,18 +84,3 @@ parameters:
             message: "#^Property Tests\\\\Wallabag\\\\CoreBundle\\\\Helper\\\\RedirectTest\\:\\:\\$routerMock has unknown class PHPUnit_Framework_MockObject_MockObject as its type\\.$#"
             count: 1
             path: tests/Wallabag/CoreBundle/Helper/RedirectTest.php
-
-        -
-            message: "#^Method Symfony\\\\Contracts\\\\EventDispatcher\\\\EventDispatcherInterface\\:\\:dispatch()#"
-            count: 1
-            path: src/Wallabag/ApiBundle/Controller/UserRestController.php
-
-        -
-            message: "#^Method Symfony\\\\Contracts\\\\EventDispatcher\\\\EventDispatcherInterface\\:\\:dispatch()#"
-            count: 1
-            path: src/Wallabag/CoreBundle/Command/InstallCommand.php
-
-        -
-            message: "#^Method Symfony\\\\Contracts\\\\EventDispatcher\\\\EventDispatcherInterface\\:\\:dispatch()#"
-            count: 1
-            path: src/Wallabag/UserBundle/Controller/ManageController.php
diff --git a/src/Wallabag/ApiBundle/Controller/EntryRestController.php b/src/Wallabag/ApiBundle/Controller/EntryRestController.php
@@ -462,7 +462,7 @@ public function deleteEntriesListAction(Request $request)
 
             if (false !== $entry) {
                 // entry deleted, dispatch event about it!
-                $this->get(EventDispatcherInterface::class)->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
+                $this->get(EventDispatcherInterface::class)->dispatch(new EntryDeletedEvent($entry), EntryDeletedEvent::NAME);
 
                 $em = $this->get('doctrine')->getManager();
                 $em->remove($entry);
@@ -539,7 +539,7 @@ public function postEntriesListAction(Request $request)
             $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 
             // entry saved, dispatch event about it!
-            $this->get(EventDispatcherInterface::class)->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+            $this->get(EventDispatcherInterface::class)->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
         }
 
         return $this->sendResponse($results);
@@ -760,7 +760,7 @@ public function postEntriesAction(Request $request)
         $em->flush();
 
         // entry saved, dispatch event about it!
-        $this->get(EventDispatcherInterface::class)->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+        $this->get(EventDispatcherInterface::class)->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
 
         return $this->sendResponse($entry);
     }
@@ -976,7 +976,7 @@ public function patchEntriesAction(Entry $entry, Request $request)
         $em->flush();
 
         // entry saved, dispatch event about it!
-        $this->get(EventDispatcherInterface::class)->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+        $this->get(EventDispatcherInterface::class)->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
 
         return $this->sendResponse($entry);
     }
@@ -1032,7 +1032,7 @@ public function patchEntriesReloadAction(Entry $entry)
         $em->flush();
 
         // entry saved, dispatch event about it!
-        $this->get(EventDispatcherInterface::class)->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+        $this->get(EventDispatcherInterface::class)->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
 
         return $this->sendResponse($entry);
     }
@@ -1083,7 +1083,7 @@ public function deleteEntriesAction(Entry $entry, Request $request)
         }
 
         // entry deleted, dispatch event about it!
-        $this->get(EventDispatcherInterface::class)->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
+        $this->get(EventDispatcherInterface::class)->dispatch(new EntryDeletedEvent($entry), EntryDeletedEvent::NAME);
 
         $em = $this->get('doctrine')->getManager();
         $em->remove($entry);

diff --git a/src/Wallabag/ApiBundle/Controller/UserRestController.php b/src/Wallabag/ApiBundle/Controller/UserRestController.php
@@ -11,7 +11,6 @@
 use Nelmio\ApiDocBundle\Annotation\Operation;
 use Swagger\Annotations as SWG;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\Annotation\Route;
@@ -160,7 +159,7 @@ public function putUserAction(Request $request)
 
         // dispatch a created event so the associated config will be created
         $event = new UserEvent($user, $request);
-        LegacyEventDispatcherProxy::decorate($this->get(EventDispatcherInterface::class))->dispatch($event, FOSUserEvents::USER_CREATED);
+        $this->get(EventDispatcherInterface::class)->dispatch($event, FOSUserEvents::USER_CREATED);
 
         return $this->sendUser($user, 'user_api_with_client', JsonResponse::HTTP_CREATED);
     }

diff --git a/src/Wallabag/CoreBundle/Command/InstallCommand.php b/src/Wallabag/CoreBundle/Command/InstallCommand.php
@@ -18,7 +18,6 @@
 use Symfony\Component\Console\Question\Question;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Wallabag\CoreBundle\Entity\IgnoreOriginInstanceRule;
 use Wallabag\CoreBundle\Entity\InternalSetting;
 use Wallabag\UserBundle\Entity\User;
@@ -282,7 +281,7 @@ private function setupAdmin()
 
         // dispatch a created event so the associated config will be created
         $event = new UserEvent($user);
-        LegacyEventDispatcherProxy::decorate($this->getContainer()->get(EventDispatcherInterface::class))->dispatch($event, FOSUserEvents::USER_CREATED);
+        $this->getContainer()->get(EventDispatcherInterface::class)->dispatch($event, FOSUserEvents::USER_CREATED);
 
         $this->io->text('<info>Administration successfully setup.</info>');
 

diff --git a/src/Wallabag/CoreBundle/Command/ReloadEntryCommand.php b/src/Wallabag/CoreBundle/Command/ReloadEntryCommand.php
@@ -80,7 +80,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $em->persist($entry);
             $em->flush();
 
-            $dispatcher->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+            $dispatcher->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
             $progressBar->advance();
 
             $em->detach($entry);

diff --git a/src/Wallabag/CoreBundle/Controller/EntryController.php b/src/Wallabag/CoreBundle/Controller/EntryController.php
@@ -102,7 +102,7 @@ function ($v) {
                         $entry->removeTag($tag);
                     }
                 } elseif ('delete' === $action) {
-                    $this->get(EventDispatcherInterface::class)->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
+                    $this->get(EventDispatcherInterface::class)->dispatch(new EntryDeletedEvent($entry), EntryDeletedEvent::NAME);
                     $em->remove($entry);
                 }
             }
@@ -178,7 +178,7 @@ public function addEntryFormAction(Request $request)
             $em->flush();
 
             // entry saved, dispatch event about it!
-            $this->get(EventDispatcherInterface::class)->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+            $this->get(EventDispatcherInterface::class)->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
 
             return $this->redirect($this->generateUrl('homepage'));
         }
@@ -206,7 +206,7 @@ public function addEntryViaBookmarkletAction(Request $request)
             $em->flush();
 
             // entry saved, dispatch event about it!
-            $this->get(EventDispatcherInterface::class)->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+            $this->get(EventDispatcherInterface::class)->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
         }
 
         return $this->redirect($this->generateUrl('homepage'));
@@ -414,7 +414,7 @@ public function reloadAction(Entry $entry)
         $em->flush();
 
         // entry saved, dispatch event about it!
-        $this->get(EventDispatcherInterface::class)->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+        $this->get(EventDispatcherInterface::class)->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
 
         return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()]));
     }
@@ -498,7 +498,7 @@ public function deleteEntryAction(Request $request, Entry $entry)
         );
 
         // entry deleted, dispatch event about it!
-        $this->get(EventDispatcherInterface::class)->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
+        $this->get(EventDispatcherInterface::class)->dispatch(new EntryDeletedEvent($entry), EntryDeletedEvent::NAME);
 
         $em = $this->get('doctrine')->getManager();
         $em->remove($entry);

diff --git a/src/Wallabag/CoreBundle/Event/EntryDeletedEvent.php b/src/Wallabag/CoreBundle/Event/EntryDeletedEvent.php
@@ -2,7 +2,7 @@
 
 namespace Wallabag\CoreBundle\Event;
 
-use Symfony\Component\EventDispatcher\Event;
+use Symfony\Contracts\EventDispatcher\Event;
 use Wallabag\CoreBundle\Entity\Entry;
 
 /**
@@ -19,7 +19,7 @@ public function __construct(Entry $entry)
         $this->entry = $entry;
     }
 
-    public function getEntry()
+    public function getEntry(): Entry
     {
         return $this->entry;
     }

diff --git a/src/Wallabag/CoreBundle/Event/EntrySavedEvent.php b/src/Wallabag/CoreBundle/Event/EntrySavedEvent.php
@@ -2,7 +2,7 @@
 
 namespace Wallabag\CoreBundle\Event;
 
-use Symfony\Component\EventDispatcher\Event;
+use Symfony\Contracts\EventDispatcher\Event;
 use Wallabag\CoreBundle\Entity\Entry;
 
 /**
@@ -19,7 +19,7 @@ public function __construct(Entry $entry)
         $this->entry = $entry;
     }
 
-    public function getEntry()
+    public function getEntry(): Entry
     {
         return $this->entry;
     }

diff --git a/src/Wallabag/ImportBundle/Consumer/AbstractConsumer.php b/src/Wallabag/ImportBundle/Consumer/AbstractConsumer.php
@@ -72,7 +72,7 @@ protected function handleMessage($body)
             $this->em->flush();
 
             // entry saved, dispatch event about it!
-            $this->eventDispatcher->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+            $this->eventDispatcher->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
 
             // clear only affected entities
             $this->em->clear(Entry::class);

diff --git a/src/Wallabag/ImportBundle/Import/AbstractImport.php b/src/Wallabag/ImportBundle/Import/AbstractImport.php
@@ -171,7 +171,7 @@ protected function parseEntries(array $entries)
                 $this->em->flush();
 
                 foreach ($entryToBeFlushed as $entry) {
-                    $this->eventDispatcher->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+                    $this->eventDispatcher->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
                 }
 
                 $entryToBeFlushed = [];
@@ -187,7 +187,7 @@ protected function parseEntries(array $entries)
 
         if (!empty($entryToBeFlushed)) {
             foreach ($entryToBeFlushed as $entry) {
-                $this->eventDispatcher->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+                $this->eventDispatcher->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
             }
         }
     }

diff --git a/src/Wallabag/ImportBundle/Import/BrowserImport.php b/src/Wallabag/ImportBundle/Import/BrowserImport.php
@@ -173,7 +173,7 @@ protected function parseEntries(array $entries)
                 $this->em->flush();
 
                 foreach ($entryToBeFlushed as $entry) {
-                    $this->eventDispatcher->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+                    $this->eventDispatcher->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
                 }
 
                 $entryToBeFlushed = [];
@@ -185,7 +185,7 @@ protected function parseEntries(array $entries)
 
         if (!empty($entryToBeFlushed)) {
             foreach ($entryToBeFlushed as $entry) {
-                $this->eventDispatcher->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+                $this->eventDispatcher->dispatch(new EntrySavedEvent($entry), EntrySavedEvent::NAME);
             }
         }
     }

diff --git a/src/Wallabag/UserBundle/Controller/ManageController.php b/src/Wallabag/UserBundle/Controller/ManageController.php
@@ -11,7 +11,6 @@
 use Scheb\TwoFactorBundle\Security\TwoFactor\Provider\Google\GoogleAuthenticatorInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Form\Form;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -50,7 +49,7 @@ public function newAction(Request $request)
 
             // dispatch a created event so the associated config will be created
             $event = new UserEvent($user, $request);
-            LegacyEventDispatcherProxy::decorate($this->get(EventDispatcherInterface::class))->dispatch($event, FOSUserEvents::USER_CREATED);
+            $this->get(EventDispatcherInterface::class)->dispatch($event, FOSUserEvents::USER_CREATED);
 
             $this->get(SessionInterface::class)->getFlashBag()->add(
                 'notice',

diff --git a/tests/Wallabag/CoreBundle/Event/Listener/LocaleListenerTest.php b/tests/Wallabag/CoreBundle/Event/Listener/LocaleListenerTest.php
@@ -69,8 +69,8 @@ public function testSubscribedEvents()
         $dispatcher->addSubscriber($listener);
 
         $dispatcher->dispatch(
-            KernelEvents::REQUEST,
-            $event
+            $event,
+            KernelEvents::REQUEST
         );
 
         $this->assertSame('fr', $request->getLocale());

diff --git a/tests/Wallabag/UserBundle/EventListener/AuthenticationFailureListenerTest.php b/tests/Wallabag/UserBundle/EventListener/AuthenticationFailureListenerTest.php
@@ -57,8 +57,8 @@ public function testOnAuthenticationFailure()
         );
 
         $this->dispatcher->dispatch(
-            AuthenticationEvents::AUTHENTICATION_FAILURE,
-            $event
+            $event,
+            AuthenticationEvents::AUTHENTICATION_FAILURE
         );
 
         $records = $this->logHandler->getRecords();

diff --git a/tests/Wallabag/UserBundle/EventListener/CreateConfigListenerTest.php b/tests/Wallabag/UserBundle/EventListener/CreateConfigListenerTest.php
@@ -72,8 +72,8 @@ public function testWithValidUser()
             ->method('flush');
 
         $this->dispatcher->dispatch(
-            FOSUserEvents::REGISTRATION_COMPLETED,
-            $event
+            $event,
+            FOSUserEvents::REGISTRATION_COMPLETED
         );
     }
 }