MC-31729: Non-cacheable block added to default handle makes every page non-cacheable

viktorpetryk · viktorpetryk · commit ad9f69b2e517 · 2020-03-04T11:21:17.000+02:00
diff --git a/app/code/Magento/Catalog/Model/Layout/DepersonalizePlugin.php b/app/code/Magento/Catalog/Model/Layout/DepersonalizePlugin.php
@@ -41,7 +41,7 @@ public function __construct(
     }
 
     /**
-     * Changes sensitive customer data if the depersonalization is needed.
+     * Change sensitive customer data if the depersonalization is needed.
      *
      * @param LayoutInterface $subject
      * @return void
diff --git a/app/code/Magento/Catalog/Test/Unit/Model/Layout/DepersonalizePluginTest.php b/app/code/Magento/Catalog/Test/Unit/Model/Layout/DepersonalizePluginTest.php
@@ -59,7 +59,7 @@ protected function setUp()
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is needed.
+     * Test afterGenerateElements method when depersonalization is needed.
      *
      * @return void
      */
@@ -71,7 +71,7 @@ public function testAfterGenerateElements(): void
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is not needed.
+     * Test afterGenerateElements method when depersonalization is not needed.
      *
      * @return void
      */
diff --git a/app/code/Magento/Checkout/Model/Layout/DepersonalizePlugin.php b/app/code/Magento/Checkout/Model/Layout/DepersonalizePlugin.php
@@ -42,7 +42,7 @@ public function __construct(
     }
 
     /**
-     * Changes sensitive customer data if the depersonalization is needed.
+     * Change sensitive customer data if the depersonalization is needed.
      *
      * @param LayoutInterface $subject
      * @return void
diff --git a/app/code/Magento/Checkout/Test/Unit/Model/Layout/DepersonalizePluginTest.php b/app/code/Magento/Checkout/Test/Unit/Model/Layout/DepersonalizePluginTest.php
@@ -59,7 +59,7 @@ protected function setUp()
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is needed.
+     * Test afterGenerateElements method when depersonalization is needed.
      *
      * @return void
      */
@@ -75,7 +75,7 @@ public function testAfterGenerateElements(): void
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is not needed.
+     * Test afterGenerateElements method when depersonalization is not needed.
      *
      * @return void
      */
diff --git a/app/code/Magento/Customer/Model/Layout/DepersonalizePlugin.php b/app/code/Magento/Customer/Model/Layout/DepersonalizePlugin.php
@@ -79,7 +79,7 @@ public function __construct(
     }
 
     /**
-     * Retrieves sensitive customer data.
+     * Retrieve sensitive customer data.
      *
      * @param LayoutInterface $subject
      * @return void
@@ -93,7 +93,7 @@ public function beforeGenerateXml(LayoutInterface $subject)
     }
 
     /**
-     * Changes sensitive customer data if the depersonalization is needed.
+     * Change sensitive customer data if the depersonalization is needed.
      *
      * @param LayoutInterface $subject
      * @return void
diff --git a/app/code/Magento/Customer/Test/Unit/Model/Layout/DepersonalizePluginTest.php b/app/code/Magento/Customer/Test/Unit/Model/Layout/DepersonalizePluginTest.php
@@ -105,7 +105,7 @@ protected function setUp()
     }
 
     /**
-     * Tests beforeGenerateXml method when depersonalization is needed.
+     * Test beforeGenerateXml method when depersonalization is needed.
      *
      * @return void
      */
@@ -121,7 +121,7 @@ public function testBeforeGenerateXml(): void
     }
 
     /**
-     * Tests beforeGenerateXml method when depersonalization is not needed.
+     * Test beforeGenerateXml method when depersonalization is not needed.
      *
      * @return void
      */
@@ -136,7 +136,7 @@ public function testBeforeGenerateXmlNoDepersonalize(): void
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is needed.
+     * Test afterGenerateElements method when depersonalization is needed.
      *
      * @return void
      */
