src/Core/Content/Category/SalesChannel/CachedNavigationRoute.php line 51

  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(private readonly AbstractNavigationRoute $decorated, private readonly CacheInterface $cache, private readonly EntityCacheKeyGenerator $generator, private readonly AbstractCacheTracer $tracer, private readonly EventDispatcherInterface $dispatcher, private readonly array $states)
  40.     {
  41.     }
  43.     public function getDecorated(): AbstractNavigationRoute
  44.     {
  45.         return $this->decorated;
  46.     }
  48.     #[Route(path: '/store-api/navigation/{activeId}/{rootId}', name: 'store-api.navigation', methods: ['GET', 'POST'], defaults: ['_entity' => 'category'])]
  49.     public function load(string $activeId, string $rootId, Request $request, SalesChannelContext $context, Criteria $criteria): NavigationRouteResponse
  50.     {
  51.         return Profiler::trace('navigation-route', function () use ($activeId, $rootId, $request, $context, $criteria) {
  52.             if ($context->hasState(...$this->states)) {
  53.                 return $this->getDecorated()->load($activeId, $rootId, $request, $context, $criteria);
  54.             }
  56.             $depth = $request->query->getInt('depth', $request->request->getInt('depth', 2));
  58.             // first we load the base navigation, the base navigation is shared for all storefront listings
  59.             $response = $this->loadNavigation($request, $rootId, $rootId, $depth, $context, $criteria, [self::ALL_TAG, self::BASE_NAVIGATION_TAG]);
  61.             // no we have to check if the active category is loaded and the children of the active category are loaded
  62.             if ($this->isActiveLoaded($rootId, $response->getCategories(), $activeId)) {
  63.                 return $response;
  64.             }
  66.             // reload missing children of active category, depth 0 allows us the skip base navigation loading in the core route
  67.             $active = $this->loadNavigation($request, $activeId, $rootId, 0, $context, $criteria, [self::ALL_TAG]);
  69.             $response->getCategories()->merge($active->getCategories());
  71.             return $response;
  72.         });
  73.     }
  75.     public static function buildName(string $id): string
  76.     {
  77.         return 'navigation-route-' . $id;
  78.     }
  80.     /**
  81.      * @param array<string> $tags
  82.      */
  83.     private function loadNavigation(Request $request, string $active, string $rootId, int $depth, SalesChannelContext $context, Criteria $criteria, array $tags = []): NavigationRouteResponse
  84.     {
  85.         $key = $this->generateKey($active, $rootId, $depth, $request, $context, $criteria);
  87.         if ($key === null) {
  88.             return $this->getDecorated()->load($active, $rootId, $request, $context, $criteria);
  89.         }
  91.         $value = $this->cache->get($key, function (ItemInterface $item) use ($active, $depth, $rootId, $request, $context, $criteria, $tags) {
  92.             $request->query->set('depth', (string) $depth);
  94.             $name = self::buildName($active);
  96.             $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($active, $rootId, $request, $context, $criteria));
  98.             $item->tag($this->generateTags($tags, $active, $rootId, $depth, $request, $response, $context, $criteria));
  100.             return CacheValueCompressor::compress($response);
  101.         });
  103.         return CacheValueCompressor::uncompress($value);
  104.     }
  106.     private function isActiveLoaded(string $root, CategoryCollection $categories, string $activeId): bool
  107.     {
  108.         if ($root === $activeId) {
  109.             return true;
  110.         }
  112.         $active = $categories->get($activeId);
  113.         if (!$active instanceof CategoryEntity) {
  114.             return false;
  115.         }
  117.         if ($active->getChildCount() === 0 && \is_string($active->getParentId())) {
  118.             return $categories->has($active->getParentId());
  119.         }
  121.         foreach ($categories as $category) {
  122.             if ($category->getParentId() === $activeId) {
  123.                 return true;
  124.             }
  125.         }
  127.         return false;
  128.     }
  130.     private function generateKey(string $active, string $rootId, int $depth, Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  131.     {
  132.         $parts = [
  133.             $rootId,
  134.             $depth,
  135.             $this->generator->getCriteriaHash($criteria),
  136.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::CATEGORY_AREA]),
  137.         ];
  139.         $event = new NavigationRouteCacheKeyEvent($parts, $active, $rootId, $depth, $request, $context, $criteria);
  140.         $this->dispatcher->dispatch($event);
  142.         if (!$event->shouldCache()) {
  143.             return null;
  144.         }
  146.         return self::buildName($active) . '-' . md5(Json::encode($event->getParts()));
  147.     }
  149.     /**
  150.      * @param array<string> $tags
  151.      *
  152.      * @return array<string>
  153.      */
  154.     private function generateTags(array $tags, string $active, string $rootId, int $depth, Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  155.     {
  156.         $tags = array_merge(
  157.             $tags,
  158.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  159.             [self::buildName($context->getSalesChannelId())]
  160.         );
  162.         $event = new NavigationRouteCacheTagsEvent($tags, $active, $rootId, $depth, $request, $response, $context, $criteria);
  163.         $this->dispatcher->dispatch($event);
  165.         return array_unique(array_filter($event->getTags()));
  166.     }
  167. }