vendor/shopware/core/Content/Product/SalesChannel/Detail/CachedProductDetailRoute.php line 77

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\Detail;
  5. use Shopware\Core\Content\Product\Events\ProductDetailRouteCacheKeyEvent;
  6. use Shopware\Core\Content\Product\Events\ProductDetailRouteCacheTagsEvent;
  7. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  8. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  10. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  12. use Shopware\Core\Framework\Routing\Annotation\Entity;
  13. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  14. use Shopware\Core\Framework\Routing\Annotation\Since;
  15. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\Routing\Annotation\Route;
  18. use Symfony\Contracts\Cache\CacheInterface;
  19. use Symfony\Contracts\Cache\ItemInterface;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. /**
  23.  * @Route(defaults={"_routeScope"={"store-api"}})
  24.  */
  25. class CachedProductDetailRoute extends AbstractProductDetailRoute
  26. {
  27.     private AbstractProductDetailRoute $decorated;
  29.     private CacheInterface $cache;
  31.     private EntityCacheKeyGenerator $generator;
  33.     /**
  34.      * @var AbstractCacheTracer<ProductDetailRouteResponse>
  35.      */
  36.     private AbstractCacheTracer $tracer;
  38.     /**
  39.      * @var array<string, string>
  40.      */
  41.     private array $states;
  43.     private EventDispatcherInterface $dispatcher;
  45.     /**
  46.      * @internal
  47.      *
  48.      * @param AbstractCacheTracer<ProductDetailRouteResponse> $tracer
  49.      * @param array<string> $states
  50.      */
  51.     public function __construct(
  52.         AbstractProductDetailRoute $decorated,
  53.         CacheInterface $cache,
  54.         EntityCacheKeyGenerator $generator,
  55.         AbstractCacheTracer $tracer,
  56.         EventDispatcherInterface $dispatcher,
  57.         array $states
  58.     ) {
  59.         $this->decorated = $decorated;
  60.         $this->cache = $cache;
  61.         $this->generator = $generator;
  62.         $this->tracer = $tracer;
  63.         $this->states = $states;
  64.         $this->dispatcher = $dispatcher;
  65.     }
  67.     public function getDecorated(): AbstractProductDetailRoute
  68.     {
  69.         return $this->decorated;
  70.     }
  72.     /**
  73.      * @Since("6.3.2.0")
  74.      * @Entity("product")
  75.      * @Route("/store-api/product/{productId}", name="store-api.product.detail", methods={"POST"})
  76.      */
  77.     public function load(string $productId, Request $request, SalesChannelContext $context, Criteria $criteria): ProductDetailRouteResponse
  78.     {
  79.         if ($context->hasState(...$this->states)) {
  80.             return $this->getDecorated()->load($productId, $request, $context, $criteria);
  81.         }
  83.         $key = $this->generateKey($productId, $request, $context, $criteria);
  85.         if ($key === null) {
  86.             return $this->getDecorated()->load($productId, $request, $context, $criteria);
  87.         }
  89.         $value = $this->cache->get($key, function (ItemInterface $item) use ($productId, $request, $context, $criteria) {
  90.             $name = self::buildName($productId);
  92.             $response = $this->tracer->trace($name, function () use ($productId, $request, $context, $criteria) {
  93.                 return $this->getDecorated()->load($productId, $request, $context, $criteria);
  94.             });
  96.             $item->tag($this->generateTags($productId, $request, $response, $context, $criteria));
  98.             return CacheValueCompressor::compress($response);
  99.         });
  101.         return CacheValueCompressor::uncompress($value);
  102.     }
  104.     public static function buildName(string $parentId): string
  105.     {
  106.         return 'product-detail-route-' . $parentId;
  107.     }
  109.     private function generateKey(string $productId, Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  110.     {
  111.         $parts = [
  112.             $this->generator->getCriteriaHash($criteria),
  113.             $this->generator->getSalesChannelContextHash($context),
  114.         ];
  116.         $event = new ProductDetailRouteCacheKeyEvent($parts, $request, $context, $criteria);
  117.         $this->dispatcher->dispatch($event);
  119.         if (!$event->shouldCache()) {
  120.             return null;
  121.         }
  123.         return self::buildName($productId) . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  124.     }
  126.     /**
  127.      * @return array<string>
  128.      */
  129.     private function generateTags(string $productId, Request $request, ProductDetailRouteResponse $response, SalesChannelContext $context, Criteria $criteria): array
  130.     {
  131.         $parentId = $response->getProduct()->getParentId() ?? $response->getProduct()->getId();
  133.         $pageId = $response->getProduct()->getCmsPageId();
  135.         $tags = array_merge(
  136.             $this->tracer->get(self::buildName($productId)),
  137.             [$pageId !== null ? EntityCacheKeyGenerator::buildCmsTag($pageId) : null],
  138.             [self::buildName($parentId)]
  139.         );
  141.         $event = new ProductDetailRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  142.         $this->dispatcher->dispatch($event);
  144.         return array_unique(array_filter($event->getTags()));
  145.     }
  146. }