src/Core/Checkout/Shipping/SalesChannel/CachedShippingMethodRoute.php line 56

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Shipping\SalesChannel;
  5. use Shopware\Core\Checkout\Shipping\Event\ShippingMethodRouteCacheKeyEvent;
  6. use Shopware\Core\Checkout\Shipping\Event\ShippingMethodRouteCacheTagsEvent;
  7. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  8. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\RuleAreas;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  12. use Shopware\Core\Framework\Log\Package;
  13. use Shopware\Core\Framework\Util\Json;
  14. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  15. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\Routing\Annotation\Route;
  18. use Symfony\Contracts\Cache\CacheInterface;
  19. use Symfony\Contracts\Cache\ItemInterface;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. #[Route(defaults: ['_routeScope' => ['store-api']])]
  23. #[Package('checkout')]
  24. class CachedShippingMethodRoute extends AbstractShippingMethodRoute
  25. {
  26.     final public const ALL_TAG = 'shipping-method-route';
  28.     /**
  29.      * @internal
  30.      *
  31.      * @param AbstractCacheTracer<ShippingMethodRouteResponse> $tracer
  32.      * @param array<string> $states
  33.      */
  34.     public function __construct(private readonly AbstractShippingMethodRoute $decorated, private readonly CacheInterface $cache, private readonly EntityCacheKeyGenerator $generator, private readonly AbstractCacheTracer $tracer, private readonly EventDispatcherInterface $dispatcher, private readonly array $states)
  35.     {
  36.     }
  38.     public function getDecorated(): AbstractShippingMethodRoute
  39.     {
  40.         return $this->decorated;
  41.     }
  43.     #[Route(path: '/store-api/shipping-method', name: 'store-api.shipping.method', methods: ['GET', 'POST'], defaults: ['_entity' => 'shipping_method'])]
  44.     public function load(Request $request, SalesChannelContext $context, Criteria $criteria): ShippingMethodRouteResponse
  45.     {
  46.         if ($context->hasState(...$this->states)) {
  47.             return $this->getDecorated()->load($request, $context, $criteria);
  48.         }
  50.         $key = $this->generateKey($request, $context, $criteria);
  52.         if ($key === null) {
  53.             return $this->getDecorated()->load($request, $context, $criteria);
  54.         }
  56.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
  57.             $name = self::buildName($context->getSalesChannelId());
  59.             $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($request, $context, $criteria));
  61.             $item->tag($this->generateTags($request, $response, $context, $criteria));
  63.             return CacheValueCompressor::compress($response);
  64.         });
  66.         return CacheValueCompressor::uncompress($value);
  67.     }
  69.     public static function buildName(string $salesChannelId): string
  70.     {
  71.         return 'shipping-method-route-' . $salesChannelId;
  72.     }
  74.     private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  75.     {
  76.         $parts = [
  77.             $this->generator->getCriteriaHash($criteria),
  78.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::SHIPPING_AREA]),
  79.             $request->query->getBoolean('onlyAvailable', false),
  80.         ];
  82.         $event = new ShippingMethodRouteCacheKeyEvent($parts, $request, $context, $criteria);
  83.         $this->dispatcher->dispatch($event);
  85.         if (!$event->shouldCache()) {
  86.             return null;
  87.         }
  89.         return self::buildName($context->getSalesChannelId()) . '-' . md5(Json::encode($event->getParts()));
  90.     }
  92.     /**
  93.      * @return array<string>
  94.      */
  95.     private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  96.     {
  97.         $tags = array_merge(
  98.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  99.             [self::buildName($context->getSalesChannelId()), self::ALL_TAG]
  100.         );
  102.         $event = new ShippingMethodRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  103.         $this->dispatcher->dispatch($event);
  105.         return array_unique(array_filter($event->getTags()));
  106.     }
  107. }