src/Core/Content/Category/SalesChannel/CachedCategoryRoute.php line 62

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category\SalesChannel;
  5. use Shopware\Core\Content\Category\Event\CategoryRouteCacheKeyEvent;
  6. use Shopware\Core\Content\Category\Event\CategoryRouteCacheTagsEvent;
  7. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  8. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductBoxStruct;
  9. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductSliderStruct;
  10. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  11. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\RuleAreas;
  14. use Shopware\Core\Framework\Log\Package;
  15. use Shopware\Core\Framework\Util\Json;
  16. use Shopware\Core\Profiling\Profiler;
  17. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\Routing\Annotation\Route;
  20. use Symfony\Contracts\Cache\CacheInterface;
  21. use Symfony\Contracts\Cache\ItemInterface;
  22. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  24. #[Route(defaults: ['_routeScope' => ['store-api']])]
  25. #[Package('content')]
  26. class CachedCategoryRoute extends AbstractCategoryRoute
  27. {
  28.     /**
  29.      * @internal
  30.      *
  31.      * @param AbstractCacheTracer<CategoryRouteResponse> $tracer
  32.      * @param array<string> $states
  33.      */
  34.     public function __construct(private readonly AbstractCategoryRoute $decorated, private readonly CacheInterface $cache, private readonly EntityCacheKeyGenerator $generator, private readonly AbstractCacheTracer $tracer, private readonly EventDispatcherInterface $dispatcher, private readonly array $states)
  35.     {
  36.     }
  38.     public static function buildName(string $id): string
  39.     {
  40.         return 'category-route-' . $id;
  41.     }
  43.     public function getDecorated(): AbstractCategoryRoute
  44.     {
  45.         return $this->decorated;
  46.     }
  48.     #[Route(path: '/store-api/category/{navigationId}', name: 'store-api.category.detail', methods: ['GET', 'POST'])]
  49.     public function load(string $navigationId, Request $request, SalesChannelContext $context): CategoryRouteResponse
  50.     {
  51.         return Profiler::trace('category-route', function () use ($navigationId, $request, $context) {
  52.             if ($context->hasState(...$this->states)) {
  53.                 return $this->getDecorated()->load($navigationId, $request, $context);
  54.             }
  56.             $key = $this->generateKey($navigationId, $request, $context);
  58.             if ($key === null) {
  59.                 return $this->getDecorated()->load($navigationId, $request, $context);
  60.             }
  62.             $value = $this->cache->get($key, function (ItemInterface $item) use ($navigationId, $request, $context) {
  63.                 $name = self::buildName($navigationId);
  65.                 $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($navigationId, $request, $context));
  67.                 $item->tag($this->generateTags($navigationId, $response, $request, $context));
  69.                 return CacheValueCompressor::compress($response);
  70.             });
  72.             return CacheValueCompressor::uncompress($value);
  73.         });
  74.     }
  76.     private function generateKey(string $navigationId, Request $request, SalesChannelContext $context): ?string
  77.     {
  78.         $parts = [...$request->query->all(), ...$request->request->all(), ...[$this->generator->getSalesChannelContextHash($context, [RuleAreas::CATEGORY_AREA, RuleAreas::PRODUCT_AREA])]];
  80.         $event = new CategoryRouteCacheKeyEvent($navigationId, $parts, $request, $context, null);
  81.         $this->dispatcher->dispatch($event);
  83.         if (!$event->shouldCache()) {
  84.             return null;
  85.         }
  87.         return self::buildName($navigationId) . '-' . md5(Json::encode($event->getParts()));
  88.     }
  90.     /**
  91.      * @return array<string>
  92.      */
  93.     private function generateTags(string $navigationId, CategoryRouteResponse $response, Request $request, SalesChannelContext $context): array
  94.     {
  95.         $tags = array_merge(
  96.             $this->tracer->get(self::buildName($navigationId)),
  97.             $this->extractProductIds($response),
  98.             [self::buildName($navigationId)]
  99.         );
  101.         $event = new CategoryRouteCacheTagsEvent($navigationId, $tags, $request, $response, $context, null);
  102.         $this->dispatcher->dispatch($event);
  104.         return array_unique(array_filter($event->getTags()));
  105.     }
  107.     /**
  108.      * @return array<string>
  109.      */
  110.     private function extractProductIds(CategoryRouteResponse $response): array
  111.     {
  112.         $page = $response->getCategory()->getCmsPage();
  114.         if ($page === null) {
  115.             return [];
  116.         }
  118.         $ids = [];
  119.         $streamIds = [];
  121.         $slots = $page->getElementsOfType('product-slider');
  122.         /** @var CmsSlotEntity $slot */
  123.         foreach ($slots as $slot) {
  124.             $slider = $slot->getData();
  126.             if (!$slider instanceof ProductSliderStruct) {
  127.                 continue;
  128.             }
  130.             if ($slider->getStreamId() !== null) {
  131.                 $streamIds[] = $slider->getStreamId();
  132.             }
  134.             if ($slider->getProducts() === null) {
  135.                 continue;
  136.             }
  137.             foreach ($slider->getProducts() as $product) {
  138.                 $ids[] = $product->getId();
  139.                 $ids[] = $product->getParentId();
  140.             }
  141.         }
  143.         $slots = $page->getElementsOfType('product-box');
  144.         /** @var CmsSlotEntity $slot */
  145.         foreach ($slots as $slot) {
  146.             $box = $slot->getData();
  148.             if (!$box instanceof ProductBoxStruct) {
  149.                 continue;
  150.             }
  151.             if ($box->getProduct() === null) {
  152.                 continue;
  153.             }
  155.             $ids[] = $box->getProduct()->getId();
  156.             $ids[] = $box->getProduct()->getParentId();
  157.         }
  159.         $ids = array_values(array_unique(array_filter($ids)));
  161.         return [...array_map(EntityCacheKeyGenerator::buildProductTag(...), $ids), ...array_map(EntityCacheKeyGenerator::buildStreamTag(...), $streamIds), ...[EntityCacheKeyGenerator::buildCmsTag($page->getId())]];
  162.     }
  163. }