@@ -168,7 +168,7 @@ public function testAfterGenerateElements(): void
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is not needed.
+     * Test afterGenerateElements method when depersonalization is not needed.
      *
      * @return void
      */
diff --git a/app/code/Magento/PageCache/Model/Layout/DepersonalizePlugin.php b/app/code/Magento/PageCache/Model/Layout/DepersonalizePlugin.php
@@ -50,7 +50,7 @@ public function __construct(
     }
 
     /**
-     * Changes sensitive customer data if the depersonalization is needed.
+     * Change sensitive customer data if the depersonalization is needed.
      *
      * @param LayoutInterface $subject
      * @return void
diff --git a/app/code/Magento/PageCache/Model/Layout/LayoutPlugin.php b/app/code/Magento/PageCache/Model/Layout/LayoutPlugin.php
@@ -10,11 +10,11 @@
 use Magento\Framework\App\MaintenanceMode;
 use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\DataObject\IdentityInterface;
-use Magento\Framework\View\LayoutInterface;
+use Magento\Framework\View\Layout;
 use Magento\PageCache\Model\Config;
 
 /**
- * Appends cacheable pages response headers.
+ * Append cacheable pages response headers.
  */
 class LayoutPlugin
 {
@@ -49,28 +49,28 @@ public function __construct(
     }
 
     /**
-     * Sets appropriate Cache-Control headers.
+     * Set appropriate Cache-Control headers.
      *
      * We have to set public headers in order to tell Varnish and Builtin app that page should be cached
      *
-     * @param LayoutInterface $subject
+     * @param Layout $subject
      * @return void
      */
-    public function afterGenerateElements(LayoutInterface $subject)
+    public function afterGenerateElements(Layout $subject)
     {
         if ($subject->isCacheable() && !$this->maintenanceMode->isOn() && $this->config->isEnabled()) {
             $this->response->setPublicHeaders($this->config->getTtl());
         }
     }
 
     /**
-     * Retrieves all identities from blocks for further cache invalidation.
+     * Retrieve all identities from blocks for further cache invalidation.
      *
-     * @param LayoutInterface $subject
+     * @param Layout $subject
      * @param mixed $result
      * @return mixed
      */
-    public function afterGetOutput(LayoutInterface $subject, $result)
+    public function afterGetOutput(Layout $subject, $result)
     {
         if ($subject->isCacheable() && $this->config->isEnabled()) {
             $tags = [[]];
diff --git a/app/code/Magento/PageCache/Test/Unit/Model/Layout/DepersonalizePluginTest.php b/app/code/Magento/PageCache/Test/Unit/Model/Layout/DepersonalizePluginTest.php
@@ -69,7 +69,7 @@ protected function setUp()
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is needed.
+     * Test afterGenerateElements method when depersonalization is needed.
      *
      * @return void
      */
@@ -85,7 +85,7 @@ public function testAfterGenerateElements(): void
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is not needed.
+     * Test afterGenerateElements method when depersonalization is not needed.
      *
      * @return void
      */
diff --git a/app/code/Magento/PageCache/Test/Unit/Model/Layout/LayoutPluginTest.php b/app/code/Magento/PageCache/Test/Unit/Model/Layout/LayoutPluginTest.php
@@ -12,7 +12,7 @@
 use Magento\Framework\App\Response\Http;
 use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
-use Magento\Framework\View\LayoutInterface;
+use Magento\Framework\View\Layout;
 use Magento\PageCache\Model\Config;
 use Magento\PageCache\Model\Layout\LayoutPlugin;
 use Magento\PageCache\Test\Unit\Block\Controller\StubBlock;
@@ -35,7 +35,7 @@ class LayoutPluginTest extends TestCase
     private $responseMock;
 
     /**
-     * @var LayoutInterface|MockObject
+     * @var Layout|MockObject
      */
     private $layoutMock;
 
@@ -54,7 +54,7 @@ class LayoutPluginTest extends TestCase
      */
     protected function setUp()
     {
-        $this->layoutMock = $this->getMockForAbstractClass(LayoutInterface::class);
+        $this->layoutMock = $this->createPartialMock(Layout::class, ['isCacheable', 'getAllBlocks']);
         $this->responseMock = $this->createMock(Http::class);
         $this->configMock = $this->createMock(Config::class);
         $this->maintenanceModeMock = $this->createMock(MaintenanceMode::class);
diff --git a/app/code/Magento/Persistent/Model/Layout/DepersonalizePlugin.php b/app/code/Magento/Persistent/Model/Layout/DepersonalizePlugin.php
@@ -39,7 +39,7 @@ public function __construct(
     }
 
     /**
-     * Changes sensitive customer data if the depersonalization is needed.
+     * Change sensitive customer data if the depersonalization is needed.
      *
      * @param LayoutInterface $subject
      * @return void
diff --git a/app/code/Magento/Persistent/Test/Unit/Model/Layout/DepersonalizePluginTest.php b/app/code/Magento/Persistent/Test/Unit/Model/Layout/DepersonalizePluginTest.php
@@ -59,7 +59,7 @@ protected function setUp()
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is needed.
+     * Test afterGenerateElements method when depersonalization is needed.
      *
      * @return void
      */
@@ -72,7 +72,7 @@ public function testAfterGenerateElements(): void
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is not needed.
+     * Test afterGenerateElements method when depersonalization is not needed.
      *
      * @return void
      */
diff --git a/app/code/Magento/Tax/Model/Layout/DepersonalizePlugin.php b/app/code/Magento/Tax/Model/Layout/DepersonalizePlugin.php
@@ -55,7 +55,7 @@ public function __construct(
     }
 
     /**
-     * Resolves sensitive customer data if the depersonalization is needed.
+     * Resolve sensitive customer data if the depersonalization is needed.
      *
      * @param LayoutInterface $subject
      * @return void
@@ -70,7 +70,7 @@ public function beforeGenerateXml(LayoutInterface $subject)
     }
 
     /**
-     * Changes sensitive customer data if the depersonalization is needed.
+     * Change sensitive customer data if the depersonalization is needed.
      *
      * @param LayoutInterface $subject
      * @return void
diff --git a/app/code/Magento/Tax/Test/Unit/Model/Layout/DepersonalizePluginTest.php b/app/code/Magento/Tax/Test/Unit/Model/Layout/DepersonalizePluginTest.php
@@ -69,7 +69,7 @@ protected function setUp()
     }
 
     /**
-     * Tests beforeGenerateXml method when depersonalization is needed.
+     * Test beforeGenerateXml method when depersonalization is needed.
      *
      * @return void
      */
@@ -83,7 +83,7 @@ public function testBeforeGenerateXml(): void
     }
 
     /**
-     * Tests beforeGenerateXml method when depersonalization is not needed.
+     * Test beforeGenerateXml method when depersonalization is not needed.
      *
      * @return void
      */
@@ -97,7 +97,7 @@ public function testBeforeGenerateXmlNoDepersonalize(): void
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is needed.
+     * Test afterGenerateElements method when depersonalization is needed.
      *
      * @return void
      */
@@ -111,7 +111,7 @@ public function testAfterGenerateElements(): void
     }
 
     /**
-     * Tests afterGenerateElements method when depersonalization is not needed.
+     * Test afterGenerateElements method when depersonalization is not needed.
      *
      * @return void
      */
@@ -125,7 +125,7 @@ public function testAfterGenerateElementsNoDepersonalize(): void
     }
 
     /**
-     * Tests beforeGenerateXml and afterGenerateElements methods.
+     * Test beforeGenerateXml and afterGenerateElements methods.
      *
      * @return void
      */
diff --git a/lib/internal/Magento/Framework/View/Layout.php b/lib/internal/Magento/Framework/View/Layout.php
@@ -1103,7 +1103,7 @@ protected function _prepareMessageGroup($messageGroups)
     }
 
     /**
-     * Checks existed non-cacheable layout elements.
+     * Check existed non-cacheable layout elements.
      *
      * @return bool
      */
