PSR-6 Episode 2

.phpunit_full

@@ -1,5 +1,8 @@
 <?php
+/**
+ * @todo rework tests suite
+ */
 require_once './.phpunit';
 define('SKIP_FUNCTIONAL_TESTS', false);
 define('SKIP_INTEGRATION_TESTS', false);
-define('LLEGAZ_DEBUG', true);
+define('LLEGAZ_DEBUG', true);

composer.json

@@ -48,7 +48,7 @@
         "puf":"@phpunit-func-suite",
         "cs":"@phpcsfixer",
         "test": "./vendor/bin/phpunit --display-deprecations --display-notices --display-warnings --colors=always --configuration ./phpunit.xml --bootstrap .phpunit_full",
-        "test-only": "./vendor/bin/phpunit --display-deprecations --display-notices --display-warnings --colors=always --configuration ./phpunit.xml --bootstrap .phpunit_full --filter PoolIntegrationTest::testGetItems",
+        "test-only": "./vendor/bin/phpunit --display-deprecations --display-notices --display-warnings --colors=always --configuration ./phpunit.xml --bootstrap .phpunit_full --filter PoolIntegrationTest::testExpire",
         "test-psr16": "./vendor/bin/phpunit --display-deprecations --display-notices --display-warnings --colors=always --configuration ./phpunit.xml --bootstrap .phpunit_full --filter CacheIntegrationTest",
         "test-psr6": "./vendor/bin/phpunit --display-deprecations --display-notices --display-warnings --colors=always --configuration ./phpunit.xml --bootstrap .phpunit_full --filter PoolIntegrationTest",
         "phpunit" : "./vendor/bin/phpunit --colors=always --configuration ./phpunit.xml --testsuite unit",

src/CacheEntry/CacheEntry.php

@@ -4,16 +4,15 @@
 
 namespace LLegaz\Cache\Entry;
 
