Make Tracking::enabled not use statics as it does mess up with tests

Signed-off-by: William Desportes <williamdes@wdes.fr>
phpmyadmin · Aug 24, 2021 · 36e24d1 · 36e24d1
1 parent 2c28a71
commit 36e24d1
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 29 deletions.
diff --git a/libraries/classes/Tracker.php b/libraries/classes/Tracker.php
@@ -41,12 +41,7 @@
  */
 class Tracker
 {
-    /**
-     * Whether tracking is ready.
-     *
-     * @var bool
-     */
-    protected static $enabled = false;
+    public const TRACKER_ENABLED_CACHE_KEY = 'phpmyadmin.tracker.enabled';
 
     /**
      * Cache to avoid quering tracking status multiple times.
@@ -58,14 +53,10 @@ class Tracker
     /**
      * Actually enables tracking. This needs to be done after all
      * underlaying code is initialized.
-     *
-     * @return void
-     *
-     * @static
      */
-    public static function enable()
+    public static function enable(): void
     {
-        self::$enabled = true;
+        Cache::set(self::TRACKER_ENABLED_CACHE_KEY, true);
     }
 
     /**
@@ -79,19 +70,20 @@ public static function isActive()
     {
         global $dbi;
 
-        if (! self::$enabled) {
+        $trackingEnabled = Cache::get(self::TRACKER_ENABLED_CACHE_KEY, false);
+        if (! $trackingEnabled) {
             return false;
         }
 
         /**
          * We need to avoid attempt to track any queries
          * from Relation::getRelationsParam
          */
-        self::$enabled = false;
+        Cache::set(self::TRACKER_ENABLED_CACHE_KEY, false);
         $relation = new Relation($dbi);
         $cfgRelation = $relation->getRelationsParam();
         /* Restore original state */
-        self::$enabled = true;
+        Cache::set(self::TRACKER_ENABLED_CACHE_KEY, true);
         if (! $cfgRelation['trackingwork']) {
             return false;
         }
@@ -142,7 +134,8 @@ public static function isTracked($dbName, $tableName)
     {
         global $dbi;
 
-        if (! self::$enabled) {
+        $trackingEnabled = Cache::get(self::TRACKER_ENABLED_CACHE_KEY, false);
+        if (! $trackingEnabled) {
             return false;
         }
 
@@ -154,11 +147,11 @@ public static function isTracked($dbName, $tableName)
          * We need to avoid attempt to track any queries
          * from Relation::getRelationsParam
          */
-        self::$enabled = false;
+        Cache::set(self::TRACKER_ENABLED_CACHE_KEY, false);
         $relation = new Relation($dbi);
         $cfgRelation = $relation->getRelationsParam();
         /* Restore original state */
-        self::$enabled = true;
+        Cache::set(self::TRACKER_ENABLED_CACHE_KEY, true);
         if (! $cfgRelation['trackingwork']) {
             return false;
         }

diff --git a/test/classes/TrackerTest.php b/test/classes/TrackerTest.php
@@ -4,12 +4,12 @@
 
 namespace PhpMyAdmin\Tests;
 
+use PhpMyAdmin\Cache;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Tracker;
 use PhpMyAdmin\Util;
 use PhpMyAdmin\Version;
 use ReflectionMethod;
-use ReflectionProperty;
 
 /**
  * @covers \PhpMyAdmin\Tracker
@@ -53,12 +53,12 @@ protected function setUp(): void
      */
     public function testEnabled(): void
     {
-        $reflection = new ReflectionProperty(Tracker::class, 'enabled');
-        $reflection->setAccessible(true);
-
+        $this->assertFalse(
+            Cache::has(Tracker::TRACKER_ENABLED_CACHE_KEY)
+        );
         Tracker::enable();
         $this->assertTrue(
-            $reflection->getValue()
+            Cache::get(Tracker::TRACKER_ENABLED_CACHE_KEY)
         );
     }
 
@@ -67,9 +67,9 @@ public function testEnabled(): void
      */
     public function testIsActive(): void
     {
-        $attr = new ReflectionProperty(Tracker::class, 'enabled');
-        $attr->setAccessible(true);
-        $attr->setValue(false);
+        $this->assertFalse(
+            Cache::has(Tracker::TRACKER_ENABLED_CACHE_KEY)
+        );
 
         $this->assertFalse(
             Tracker::isActive()
@@ -142,9 +142,9 @@ public function getTableNameData(): array
      */
     public function testIsTracked(): void
     {
-        $attr = new ReflectionProperty(Tracker::class, 'enabled');
-        $attr->setAccessible(true);
-        $attr->setValue(false);
+        $this->assertFalse(
+            Cache::has(Tracker::TRACKER_ENABLED_CACHE_KEY)
+        );
 
         $this->assertFalse(
             Tracker::isTracked('', '')