vendor/shopware/core/Content/Product/SalesChannel/Listing/CachedProductListingRoute.php line 94

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\Listing;
  5. use Shopware\Core\Content\Product\Events\ProductListingRouteCacheKeyEvent;
  6. use Shopware\Core\Content\Product\Events\ProductListingRouteCacheTagsEvent;
  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\Field\Flag\RuleAreas;
  11. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  13. use Shopware\Core\Framework\Routing\Annotation\Entity;
  14. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  15. use Shopware\Core\Framework\Routing\Annotation\Since;
  16. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\Routing\Annotation\Route;
  19. use Symfony\Contracts\Cache\CacheInterface;
  20. use Symfony\Contracts\Cache\ItemInterface;
  21. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  23. /**
  24.  * @Route(defaults={"_routeScope"={"store-api"}})
  25.  */
  26. class CachedProductListingRoute extends AbstractProductListingRoute
  27. {
  28.     private AbstractProductListingRoute $decorated;
  30.     private CacheInterface $cache;
  32.     private EntityCacheKeyGenerator $generator;
  34.     /**
  35.      * @var AbstractCacheTracer<ProductListingRouteResponse>
  36.      */
  37.     private AbstractCacheTracer $tracer;
  39.     /**
  40.      * @var array<string>
  41.      */
  42.     private array $states;
  44.     private EventDispatcherInterface $dispatcher;
  46.     /**
  47.      * @internal
  48.      *
  49.      * @param AbstractCacheTracer<ProductListingRouteResponse> $tracer
  50.      * @param array<string> $states
  51.      */
  52.     public function __construct(
  53.         AbstractProductListingRoute $decorated,
  54.         CacheInterface $cache,
  55.         EntityCacheKeyGenerator $generator,
  56.         AbstractCacheTracer $tracer,
  57.         EventDispatcherInterface $dispatcher,
  58.         array $states
  59.     ) {
  60.         $this->decorated = $decorated;
  61.         $this->cache = $cache;
  62.         $this->generator = $generator;
  63.         $this->tracer = $tracer;
  64.         $this->states = $states;
  65.         $this->dispatcher = $dispatcher;
  66.     }
  68.     public function getDecorated(): AbstractProductListingRoute
  69.     {
  70.         return $this->decorated;
  71.     }
  73.     /**
  74.      * @Since("6.2.0.0")
  75.      * @Entity("product")
  76.      * @Route("/store-api/product-listing/{categoryId}", name="store-api.product.listing", methods={"POST"})
  77.      */
  78.     public function load(string $categoryId, Request $request, SalesChannelContext $context, Criteria $criteria): ProductListingRouteResponse
  79.     {
  80.         if ($context->hasState(...$this->states)) {
  81.             return $this->getDecorated()->load($categoryId, $request, $context, $criteria);
  82.         }
  84.         $key = $this->generateKey($categoryId, $request, $context, $criteria);
  86.         if ($key === null) {
  87.             return $this->getDecorated()->load($categoryId, $request, $context, $criteria);
  88.         }
  90.         $value = $this->cache->get($key, function (ItemInterface $item) use ($categoryId, $request, $context, $criteria) {
  91.             $name = self::buildName($categoryId);
  93.             $response = $this->tracer->trace($name, function () use ($categoryId, $request, $context, $criteria) {
  94.                 return $this->getDecorated()->load($categoryId, $request, $context, $criteria);
  95.             });
  97.             $item->tag($this->generateTags($categoryId, $request, $response, $context, $criteria));
  99.             return CacheValueCompressor::compress($response);
  100.         });
  102.         return CacheValueCompressor::uncompress($value);
  103.     }
  105.     public static function buildName(string $categoryId): string
  106.     {
  107.         return 'product-listing-route-' . $categoryId;
  108.     }
  110.     private function generateKey(string $categoryId, Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  111.     {
  112.         $parts = [
  113.             $this->generator->getCriteriaHash($criteria),
  114.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::PRODUCT_AREA, RuleAreas::CATEGORY_AREA]),
  115.         ];
  117.         $event = new ProductListingRouteCacheKeyEvent($parts, $categoryId, $request, $context, $criteria);
  118.         $this->dispatcher->dispatch($event);
  120.         if (!$event->shouldCache()) {
  121.             return null;
  122.         }
  124.         return self::buildName($categoryId) . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  125.     }
  127.     /**
  128.      * @return array<string>
  129.      */
  130.     private function generateTags(string $categoryId, Request $request, ProductListingRouteResponse $response, SalesChannelContext $context, Criteria $criteria): array
  131.     {
  132.         $streamId = $response->getResult()->getStreamId();
  134.         $tags = array_merge(
  135.             $this->tracer->get(self::buildName($categoryId)),
  136.             [$streamId ? EntityCacheKeyGenerator::buildStreamTag($streamId) : null],
  137.             [self::buildName($categoryId)]
  138.         );
  140.         $event = new ProductListingRouteCacheTagsEvent($tags, $categoryId, $request, $response, $context, $criteria);
  141.         $this->dispatcher->dispatch($event);
  143.         return array_unique(array_filter($event->getTags()));
  144.     }
  145. }