Skip to content

Cleanup ObjectManager usage - Magento_CacheInvalidate #27084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 12, 2020
Merged

Cleanup ObjectManager usage - Magento_CacheInvalidate #27084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 31 additions & 29 deletions app/code/Magento/CacheInvalidate/Observer/InvalidateVarnishObserver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,61 +3,76 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\CacheInvalidate\Observer;

use Magento\CacheInvalidate\Model\PurgeCache;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;
use Magento\Framework\App\Cache\Tag\Resolver;
use Magento\PageCache\Model\Config;

/**
* Observer used to invalidate varnish cache once Magento cache was cleaned
*/
class InvalidateVarnishObserver implements ObserverInterface
{
/**
* Application config object
*
* @var \Magento\Framework\App\Config\ScopeConfigInterface
* @var ScopeConfigInterface
*/
protected $config;
private $config;

/**
* @var \Magento\CacheInvalidate\Model\PurgeCache
* @var PurgeCache
*/
protected $purgeCache;
private $purgeCache;

/**
* Invalidation tags resolver
*
* @var \Magento\Framework\App\Cache\Tag\Resolver
* @var Resolver
*/
private $tagResolver;

/**
* @param \Magento\PageCache\Model\Config $config
* @param \Magento\CacheInvalidate\Model\PurgeCache $purgeCache
* @param Config $config
* @param PurgeCache $purgeCache
* @param Resolver $tagResolver
*/
public function __construct(
\Magento\PageCache\Model\Config $config,
\Magento\CacheInvalidate\Model\PurgeCache $purgeCache
Config $config,
PurgeCache $purgeCache,
Resolver $tagResolver
) {
$this->config = $config;
$this->purgeCache = $purgeCache;
$this->tagResolver = $tagResolver;
}

/**
* If Varnish caching is enabled it collects array of tags
* of incoming object and asks to clean cache.
* If Varnish 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)
{
$object = $observer->getEvent()->getObject();

if (!is_object($object)) {
return;
}
if ($this->config->getType() == \Magento\PageCache\Model\Config::VARNISH && $this->config->isEnabled()) {
$bareTags = $this->getTagResolver()->getTags($object);

if ((int)$this->config->getType() === Config::VARNISH && $this->config->isEnabled()) {
$bareTags = $this->tagResolver->getTags($object);

$tags = [];
$pattern = "((^|,)%s(,|$))";
$pattern = '((^|,)%s(,|$))';
foreach ($bareTags as $tag) {
$tags[] = sprintf($pattern, $tag);
}
Expand All @@ -66,17 +81,4 @@ public function execute(\Magento\Framework\Event\Observer $observer)
}
}
}

/**
* @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;
}
}
98 changes: 63 additions & 35 deletions app/code/Magento/CacheInvalidate/Test/Unit/Observer/InvalidateVarnishObserverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,77 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\CacheInvalidate\Test\Unit\Observer;

use Magento\CacheInvalidate\Model\PurgeCache;
use Magento\CacheInvalidate\Observer\InvalidateVarnishObserver;
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\Config;
use Magento\Store\Model\Store;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

class InvalidateVarnishObserverTest extends \PHPUnit\Framework\TestCase
/**
* Test class for \Magento\CacheInvalidate\Observer\InvalidateVarnishObserver
*/
class InvalidateVarnishObserverTest extends TestCase
{
/** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\CacheInvalidate\Observer\InvalidateVarnishObserver */
protected $model;
/**
* @var InvalidateVarnishObserver
*/
private $model;

/** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\Framework\Event\Observer */
protected $observerMock;
/**
* @var Config|MockObject
*/
private $configMock;

/** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\PageCache\Model\Config */
protected $configMock;
/**
* @var PurgeCache|MockObject
*/
private $purgeCacheMock;

/** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\CacheInvalidate\Model\PurgeCache */
protected $purgeCache;
/**
* @var Resolver|MockObject
*/
private $tagResolverMock;

/** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\Framework\DataObject\ */
protected $observerObject;
/**
* @var Observer|MockObject
*/
private $observerMock;

/** @var \PHPUnit_Framework_MockObject_MockObject | \Magento\Framework\App\Cache\Tag\Resolver */
private $tagResolver;
/**
* @var Store|MockObject
*/
private $observerObject;

/**
* 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->purgeCache = $this->createMock(\Magento\CacheInvalidate\Model\PurgeCache::class);
$this->model = new \Magento\CacheInvalidate\Observer\InvalidateVarnishObserver(
$this->configMock,
$this->purgeCache
);
$this->configMock = $this->createPartialMock(Config::class, ['getType', 'isEnabled']);
$this->purgeCacheMock = $this->createMock(PurgeCache::class);
$this->tagResolverMock = $this->createMock(Resolver::class);

$this->tagResolver = $this->createMock(\Magento\Framework\App\Cache\Tag\Resolver::class);
$helper->setBackwardCompatibleProperty($this->model, 'tagResolver', $this->tagResolver);
$this->observerMock = $this->createPartialMock(Observer::class, ['getEvent']);
$this->observerObject = $this->createMock(Store::class);

$this->observerMock = $this->createPartialMock(\Magento\Framework\Event\Observer::class, ['getEvent']);
$this->observerObject = $this->createMock(\Magento\Store\Model\Store::class);
$objectManager = new ObjectManager($this);
$this->model = $objectManager->getObject(
InvalidateVarnishObserver::class,
[
'config' => $this->configMock,
'purgeCache' => $this->purgeCacheMock,
'tagResolver' => $this->tagResolverMock
]
);
}

/**
Expand All @@ -56,21 +84,21 @@ public function testInvalidateVarnish()
$tags = ['cache_1', 'cache_group'];
$pattern = '((^|,)cache_1(,|$))|((^|,)cache_group(,|$))';

$this->configMock->expects($this->once())->method('isEnabled')->will($this->returnValue(true));
$this->configMock->expects($this->once())->method('isEnabled')->willReturn(true);
$this->configMock->expects(
$this->once()
)->method(
'getType'
)->will(
$this->returnValue(\Magento\PageCache\Model\Config::VARNISH)
)->willReturn(
Config::VARNISH
);

$eventMock = $this->createPartialMock(\Magento\Framework\Event::class, ['getObject']);
$eventMock->expects($this->once())->method('getObject')->will($this->returnValue($this->observerObject));
$this->observerMock->expects($this->once())->method('getEvent')->will($this->returnValue($eventMock));
$this->tagResolver->expects($this->once())->method('getTags')->with($this->observerObject)
->will($this->returnValue($tags));
$this->purgeCache->expects($this->once())->method('sendPurgeRequest')->with($pattern);
$eventMock = $this->createPartialMock(Event::class, ['getObject']);
$eventMock->expects($this->once())->method('getObject')->willReturn($this->observerObject);
$this->observerMock->expects($this->once())->method('getEvent')->willReturn($eventMock);
$this->tagResolverMock->expects($this->once())->method('getTags')->with($this->observerObject)
->willReturn($tags);
$this->purgeCacheMock->expects($this->once())->method('sendPurgeRequest')->with($pattern);

$this->model->execute($this->observerMock);
}
Expand Down