Fixed #893 // getItemsByTag() - empty after one item has expired

Author: Geolim4

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -82,10 +82,11 @@ body:
         See our [global support timeline](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV4%CB%96%5D-Global-support-timeline) ⌚
       multiple: false
       options:
-        - 9.1.2 ✅
-        - 9.1.1 🔶
-        - 9.1.0 🔶
-        - 9.1.0-dev 🔶
+        - 9.1.3 ✅
+        - 9.1.2 🔶
+        - 9.1.1 ❌
+        - 9.1.0 ❌
+        - 9.1.0-dev ❌
         - 9.0.2 ❌
         - 9.0.1 ❌
         - 9.0.0-rc ❌
@@ -99,7 +100,8 @@ body:
         - 9.0.0-alpha ❌
         - 9.0.0-dev ❌
         - 9.0.0 ❌
-        - 8.1.3 🔶
+        - 8.1.4 🔶
+        - 8.1.3 ❌
         - 8.1.2 ❌
         - 8.1.1 ❌
         - 8.1.0 ❌

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 9.1.2
+##### 12 february 2023
+- __Core__
+  - Fixed #893 // getItemsByTag() - empty after one item has expired
+- __Misc__
+  - Fixed multiple code typo & updated README.md
+
 ## 9.1.2
 ##### 09 june 2022
 - __API__

composer.json

@@ -23,7 +23,16 @@
         "psr/cache": "^2.0||^3.0",
         "psr/simple-cache": "^2.0||^3.0",
         "ext-mbstring": "*",
