vendor/shopware/core/Content/Product/SalesChannel/Search/CachedProductSearchRoute.php line 79

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\Search;
  5. use Shopware\Core\Content\Product\Events\ProductSearchRouteCacheKeyEvent;
  6. use Shopware\Core\Content\Product\Events\ProductSearchRouteCacheTagsEvent;
  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\Log\Package;
  14. use Shopware\Core\Framework\Routing\Annotation\Entity;
  15. use Shopware\Core\Framework\Routing\Annotation\Since;
  16. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  17. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\Routing\Annotation\Route;
  20. use Symfony\Contracts\Cache\CacheInterface;
  21. use Symfony\Contracts\Cache\ItemInterface;
  22. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  24. #[Package('system-settings')]
  25. class CachedProductSearchRoute extends AbstractProductSearchRoute
  26. {
  27.     private const NAME = 'product-search-route';
  29.     private AbstractProductSearchRoute $decorated;
  31.     private CacheInterface $cache;
  33.     private EntityCacheKeyGenerator $generator;
  35.     /**
  36.      * @var AbstractCacheTracer<ProductSearchRouteResponse>
  37.      */
  38.     private AbstractCacheTracer $tracer;
  40.     /**
  41.      * @var array<string>
  42.      */
  43.     private array $states;
  45.     private EventDispatcherInterface $dispatcher;
  47.     /**
  48.      * @internal
  49.      *
  50.      * @param AbstractCacheTracer<ProductSearchRouteResponse> $tracer
  51.      * @param array<string> $states
  52.      */
  53.     public function __construct(
  54.         AbstractProductSearchRoute $decorated,
  55.         CacheInterface $cache,
  56.         EntityCacheKeyGenerator $generator,
  57.         AbstractCacheTracer $tracer,
  58.         EventDispatcherInterface $dispatcher,
  59.         array $states
  60.     ) {
  61.         $this->decorated = $decorated;
  62.         $this->cache = $cache;
  63.         $this->generator = $generator;
  64.         $this->tracer = $tracer;
  65.         $this->states = $states;
  66.         $this->dispatcher = $dispatcher;
  67.     }
  69.     public function getDecorated(): AbstractProductSearchRoute
  70.     {
  71.         return $this->decorated;
  72.     }
  74.     /**
  75.      * @Since("6.2.0.0")
  76.      * @Entity("product")
  77.      * @Route("/store-api/search", name="store-api.search", methods={"POST"})
  78.      */
  79.     public function load(Request $request, SalesChannelContext $context, Criteria $criteria): ProductSearchRouteResponse
  80.     {
  81.         if ($context->hasState(...$this->states)) {
  82.             return $this->getDecorated()->load($request, $context, $criteria);
  83.         }
  85.         $key = $this->generateKey($request, $context, $criteria);
  87.         if ($key === null) {
  88.             return $this->getDecorated()->load($request, $context, $criteria);
  89.         }
  91.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
  92.             $response = $this->tracer->trace(self::NAME, function () use ($request, $context, $criteria) {
  93.                 return $this->getDecorated()->load($request, $context, $criteria);
  94.             });
  96.             $item->tag($this->generateTags($request, $response, $context, $criteria));
  98.             return CacheValueCompressor::compress($response);
  99.         });
  101.         return CacheValueCompressor::uncompress($value);
  102.     }
  104.     private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  105.     {
  106.         $parts = [
  107.             $this->generator->getCriteriaHash($criteria),
  108.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::PRODUCT_AREA]),
  109.             $request->get('search'),
  110.         ];
  112.         $event = new ProductSearchRouteCacheKeyEvent($parts, $request, $context, $criteria);
  113.         $this->dispatcher->dispatch($event);
  115.         if (!$event->shouldCache()) {
  116.             return null;
  117.         }
  119.         return self::NAME . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  120.     }
  122.     /**
  123.      * @return array<string>
  124.      */
  125.     private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  126.     {
  127.         $tags = array_merge(
  128.             $this->tracer->get(self::NAME),
  129.             [self::NAME]
  130.         );
  132.         $event = new ProductSearchRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  133.         $this->dispatcher->dispatch($event);
  135.         return array_unique(array_filter($event->getTags()));
  136.     }
  137. }