diff --git a/lib/internal/Magento/Framework/View/Test/Unit/LayoutTest.php b/lib/internal/Magento/Framework/View/Test/Unit/LayoutTest.php
@@ -351,7 +351,10 @@ public function testGetChildBlock(): void
         );
     }
 
-    public function testGetChildNonExistBlock()
+    /**
+     * @return void
+     */
+    public function testGetChildNonExistBlock(): void
     {
         $this->structureMock->expects($this->once())
             ->method('getChildId')

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function __construct(`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`44`		`- * Changes sensitive customer data if the depersonalization is needed.`
	`44`	`+ * Change sensitive customer data if the depersonalization is needed.`
`45`	`45`	`*`
`46`	`46`	`* @param LayoutInterface $subject`
`47`	`47`	`* @return void`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ protected function setUp()`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`/**`
`62`		`- * Tests afterGenerateElements method when depersonalization is needed.`
	`62`	`+ * Test afterGenerateElements method when depersonalization is needed.`
`63`	`63`	`*`
`64`	`64`	`* @return void`
`65`	`65`	`*/`
`@@ -71,7 +71,7 @@ public function testAfterGenerateElements(): void`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`/**`
`74`		`- * Tests afterGenerateElements method when depersonalization is not needed.`
	`74`	`+ * Test afterGenerateElements method when depersonalization is not needed.`
`75`	`75`	`*`
`76`	`76`	`* @return void`
`77`	`77`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function __construct(`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * Changes sensitive customer data if the depersonalization is needed.`
	`45`	`+ * Change sensitive customer data if the depersonalization is needed.`
`46`	`46`	`*`
`47`	`47`	`* @param LayoutInterface $subject`
`48`	`48`	`* @return void`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public function __construct(`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`/**`
`82`		`- * Retrieves sensitive customer data.`
	`82`	`+ * Retrieve sensitive customer data.`
`83`	`83`	`*`
`84`	`84`	`* @param LayoutInterface $subject`
`85`	`85`	`* @return void`
`@@ -93,7 +93,7 @@ public function beforeGenerateXml(LayoutInterface $subject)`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`/**`
`96`		`- * Changes sensitive customer data if the depersonalization is needed.`
	`96`	`+ * Change sensitive customer data if the depersonalization is needed.`
`97`	`97`	`*`
`98`	`98`	`* @param LayoutInterface $subject`
`99`	`99`	`* @return void`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ protected function setUp()`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`/**`
`108`		`- * Tests beforeGenerateXml method when depersonalization is needed.`
	`108`	`+ * Test beforeGenerateXml method when depersonalization is needed.`
`109`	`109`	`*`
`110`	`110`	`* @return void`
`111`	`111`	`*/`
`@@ -121,7 +121,7 @@ public function testBeforeGenerateXml(): void`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`/**`
`124`		`- * Tests beforeGenerateXml method when depersonalization is not needed.`
	`124`	`+ * Test beforeGenerateXml method when depersonalization is not needed.`
`125`	`125`	`*`
`126`	`126`	`* @return void`
`127`	`127`	`*/`
`@@ -136,7 +136,7 @@ public function testBeforeGenerateXmlNoDepersonalize(): void`
`136`	`136`	`}`
`137`	`137`
`138`	`138`	`/**`
`139`		`- * Tests afterGenerateElements method when depersonalization is needed.`
	`139`	`+ * Test afterGenerateElements method when depersonalization is needed.`
`140`	`140`	`*`
`141`	`141`	`* @return void`
`142`	`142`	`*/`
`@@ -168,7 +168,7 @@ public function testAfterGenerateElements(): void`
`168`	`168`	`}`
`169`	`169`
`170`	`170`	`/**`
`171`		`- * Tests afterGenerateElements method when depersonalization is not needed.`
	`171`	`+ * Test afterGenerateElements method when depersonalization is not needed.`
`172`	`172`	`*`
`173`	`173`	`* @return void`
`174`	`174`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public function __construct(`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`/**`
`53`		`- * Changes sensitive customer data if the depersonalization is needed.`
	`53`	`+ * Change sensitive customer data if the depersonalization is needed.`
`54`	`54`	`*`
`55`	`55`	`* @param LayoutInterface $subject`
`56`	`56`	`* @return void`
Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,11 @@`
`10`	`10`	`use Magento\Framework\App\MaintenanceMode;`
`11`	`11`	`use Magento\Framework\App\ResponseInterface;`
`12`	`12`	`use Magento\Framework\DataObject\IdentityInterface;`
`13`		`-use Magento\Framework\View\LayoutInterface;`
	`13`	`+use Magento\Framework\View\Layout;`
`14`	`14`	`use Magento\PageCache\Model\Config;`
`15`	`15`
`16`	`16`	`/**`
`17`		`- * Appends cacheable pages response headers.`
	`17`	`+ * Append cacheable pages response headers.`
`18`	`18`	`*/`
`19`	`19`	`class LayoutPlugin`
`20`	`20`	`{`
`@@ -49,28 +49,28 @@ public function __construct(`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/**`
`52`		`- * Sets appropriate Cache-Control headers.`
	`52`	`+ * Set appropriate Cache-Control headers.`
`53`	`53`	`*`
`54`	`54`	`* We have to set public headers in order to tell Varnish and Builtin app that page should be cached`
`55`	`55`	`*`
`56`		`- * @param LayoutInterface $subject`
	`56`	`+ * @param Layout $subject`
`57`	`57`	`* @return void`
`58`	`58`	`*/`
`59`		`- public function afterGenerateElements(LayoutInterface $subject)`
	`59`	`+ public function afterGenerateElements(Layout $subject)`
`60`	`60`	`{`
`61`	`61`	`if ($subject->isCacheable() && !$this->maintenanceMode->isOn() && $this->config->isEnabled()) {`
`62`	`62`	`$this->response->setPublicHeaders($this->config->getTtl());`
`63`	`63`	`}`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/**`
`67`		`- * Retrieves all identities from blocks for further cache invalidation.`
	`67`	`+ * Retrieve all identities from blocks for further cache invalidation.`
`68`	`68`	`*`
`69`		`- * @param LayoutInterface $subject`
	`69`	`+ * @param Layout $subject`
`70`	`70`	`* @param mixed $result`
`71`	`71`	`* @return mixed`
`72`	`72`	`*/`
`73`		`- public function afterGetOutput(LayoutInterface $subject, $result)`
	`73`	`+ public function afterGetOutput(Layout $subject, $result)`
`74`	`74`	`{`
`75`	`75`	`if ($subject->isCacheable() && $this->config->isEnabled()) {`
`76`	`76`	`$tags = [[]];`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ protected function setUp()`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`
`72`		`- * Tests afterGenerateElements method when depersonalization is needed.`
	`72`	`+ * Test afterGenerateElements method when depersonalization is needed.`
`73`	`73`	`*`
`74`	`74`	`* @return void`
`75`	`75`	`*/`
`@@ -85,7 +85,7 @@ public function testAfterGenerateElements(): void`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`/**`
`88`		`- * Tests afterGenerateElements method when depersonalization is not needed.`
	`88`	`+ * Test afterGenerateElements method when depersonalization is not needed.`
`89`	`89`	`*`
`90`	`90`	`* @return void`
`91`	`91`	`*/`