Merge pull request #113 from magento-extensibility/develop

[Extensibility] bug-mania

Author: Kopylova,Olga(okopylova)

app/code/Magento/PageCache/Model/App/PageCachePlugin.php

@@ -6,10 +6,17 @@
 
 namespace Magento\PageCache\Model\App;
 
+use Magento\Framework\Exception\LocalizedException;
+
 class PageCachePlugin
 {
     /**
-     * Attach FPC tag to all saved entries to enable cache type management
+     * Label for compressed cache entries
+     */
+    const COMPRESSION_PREFIX = 'COMPRESSED_CACHE_';
+
+    /**
+     * Enable type management by adding type tag, and enable cache compression
      *
      * @param \Magento\Framework\App\PageCache\Cache $subject
      * @param string $data
@@ -27,7 +34,44 @@ public function beforeSave(
         $tags = [],
         $lifeTime = null
     ) {
+        $data = $this->handleCompression($data);
         $tags[] = \Magento\PageCache\Model\Cache\Type::CACHE_TAG;
         return [$data, $identifier, $tags, $lifeTime];
     }
+
+    /**
+     * Enable cache de-compression
+     *
+     * @param \Magento\Framework\App\PageCache\Cache $subject
+     * @param string $result
+     * @return string|bool
+     * @throws \Magento\Framework\Exception\LocalizedException
+     *
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterLoad(
+        \Magento\Framework\App\PageCache\Cache $subject,
+        $result
+    ) {
+        if ($result && strpos($result, self::COMPRESSION_PREFIX) === 0) {
+            $result = function_exists('gzuncompress')
+                ? gzuncompress(substr($result, strlen(self::COMPRESSION_PREFIX)))
+                : false;
+        }
+        return $result;
+    }
+
+    /**
+     * Label compressed entries and check if gzcompress exists
+     *
+     * @param string $data
+     * @return string
+     */
+    private function handleCompression($data)
+    {
+        if (function_exists('gzcompress')) {
+            $data = self::COMPRESSION_PREFIX . gzcompress($data);
+        }
+        return $data;
+    }
 }

app/code/Magento/PageCache/Test/Unit/Model/App/PageCachePluginTest.php

@@ -7,24 +7,61 @@
 namespace Magento\PageCache\Test\Unit\Model\App;
 
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\PageCache\Model\App\PageCachePlugin;
 use Magento\PageCache\Model\Cache\Type;
 
 class PageCachePluginTest extends \PHPUnit_Framework_TestCase
 {
-    public function testBeforeSave()
+    /** @var PageCachePlugin */
+    private $plugin;
+
+    /** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\Framework\App\PageCache\Cache*/
+    private $subjectMock;
+
+    public function setUp()
     {
-        /** @var \Magento\PageCache\Model\App\PageCachePlugin $plugin */
-        $plugin = (new ObjectManager($this))->getObject('\Magento\PageCache\Model\App\PageCachePlugin');
-        $subjectMock = $this->getMockBuilder('\Magento\Framework\App\PageCache\Cache')
+        $this->plugin = (new ObjectManager($this))->getObject('\Magento\PageCache\Model\App\PageCachePlugin');
+        $this->subjectMock = $this->getMockBuilder('\Magento\Framework\App\PageCache\Cache')
             ->disableOriginalConstructor()
             ->getMock();
+    }
+
+    public function testBeforeSaveAddTag()
+    {
         $initTags = ['tag', 'otherTag'];
-        $result = $plugin->beforeSave($subjectMock, 'data', 'identifier', $initTags);
+        $result = $this->plugin->beforeSave($this->subjectMock, 'data', 'identifier', $initTags);
         $tags = isset($result[2]) ? $result[2] : null;
         $expectedTags = array_merge($initTags, [Type::CACHE_TAG]);
         $this->assertNotNull($tags);
         foreach ($expectedTags as $expected) {
             $this->assertContains($expected, $tags);
         }
     }
+
+    public function testBeforeSaveCompression()
+    {
+        $data = 'raw-data';
+        $expected = PageCachePlugin::COMPRESSION_PREFIX . gzcompress($data);
+        $result = $this->plugin->beforeSave($this->subjectMock, $data, 'id');
+        $resultData = $result[0];
+        $this->assertSame($resultData, $expected);
+    }
+
+    /**
+     * @dataProvider afterSaveDataProvider
+     * @param string $dataw
+     * @param string $initResult
+     */
+    public function testAfterSaveDecompression($data, $initResult)
+    {
+        $this->assertSame($data, $this->plugin->afterLoad($this->subjectMock, $initResult));
+    }
+
+    public function afterSaveDataProvider()
+    {
+        return [
+            'Compressed cache' => ['raw-data', PageCachePlugin::COMPRESSION_PREFIX . gzcompress('raw-data')],
+            'Non-compressed cache' => ['raw-data', 'raw-data']
+        ];
+    }
 }

app/code/Magento/PageCache/etc/di.xml

@@ -11,6 +11,6 @@
                 type="Magento\PageCache\Model\App\CacheIdentifierPlugin" sortOrder="10"/>
     </type>
     <type name="Magento\Framework\App\PageCache\Cache">
-        <plugin name="fpc-tag-addition-plugin" type="Magento\PageCache\Model\App\PageCachePlugin"/>
+        <plugin name="fpc-type-plugin" type="Magento\PageCache\Model\App\PageCachePlugin"/>
     </type>
 </config>