Now loading assets via twig, fixed timeout issues with task, fixed admin menu access

Author: lachiebol

Annotations/AnnotationGenerator.php

@@ -964,8 +964,8 @@ protected function getExampleIfAvailable(string $url, bool $useLocalToken = fals
                 $httpMethod = 'GET'
             );
         } catch (\Throwable $e) {
-            // Add a little bit more context for troubleshooting the failed request
-            throw new \Exception('Error getting example from URL: ' . $url . PHP_EOL . $e, 0, $e);
+            // Example lookups are best-effort. Timeouts and other transport failures should not abort spec generation.
+            return '';
         }
 
         // If the example didn't load or resulted in an error, simply return an empty string

Menu.php

@@ -16,7 +16,7 @@ class Menu extends \Piwik\Plugin\Menu
 {
     public function configureAdminMenu(MenuAdmin $menu): void
     {
-        if (!Piwik::hasUserSuperUserAccess()) {
+        if (!Piwik::isUserHasSomeViewAccess()) {
             return;
         }
 

OpenApiDocs.php

@@ -23,23 +23,10 @@ class OpenApiDocs extends \Piwik\Plugin
     public function registerEvents()
     {
         return [
-            'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
-            'AssetManager.getJavaScriptFiles' => 'getJsFiles',
             'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
         ];
     }
 
-    public function getStylesheetFiles(&$stylesheets): void
-    {
-        $stylesheets[] = 'plugins/OpenApiDocs/vue/lib/swagger-ui/swagger-ui.css';
-        $stylesheets[] = 'plugins/OpenApiDocs/vue/src/SwaggerPage/swagger-ui-overrides.css';
-    }
-
-    public function getJsFiles(&$jsFiles): void
-    {
-        $jsFiles[] = 'plugins/OpenApiDocs/vue/lib/swagger-ui/swagger-ui-bundle.js';
-    }
-
     public function getClientSideTranslationKeys(&$translationKeys): void
     {
         $translationKeys[] = 'CoreHome_LearnMoreFullStop';

templates/swagger.twig

@@ -1,5 +1,12 @@
 {% extends 'admin.twig' %}
 
+{% block head %}
+    {{ parent() }}
+    <link rel="stylesheet" href="plugins/OpenApiDocs/vue/lib/swagger-ui/swagger-ui.css" />
+    <link rel="stylesheet" href="plugins/OpenApiDocs/vue/src/SwaggerPage/swagger-ui-overrides.css" />
+    <script src="plugins/OpenApiDocs/vue/lib/swagger-ui/swagger-ui-bundle.js"></script>
+{% endblock %}
+
 {% set title %}{{ 'OpenApiDocs_SwaggerApi'|translate }}{% endset %}
 
 {% block content %}

tests/Integration/ControllerTest.php

@@ -91,6 +91,9 @@ public function testSwaggerRendersAdminPageForViewAccess(): void
 
         $this->assertNotSame('', $html);
         $this->assertStringContainsString('vue-entry="OpenApiDocs.SwaggerPage"', $html);
+        $this->assertStringContainsString('plugins/OpenApiDocs/vue/lib/swagger-ui/swagger-ui.css', $html);
+        $this->assertStringContainsString('plugins/OpenApiDocs/vue/src/SwaggerPage/swagger-ui-overrides.css', $html);
+        $this->assertStringContainsString('plugins/OpenApiDocs/vue/lib/swagger-ui/swagger-ui-bundle.js', $html);
         $this->assertStringContainsString('Swagger', $html);
     }
 

tests/Integration/MenuTest.php

@@ -0,0 +1,92 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\OpenApiDocs\tests\Integration;
+
+use Piwik\Cache;
+use Piwik\Menu\MenuAdmin;
+use Piwik\Plugin\Manager;
+use Piwik\Tests\Framework\Fixture;
+use Piwik\Tests\Framework\Mock\FakeAccess;
+use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
+
+/**
+ * @group OpenApiDocs
+ * @group MenuTest
+ * @group Plugins
+ */
+class MenuTest extends IntegrationTestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        Fixture::createSuperUser();
+        if (!Fixture::siteCreated(1)) {
+            Fixture::createWebsite('2012-01-01 00:00:00');
+        }
+
+        Manager::getInstance()->loadPlugin('OpenApiDocs');
+    }
+
+    public function provideContainerConfig(): array
+    {
+        return ['Piwik\Access' => new FakeAccess()];
+    }
+
+    public function tearDown(): void
+    {
+        Cache::getTransientCache()->flushAll();
+        MenuAdmin::unsetInstance();
+
+        parent::tearDown();
+    }
+
+    public function testConfigureAdminMenuAddsSwaggerItemForViewAccess(): void
+    {
+        FakeAccess::clearAccess(
+            $superUser = false,
+            $idSitesAdmin = [0],
+            $idSitesView = [1],
+            $identity = 'viewAccessUser'
+        );
+
+        $items = $this->buildConfiguredMenu()->getMenu();
+
+        $this->assertArrayHasKey('CorePluginsAdmin_MenuPlatform', $items);
+        $this->assertArrayHasKey('OpenApiDocs_SwaggerApi', $items['CorePluginsAdmin_MenuPlatform']);
+    }
+
+    public function testConfigureAdminMenuSkipsSwaggerItemWithoutViewAccess(): void
+    {
+        FakeAccess::clearAccess(
+            $superUser = false,
+            $idSitesAdmin = [],
+            $idSitesView = [],
+            $identity = 'noAccessUser'
+        );
+
+        $items = $this->buildConfiguredMenu()->getMenu();
+
+        if (!isset($items['CorePluginsAdmin_MenuPlatform'])) {
+            $this->assertArrayNotHasKey('CorePluginsAdmin_MenuPlatform', $items);
+            return;
+        }
+
+        $this->assertArrayNotHasKey('OpenApiDocs_SwaggerApi', $items['CorePluginsAdmin_MenuPlatform']);
+    }
+
+    private function buildConfiguredMenu(): MenuAdmin
+    {
+        MenuAdmin::unsetInstance();
+        return MenuAdmin::getInstance();
+    }
+}