feat(cache): Introduce cache version storage (#69)

Co-authored-by: Oskar Stark <[email protected]>

Author: silasjoisten

src/CacheVersion/CacheVersionStorageInterface.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of storyblok/php-content-api-client.
+ *
+ * (c) Storyblok GmbH <[email protected]>
+ * in cooperation with SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\CacheVersion;
+
+/**
+ * @experimental
+ *
+ * Interface for managing cache version storage.
+ *
+ * This interface defines methods to get and set the cache version.
+ * If the cache version is not set, it should return null.
+ */
+interface CacheVersionStorageInterface
+{
+    /**
+     * @return null|int returns int if cache version is set, null if not set
+     */
+    public function get(): ?int;
+
+    /**
+     * @param null|int $version Sets the cache version. If null the cache version is unset.
+     */
+    public function set(?int $version): void;
+}

src/CacheVersion/InMemoryStorage.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of storyblok/php-content-api-client.
+ *
+ * (c) Storyblok GmbH <[email protected]>
+ * in cooperation with SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\CacheVersion;
+
+/**
+ * @experimental
+ */
+final class InMemoryStorage implements CacheVersionStorageInterface
+{
+    private ?int $cacheVersion = null;
+
+    public function get(): ?int
+    {
+        return $this->cacheVersion;
+    }
+
+    public function set(?int $version): void
+    {
+        $this->cacheVersion = $version;
+    }
+}

src/StoryblokClient.php

@@ -18,6 +18,8 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Storyblok\Api\Bridge\HttpClient\QueryStringHelper;
+use Storyblok\Api\CacheVersion\CacheVersionStorageInterface;
+use Storyblok\Api\CacheVersion\InMemoryStorage;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -30,14 +32,14 @@
 final class StoryblokClient implements StoryblokClientInterface
 {
     private HttpClientInterface $client;
-    private ?int $cacheVersion = null;
 
     public function __construct(
         string $baseUri,
         #[\SensitiveParameter]
         private string $token,
         int $timeout = 4,
         private LoggerInterface $logger = new NullLogger(),
+        private CacheVersionStorageInterface $storage = new InMemoryStorage(),
     ) {
         $this->client = HttpClient::createForBaseUri($baseUri);
         $this->token = TrimmedNonEmptyString::fromString($token, '$token must not be an empty string')->toString();
@@ -72,13 +74,13 @@ public function request(string $method, string $url, array $options = []): Respo
             $url = QueryStringHelper::applyQueryString($url, [
                 ...$options['query'],
                 'token' => $this->token,
-                'cv' => $this->cacheVersion,
+                'cv' => $this->storage->get(),
             ]);
             unset($options['query']);
         } else {
             $options['query'] = [
                 'token' => $this->token,
-                'cv' => $this->cacheVersion,
+                'cv' => $this->storage->get(),
             ];
         }
 
@@ -110,7 +112,7 @@ public function request(string $method, string $url, array $options = []): Respo
             $parsedUrl = parse_url($response->getInfo('url'), \PHP_URL_QUERY);
             parse_str($parsedUrl, $parsed);
 
-            $this->cacheVersion = \array_key_exists('cv', $parsed) ? (int) $parsed['cv'] : $this->cacheVersion;
+            $this->storage->set(\array_key_exists('cv', $parsed) ? (int) $parsed['cv'] : $this->storage->get());
         }
 
         return $response;

tests/Unit/CacheVersion/InMemoryStorageTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of storyblok/php-content-api-client.
+ *
+ * (c) Storyblok GmbH <[email protected]>
+ * in cooperation with SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\Tests\Unit\CacheVersion;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Storyblok\Api\CacheVersion\InMemoryStorage;
+
+/**
+ * @author Silas Joisten <[email protected]>
+ */
+final class InMemoryStorageTest extends TestCase
+{
+    #[DataProvider('values')]
+    #[Test]
+    public function setAndGetWithValues(?int $value): void
+    {
+        $storage = new InMemoryStorage();
+        $storage->set($value);
+
+        self::assertSame($value, $storage->get());
+    }
+
+    /**
+     * @return iterable<array<int, null|int>>
+     */
+    public static function values(): iterable
+    {
+        yield [12];
+        yield [0];
+        yield [null];
+    }
+}