IBX-431: Added event dispatching after building the View (#226)

* IBX-431: Added event dispatching after building the View

* fix: Rebrand PostBuildViewEvent

* fix: Add missing test coverage

* fix: Add missing test coverage

* Update eZ/Bundle/EzPublishCoreBundle/Tests/EventListener/ViewControllerListenerTest.php

Co-authored-by: Paweł Niedzielski <[email protected]>

* Update eZ/Bundle/EzPublishCoreBundle/Tests/EventListener/ViewControllerListenerTest.php

Co-authored-by: Paweł Niedzielski <[email protected]>

* Update eZ/Bundle/EzPublishCoreBundle/Tests/EventListener/ViewControllerListenerTest.php

Co-authored-by: Paweł Niedzielski <[email protected]>

* Fixed test

* Update tests/lib/Event/View/PostBuildViewEventTest.php

Co-authored-by: Paweł Niedzielski <[email protected]>

* Fixed test

* Fixed test

* Re-used test properties

Co-authored-by: Paweł Niedzielski <[email protected]>

Author: Nattfarinn

eZ/Bundle/EzPublishCoreBundle/EventListener/ViewControllerListener.php

@@ -9,6 +9,7 @@
 use eZ\Publish\Core\MVC\Symfony\View\Builder\ViewBuilderRegistry;
 use eZ\Publish\Core\MVC\Symfony\View\Event\FilterViewBuilderParametersEvent;
 use eZ\Publish\Core\MVC\Symfony\View\ViewEvents;
+use Ibexa\Contracts\Core\Event\View\PostBuildViewEvent;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -66,6 +67,7 @@ public function getController(ControllerEvent $event)
         $parameterEvent = new FilterViewBuilderParametersEvent(clone $request);
         $this->eventDispatcher->dispatch($parameterEvent, ViewEvents::FILTER_BUILDER_PARAMETERS);
         $view = $viewBuilder->buildView($parameterEvent->getParameters()->all());
+        $this->eventDispatcher->dispatch(new PostBuildViewEvent($view));
         $request->attributes->set('view', $view);
 
         // View parameters are added as request attributes so that they are available as controller action parameters

eZ/Bundle/EzPublishCoreBundle/Tests/EventListener/ViewControllerListenerTest.php

@@ -7,14 +7,18 @@
 namespace eZ\Bundle\EzPublishCoreBundle\Tests\EventListener;
 
 use eZ\Bundle\EzPublishCoreBundle\EventListener\ViewControllerListener;
+use eZ\Publish\Core\MVC\Symfony\View\BaseView;
 use eZ\Publish\Core\MVC\Symfony\View\Builder\ViewBuilder;
 use eZ\Publish\Core\MVC\Symfony\View\Builder\ViewBuilderRegistry;
 use eZ\Publish\Core\MVC\Symfony\View\ContentView;
+use eZ\Publish\Core\MVC\Symfony\View\Event\FilterViewBuilderParametersEvent;
+use eZ\Publish\Core\MVC\Symfony\View\ViewEvents;
+use Ibexa\Contracts\Core\Event\View\PostBuildViewEvent;
+use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
-use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
 use Symfony\Component\HttpKernel\Event\ControllerEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
@@ -151,6 +155,37 @@ public function testGetControllerMatchedView()
         $this->assertEquals($expectedView, $this->request->attributes->get('view'));
     }
 
+    public function testGetControllerEmitsProperEvents(): void
+    {
+        $viewObject = new class() extends BaseView {
+        };
+
+        $this->viewBuilderRegistry
+            ->expects($this->once())
+            ->method('getFromRegistry')
+            ->willReturn($this->viewBuilderMock);
+
+        $this->viewBuilderMock
+            ->expects($this->once())
+            ->method('buildView')
+            ->willReturn($viewObject);
+
+        $this->eventDispatcher
+            ->expects($this->exactly(2))
+            ->method('dispatch')
+            ->withConsecutive(
+                [
+                    $this->isInstanceOf(FilterViewBuilderParametersEvent::class),
+                    $this->identicalTo(ViewEvents::FILTER_BUILDER_PARAMETERS),
+                ], [
+                    $this->isInstanceOf(PostBuildViewEvent::class),
+                    $this->isNull(),
+                ])
+            ->willReturnArgument(0);
+
+        $this->controllerListener->getController($this->event);
+    }
+
     /**
      * @return \PHPUnit\Framework\MockObject\MockObject|ControllerEvent
      */

src/contracts/Event/View/PostBuildViewEvent.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Event\View;
+
+use eZ\Publish\Core\MVC\Symfony\View\View;
+use Symfony\Contracts\EventDispatcher\Event;
+
+final class PostBuildViewEvent extends Event
+{
+    /** @var \eZ\Publish\Core\MVC\Symfony\View\View */
+    private $view;
+
+    public function __construct(View $view)
+    {
+        $this->view = $view;
+    }
+
+    public function getView(): View
+    {
+        return $this->view;
+    }
+}

tests/lib/Event/View/PostBuildViewEventTest.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\Core\Event\View;
+
+use eZ\Publish\Core\MVC\Symfony\View\BaseView;
+use Ibexa\Contracts\Core\Event\View\PostBuildViewEvent;
+use PHPUnit\Framework\TestCase;
+
+final class PostBuildViewEventTest extends TestCase
+{
+    public function testEventConstruction(): void
+    {
+        $view = new class() extends BaseView {
+        };
+
+        $event = new PostBuildViewEvent($view);
+
+        self::assertSame($view, $event->getView());
+    }
+}