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

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\Event\NavigationRouteCacheKeyEvent;
  7. use Shopware\Core\Content\Category\Event\NavigationRouteCacheTagsEvent;
  8. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  9. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  11. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  13. use Shopware\Core\Framework\Routing\Annotation\Entity;
  14. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  15. use Shopware\Core\Framework\Routing\Annotation\Since;
  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. /**
  26.  * @Route(defaults={"_routeScope"={"store-api"}})
  27.  */
  28. class CachedNavigationRoute extends AbstractNavigationRoute
  29. {
  30.     public const ALL_TAG = 'navigation';
  32.     public const BASE_NAVIGATION_TAG = 'base-navigation';
  34.     private AbstractNavigationRoute $decorated;
  36.     private CacheInterface $cache;
  38.     private EntityCacheKeyGenerator $generator;
  40.     /**
  41.      * @var AbstractCacheTracer<NavigationRouteResponse>
  42.      */
  43.     private AbstractCacheTracer $tracer;
  45.     /**
  46.      * @var array<string>
  47.      */
  48.     private array $states;
  50.     private EventDispatcherInterface $dispatcher;
  52.     /**
  53.      * @internal
  54.      *
  55.      * @param AbstractCacheTracer<NavigationRouteResponse> $tracer
  56.      * @param array<string> $states
  57.      */
  58.     public function __construct(
  59.         AbstractNavigationRoute $decorated,
  60.         CacheInterface $cache,
  61.         EntityCacheKeyGenerator $generator,
  62.         AbstractCacheTracer $tracer,
  63.         EventDispatcherInterface $dispatcher,
  64.         array $states
  65.     ) {
  66.         $this->decorated = $decorated;
  67.         $this->cache = $cache;
  68.         $this->generator = $generator;
  69.         $this->tracer = $tracer;
  70.         $this->states = $states;
  71.         $this->dispatcher = $dispatcher;
  72.     }
  74.     public function getDecorated(): AbstractNavigationRoute
  75.     {
  76.         return $this->decorated;
  77.     }
  79.     /**
  80.      * @Since("6.2.0.0")
  81.      * @Entity("category")
  82.      * @Route("/store-api/navigation/{activeId}/{rootId}", name="store-api.navigation", methods={"GET", "POST"})
  83.      */
  84.     public function load(string $activeId, string $rootId, Request $request, SalesChannelContext $context, Criteria $criteria): NavigationRouteResponse
  85.     {
  86.         return Profiler::trace('navigation-route', function () use ($activeId, $rootId, $request, $context, $criteria) {
  87.             if ($context->hasState(...$this->states)) {
  88.                 return $this->getDecorated()->load($activeId, $rootId, $request, $context, $criteria);
  89.             }
  91.             $depth = $request->query->getInt('depth', $request->request->getInt('depth', 2));
  93.             // first we load the base navigation, the base navigation is shared for all storefront listings
  94.             $response = $this->loadNavigation($request, $rootId, $rootId, $depth, $context, $criteria, [self::ALL_TAG, self::BASE_NAVIGATION_TAG]);
  96.             // no we have to check if the active category is loaded and the children of the active category are loaded
  97.             if ($this->isActiveLoaded($rootId, $response->getCategories(), $activeId)) {
  98.                 return $response;
  99.             }
  101.             // reload missing children of active category, depth 0 allows us the skip base navigation loading in the core route
  102.             $active = $this->loadNavigation($request, $activeId, $rootId, 0, $context, $criteria, [self::ALL_TAG]);
  104.             $response->getCategories()->merge($active->getCategories());
  106.             return $response;
  107.         });
  108.     }
  110.     public static function buildName(string $id): string
  111.     {
  112.         return 'navigation-route-' . $id;
  113.     }
  115.     /**
  116.      * @param array<string> $tags
  117.      */
  118.     private function loadNavigation(Request $request, string $active, string $rootId, int $depth, SalesChannelContext $context, Criteria $criteria, array $tags = []): NavigationRouteResponse
  119.     {
  120.         $key = $this->generateKey($active, $rootId, $depth, $request, $context, $criteria);
  122.         if ($key === null) {
  123.             return $this->getDecorated()->load($active, $rootId, $request, $context, $criteria);
  124.         }
  126.         $value = $this->cache->get($key, function (ItemInterface $item) use ($active, $depth, $rootId, $request, $context, $criteria, $tags) {
  127.             $request->query->set('depth', (string) $depth);
  129.             $name = self::buildName($active);
  131.             $response = $this->tracer->trace($name, function () use ($active, $rootId, $request, $context, $criteria) {
  132.                 return $this->getDecorated()->load($active, $rootId, $request, $context, $criteria);
  133.             });
  135.             $item->tag($this->generateTags($tags, $active, $rootId, $depth, $request, $response, $context, $criteria));
  137.             return CacheValueCompressor::compress($response);
  138.         });
  140.         return CacheValueCompressor::uncompress($value);
  141.     }
  143.     private function isActiveLoaded(string $root, CategoryCollection $categories, string $activeId): bool
  144.     {
  145.         if ($root === $activeId) {
  146.             return true;
  147.         }
  149.         $active = $categories->get($activeId);
  150.         if ($active === null) {
  151.             return false;
  152.         }
  154.         if ($active->getChildCount() === 0) {
  155.             return $categories->has($active->getParentId());
  156.         }
  158.         foreach ($categories as $category) {
  159.             if ($category->getParentId() === $activeId) {
  160.                 return true;
  161.             }
  162.         }
  164.         return false;
  165.     }
  167.     private function generateKey(string $active, string $rootId, int $depth, Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  168.     {
  169.         $parts = [
  170.             $rootId,
  171.             $depth,
  172.             $this->generator->getCriteriaHash($criteria),
  173.             $this->generator->getSalesChannelContextHash($context),
  174.         ];
  176.         $event = new NavigationRouteCacheKeyEvent($parts, $active, $rootId, $depth, $request, $context, $criteria);
  177.         $this->dispatcher->dispatch($event);
  179.         if (!$event->shouldCache()) {
  180.             return null;
  181.         }
  183.         return self::buildName($active) . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  184.     }
  186.     /**
  187.      * @param array<string> $tags
  188.      *
  189.      * @return array<string>
  190.      */
  191.     private function generateTags(array $tags, string $active, string $rootId, int $depth, Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  192.     {
  193.         $tags = array_merge(
  194.             $tags,
  195.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  196.             [self::buildName($context->getSalesChannelId())]
  197.         );
  199.         $event = new NavigationRouteCacheTagsEvent($tags, $active, $rootId, $depth, $request, $response, $context, $criteria);
  200.         $this->dispatcher->dispatch($event);
  202.         return array_unique(array_filter($event->getTags()));
  203.     }
  204. }