Version 1.1.1 Complete

Rafael Grigorian · Rafael Grigorian · commit f78dfe025966 · 2017-12-06T16:23:58.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,4 +3,9 @@
 
 ## Version 1.1.0
 - 	Removed backend server configuration
-- 	Removed VCL template generation by user
+- 	Removed VCL template generation by user
+
+## Version 1.1.1
+-	Change caching application from varnish module config page
+- 	Change status of varnish module when cache application changes
+-	Changed headers in conf/default.vcl
diff --git a/dist/JetRails_Varnish-1.1.1.tgz b/dist/JetRails_Varnish-1.1.1.tgz
diff --git a/dist/Varnish.zip b/dist/Varnish.zip
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "Varnish",
-	"version": "1.1.0",
+	"version": "1.1.1",
 	"description": "Magento 2 - Manage Varnish Cache",
 	"repository": {
 		"type": "git",
@@ -22,12 +22,5 @@
 		"grunt-mkdir": "^1.0.0",
 		"grunt-replace": "^1.0.1",
 		"grunt-rsync": "^2.0.1"
-	},
-	"jetrailsDependencies": [],
-	"staging": {
-		"port": "22",
-		"user": "raffi",
-		"host": "localhost",
-		"dest": "~/Site/"
 	}
 }
diff --git a/src/app/code/JetRails/Varnish/Block/Adminhtml/System/Config/Form/Link.php b/src/app/code/JetRails/Varnish/Block/Adminhtml/System/Config/Form/Link.php
@@ -9,7 +9,7 @@
 	 * Link.php - This block alongside the template is used to render a link to the cache management
 	 * page in the magento store backend.  This block is also referenced as a frontend model in the
 	 * system.xml file.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Form
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Console/Command/AbstractCommand.php b/src/app/code/JetRails/Varnish/Console/Command/AbstractCommand.php
@@ -14,7 +14,7 @@
 	 * is meant to be a buffer between that class and the commands that are implemented in this
 	 * module.  Instead of using the execute command, the child classes overload the runCommand
 	 * method.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Status
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Purge/All.php b/src/app/code/JetRails/Varnish/Console/Command/Purge/All.php
@@ -8,7 +8,7 @@
 	/**
 	 * All.php - This class inherits from the AbstractCommand.  This command contacts all the
 	 * configured varnish cache servers and asks them to flush all the cache for all urls.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Purge/Store.php b/src/app/code/JetRails/Varnish/Console/Command/Purge/Store.php
@@ -12,7 +12,7 @@
 	 * servers that start with the store view's base url.  If no argument is passed, then a list of
 	 * store views along with their base url, id, and name is displayed in the payload of the
 	 * response.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Purge/Url.php b/src/app/code/JetRails/Varnish/Console/Command/Purge/Url.php
@@ -9,7 +9,7 @@
 	/**
 	 * Url.php - This class inherits from the AbstractCommand.  This command takes in a url and asks
 	 * all the saved varnish servers a request to purge the passed url from cache.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Status.php b/src/app/code/JetRails/Varnish/Console/Command/Status.php
@@ -9,7 +9,7 @@
 	 * Status.php - This class inherits from the AbstractCommand.  This command tells the user if
 	 * the module is enabled.  In the sense that the 'Caching Application' setting is set to
 	 * 'Varnish Cache', and not 'Built-in Cache'.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Command
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Status/Set.php b/src/app/code/JetRails/Varnish/Console/Command/Status/Set.php
@@ -11,7 +11,7 @@
 	 * Set.php - This class inherits from the AbstractCommand.  This command takes in an additional
 	 * argument, either enable or disable, and sets the caching application to 'Varnish Cache' or
 	 * 'Built-in Cache' respectfully.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Status
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/All.php b/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/All.php
@@ -13,7 +13,7 @@
 	 * All.php - This class is a controller action and when it is triggered, it is responsible for
 	 * looping through all the saved varnish cache servers and purging all the cache for all the
 	 * urls that are stored with those varnish cache servers.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/Store.php b/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/Store.php
@@ -13,7 +13,7 @@
 	 * Store.php - This class is a controller action and when it is triggered, it is responsible for
 	 * purging all the cache in all the configured cache servers that match (start with) the base
 	 * url of the store view.  The store view id is passed as a parameter
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/Url.php b/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/Url.php
@@ -12,7 +12,7 @@
 	/**
 	 * Url.php - This class is a controller action and when it is triggered, it is responsible for
 	 * purging all the cache in all the configured cache servers that exactly match the passed url.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Helper/Data.php b/src/app/code/JetRails/Varnish/Helper/Data.php
@@ -18,7 +18,7 @@
 	 * Data.php - This helper class is responsible for data retrieval and configuration.  It can use
 	 * the store config and the Magento session information to return data about the user and about
 	 * the module configuration on the store scope.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Helper
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Helper/Purger.php b/src/app/code/JetRails/Varnish/Helper/Purger.php
@@ -10,7 +10,7 @@
 	 * Purger.php - This class is encapsulated with purge specific methods in order to use them on
 	 * the backend controllers and the console commands.  These methods specifically purge single
 	 * URLs, store views, and even purge all cache from a list of given varnish servers.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Helper
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Logger/Handler.php b/src/app/code/JetRails/Varnish/Logger/Handler.php
@@ -8,7 +8,7 @@
 	/**
 	 * Handler.php - This class is used by Magento to define a custom log file.  These injections
 	 * for runtime reflection of this custom logging class is defined within the di.xml file.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Logger
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Logger/Logger.php b/src/app/code/JetRails/Varnish/Logger/Logger.php
@@ -9,7 +9,7 @@
 	 * method in essence is the same as the info method because it logs with the same severity, but
 	 * it also takes in additional blame oriented data in order to propagate blame to the caller as
 	 * well as the action that was taken.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Logger
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Model/Adminhtml/Config/Options/EnableDisable.php b/src/app/code/JetRails/Varnish/Model/Adminhtml/Config/Options/EnableDisable.php
@@ -7,7 +7,7 @@
 	/**
 	 * EnableDisable.php - These options include enable and disable with enable having an integer
 	 * value of 1 and disable having an integer value of 0.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Options
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Model/Adminhtml/Config/Options/YesNo.php b/src/app/code/JetRails/Varnish/Model/Adminhtml/Config/Options/YesNo.php
@@ -7,7 +7,7 @@
 	/**
 	 * YesNo.php - These options include yes and no.  Yes has an integer value of 1 and no has an
 	 * integer value of 0.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Options
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Observer/Excluder.php b/src/app/code/JetRails/Varnish/Observer/Excluder.php
@@ -14,7 +14,7 @@
 	 * then looks at the URL and route of the controller action in question, and it checks the store
 	 * config for excluded URLs and routes.  If any match, then a header parameter is set in order
 	 * not to cache the page.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Observer
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Observer/Save/Cache.php b/src/app/code/JetRails/Varnish/Observer/Save/Cache.php
@@ -0,0 +1,71 @@
+<?php
+
+	namespace JetRails\Varnish\Observer\Save;
+
+	use JetRails\Varnish\Model\Adminhtml\Config\Options\EnableDisable;
+	use Magento\Framework\App\Config\ScopeConfigInterface;
+	use Magento\Framework\App\Config\Storage\WriterInterface;
+	use Magento\Framework\Event\Observer;
+	use Magento\Framework\Event\ObserverInterface;
+	use Magento\PageCache\Model\Config as CacheConfig;
+	use Magento\Store\Model\ScopeInterface;
+
+	/**
+	 * Cache.php - This observer event is triggered whenever the caching application is changed in
+	 * the system configuration page under the Advanced menu. Based on the caching application,
+	 * the varnish module will be disabled or enabled.
+	 * @version         1.1.1
+	 * @package         JetRails® Varnish
+	 * @category        Save
+	 * @author          Rafael Grigorian - JetRails®
+	 * @copyright       JetRails®, all rights reserved
+	 */
+	class Cache implements ObserverInterface {
+
+		/**
+		 * These internal data members include instances of helper classes that are injected into
+		 * the class using dependency injection on runtime.
+		 * @var         ScopeConfigInterface    _configReader   Instance of ScopeConfigInterface
+		 * @var         WriterInterface         _configWriter   Instance of WriterInterface
+		 */
+		protected $_configReader;
+		protected $_configWriter;
+
+		/**
+		 * This constructor is overloaded from the parent class in order to use dependency injection
+		 * to get the dependency classes that we need for this module's command actions to execute.
+		 * @param       ScopeConfigInterface    configReader    Instance of ScopeConfigInterface
+		 * @param       WriterInterface         configWriter    Instance of WriterInterface
+		 */
+		public function __construct (
+			ScopeConfigInterface $configReader,
+			WriterInterface $configWriter
+		) {
+			// Save the injected class instances
+			$this->_configReader = $configReader;
+			$this->_configWriter = $configWriter;
+		}
+
+		/**
+		 * This method is required because this class implements the ObserverInterface class.  This
+		 * method gets executed when the registered event is fired for this class.  The event that
+		 * this method will file for can be found in the events.xml file.
+		 * @param       Observer            observer            Observer with event information
+		 * @return      void
+		 */
+		public function execute ( Observer $observer ) {
+			// Set the scope to be store scope
+			$storeScope = ScopeInterface::SCOPE_STORE;
+			// Get the caching application that was saved
+			$cacheApp = $this->_configReader->getValue (
+				"system/full_page_cache/caching_application",
+				$storeScope
+			);
+			// Based on the changed caching application, set status
+			$this->_configWriter->save (
+				"jetrails_varnish/general_configuration/status",
+				$cacheApp == CacheConfig::VARNISH ? EnableDisable::ENABLED : EnableDisable::DISABLED
+			);
+		}
+
+	}
diff --git a/src/app/code/JetRails/Varnish/Observer/Save/Config.php b/src/app/code/JetRails/Varnish/Observer/Save/Config.php
@@ -2,19 +2,21 @@
 
 	namespace JetRails\Varnish\Observer\Save;
 
