custom/plugins/SwkwebProductSet/src/Core/Content/ProductSet/SalesChannel/CachedProductSetRoute.php line 54

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Swkweb\ProductSet\Core\Content\ProductSet\SalesChannel;
  5. use Psr\Log\LoggerInterface;
  6. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  7. use Shopware\Core\Framework\Adapter\Cache\CacheCompressor;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  10. use Shopware\Core\Framework\Routing\Annotation\Entity;
  11. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  12. use Swkweb\ProductSet\Core\Content\ProductSet\Cache\ProductSetCacheKeyGenerator;
  13. use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\Routing\Annotation\Route;
  17. /**
  18.  * @Route(defaults={"_routeScope"={"store-api"}})
  19.  */
  20. class CachedProductSetRoute implements ProductSetRouteInterface
  21. {
  22.     private ProductSetRouteInterface $route;
  23.     private TagAwareAdapterInterface $cache;
  24.     private EntityCacheKeyGenerator $entityCacheKeyGenerator;
  25.     private ProductSetCacheKeyGenerator $productSetCacheKeyGenerator;
  26.     private AbstractCacheTracer $cacheTracer;
  27.     private LoggerInterface $logger;
  28.     /** @var string[] */
  29.     private array $states;
  31.     public function __construct(
  32.         ProductSetRouteInterface $route,
  33.         TagAwareAdapterInterface $cache,
  34.         EntityCacheKeyGenerator $entityCacheKeyGenerator,
  35.         ProductSetCacheKeyGenerator $productSetCacheKeyGenerator,
  36.         AbstractCacheTracer $cacheTracer,
  37.         LoggerInterface $logger
  38.     ) {
  39.         $this->route = $route;
  40.         $this->cache = $cache;
  41.         $this->entityCacheKeyGenerator = $entityCacheKeyGenerator;
  42.         $this->productSetCacheKeyGenerator = $productSetCacheKeyGenerator;
  43.         $this->cacheTracer = $cacheTracer;
  44.         $this->logger = $logger;
  46.         $this->states = [];
  47.     }
  49.     /**
  50.      * @Entity("swkweb_product_set")
  51.      *
  52.      * @Route("/store-api/swkweb-product-set/{productId}", name="store-api.swkweb-product-set.detail", methods={"POST"})
  53.      */
  54.     public function load(string $productId, ?string $path, Request $request, SalesChannelContext $context, Criteria $criteria): ProductSetRouteResponse
  55.     {
  56.         $name = self::buildName($productId);
  58.         if ($context->hasState(...$this->states)) {
  59.             $this->logger->info('cache-miss: ' . $name);
  61.             return $this->route->load($productId, $path, $request, $context, $criteria);
  62.         }
  64.         $item = $this->cache->getItem($this->generateKey($productId, $path, $request, $context, $criteria));
  66.         try {
  67.             if ($item->isHit() && $item->get()) {
  68.                 $this->logger->info('cache-hit: ' . $name);
  70.                 return CacheCompressor::uncompress($item);
  71.             }
  72.         } catch (\Throwable $e) {
  73.             $this->logger->error($e->getMessage());
  74.         }
  76.         $this->logger->info('cache-miss: ' . $name);
  78.         $response = $this->cacheTracer->trace($name, fn () => $this->route->load($productId, $path, $request, $context, $criteria));
  79.         assert($response instanceof ProductSetRouteResponse);
  81.         $item = CacheCompressor::compress($item, $response);
  82.         $item->tag($this->generateTags($name, $response));
  84.         $this->cache->save($item);
  86.         return $response;
  87.     }
  89.     public static function buildName(string $productId): string
  90.     {
  91.         return 'swkweb-product-set-route-' . $productId;
  92.     }
  94.     private function generateKey(string $productId, ?string $path, Request $request, SalesChannelContext $context, Criteria $criteria): string
  95.     {
  96.         $parts = [
  97.             self::buildName($productId),
  98.             $path,
  99.             $this->productSetCacheKeyGenerator->getRequestHash($request),
  100.             $this->entityCacheKeyGenerator->getSalesChannelContextHash($context),
  101.             $this->entityCacheKeyGenerator->getCriteriaHash($criteria),
  102.         ];
  104.         return md5(json_encode($parts, \JSON_THROW_ON_ERROR));
  105.     }
  107.     /**
  108.      * @return string[]
  109.      */
  110.     private function generateTags(string $name, ProductSetRouteResponse $response): array
  111.     {
  112.         $tags = [
  113.             $name,
  114.             ...$this->cacheTracer->get($name),
  115.             ...$this->productSetCacheKeyGenerator->extractTags($response->getProductSet()),
  116.         ];
  118.         return array_unique(array_filter($tags));
  119.     }
  120. }