CachedLandingPageRoute::extractIds() - Code Metrics - Inspection of "Merge branch 'next-29004/add-a-elasticsearch-mappi..." - shopware/platform - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — trunk ( 9dfcf5...f40966 )

by Christian

created 2023-07-13 08:38 UTC

CachedLandingPageRoute::extractIds() B

↳ Parent: Project

Complexity

Conditions	10
Paths	25

Size

Total Lines	52
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	28
nc	25
nop	1
dl	0
loc	52
rs	7.6666
c	0
b	0
f	0

How to fix Long Method Complexity

<?php declare(strict_types=1);

namespace Shopware\Core\Content\LandingPage\SalesChannel;

use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductBoxStruct;
use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductSliderStruct;
use Shopware\Core\Content\LandingPage\Event\LandingPageRouteCacheKeyEvent;
use Shopware\Core\Content\LandingPage\Event\LandingPageRouteCacheTagsEvent;
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\Field\Flag\RuleAreas;
use Shopware\Core\Framework\Log\Package;
use Shopware\Core\Framework\Util\Json;
use Shopware\Core\System\SalesChannel\SalesChannelContext;
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']])]
#[Package('content')]
class CachedLandingPageRoute extends AbstractLandingPageRoute
{
    /**
     * @internal
     *
     * @param AbstractCacheTracer<LandingPageRouteResponse> $tracer
     * @param array<string> $states
     */
    public function __construct(
        private readonly AbstractLandingPageRoute $decorated,
        private readonly CacheInterface $cache,
        private readonly EntityCacheKeyGenerator $generator,
        private readonly AbstractCacheTracer $tracer,
        private readonly EventDispatcherInterface $dispatcher,
        private readonly array $states
    ) {
    }

    public static function buildName(string $id): string
    {
        return 'landing-page-route-' . $id;
    }

    public function getDecorated(): AbstractLandingPageRoute
    {
        return $this->decorated;
    }

    #[Route(path: '/store-api/landing-page/{landingPageId}', name: 'store-api.landing-page.detail', methods: ['POST'])]
    public function load(string $landingPageId, Request $request, SalesChannelContext $context): LandingPageRouteResponse
    {
        if ($context->hasState(...$this->states)) {
            return $this->getDecorated()->load($landingPageId, $request, $context);
        }

        $key = $this->generateKey($landingPageId, $request, $context);

        if ($key === null) {
            return $this->getDecorated()->load($landingPageId, $request, $context);
        }

        $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $landingPageId) {
            $name = self::buildName($landingPageId);
            $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($landingPageId, $request, $context));

            $item->tag($this->generateTags($landingPageId, $response, $request, $context));

