Replace API menu, #PG-5207 (#46)

* Rerouted menu item, added old api reference url to page, renamed to API instead of Swagger API

* Remove stale test case that has no purpose now

* fix test

* Added default site to param

Author: lachiebol

ApiReference.php

@@ -29,11 +29,12 @@ public function registerEvents()
 
     public function getClientSideTranslationKeys(&$translationKeys): void
     {
+        $translationKeys[] = 'General_API';
         $translationKeys[] = 'CoreHome_LearnMoreFullStop';
+        $translationKeys[] = 'ApiReference_LookingForLegacyApiReference';
         $translationKeys[] = 'ApiReference_ReportingApiMoreInformation';
         $translationKeys[] = 'ApiReference_ReportingApiReference';
         $translationKeys[] = 'ApiReference_ReportingApiSummary';
-        $translationKeys[] = 'ApiReference_SwaggerApi';
         $translationKeys[] = 'ApiReference_SwaggerPagePluginEmpty';
         $translationKeys[] = 'ApiReference_SwaggerPageRequestFailed';
         $translationKeys[] = 'ApiReference_SwaggerPageSpecLoadFailed';

Controller.php

@@ -12,6 +12,7 @@
 namespace Piwik\Plugins\ApiReference;
 
 use Piwik\Piwik;
+use Piwik\Plugins\UsersManager\UserPreferences;
 use Piwik\View;
 
 class Controller extends \Piwik\Plugin\ControllerAdmin
@@ -22,7 +23,19 @@ public function swagger(): string
 
         $view = new View('@ApiReference/swagger');
         $this->setBasicVariablesView($view);
+        $view->defaultWebsiteId = $this->getDefaultWebsiteId();
 
         return $view->render();
     }
+
+    private function getDefaultWebsiteId(): ?int
+    {
+        $defaultWebsiteId = (new UserPreferences())->getDefaultWebsiteId();
+
+        if (is_numeric($defaultWebsiteId)) {
+            return (int) $defaultWebsiteId;
+        }
+
+        return null;
+    }
 }

Menu.php

@@ -20,10 +20,10 @@ public function configureAdminMenu(MenuAdmin $menu): void
             return;
         }
 
-        $menu->addPlatformItem(
-            'ApiReference_SwaggerApi',
-            $this->urlForAction('swagger'),
-            30
+        $menu->editUrl(
+            'CorePluginsAdmin_MenuPlatform',
+            'General_API',
+            $this->urlForAction('swagger')
         );
     }
 }

lang/en.json

@@ -1,9 +1,9 @@
 {
     "ApiReference": {
+        "LookingForLegacyApiReference": "Looking for the legacy API reference? The %1$slegacy API reference%2$s page is still available while we continue improving the new API documentation. If anything is missing or behaving unexpectedly in this new version, %3$splease let us know%4$s so we can improve the experience.",
         "ReportingApiMoreInformation": "More info about the Matomo APIs available in %1$sIntroduction to Matomo API%2$s and the %3$sMatomo API Reference%4$s.",
         "ReportingApiReference": "Reporting API Reference",
         "ReportingApiSummary": "All the data in Matomo is available through simple APIs.",
-        "SwaggerApi": "Swagger API",
         "SwaggerPagePluginEmpty": "No plugins are configured in the ApiReference whitelist.",
         "SwaggerPageRequestFailed": "The plugin whitelist could not be loaded.",
         "SwaggerPageSearchNoResults": "No plugins match your search.",

templates/swagger.twig

@@ -7,11 +7,12 @@
     <script src="plugins/ApiReference/vue/lib/swagger-ui/swagger-ui-bundle.js"></script>
 {% endblock %}
 
-{% set title %}{{ 'ApiReference_SwaggerApi'|translate }}{% endset %}
+{% set title %}{{ 'General_API'|translate }}{% endset %}
 
 {% block content %}
     <div
         vue-entry="ApiReference.SwaggerPage"
+        default-website-id="{{ defaultWebsiteId|default(null)|json_encode }}"
         piwik-url="{{ piwikUrl|default(null)|json_encode }}"
     ></div>
 {% endblock %}

tests/Integration/ControllerTest.php

@@ -91,6 +91,7 @@ public function testSwaggerRendersAdminPageForViewAccess(): void
 
         $this->assertNotSame('', $html);
         $this->assertStringContainsString('vue-entry="ApiReference.SwaggerPage"', $html);
+        $this->assertStringContainsString('default-website-id="1"', $html);
         $this->assertStringContainsString('piwik-url=', $html);
         $this->assertStringContainsString('plugins/ApiReference/vue/lib/swagger-ui/swagger-ui.css', $html);
         $this->assertStringContainsString('plugins/ApiReference/vue/src/SwaggerPage/swagger-ui-overrides.css', $html);

tests/Integration/MenuTest.php

@@ -11,7 +11,9 @@
 
 namespace Piwik\Plugins\ApiReference\tests\Integration;
 
+use Piwik\Access;
 use Piwik\Cache;
+use Piwik\Container\StaticContainer;
 use Piwik\Menu\MenuAdmin;
 use Piwik\Plugin\Manager;
 use Piwik\Tests\Framework\Fixture;
@@ -50,38 +52,23 @@ public function tearDown(): void
         parent::tearDown();
     }
 
-    public function testConfigureAdminMenuAddsSwaggerItemForViewAccess(): void
+    public function testConfigureAdminMenuEditsApiItemUrlForViewAccess(): void
     {
-        FakeAccess::clearAccess(
-            $superUser = false,
-            $idSitesAdmin = [0],
-            $idSitesView = [1],
-            $identity = 'viewAccessUser'
-        );
-
-        $items = $this->buildConfiguredMenu()->getMenu();
-
-        $this->assertArrayHasKey('CorePluginsAdmin_MenuPlatform', $items);
-        $this->assertArrayHasKey('ApiReference_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;
+        $originalAccess = StaticContainer::getContainer()->get(Access::class);
+        StaticContainer::getContainer()->set(Access::class, new FakeAccess(false, [0], [1], 'viewAccessUser'));
+
+        try {
+            $items = $this->buildConfiguredMenu()->getMenu();
+
+            $this->assertArrayHasKey('CorePluginsAdmin_MenuPlatform', $items);
+            $this->assertArrayHasKey('General_API', $items['CorePluginsAdmin_MenuPlatform']);
+            $this->assertSame(
+                ['action' => 'swagger', 'module' => 'ApiReference'],
+                $items['CorePluginsAdmin_MenuPlatform']['General_API']['_url']
+            );
+        } finally {
+            StaticContainer::getContainer()->set(Access::class, $originalAccess);
         }
-
-        $this->assertArrayNotHasKey('ApiReference_SwaggerApi', $items['CorePluginsAdmin_MenuPlatform']);
     }
 
     private function buildConfiguredMenu(): MenuAdmin