Merge pull request #29 from DevDavido/development

DevDavido · web-flow · commit 1635df90b3d6 · 2020-11-05T16:52:39.000+01:00
Bump to v1.1.4
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,11 @@
 - Added: Support for Matomo 4 🎉
 - Updated: Bumped the minimum PHP version to 7.2.5 for this new major plugin version, just as Matomo 4 itself
 
+## 1.1.4
+- Improved: Exception handling for failed audit due to too many requests response
+- Fixed: One performance audit setting has been displayed after disabling audits for the site in settings
+- Fixed: Disabled performance audits for site renders dashboard empty
+
 ## 1.1.3
 - Added: Possibility to set extended audit timeout for each site
 - Improved: Minor internal refactoring for site settings
diff --git a/Exceptions/AuditFailedTooManyRequestsException.php b/Exceptions/AuditFailedTooManyRequestsException.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link https://matomo.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\PerformanceAudit\Exceptions;
+
+require PIWIK_INCLUDE_PATH . '/plugins/PerformanceAudit/vendor/autoload.php';
+
+use Exception;
+
+class AuditFailedTooManyRequestsException extends Exception
+{
+    /**
+     * AuditFailedTooManyRequestsException constructor.
+     *
+     * @param string $url
+     * @param null|string $output
+     */
+    public function __construct(string $url, $output = null)
+    {
+        parent::__construct('Audit of ' . $url . ' failed due to too many requests: ' . $output);
+    }
+}
diff --git a/Lighthouse.php b/Lighthouse.php
@@ -15,6 +15,7 @@
 use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedException;
 use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedMethodNotAllowedException;
 use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedNotFoundException;
+use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedTooManyRequestsException;
 use Piwik\Plugins\PerformanceAudit\Exceptions\DependencyMissingException;
 use Piwik\Plugins\PerformanceAudit\Exceptions\DependencyUnexpectedResultException;
 use Symfony\Component\Process\Exception\ProcessSignaledException;
@@ -220,6 +221,7 @@ protected function setAudit($audit, $enable)
      * @return void
      * @throws AuditFailedAuthoriseRefusedException|AuditFailedNotFoundException
      * @throws AuditFailedMethodNotAllowedException|AuditFailedException
+     * @throws AuditFailedTooManyRequestsException
      */
     protected function throwAuditException($url, $errorOutput)
     {
@@ -229,6 +231,8 @@ protected function throwAuditException($url, $errorOutput)
             throw new AuditFailedNotFoundException($url, $errorOutput);
         } elseif (stristr($errorOutput, 'Status code: 405')) {
             throw new AuditFailedMethodNotAllowedException($url, $errorOutput);
+        } elseif (stristr($errorOutput, 'Status code: 429')) {
+            throw new AuditFailedTooManyRequestsException($url, $errorOutput);
         }
 
         throw new AuditFailedException($url, $errorOutput);
diff --git a/MeasurableSettings.php b/MeasurableSettings.php
@@ -90,6 +90,7 @@ private function makeHasExtendedTimeoutSetting()
         return $this->makeSetting('has_extended_timeout', false, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
             $field->title = Piwik::translate('PerformanceAudit_Settings_HasExtendedTimeout_Title');
             $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_HasExtendedTimeout_Help');
+            $field->condition = 'is_enabled';
             $field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
         });
     }
diff --git a/Reports/GetPerformanceBase.php b/Reports/GetPerformanceBase.php
@@ -47,9 +47,6 @@ protected function init()
         }
 
         $siteSettings = new MeasurableSettings(Common::getRequestVar('idSite'));
