From c1a8ead92f47832dbac42762cbcd47fdcf82fde7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Szubert?= <bartlomiejszubert@gmail.com>
Date: Mon, 3 Feb 2020 23:46:41 +0100
Subject: [PATCH] Move additional dependencies from private getters to
 constructor - Magento_PageCache

---
 .../PageCache/Observer/FlushAllCache.php      |  53 ++++----
 .../PageCache/Observer/FlushCacheByTags.php   |  78 +++++-------
 .../Test/Unit/Observer/FlushAllCacheTest.php  |  86 ++++++++-----
 .../Unit/Observer/FlushCacheByTagsTest.php    | 118 ++++++++++--------
 4 files changed, 187 insertions(+), 148 deletions(-)

diff --git a/app/code/Magento/PageCache/Observer/FlushAllCache.php b/app/code/Magento/PageCache/Observer/FlushAllCache.php
index 0a45ebf265715..aca9fc5e2a8c0 100644
--- a/app/code/Magento/PageCache/Observer/FlushAllCache.php
+++ b/app/code/Magento/PageCache/Observer/FlushAllCache.php
@@ -1,18 +1,25 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\PageCache\Observer;
 
-use Magento\Framework\App\ObjectManager;
+use Magento\Framework\App\PageCache\Cache;
+use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
+use Magento\PageCache\Model\Cache\Type;
+use Magento\PageCache\Model\Config;
 