+	use JetRails\Varnish\Model\Adminhtml\Config\Options\EnableDisable;
 	use Magento\Framework\App\Config\ScopeConfigInterface;
 	use Magento\Framework\App\Config\Storage\WriterInterface;
 	use Magento\Framework\Event\Observer;
 	use Magento\Framework\Event\ObserverInterface;
 	use Magento\Framework\Message\ManagerInterface;
+	use Magento\PageCache\Model\Config as CacheConfig;
 	use Magento\Store\Model\ScopeInterface;
 
 	/**
 	 * Config.php - This observer event is triggered whenever the store config is saved for this
 	 * module.  It then validates all the fields and makes sure no invalid server information, urls,
 	 * or routes are saved in the database.  If invalid ones are passed, then an error message is
 	 * attached to the caller's session.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Save
 	 * @author          Rafael Grigorian - JetRails®
@@ -172,6 +174,12 @@ public function execute ( Observer $observer ) {
 			$this->_configWriter->save ( "$groupGC/servers", $validatedServers );
 			$this->_configWriter->save ( "$groupCEP/excluded_routes", $validatedRoutes );
 			$this->_configWriter->save ( "$groupCEP/excluded_url_paths", $validatedUrls );
+			// Change caching type based on status
+			$status = $this->_configReader->getValue ( "$groupGC/status", $storeScope );
+			$this->_configWriter->save (
+				"system/full_page_cache/caching_application",
+				$status == EnableDisable::ENABLED ? CacheConfig::VARNISH : CacheConfig::BUILT_IN
+			);
 		}
 
 	}
diff --git a/src/app/code/JetRails/Varnish/Observer/Save/Page.php b/src/app/code/JetRails/Varnish/Observer/Save/Page.php
@@ -13,7 +13,7 @@
 	/**
 	 * Page.php - This observer is triggered when the CMS page save event is fired.  It then finds
 	 * the url of the CMS page and sends a URL purge request to the configured varnish servers.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Save
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Observer/Save/Product.php b/src/app/code/JetRails/Varnish/Observer/Save/Product.php
@@ -13,7 +13,7 @@
 	/**
 	 * Product.php - This observer is triggered when the product save event is fired.  It then finds
 	 * the url of the product and sends a URL purge request to the configured varnish servers.
-	 * @version         1.1.0
+	 * @version         1.1.1
 	 * @package         JetRails® Varnish
 	 * @category        Save
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/etc/adminhtml/system.xml b/src/app/code/JetRails/Varnish/etc/adminhtml/system.xml
@@ -28,6 +28,18 @@
 				showInStore="1" >
 				<label>General Configuration</label>
 				<attribute type="expanded" >1</attribute>
+				<field
+					id="status"
+					translate="label"
+					type="select"
+					sortOrder="0"
+					showInDefault="1"
+					showInWebsite="1"
+					showInStore="1" >
+					<label>Status</label>
+					<source_model>JetRails\Varnish\Model\Adminhtml\Config\Options\EnableDisable</source_model>
+					<comment>This will change your caching application</comment>
+				</field>
 				<field
 					id="debug"
 					translate="label"
diff --git a/src/app/code/JetRails/Varnish/etc/config.xml b/src/app/code/JetRails/Varnish/etc/config.xml
@@ -6,6 +6,7 @@
 	<default>
 		<jetrails_varnish>
 			<general_configuration>
+				<status>0</status>
 				<debug>0</debug>
 				<servers>127.0.0.1:80</servers>
 			</general_configuration>
diff --git a/src/app/code/JetRails/Varnish/etc/events.xml b/src/app/code/JetRails/Varnish/etc/events.xml
@@ -15,6 +15,12 @@
 			instance="JetRails\Varnish\Observer\Save\Config"
 		/>
 	</event>
+	<event name="admin_system_config_changed_section_system" >
+		<observer
+			name="jetrails_varnish_save_config"
+			instance="JetRails\Varnish\Observer\Save\Cache"
+		/>
+	</event>
 	<event name="catalog_product_save_after" >
 		<observer
 			name="jetrails_varnish_save_product"
diff --git a/yarn.lock b/yarn.lock
