Merge pull request #13 from DevDavido/development

Bump to v1.0.7

Author: DevDavido

CHANGELOG.md

@@ -1,7 +1,13 @@
 # Changelog
 
+## 1.0.7
+- Improved: Plugin check is now also running pre-checks first
+- Improved: Plugin check is now independent of regular audit flow
+- Improved: Wording in README text regarding tests
+- Fixed: Updates could remove Node dependencies which now get reinstalled
+
 ## 1.0.6
-- Bugfix: Fixes file require bug from previous release
+- Fixed: Correct file require bug from previous release
 
 ## 1.0.5
 - Added: Possibility to check plugin audit functionality

Controller.php

@@ -40,8 +40,21 @@ public function version()
      */
     public function pluginCheck()
     {
+        $plugin = new PerformanceAudit();
+
+        $error = '';
+        try {
+            $plugin->checkInternetAvailability();
+            $plugin->checkDirectoriesWriteable();
+            $plugin->checkNpm();
+            $plugin->checkNpmDependencies();
+        } catch (Exception $exception) {
+            $error = $exception->getMessage();
+        }
+
         return $this->renderTemplate('pluginCheck', [
-            'checkStartUrl' => (new Menu())->getUrlForAction('pluginCheckStart')
+            'checkStartUrl' => (new Menu())->getUrlForAction('pluginCheckStart'),
+            'error' => $error
         ]);
     }
 

PerformanceAudit.php

@@ -120,7 +120,7 @@ public function deactivate()
      * @return void
      * @throws DirectoryNotWriteableException
      */