+/**
+ * Observer used to flush all caches with built-in full page cache
+ */
 class FlushAllCache implements ObserverInterface
 {
     /**
-     * @var \Magento\Framework\App\PageCache\Cache
+     * @var Cache
      *
      * @deprecated 100.1.0
      */
@@ -21,48 +28,42 @@ class FlushAllCache implements ObserverInterface
     /**
      * Application config object
      *
-     * @var \Magento\PageCache\Model\Config
+     * @var Config
      */
     protected $_config;
 
     /**
-     * @var \Magento\PageCache\Model\Cache\Type
+     * @var Type
      */
     private $fullPageCache;
 
     /**
-     * @param \Magento\PageCache\Model\Config $config
-     * @param \Magento\Framework\App\PageCache\Cache $cache
+     * @param Config $config
+     * @param Cache $cache
+     * @param Type $fullPageCache
      */
-    public function __construct(\Magento\PageCache\Model\Config $config, \Magento\Framework\App\PageCache\Cache $cache)
-    {
+    public function __construct(
+        Config $config,
+        Cache $cache,
+        Type $fullPageCache
+    ) {
         $this->_config = $config;
         $this->_cache = $cache;
+        $this->fullPageCache = $fullPageCache;
     }
 
     /**
      * Flash Built-In cache
-     * @param \Magento\Framework\Event\Observer $observer
+     *
+     * @param Observer $observer
+     *
      * @return void
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    public function execute(\Magento\Framework\Event\Observer $observer)
-    {
-        if ($this->_config->getType() == \Magento\PageCache\Model\Config::BUILT_IN) {
-            $this->getCache()->clean();
-        }
-    }
-
-    /**
-     * TODO: Workaround to support backwards compatibility, will rework to use Dependency Injection in MAGETWO-49547
-     *
-     * @return \Magento\PageCache\Model\Cache\Type
-     */
-    private function getCache()
+    public function execute(Observer $observer)
     {
-        if (!$this->fullPageCache) {
-            $this->fullPageCache = ObjectManager::getInstance()->get(\Magento\PageCache\Model\Cache\Type::class);
+        if ($this->_config->getType() == Config::BUILT_IN) {
+            $this->fullPageCache->clean();
         }
-        return $this->fullPageCache;
     }
 }
diff --git a/app/code/Magento/PageCache/Observer/FlushCacheByTags.php b/app/code/Magento/PageCache/Observer/FlushCacheByTags.php
index 8ce26f7d31781..778557ee0dd2f 100644
--- a/app/code/Magento/PageCache/Observer/FlushCacheByTags.php
+++ b/app/code/Magento/PageCache/Observer/FlushCacheByTags.php
@@ -1,18 +1,27 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\PageCache\Observer;
 
-use Magento\Framework\App\ObjectManager;
+use Magento\Framework\App\Cache\Tag\Resolver;
+use Magento\Framework\App\PageCache\Cache;
+use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
+use Magento\PageCache\Model\Cache\Type;
+use Magento\PageCache\Model\Config;
+use Zend_Cache;
 
+/**
+ * Observer used to cache by tags when using built-in full page cache
+ */
 class FlushCacheByTags implements ObserverInterface
 {
     /**
-     * @var \Magento\Framework\App\PageCache\Cache
+     * @var Cache
      *
      * @deprecated 100.1.0
      */
@@ -21,78 +30,59 @@ class FlushCacheByTags implements ObserverInterface
     /**
      * Application config object
      *
-     * @var \Magento\PageCache\Model\Config
+     * @var Config
      */
     protected $_config;
 
     /**
-     * @var \Magento\PageCache\Model\Cache\Type
+     * @var Type
      */
     private $fullPageCache;
 
     /**
      * Invalidation tags resolver
      *
-     * @var \Magento\Framework\App\Cache\Tag\Resolver
+     * @var Resolver
      */
     private $tagResolver;
 
     /**
-     * @param \Magento\PageCache\Model\Config $config
-     * @param \Magento\Framework\App\PageCache\Cache $cache
+     * @param Config $config
+     * @param Cache $cache
+     * @param Type $fullPageCache
+     * @param Resolver $tagResolver
      */
-    public function __construct(\Magento\PageCache\Model\Config $config, \Magento\Framework\App\PageCache\Cache $cache)
-    {
+    public function __construct(
+        Config $config,
+        Cache $cache,
+        Type $fullPageCache,
+        Resolver $tagResolver
+    ) {
         $this->_config = $config;
         $this->_cache = $cache;
+        $this->fullPageCache = $fullPageCache;
+        $this->tagResolver = $tagResolver;
     }
 
     /**
-     * If Built-In caching is enabled it collects array of tags
-     * of incoming object and asks to clean cache.
+     * If Built-In caching is enabled it collects array of tags of incoming object and asks to clean cache.
+     *
+     * @param Observer $observer
      *
-     * @param \Magento\Framework\Event\Observer $observer
      * @return void
      */
-    public function execute(\Magento\Framework\Event\Observer $observer)
+    public function execute(Observer $observer)
     {
-        if ($this->_config->getType() == \Magento\PageCache\Model\Config::BUILT_IN && $this->_config->isEnabled()) {
+        if ($this->_config->getType() == Config::BUILT_IN && $this->_config->isEnabled()) {
             $object = $observer->getEvent()->getObject();
             if (!is_object($object)) {
                 return;
             }
-            $tags = $this->getTagResolver()->getTags($object);
+            $tags = $this->tagResolver->getTags($object);
 
             if (!empty($tags)) {
-                $this->getCache()->clean(\Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG, array_unique($tags));
+                $this->fullPageCache->clean(Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG, array_unique($tags));
             }
         }
     }
-
-    /**
-     * TODO: Workaround to support backwards compatibility, will rework to use Dependency Injection in MAGETWO-49547
-     *
-     *
-     * @return \Magento\PageCache\Model\Cache\Type
-     */
-    private function getCache()
-    {
-        if (!$this->fullPageCache) {
-            $this->fullPageCache = ObjectManager::getInstance()->get(\Magento\PageCache\Model\Cache\Type::class);
-        }
-        return $this->fullPageCache;
-    }
-
-    /**
-     * @deprecated 100.1.2
-     * @return \Magento\Framework\App\Cache\Tag\Resolver
-     */
-    private function getTagResolver()
-    {
-        if ($this->tagResolver === null) {
-            $this->tagResolver = \Magento\Framework\App\ObjectManager::getInstance()
-                ->get(\Magento\Framework\App\Cache\Tag\Resolver::class);
-        }
-        return $this->tagResolver;
-    }
 }
diff --git a/app/code/Magento/PageCache/Test/Unit/Observer/FlushAllCacheTest.php b/app/code/Magento/PageCache/Test/Unit/Observer/FlushAllCacheTest.php
index 27e1da5a9f144..a0fa99035c8b0 100644
--- a/app/code/Magento/PageCache/Test/Unit/Observer/FlushAllCacheTest.php
+++ b/app/code/Magento/PageCache/Test/Unit/Observer/FlushAllCacheTest.php
@@ -1,48 +1,61 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 
 namespace Magento\PageCache\Test\Unit\Observer;
 
-class FlushAllCacheTest extends \PHPUnit\Framework\TestCase
-{
-    /** @var \Magento\PageCache\Observer\FlushAllCache */
-    private $_model;
+use Magento\Framework\Event\Observer;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\PageCache\Model\Cache\Type;
+use Magento\PageCache\Model\Config;
+use Magento\PageCache\Observer\FlushAllCache;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
 
-    /** @var \PHPUnit_Framework_MockObject_MockObject|\Magento\PageCache\Model\Config */
-    private $_configMock;
+/**
+ * Test class for \Magento\PageCache\Observer\FlushAllCache
+ */
+class FlushAllCacheTest extends TestCase
+{
+    /**
+     * @var FlushAllCache
+     */
+    private $model;
 
-    /** @var  \PHPUnit_Framework_MockObject_MockObject|\Magento\Framework\App\PageCache\Cache */
-    private $_cacheMock;
+    /**
+     * @var Config|MockObject
+     */
+    private $configMock;
 
-    /** @var \PHPUnit_Framework_MockObject_MockObject|\Magento\Framework\Event\Observer */
+    /**
+     * @var Observer|MockObject
+     */
     private $observerMock;
 
-    /** @var  \PHPUnit_Framework_MockObject_MockObject|\Magento\PageCache\Model\Cache\Type */
+    /**
+     * @var Type|MockObject
+     */
     private $fullPageCacheMock;
 
     /**
-     * Set up all mocks and data for test
+     * @inheritDoc
      */
     protected function setUp()
     {
-        $this->_configMock = $this->createPartialMock(\Magento\PageCache\Model\Config::class, ['getType', 'isEnabled']);
-        $this->_cacheMock = $this->createPartialMock(\Magento\Framework\App\PageCache\Cache::class, ['clean']);
-        $this->fullPageCacheMock = $this->createPartialMock(\Magento\PageCache\Model\Cache\Type::class, ['clean']);
-        $this->observerMock = $this->createMock(\Magento\Framework\Event\Observer::class);
+        $this->configMock = $this->createPartialMock(Config::class, ['getType', 'isEnabled']);
+        $this->fullPageCacheMock = $this->createPartialMock(Type::class, ['clean']);
+        $this->observerMock = $this->createMock(Observer::class);
 
-        $this->_model = new \Magento\PageCache\Observer\FlushAllCache(
-            $this->_configMock,
-            $this->_cacheMock
+        $objectManager = new ObjectManager($this);
+        $this->model = $objectManager->getObject(
+            FlushAllCache::class,
+            [
+                'config' => $this->configMock,
+                'fullPageCache' => $this->fullPageCacheMock
+            ]
         );
-
-        $reflection = new \ReflectionClass(\Magento\PageCache\Observer\FlushAllCache::class);
-        $reflectionProperty = $reflection->getProperty('fullPageCache');
-        $reflectionProperty->setAccessible(true);
-        $reflectionProperty->setValue($this->_model, $this->fullPageCacheMock);
     }
 
     /**
@@ -50,15 +63,32 @@ protected function setUp()
      */
     public function testExecute()
     {
-        $this->_configMock->expects(
+        $this->configMock->expects(
             $this->once()
         )->method(
             'getType'
-        )->will(
-            $this->returnValue(\Magento\PageCache\Model\Config::BUILT_IN)
+        )->willReturn(
+            Config::BUILT_IN
         );
 
         $this->fullPageCacheMock->expects($this->once())->method('clean');
-        $this->_model->execute($this->observerMock);
+        $this->model->execute($this->observerMock);
+    }
+
+    /**
+     * Test case for flushing all the cache with varnish enabled
+     */
+    public function testExecuteWithVarnish()
+    {
+        $this->configMock->expects(
+            $this->once()
+        )->method(
+            'getType'
+        )->willReturn(
+            Config::VARNISH
+        );
+
+        $this->fullPageCacheMock->expects($this->never())->method('clean');
+        $this->model->execute($this->observerMock);
     }
 }
diff --git a/app/code/Magento/PageCache/Test/Unit/Observer/FlushCacheByTagsTest.php b/app/code/Magento/PageCache/Test/Unit/Observer/FlushCacheByTagsTest.php
index 8019c6b2e810f..cc3df162fd35a 100644
--- a/app/code/Magento/PageCache/Test/Unit/Observer/FlushCacheByTagsTest.php
+++ b/app/code/Magento/PageCache/Test/Unit/Observer/FlushCacheByTagsTest.php
@@ -1,51 +1,66 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 
 namespace Magento\PageCache\Test\Unit\Observer;
 
-class FlushCacheByTagsTest extends \PHPUnit\Framework\TestCase
-{
-    /** @var \Magento\PageCache\Observer\FlushCacheByTags */
-    protected $_model;
+use Magento\Framework\App\Cache\Tag\Resolver;
+use Magento\Framework\Event;
+use Magento\Framework\Event\Observer;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\PageCache\Model\Cache\Type;
+use Magento\PageCache\Model\Config;
+use Magento\PageCache\Observer\FlushCacheByTags;
+use Magento\Store\Model\Store;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
 
-    /** @var \PHPUnit_Framework_MockObject_MockObject|\Magento\PageCache\Model\Config */
-    protected $_configMock;
+/**
+ * Test class for \Magento\PageCache\Observer\FlushCacheByTags
+ */
+class FlushCacheByTagsTest extends TestCase
+{
+    /**
+     * @var FlushCacheByTags
+     */
+    private $model;
 
-    /** @var  \PHPUnit_Framework_MockObject_MockObject|\Magento\Framework\App\PageCache\Cache */
-    protected $_cacheMock;
+    /**
+     * @var Config|MockObject
+     */
+    private $configMock;
 
-    /** @var  \PHPUnit_Framework_MockObject_MockObject|\Magento\PageCache\Model\Cache\Type */
+    /**
+     * @var Type|MockObject
+     */
     private $fullPageCacheMock;
 
-    /** @var  \PHPUnit_Framework_MockObject_MockObject|\Magento\Framework\App\Cache\Tag\Resolver */
-    private $tagResolver;
+    /**
+     * @var Resolver|MockObject
+     */
+    private $tagResolverMock;
 
     /**
-     * Set up all mocks and data for test
+     * @inheritDoc
      */
     protected function setUp()
     {
-        $helper = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
-        $this->_configMock = $this->createPartialMock(\Magento\PageCache\Model\Config::class, ['getType', 'isEnabled']);
-        $this->_cacheMock = $this->createPartialMock(\Magento\Framework\App\PageCache\Cache::class, ['clean']);
-        $this->fullPageCacheMock = $this->createPartialMock(\Magento\PageCache\Model\Cache\Type::class, ['clean']);
-
-        $this->_model = new \Magento\PageCache\Observer\FlushCacheByTags(
-            $this->_configMock,
-            $this->_cacheMock
+        $this->configMock = $this->createPartialMock(Config::class, ['getType', 'isEnabled']);
+        $this->fullPageCacheMock = $this->createPartialMock(Type::class, ['clean']);
+
+        $this->tagResolverMock = $this->createMock(Resolver::class);
+
+        $objectManager = new ObjectManager($this);
+        $this->model = $objectManager->getObject(
+            FlushCacheByTags::class,
+            [
+                'config' => $this->configMock,
+                'fullPageCache' => $this->fullPageCacheMock,
+                'tagResolver' => $this->tagResolverMock
+            ]
         );
-
-        $this->tagResolver = $this->createMock(\Magento\Framework\App\Cache\Tag\Resolver::class);
-
-        $helper->setBackwardCompatibleProperty($this->_model, 'tagResolver', $this->tagResolver);
-        $reflection = new \ReflectionClass(\Magento\PageCache\Observer\FlushCacheByTags::class);
-        $reflectionProperty = $reflection->getProperty('fullPageCache');
-        $reflectionProperty->setAccessible(true);
-        $reflectionProperty->setValue($this->_model, $this->fullPageCacheMock);
     }
 
     /**
@@ -56,28 +71,28 @@ protected function setUp()
      */
     public function testExecute($cacheState)
     {
-        $this->_configMock->expects($this->any())->method('isEnabled')->will($this->returnValue($cacheState));
-        $observerObject = $this->createMock(\Magento\Framework\Event\Observer::class);
-        $observedObject = $this->createMock(\Magento\Store\Model\Store::class);
+        $this->configMock->method('isEnabled')->willReturn($cacheState);
+        $observerObject = $this->createMock(Observer::class);
+        $observedObject = $this->createMock(Store::class);
 
         if ($cacheState) {
             $tags = ['cache_1', 'cache_group'];
             $expectedTags = ['cache_1', 'cache_group'];
 
-            $eventMock = $this->createPartialMock(\Magento\Framework\Event::class, ['getObject']);
-            $eventMock->expects($this->once())->method('getObject')->will($this->returnValue($observedObject));
-            $observerObject->expects($this->once())->method('getEvent')->will($this->returnValue($eventMock));
-            $this->_configMock->expects($this->once())
+            $eventMock = $this->createPartialMock(Event::class, ['getObject']);
+            $eventMock->expects($this->once())->method('getObject')->willReturn($observedObject);
+            $observerObject->expects($this->once())->method('getEvent')->willReturn($eventMock);
+            $this->configMock->expects($this->once())
                 ->method('getType')
-                ->willReturn(\Magento\PageCache\Model\Config::BUILT_IN);
-            $this->tagResolver->expects($this->once())->method('getTags')->will($this->returnValue($tags));
+                ->willReturn(Config::BUILT_IN);
+            $this->tagResolverMock->expects($this->once())->method('getTags')->willReturn($tags);
 
             $this->fullPageCacheMock->expects($this->once())
                 ->method('clean')
                 ->with(\Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG, $this->equalTo($expectedTags));
         }
 
-        $result = $this->_model->execute($observerObject);
+        $result = $this->model->execute($observerObject);
         $this->assertNull($result);
     }
 
@@ -92,28 +107,31 @@ public function flushCacheByTagsDataProvider()
         ];
     }
 
+    /**
+     * Test case for cache invalidation with empty tags
+     */
     public function testExecuteWithEmptyTags()
     {
-        $this->_configMock->expects($this->any())->method('isEnabled')->will($this->returnValue(true));
-        $observerObject = $this->createMock(\Magento\Framework\Event\Observer::class);
-        $observedObject = $this->createMock(\Magento\Store\Model\Store::class);
+        $this->configMock->method('isEnabled')->willReturn(true);
+        $observerObject = $this->createMock(Observer::class);
+        $observedObject = $this->createMock(Store::class);
 
         $tags = [];
 
-        $eventMock = $this->createPartialMock(\Magento\Framework\Event::class, ['getObject']);
-        $eventMock->expects($this->once())->method('getObject')->will($this->returnValue($observedObject));
-        $observerObject->expects($this->once())->method('getEvent')->will($this->returnValue($eventMock));
-        $this->_configMock->expects(
+        $eventMock = $this->createPartialMock(Event::class, ['getObject']);
+        $eventMock->expects($this->once())->method('getObject')->willReturn($observedObject);
+        $observerObject->expects($this->once())->method('getEvent')->willReturn($eventMock);
+        $this->configMock->expects(
             $this->once()
         )->method(
             'getType'
-        )->will(
-            $this->returnValue(\Magento\PageCache\Model\Config::BUILT_IN)
+        )->willReturn(
+            Config::BUILT_IN
         );
-        $this->tagResolver->expects($this->once())->method('getTags')->will($this->returnValue($tags));
+        $this->tagResolverMock->expects($this->once())->method('getTags')->willReturn($tags);
 
         $this->fullPageCacheMock->expects($this->never())->method('clean');
 
-        $this->_model->execute($observerObject);
+        $this->model->execute($observerObject);
     }
 }