removed EventDispatcher dependency in favour of Piwik::postEvent

Author: lachiebol

Generation/PluginListProvider.php

@@ -11,7 +11,7 @@
 
 namespace Piwik\Plugins\OpenApiDocs\Generation;
 
-use Piwik\EventDispatcher;
+use Piwik\Piwik;
 use Piwik\Plugin\Manager;
 use Piwik\Plugins\OpenApiDocs\OpenApiDocs;
 
@@ -22,15 +22,9 @@ class PluginListProvider
      */
     private $pluginManager;
 
-    /**
-     * @var EventDispatcher
-     */
-    private $eventDispatcher;
-
-    public function __construct(?Manager $pluginManager = null, ?EventDispatcher $eventDispatcher = null)
+    public function __construct(?Manager $pluginManager = null)
     {
         $this->pluginManager = $pluginManager ?? Manager::getInstance();
-        $this->eventDispatcher = $eventDispatcher ?? EventDispatcher::getInstance();
     }
 
     /**
@@ -96,6 +90,14 @@ protected function pluginHasApiFile(string $pluginName): bool
      */
     private function dispatchUpdatePluginListEvent(array &$pluginNames): void
     {
-        $this->eventDispatcher->postEvent('OpenApiDocs.updatePluginList', [&$pluginNames]);
+        $this->postEvent('OpenApiDocs.updatePluginList', [&$pluginNames]);
+    }
+
+    /**
+     * @param array<int, mixed> $params
+     */
+    protected function postEvent(string $eventName, array $params): void
+    {
+        Piwik::postEvent($eventName, $params);
     }
 }

tests/Unit/Generation/PluginListProviderTest.php

@@ -14,7 +14,6 @@
 require_once PIWIK_INCLUDE_PATH . '/plugins/OpenApiDocs/vendor/autoload.php';
 
 use PHPUnit\Framework\TestCase;
-use Piwik\EventDispatcher;
 use Piwik\Plugin\Manager;
 use Piwik\Plugins\OpenApiDocs\Generation\PluginListProvider;
 
@@ -92,10 +91,9 @@ public function testGetPluginsForSpecGenerationAppliesEventUpdates(): void
             ['HasApi' => true, 'Login' => true],
             ['HasApi' => true, 'Login' => true],
             ['HasApi' => true, 'Login' => true],
-            static function (EventDispatcher $eventDispatcher): void {
-                $eventDispatcher->addObserver('OpenApiDocs.updatePluginList', function (&$pluginNames): void {
-                    $pluginNames[] = 'Login';
-                });
+            static function (string $eventName, array $params): void {
+                $pluginNames = &$params[0];
+                $pluginNames[] = 'Login';
             }
         );
 
@@ -134,14 +132,13 @@ public function testGetPluginsForSpecGenerationDropsInvalidEventUpdatesButKeepsU
                 'NoApi' => false,
                 'ConnectAccounts' => true,
             ],
-            static function (EventDispatcher $eventDispatcher): void {
-                $eventDispatcher->addObserver('OpenApiDocs.updatePluginList', function (&$pluginNames): void {
-                    $pluginNames[] = 'Login';
-                    $pluginNames[] = 'InactivePlugin';
-                    $pluginNames[] = 'NoApi';
-                    $pluginNames[] = 'ConnectAccounts';
-                    $pluginNames[] = 123;
-                });
+            static function (string $eventName, array $params): void {
+                $pluginNames = &$params[0];
+                $pluginNames[] = 'Login';
+                $pluginNames[] = 'InactivePlugin';
+                $pluginNames[] = 'NoApi';
+                $pluginNames[] = 'ConnectAccounts';
+                $pluginNames[] = 123;
             }
         );
 
@@ -159,7 +156,7 @@ private function makeProvider(
         array $activatedByPlugin,
         array $inFilesystemByPlugin,
         $hasApiFile,
-        ?callable $configureEventDispatcher = null
+        ?callable $postEventCallback = null
     ): PluginListProvider {
         $pluginManager = $this->createConfiguredMock(Manager::class, [
             'getInstalledPluginsName' => $installedPlugins,
@@ -176,16 +173,9 @@ private function makeProvider(
                 return $inFilesystemByPlugin[$pluginName] ?? false;
             });
 
-        if ($configureEventDispatcher) {
-            $eventDispatcher = new EventDispatcher($pluginManager, []);
-            $configureEventDispatcher($eventDispatcher);
-        } else {
-            $eventDispatcher = $this->createMock(EventDispatcher::class);
-        }
-
         $provider = $this->getMockBuilder(PluginListProvider::class)
-            ->setConstructorArgs([$pluginManager, $eventDispatcher])
-            ->onlyMethods(['pluginHasApiFile'])
+            ->setConstructorArgs([$pluginManager])
+            ->onlyMethods(['pluginHasApiFile', 'postEvent'])
             ->getMock();
 
         $provider->method('pluginHasApiFile')
@@ -197,6 +187,11 @@ private function makeProvider(
                 return $hasApiFile;
             });
 
+        if ($postEventCallback) {
+            $provider->method('postEvent')
+                ->willReturnCallback($postEventCallback);
+        }
+
         return $provider;
     }
 }