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

Open in your IDE?
  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\FieldSerializer\JsonFieldSerializer;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  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\Profiling\Profiler;
  19. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  20. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  21. use Symfony\Component\HttpFoundation\Request;
  22. use Symfony\Component\Routing\Annotation\Route;
  23. use Symfony\Contracts\Cache\CacheInterface;
  24. use Symfony\Contracts\Cache\ItemInterface;
  25. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  27. /**
  28.  * @Route(defaults={"_routeScope"={"store-api"}})
  29.  */
  30. class CachedNavigationRoute extends AbstractNavigationRoute
  31. {
  32.     public const ALL_TAG = 'navigation';
  34.     public const BASE_NAVIGATION_TAG = 'base-navigation';
  36.     private AbstractNavigationRoute $decorated;
  38.     private CacheInterface $cache;
  40.     private EntityCacheKeyGenerator $generator;
  42.     /**
  43.      * @var AbstractCacheTracer<NavigationRouteResponse>
  44.      */
  45.     private AbstractCacheTracer $tracer;
  47.     /**
  48.      * @var array<string>
  49.      */
  50.     private array $states;
  52.     private EventDispatcherInterface $dispatcher;
  54.     /**
  55.      * @internal
  56.      *
  57.      * @param AbstractCacheTracer<NavigationRouteResponse> $tracer
  58.      * @param array<string> $states
  59.      */
  60.     public function __construct(
  61.         AbstractNavigationRoute $decorated,
  62.         CacheInterface $cache,
  63.         EntityCacheKeyGenerator $generator,
  64.         AbstractCacheTracer $tracer,
  65.         EventDispatcherInterface $dispatcher,
  66.         array $states
  67.     ) {
  68.         $this->decorated = $decorated;
  69.         $this->cache = $cache;
  70.         $this->generator = $generator;
  71.         $this->tracer = $tracer;
  72.         $this->states = $states;
  73.         $this->dispatcher = $dispatcher;
  74.     }
  76.     public function getDecorated(): AbstractNavigationRoute
  77.     {
  78.         return $this->decorated;
  79.     }
  81.     /**
  82.      * @Since("6.2.0.0")
  83.      * @Entity("category")
  84.      * @Route("/store-api/navigation/{activeId}/{rootId}", name="store-api.navigation", methods={"GET", "POST"})
  85.      */
  86.     public function load(string $activeId, string $rootId, Request $request, SalesChannelContext $context, Criteria $criteria): NavigationRouteResponse
  87.     {
  88.         return Profiler::trace('navigation-route', function () use ($activeId, $rootId, $request, $context, $criteria) {
  89.             if ($context->hasState(...$this->states)) {
  90.                 return $this->getDecorated()->load($activeId, $rootId, $request, $context, $criteria);
  91.             }
  93.             $depth = $request->query->getInt('depth', $request->request->getInt('depth', 2));
  95.             // first we load the base navigation, the base navigation is shared for all storefront listings
  96.             $response = $this->loadNavigation($request, $rootId, $rootId, $depth, $context, $criteria, [self::ALL_TAG, self::BASE_NAVIGATION_TAG]);
  98.             // no we have to check if the active category is loaded and the children of the active category are loaded
  99.             if ($this->isActiveLoaded($rootId, $response->getCategories(), $activeId)) {
  100.                 return $response;
  101.             }
  103.             // reload missing children of active category, depth 0 allows us the skip base navigation loading in the core route
  104.             $active = $this->loadNavigation($request, $activeId, $rootId, 0, $context, $criteria, [self::ALL_TAG]);
  106.             $response->getCategories()->merge($active->getCategories());
  108.             return $response;
  109.         });
  110.     }
  112.     public static function buildName(string $id): string
  113.     {
  114.         return 'navigation-route-' . $id;
  115.     }
  117.     /**
  118.      * @param array<string> $tags
  119.      */
  120.     private function loadNavigation(Request $request, string $active, string $rootId, int $depth, SalesChannelContext $context, Criteria $criteria, array $tags = []): NavigationRouteResponse
  121.     {
  122.         $key = $this->generateKey($active, $rootId, $depth, $request, $context, $criteria);
  124.         if ($key === null) {
  125.             return $this->getDecorated()->load($active, $rootId, $request, $context, $criteria);
  126.         }
  128.         $value = $this->cache->get($key, function (ItemInterface $item) use ($active, $depth, $rootId, $request, $context, $criteria, $tags) {
  129.             $request->query->set('depth', (string) $depth);
  131.             $name = self::buildName($active);
  133.             $response = $this->tracer->trace($name, function () use ($active, $rootId, $request, $context, $criteria) {
  134.                 return $this->getDecorated()->load($active, $rootId, $request, $context, $criteria);
  135.             });
  137.             $item->tag($this->generateTags($tags, $active, $rootId, $depth, $request, $response, $context, $criteria));
  139.             return CacheValueCompressor::compress($response);
  140.         });
  142.         return CacheValueCompressor::uncompress($value);
  143.     }
  145.     private function isActiveLoaded(string $root, CategoryCollection $categories, string $activeId): bool
  146.     {
  147.         if ($root === $activeId) {
  148.             return true;
  149.         }
  151.         $active = $categories->get($activeId);
  152.         if (!$active instanceof CategoryEntity) {
  153.             return false;
  154.         }
  156.         if ($active->getChildCount() === 0 && \is_string($active->getParentId())) {
  157.             return $categories->has($active->getParentId());
  158.         }
  160.         foreach ($categories as $category) {
  161.             if ($category->getParentId() === $activeId) {
  162.                 return true;
  163.             }
  164.         }
  166.         return false;
  167.     }
  169.     private function generateKey(string $active, string $rootId, int $depth, Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  170.     {
  171.         $parts = [
  172.             $rootId,
  173.             $depth,
  174.             $this->generator->getCriteriaHash($criteria),
  175.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::CATEGORY_AREA]),
  176.         ];
  178.         $event = new NavigationRouteCacheKeyEvent($parts, $active, $rootId, $depth, $request, $context, $criteria);
  179.         $this->dispatcher->dispatch($event);
  181.         if (!$event->shouldCache()) {
  182.             return null;
  183.         }
  185.         return self::buildName($active) . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  186.     }
  188.     /**
  189.      * @param array<string> $tags
  190.      *
  191.      * @return array<string>
  192.      */
  193.     private function generateTags(array $tags, string $active, string $rootId, int $depth, Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  194.     {
  195.         $tags = array_merge(
  196.             $tags,
  197.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  198.             [self::buildName($context->getSalesChannelId())]
  199.         );
  201.         $event = new NavigationRouteCacheTagsEvent($tags, $active, $rootId, $depth, $request, $response, $context, $criteria);
  202.         $this->dispatcher->dispatch($event);
  204.         return array_unique(array_filter($event->getTags()));
  205.     }
  206. }