vendor/shopware/core/Checkout/Shipping/SalesChannel/CachedShippingMethodRoute.php line 70

  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(
  35.         private readonly AbstractShippingMethodRoute $decorated,
  36.         private readonly CacheInterface $cache,
  37.         private readonly EntityCacheKeyGenerator $generator,
  38.         private readonly AbstractCacheTracer $tracer,
  39.         private readonly EventDispatcherInterface $dispatcher,
  40.         private readonly array $states
  41.     ) {
  42.     }
  44.     public function getDecorated(): AbstractShippingMethodRoute
  45.     {
  46.         return $this->decorated;
  47.     }
  49.     #[Route(path: '/store-api/shipping-method', name: 'store-api.shipping.method', methods: ['GET', 'POST'], defaults: ['_entity' => 'shipping_method'])]
  50.     public function load(Request $request, SalesChannelContext $context, Criteria $criteria): ShippingMethodRouteResponse
  51.     {
  52.         if ($context->hasState(...$this->states)) {
  53.             return $this->getDecorated()->load($request, $context, $criteria);
  54.         }
  56.         $key = $this->generateKey($request, $context, $criteria);
  58.         if ($key === null) {
  59.             return $this->getDecorated()->load($request, $context, $criteria);
  60.         }
  62.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
  63.             $name = self::buildName($context->getSalesChannelId());
  65.             $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($request, $context, $criteria));
  67.             $item->tag($this->generateTags($request, $response, $context, $criteria));
  69.             return CacheValueCompressor::compress($response);
  70.         });
  72.         return CacheValueCompressor::uncompress($value);
  73.     }
  75.     public static function buildName(string $salesChannelId): string
  76.     {
  77.         return 'shipping-method-route-' . $salesChannelId;
  78.     }
  80.     private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  81.     {
  82.         $parts = [
  83.             $this->generator->getCriteriaHash($criteria),
  84.             $this->generator->getSalesChannelContextHash($context, [RuleAreas::SHIPPING_AREA]),
  85.             $request->query->getBoolean('onlyAvailable', false),
  86.         ];
  88.         $event = new ShippingMethodRouteCacheKeyEvent($parts, $request, $context, $criteria);
  89.         $this->dispatcher->dispatch($event);
  91.         if (!$event->shouldCache()) {
  92.             return null;
  93.         }
  95.         return self::buildName($context->getSalesChannelId()) . '-' . md5(Json::encode($event->getParts()));
  96.     }
  98.     /**
  99.      * @return array<string>
  100.      */
  101.     private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  102.     {
  103.         $tags = array_merge(
  104.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  105.             [self::buildName($context->getSalesChannelId()), self::ALL_TAG]
  106.         );
  108.         $event = new ShippingMethodRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  109.         $this->dispatcher->dispatch($event);
  111.         return array_unique(array_filter($event->getTags()));
  112.     }
  113. }