Merge pull request #863 from PHPSocialNetwork/v9

Geolim4 · web-flow · commit 517741c800f8 · 2022-04-15T23:25:40.000+02:00
Released 9.1.1
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -9,9 +9,10 @@
 # @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
 #
 
-before_commands: 
-  - "./bin/ci/scripts/install_dependencies.sh"
 build:
+  dependencies:
+    override:
+      - "composer require -W --ignore-platform-reqs 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"
   nodes:
     analysis:
       project_setup:
@@ -21,7 +22,14 @@ build:
   environment: 
     php: 
       version: 8.0.0
-checks: 
+      ini:
+        date.timezone: 'Europe/Paris'
+      pecl_extensions:
+        # - couchbase
+        # - grpc
+        - redis
+        - memcache
+checks:
   php: true
 coding_style: 
   php: 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+## 9.1.1
+##### _Date to be defined_
+- __Core__
+  - Fixed #860 // Cache item throw an error on reading with DateTimeImmutable date objects
+  - Fixed an issue with tags not properly reinitialized when a backend driver returns an expired cache item
+- __Drivers__
+  - Fixed #862 // Multiple driver errors caused by invalid return type of `driverRead()` (reported by @ShockedPlot7560 and @aemla)
+
 ## 9.1.0
 ##### 04 april 2022
 - __API__
diff --git a/lib/Phpfastcache/Core/Item/CacheItemTrait.php b/lib/Phpfastcache/Core/Item/CacheItemTrait.php
@@ -102,7 +102,7 @@ public function expiresAt(?\DateTimeInterface $expiration): static
     {
         if ($expiration instanceof DateTimeInterface) {
             $this->eventManager->dispatch(Event::CACHE_ITEM_EXPIRE_AT, $this, $expiration);
-            $this->expirationDate = $expiration;
+            $this->expirationDate = $this->demutateDatetime($expiration);
         } else {
             throw new PhpfastcacheInvalidArgumentException('$expiration must be an object implementing the DateTimeInterface got: ' . \gettype($expiration));
         }
@@ -139,4 +139,11 @@ public function expiresAfter(int|\DateInterval|null $time): static
 
         return $this;
     }
+
+    protected function demutateDatetime(\DateTimeInterface $dateTime): \DateTimeInterface
+    {
+        return $dateTime instanceof \DateTimeImmutable
+            ? \DateTime::createFromImmutable($dateTime)
+            : $dateTime;
+    }
 }
