vendor/shopware/core/Content/Product/SalesChannel/Suggest/CachedProductSuggestRoute.php line 86

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\Suggest;
  5. use Shopware\Core\Content\Product\Events\ProductSuggestRouteCacheKeyEvent;
  6. use Shopware\Core\Content\Product\Events\ProductSuggestRouteCacheTagsEvent;
  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 Shopware\Core\System\SalesChannel\StoreApiResponse;
  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 CachedProductSuggestRoute extends AbstractProductSuggestRoute
  27. {
  28.     private const NAME = 'product-suggest-route';
  30.     private AbstractProductSuggestRoute $decorated;
  32.     private CacheInterface $cache;
  34.     private EntityCacheKeyGenerator $generator;
  36.     /**
  37.      * @var AbstractCacheTracer<ProductSuggestRouteResponse>
  38.      */
  39.     private AbstractCacheTracer $tracer;
  41.     private array $states;
  43.     private EventDispatcherInterface $dispatcher;
  45.     /**
  46.      * @internal
  47.      *
  48.      * @param AbstractCacheTracer<ProductSuggestRouteResponse> $tracer
  49.      */
  50.     public function __construct(
  51.         AbstractProductSuggestRoute $decorated,
  52.         CacheInterface $cache,
  53.         EntityCacheKeyGenerator $generator,
  54.         AbstractCacheTracer $tracer,
  55.         EventDispatcherInterface $dispatcher,
  56.         array $states
  57.     ) {
  58.         $this->decorated = $decorated;
  59.         $this->cache = $cache;
  60.         $this->generator = $generator;
  61.         $this->tracer = $tracer;
  62.         $this->states = $states;
  63.         $this->dispatcher = $dispatcher;
  64.     }
  66.     public function getDecorated(): AbstractProductSuggestRoute
  67.     {
  68.         return $this->decorated;
  69.     }
  71.     /**
  72.      * @Since("6.2.0.0")
  73.      * @Entity("product")
  74.      * @Route("/store-api/search-suggest", name="store-api.search.suggest", methods={"POST"})
  75.      */
  76.     public function load(Request $request, SalesChannelContext $context, Criteria $criteria): ProductSuggestRouteResponse
  77.     {
  78.         if ($context->hasState(...$this->states)) {
  79.             return $this->getDecorated()->load($request, $context, $criteria);
  80.         }
  82.         $key = $this->generateKey($request, $context, $criteria);
  84.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
  85.             $response = $this->tracer->trace(self::NAME, function () use ($request, $context, $criteria) {
  86.                 return $this->getDecorated()->load($request, $context, $criteria);
  87.             });
  89.             $item->tag($this->generateTags($request, $response, $context, $criteria));
  91.             return CacheValueCompressor::compress($response);
  92.         });
  94.         return CacheValueCompressor::uncompress($value);
  95.     }
  97.     private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): string
  98.     {
  99.         $parts = [
  100.             $this->generator->getCriteriaHash($criteria),
  101.             $this->generator->getSalesChannelContextHash($context),
  102.             $request->get('search'),
  103.         ];
  105.         $event = new ProductSuggestRouteCacheKeyEvent($parts, $request, $context, $criteria);
  106.         $this->dispatcher->dispatch($event);
  108.         return self::NAME . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  109.     }
  111.     private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  112.     {
  113.         $tags = array_merge(
  114.             $this->tracer->get(self::NAME),
  115.             [self::NAME],
  116.         );
  118.         $event = new ProductSuggestRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  119.         $this->dispatcher->dispatch($event);
  121.         return array_unique(array_filter($event->getTags()));
  122.     }
  123. }