+use LLegaz\Cache\RedisCache;
 use LLegaz\Cache\Utils;
 
 class CacheEntry extends AbstractCacheEntry
 {
     private string $key;
     private mixed $value = null;
     private bool $isHit = false;
-    private ?int $ttl;
-    private bool $isTimeStamp;
-
+    private ?int $ttl = -1;
 
     public function __construct(string $key)
     {
@@ -28,11 +27,17 @@ public function __construct(string $key)
      */
     public function expiresAfter(int|\DateInterval|null $time): static
     {
-        // hexpire
         if ($time instanceof \DateInterval) {
             $this->ttl = Utils::dateIntervalToSeconds($time);
+        } elseif (is_int($time)) {
+            if ($time <= 0) {
+                $this->ttl = 0;
+            } else {
+                $this->ttl = $time;
+            }
         } else {
-            $this->ttl = $time;
+            // null case
+            $this->ttl = RedisCache::DAY_EXPIRATION_TIME; // 24h
         }
 
         $this->isTimeStamp = false;
@@ -42,9 +47,16 @@ public function expiresAfter(int|\DateInterval|null $time): static
 
     public function expiresAt(?\DateTimeInterface $expiration): static
     {
-        // hexpireat
-        $this->ttl = $expiration->getTimestamp();
-        $this->isTimeStamp = true;
+        if ($expiration) {
+            if (Utils::getNow()->diff($expiration)->invert > 0) {
+                $this->ttl = 0;
+            } else {
+                $this->ttl = $expiration->getTimestamp();
+            }
+        } else {
+            // null case
+            $this->ttl = RedisCache::DAY_EXPIRATION_TIME; // 24h
+        }
 
         return $this;
     }
@@ -83,19 +95,6 @@ public function set($value): static
         return $this;
     }
 
-    /**
-     * if true = expireAt
-     *
-     *
-     * this bool seems useless @todo : remove it
-     *
-     * @return bool
-     */
-    public function isTimeStamp(): bool
-    {
-        return $this->isTimeStamp;
-    }
-
     /**
      * return TTL in seconds OR unix timestamp
      *

src/CacheEntryPool/CacheEntryPool.php

@@ -49,7 +49,7 @@ class CacheEntryPool implements CacheItemPoolInterface
      */
     private array $deferredItems = [];
 
-    protected const HASH_DB_PREFIX = 'DEFAULT_Cache_Pool';
+    protected const HASH_DB_PREFIX = 'Cache_Pool';
 
     /**
      * @todo use Psr\SimpleCache\CacheInterface ?
@@ -63,6 +63,11 @@ public function __construct(RedisEnhancedCache $cache, ?string $pool = null)
         $this->poolName = $this->getPoolName($pool ?? '');
     }
 
+    public function __destruct()
+    {
+        $this->commit();
+    }
+
     /**
      * Deletes all items in the pool.
      *
@@ -71,9 +76,14 @@ public function __construct(RedisEnhancedCache $cache, ?string $pool = null)
      */
     public function clear(): bool
     {
+        $e = new \Exception();
+        dump('pool cleared by : ', $e->getTrace()[1]['function']);
+
         try {
             $this->cache->set($this->poolName, null);
             $this->cache->delete($this->poolName);
+            unset($this->deferredItems);
+            $this->deferredItems = [];
         } catch (Exception $e) {
             return false;
         }
@@ -83,16 +93,25 @@ public function clear(): bool
 
     public function deleteItem(string $key): bool
     {
+        if ($this->isDeferred($key)) {
+            unset($this->deferredItems[$key]);
+
+            return $this->isDeferred($key);
+        }
+
         return $this->deleteItems([$key]);
 
     }
 
     public function deleteItems(array $keys): bool
     {
-        $bln = $this->cache->deleteFromPool($keys, $this->poolName);
-        dump('deleteItems', $keys, $bln);
+        foreach ($keys as $key) {
+            if ($this->isDeferred($key)) {
+                unset($this->deferredItems[$key]);
+            }
+        }
 
-        return  $bln;/*$this->cache->deleteFromPool($keys, $this->poolName);*/
+        return $this->cache->deleteFromPool($keys, $this->poolName);
 
     }
 
@@ -114,15 +133,21 @@ public function deleteItems(array $keys): bool
      */
     public function getItem(string $key): CacheItemInterface
     {
-        $value = $this->cache->fetchFromPool($key, $this->poolName);
-        //dump('getItem', $key, $value);
-        /** @todo handle hit, ttl */
-        $item = new CacheEntry($key);
-        if ($this->exist($value)) {
-            $item->set($value);
+        /** @todo handle hit, ttl, refacto */
+        if ($this->isDeferred($key)) {
+            $item = clone $this->deferredItems[$key];
             $item->hit();
+        } else {
+            $value = $this->cache->fetchFromPool($key, $this->poolName);
+            $item = new CacheEntry($key);
+            if ($this->cache->exist($value)) {
+                $item->set($value);
+                $item->hit();
+            }
         }
 
+        dump('getItem: ' . $item->getKey(). ' - TTL= ' . $item->getTTL() . ' - ' . (is_string($item->get()) ? $item->get() : print_r($item->get())));
+        dump($item);
         return $item;
 
     }
@@ -149,15 +174,20 @@ public function getItems(array $keys = []): iterable
         $values = $this->cache->fetchFromPool($keys, $this->poolName);
         //dump($values);
         foreach ($keys as $key) {
-            /** @todo handle hit, ttl */
-            $item = new CacheEntry($key);
-            if (isset($values[$key]) && $this->exist($values[$key])) {
-                $item->set($values[$key]);
+            /** @todo handle hit, ttl and refacto */
+            if ($this->isDeferred($key)) {
+                $item = clone $this->deferredItems[$key];
                 $item->hit();
+            } else {
+                $item = new CacheEntry($key);
+                if (isset($values[$key]) && $this->cache->exist($values[$key])) {
+                    $item->set($values[$key]);
+                    $item->hit();
+                }
             }
             //$items[] = $item;
             /**
-             * because of his code (wrong)
+             * because of this code (that is wrong IMHO)
              * https://github.com/php-cache/integration-tests/blob/fb7d78718f1e5bbfd7c63e5c5734000999ac7366/src/CachePoolTest.php#L208C40-L208C44
              */
             $items[$key] = $item;
@@ -185,13 +215,17 @@ public function getItems(array $keys = []): iterable
      */
     public function hasItem(string $key): bool
     {
-        return $this->cache->hasInPool($key, $this->poolName);
+        return isset($this->deferredItems[$key]) || $this->cache->hasInPool($key, $this->poolName);
 
     }
 
     /**
      * Persists a cache item immediately.
      *
+     * <b>CRITICAL</b>: if an expiration time, a ttl or expiration date is set, THEN the
+     * <b>ENTIRE pool </b> will be expired ! Thus deleting all the pool's key values (hash fields).
+     * @caution @warning
+     *
      * @param CacheItemInterface $item
      *   The cache item to save.
      *
@@ -200,8 +234,24 @@ public function hasItem(string $key): bool
      */
     public function save(CacheItemInterface $item): bool
     {
-        //dump("save", $item);
-        return $this->cache->storeToPool([$item->getKey() => $item->get()], $this->poolName);
+        dump('savi,ng', $this->isExpired($item), $item);
+        if ($this->isExpired($item)) {
+            return false;
+        }
+
+        dump('save', $item);
+        $bln = $this->cache->storeToPool([$item->getKey() => $item->get()], $this->poolName);
+        if ($bln && $item instanceof CacheEntry && $item->getTTL() > 0) {
+            /**
+             * /!\/!\/!\/!\/!\/!\/!\/!\/!\/!\
+             * /!\  expires entire pool!  /!\
+             * /!\/!\/!\/!\/!\/!\/!\/!\/!\/!\
+             */
+            //dump('/!\  expires entire pool!  /!\\', $this->poolName, $item->getTTL());
+            $bln = $this->cache->setHsetPoolExpiration($this->poolName, $item->getTTL());
+        }
+
+        return $bln;
     }
 
     /**
@@ -215,9 +265,15 @@ public function save(CacheItemInterface $item): bool
      */
     public function saveDeferred(CacheItemInterface $item): bool
     {
-        $this->deferredItems[] = $item;
+        if (!$this->isExpired($item)) {
+            $this->deferredItems[$item->getKey()] = clone $item;
 
-        return true;
+            return true;
+        } elseif (isset($this->deferredItems[$item->getKey()])) {
+            unset($this->deferredItems[$item->getKey()]);
+        }
+
+        return false;
     }
 
     /**
@@ -228,17 +284,29 @@ public function saveDeferred(CacheItemInterface $item): bool
      */
     public function commit(): bool
     {
-        $deferred = [];
-        foreach ($this->deferredItems as $item) {
-            $deferred[$item->getKey()] = $item->get();
+        if (!count($this->deferredItems)) {
+
+            return true;
+        }
+
+        foreach ($this->deferredItems as $key => $item) {
+            if (!$this->isExpired($item)) {
+                $deferred[$key] = $item->get();
+            }
+            unset($this->deferredItems[$key]);
         }
+        $this->deferredItems = [];
 
-        return $this->cache->storeToPool($deferred);
+        return $this->cache->storeToPool($deferred, $this->poolName);
+    }
+
+    public function printCachePool(): string
+    {
+        return $this->cache->printCacheHash($this->poolName);
     }
 
     /**
      *
-     * @todo may be rework this a bit (DEFAULT everywhere lol)
      *
      * @param mixed $poolSuffix
      * @return string
@@ -247,16 +315,17 @@ protected function getPoolName(string $poolSuffix): string
     {
         return strlen($poolSuffix) ?
             self::HASH_DB_PREFIX . "_{$poolSuffix}" :
-            self::HASH_DB_PREFIX
+            'DEFAULT_' . self::HASH_DB_PREFIX
         ;
     }
 
-    private function exist(mixed $value): bool
+    private function isExpired(CacheEntry $item): bool
     {
-        if (is_string($value) && strlen($value) && $value === RedisEnhancedCache::DOES_NOT_EXIST) {
-            return false;
-        }
+        return !($item instanceof CacheEntry) || $item->getTTL() === 0;
+    }
 
-        return true;
+    private function isDeferred(string $key): bool
+    {
+        return isset($this->deferredItems[$key]) && ($this->deferredItems[$key] instanceof CacheEntry);
     }
 }

src/Exception/InvalidArgumentException.php

@@ -4,14 +4,16 @@
 
 namespace LLegaz\Cache\Exception;
 
-use Psr\Cache\InvalidArgumentException as Psr6CacheInterface;
-use Psr\SimpleCache\InvalidArgumentException as SimpleCacheInterface;
+use Psr\Cache\InvalidArgumentException as Psr6InvalidArgumentException;
+use Psr\SimpleCache\InvalidArgumentException as Psr16InvalidArgumentException;
 
 /**
  * inspired from Symfony Cache (by Nicolas Grekas)
  *
- * @todo rework all package exceptions ?
+ * PSR-6 and PSR-16 <b>InvalidArgumentException</b>
+ *
+ * @todo rework / clean all package(s) exceptions ?
  */
-class InvalidArgumentException extends \InvalidArgumentException implements Psr6CacheInterface, SimpleCacheInterface
+class InvalidArgumentException extends \InvalidArgumentException implements Psr6InvalidArgumentException, Psr16InvalidArgumentException
 {
 }

src/Exception/InvalidKeyException.php

@@ -4,9 +4,11 @@
 
 namespace LLegaz\Cache\Exception;
 
-use Psr\SimpleCache\InvalidArgumentException;
-
-class InvalidKeyException extends \Exception implements InvalidArgumentException
+/**
+ *
+ * PSR-6 and PSR-16 <b>InvalidArgumentException</b>
+ */
+class InvalidKeyException extends InvalidArgumentException
 {
     public function __construct(string $message = 'RedisCache says "Can\'t do shit with this Key"' . PHP_EOL, int $code = 400, \Throwable $previous = null)
     {

src/Exception/InvalidKeysException.php

@@ -4,9 +4,11 @@
 
 namespace LLegaz\Cache\Exception;
 
-use Psr\SimpleCache\InvalidArgumentException;
-
-class InvalidKeysException extends \Exception implements InvalidArgumentException
+/**
+ *
+ * PSR-6 and PSR-16 <b>InvalidArgumentException</b>
+ */
+class InvalidKeysException extends InvalidArgumentException
 {
     public function __construct(string $message = 'RedisCache says "Can\'t do shit with those keys"' . PHP_EOL, int $code = 400, \Throwable $previous = null)
     {