diff --git a/lib/Phpfastcache/Core/Item/ExtendedCacheItemTrait.php b/lib/Phpfastcache/Core/Item/ExtendedCacheItemTrait.php
@@ -136,7 +136,7 @@ public function getCreationDate(): DateTimeInterface
     public function setCreationDate(DateTimeInterface $date): ExtendedCacheItemInterface
     {
         if ($this->driver->getConfig()->isItemDetailedDate()) {
-            $this->creationDate = $date;
+            $this->creationDate = $this->demutateDatetime($date);
             return $this;
         }
 
@@ -163,7 +163,7 @@ public function getModificationDate(): DateTimeInterface
     public function setModificationDate(DateTimeInterface $date): ExtendedCacheItemInterface
     {
         if ($this->driver->getConfig()->isItemDetailedDate()) {
-            $this->modificationDate = $date;
+            $this->modificationDate = $this->demutateDatetime($date);
             return $this;
         }
 
diff --git a/lib/Phpfastcache/Core/Item/TaggableCacheItemTrait.php b/lib/Phpfastcache/Core/Item/TaggableCacheItemTrait.php
@@ -90,12 +90,10 @@ public function hasTags(array $tagNames, int $strategy = TaggableCacheItemInterf
      */
     public function setTags(array $tags): ExtendedCacheItemInterface
     {
-        if (\count($tags)) {
-            if (\array_filter($tags, 'is_string')) {
-                $this->tags = $tags;
-            } else {
-                throw new PhpfastcacheInvalidArgumentException('$tagName must be an array of string');
-            }
+        if ($tags === [] || \array_filter($tags, 'is_string')) {
+            $this->tags = $tags;
+        } else {
+            throw new PhpfastcacheInvalidArgumentException('$tagName must be an array of string');
         }
 
         return $this;
diff --git a/lib/Phpfastcache/Core/Pool/DriverBaseTrait.php b/lib/Phpfastcache/Core/Pool/DriverBaseTrait.php
@@ -203,11 +203,11 @@ public function driverUnwrapData(array $wrapper): mixed
 
     /**
      * @param array $wrapper
-     * @return DateTime
+     * @return DateTimeInterface
      */
-    public function driverUnwrapEdate(array $wrapper): \DateTime
+    public function driverUnwrapEdate(array $wrapper): \DateTimeInterface
     {
-        if ($wrapper[self::DRIVER_EDATE_WRAPPER_INDEX] instanceof \DateTime) {
+        if ($wrapper[self::DRIVER_EDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {
             return $wrapper[self::DRIVER_EDATE_WRAPPER_INDEX];
         }
 
@@ -216,11 +216,11 @@ public function driverUnwrapEdate(array $wrapper): \DateTime
 
     /**
      * @param array $wrapper
-     * @return DateTime|null
+     * @return DateTimeInterface|null
      */
-    public function driverUnwrapCdate(array $wrapper): ?\DateTime
+    public function driverUnwrapCdate(array $wrapper): ?\DateTimeInterface
     {
-        if ($wrapper[self::DRIVER_CDATE_WRAPPER_INDEX] instanceof \DateTime) {
+        if ($wrapper[self::DRIVER_CDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {
             return $wrapper[self::DRIVER_CDATE_WRAPPER_INDEX];
         }
 
@@ -229,11 +229,11 @@ public function driverUnwrapCdate(array $wrapper): ?\DateTime
 
     /**
      * @param array $wrapper
-     * @return DateTime|null
+     * @return DateTimeInterface|null
      */
-    public function driverUnwrapMdate(array $wrapper): ?\DateTime
+    public function driverUnwrapMdate(array $wrapper): ?\DateTimeInterface
     {
-        if ($wrapper[self::DRIVER_MDATE_WRAPPER_INDEX] instanceof \DateTime) {
+        if ($wrapper[self::DRIVER_MDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {
             return $wrapper[self::DRIVER_MDATE_WRAPPER_INDEX];
         }
 
@@ -269,6 +269,6 @@ protected function encode($data): string
      */
     protected function decode(?string $value): mixed
     {
-        return \unserialize((string) $value, ['allowed_classes' => true]);
+        return $value ? \unserialize($value, ['allowed_classes' => true]) : null;
     }
 }
diff --git a/lib/Phpfastcache/Drivers/Apcu/Driver.php b/lib/Phpfastcache/Drivers/Apcu/Driver.php
@@ -92,7 +92,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {
         $data = apcu_fetch($item->getKey(), $success);
 
-        if ($success === false) {
+        if ($success === false || !\is_array($data)) {
             return null;
         }
 
diff --git a/lib/Phpfastcache/Drivers/Arangodb/Driver.php b/lib/Phpfastcache/Drivers/Arangodb/Driver.php
@@ -131,7 +131,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array
                 return null;
             }
             throw new PhpfastcacheDriverException(
-                'Got unexpeced error from Arangodb: ' . $e->getMessage()
+                'Got unexpected error from Arangodb: ' . $e->getMessage()
             );
         }
 
diff --git a/lib/Phpfastcache/Drivers/Cassandra/Driver.php b/lib/Phpfastcache/Drivers/Cassandra/Driver.php
@@ -140,7 +140,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array
             $results = $this->instance->execute(new Cassandra\SimpleStatement($query), $options);
 
             if ($results instanceof Cassandra\Rows && $results->count() === 1) {
-                return $this->decode($results->first()['cache_data']);
+                return $this->decode($results->first()['cache_data']) ?: null;
             }
 
             return null;
diff --git a/lib/Phpfastcache/Drivers/Couchdb/Driver.php b/lib/Phpfastcache/Drivers/Couchdb/Driver.php
@@ -257,7 +257,7 @@ protected function encodeDocument(array $data): array
      * @return mixed
      * @throws \Exception
      */
-    protected function decode($value): mixed
+    protected function decode($value): array
     {
         $value[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX] = \unserialize(
             $value[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX],
diff --git a/lib/Phpfastcache/Drivers/Memcache/Driver.php b/lib/Phpfastcache/Drivers/Memcache/Driver.php
@@ -149,7 +149,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {
         $val = $this->instance->get($item->getKey());
 
-        if ($val === false) {
+        if (empty($val) || !\is_array($val)) {
             return null;
         }
 
diff --git a/lib/Phpfastcache/Drivers/Memcached/Driver.php b/lib/Phpfastcache/Drivers/Memcached/Driver.php
@@ -147,7 +147,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {
         $val = $this->instance->get($item->getKey());
 
-        if ($val === false) {
+        if (empty($val) || !\is_array($val)) {
             return null;
         }
 
diff --git a/lib/Phpfastcache/Drivers/Predis/Driver.php b/lib/Phpfastcache/Drivers/Predis/Driver.php
@@ -143,7 +143,8 @@ protected function driverConnect(): bool
     protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {
         $val = $this->instance->get($item->getKey());
-        if ($val == false) {
+
+        if ($val === null) {
             return null;
         }
 
diff --git a/lib/Phpfastcache/Drivers/Redis/Driver.php b/lib/Phpfastcache/Drivers/Redis/Driver.php
@@ -57,8 +57,9 @@ public function getStats(): DriverStatistic
             ->setSize((int)$info['used_memory'])
             ->setInfo(
                 sprintf(
-                    "The Redis daemon v%s is up since %s.\n For more information see RawData. \n Driver size includes the memory allocation size.",
+                    "The Redis daemon v%s, php-ext v%s, is up since %s.\n For more information see RawData. \n Driver size includes the memory allocation size.",
                     $info['redis_version'],
+                    \phpversion("redis"),
                     $date->format(DATE_RFC2822)
                 )
             );
diff --git a/lib/Phpfastcache/Drivers/Ssdb/Driver.php b/lib/Phpfastcache/Drivers/Ssdb/Driver.php
@@ -94,7 +94,8 @@ protected function driverConnect(): bool
     protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {
         $val = $this->instance->get($item->getEncodedKey());
-        if (!$val) {
+
+        if (empty($val)) {
             return null;
         }
 
diff --git a/lib/Phpfastcache/Drivers/Wincache/Driver.php b/lib/Phpfastcache/Drivers/Wincache/Driver.php
@@ -72,7 +72,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {
         $val = wincache_ucache_get($item->getKey(), $suc);
 
-        if ($suc === false) {
+        if ($suc === false || empty($val)) {
             return null;
         }
 
diff --git a/lib/Phpfastcache/Drivers/Zenddisk/Driver.php b/lib/Phpfastcache/Drivers/Zenddisk/Driver.php
@@ -80,7 +80,8 @@ protected function driverConnect(): bool
     protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {
         $data = zend_disk_cache_fetch($item->getKey());
-        if ($data === false) {
+
+        if (empty($data) || !\is_array($data)) {
             return null;
         }
 
diff --git a/lib/Phpfastcache/Drivers/Zendshm/Driver.php b/lib/Phpfastcache/Drivers/Zendshm/Driver.php
@@ -79,7 +79,8 @@ protected function driverConnect(): bool
     protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {
         $data = zend_shm_cache_fetch($item->getKey());
-        if ($data === false) {
+
+        if (empty($data) || !\is_array($data)) {
             return null;
         }
 
diff --git a/tests/Memcached.test.php b/tests/Memcached.test.php
@@ -13,6 +13,7 @@
  */
 
 use Phpfastcache\CacheManager;
+use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Drivers\Memcached\Config as MemcachedConfig;
 use Phpfastcache\Tests\Helper\TestHelper;
 
@@ -82,4 +83,6 @@
 $cacheInstanceDefSyntax->clear();
 $cacheInstanceOldSyntax->clear();
 $cacheInstanceNewSyntax->clear();
+
+$testHelper->runCRUDTests($cacheInstanceNewSyntax);
 $testHelper->terminateTest();
diff --git a/tests/issues/Github-860.test.php b/tests/issues/Github-860.test.php
@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @author Khoa Bui (khoaofgod)  <khoaofgod@gmail.com> https://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <contact@geolim4.com>
+ */
+
+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 #860 - Cache item throw an error on reading with DateTimeImmutable date objects');
+
+$config = new FilesConfig();
+$testHelper->preConfigure($config);
+$cacheInstance = CacheManager::getInstance('Files', $config);
+$cacheInstance->clear();
+
+try {
+    $key = 'pfc_' . bin2hex(random_bytes(12));
+    $item = $cacheInstance->getItem($key);
+    $item->set(random_int(1000, 999999))
+        ->setExpirationDate(new DateTimeImmutable('+1 month'))
+        ->setCreationDate(new DateTimeImmutable())
+        ->setModificationDate(new DateTimeImmutable('+1 week'));
+    $cacheInstance->save($item);
+    $cacheInstance->detachAllItems();
+    $item = $cacheInstance->getItem($key);
+    $testHelper->assertPass('Github issue #860 have not regressed.');
+} catch (\TypeError $e) {
+    $testHelper->assertFail('Github issue #860 have regressed, exception caught: ' . $e->getMessage());
+}
+
diff --git a/tests/lib/Helper/TestHelper.php b/tests/lib/Helper/TestHelper.php
@@ -550,11 +550,12 @@ public function runCRUDTests(ExtendedCacheItemPoolInterface|PhpfastcacheAbstract
                 $pool->getIO()->getWriteHit()
             )
         );
-        $this->printInfoText('<yellow>Driver info</yellow>: <magenta>' . $pool->getStats()->getInfo() . '</magenta>');
-        $poolSize = $pool->getStats()->getSize();
+        $stats = $pool->getStats();
+        $this->printInfoText('<yellow>Driver info</yellow>: <magenta>' . $stats->getInfo() . '</magenta>');
+        $poolSize = $stats->getSize();
 
         if($poolSize){
-            $this->printInfoText('<yellow>Driver size</yellow> (approximative): <magenta>' . round($pool->getStats()->getSize() / (1024 ** 2), 3) . ' Mo</magenta>');
+            $this->printInfoText('<yellow>Driver size</yellow> (approximative): <magenta>' . round($stats->getSize() / (1024 ** 2), 3) . ' Mo</magenta>');
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ public function expiresAt(?\DateTimeInterface $expiration): static`
`102`	`102`	`{`
`103`	`103`	`if ($expiration instanceof DateTimeInterface) {`
`104`	`104`	`$this->eventManager->dispatch(Event::CACHE_ITEM_EXPIRE_AT, $this, $expiration);`
`105`		`- $this->expirationDate = $expiration;`
	`105`	`+ $this->expirationDate = $this->demutateDatetime($expiration);`
`106`	`106`	`} else {`
`107`	`107`	`throw new PhpfastcacheInvalidArgumentException('$expiration must be an object implementing the DateTimeInterface got: ' . \gettype($expiration));`
`108`	`108`	`}`
`@@ -139,4 +139,11 @@ public function expiresAfter(int\|\DateInterval\|null $time): static`
`139`	`139`
`140`	`140`	`return $this;`
`141`	`141`	`}`
	`142`	`+`
	`143`	`+ protected function demutateDatetime(\DateTimeInterface $dateTime): \DateTimeInterface`
	`144`	`+ {`
	`145`	`+ return $dateTime instanceof \DateTimeImmutable`
	`146`	`+ ? \DateTime::createFromImmutable($dateTime)`
	`147`	`+ : $dateTime;`
	`148`	`+ }`
`142`	`149`	`}`
Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ public function getCreationDate(): DateTimeInterface`
`136`	`136`	`public function setCreationDate(DateTimeInterface $date): ExtendedCacheItemInterface`
`137`	`137`	`{`
`138`	`138`	`if ($this->driver->getConfig()->isItemDetailedDate()) {`
`139`		`- $this->creationDate = $date;`
	`139`	`+ $this->creationDate = $this->demutateDatetime($date);`
`140`	`140`	`return $this;`
`141`	`141`	`}`
`142`	`142`
`@@ -163,7 +163,7 @@ public function getModificationDate(): DateTimeInterface`
`163`	`163`	`public function setModificationDate(DateTimeInterface $date): ExtendedCacheItemInterface`
`164`	`164`	`{`
`165`	`165`	`if ($this->driver->getConfig()->isItemDetailedDate()) {`
`166`		`- $this->modificationDate = $date;`
	`166`	`+ $this->modificationDate = $this->demutateDatetime($date);`
`167`	`167`	`return $this;`
`168`	`168`	`}`
`169`	`169`
Original file line number	Diff line number	Diff line change
`@@ -203,11 +203,11 @@ public function driverUnwrapData(array $wrapper): mixed`
`203`	`203`
`204`	`204`	`/**`
`205`	`205`	`* @param array $wrapper`
`206`		`- * @return DateTime`
	`206`	`+ * @return DateTimeInterface`
`207`	`207`	`*/`
`208`		`- public function driverUnwrapEdate(array $wrapper): \DateTime`
	`208`	`+ public function driverUnwrapEdate(array $wrapper): \DateTimeInterface`
`209`	`209`	`{`
`210`		`- if ($wrapper[self::DRIVER_EDATE_WRAPPER_INDEX] instanceof \DateTime) {`
	`210`	`+ if ($wrapper[self::DRIVER_EDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {`
`211`	`211`	`return $wrapper[self::DRIVER_EDATE_WRAPPER_INDEX];`
`212`	`212`	`}`
`213`	`213`
`@@ -216,11 +216,11 @@ public function driverUnwrapEdate(array $wrapper): \DateTime`
`216`	`216`
`217`	`217`	`/**`
`218`	`218`	`* @param array $wrapper`
`219`		`- * @return DateTime\|null`
	`219`	`+ * @return DateTimeInterface\|null`
`220`	`220`	`*/`
`221`		`- public function driverUnwrapCdate(array $wrapper): ?\DateTime`
	`221`	`+ public function driverUnwrapCdate(array $wrapper): ?\DateTimeInterface`
`222`	`222`	`{`
`223`		`- if ($wrapper[self::DRIVER_CDATE_WRAPPER_INDEX] instanceof \DateTime) {`
	`223`	`+ if ($wrapper[self::DRIVER_CDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {`
`224`	`224`	`return $wrapper[self::DRIVER_CDATE_WRAPPER_INDEX];`
`225`	`225`	`}`
`226`	`226`
`@@ -229,11 +229,11 @@ public function driverUnwrapCdate(array $wrapper): ?\DateTime`
`229`	`229`
`230`	`230`	`/**`
`231`	`231`	`* @param array $wrapper`
`232`		`- * @return DateTime\|null`
	`232`	`+ * @return DateTimeInterface\|null`
`233`	`233`	`*/`
`234`		`- public function driverUnwrapMdate(array $wrapper): ?\DateTime`
	`234`	`+ public function driverUnwrapMdate(array $wrapper): ?\DateTimeInterface`
`235`	`235`	`{`
`236`		`- if ($wrapper[self::DRIVER_MDATE_WRAPPER_INDEX] instanceof \DateTime) {`
	`236`	`+ if ($wrapper[self::DRIVER_MDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {`
`237`	`237`	`return $wrapper[self::DRIVER_MDATE_WRAPPER_INDEX];`
`238`	`238`	`}`
`239`	`239`
`@@ -269,6 +269,6 @@ protected function encode($data): string`
`269`	`269`	`*/`
`270`	`270`	`protected function decode(?string $value): mixed`
`271`	`271`	`{`
`272`		`- return \unserialize((string) $value, ['allowed_classes' => true]);`
	`272`	`+ return $value ? \unserialize($value, ['allowed_classes' => true]) : null;`
`273`	`273`	`}`
`274`	`274`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array`
`92`	`92`	`{`
`93`	`93`	`$data = apcu_fetch($item->getKey(), $success);`
`94`	`94`
`95`		`- if ($success === false) {`
	`95`	`+ if ($success === false \|\| !\is_array($data)) {`
`96`	`96`	`return null;`
`97`	`97`	`}`
`98`	`98`
Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array`
`131`	`131`	`return null;`
`132`	`132`	`}`
`133`	`133`	`throw new PhpfastcacheDriverException(`
`134`		`- 'Got unexpeced error from Arangodb: ' . $e->getMessage()`
	`134`	`+ 'Got unexpected error from Arangodb: ' . $e->getMessage()`
`135`	`135`	`);`
`136`	`136`	`}`
`137`	`137`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ protected function driverRead(ExtendedCacheItemInterface $item): ?array`
`140`	`140`	`$results = $this->instance->execute(new Cassandra\SimpleStatement($query), $options);`
`141`	`141`
`142`	`142`	`if ($results instanceof Cassandra\Rows && $results->count() === 1) {`
`143`		`- return $this->decode($results->first()['cache_data']);`
	`143`	`+ return $this->decode($results->first()['cache_data']) ?: null;`
`144`	`144`	`}`
`145`	`145`
`146`	`146`	`return null;`
Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,7 @@ protected function encodeDocument(array $data): array`
`257`	`257`	`* @return mixed`
`258`	`258`	`* @throws \Exception`
`259`	`259`	`*/`
`260`		`- protected function decode($value): mixed`
	`260`	`+ protected function decode($value): array`
`261`	`261`	`{`
`262`	`262`	`$value[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX] = \unserialize(`
`263`	`263`	`$value[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX],`