src/Core/Content/Product/SalesChannel/Listing/CachedProductListingRoute.php line 53

  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\Search\Criteria;
  12. use Shopware\Core\Framework\Log\Package;
  13. use Shopware\Core\Framework\Util\Json;
  14. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\Routing\Annotation\Route;
  17. use Symfony\Contracts\Cache\CacheInterface;
  18. use Symfony\Contracts\Cache\ItemInterface;
  19. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  21. #[Route(defaults: ['_routeScope' => ['store-api']])]
  22. #[Package('inventory')]
  23. class CachedProductListingRoute extends AbstractProductListingRoute
  24. {
  25.     /**
  26.      * @internal
  27.      *
  28.      * @param AbstractCacheTracer<ProductListingRouteResponse> $tracer
  29.      * @param array<string> $states
  30.      */
  31.     public function __construct(private readonly AbstractProductListingRoute $decorated, private readonly CacheInterface $cache, private readonly EntityCacheKeyGenerator $generator, private readonly AbstractCacheTracer $tracer, private readonly EventDispatcherInterface $dispatcher, private readonly array $states)
  32.     {
  33.     }
  35.     public function getDecorated(): AbstractProductListingRoute
  36.     {
  37.         return $this->decorated;
  38.     }
  40.     #[Route(path: '/store-api/product-listing/{categoryId}', name: 'store-api.product.listing', methods: ['POST'], defaults: ['_entity' => 'product'])]
  41.     public function load(string $categoryId, Request $request, SalesChannelContext $context, Criteria $criteria): ProductListingRouteResponse
  42.     {
  43.         if ($context->hasState(...$this->states)) {
  44.             return $this->getDecorated()->load($categoryId, $request, $context, $criteria);
  45.         }
  47.         $key = $this->generateKey($categoryId, $request, $context, $criteria);
  49.         if ($key === null) {
  50.             return $this->getDecorated()->load($categoryId, $request, $context, $criteria);
  51.         }
  53.         $value = $this->cache->get($key, function (ItemInterface $item) use ($categoryId, $request, $context, $criteria) {
  54.             $name = self::buildName($categoryId);
  56.             $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($categoryId, $request, $context, $criteria));
  58.             $item->tag($this->generateTags($categoryId, $request, $response, $context, $criteria));
  60.             return CacheValueCompressor::compress($response);
  61.         });
  63.         return CacheValueCompressor::uncompress($value);
  64.     }
  66.     public static function buildName(string $categoryId): string
  67.     {
  68.         return 'product-listing-route-' . $categoryId;
  69.     }
  71.     private function generateKey(string $categoryId, Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  72.     {
  73.         $parts = [
  74.             $this->generator->getCriteriaHash($criteria),
  75.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::PRODUCT_AREA, RuleAreas::CATEGORY_AREA]),
  76.         ];
  78.         $event = new ProductListingRouteCacheKeyEvent($parts, $categoryId, $request, $context, $criteria);
  79.         $this->dispatcher->dispatch($event);
  81.         if (!$event->shouldCache()) {
  82.             return null;
  83.         }
  85.         return self::buildName($categoryId) . '-' . md5(Json::encode($event->getParts()));
  86.     }
  88.     /**
  89.      * @return array<string>
  90.      */
  91.     private function generateTags(string $categoryId, Request $request, ProductListingRouteResponse $response, SalesChannelContext $context, Criteria $criteria): array
  92.     {
  93.         $streamId = $response->getResult()->getStreamId();
  95.         $tags = array_merge(
  96.             $this->tracer->get(self::buildName($categoryId)),
  97.             [$streamId ? EntityCacheKeyGenerator::buildStreamTag($streamId) : null],
  98.             [self::buildName($categoryId)]
  99.         );
  101.         $event = new ProductListingRouteCacheTagsEvent($tags, $categoryId, $request, $response, $context, $criteria);
  102.         $this->dispatcher->dispatch($event);
  104.         return array_unique(array_filter($event->getTags()));
  105.     }
  106. }