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

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\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\Since;
  14. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  15. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  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. class CachedProductSearchRoute extends AbstractProductSearchRoute
  23. {
  24.     private const NAME = 'product-search-route';
  26.     private AbstractProductSearchRoute $decorated;
  28.     private CacheInterface $cache;
  30.     private EntityCacheKeyGenerator $generator;
  32.     /**
  33.      * @var AbstractCacheTracer<ProductSearchRouteResponse>
  34.      */
  35.     private AbstractCacheTracer $tracer;
  37.     private array $states;
  39.     private EventDispatcherInterface $dispatcher;
  41.     /**
  42.      * @internal
  43.      *
  44.      * @param AbstractCacheTracer<ProductSearchRouteResponse> $tracer
  45.      */
  46.     public function __construct(
  47.         AbstractProductSearchRoute $decorated,
  48.         CacheInterface $cache,
  49.         EntityCacheKeyGenerator $generator,
  50.         AbstractCacheTracer $tracer,
  51.         EventDispatcherInterface $dispatcher,
  52.         array $states
  53.     ) {
  54.         $this->decorated = $decorated;
  55.         $this->cache = $cache;
  56.         $this->generator = $generator;
  57.         $this->tracer = $tracer;
  58.         $this->states = $states;
  59.         $this->dispatcher = $dispatcher;
  60.     }
  62.     public function getDecorated(): AbstractProductSearchRoute
  63.     {
  64.         return $this->decorated;
  65.     }
  67.     /**
  68.      * @Since("6.2.0.0")
  69.      * @Entity("product")
  70.      * @Route("/store-api/search", name="store-api.search", methods={"POST"})
  71.      */
  72.     public function load(Request $request, SalesChannelContext $context, Criteria $criteria): ProductSearchRouteResponse
  73.     {
  74.         if ($context->hasState(...$this->states)) {
  75.             return $this->getDecorated()->load($request, $context, $criteria);
  76.         }
  78.         $key = $this->generateKey($request, $context, $criteria);
  80.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
  81.             $response = $this->tracer->trace(self::NAME, function () use ($request, $context, $criteria) {
  82.                 return $this->getDecorated()->load($request, $context, $criteria);
  83.             });
  85.             $item->tag($this->generateTags($request, $response, $context, $criteria));
  87.             return CacheValueCompressor::compress($response);
  88.         });
  90.         return CacheValueCompressor::uncompress($value);
  91.     }
  93.     private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): string
  94.     {
  95.         $parts = [
  96.             $this->generator->getCriteriaHash($criteria),
  97.             $this->generator->getSalesChannelContextHash($context),
  98.             $request->get('search'),
  99.         ];
  101.         $event = new ProductSearchRouteCacheKeyEvent($parts, $request, $context, $criteria);
  102.         $this->dispatcher->dispatch($event);
  104.         return self::NAME . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  105.     }
  107.     private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  108.     {
  109.         $tags = array_merge(
  110.             $this->tracer->get(self::NAME),
  111.             [self::NAME]
  112.         );
  114.         $event = new ProductSearchRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  115.         $this->dispatcher->dispatch($event);
  117.         return array_unique(array_filter($event->getTags()));
  118.     }
  119. }