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

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\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\RouteScope;
  16. use Shopware\Core\Framework\Routing\Annotation\Since;
  17. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  18. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\Routing\Annotation\Route;
  21. use Symfony\Contracts\Cache\CacheInterface;
  22. use Symfony\Contracts\Cache\ItemInterface;
  23. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  25. /**
  26.  * @Route(defaults={"_routeScope"={"store-api"}})
  27.  */
  28. #[Package('system-settings')]
  29. class CachedProductSuggestRoute extends AbstractProductSuggestRoute
  30. {
  31.     private const NAME = 'product-suggest-route';
  33.     private AbstractProductSuggestRoute $decorated;
  35.     private CacheInterface $cache;
  37.     private EntityCacheKeyGenerator $generator;
  39.     /**
  40.      * @var AbstractCacheTracer<ProductSuggestRouteResponse>
  41.      */
  42.     private AbstractCacheTracer $tracer;
  44.     /**
  45.      * @var array<string>
  46.      */
  47.     private array $states;
  49.     private EventDispatcherInterface $dispatcher;
  51.     /**
  52.      * @internal
  53.      *
  54.      * @param AbstractCacheTracer<ProductSuggestRouteResponse> $tracer
  55.      * @param array<string> $states
  56.      */
  57.     public function __construct(
  58.         AbstractProductSuggestRoute $decorated,
  59.         CacheInterface $cache,
  60.         EntityCacheKeyGenerator $generator,
  61.         AbstractCacheTracer $tracer,
  62.         EventDispatcherInterface $dispatcher,
  63.         array $states
  64.     ) {
  65.         $this->decorated = $decorated;
  66.         $this->cache = $cache;
  67.         $this->generator = $generator;
  68.         $this->tracer = $tracer;
  69.         $this->states = $states;
  70.         $this->dispatcher = $dispatcher;
  71.     }
  73.     public function getDecorated(): AbstractProductSuggestRoute
  74.     {
  75.         return $this->decorated;
  76.     }
  78.     /**
  79.      * @Since("6.2.0.0")
  80.      * @Entity("product")
  81.      * @Route("/store-api/search-suggest", name="store-api.search.suggest", methods={"POST"})
  82.      */
  83.     public function load(Request $request, SalesChannelContext $context, Criteria $criteria): ProductSuggestRouteResponse
  84.     {
  85.         if ($context->hasState(...$this->states)) {
  86.             return $this->getDecorated()->load($request, $context, $criteria);
  87.         }
  89.         $key = $this->generateKey($request, $context, $criteria);
  91.         if ($key === null) {
  92.             return $this->getDecorated()->load($request, $context, $criteria);
  93.         }
  95.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
  96.             $response = $this->tracer->trace(self::NAME, function () use ($request, $context, $criteria) {
  97.                 return $this->getDecorated()->load($request, $context, $criteria);
  98.             });
  100.             $item->tag($this->generateTags($request, $response, $context, $criteria));
  102.             return CacheValueCompressor::compress($response);
  103.         });
  105.         return CacheValueCompressor::uncompress($value);
  106.     }
  108.     private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  109.     {
  110.         $parts = [
  111.             $this->generator->getCriteriaHash($criteria),
  112.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::PRODUCT_AREA]),
  113.             $request->get('search'),
  114.         ];
  116.         $event = new ProductSuggestRouteCacheKeyEvent($parts, $request, $context, $criteria);
  117.         $this->dispatcher->dispatch($event);
  119.         if (!$event->shouldCache()) {
  120.             return null;
  121.         }
  123.         return self::NAME . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  124.     }
  126.     /**
  127.      * @return array<string>
  128.      */
  129.     private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  130.     {
  131.         $tags = array_merge(
  132.             $this->tracer->get(self::NAME),
  133.             [self::NAME],
  134.         );
  136.         $event = new ProductSuggestRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  137.         $this->dispatcher->dispatch($event);
  139.         return array_unique(array_filter($event->getTags()));
  140.     }
  141. }