Allow CMS pages to not be banned in Varnish when products are updated

Block/Adminhtml/Report/Edit.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Block\Adminhtml\Report;
@@ -19,7 +19,7 @@ public function __construct(
     ) {
         parent::__construct($context, $data);
     }
-    
+
     protected function _construct()
     {
         $this->_objectId = 'general_id';
@@ -28,7 +28,7 @@ protected function _construct()
 
         parent::_construct();
     }
-    
+
     /**
      * Retrieve text for header element
      *

Block/Adminhtml/Report/Edit/Form.php

@@ -1,12 +1,12 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Block\Adminhtml\Report\Edit;
- 
+
 use Magento\Backend\Block\Widget\Form\Generic;
- 
+
 class Form extends Generic
 {
     /**
@@ -26,7 +26,7 @@ protected function _prepareForm()
         );
         $form->setUseContainer(true);
         $this->setForm($form);
- 
+
         return parent::_prepareForm();
     }
 }

Block/Adminhtml/Report/Edit/Tab/Credentials.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Block\Adminhtml\Report\Edit\Tab;

Block/Adminhtml/Report/Edit/Tab/Metrics.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Block\Adminhtml\Report\Edit\Tab;

Block/Adminhtml/Report/Edit/Tab/Settings.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Block\Adminhtml\Report\Edit\Tab;

Block/Adminhtml/Report/Edit/Tabs.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Block\Adminhtml\Report\Edit;

Controller/Adminhtml/Report/FetchInfo.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Controller\Adminhtml\Report;

Controller/Adminhtml/Report/Index.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Controller\Adminhtml\Report;

Controller/Adminhtml/Report/Save.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Controller\Adminhtml\Report;

Controller/Index/Index.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Section.io. All rights reserved.
+ * Copyright © 2018 Section.io. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Controller\Index;

Controller/Router.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Section.io. All rights reserved.
+ * Copyright © 2018 Section.io. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Controller;

Helper/Aperture.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Helper;

Helper/Data.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Helper;

Helper/State.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Helper;

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016, section.io
+Copyright (c) 2018, section.io
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
@@ -7,4 +7,4 @@ Redistribution and use in source and binary forms, with or without modification,
 
 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Model/Account.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model;
@@ -22,7 +22,7 @@ public function __construct(
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = []
     ) {
-    
+
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }
 

Model/Application.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model;
@@ -22,7 +22,7 @@ public function __construct(
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = []
     ) {
-    
+
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }
 

Model/Config.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Copyright © 2018 Sectionio. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Sectionio\Metrics\Model;
+
+/**
+ * Class Config
+ *
+ */
+ class Config extends \Magento\PageCache\Model\Config
+ {
+
+    /**
+     * Returns include CMS in product purge.
+     *
+     * @return bool
+     */
+    public function includeCmsInProductPurge()
+    {
+        return $this->_scopeConfig->isSetFlag('system/full_page_cache/sectionio/include_cms_in_product_purge');
+    }
+ }

Model/PurgeCache.php

@@ -14,6 +14,13 @@ class PurgeCache
      */
     private $logger;
 
+    /**
+     * Application config object
+     *
+     * @var \Magento\Framework\App\Config\ScopeConfigInterface
+     */
+    private $config;
+
     /** @var \Sectionio\Metrics\Helper\State $helper */
     protected $state;
 
@@ -27,15 +34,18 @@ class PurgeCache
      * Constructor
      *
      * @param InvalidateLogger $logger
+     * @param \Sectionio\Metrics\Model\Config $config
      * @param \Sectionio\Metrics\Helper\State $state
      * @param \Sectionio\Metrics\Helper\Aperture $aperture
      */
     public function __construct(
         InvalidateLogger $logger,
+        \Sectionio\Metrics\Model\Config $config,
         \Sectionio\Metrics\Helper\State $state,
         \Sectionio\Metrics\Helper\Aperture $aperture
     ) {
         $this->logger = $logger;
+        $this->config = $config;
         $this->state = $state;
         $this->aperture = $aperture;
     }
@@ -54,21 +64,28 @@ public function sendPurgeRequest($tagsPattern)
         $environment_name = $this->state->getEnvironmentName();
         $proxy_name = $this->state->getProxyName();
 
