src/Core/Content/Product/SalesChannel/Review/CachedProductReviewRoute.php line 67

  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\Search\Criteria;
  13. use Shopware\Core\Framework\Log\Package;
  14. use Shopware\Core\Framework\Util\Json;
  15. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  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. #[Route(defaults: ['_routeScope' => ['store-api']])]
  23. #[Package('inventory')]
  24. class CachedProductReviewRoute extends AbstractProductReviewRoute
  25. {
  26.     final public const ALL_TAG = 'product-review-route';
  28.     /**
  29.      * @var string[]
  30.      */
  31.     private readonly array $states;
  33.     /**
  34.      * @internal
  35.      *
  36.      * @param AbstractCacheTracer<ProductReviewRouteResponse> $tracer
  37.      * @param string[] $states
  38.      */
  39.     public function __construct(
  40.         private readonly AbstractProductReviewRoute $decorated,
  41.         private readonly CacheInterface $cache,
  42.         private readonly EntityCacheKeyGenerator $generator,
  43.         private readonly AbstractCacheTracer $tracer,
  44.         private readonly EventDispatcherInterface $dispatcher,
  45.         array $states
  46.     ) {
  47.         $states[] = CacheStateSubscriber::STATE_LOGGED_IN;
  48.         $this->states = array_unique($states);
  49.     }
  51.     public function getDecorated(): AbstractProductReviewRoute
  52.     {
  53.         return $this->decorated;
  54.     }
  56.     #[Route(path: '/store-api/product/{productId}/reviews', name: 'store-api.product-review.list', methods: ['POST'], defaults: ['_entity' => 'product_review'])]
  57.     public function load(string $productId, Request $request, SalesChannelContext $context, Criteria $criteria): ProductReviewRouteResponse
  58.     {
  59.         if ($context->hasState(...$this->states)) {
  60.             return $this->getDecorated()->load($productId, $request, $context, $criteria);
  61.         }
  63.         $key = $this->generateKey($productId, $request, $context, $criteria);
  65.         $value = $this->cache->get($key, function (ItemInterface $item) use ($productId, $request, $context, $criteria) {
  66.             $name = self::buildName($productId);
  67.             $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($productId, $request, $context, $criteria));
  69.             $item->tag($this->generateTags($productId, $request, $response, $context, $criteria));
  71.             return CacheValueCompressor::compress($response);
  72.         });
  74.         return CacheValueCompressor::uncompress($value);
  75.     }
  77.     public static function buildName(string $productId): string
  78.     {
  79.         return 'product-review-route-' . $productId;
  80.     }
  82.     private function generateKey(string $productId, Request $request, SalesChannelContext $context, Criteria $criteria): string
  83.     {
  84.         $parts = [
  85.             $this->generator->getCriteriaHash($criteria),
  86.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::PRODUCT_AREA]),
  87.         ];
  89.         $event = new ProductDetailRouteCacheKeyEvent($parts, $request, $context, $criteria);
  90.         $this->dispatcher->dispatch($event);
  92.         return self::buildName($productId) . '-' . md5(Json::encode($event->getParts()));
  93.     }
  95.     /**
  96.      * @return string[]
  97.      */
  98.     private function generateTags(string $productId, Request $request, ProductReviewRouteResponse $response, SalesChannelContext $context, Criteria $criteria): array
  99.     {
  100.         $tags = array_merge(
  101.             $this->tracer->get(self::buildName($productId)),
  102.             [self::buildName($productId)]
  103.         );
  105.         $event = new ProductDetailRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  106.         $this->dispatcher->dispatch($event);
  108.         return array_unique(array_filter($event->getTags()));
  109.     }
  110. }