<?php declare(strict_types=1);
namespace Shopware\Core\Checkout\Payment\SalesChannel;
use Shopware\Core\Checkout\Payment\Event\PaymentMethodRouteCacheKeyEvent;
use Shopware\Core\Checkout\Payment\Event\PaymentMethodRouteCacheTagsEvent;
use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
use Shopware\Core\Framework\Routing\Annotation\Entity;
use Shopware\Core\Framework\Routing\Annotation\RouteScope;
use Shopware\Core\Framework\Routing\Annotation\Since;
use Shopware\Core\System\SalesChannel\SalesChannelContext;
use Shopware\Core\System\SalesChannel\StoreApiResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Contracts\Cache\CacheInterface;
use Symfony\Contracts\Cache\ItemInterface;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
* @Route(defaults={"_routeScope"={"store-api"}})
*/
class CachedPaymentMethodRoute extends AbstractPaymentMethodRoute
{
public const ALL_TAG = 'payment-method-route';
private AbstractPaymentMethodRoute $decorated;
private CacheInterface $cache;
private EntityCacheKeyGenerator $generator;
/**
* @var AbstractCacheTracer<PaymentMethodRouteResponse>
*/
private AbstractCacheTracer $tracer;
/**
* @var array<string>
*/
private array $states;
private EventDispatcherInterface $dispatcher;
/**
* @internal
*
* @param AbstractCacheTracer<PaymentMethodRouteResponse> $tracer
* @param array<string> $states
*/
public function __construct(
AbstractPaymentMethodRoute $decorated,
CacheInterface $cache,
EntityCacheKeyGenerator $generator,
AbstractCacheTracer $tracer,
EventDispatcherInterface $dispatcher,
array $states
) {
$this->decorated = $decorated;
$this->cache = $cache;
$this->generator = $generator;
$this->tracer = $tracer;
$this->states = $states;
$this->dispatcher = $dispatcher;
}
public function getDecorated(): AbstractPaymentMethodRoute
{
return $this->decorated;
}
/**
* @Since("6.2.0.0")
* @Entity("payment_method")
* @Route("/store-api/payment-method", name="store-api.payment.method", methods={"GET", "POST"})
*/
public function load(Request $request, SalesChannelContext $context, Criteria $criteria): PaymentMethodRouteResponse
{
if ($context->hasState(...$this->states)) {
return $this->getDecorated()->load($request, $context, $criteria);
}
$key = $this->generateKey($request, $context, $criteria);
if ($key === null) {
return $this->getDecorated()->load($request, $context, $criteria);
}
$value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
$name = self::buildName($context->getSalesChannelId());
$response = $this->tracer->trace($name, function () use ($request, $context, $criteria) {
return $this->getDecorated()->load($request, $context, $criteria);
});
$item->tag($this->generateTags($request, $response, $context, $criteria));
return CacheValueCompressor::compress($response);
});
return CacheValueCompressor::uncompress($value);
}
public static function buildName(string $salesChannelId): string
{
return 'payment-method-route-' . $salesChannelId;
}
private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): ?string
{
$parts = [
$this->generator->getCriteriaHash($criteria),
$this->generator->getSalesChannelContextHash($context),
$request->query->getBoolean('onlyAvailable', false),
];
$event = new PaymentMethodRouteCacheKeyEvent($parts, $request, $context, $criteria);
$this->dispatcher->dispatch($event);
if (!$event->shouldCache()) {
return null;
}
return self::buildName($context->getSalesChannelId()) . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
}
/**
* @return array<string>
*/
private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
{
$tags = array_merge(
$this->tracer->get(self::buildName($context->getSalesChannelId())),
[self::buildName($context->getSalesChannelId()), self::ALL_TAG]
);
$event = new PaymentMethodRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
$this->dispatcher->dispatch($event);
return array_unique(array_filter($event->getTags()));
}
}