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

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category\SalesChannel;
  5. use OpenApi\Annotations as OA;
  6. use Psr\Log\LoggerInterface;
  7. use Shopware\Core\Content\Category\CategoryCollection;
  8. use Shopware\Core\Content\Category\Event\NavigationRouteCacheKeyEvent;
  9. use Shopware\Core\Content\Category\Event\NavigationRouteCacheTagsEvent;
  10. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  11. use Shopware\Core\Framework\Adapter\Cache\CacheCompressor;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  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\System\SalesChannel\SalesChannelContext;
  19. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  20. use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
  21. use Symfony\Component\HttpFoundation\Request;
  22. use Symfony\Component\Routing\Annotation\Route;
  23. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  25. /**
  26.  * @RouteScope(scopes={"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 TagAwareAdapterInterface $cache;
  38.     private EntityCacheKeyGenerator $generator;
  40.     /**
  41.      * @var AbstractCacheTracer<NavigationRouteResponse>
  42.      */
  43.     private AbstractCacheTracer $tracer;
  45.     private array $states;
  47.     private EventDispatcherInterface $dispatcher;
  49.     private LoggerInterface $logger;
  51.     /**
  52.      * @param AbstractCacheTracer<NavigationRouteResponse> $tracer
  53.      */
  54.     public function __construct(
  55.         AbstractNavigationRoute $decorated,
  56.         TagAwareAdapterInterface $cache,
  57.         EntityCacheKeyGenerator $generator,
  58.         AbstractCacheTracer $tracer,
  59.         EventDispatcherInterface $dispatcher,
  60.         array $states,
  61.         LoggerInterface $logger
  62.     ) {
  63.         $this->decorated = $decorated;
  64.         $this->cache = $cache;
  65.         $this->generator = $generator;
  66.         $this->tracer = $tracer;
  67.         $this->states = $states;
  68.         $this->dispatcher = $dispatcher;
  69.         $this->logger = $logger;
  70.     }
  72.     public function getDecorated(): AbstractNavigationRoute
  73.     {
  74.         return $this->decorated;
  75.     }
  77.     /**
  78.      * @Since("6.2.0.0")
  79.      * @Entity("category")
  80.      * @OA\Post(
  81.      *      path="/navigation/{requestActiveId}/{requestRootId}",
  82.      *      summary="Fetch a navigation menu",
  83.      *      description="This endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth of the tree.
  85. Instead of passing uuids, you can also use one of the following aliases for the activeId and rootId parameters to get the respective navigations of your sales channel.
  87. * main-navigation
  88. * service-navigation
  89. * footer-navigation",
  90.      *      operationId="readNavigation",
  91.      *      tags={"Store API", "Category"},
  92.      *      @OA\Parameter(name="Api-Basic-Parameters"),
  93.      *      @OA\Parameter(
  94.      *          name="sw-include-seo-urls",
  95.      *          description="Instructs Shopware to try and resolve SEO URLs for the given navigation item",
  96.      *          @OA\Schema(type="boolean"),
  97.      *          in="header",
  98.      *          required=false
  99.      *      ),
  100.      *      @OA\Parameter(
  101.      *          name="requestActiveId",
  102.      *          description="Identifier of the active category in the navigation tree (if not used, just set to the same as rootId).",
  103.      *          @OA\Schema(type="string", pattern="^[0-9a-f]{32}$"),
  104.      *          in="path",
  105.      *          required=true
  106.      *      ),
  107.      *      @OA\Parameter(
  108.      *          name="requestRootId",
  109.      *          description="Identifier of the root category for your desired navigation tree. You can use it to fetch sub-trees of your navigation tree.",
  110.      *          @OA\Schema(type="string", pattern="^[0-9a-f]{32}$"),
  111.      *          in="path",
  112.      *          required=true
  113.      *      ),
  114.      *      @OA\RequestBody(
  115.      *          required=true,
  116.      *          @OA\JsonContent(
  117.      *              @OA\Property(
  118.      *                  property="depth",
  119.      *                  description="Determines the depth of fetched navigation levels.",
  120.      *                  @OA\Schema(type="integer", default="2")
  121.      *              ),
  122.      *              @OA\Property(
  123.      *                  property="buildTree",
  124.      *                  description="Return the categories as a tree or as a flat list.",
  125.      *                  @OA\Schema(type="boolean", default="true")
  126.      *              )
  127.      *          )
  128.      *      ),
  129.      *      @OA\Response(
  130.      *          response="200",
  131.      *          description="All available navigations",
  132.      *          @OA\JsonContent(ref="#/components/schemas/NavigationRouteResponse")
  133.      *     )
  134.      * )
  135.      * @Route("/store-api/navigation/{activeId}/{rootId}", name="store-api.navigation", methods={"GET", "POST"})
  136.      */
  137.     public function load(string $activeId, string $rootId, Request $request, SalesChannelContext $context, Criteria $criteria): NavigationRouteResponse
  138.     {
  139.         if ($context->hasState(...$this->states)) {
  140.             $this->logger->info('cache-miss: ' . self::buildName($activeId));
  142.             return $this->getDecorated()->load($activeId, $rootId, $request, $context, $criteria);
  143.         }
  145.         $depth = $request->query->getInt('depth', $request->request->getInt('depth', 2));
  147.         // first we load the base navigation, the base navigation is shared for all storefront listings
  148.         $response = $this->loadNavigation($request, $rootId, $rootId, $depth, $context, $criteria, [self::ALL_TAG, self::BASE_NAVIGATION_TAG]);
  150.         // no we have to check if the active category is loaded and the children of the active category are loaded
  151.         if ($this->isActiveLoaded($rootId, $response->getCategories(), $activeId)) {
  152.             return $response;
  153.         }
  155.         // reload missing children of active category, depth 0 allows us the skip base navigation loading in the core route
  156.         $active = $this->loadNavigation($request, $activeId, $rootId, 0, $context, $criteria, [self::ALL_TAG]);
  158.         $response->getCategories()->merge($active->getCategories());
  160.         return $response;
  161.     }
  163.     public static function buildName(string $id): string
  164.     {
  165.         return 'navigation-route-' . $id;
  166.     }
  168.     private function loadNavigation(Request $request, string $active, string $rootId, int $depth, SalesChannelContext $context, Criteria $criteria, array $tags = []): NavigationRouteResponse
  169.     {
  170.         $item = $this->cache->getItem(
  171.             $this->generateKey($active, $rootId, $depth, $request, $context, $criteria)
  172.         );
  174.         try {
  175.             if ($item->isHit() && $item->get()) {
  176.                 $this->logger->info('cache-hit: ' . self::buildName($active));
  178.                 return CacheCompressor::uncompress($item);
  179.             }
  180.         } catch (\Throwable $e) {
  181.             $this->logger->error($e->getMessage());
  182.         }
  184.         $this->logger->info('cache-miss: ' . self::buildName($active));
  186.         $request->query->set('depth', (string) $depth);
  188.         $name = self::buildName($active);
  190.         $response = $this->tracer->trace($name, function () use ($active, $rootId, $request, $context, $criteria) {
  191.             return $this->getDecorated()->load($active, $rootId, $request, $context, $criteria);
  192.         });
  194.         $item = CacheCompressor::compress($item, $response);
  196.         $item->tag($this->generateTags($tags, $active, $rootId, $depth, $request, $response, $context, $criteria));
  198.         $this->cache->save($item);
  200.         return $response;
  201.     }
  203.     private function isActiveLoaded(string $root, CategoryCollection $categories, string $activeId): bool
  204.     {
  205.         if ($root === $activeId) {
  206.             return true;
  207.         }
  209.         $active = $categories->get($activeId);
  210.         if ($active === null) {
  211.             return false;
  212.         }
  214.         if ($active->getChildCount() === 0) {
  215.             return $categories->has($active->getParentId());
  216.         }
  218.         foreach ($categories as $category) {
  219.             if ($category->getParentId() === $activeId) {
  220.                 return true;
  221.             }
  222.         }
  224.         return false;
  225.     }
  227.     private function generateKey(string $active, string $rootId, int $depth, Request $request, SalesChannelContext $context, Criteria $criteria): string
  228.     {
  229.         $parts = [
  230.             self::buildName($active),
  231.             $rootId,
  232.             $depth,
  233.             $this->generator->getCriteriaHash($criteria),
  234.             $this->generator->getSalesChannelContextHash($context),
  235.         ];
  237.         $event = new NavigationRouteCacheKeyEvent($parts, $active, $rootId, $depth, $request, $context, $criteria);
  238.         $this->dispatcher->dispatch($event);
  240.         return md5(JsonFieldSerializer::encodeJson($event->getParts()));
  241.     }
  243.     private function generateTags(array $tags, string $active, string $rootId, int $depth, Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  244.     {
  245.         $tags = array_merge(
  246.             $tags,
  247.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  248.             [self::buildName($context->getSalesChannelId())]
  249.         );
  251.         $event = new NavigationRouteCacheTagsEvent($tags, $active, $rootId, $depth, $request, $response, $context, $criteria);
  252.         $this->dispatcher->dispatch($event);
  254.         return array_unique(array_filter($event->getTags()));
  255.     }
  256. }