Merge pull request #27 from DevDavido/development

Bump to v1.1.2

Author: DevDavido

Archiver.php

@@ -96,7 +96,7 @@ private function aggregateReport()
         $emulatedDevices = EmulatedDevice::getList(EmulatedDevice::Both);
 
         foreach ($idSites as $idSite) {
-            Log::info("Will process performance for website id = {$idSite}, period = {$period}");
+            Log::info("Will process performance audit for website id = {$idSite}, period = {$period}");
             foreach ($metrics as $metric) {
                 foreach ($emulatedDevices as $emulatedDevice) {
                     $table = new DataTable();

CHANGELOG.md

@@ -3,6 +3,10 @@
 - 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.2
+- Added: Possibility to enable or disable audit for each site
+- Improved: Set timeout for installation process to 5 minutes
+
 ## 1.1.1
 - Added: Scheduled weekly clearing of task running flag (in case of unexpected audit cancellation)
 - Added: Console command to clear task running flag

MeasurableSettings.php

@@ -20,6 +20,12 @@
 
 class MeasurableSettings extends BaseMeasurableSettings
 {
+    /** @var Setting */
+    public $isEnabled;
+
+    /** @var Setting */
+    public $runCount;
+
     /** @var Setting */
     public $emulatedDevice;
 
@@ -35,9 +41,6 @@ class MeasurableSettings extends BaseMeasurableSettings
     /** @var Setting */
     public $extraHttpHeaderValue;
 
-    /** @var Setting */
-    public $runCount;
-
     /**
      * Initialise plugin settings.
      *
@@ -48,6 +51,7 @@ protected function init()
     {
         Piwik::checkUserHasSomeViewAccess();
 
+        $this->isEnabled = $this->makeIsEnabledSetting();
         $this->runCount = $this->makeRunCountSetting();
         $this->emulatedDevice = $this->makeEmulatedDeviceSetting();
         $this->hasGroupedUrls = $this->makeHasGroupedUrlsSetting();
@@ -56,6 +60,21 @@ protected function init()
         $this->extraHttpHeaderValue = $this->makeExtraHttpHeaderValueSetting();
     }
 
+    /**
+     * Create is enabled setting.
+     *
+     * @return MeasurableSetting
+     * @throws ValidatorException|Exception
+     */
+    private function makeIsEnabledSetting()
+    {
+        return $this->makeSetting('is_enabled', true, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
+            $field->title = Piwik::translate('PerformanceAudit_Settings_IsEnabled_Title');
+            $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_IsEnabled_Help');
+            $field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
+        });
+    }
+
     /**
      * Create run count setting.
      *
@@ -67,6 +86,7 @@ private function makeRunCountSetting()
         return $this->makeSetting('run_count', 3, FieldConfig::TYPE_INT, function (FieldConfig $field) {
             $field->title = Piwik::translate('PerformanceAudit_Settings_RunCount_Title');
             $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_RunCount_Help');
+            $field->condition = 'is_enabled';
             $field->uiControl = FieldConfig::UI_CONTROL_TEXT;
             $field->validate = function ($value) {
                 if (empty($value) && $value != 0) {
@@ -90,6 +110,7 @@ private function makeEmulatedDeviceSetting()
         return $this->makeSetting('emulated_device', EmulatedDevice::__default, FieldConfig::TYPE_STRING, function (FieldConfig $field) {
             $field->title = Piwik::translate('PerformanceAudit_Settings_EmulatedDevice_Title');
             $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_EmulatedDevice_Help');
+            $field->condition = 'is_enabled';
             $field->uiControl = FieldConfig::UI_CONTROL_SINGLE_SELECT;
             $field->availableValues = [
                 EmulatedDevice::Desktop => ucfirst(Piwik::translate('PerformanceAudit_EnvironmentDesktop')),
@@ -118,6 +139,7 @@ private function makeHasGroupedUrlsSetting()
         return $this->makeSetting('has_grouped_urls', false, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
             $field->title = Piwik::translate('PerformanceAudit_Settings_HasGroupedUrls_Title');
             $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_HasGroupedUrls_Help');
+            $field->condition = 'is_enabled';
             $field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
         });
     }
@@ -133,6 +155,7 @@ private function makeHasExtraHttpHeaderSetting()
         return $this->makeSetting('has_extra_http_header', false, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
             $field->title = Piwik::translate('PerformanceAudit_Settings_HasExtraHttpHeader_Title');
             $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_HasExtraHttpHeader_Help');
+            $field->condition = 'is_enabled';
             $field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
         });
     }
@@ -150,14 +173,14 @@ private function makeExtraHttpHeaderKeySetting()
         return $this->makeSetting('extra_http_header_key', '', FieldConfig::TYPE_STRING, function (FieldConfig $field) use ($self) {
             $field->title = Piwik::translate('PerformanceAudit_Settings_ExtraHttpHeaderKey_Title');
             $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_ExtraHttpHeaderKey_Help');
-            $field->condition = 'has_extra_http_header';
+            $field->condition = 'is_enabled && has_extra_http_header';
             $field->uiControl = FieldConfig::UI_CONTROL_SINGLE_SELECT;
             $field->availableValues = [
                 'Authorization' => Piwik::translate('PerformanceAudit_Settings_ExtraHttpHeaderKey_Authorization'),
                 'Cookie' => Piwik::translate('PerformanceAudit_Settings_ExtraHttpHeaderKey_Cookie'),
             ];
             $field->validate = function ($value) use ($self, $field) {
-                if ($self->getSetting($field->condition)->getValue()) {
+                if ($self->getSetting('has_extra_http_header')->getValue()) {
                     if (empty($value)) {
                         throw new ValidatorException(Piwik::translate('General_ValidatorErrorEmptyValue'));
                     }
@@ -182,10 +205,10 @@ private function makeExtraHttpHeaderValueSetting()
         return $this->makeSetting('extra_http_header_value', '', FieldConfig::TYPE_STRING, function (FieldConfig $field) use ($self) {
             $field->title = Piwik::translate('PerformanceAudit_Settings_ExtraHttpHeaderValue_Title');
             $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_ExtraHttpHeaderValue_Help');
-            $field->condition = 'has_extra_http_header';
+            $field->condition = 'is_enabled && has_extra_http_header';
             $field->uiControl = FieldConfig::UI_CONTROL_TEXT;
             $field->validate = function ($value) use ($self, $field) {
-                if ($self->getSetting($field->condition)->getValue()) {
+                if ($self->getSetting('has_extra_http_header')->getValue()) {
                     if (empty($value)) {
                         throw new ValidatorException(Piwik::translate('General_ValidatorErrorEmptyValue'));
                     }
@@ -217,6 +240,16 @@ public function getEmulatedDevicesList()
         return EmulatedDevice::getList($this->getSetting('emulated_device')->getValue());
     }
 
+    /**
+     * Returns if site has audits enabled or not.
+     *
+     * @return bool
+     */
+    public function isAuditEnabled()
+    {
+        return $this->getSetting('is_enabled')->getValue();
+    }
+
     /**
      * Returns if site has grouped URLs for site.
      *

NodeDependencyInstaller.php

@@ -145,6 +145,7 @@ private function installNpmDependencies()
         $npmPath = ExecutableFinder::search('npm');
         // Puppeteer + Lighthouse
         $process = new Process([$npmPath, 'install', '--quiet', '--no-progress', '--no-audit', '--force', '--only=production', '--prefix=' . __DIR__, 'puppeteer@^3.0', 'lighthouse@^6.0']);
+        $process->setTimeout(300);
         $process->run();
 
         if (!$process->isSuccessful()) {

Reports/GetPerformanceBase.php

@@ -47,6 +47,9 @@ protected function init()
         }
 
         $siteSettings = new MeasurableSettings(Common::getRequestVar('idSite'));
+        if (!$siteSettings->isAuditEnabled()) {
+            return;
+        }
         $defaultMetrics = [
             new MinSeconds(),
             new MedianSeconds(),

Tasks.php

@@ -119,6 +119,13 @@ public function auditSite(int $idSite, bool $debug = false)
             $this->logInfo('Performance Audit task for site ' . $idSite . ' has been already started today');
             return;
         }
+
+        $siteSettings = new MeasurableSettings($idSite);
+        if (!$siteSettings->isAuditEnabled() && !$this->isInDebugMode()) {
+            $this->logInfo('Performance Audit task for site ' . $idSite . ' will be skipped due to setting which disables it for this site');
+            return;
+        }
+
         $urls = $this->getPageUrls($idSite, 'last30');
         if (empty($urls)) {
             $this->logWarning('Performance Audit task for site ' . $idSite . ' has no URLs to check');
@@ -134,7 +141,6 @@ public function auditSite(int $idSite, bool $debug = false)
                 $this->markTaskAsRunning();
                 $this->markTaskAsStartedToday($idSite);
             }
-            $siteSettings = new MeasurableSettings($idSite);
 
             $runs = $siteSettings->getRuns();
             $emulatedDevices = $siteSettings->getEmulatedDevicesList();

lang/en.json

@@ -63,6 +63,8 @@
         "Metrics_Max_Seconds_Documentation": "The upper boundary in seconds the page took in this performance category.",
         "Metrics_Tooltip": "%1$s%2$s is classified as %3$s! \n Values between %4$s%2$s – %5$s%2$s are in this classification group.",
         "Metrics_Tooltip_OutOfRange": "%s%s is out of range of all classification groups.",
+        "Settings_IsEnabled_Title": "Perform performance audit for this site",
+        "Settings_IsEnabled_Help": "You can decide on a per-website basis if website performance audits are performed after all.",
         "Settings_RunCount_Title": "Number of performance audit iterations",
         "Settings_RunCount_Help": "Set how many times the audit should be performed on each page for stable results. Any number between 1 and 5 is possible. 5 iterations are twice as stable, but prolongs the processing time the most. Just use such high values like 5 iterations only if enough server resources are generally available. 3 iterations are usually the best balance between reproducibility and resource consumption.",
         "Settings_EmulatedDevice_Title": "Performance simulation environment",

plugin.json

@@ -1,7 +1,7 @@
 {
     "name": "PerformanceAudit",
     "description": "Daily performance audits of all your sites in Matomo.",
-    "version": "1.1.1",
+    "version": "1.1.2",
     "theme": false,
     "require": {
         "php": ">=7.1.3",