custom/plugins/NetzpBlog6/src/Controller/StoreApi/BlogListing/CachedBlogListingRoute.php line 109

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace NetzpBlog6\Controller\StoreApi\BlogListing;
  5. use OpenApi\Annotations as OA;
  6. use Shopware\Core\Framework\Routing\Annotation\Entity;
  7. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  8. use Shopware\Core\Framework\Routing\Annotation\Since;
  9. use Symfony\Component\Routing\Annotation\Route;
  10. use Psr\Log\LoggerInterface;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  12. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  13. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  14. use Shopware\Core\Framework\Adapter\Cache\CacheCompressor;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  16. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  17. use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
  19. /**
  20.  * @RouteScope(scopes={"store-api"})
  21.  */
  22. class CachedBlogListingRoute extends AbstractBlogListingRoute
  23. {
  24.     private AbstractBlogListingRoute $decorated;
  26.     private TagAwareAdapterInterface $cache;
  28.     private EntityCacheKeyGenerator $generator;
  30.     private AbstractCacheTracer $tracer;
  32.     private array $states;
  34.     private LoggerInterface $logger;
  36.     public function __construct(
  37.         AbstractBlogListingRoute $decorated,
  38.         TagAwareAdapterInterface $cache,
  39.         EntityCacheKeyGenerator $generator,
  40.         AbstractCacheTracer $tracer,
  41.         LoggerInterface $logger
  42.     ) {
  43.         $this->decorated = $decorated;
  44.         $this->cache = $cache;
  45.         $this->generator = $generator;
  46.         $this->tracer = $tracer;
  47.         $this->states = [];
  48.         $this->logger = $logger;
  49.     }
  51.     public function getDecorated(): AbstractBlogListingRoute
  52.     {
  53.         return $this->decorated;
  54.     }
  56.     /**
  57.      * @Entity("s_plugin_netzp_blog")
  58.      * @OA\Post(
  59.      *      path="/bloglisting",
  60.      *      summary="This route can be used to load a blog listing",
  61.      *      operationId="readNetzpBlogListing",
  62.      *      tags={"Store API", "NetzpBlog"},
  63.      *      @OA\Parameter(name="Api-Basic-Parameters"),
  64.      *      @OA\Response(
  65.      *          response="200",
  66.      *          description="",
  67.      *          @OA\JsonContent(type="object",
  68.      *              @OA\Property(
  69.      *                  property="total",
  70.      *                  type="integer",
  71.      *                  description="Total amount"
  72.      *              ),
  73.      *              @OA\Property(
  74.      *                  property="aggregations",
  75.      *                  type="object",
  76.      *                  description="aggregation result"
  77.      *              )
  78.      *          )
  79.      *     )
  80.      * )
  81.      * @Route("/store-api/bloglisting/{navigationId?}", name="store-api.s_plugin_netzp_blog_listing.load", methods={"GET", "POST"})
  82.      */
  83.     public function load($navigationId, Criteria $criteria, SalesChannelContext $context,
  84.         ?string $categoryId, ?string $authorId, ?array $tags, ?string $sortOrder): BlogListingRouteResponse
  85.     {
  86.         // The context is provided with a state where the route cannot be cached
  87.         if ($context->hasState(...$this->states)) {
  88.             return $this->getDecorated()->load($navigationId, $criteria, $context, $categoryId, $authorId, $tags, $sortOrder);
  89.         }
  91.         // Fetch item from the cache pool
  92.         $item = $this->cache->getItem(
  93.             $this->generateKey($navigationId, $context, $criteria)
  94.         );
  96.         try {
  97.             if ($item->isHit() && $item->get()) {
  98.                 // Use cache compressor to uncompress the cache value
  99.                 return CacheCompressor::uncompress($item);
  100.             }
  101.         } catch (\Throwable $e) {
  102.             // Something went wrong when uncompress the cache item - we log the error and continue to overwrite the invalid cache item
  103.             $this->logger->error($e->getMessage());
  104.         }
  106.         $name = self::buildName($navigationId);
  107.         // start tracing of nested cache tags and system config keys
  108.         $response = $this->tracer->trace($name, function () use ($navigationId, $criteria, $context, $categoryId, $authorId, $tags, $sortOrder) {
  109.             return $this->getDecorated()->load($navigationId, $criteria, $context, $categoryId, $authorId, $tags, $sortOrder);
  110.         });
  112.         // compress cache content to reduce cache size
  113.         $item = CacheCompressor::compress($item, $response);
  115.         $item->tag(array_merge(
  116.         // get traced tags and configs
  117.             $this->tracer->get(self::buildName($navigationId)),
  118.             [self::buildName($navigationId), self::buildName('')]
  119.         ));
  121.         $this->cache->save($item);
  123.         return $response;
  124.     }
  126.     public static function buildName($navigationId): string
  127.     {
  128.         return 'blog-listing-route-' . $navigationId;
  129.     }
  131.     private function generateKey($navigationId, SalesChannelContext $context, Criteria $criteria): string
  132.     {
  133.         $parts = [
  134.             self::buildName($navigationId),
  135.             // generate a hash for the route criteria
  136.             $this->generator->getCriteriaHash($criteria),
  137.             // generate a hash for the current context
  138.             $this->generator->getSalesChannelContextHash($context),
  139.         ];
  141.         return md5(JsonFieldSerializer::encodeJson($parts));
  142.     }
  143. }