-        "ext-json": "*"
+        "ext-json": "*",
+        "doctrine/couchdb": "dev-master",
+        "phpfastcache/phpssdb": "~1.1",
+        "predis/predis": "~1.1",
+        "mongodb/mongodb": "~1.9",
+        "triagens/arangodb": "~3.8",
+        "aws/aws-sdk-php": "~3.2",
+        "google/cloud-firestore": "~1.20",
+        "solarium/solarium": "~6.1",
+        "symfony/var-dumper": "^6.0"
     },
     "require-dev": {
         "league/climate": "^3.8",

lib/Phpfastcache/Core/Pool/TaggableCacheItemPoolTrait.php

@@ -102,9 +102,9 @@ public function getItemsByTags(array $tagNames, int $strategy = TaggableCacheIte
     protected function fetchItemsByTagFromBackend(string $tagName): array
     {
         $driverResponse = $this->getItem($this->getTagKey($tagName));
+
         if ($driverResponse->isHit()) {
             $tagsItems = (array)$driverResponse->get();
-
             /**
              * getItems() may provide expired item(s)
              * themselves provided by a cache of item
@@ -407,9 +407,21 @@ protected function driverWriteTags(ExtendedCacheItemInterface $item): bool
              * avoid to use array_unique
              * that has slow performances
              */
+            $data = \array_merge((array)$data, [$item->getKey() => $expTimestamp]);
+            $tagsItem->set($data);
 
-            $tagsItem->set(\array_merge((array)$data, [$item->getKey() => $expTimestamp]))
-                ->expiresAt($item->getExpirationDate());
+            if (!$tagsItem->isHit() || $tagsItem->getExpirationDate() < $item->getExpirationDate()) {
+                $tagsItem->expiresAt($item->getExpirationDate());
+            }
+
+            /**
+             * Recalculate the expiration date
+             *
+             * If the $tagsItem does not have
+             * any cache item references left
+             * then remove it from tagsItems index
+             */
+            $tagsItem->expiresAt((new DateTime())->setTimestamp(max($data)));
 
             $this->driverWrite($tagsItem);
             $tagsItem->setHit(true);

tests/Arangodb.test.php

@@ -13,9 +13,7 @@
  */
 
 use Phpfastcache\CacheManager;
-use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Drivers\Arangodb\Config as ArangodbConfig;
-use Phpfastcache\Event\EventReferenceParameter;
 use Phpfastcache\EventManager;
 use Phpfastcache\Exceptions\PhpfastcacheDriverConnectException;
 use Phpfastcache\Tests\Helper\TestHelper;

tests/Couchbasev3.test.php

@@ -33,7 +33,7 @@
     $cacheInstance = CacheManager::getInstance('Couchbasev3', $config);
     $testHelper->runCRUDTests($cacheInstance);
 } catch (PhpfastcacheDriverConnectException $e) {
-    $testHelper->assertSkip('Couchdb server unavailable: ' . $e->getMessage());
+    $testHelper->assertSkip('Couchbase server unavailable: ' . $e->getMessage());
     $testHelper->terminateTest();
 }
 $testHelper->terminateTest();

tests/Mongodb.test.php

@@ -14,7 +14,6 @@
 
 use Phpfastcache\CacheManager;
 use Phpfastcache\Drivers\Mongodb\Config;
-use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;
 use Phpfastcache\Tests\Helper\TestHelper;
 
 chdir(__DIR__);

tests/issues/Github-893.test.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * @author Khoa Bui (khoaofgod)  <[email protected]> https://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <[email protected]>
+ */
+
+use Phpfastcache\CacheManager;
+use Phpfastcache\Drivers\Files\Config as FilesConfig;
+use Phpfastcache\Tests\Helper\TestHelper;
+
+chdir(__DIR__);
+require_once __DIR__ . '/../../vendor/autoload.php';
+$testHelper = new TestHelper('Github issue #893 - getItemsByTag() - empty after one item has expired');
+
+$config = new FilesConfig();
+$testHelper->preConfigure($config);
+$cacheInstance = CacheManager::getInstance('Files', $config);
+$cacheInstance->clear();
+
+$testHelper->printInfoText('Creating cache item "key_1" & "key_2"...');
+
+$CachedString1 = $cacheInstance->getItem("key_1");
+if (is_null($CachedString1->get())) {
+    $CachedString1->set("data1")->expiresAfter(10);
+    $CachedString1->addTag("query");
+    $cacheInstance->save($CachedString1);
+}
+
+
+$CachedString2 = $cacheInstance->getItem("key_2");
+if (is_null($CachedString2->get())) {
+    $CachedString2->set("data2")->expiresAfter(5);
+    $CachedString2->addTag("query");
+    $cacheInstance->save($CachedString2);
+}
+
+$cacheInstance->detachAllItems();
+$testHelper->printInfoText('Items created and saved, sleeping 6 secondes to force "key_1" to expire');
+sleep(6);
+
+$cacheItems = $cacheInstance->getItemsByTag("query");
+
+if(count($cacheItems) === 1 && isset($cacheItems['key_1']) && $cacheItems['key_1']->get() === 'data1') {
+    $testHelper->assertPass('getItemsByTag() has returned only cache item "key_1"');
+} else {
+    $testHelper->assertFail(sprintf('getItemsByTag() returned unknown results: %d item(s)...', \count($cacheItems)));
+}
+
+$testHelper->terminateTest();

tests/lib/Helper/TestHelper.php

@@ -570,11 +570,12 @@ public function exceptionHandler(Throwable $exception): void
         } elseif ($exception instanceof PhpfastcacheDriverConnectException) {
             $this->assertSkip('A driver could not be initialized due to network/authentication issue: ' . $exception->getMessage());
         } else {
+            $relativeFilename = '~' . str_replace($this->getProjectDir(), '', realpath($exception->getFile()));
             $this->assertFail(
                 \sprintf(
                     'Uncaught exception "%s" in "%s" line %d with message: "%s"',
                     get_class($exception),
-                    $exception->getFile(),
+                    str_replace('\\', '/', $relativeFilename),
                     $exception->getLine(),
                     $exception->getMessage()
                 )
@@ -583,6 +584,11 @@ public function exceptionHandler(Throwable $exception): void
         $this->terminateTest();
     }
 
+    public function getProjectDir(): string {
+
+        return dirname(__DIR__, 3);
+    }
+
     public function getRandomKey(string $prefix = 'test_', int $minBlockLength = 3): string
     {
         return $prefix . \implode(