apply further fixes

Author: sgiehl

plugins/Dashboard/javascripts/widgetMenu.js

@@ -20,14 +20,18 @@ widgetsHelper.firstGetAvailableWidgetsCall = null;
  */
 widgetsHelper.getAvailableWidgets = function (callback) {
 
+    function resetFirstGetAvailableWidgetsCall(promise) {
+        if (widgetsHelper.firstGetAvailableWidgetsCall === promise) {
+            widgetsHelper.firstGetAvailableWidgetsCall = null;
+        }
+    }
+
     if (!widgetsHelper.availableWidgets && widgetsHelper.firstGetAvailableWidgetsCall) {
-        widgetsHelper.firstGetAvailableWidgetsCall.then(function () {
+        return widgetsHelper.firstGetAvailableWidgetsCall.then(function () {
             if (callback) {
                 callback(widgetsHelper.availableWidgets);
             }
         });
-
-        return widgetsHelper.firstGetAvailableWidgetsCall;
     }
 
     function mergeCategoriesAndSubCategories(availableWidgets)
@@ -97,15 +101,25 @@ widgetsHelper.getAvailableWidgets = function (callback) {
           function (data) {
             widgetsHelper.availableWidgets = mergeCategoriesAndSubCategories(data);
 
+            resetFirstGetAvailableWidgetsCall(promise);
             resolve();
           }
         );
         ajaxRequest.setErrorCallback(function (deferred, status) {
-          if (status == 'abort' || !deferred || deferred.status < 400 || deferred.status >= 600) {
+          resetFirstGetAvailableWidgetsCall(promise);
+
+          if (status == 'abort') {
+            reject(new Error('Loading widget metadata was aborted'));
             return;
           }
+
+          if (!deferred || deferred.status < 400 || deferred.status >= 600) {
+            reject(new Error('Loading widget metadata failed'));
+            return;
+          }
+
           $('#loadingError').show();
-          reject();
+          reject(new Error('Loading widget metadata failed'));
         });
         ajaxRequest.send();
         return;
@@ -118,13 +132,11 @@ widgetsHelper.getAvailableWidgets = function (callback) {
       widgetsHelper.firstGetAvailableWidgetsCall = promise;
     }
 
-    promise.then(function () {
+    return promise.then(function () {
       if (callback) {
         callback(widgetsHelper.availableWidgets);
       }
     });
-
-    return promise;
 };
 
 /**

plugins/Widgetize/Controller.php

@@ -18,6 +18,7 @@
 use Piwik\Plugins\API\WidgetMetadata;
 use Piwik\Url;
 use Piwik\View;
+use Piwik\Widget\WidgetConfig;
 use Piwik\Widget\WidgetsList;
 
 class Controller extends \Piwik\Plugin\Controller
@@ -113,10 +114,21 @@ private function findClientWidgetMetadata(string $module, string $action): ?arra
                 return null;
             }
 
-            $metadata = new WidgetMetadata();
-            return $metadata->buildWidgetMetadata($config);
+            return $this->buildClientWidgetMetadata($config);
         }
 
         return null;
     }
+
+    private function buildClientWidgetMetadata(WidgetConfig $config): ?array
+    {
+        if (!$config->isWidgetizeable()) {
+            return null;
+        }
+
+        $config->checkIsEnabled();
+
+        $metadata = new WidgetMetadata();
+        return $metadata->buildWidgetMetadata($config);
+    }
 }

plugins/Widgetize/tests/Integration/ControllerTest.php

@@ -13,6 +13,7 @@
 use Piwik\Tests\Framework\Fixture;
 use Piwik\Tests\Framework\Mock\FakeAccess;
 use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
+use Piwik\Widget\WidgetConfig;
 
 /**
  * @group Widgetize
@@ -83,4 +84,30 @@ public function testIframeShouldBootstrapClientRenderedWidgetForLegacyWidgetizeU
         $this->assertStringContainsString('clientComponent', $html);
         $this->assertStringContainsString('TransitionsPage', $html);
     }
+
+    public function testBuildClientWidgetMetadataShouldRejectDisabledWidgets(): void
+    {
+        $config = new WidgetConfig();
+        $config->setClientSideComponent('Transitions', 'TransitionsPage');
+        $config->disable();
+
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('General_ExceptionWidgetNotEnabled');
+
+        $method = new \ReflectionMethod(Controller::class, 'buildClientWidgetMetadata');
+        $method->setAccessible(true);
+        $method->invoke($this->controller, $config);
+    }
+
+    public function testBuildClientWidgetMetadataShouldIgnoreNonWidgetizableWidgets(): void
+    {
+        $config = new WidgetConfig();
+        $config->setClientSideComponent('Transitions', 'TransitionsPage');
+        $config->setIsNotWidgetizable();
+
+        $method = new \ReflectionMethod(Controller::class, 'buildClientWidgetMetadata');
+        $method->setAccessible(true);
+
+        $this->assertNull($method->invoke($this->controller, $config));
+    }
 }