feat: add CachedQRCodeProvider

README.md

@@ -2,3 +2,4 @@ TODO:
 -----
 - [ ] Chybí speciální slovník nebo vypnutí slovníku pro testy
 - [ ] V reálný aplikaci bych použil Mockery, nicméně tady mě to přijde zbytečný
+- [ ] Nastavení cache ideálně v memcached/redis etc.

composer.json

@@ -20,6 +20,7 @@
         "php-http/httplug": "*",
         "symfony/asset": "7.0.*",
         "symfony/asset-mapper": "7.0.*",
+        "symfony/cache": "7.0.*",
         "symfony/console": "7.0.*",
         "symfony/dotenv": "7.0.*",
         "symfony/flex": "^2",

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "dda7db8ccac14db47a72f26e4769dac8",
+    "content-hash": "15e05e23293f0f945b50f450fe8213c3",
     "packages": [
         {
             "name": "composer/semver",

config/packages/cache.yaml

@@ -1,7 +1,7 @@
 framework:
     cache:
         # Unique name of your app: used to compute stable namespaces for cache keys.
-        #prefix_seed: your_vendor_name/app_name
+        prefix_seed: ovlach/symfony_example_app
 
         # The "app" cache stores to the filesystem by default.
         # The data in this cache should persist between deploys.

config/services.yaml

@@ -40,9 +40,14 @@ services:
             $username: '%app.usetreno.username%'
             $password: '%app.usetreno.password%'
 
+    App\Service\CachedQRCodeGenerator:
+        arguments:
+            $innerGenerator: '@App\Service\Remote\UsetrenoQRCodeProvider'
+            $cacheDuration: 'PT60S'
+
     App\Service\CurrencyListerInterface: '@App\Service\StaticCurrencyLister'
     App\Service\QRCodeQROptionsProviderInterface: '@App\Service\QRCodeQROptionsDefaultProvider'
-    App\Service\QRCodeGeneratorInterface: '@App\Service\Remote\UsetrenoQRCodeProvider'
+    App\Service\QRCodeGeneratorInterface: '@App\Service\CachedQRCodeGenerator'
 
     # add more service definitions when explicit configuration is needed
     # please note that last definitions always *replace* previous ones

src/Service/CacheableQRCodeGeneratorInterface.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Service;
+
+use App\Entity\QRCode\QRCode;
+
+interface CacheableQRCodeGeneratorInterface extends QRCodeGeneratorInterface
+{
+    // We can't calculate cache key directly from QRCode
+    public function getCacheKey(QRCode $entity): string;
+}

src/Service/CachedQRCodeGenerator.php

@@ -0,0 +1,39 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Service;
+
+use App\Entity\QRCode\QRCode;
+use Exception;
+use Psr\Cache\InvalidArgumentException;
+use Psr\Log\LoggerInterface;
+use Symfony\Contracts\Cache\CacheInterface;
+use Symfony\Contracts\Cache\ItemInterface;
+
+
+final readonly class CachedQRCodeGenerator implements QRCodeGeneratorInterface
+{
+    private \DateInterval $cacheDuration;
+
+    /**
+     * @throws Exception
+     */
+    public function __construct(private CacheableQRCodeGeneratorInterface $innerGenerator, private CacheInterface $cache, private LoggerInterface $logger, string $cacheDuration)
+    {
+        $this->cacheDuration = new \DateInterval($cacheDuration);
+    }
+
+    public function generateQRCodeFromEntity(QRCode $entity): string
+    {
+        $key = $this->innerGenerator->getCacheKey($entity);
+        return $this->cache->get($key, function(ItemInterface $c) use ($entity) {
+            $this->logger->debug("cache miss for key " . $c->getKey(), [
+                'entity' => $entity,
+            ]);
+
+            $c->expiresAfter($this->cacheDuration);
+
+            return $this->innerGenerator->generateQRCodeFromEntity($entity);
+        });
+    }
+}

src/Service/Remote/UsetrenoQRCodeProvider.php

@@ -4,13 +4,12 @@ declare(strict_types=1);
 namespace App\Service\Remote;
 
 use App\Entity\QRCode\QRCode;
-use App\Service\QRCodeGeneratorInterface;
+use App\Service\CacheableQRCodeGeneratorInterface;
 use App\Service\Remote\Edge\QRCodeEntityConverter;
-use App\Service\Remote\Exception\AuthorizeException;
 use App\Service\Remote\Exception\UsetrenoQRCodeException;
 use Psr\Log\LoggerInterface;
 
-class UsetrenoQRCodeProvider implements QRCodeGeneratorInterface
+class UsetrenoQRCodeProvider implements CacheableQRCodeGeneratorInterface
 {
     const QRCODE_API = 'https://topapi.top-test.cz/chameleon/api/v1/qr-code/create-for-bank-account-payment';
     const QRCODE_METHOD = 'POST';
@@ -86,4 +85,14 @@ class UsetrenoQRCodeProvider implements QRCodeGeneratorInterface
 
         return $data->data->base64Data;
     }
+
+    public function getCacheKey(QRCode $entity): string
+    {
+        $edgeEntity = $this->codeEntityConverter->convert($entity);
+        $encodedEntity = json_encode($edgeEntity);
+        if ($encodedEntity === false) {
+            throw new \RuntimeException("Can't serialize edge entity");
+        }
+        return base64_encode($encodedEntity);
+    }
 }