Phpfastcache\Drivers\Firestore\Driver

Complexity

Total Complexity

19

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	driverCheck()	0	3	2
A	decodeFirestoreDocument()	0	17	4
A	driverDelete()	0	7	1
A	getConfig()	0	3	1
A	getStats()	0	7	1
A	driverConnect()	0	16	4
A	driverWrite()	0	10	1
A	driverRead()	0	12	2
A	driverClear()	0	13	3

<?php

/**
 *
 * This file is part of Phpfastcache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt and LICENCE files.
 *
 * @author Georges.L (Geolim4)  <contact@geolim4.com>
 * @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
 */
declare(strict_types=1);

namespace Phpfastcache\Drivers\Firestore;

use Google\Cloud\Core\Blob as GoogleBlob;

The type Google\Cloud\Core\Blob was not found. Maybe you did not declare it correctly or list all dependencies?

use Google\Cloud\Core\Timestamp as GoogleTimestamp;

The type Google\Cloud\Core\Timestamp was not found. Maybe you did not declare it correctly or list all dependencies?

use Google\Cloud\Firestore\FirestoreClient as GoogleFirestoreClient;

The type Google\Cloud\Firestore\FirestoreClient was not found. Maybe you did not declare it correctly or list all dependencies?

use Phpfastcache\Cluster\AggregatablePoolInterface;
use Phpfastcache\Core\Item\ExtendedCacheItemInterface;
use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
use Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait;
use Phpfastcache\Entities\DriverStatistic;
use Phpfastcache\Exceptions\PhpfastcacheDriverConnectException;
use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
use Phpfastcache\Exceptions\PhpfastcacheLogicException;

/**
 * Class Driver
 * @property Config $config
 * @property GoogleFirestoreClient $instance
 */
class Driver implements ExtendedCacheItemPoolInterface, AggregatablePoolInterface
{
    use TaggableCacheItemPoolTrait;

    /**
     * @return bool
     */
    public function driverCheck(): bool
    {
        return \class_exists(GoogleFirestoreClient::class) && \extension_loaded('grpc');
    }

    /**
     * @return bool
     * @throws PhpfastcacheDriverConnectException
     * @throws PhpfastcacheInvalidArgumentException
     * @throws PhpfastcacheLogicException
     */
    protected function driverConnect(): bool
    {
        $gcpId = $this->getConfig()->getSuperGlobalAccessor()('SERVER', 'GOOGLE_CLOUD_PROJECT');
        $gacPath = $this->getConfig()->getSuperGlobalAccessor()('SERVER', 'GOOGLE_APPLICATION_CREDENTIALS');

        if (empty($gcpId)) {
            throw new PhpfastcacheDriverConnectException('The environment configuration GOOGLE_CLOUD_PROJECT must be set');
        }

        if (empty($gacPath) || !\is_readable($gacPath)) {
            throw new PhpfastcacheDriverConnectException('The environment configuration GOOGLE_APPLICATION_CREDENTIALS must be set and the file must be readable.');
        }

        $this->instance = new GoogleFirestoreClient();

        return true;
    }

    /**
     * @param ExtendedCacheItemInterface $item
     * @return bool
     */
    protected function driverWrite(ExtendedCacheItemInterface $item): bool
    {
        $this->instance->collection($this->getConfig()->getCollection())
            ->document($item->getKey())
            ->set(
                $this->driverPreWrap($item),
                ['merge' => true]
            );

        return true;
    }

    /**
     * @param ExtendedCacheItemInterface $item
     * @return null|array
     * @throws \Exception
     */
    protected function driverRead(ExtendedCacheItemInterface $item): ?array
    {
        $doc = $this->instance->collection($this->getConfig()->getCollection())
            ->document($item->getKey());

        $snapshotData = $doc->snapshot()->data();

        if (\is_array($snapshotData)) {
            return $this->decodeFirestoreDocument($snapshotData);
        }

        return null;
    }

    /**
     * @param ExtendedCacheItemInterface $item
     * @return bool
     */
    protected function driverDelete(ExtendedCacheItemInterface $item): bool
    {
        $this->instance->collection($this->getConfig()->getCollection())
            ->document($item->getKey())
            ->delete();

        return true;
    }

    /**
     * @return bool
     */
    protected function driverClear(): bool
    {
        $batchSize = 100;
        $collection = $this->instance->collection($this->getConfig()->getCollection());
        $documents = $collection->limit($batchSize)->documents();
        while (!$documents->isEmpty()) {
            foreach ($documents as $document) {
                $document->reference()->delete();
            }
            $documents = $collection->limit($batchSize)->documents();
        }

        return true;
    }

    protected function decodeFirestoreDocument(array $snapshotData): array
    {
        return \array_map(static function ($datum) {
            if ($datum instanceof GoogleTimestamp) {
                $date = $datum->get();
                if ($date instanceof \DateTimeImmutable) {
                    return \DateTime::createFromImmutable($date);
                }
                return $date;
            }

            if ($datum instanceof GoogleBlob) {
                return (string) $datum;
            }

            return $datum;
        }, $snapshotData);
    }

    public function getStats(): DriverStatistic
    {
        return (new DriverStatistic())
            ->setData(implode(', ', array_keys($this->itemInstances)))
            ->setInfo('No info provided by Google Firestore')
            ->setRawData([])
            ->setSize(0);
    }

    public function getConfig(): Config
    {
        return $this->config;
    }
}