src/Core/System/Salutation/SalesChannel/CachedSalutationRoute.php line 60

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\Salutation\SalesChannel;
  5. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  6. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  9. use Shopware\Core\Framework\Log\Package;
  10. use Shopware\Core\Framework\Util\Json;
  11. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  12. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  13. use Shopware\Core\System\Salutation\Event\SalutationRouteCacheKeyEvent;
  14. use Shopware\Core\System\Salutation\Event\SalutationRouteCacheTagsEvent;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\Routing\Annotation\Route;
  17. use Symfony\Contracts\Cache\CacheInterface;
  18. use Symfony\Contracts\Cache\ItemInterface;
  19. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  21. #[Route(defaults: ['_routeScope' => ['store-api']])]
  22. #[Package('customer-order')]
  23. class CachedSalutationRoute extends AbstractSalutationRoute
  24. {
  25.     final public const ALL_TAG = 'salutation-route';
  27.     /**
  28.      * @internal
  29.      *
  30.      * @param AbstractCacheTracer<SalutationRouteResponse> $tracer
  31.      * @param array<string> $states
  32.      */
  33.     public function __construct(private readonly AbstractSalutationRoute $decorated, private readonly CacheInterface $cache, private readonly EntityCacheKeyGenerator $generator, private readonly AbstractCacheTracer $tracer, private readonly EventDispatcherInterface $dispatcher, private readonly array $states)
  34.     {
  35.     }
  37.     public static function buildName(): string
  38.     {
  39.         return 'salutation-route';
  40.     }
  42.     public function getDecorated(): AbstractSalutationRoute
  43.     {
  44.         return $this->decorated;
  45.     }
  47.     #[Route(path: '/store-api/salutation', name: 'store-api.salutation', methods: ['GET', 'POST'], defaults: ['_entity' => 'salutation'])]
  48.     public function load(Request $request, SalesChannelContext $context, Criteria $criteria): SalutationRouteResponse
  49.     {
  50.         if ($context->hasState(...$this->states)) {
  51.             return $this->getDecorated()->load($request, $context, $criteria);
  52.         }
  54.         $key = $this->generateKey($request, $context, $criteria);
  56.         if ($key === null) {
  57.             return $this->getDecorated()->load($request, $context, $criteria);
  58.         }
  60.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
  61.             $name = self::buildName();
  63.             $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($request, $context, $criteria));
  65.             $item->tag($this->generateTags($request, $response, $context, $criteria));
  67.             return CacheValueCompressor::compress($response);
  68.         });
  70.         return CacheValueCompressor::uncompress($value);
  71.     }
  73.     private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  74.     {
  75.         $parts = [
  76.             $this->generator->getCriteriaHash($criteria),
  77.             $this->generator->getSalesChannelContextHash($context),
  78.         ];
  80.         $event = new SalutationRouteCacheKeyEvent($parts, $request, $context, $criteria);
  81.         $this->dispatcher->dispatch($event);
  83.         if (!$event->shouldCache()) {
  84.             return null;
  85.         }
  87.         return self::buildName() . '-' . md5((string) Json::encode($event->getParts()));
  88.     }
  90.     /**
  91.      * @return array<string>
  92.      */
  93.     private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  94.     {
  95.         $tags = array_merge(
  96.             $this->tracer->get(self::buildName()),
  97.             [self::ALL_TAG]
  98.         );
  100.         $event = new SalutationRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  101.         $this->dispatcher->dispatch($event);
  103.         return array_unique(array_filter($event->getTags()));
  104.     }
  105. }