Fixed #529 // Memory leak caused by item tags

Author: Geolim4

src/phpFastCache/Cache/DriverBaseTrait.php

@@ -268,7 +268,7 @@ public function driverWriteTags(ExtendedCacheItemInterface $item)
              * then remove it from tagsItems index
              */
             if (count($data)) {
-                $tagsItem->expiresAt(max($data));
+                $tagsItem->expiresAt((new \DateTime())->setTimestamp(max($data)));
                 $this->driverWrite($tagsItem);
                 $tagsItem->setHit(true);
             } else {

src/phpFastCache/Cache/ItemBaseTrait.php

@@ -131,7 +131,7 @@ public function expiresAt($expiration)
         if ($expiration instanceof \DateTimeInterface) {
             $this->expirationDate = $expiration;
         } else {
-            throw new \InvalidArgumentException('$expiration must be an object implementing the DateTimeInterface');
+            throw new phpFastCacheInvalidArgumentException('$expiration must be an object implementing the DateTimeInterface got: ' . gettype($expiration));
         }
 
         return $this;

src/phpFastCache/Core/ExtendedCacheItemPoolTrait.php

@@ -350,6 +350,13 @@ protected function deregisterItem($item)
             gc_collect_cycles();
         }
     }
+    /**
+     * @param ExtendedCacheItemInterface $item
+     */
+    protected function cleanItemTags(ExtendedCacheItemInterface $item)
+    {
+        $this->driverWriteTags($item->removeTags($item->getTags()));
+    }
 
     /**
      * Returns true if the item exists, is attached and the Spl Hash matches

src/phpFastCache/Core/StandardPsr6StructureTrait.php

@@ -164,6 +164,13 @@ public function deleteItem($key)
              */
             $this->deregisterItem($key);
 
+            /**
+             * Perform a tag cleanup to avoid memory leaks
+             */
+            if (strpos($key, self::DRIVER_TAGS_KEY_PREFIX) !== 0) {
+                $this->cleanItemTags($item);
+            }
+
             return true;
         }
 

tests/issues/Github-529.test.php

@@ -0,0 +1,71 @@
+<?php
+
+/**
+ * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <[email protected]>
+ */
+
+use phpFastCache\CacheManager;
+use phpFastCache\Helper\TestHelper;
+
+chdir(__DIR__);
+require_once __DIR__ . '/../../vendor/autoload.php';
+
+/**
+ * @param $obj
+ * @param $prop
+ * @return mixed
+ * @throws \ReflectionException
+ */
+function accessInaccessibleMember($obj, $prop) {
+    $reflection = new \ReflectionClass($obj);
+    $property = $reflection->getProperty($prop);
+    $property->setAccessible(true);
+    return $property->getValue($obj);
+}
+
+// Hide php Redis extension notice by using a little @
+$cacheInstance = CacheManager::getInstance('Files');
+$string = uniqid('pfc', true);
+
+/**
+ * Populate the cache with some data
+ */
+list($item, $item2) = array_values($cacheInstance->getItems(['item1', 'item2']));
+
+$item->set($string)
+  ->addTags(['tag-all', 'tag1'])
+  ->expiresAfter(3600);
+
+$item2->set($string)
+  ->addTags(['tag-all', 'tag2'])
+  ->expiresAfter(3600);
+
+$cacheInstance->save($item);
+$cacheInstance->save($item2);
+$cacheInstance->detachAllItems();
+unset($item, $item2);
+
+/**
+ * Destroy the populated items
+ */
+$cacheInstance->deleteItemsByTag('tag-all');
+
+/**
+ * First test memory, as we will write the item inside in the second test
+ */
+$itemInstances = accessInaccessibleMember($cacheInstance, 'itemInstances');
+if (isset($itemInstances[$cacheInstance::DRIVER_TAGS_KEY_PREFIX . 'tag-all'])) {
+    echo '[FAIL] The internal cache item tag is still stored in memory' . PHP_EOL;
+} else {
+    echo '[PASS] The internal cache item tag is no longer stored in memory' . PHP_EOL;
+}
+
+/**
+ * Then test disk to see if the item is still there
+ */
+if ($cacheInstance->getItem($cacheInstance::DRIVER_TAGS_KEY_PREFIX . 'tag-all')->isHit()) {
+    echo '[FAIL] The internal cache item tag is still stored on disk' . PHP_EOL;
+} else {
+    echo '[PASS] The internal cache item tag is no longer stored on disk' . PHP_EOL;
+}