Merge pull request #20 from DevDavido/development

Bump to v1.0.11

Author: DevDavido

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.0.11
+- Added: Option to remove query strings from audited URLs
+- Improved: Small refactoring in settings
+
 ## 1.0.10
 - Fixed: Issue with previous release as version number was incompatible with plugin marketplace
 

MeasurableSettings.php

@@ -23,6 +23,9 @@ class MeasurableSettings extends BaseMeasurableSettings
     /** @var Setting */
     public $emulatedDevice;
 
+    /** @var Setting */
+    public $hasUrlsWithoutQueryString;
+
     /** @var Setting */
     public $hasExtraHttpHeader;
 
@@ -47,6 +50,7 @@ protected function init()
 
         $this->runCount = $this->makeRunCountSetting();
         $this->emulatedDevice = $this->makeEmulatedDeviceSetting();
+        $this->hasUrlsWithoutQueryString = $this->makeHasUrlsWithoutQueryStringSetting();
         $this->hasExtraHttpHeader = $this->makeHasExtraHttpHeaderSetting();
         $this->extraHttpHeaderKey = $this->makeExtraHttpHeaderKeySetting();
         $this->extraHttpHeaderValue = $this->makeExtraHttpHeaderValueSetting();
@@ -103,6 +107,21 @@ private function makeEmulatedDeviceSetting()
         });
     }
 
+    /**
+     * Create a grouped URLs setting.
+     *
+     * @return MeasurableSetting
+     * @throws ValidatorException|Exception
+     */
+    private function makeHasUrlsWithoutQueryStringSetting()
+    {
+        return $this->makeSetting('has_urls_without_query_string', false, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
+            $field->title = Piwik::translate('PerformanceAudit_Settings_HasUrlsWithoutQueryString_Title');
+            $field->inlineHelp = Piwik::translate('PerformanceAudit_Settings_HasUrlsWithoutQueryString_Help');
+            $field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
+        });
+    }
+
     /**
      * Create has extra HTTP header setting.
      *
@@ -177,4 +196,34 @@ private function makeExtraHttpHeaderValueSetting()
             };
         });
     }
+
+    /**
+     * Returns array of runs of site.
+     *
+     * @return array
+     */
+    public function getRuns()
+    {
+        return range(1, (int) $this->getSetting('run_count')->getValue());
+    }
+
+    /**
+     * Returns list of emulated devices of site.
+     *
+     * @return array
+     */
+    public function getEmulatedDevicesList()
+    {
+        return EmulatedDevice::getList($this->getSetting('emulated_device')->getValue());
+    }
+
+    /**
+     * Returns if site has URLs without query strings for site.
+     *
+     * @return bool
+     */
+    public function hasUrlsWithoutQueryString()
+    {
+        return $this->getSetting('has_urls_without_query_string')->getValue();
+    }
 }

Tasks.php

@@ -109,8 +109,12 @@ public function auditSite(int $idSite, bool $debug = false)
             }
             $siteSettings = new MeasurableSettings($idSite);
 
-            $runs = range(1, (int) $siteSettings->getSetting('run_count')->getValue());
-            $emulatedDevices = EmulatedDevice::getList($siteSettings->getSetting('emulated_device')->getValue());
+            $runs = $siteSettings->getRuns();
+            $emulatedDevices = $siteSettings->getEmulatedDevicesList();
+
+            if ($siteSettings->hasUrlsWithoutQueryString()) {
+                $this->removeQueryStrings($urls);
+            }
 
             if ($this->isInDebugMode()) {
                 $urls = [array_shift($urls)];
@@ -285,8 +289,35 @@ private function getPageUrls(int $idSite, string $date)
                 }
             }
         }
+        $this->removeUrlDuplicates($urls);
+
+        return $urls;
+    }
+
+    /**
+     * Remove query string from each url.
+     *
+     * @param array $urls
+     * @return void
+     */
+    private function removeQueryStrings(array &$urls)
+    {
+        foreach ($urls as $key => $url) {
+            $urls[$key] = current(explode('?', $url, 2));
+        }
 
-        return array_values(array_unique($urls, SORT_STRING));
+        $this->removeUrlDuplicates($urls);
+    }
+
+    /**
+     * Remove url duplicates.
+     *
+     * @param array $urls
+     * @return void
+     */
+    private function removeUrlDuplicates(array &$urls)
+    {
+        $urls = array_values(array_unique($urls, SORT_STRING));
     }
 
     /**

lang/en.json

@@ -67,8 +67,10 @@
         "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",
         "Settings_EmulatedDevice_Help": "Select in what kind of environment performance audits should be executed and measured.",
-        "Settings_HasExtraHttpHeader_Title": "Use Custom HTTP header",
-        "Settings_HasExtraHttpHeader_Help": "If you want to add a custom HTTP header to every request, e.g. for HTTP Basic Authentication, enable this setting.",
+        "Settings_HasUrlsWithoutQueryString_Title": "Remove query string from URLs for performance audits",
+        "Settings_HasUrlsWithoutQueryString_Help": "If you enable this setting, URLs will get their <a href=\"https://en.wikipedia.org/wiki/Query_string\" target=\"_blank\">query string</a> removed for audits. If lots of your website requests only differ in their query string, enabling this setting can speed up the time it takes for the overall performance audit of a site. Note that only URLs with the same path but with different query strings will be removed, all other URLs are not affected by this setting.",
+        "Settings_HasExtraHttpHeader_Title": "Use Custom HTTP header for performance audits",
+        "Settings_HasExtraHttpHeader_Help": "If you want to add a custom HTTP header to every performance audit request, e.g. for HTTP Basic Authentication, enable this setting.",
         "Settings_ExtraHttpHeaderKey_Title": "Custom HTTP header key",
         "Settings_ExtraHttpHeaderKey_Help": "Select your custom HTTP header key.",
         "Settings_ExtraHttpHeaderKey_Authorization": "Authorization",

plugin.json

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