ENGCOM-3722: Re-enable PriceBox block caching #19897

Author: p-bystritsky

app/code/Magento/Msrp/Pricing/Price/MsrpPrice.php

@@ -93,6 +93,8 @@ public function canApplyMsrp(Product $product)
     }
 
     /**
+     * Check if is minimal price is less than the msrp.
+     *
      * @param Product $product
      * @return bool|float
      */

app/code/Magento/Msrp/Pricing/Render/PriceBox.php

@@ -59,4 +59,16 @@ public function getMsrpPriceCalculator(): MsrpPriceCalculatorInterface
     {
         return $this->msrpPriceCalculator;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getCacheKey()
+    {
+        return sprintf(
+            '%s-%s',
+            parent::getCacheKey(),
+            $this->getZone()
+        );
+    }
 }

lib/internal/Magento/Framework/Pricing/Render/PriceBox.php

@@ -8,8 +8,8 @@
 
 use Magento\Framework\DataObject\IdentityInterface;
 use Magento\Framework\Pricing\Amount\AmountInterface;
-use Magento\Framework\Pricing\SaleableInterface;
 use Magento\Framework\Pricing\Price\PriceInterface;
+use Magento\Framework\Pricing\SaleableInterface;
 use Magento\Framework\View\Element\Template;
 
 /**
@@ -21,7 +21,7 @@
 class PriceBox extends Template implements PriceBoxRenderInterface, IdentityInterface
 {
     /** Default block lifetime */
-    const DEFAULT_LIFETIME = 3600;
+    const DEFAULT_LIFETIME = 86400;
 
     /**
      * @var SaleableInterface
@@ -39,11 +39,11 @@ class PriceBox extends Template implements PriceBoxRenderInterface, IdentityInte
     protected $rendererPool;
 
     /**
-     * @param Template\Context  $context
+     * @param Template\Context $context
      * @param SaleableInterface $saleableItem
-     * @param PriceInterface    $price
-     * @param RendererPool      $rendererPool
-     * @param array             $data
+     * @param PriceInterface $price
+     * @param RendererPool $rendererPool
+     * @param array $data
      */
     public function __construct(
         Template\Context $context,
@@ -59,7 +59,7 @@ public function __construct(
     }
 
     /**
-     * @return string
+     * @inheritdoc
      */
     protected function _toHtml()
     {
@@ -70,35 +70,31 @@ protected function _toHtml()
     }
 
     /**
-     * Get Key for caching block content
-     *
-     * @return string
+     * @inheritdoc
      */
     public function getCacheKey()
     {
         return parent::getCacheKey() . '-' . $this->getPriceId() . '-' . $this->getPrice()->getPriceCode();
     }
 
     /**
-     * Get block cache life time
-     *
-     * @return int
+     * @inheritdoc
      */
     protected function getCacheLifetime()
     {
-        return parent::hasCacheLifetime() ? parent::getCacheLifetime() : null;
+        return parent::hasCacheLifetime() ? parent::getCacheLifetime() : self::DEFAULT_LIFETIME;
     }
-    
+
     /**
-     * @return SaleableInterface
+     * @inheritdoc
      */
     public function getSaleableItem()
     {
         return $this->saleableItem;
     }
 
     /**
-     * @return PriceInterface
+     * @inheritdoc
      */
     public function getPrice()
     {
@@ -136,9 +132,7 @@ public function getPriceType($priceCode)
     }
 
     /**
-     * @param AmountInterface $amount
-     * @param array $arguments
-     * @return string
+     * @inheritdoc
      */
     public function renderAmount(AmountInterface $amount, array $arguments = [])
     {
@@ -149,6 +143,8 @@ public function renderAmount(AmountInterface $amount, array $arguments = [])
     }
 
     /**
+     * Get amount render.
+     *
      * @param AmountInterface $amount
      * @param array $arguments
      * @return AmountRenderInterface
@@ -164,6 +160,8 @@ protected function getAmountRender(AmountInterface $amount, array $arguments = [
     }
 
     /**
+     * Get renderer pool.
+     *
      * @return RendererPool
      */
     public function getRendererPool()
@@ -172,9 +170,7 @@ public function getRendererPool()
     }
 
     /**
-     * Return unique ID(s) for each object in system
-     *
-     * @return array
+     * @inheritdoc
      */
     public function getIdentities()
     {

lib/internal/Magento/Framework/Pricing/Test/Unit/Render/PriceBoxTest.php

@@ -248,17 +248,4 @@ public function testGetRendererPool()
     {
         $this->assertEquals($this->rendererPool, $this->model->getRendererPool());
     }
-
-    /**
-     * This tests ensures that protected method getCacheLifetime() returns a null value when cacheLifeTime is not
-     * explicitly set in the parent block
-     */
-    public function testCacheLifetime()
-    {
-        $reflectionClass = new \ReflectionClass(get_class($this->model));
-        $methodReflection = $reflectionClass->getMethod('getCacheLifetime');
-        $methodReflection->setAccessible(true);
-        $cacheLifeTime = $methodReflection->invoke($this->model);
-        $this->assertNull($cacheLifeTime, 'Expected null cache lifetime');
-    }
 }