Optimized Couchdb document storage (#810)

* Upgraded travis dist to repair broken php8 tests

* Trying to repair broken build

* Trying to repair broken build

* Trying to repair broken build

* Fixed Couchdb tests & driver

* Removed dump...

* Fixed tests for php 7.x ...

* Fixed tests & dropped support of Riak which is became unmaintenable and is globally unused

* Refactored some tests and isolated TestHelper out of core code

* Optimized Couchdb document storage

* Updated github action
Updated composer.lock

* Updated github action

* Fixed Couchdb test

Author: Geolim4

.github/workflows/tests.yml

@@ -1,5 +1,5 @@
 name: Github tests workflow
-on: [push, pull_request_target]
+on: [push, pull_request]
 jobs:
   build:
     name: Github PHP unit tests
@@ -18,7 +18,7 @@ jobs:
         uses: zhulik/[email protected]
         with:
           redis version: '5'
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Validate composer.json and composer.lock
         run: composer validate

composer.lock

@@ -145,12 +145,12 @@ protected function driverRead(CacheItemInterface $item)
             throw new PhpfastcacheDriverException('Got error while trying to get a document: ' . $e->getMessage(), 0, $e);
         }
 
-        if ($response->status === 404 || empty($response->body['data'])) {
+        if ($response->status === 404 || empty($response->body[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX])) {
             return null;
         }
 
         if ($response->status === 200) {
-            return $this->decode($response->body['data']);
+            return $this->decode($response->body);
         }
 
         throw new PhpfastcacheDriverException('Got unexpected HTTP status: ' . $response->status);
@@ -170,7 +170,7 @@ protected function driverWrite(CacheItemInterface $item): bool
         if ($item instanceof Item) {
             try {
                 $this->instance->putDocument(
-                    ['data' => $this->encode($this->driverPreWrap($item))],
+                    $this->encodeDocument($this->driverPreWrap($item)),
                     $this->getCouchDbItemKey($item),
                     $this->getLatestDocumentRevision($this->getCouchDbItemKey($item))
                 );
@@ -247,4 +247,50 @@ protected function driverClear(): bool
 
         return true;
     }
+
+    /**
+     * @param array $data
+     * @return array
+     */
+    protected function encodeDocument(array $data): array
+    {
+        $data[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX] = $this->encode($data[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX]);
+
+        return $data;
+    }
+
+    /**
+     * Specific document decoder for Couchdb
+     * since we dont store encoded version
+     * for performance purposes
+     *
+     * @param $value
+     * @return mixed
+     * @throws \Exception
+     */
+    protected function decode($value)
+    {
+        $value[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX] = \unserialize($value[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX], ['allowed_classes' => true]);
+
+        $value[ExtendedCacheItemPoolInterface::DRIVER_EDATE_WRAPPER_INDEX] = new \DateTime(
+            $value[ExtendedCacheItemPoolInterface::DRIVER_EDATE_WRAPPER_INDEX]['date'],
+            new \DateTimeZone($value[ExtendedCacheItemPoolInterface::DRIVER_EDATE_WRAPPER_INDEX]['timezone'])
+        );
+
+        if(isset($value[ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX])){
+            $value[ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX] = new \DateTime(
+                $value[ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX]['date'],
+                new \DateTimeZone($value[ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX]['timezone'])
+            );
+        }
+
+        if(isset($value[ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX])){
+            $value[ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX] = new \DateTime(
+                $value[ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX]['date'],
+                new \DateTimeZone($value[ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX]['timezone'])
+            );
+        }
+
+        return $value;
+    }
 }

lib/Phpfastcache/Drivers/Couchdb/Driver.php

@@ -18,13 +18,15 @@
 try{
     $cacheInstance = CacheManager::getInstance('Couchdb', $config);
 } catch (PhpfastcacheDriverConnectException $e){
-    $testHelper->printDebugText('Unable to connect to Couchdb as an anynymous, trying with default credential...');
-    $config->setUsername('admin');
-    $config->setPassword('travis');
-    $cacheInstance = CacheManager::getInstance('Couchdb', $config);
-} catch(PhpfastcacheDriverConnectException $e){
-    $testHelper->assertSkip('Couchdb server unavailable: ' . $e->getMessage());
-    $testHelper->terminateTest();
+    try{
+        $testHelper->printDebugText('Unable to connect to Couchdb as an anynymous, trying with default credential...');
+        $config->setUsername('admin');
+        $config->setPassword('travis');
+        $cacheInstance = CacheManager::getInstance('Couchdb', $config);
+    } catch(PhpfastcacheDriverConnectException $e){
+        $testHelper->assertSkip('Couchdb server unavailable: ' . $e->getMessage());
+        $testHelper->terminateTest();
+    }
 }
 
 $testHelper->runCRUDTests($cacheInstance);