            return CacheValueCompressor::compress($response);
        });

        return CacheValueCompressor::uncompress($value);
    }

    private function generateKey(string $landingPageId, Request $request, SalesChannelContext $context): ?string
    {
        $parts = [...$request->query->all(), ...$request->request->all(), ...[$this->generator->getSalesChannelContextHash($context, [RuleAreas::LANDING_PAGE_AREA, RuleAreas::PRODUCT_AREA, RuleAreas::CATEGORY_AREA])]];

        $event = new LandingPageRouteCacheKeyEvent($landingPageId, $parts, $request, $context, null);
        $this->dispatcher->dispatch($event);

        if (!$event->shouldCache()) {
            return null;
        }

        return self::buildName($landingPageId) . '-' . md5(Json::encode($event->getParts()));
    }

    /**
     * @return array<string>
     */
    private function generateTags(string $landingPageId, LandingPageRouteResponse $response, Request $request, SalesChannelContext $context): array
    {
        $tags = array_merge(
            $this->tracer->get(self::buildName($landingPageId)),
            $this->extractIds($response),
            [self::buildName($landingPageId)]
        );

        $event = new LandingPageRouteCacheTagsEvent($landingPageId, $tags, $request, $response, $context, null);
        $this->dispatcher->dispatch($event);

        return array_unique(array_filter($event->getTags()));
    }

    /**
     * @return array<string>
     */
    private function extractIds(LandingPageRouteResponse $response): array
    {
        $page = $response->getLandingPage()->getCmsPage();

        if ($page === null) {
            return [];
        }

        $ids = [];
        $streamIds = [];

        $slots = $page->getElementsOfType('product-slider');
        /** @var CmsSlotEntity $slot */
        foreach ($slots as $slot) {
            $slider = $slot->getData();

            if (!$slider instanceof ProductSliderStruct) {
                continue;
            }

            if ($slider->getStreamId() !== null) {
                $streamIds[] = $slider->getStreamId();
            }

            if ($slider->getProducts() === null) {
                continue;
            }
            foreach ($slider->getProducts() as $product) {
                $ids[] = $product->getId();
                $ids[] = $product->getParentId();
            }
        }

        $slots = $page->getElementsOfType('product-box');
        /** @var CmsSlotEntity $slot */
        foreach ($slots as $slot) {
            $box = $slot->getData();

            if (!$box instanceof ProductBoxStruct) {
                continue;
            }
            if ($box->getProduct() === null) {
                continue;
            }

            $ids[] = $box->getProduct()->getId();
            $ids[] = $box->getProduct()->getParentId();
        }

        $ids = array_values(array_unique(array_filter($ids)));

        return [...array_map(EntityCacheKeyGenerator::buildProductTag(...), $ids), ...array_map(EntityCacheKeyGenerator::buildStreamTag(...), $streamIds), ...[EntityCacheKeyGenerator::buildCmsTag($page->getId())]];

    }
}


