Improved "Auto" driver context with tests, new interface method and additional checks

Author: Geolim4

CHANGELOG_API.md

@@ -1,3 +1,6 @@
+## 2.0.2
+- Added ExtendedCacheItemPoolInterface::isUsableInAutoContext() to check if the driver is allowed to be used in 'Auto' context.
+
 ## 2.0.1
 - Implemented additional atomic methods:
 - Added ExtendedCacheItemInterface::isNull() to test if the data is null or not despite the hit/miss status.

lib/Phpfastcache/Api.php

@@ -24,7 +24,7 @@
  */
 class Api
 {
-    protected static $version = '2.0.1';
+    protected static $version = '2.0.2';
 
     /**
      * Api constructor.

lib/Phpfastcache/CacheManager.php

@@ -92,6 +92,11 @@ class CacheManager
      */
     protected static $driverCustoms = [];
 
+    /**
+     * @var array
+     */
+    protected static $badPracticeOmeter = [];
+
     /**
      * @param string $driver
      * @param array|ConfigurationOption $config
@@ -105,14 +110,8 @@ class CacheManager
      * @throws PhpfastcacheInvalidArgumentException
      * @throws PhpfastcacheDriverException
      */
-    public static function getInstance($driver = 'auto', $config = null, $instanceId = null): ExtendedCacheItemPoolInterface
+    public static function getInstance(string $driver = 'auto', $config = null, string $instanceId = null): ExtendedCacheItemPoolInterface
     {
-        static $badPracticeOmeter = [];
-
-        if ($instanceId !== null && !\is_string($instanceId)) {
-            throw new PhpfastcacheInvalidArgumentException('The Instance ID must be a string');
-        }
-
         if (\is_array($config)) {
             $config = new ConfigurationOption($config);
             trigger_error(
@@ -134,7 +133,7 @@ public static function getInstance($driver = 'auto', $config = null, $instanceId
         $instance = $instanceId ?: md5($driver . \serialize($config->toArray()));
 
         if (!isset(self::$instances[ $instance ])) {
-            $badPracticeOmeter[ $driver ] = 1;
+            self::$badPracticeOmeter[ $driver ] = 1;
             $driverClass = self::getDriverClass($driver);
 
             if(!is_a($driverClass, ExtendedCacheItemPoolInterface::class, true)){
@@ -166,12 +165,12 @@ public static function getInstance($driver = 'auto', $config = null, $instanceId
                     throw new PhpfastcacheDriverCheckException($e->getMessage(), $e->getCode(), $e);
                 }
             }
-        } else if ($badPracticeOmeter[ $driver ] >= 2) {
+        } else if (self::$badPracticeOmeter[ $driver ] >= 2) {
             trigger_error('[' . $driver . '] Calling many times CacheManager::getInstance() for already instanced drivers is a bad practice and have a significant impact on performances.
            See https://github.com/PHPSocialNetwork/phpfastcache/wiki/[V5]-Why-calling-getInstance%28%29-each-time-is-a-bad-practice-%3F');
         }
 
-        $badPracticeOmeter[ $driver ]++;
+        self::$badPracticeOmeter[ $driver ]++;
 
         return self::$instances[ $instance ];
     }
@@ -184,7 +183,7 @@ public static function getInstance($driver = 'auto', $config = null, $instanceId
      * @throws PhpfastcacheInvalidArgumentException
      * @throws PhpfastcacheInstanceNotFoundException
      */
-    public static function getInstanceById($instanceId): ExtendedCacheItemPoolInterface
+    public static function getInstanceById(string $instanceId): ExtendedCacheItemPoolInterface
     {
         if ($instanceId !== null && !\is_string($instanceId)) {
             throw new PhpfastcacheInvalidArgumentException('The Instance ID must be a string');
@@ -238,12 +237,15 @@ public static function getAutoClass(ConfigurationOption $config): string
 
         if ($autoDriver === null) {
             foreach (self::getDriverList() as $driver) {
-                try {
-                    self::getInstance($driver, $config);
-                    $autoDriver = $driver;
-                    break;
-                } catch (PhpfastcacheDriverCheckException $e) {
-                    continue;
+                /** @var ExtendedCacheItemPoolInterface $driver */
+                if((self::CORE_DRIVER_NAMESPACE . $driver . '\Driver')::isUsableInAutoContext()){
+                    try {
+                        self::getInstance($driver, $config);
+                        $autoDriver = $driver;
+                        break;
+                    } catch (PhpfastcacheDriverCheckException $e) {
+                        continue;
+                    }
                 }
             }
         }
@@ -252,6 +254,8 @@ public static function getAutoClass(ConfigurationOption $config): string
             throw new PhpfastcacheLogicException('Unable to find out a valid driver automatically');
         }
 
+        self::$badPracticeOmeter[ $autoDriver ]--;
+
         return $autoDriver;
     }
 

lib/Phpfastcache/Core/Pool/ExtendedCacheItemPoolInterface.php

@@ -530,4 +530,12 @@ public function setEventManager(EventManager $em): self;
      * @return bool
      */
     public function saveMultiple(...$items): bool;
+
+    /**
+     * Defines if the driver is allowed
+     * to be used in "Auto" driver.
+     *
+     * @return bool
+     */
+    public static function isUsableInAutoContext(): bool;
 }

lib/Phpfastcache/Core/Pool/ExtendedCacheItemPoolTrait.php

@@ -478,7 +478,9 @@ public function saveMultiple(...$items): bool
                 $this->save($item);
             }
             return true;
-        } else if (\is_array($items)) {
+        }
+
+        if (\is_array($items)) {
             foreach ($items as $item) {
                 $this->save($item);
             }
@@ -487,6 +489,14 @@ public function saveMultiple(...$items): bool
         return false;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public static function isUsableInAutoContext(): bool
+    {
+        return true;
+    }
+
     /**
      * @return string
      */

lib/Phpfastcache/Drivers/Cookie/Driver.php

@@ -150,6 +150,14 @@ protected function driverClear(): bool
         return $return;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public static function isUsableInAutoContext(): bool
+    {
+        return false;
+    }
+
     /********************
      *
      * PSR-6 Extended Methods

lib/Phpfastcache/Drivers/Devfalse/Driver.php

@@ -105,6 +105,14 @@ protected function driverConnect(): bool
         return true;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public static function isUsableInAutoContext(): bool
+    {
+        return false;
+    }
+
     /********************
      *
      * PSR-6 Extended Methods

lib/Phpfastcache/Drivers/Devnull/Driver.php

@@ -99,6 +99,14 @@ protected function driverConnect(): bool
         return true;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public static function isUsableInAutoContext(): bool
+    {
+        return false;
+    }
+
     /********************
      *
      * PSR-6 Extended Methods

lib/Phpfastcache/Drivers/Devtrue/Driver.php

@@ -103,6 +103,14 @@ protected function driverConnect(): bool
         return false;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public static function isUsableInAutoContext(): bool
+    {
+        return false;
+    }
+
     /********************
      *
      * PSR-6 Extended Methods

tests/AutoDriver.test.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <[email protected]>
+ */
+
+use Phpfastcache\CacheManager;
+use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
+use Phpfastcache\Exceptions\PhpfastcacheRootException;
+use Phpfastcache\Helper\TestHelper;
+
+chdir(__DIR__);
+require_once __DIR__ . '/../vendor/autoload.php';
+$testHelper = new TestHelper('"Auto" driver');
+
+try{
+    $driverInstance = CacheManager::getInstance('Auto');
+    if($driverInstance instanceof ExtendedCacheItemPoolInterface){
+        $testHelper->printPassText(sprintf('Found "%s" driver in "Auto" context', get_class($driverInstance)));
+    }else{
+        $testHelper->printFailText('No driver found in "Auto" context');
+    }
+
+}catch (PhpfastcacheRootException $e){
+    $testHelper->printFailText('Got an exception while trying to find a driver in "Auto" context: ' . $e->getMessage());
+}
+
+
+$testHelper->terminateTest();