OXDEV-9930 Cache chain

Author: AshrafOxid

CHANGELOG-2.x.md

@@ -5,6 +5,7 @@
 ### Added
 - Template Filter to sanitize HTML content
 - PHP v8.5 support
+- Cache template chains to improve rendering performance
 
 ### Changed
 - Extension include_content uses HTML sanitizer

src/Resolver/TemplateChain/TemplateChainResolver.php

@@ -14,6 +14,7 @@
 class TemplateChainResolver implements TemplateChainResolverInterface
 {
     private array $lastChildCache = [];
+    private array $parentCache = [];
 
     public function __construct(
         private TemplateChainBuilderInterface $templateChainBuilder,
@@ -23,11 +24,15 @@ public function __construct(
 
     public function getParent(string $templateName): string
     {
-        $templateType = $this->templateTypeFactory->createFromTemplateName($templateName);
-        return $this->templateChainBuilder
-            ->getChain($templateType)
-            ->getParent($templateType)
-            ->getFullyQualifiedName();
+        if (!isset($this->parentCache[$templateName])) {
+            $templateType = $this->templateTypeFactory->createFromTemplateName($templateName);
+            $this->parentCache[$templateName] = $this->templateChainBuilder
+                ->getChain($templateType)
+                ->getParent($templateType)
+                ->getFullyQualifiedName();
+        }
+
+        return $this->parentCache[$templateName];
     }
 
     public function getLastChild(string $templateName): string

src/Resolver/TemplateChain/TemplateChainSorter.php

@@ -18,6 +18,8 @@
 
 class TemplateChainSorter implements TemplateChainSorterInterface
 {
+    private array $chainCache = [];
+
     public function __construct(
         private SortingConfigurationValidatorInterface $sortingConfigurationValidator,
         private ShopConfigurationDaoInterface $shopConfigurationDao,
@@ -28,11 +30,15 @@ public function __construct(
 
     public function sort(TemplateChain $unsortedChain, TemplateTypeInterface $extendedTemplate): TemplateChain
     {
-        $sortingConfiguration = $this->shopConfigurationDao
-            ->get($this->context->getCurrentShopId())
-            ->getModuleTemplateExtensionChain();
+        $shopId = $this->context->getCurrentShopId();
+
+        if (!isset($this->chainCache[$shopId])) {
+            $this->chainCache[$shopId] = $this->shopConfigurationDao
+                ->get($shopId)
+                ->getModuleTemplateExtensionChain();
+        }
 
-        return $this->getSortedChain($unsortedChain, $sortingConfiguration, $extendedTemplate);
+        return $this->getSortedChain($unsortedChain, $this->chainCache[$shopId], $extendedTemplate);
     }
 
     private function getSortedChain(

tests/Unit/Resolver/TemplateChain/TemplateChainResolverTest.php

@@ -18,6 +18,39 @@
 
 final class TemplateChainResolverTest extends TestCase
 {
+    public function testGetParentWithMultipleCallsWillUseCachedResult(): void
+    {
+        $templateName = 'widget/header.html.twig';
+
+        $templateTypeMock = $this->createMock(TemplateTypeInterface::class);
+        $parentMock = $this->createConfiguredMock(TemplateTypeInterface::class, [
+            'getFullyQualifiedName' => '@my_module/widget/header.html.twig'
+        ]);
+        $templateChainMock = $this->createConfiguredMock(TemplateChain::class, [
+            'getParent' => $parentMock
+        ]);
+
+        $templateTypeFactoryMock = $this->createMock(TemplateTypeFactoryInterface::class);
+        $templateTypeFactoryMock
+            ->expects($this->once())
+            ->method('createFromTemplateName')
+            ->with($templateName)
+            ->willReturn($templateTypeMock);
+
+        $templateChainBuilderMock = $this->createMock(TemplateChainBuilderInterface::class);
+        $templateChainBuilderMock
+            ->expects($this->once())
+            ->method('getChain')
+            ->with($templateTypeMock)
+            ->willReturn($templateChainMock);
+
+        $templateChainResolver = new TemplateChainResolver($templateChainBuilderMock, $templateTypeFactoryMock);
+
+        $templateChainResolver->getParent($templateName);
+        $templateChainResolver->getParent($templateName);
+        $templateChainResolver->getParent($templateName);
+    }
+
     public function testGetLastChildWithMultipleCallsWillUseCachedResult(): void
     {
         $templateName = 'widget/header.html.twig';

tests/Unit/Resolver/TemplateChain/TemplateChainSorterTest.php

@@ -162,6 +162,42 @@ public function testSortWithADuplicatedModuleIdInConfigurationWillCallLogger():
         $this->logger->error(Argument::type('string'))->shouldHaveBeenCalled();
     }
 
+    public function testSortWithMultipleCallsWillUseCachedShopConfiguration(): void
+    {
+        $shopId = 1;
+        $templateModule1 = new ModuleTemplateType('template1', 'module1');
+        $chain = new TemplateChain();
+        $chain->append($templateModule1);
+
+        $moduleTemplateExtensionsChain = new ModuleTemplateExtensionChain([]);
+        $shopConfiguration = $this->prophesize(ShopConfiguration::class);
+        $shopConfiguration->getModuleTemplateExtensionChain()->willReturn($moduleTemplateExtensionsChain);
+
+        $shopConfigurationDao = $this->prophesize(ShopConfigurationDaoInterface::class);
+        $shopConfigurationDao->get($shopId)->willReturn($shopConfiguration)->shouldBeCalledOnce();
+
+        $context = $this->prophesize(ContextInterface::class);
+        $context->getCurrentShopId()->willReturn($shopId);
+
+        $this->sortingConfigurationValidator = $this->prophesize(SortingConfigurationValidatorInterface::class);
+        $this->logger = $this->prophesize(LoggerInterface::class);
+
+        $this->chainSorter = new TemplateChainSorter(
+            $this->sortingConfigurationValidator->reveal(),
+            $shopConfigurationDao->reveal(),
+            $context->reveal(),
+            $this->logger->reveal(),
+        );
+
+        $chain1 = new TemplateChain();
+        $chain1->append($templateModule1);
+        $this->chainSorter->sort($chain1, $templateModule1);
+
+        $chain2 = new TemplateChain();
+        $chain2->append($templateModule1);
+        $this->chainSorter->sort($chain2, $templateModule1);
+    }
+
     private function prepareChainSortersConfiguration(string $templateName, array $loadOrder): void
     {
         $shopId = 1;