1			<?php declare(strict_types=1);
2
3			namespace Shopware\Core\Content\LandingPage\SalesChannel;
4
5			use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
6			use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductBoxStruct;
7			use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductSliderStruct;
8			use Shopware\Core\Content\LandingPage\Event\LandingPageRouteCacheKeyEvent;
9			use Shopware\Core\Content\LandingPage\Event\LandingPageRouteCacheTagsEvent;
10			use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
11			use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
12			use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
13			use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\RuleAreas;
14			use Shopware\Core\Framework\Log\Package;
15			use Shopware\Core\Framework\Util\Json;
16			use Shopware\Core\System\SalesChannel\SalesChannelContext;
17			use Symfony\Component\HttpFoundation\Request;
18			use Symfony\Component\Routing\Annotation\Route;
19			use Symfony\Contracts\Cache\CacheInterface;
20			use Symfony\Contracts\Cache\ItemInterface;
21			use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
22
23			#[Route(defaults: ['_routeScope' => ['store-api']])]
24			#[Package('content')]
25			class CachedLandingPageRoute extends AbstractLandingPageRoute
26			{
27			/**
28			* @internal
29			*
30			* @param AbstractCacheTracer<LandingPageRouteResponse> $tracer
31			* @param array<string> $states
32			*/
33			public function __construct(
34			private readonly AbstractLandingPageRoute $decorated,
35			private readonly CacheInterface $cache,
36			private readonly EntityCacheKeyGenerator $generator,
37			private readonly AbstractCacheTracer $tracer,
38			private readonly EventDispatcherInterface $dispatcher,
39			private readonly array $states
40			) {
41			}
42
43			public static function buildName(string $id): string
44			{
45			return 'landing-page-route-' . $id;
46			}
47
48			public function getDecorated(): AbstractLandingPageRoute
49			{
50			return $this->decorated;
51			}
52
53			#[Route(path: '/store-api/landing-page/{landingPageId}', name: 'store-api.landing-page.detail', methods: ['POST'])]
54			public function load(string $landingPageId, Request $request, SalesChannelContext $context): LandingPageRouteResponse
55			{
56			if ($context->hasState(...$this->states)) {
57			return $this->getDecorated()->load($landingPageId, $request, $context);
58			}
59
60			$key = $this->generateKey($landingPageId, $request, $context);
61
62			if ($key === null) {
63			return $this->getDecorated()->load($landingPageId, $request, $context);
64			}
65
66			$value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $landingPageId) {
67			$name = self::buildName($landingPageId);
68			$response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($landingPageId, $request, $context));
69
70			$item->tag($this->generateTags($landingPageId, $response, $request, $context));
71
72			return CacheValueCompressor::compress($response);
73			});
74
75			return CacheValueCompressor::uncompress($value);
76			}
77
78			private function generateKey(string $landingPageId, Request $request, SalesChannelContext $context): ?string
79			{
80			$parts = [...$request->query->all(), ...$request->request->all(), ...[$this->generator->getSalesChannelContextHash($context, [RuleAreas::LANDING_PAGE_AREA, RuleAreas::PRODUCT_AREA, RuleAreas::CATEGORY_AREA])]];
81
82			$event = new LandingPageRouteCacheKeyEvent($landingPageId, $parts, $request, $context, null);
83			$this->dispatcher->dispatch($event);
84
85			if (!$event->shouldCache()) {
86			return null;
87			}
88
89			return self::buildName($landingPageId) . '-' . md5(Json::encode($event->getParts()));
90			}
91
92			/**
93			* @return array<string>
94			*/
95			private function generateTags(string $landingPageId, LandingPageRouteResponse $response, Request $request, SalesChannelContext $context): array
96			{
97			$tags = array_merge(
98			$this->tracer->get(self::buildName($landingPageId)),
99			$this->extractIds($response),
100			[self::buildName($landingPageId)]
101			);
102
103			$event = new LandingPageRouteCacheTagsEvent($landingPageId, $tags, $request, $response, $context, null);
104			$this->dispatcher->dispatch($event);
105
106			return array_unique(array_filter($event->getTags()));
107			}
108
109			/**
110			* @return array<string>
111			*/
112			private function extractIds(LandingPageRouteResponse $response): array
113			{
114			$page = $response->getLandingPage()->getCmsPage();
115
116			if ($page === null) {
117			return [];
118			}
119
120			$ids = [];
121			$streamIds = [];
122
123			$slots = $page->getElementsOfType('product-slider');
124			/** @var CmsSlotEntity $slot */
125			foreach ($slots as $slot) {
126			$slider = $slot->getData();
127
128			if (!$slider instanceof ProductSliderStruct) {
129			continue;
130			}
131
132			if ($slider->getStreamId() !== null) {
133			$streamIds[] = $slider->getStreamId();
134			}
135
136			if ($slider->getProducts() === null) {
137			continue;
138			}
139			foreach ($slider->getProducts() as $product) {
140			$ids[] = $product->getId();
141			$ids[] = $product->getParentId();
142			}
143			}
144
145			$slots = $page->getElementsOfType('product-box');
146			/** @var CmsSlotEntity $slot */
147			foreach ($slots as $slot) {
148			$box = $slot->getData();
149
150			if (!$box instanceof ProductBoxStruct) {
151			continue;
152			}
153			if ($box->getProduct() === null) {
154			continue;
155			}
156
157			$ids[] = $box->getProduct()->getId();
158			$ids[] = $box->getProduct()->getParentId();
159			}
160
161			$ids = array_values(array_unique(array_filter($ids)));
162
163			return [...array_map(EntityCacheKeyGenerator::buildProductTag(...), $ids), ...array_map(EntityCacheKeyGenerator::buildStreamTag(...), $streamIds), ...[EntityCacheKeyGenerator::buildCmsTag($page->getId())]];
			0 ignored issues – show Bug introduced 2023-02-04 08:10 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected ')' on line 163 at column 73 Loading history...
164			}
165			}
166

shopware / platform

Push — trunk ( 9dfcf5...f40966 )

CachedLandingPageRoute::extractIds() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like