-    private function checkDirectoriesWriteable()
+    public function checkDirectoriesWriteable()
     {
         $directories = ['Audits', 'node_modules'];
         clearstatcache();
@@ -138,14 +138,29 @@ private function checkDirectoriesWriteable()
      * @return void
      * @throws DependencyUnexpectedResultException
      */
-    private function checkNpm()
+    public function checkNpm()
     {
         $npmVersion = $this->checkDependency('npm', ['-v']);
         if ($npmVersion < self::MINIMUM_NPM_VERSION) {
             throw new DependencyUnexpectedResultException('npm needs to be at least v' . self::MINIMUM_NPM_VERSION . ' but v' . $npmVersion . ' is installed instead.');
         }
     }
 
+    /**
+     * Check if Chrome is properly installed.
+     *
+     * @return void
+     * @throws DependencyUnexpectedResultException
+     */
+    public function checkNpmDependencies()
+    {
+        $lighthouse = new Lighthouse();
+        $chromeVersion = $this->checkDependency($lighthouse->getChromePath(), ['--version']);
+        if ($chromeVersion < self::MINIMUM_CHROME_VERSION) {
+            throw new DependencyUnexpectedResultException('Chrome needs to be at least v' . self::MINIMUM_CHROME_VERSION . ' but v' . $chromeVersion . ' is installed instead.');
+        }
+    }
+
     /**
      * Check if dependency is installed.
      *
@@ -190,21 +205,6 @@ private function installNpmDependencies()
         return trim($process->getOutput());
     }
 
-    /**
-     * Check if Chrome is properly installed.
-     *
-     * @return void
-     * @throws DependencyUnexpectedResultException
-     */
-    private function checkNpmDependencies()
-    {
-        $lighthouse = new Lighthouse();
-        $chromeVersion = $this->checkDependency($lighthouse->getChromePath(), ['--version']);
-        if ($chromeVersion < self::MINIMUM_CHROME_VERSION) {
-            throw new DependencyUnexpectedResultException('Chrome needs to be at least v' . self::MINIMUM_CHROME_VERSION . ' but v' . $chromeVersion . ' is installed instead.');
-        }
-    }
-
     /**
      * Create log database table.
      *
@@ -282,7 +282,7 @@ public function requiresInternetConnection() {
      * @return void
      * @throws InternetUnavailableException
      */
-    private function checkInternetAvailability()
+    public function checkInternetAvailability()
     {
         if ($this->requiresInternetConnection() && !SettingsPiwik::isInternetEnabled()) {
             throw new InternetUnavailableException('Internet needs to be enabled in order to use this plugin.');

README.md

@@ -63,7 +63,7 @@ If any errors occur during activation, please follow the instruction or informat
 For more screenshots, check out the [screenshot overview](/screenshots/OVERVIEW.md).
 
 ## Testing
-Run the tests with:
+Run the integration and unit tests with:
 
 ```shell
 ./console tests:run PerformanceAudit

Tasks.php

@@ -87,7 +87,7 @@ public function auditSite(int $idSite, bool $debug = false)
             $this->logDebug('Debug mode enabled');
         }
 
-        if ($this->hasAnyTaskRunning()) {
+        if ($this->hasAnyTaskRunning() && !$this->isInDebugMode()) {
             $this->logInfo('A Performance Audit task is currently already running');
             return;
         }
@@ -103,8 +103,10 @@ public function auditSite(int $idSite, bool $debug = false)
 
         $this->logInfo('Performance Audit task for site ' . $idSite . ' will be started now');
         try {
-            $this->markTaskAsRunning();
-            $this->markTaskAsStartedToday($idSite);
+            if (!$this->isInDebugMode()) {
+                $this->markTaskAsRunning();
+                $this->markTaskAsStartedToday($idSite);
+            }
             $siteSettings = new MeasurableSettings($idSite);
 
             $runs = range(1, (int) $siteSettings->getSetting('run_count')->getValue());
@@ -125,7 +127,9 @@ public function auditSite(int $idSite, bool $debug = false)
         } catch (Exception $exception) {
             $this->logError($exception->getMessage());
         } finally {
-            $this->markTaskAsFinished();
+            if (!$this->isInDebugMode()) {
+                $this->markTaskAsFinished();
+            }
         }
         $this->logInfo('Performance Audit task for site ' . $idSite . ' has finished');
     }
@@ -309,12 +313,13 @@ private function performAudits(int $idSite, array $urls, array $emulatedDevices,
 
                         self::getLighthouse($idSite)
                             ->setOutput(sprintf(
-                                '%s%s%d-%s-%s-%d.json',
+                                '%s%s%d-%s-%s-%s%d.json',
                                 __DIR__ . DIRECTORY_SEPARATOR,
                                 self::AUDIT_FOLDER . DIRECTORY_SEPARATOR,
                                 $idSite,
                                 $emulatedDevice,
                                 sha1($this->getUrlWithoutProtocolAndSubdomain($url, 'www')),
+                                ($this->isInDebugMode()) ? 'debug-' : '',
                                 $run
                             ))
                             ->setEmulatedDevice($emulatedDevice)
@@ -344,7 +349,11 @@ private function getAuditFiles(int $idSite)
             ),
             function ($file) use ($idSite) {
                 $idSiteFile = intval(current(explode('-', $file->getFilename(), 2)));
-                return $file->getExtension() === 'json' && $idSiteFile === $idSite;
+                $isDebugFile = !!strstr($file->getFilename(), '-debug-');
+                // Match if both booleans are logical equal
+                $isInMatchingMode = !($this->isInDebugMode() XOR $isDebugFile);
+
+                return $file->getExtension() === 'json' && $idSiteFile === $idSite && $isInMatchingMode;
             }
         );
     }

Updates/1.0.7.php

@@ -0,0 +1,29 @@
+<?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;
+
+require PIWIK_INCLUDE_PATH . '/plugins/PerformanceAudit/vendor/autoload.php';
+
+use Piwik\Updater;
+
+/**
+ * Update for version 1.0.7.
+ */
+class Updates_1_0_7 extends BaseUpdate
+{
+    /**
+     * Perform the incremental version update.
+     *
+     * @param Updater $updater
+     */
+    public function doUpdate(Updater $updater)
+    {
+        parent::doBaseUpdate($updater);
+    }
+}

Updates/BaseUpdate.php

@@ -0,0 +1,55 @@
+<?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;
+
+require PIWIK_INCLUDE_PATH . '/plugins/PerformanceAudit/vendor/autoload.php';
+
+use Piwik\Plugin\Manager;
+use Piwik\Updater;
+use Piwik\Updates as PiwikUpdates;
+use Piwik\Updater\Migration;
+use Piwik\Updater\Migration\Factory as MigrationFactory;
+
+/**
+ * Base update.
+ */
+class BaseUpdate extends PiwikUpdates
+{
+    /**
+     * @var MigrationFactory
+     */
+    private $migration;
+
+    public function __construct(MigrationFactory $factory)
+    {
+        $this->migration = $factory;
+    }
+
+    /**
+     * Return database migrations to be executed in this update.
+     *
+     * @param Updater $updater
+     * @return Migration\Db[]
+     */
+    public function getMigrations(Updater $updater)
+    {
+        return [];
+    }
+
+    /**
+     * Perform the base version update.
+     *
+     * @param Updater $updater
+     */
+    public function doBaseUpdate(Updater $updater)
+    {
+        // Activation needed as node_modules are removed during update
+        Manager::getInstance()->activatePlugin('PerformanceAudit');
+    }
+}

lang/en.json

@@ -32,6 +32,8 @@
         "Report_TotalBlockingTime_Documentation_Information": "total blocking time",
         "Report_CumulativeLayoutShift_Documentation_Information": "cumulative layout shift",
         "PluginCheck": "Plugin Check",
+        "PluginCheckAlertSystemIssue": "There is an issue with your system. The following error occurred:",
+        "PluginCheckAlertNoSystemIssues": "All plugin pre-checks were successful, no errors occurred. You can now start the actual plugin check with a click on the following button:",
         "PluginCheckStartButton": "Start plugin check",
         "PluginCheckStartButtonClicked": "Plugin check started, please wait up to 5 minutes...",
         "PluginCheckLogOutput": "Log Output",

plugin.json

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

stylesheets/pluginCheck.css

@@ -8,6 +8,10 @@
     margin-top: 0;
 }
 
+.pluginsManagement .card-content .alert.no-margin-bottom {
+    margin-bottom: 0;
+}
+
 .pluginsManagement .performance-audit-log-output {
     overflow-y: auto;
     max-height: 336px;