Dispatcher changed the order of params (#20)

Author: mmoreram

AsyncEventDispatcherInterface.php

@@ -27,31 +27,13 @@ interface AsyncEventDispatcherInterface extends EventDispatcherInterface
     /**
      * Dispatch an event asynchronously.
      *
-     * @param string $eventName
      * @param Event  $event
+     * @param string $eventName
      *
      * @return PromiseInterface
      */
     public function asyncDispatch(
-        string $eventName,
-        Event $event
-    );
-
-    /**
-     * Triggers the listeners of an event.
-     *
-     * This method can be overridden to add functionality that is executed
-     * for each listener.
-     *
-     * @param callable[] $listeners
-     * @param string     $eventName
-     * @param Event      $event
-     *
-     * @return PromiseInterface
-     */
-    public function doAsyncDispatch(
-        array $listeners,
-        string $eventName,
-        Event $event
+        Event $event,
+        string $eventName
     );
 }

AsyncEventDispatcherMethods.php

@@ -27,15 +27,17 @@ trait AsyncEventDispatcherMethods
     /**
      * Dispatch an event asynchronously.
      *
-     * @param string $eventName
      * @param Event  $event
+     * @param string $eventName
      *
      * @return PromiseInterface
      */
     public function asyncDispatch(
-        string $eventName,
-        Event $event
+        Event $event,
+        string $eventName = null
     ) {
+        $eventName = $eventName ?? \get_class($event);
+
         if ($listeners = $this->getListeners($eventName)) {
             return $this->doAsyncDispatch($listeners, $eventName, $event);
         }
@@ -55,7 +57,7 @@ public function asyncDispatch(
      *
      * @return PromiseInterface
      */
-    public function doAsyncDispatch(
+    private function doAsyncDispatch(
         array $listeners,
         string $eventName,
         Event $event

AsyncHttpKernel.php

@@ -21,7 +21,6 @@
 use React\Promise\FulfilledPromise;
 use React\Promise\PromiseInterface;
 use RingCentral\Psr7\Response as Psr7Response;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -42,6 +41,7 @@
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\HttpKernel\HttpKernel;
 use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Throwable;
 
 /**
@@ -101,7 +101,7 @@ public function preload(): PromiseInterface
     {
         return $this
             ->dispatcher
-            ->asyncDispatch(AsyncKernelEvents::PRELOAD, new PreloadEvent());
+            ->asyncDispatch(new PreloadEvent(), AsyncKernelEvents::PRELOAD);
     }
 
     /**
@@ -144,7 +144,7 @@ private function handleAsyncRaw(Request $request): PromiseInterface
         $event = new RequestEvent($this, $request, $type);
 
         return $dispatcher
-            ->asyncDispatch(KernelEvents::REQUEST, $event)
+            ->asyncDispatch($event, KernelEvents::REQUEST)
             ->then(function (RequestEvent $event) use ($request, $type) {
                 return $event->hasResponse()
                     ? $this->filterResponsePromise(
@@ -225,7 +225,7 @@ private function callAsyncView(
 
                 return $this
                     ->dispatcher
-                    ->asyncDispatch(KernelEvents::VIEW, $event)
+                    ->asyncDispatch($event, KernelEvents::VIEW)
                     ->then(function (ViewEvent $event) use ($controller, $response) {
                         if ($event->hasResponse()) {
                             return $event->getResponse();
@@ -259,7 +259,7 @@ private function filterResponsePromise(Response $response, Request $request, int
 
         return $this
             ->dispatcher
-            ->asyncDispatch(KernelEvents::RESPONSE, $event)
+            ->asyncDispatch($event, KernelEvents::RESPONSE)
             ->then(function (ResponseEvent $event) use ($request, $type) {
                 $this->finishRequestPromise($request, $type);
 
@@ -310,7 +310,7 @@ private function handleExceptionPromise(
 
         return $this
             ->dispatcher
-            ->asyncDispatch(KernelEvents::EXCEPTION, $event)
+            ->asyncDispatch($event, KernelEvents::EXCEPTION)
             ->then(function (ExceptionEvent $event) use ($request, $type) {
                 // Supporting both 4.3 and 5.0
                 $throwable = ($event instanceof GetResponseForExceptionEvent)

DependencyInjection/CompilerPass/EventDispatcherCompilerPass.php

@@ -51,7 +51,8 @@ public function __construct(bool $isDebug)
     public function process(ContainerBuilder $container)
     {
         if ($container->has('event_dispatcher')) {
-            $this->isDebug
+            $this->isDebug &&
+            $container->hasDefinition('debug.event_dispatcher')
                 ? $this->processEventDispatcherDebug($container)
                 : $this->processEventDispatcher($container);
         }
@@ -78,16 +79,10 @@ private function processEventDispatcher(ContainerBuilder $container)
      */
     private function processEventDispatcherDebug(ContainerBuilder $container)
     {
-        if (!$container->hasDefinition('debug.event_dispatcher')) {
-            $this->processEventDispatcher($container);
-
-            return;
-        }
-
         $container
             ->getDefinition('debug.event_dispatcher')
             ->setClass(TraceableAsyncEventDispatcher::class);
 
-        $container->setAlias(AsyncEventDispatcherInterface::class, 'event_dispatcher');
+        $container->setAlias(AsyncEventDispatcherInterface::class, 'debug.event_dispatcher');
     }
 }

Tests/Base/AsyncEventDispatcherTest.php

@@ -0,0 +1,75 @@
+<?php
+
+/*
+ * This file is part of the DriftPHP Project
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * Feel free to edit as you please, and have fun.
+ *
+ * @author Marc Morera <yuhu@mmoreram.com>
+ */
+
+declare(strict_types=1);
+
+namespace Drift\HttpKernel\Tests\Base;
+
+use Clue\React\Block;
+use Drift\HttpKernel\AsyncEventDispatcherInterface;
+use Drift\HttpKernel\Tests\AsyncKernelFunctionalTest;
+use Drift\HttpKernel\Tests\Event\Event1;
+use Drift\HttpKernel\Tests\Listener;
+use React\EventLoop\Factory;
+
+/**
+ * Class AsyncEventDispatcherTest.
+ */
+class AsyncEventDispatcherTest extends AsyncKernelFunctionalTest
+{
+    /**
+     * Decorate configuration.
+     *
+     * @param array $configuration
+     *
+     * @return array
+     */
+    protected static function decorateConfiguration(array $configuration): array
+    {
+        $configuration = parent::decorateConfiguration($configuration);
+        $configuration['services']['dispatcher_test'] = [
+            'alias' => AsyncEventDispatcherInterface::class,
+        ];
+
+        $configuration['services']['listener'] = [
+            'class' => Listener::class,
+            'tags' => [
+                [
+                    'name' => 'kernel.event_listener',
+                    'event' => Event1::class,
+                    'method' => 'handleEvent1',
+                ],
+            ],
+        ];
+
+        return $configuration;
+    }
+
+    /**
+     * Test async event dispatcher.
+     */
+    public function testAsyncDispatch()
+    {
+        $loop = Factory::create();
+
+        $_GET['event1'] = false;
+        $promise = self::get('dispatcher_test')
+            ->asyncDispatch(new Event1())
+            ->then(function (Event1 $_) {
+                $this->assertTrue($_GET['event1']);
+            });
+
+        $loop->run();
+        Block\await($promise, $loop);
+    }
+}

Tests/Event/Event1.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the DriftPHP Project
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * Feel free to edit as you please, and have fun.
+ *
+ * @author Marc Morera <yuhu@mmoreram.com>
+ */
+
+declare(strict_types=1);
+
+namespace Drift\HttpKernel\Tests\Event;
+
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * Class Event1.
+ */
+class Event1 extends Event
+{
+}

Tests/Listener.php

@@ -16,6 +16,7 @@
 namespace Drift\HttpKernel\Tests;
 
 use Drift\HttpKernel\Event\PreloadEvent;
+use Drift\HttpKernel\Tests\Event\Event1;
 use React\Promise\FulfilledPromise;
 use React\Promise\PromiseInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -150,4 +151,14 @@ public function handlePreload(PreloadEvent $event)
     {
         $_GET['preloaded'] = true;
     }
+
+    /**
+     * Handle event1.
+     *
+     * @param Event1 $event1
+     */
+    public function handleEvent1(Event1 $event1)
+    {
+        $_GET['event1'] = true;
+    }
 }