vendor/shopware/core/Content/Category/SalesChannel/CachedNavigationRoute.php line 78

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category\SalesChannel;
  5. use Shopware\Core\Content\Category\CategoryCollection;
  6. use Shopware\Core\Content\Category\CategoryEntity;
  7. use Shopware\Core\Content\Category\Event\NavigationRouteCacheKeyEvent;
  8. use Shopware\Core\Content\Category\Event\NavigationRouteCacheTagsEvent;
  9. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  10. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\RuleAreas;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  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 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. #[Route(defaults: ['_routeScope' => ['store-api']])]
  26. #[Package('content')]
  27. class CachedNavigationRoute extends AbstractNavigationRoute
  28. {
  29.     final public const ALL_TAG = 'navigation';
  31.     final public const BASE_NAVIGATION_TAG = 'base-navigation';
  33.     /**
  34.      * @internal
  35.      *
  36.      * @param AbstractCacheTracer<NavigationRouteResponse> $tracer
  37.      * @param array<string> $states
  38.      */
  39.     public function __construct(
  40.         private readonly AbstractNavigationRoute $decorated,
  41.         private readonly CacheInterface $cache,
  42.         private readonly EntityCacheKeyGenerator $generator,
  43.         private readonly AbstractCacheTracer $tracer,
  44.         private readonly EventDispatcherInterface $dispatcher,
  45.         private readonly array $states
  46.     ) {
  47.     }
  49.     public function getDecorated(): AbstractNavigationRoute
  50.     {
  51.         return $this->decorated;
  52.     }
  54.     #[Route(path: '/store-api/navigation/{activeId}/{rootId}', name: 'store-api.navigation', methods: ['GET', 'POST'], defaults: ['_entity' => 'category'])]
  55.     public function load(string $activeId, string $rootId, Request $request, SalesChannelContext $context, Criteria $criteria): NavigationRouteResponse
  56.     {
  57.         return Profiler::trace('navigation-route', function () use ($activeId, $rootId, $request, $context, $criteria) {
  58.             if ($context->hasState(...$this->states)) {
  59.                 return $this->getDecorated()->load($activeId, $rootId, $request, $context, $criteria);
  60.             }
  62.             $depth = $request->query->getInt('depth', $request->request->getInt('depth', 2));
  64.             // first we load the base navigation, the base navigation is shared for all storefront listings
  65.             $response = $this->loadNavigation($request, $rootId, $rootId, $depth, $context, $criteria, [self::ALL_TAG, self::BASE_NAVIGATION_TAG]);
  67.             // no we have to check if the active category is loaded and the children of the active category are loaded
  68.             if ($this->isActiveLoaded($rootId, $response->getCategories(), $activeId)) {
  69.                 return $response;
  70.             }
  72.             // reload missing children of active category, depth 0 allows us the skip base navigation loading in the core route
  73.             $active = $this->loadNavigation($request, $activeId, $rootId, 0, $context, $criteria, [self::ALL_TAG]);
  75.             $response->getCategories()->merge($active->getCategories());
  77.             return $response;
  78.         });
  79.     }
  81.     public static function buildName(string $id): string
  82.     {
  83.         return 'navigation-route-' . $id;
  84.     }
  86.     /**
  87.      * @param array<string> $tags
  88.      */
  89.     private function loadNavigation(Request $request, string $active, string $rootId, int $depth, SalesChannelContext $context, Criteria $criteria, array $tags = []): NavigationRouteResponse
  90.     {
  91.         $key = $this->generateKey($active, $rootId, $depth, $request, $context, $criteria);
  93.         if ($key === null) {
  94.             return $this->getDecorated()->load($active, $rootId, $request, $context, $criteria);
  95.         }
  97.         $value = $this->cache->get($key, function (ItemInterface $item) use ($active, $depth, $rootId, $request, $context, $criteria, $tags) {
  98.             $request->query->set('depth', (string) $depth);
  100.             $name = self::buildName($active);
  102.             $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($active, $rootId, $request, $context, $criteria));
  104.             $item->tag($this->generateTags($tags, $active, $rootId, $depth, $request, $response, $context, $criteria));
  106.             return CacheValueCompressor::compress($response);
  107.         });
  109.         return CacheValueCompressor::uncompress($value);
  110.     }
  112.     private function isActiveLoaded(string $root, CategoryCollection $categories, string $activeId): bool
  113.     {
  114.         if ($root === $activeId) {
  115.             return true;
  116.         }
  118.         $active = $categories->get($activeId);
  119.         if (!$active instanceof CategoryEntity) {
  120.             return false;
  121.         }
  123.         if ($active->getChildCount() === 0 && \is_string($active->getParentId())) {
  124.             return $categories->has($active->getParentId());
  125.         }
  127.         foreach ($categories as $category) {
  128.             if ($category->getParentId() === $activeId) {
  129.                 return true;
  130.             }
  131.         }
  133.         return false;
  134.     }
  136.     private function generateKey(string $active, string $rootId, int $depth, Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  137.     {
  138.         $parts = [
  139.             $rootId,
  140.             $depth,
  141.             $this->generator->getCriteriaHash($criteria),
  142.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::CATEGORY_AREA]),
  143.         ];
  145.         $event = new NavigationRouteCacheKeyEvent($parts, $active, $rootId, $depth, $request, $context, $criteria);
  146.         $this->dispatcher->dispatch($event);
  148.         if (!$event->shouldCache()) {
  149.             return null;
  150.         }
  152.         return self::buildName($active) . '-' . md5(Json::encode($event->getParts()));
  153.     }
  155.     /**
  156.      * @param array<string> $tags
  157.      *
  158.      * @return array<string>
  159.      */
  160.     private function generateTags(array $tags, string $active, string $rootId, int $depth, Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  161.     {
  162.         $tags = array_merge(
  163.             $tags,
  164.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  165.             [self::buildName($context->getSalesChannelId())]
  166.         );
  168.         $event = new NavigationRouteCacheTagsEvent($tags, $active, $rootId, $depth, $request, $response, $context, $criteria);
  169.         $this->dispatcher->dispatch($event);
  171.         return array_unique(array_filter($event->getTags()));
  172.     }
  173. }