vendor/shopware/core/Content/Product/SalesChannel/Review/CachedProductReviewRoute.php line 97

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\Review;
  5. use Shopware\Core\Content\Product\Events\ProductDetailRouteCacheKeyEvent;
  6. use Shopware\Core\Content\Product\Events\ProductDetailRouteCacheTagsEvent;
  7. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  8. use Shopware\Core\Framework\Adapter\Cache\CacheStateSubscriber;
  9. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\RuleAreas;
  12. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  14. use Shopware\Core\Framework\Log\Package;
  15. use Shopware\Core\Framework\Routing\Annotation\Entity;
  16. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  17. use Shopware\Core\Framework\Routing\Annotation\Since;
  18. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  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('inventory')]
  29. class CachedProductReviewRoute extends AbstractProductReviewRoute
  30. {
  31.     public const ALL_TAG = 'product-review-route';
  33.     private AbstractProductReviewRoute $decorated;
  35.     private CacheInterface $cache;
  37.     private EntityCacheKeyGenerator $generator;
  39.     /**
  40.      * @var AbstractCacheTracer<ProductReviewRouteResponse>
  41.      */
  42.     private AbstractCacheTracer $tracer;
  44.     /**
  45.      * @var string[]
  46.      */
  47.     private array $states;
  49.     private EventDispatcherInterface $dispatcher;
  51.     /**
  52.      * @internal
  53.      *
  54.      * @param AbstractCacheTracer<ProductReviewRouteResponse> $tracer
  55.      * @param string[] $states
  56.      */
  57.     public function __construct(
  58.         AbstractProductReviewRoute $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;
  70.         $states[] = CacheStateSubscriber::STATE_LOGGED_IN;
  71.         $this->states = array_unique($states);
  72.         $this->dispatcher = $dispatcher;
  73.     }
  75.     public function getDecorated(): AbstractProductReviewRoute
  76.     {
  77.         return $this->decorated;
  78.     }
  80.     /**
  81.      * @Since("6.3.2.0")
  82.      * @Entity("product_review")
  83.      * @Route("/store-api/product/{productId}/reviews", name="store-api.product-review.list", methods={"POST"})
  84.      */
  85.     public function load(string $productId, Request $request, SalesChannelContext $context, Criteria $criteria): ProductReviewRouteResponse
  86.     {
  87.         if ($context->hasState(...$this->states)) {
  88.             return $this->getDecorated()->load($productId, $request, $context, $criteria);
  89.         }
  91.         $key = $this->generateKey($productId, $request, $context, $criteria);
  93.         $value = $this->cache->get($key, function (ItemInterface $item) use ($productId, $request, $context, $criteria) {
  94.             $name = self::buildName($productId);
  95.             $response = $this->tracer->trace($name, function () use ($productId, $request, $context, $criteria) {
  96.                 return $this->getDecorated()->load($productId, $request, $context, $criteria);
  97.             });
  99.             $item->tag($this->generateTags($productId, $request, $response, $context, $criteria));
  101.             return CacheValueCompressor::compress($response);
  102.         });
  104.         return CacheValueCompressor::uncompress($value);
  105.     }
  107.     public static function buildName(string $productId): string
  108.     {
  109.         return 'product-review-route-' . $productId;
  110.     }
  112.     private function generateKey(string $productId, Request $request, SalesChannelContext $context, Criteria $criteria): string
  113.     {
  114.         $parts = [
  115.             $this->generator->getCriteriaHash($criteria),
  116.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::PRODUCT_AREA]),
  117.         ];
  119.         $event = new ProductDetailRouteCacheKeyEvent($parts, $request, $context, $criteria);
  120.         $this->dispatcher->dispatch($event);
  122.         return self::buildName($productId) . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  123.     }
  125.     /**
  126.      * @return string[]
  127.      */
  128.     private function generateTags(string $productId, Request $request, ProductReviewRouteResponse $response, SalesChannelContext $context, Criteria $criteria): array
  129.     {
  130.         $tags = array_merge(
  131.             $this->tracer->get(self::buildName($productId)),
  132.             [self::buildName($productId)]
  133.         );
  135.         $event = new ProductDetailRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  136.         $this->dispatcher->dispatch($event);
  138.         return array_unique(array_filter($event->getTags()));
  139.     }
  140. }