-        if (!$siteSettings->isAuditEnabled()) {
-            return;
-        }
         $defaultMetrics = [
             new MinSeconds(),
             new MedianSeconds(),
@@ -78,14 +75,19 @@ protected function init()
      */
     public function isEnabled()
     {
-        if (!Common::getRequestVar('idSite', false)) {
+        $idSite = Common::getRequestVar('idSite', false);
+        if (!$idSite) {
             return false;
         }
         // Disable report if initialised as instance of itself
         if ((new ReflectionClass($this))->getShortName() === 'GetPerformanceBase') {
             return false;
         }
-        $idSite = Common::getRequestVar('idSite');
+
+        $siteSettings = new MeasurableSettings($idSite);
+        if (!$siteSettings->isAuditEnabled()) {
+            return false;
+        }
 
         return Piwik::isUserHasViewAccess($idSite);
     }
diff --git a/Tasks.php b/Tasks.php
@@ -27,7 +27,9 @@
 use Piwik\Plugins\PerformanceAudit\Columns\Metrics\Audit;
 use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedAuthoriseRefusedException;
 use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedException;
+use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedMethodNotAllowedException;
 use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedNotFoundException;
+use Piwik\Plugins\PerformanceAudit\Exceptions\AuditFailedTooManyRequestsException;
 use Piwik\Site;
 use Piwik\Tracker\Action;
 use Piwik\Tracker\Db\DbException;
@@ -425,7 +427,7 @@ private function performAudits(int $idSite, array $urls, array $emulatedDevices,
                             ->setEmulatedDevice($emulatedDevice)
                             ->audit($url);
                         $this->runGarbageCollection();
-                    } catch (AuditFailedAuthoriseRefusedException | AuditFailedNotFoundException $exception) {
+                    } catch (AuditFailedAuthoriseRefusedException | AuditFailedNotFoundException | AuditFailedMethodNotAllowedException | AuditFailedTooManyRequestsException $exception) {
                         $this->logWarning($exception->getMessage());
                     } catch (AuditFailedException | ProcessTimedOutException | RuntimeException $exception) {
                         $this->logError($exception->getMessage());
diff --git a/plugin.json b/plugin.json
@@ -1,7 +1,7 @@
 {
     "name": "PerformanceAudit",
     "description": "Daily performance audits of all your sites in Matomo.",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "theme": false,
     "require": {
         "php": ">=7.1.3",
diff --git a/screenshots/WebsiteSettings.png b/screenshots/WebsiteSettings.png
diff --git a/vendor/composer/autoload_classmap.php b/vendor/composer/autoload_classmap.php
@@ -42,6 +42,7 @@
     'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\AuditFailedException' => $baseDir . '/Exceptions/AuditFailedException.php',
     'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\AuditFailedMethodNotAllowedException' => $baseDir . '/Exceptions/AuditFailedMethodNotAllowedException.php',
     'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\AuditFailedNotFoundException' => $baseDir . '/Exceptions/AuditFailedNotFoundException.php',
+    'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\AuditFailedTooManyRequestsException' => $baseDir . '/Exceptions/AuditFailedTooManyRequestsException.php',
     'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\DependencyMissingException' => $baseDir . '/Exceptions/DependencyMissingException.php',
     'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\DependencyNpmMisconfigurationException' => $baseDir . '/Exceptions/DependencyNpmMisconfigurationException.php',
     'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\DependencyOfChromeMissingException' => $baseDir . '/Exceptions/DependencyOfChromeMissingException.php',
diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php
@@ -80,6 +80,7 @@ class ComposerStaticInit98dde460e8a16c8877d8f8d8a8e6921c
         'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\AuditFailedException' => __DIR__ . '/../..' . '/Exceptions/AuditFailedException.php',
         'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\AuditFailedMethodNotAllowedException' => __DIR__ . '/../..' . '/Exceptions/AuditFailedMethodNotAllowedException.php',
         'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\AuditFailedNotFoundException' => __DIR__ . '/../..' . '/Exceptions/AuditFailedNotFoundException.php',
+        'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\AuditFailedTooManyRequestsException' => __DIR__ . '/../..' . '/Exceptions/AuditFailedTooManyRequestsException.php',
         'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\DependencyMissingException' => __DIR__ . '/../..' . '/Exceptions/DependencyMissingException.php',
         'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\DependencyNpmMisconfigurationException' => __DIR__ . '/../..' . '/Exceptions/DependencyNpmMisconfigurationException.php',
         'Piwik\\Plugins\\PerformanceAudit\\Exceptions\\DependencyOfChromeMissingException' => __DIR__ . '/../..' . '/Exceptions/DependencyOfChromeMissingException.php',

Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,7 @@ private function makeHasExtendedTimeoutSetting()`
`90`	`90`	`return $this->makeSetting('has_extended_timeout', false, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {`
`91`	`91`	`$field->title = Piwik::translate('PerformanceAudit_Settings_HasExtendedTimeout_Title');`
`92`	`92`	`$field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_HasExtendedTimeout_Help');`
	`93`	`+ $field->condition = 'is_enabled';`
`93`	`94`	`$field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;`
`94`	`95`	`});`
`95`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,9 +47,6 @@ protected function init()`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`$siteSettings = new MeasurableSettings(Common::getRequestVar('idSite'));`
`50`		`- if (!$siteSettings->isAuditEnabled()) {`
`51`		`- return;`
`52`		`- }`
`53`	`50`	`$defaultMetrics = [`
`54`	`51`	`new MinSeconds(),`
`55`	`52`	`new MedianSeconds(),`
`@@ -78,14 +75,19 @@ protected function init()`
`78`	`75`	`*/`
`79`	`76`	`public function isEnabled()`
`80`	`77`	`{`
`81`		`- if (!Common::getRequestVar('idSite', false)) {`
	`78`	`+ $idSite = Common::getRequestVar('idSite', false);`
	`79`	`+ if (!$idSite) {`
`82`	`80`	`return false;`
`83`	`81`	`}`
`84`	`82`	`// Disable report if initialised as instance of itself`
`85`	`83`	`if ((new ReflectionClass($this))->getShortName() === 'GetPerformanceBase') {`
`86`	`84`	`return false;`
`87`	`85`	`}`
`88`		`- $idSite = Common::getRequestVar('idSite');`
	`86`	`+`
	`87`	`+ $siteSettings = new MeasurableSettings($idSite);`
	`88`	`+ if (!$siteSettings->isAuditEnabled()) {`
	`89`	`+ return false;`
	`90`	`+ }`
`89`	`91`
`90`	`92`	`return Piwik::isUserHasViewAccess($idSite);`
`91`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "PerformanceAudit",`
`3`	`3`	`"description": "Daily performance audits of all your sites in Matomo.",`
`4`		`- "version": "1.1.3",`
	`4`	`+ "version": "1.1.4",`
`5`	`5`	`"theme": false,`
`6`	`6`	`"require": {`
`7`	`7`	`"php": ">=7.1.3",`