+        $banExpression = urlencode('obj.http.X-Magento-Tags ~ ' . $tagsPattern);
+
+        // If this ban contains product tags & includeCmsInProductPurge is false, exclude any object that also has a CMS Page tag
+        if (!$this->config->includeCmsInProductPurge() && strpos($tagsPattern, \Magento\Catalog\Model\Product::CACHE_TAG) !== false) {
+            $banExpression .= urlencode(' && obj.http.X-Magento-Tags !~ (^|,)'.\Magento\Cms\Model\Page::CACHE_TAG.'_[0-9]+');
+        }
+
         $uri = $this->aperture->generateUrl([
             'api' => true,
             'accountId' => $account_id,
             'applicationId' => $application_id,
             'environmentName' => $environment_name,
             'proxyName' => $proxy_name,
-            'uriStem'   => '/state?async=true&banExpression=' . urlencode('obj.http.X-Magento-Tags ~ ' . $tagsPattern)
+            'uriStem'   => '/state?async=true&banExpression=' . $banExpression
         ]);
 
         $info = $this->aperture->executeAuthRequest($uri, 'POST', [], self::BAN_TIMEOUT_SECONDS);
         if ($info['http_code'] != 200) {
             $this->logger->execute('Error executing purge: ' . $tagsPattern.', Error: ' . $info['body_content']);
             return false;
         }
-        $this->logger->execute(compact('server', 'tagsPattern'));
         return true;
     }
 }
+

Model/ResourceModel/Account.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model\ResourceModel;
@@ -15,7 +15,7 @@ public function __construct(
         \Magento\Framework\Model\ResourceModel\Db\Context $context,
         $resourcePrefix = null
     ) {
-    
+
         $this->transactionManager = $context->getTransactionManager();
         $this->_resources = $context->getResources();
         $this->objectRelationProcessor = $context->getObjectRelationProcessor();

Model/ResourceModel/Account/Collection.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model\ResourceModel\Account;

Model/ResourceModel/Application.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model\ResourceModel;
@@ -15,7 +15,7 @@ public function __construct(
         \Magento\Framework\Model\ResourceModel\Db\Context $context,
         $resourcePrefix = null
     ) {
-    
+
         $this->transactionManager = $context->getTransactionManager();
         $this->_resources = $context->getResources();
         $this->objectRelationProcessor = $context->getObjectRelationProcessor();

Model/ResourceModel/Application/Collection.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model\ResourceModel\Application;

Model/ResourceModel/Settings.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model\ResourceModel;

Model/ResourceModel/Settings/Collection.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model\ResourceModel\Settings;

Model/Settings.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Model;
@@ -22,7 +22,7 @@ public function __construct(
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = []
     ) {
-    
+
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }
 

Observer/InvalidateVarnishObserver.php

@@ -23,11 +23,11 @@ class InvalidateVarnishObserver implements ObserverInterface
     private $purgeCache;
 
     /**
-     * @param \Magento\PageCache\Model\Config $config
+     * @param \Sectionio\Metrics\Model\Config $config
      * @param \Sectionio\Metrics\Model\PurgeCache $purgeCache
      */
     public function __construct(
-        \Magento\PageCache\Model\Config $config,
+        \Sectionio\Metrics\Model\Config $config,
         \Sectionio\Metrics\Model\PurgeCache $purgeCache
     ) {
         $this->config = $config;
@@ -43,7 +43,7 @@ public function __construct(
      */
     public function execute(\Magento\Framework\Event\Observer $observer)
     {
-        if ($this->config->getType() == \Magento\PageCache\Model\Config::VARNISH && $this->config->isEnabled()) {
+        if ($this->config->getType() == \Sectionio\Metrics\Model\Config::VARNISH && $this->config->isEnabled()) {
             $object = $observer->getEvent()->getObject();
             if ($object instanceof \Magento\Framework\DataObject\IdentityInterface) {
                 $tags = [];

Setup/InstallSchema.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2016 Sectionio. All rights reserved.
+ * Copyright © 2018 Sectionio. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Sectionio\Metrics\Setup;