Add Jetpack sync module to sync WP Super Cache constants and global variables #6482

gititon · 2017-02-22T22:53:08Z

Changes proposed in this Pull Request:

Adds Jetpack Sync module for syncing WP Super Cache globals and constants

Testing instructions:

Tests have been added to the test suite for the new sync module. Additionally, you can test manually by installing WP Super Cache, changing values, and confirming that the changes values are reflected on WordPress.com.

Proposed changelog entry for your changes:

This change syncs constants and globals used by WP Super Cache. You can now whitelist additional callables for sync by adding them to the whitelist via the jetpack_sync_callable_whitelist filter.

gititon · 2017-02-22T22:57:14Z

I've created a pull request so that I can share my progress with teammates. This is a work in progress and is not meant/ready for review.

ebinnion · 2017-02-23T01:32:05Z

sync/class.jetpack-sync-actions.php

@@ -293,6 +294,20 @@ static function add_woocommerce_sync_module( $sync_modules ) {
 		return $sync_modules;
 	}

+	static function initialize_wp_super_cache() {
+		//WPCACHEHOME looks like a reasonable constant to test for the plugin's presence as per https://github.com/Automattic/wp-super-cache/blob/master/wp-cache.php
+		if ( false === defined( 'WPCACHEHOME' ) ) {


Hey @donnchawp - Since we need to check in Jetpack if WP Super Cache is active, we need to find an option, constant, etc. to check against. Is there one that you'd recommend to test against?

WPCACHEHOME should be good to use, but if you want to double check, use $wp_super_cache_debug too - it should be set to 0 or 1 and is in the sample config file so it's defined even if the user hasn't configured the plugin yet.

we could use function_exists too

georgestephanis · 2017-02-23T21:02:22Z

Should some of the WP Super Cache stuff be in the 3rd-party directory instead?

enejb · 2017-03-06T22:42:12Z

tests/php/sync/test_class.jetpack-sync-wp_super_cache.php

+	protected $post;
+	protected $callable_module;
+	protected $full_sync;
+	static $woo_enabled;


probably do not need this any more.

Thanks, Enej. Removed.

lezama · 2017-03-07T15:58:41Z

tests/php/sync/test_class.jetpack-sync-wp_super_cache.php

+	}
+
+	function test_module_is_enabled() {
+		$this->assertTrue( !! Jetpack_Sync_Modules::get_module( "wp-super-cache" ) );


"wp-super-cache" could use simple quotes

lezama · 2017-03-07T16:03:26Z

tests/php/sync/test_class.jetpack-sync-wp_super_cache.php

+		$this->assertTrue( !! Jetpack_Sync_Modules::get_module( "wp-super-cache" ) );
+	}
+
+	//@todo test functionality


We could add something similar to this test: https://github.com/Automattic/jetpack/blob/master/tests/php/sync/test_class.jetpack-sync-options.php#L65

enejb · 2017-03-09T20:32:36Z

tests/php/bootstrap.php

+	/**
+	 * "Mocking" function so that it exists and Jetpack_Sync_Actions will load Jetpack_Sync_Module_WP_Super_Cache
+	 */
+	function wp_cache_is_enabled() {


Lets do a if function exists here in case some one runs it with the plugin installed.

enejb · 2017-03-09T20:34:25Z

sync/class.jetpack-sync-defaults.php

+			 *
+			 * @module sync
+			 *
+			 * @since 4.7


We missed the 4.7 boat lets update it to 4.8

enejb · 2017-03-09T20:34:57Z

sync/class.jetpack-sync-defaults.php

+			 *
+			 * @module sync
+			 *
+			 * @since 4.7


We missed the 4.7 boat lets update it to 4.8

enejb · 2017-03-09T20:35:05Z

sync/class.jetpack-sync-defaults.php

+			 *
+			 * @module sync
+			 *
+			 * @since 4.7


We missed the 4.7 boat lets update it to 4.8

enejb · 2017-03-09T20:35:15Z

sync/class.jetpack-sync-defaults.php

+			 *
+			 * @module sync
+			 *
+			 * @since 4.7


We missed the 4.7 boat lets update it to 4.8

enejb · 2017-03-09T20:36:13Z

sync/class.jetpack-sync-defaults.php

+			 *
+			 * @module sync
+			 *
+			 * @since 4.7


Here as well.

enejb · 2017-03-09T20:38:07Z

sync/class.jetpack-sync-actions.php

@@ -293,6 +294,20 @@ static function add_woocommerce_sync_module( $sync_modules ) {
 		return $sync_modules;
 	}

+	static function initialize_wp_super_cache() {
+		//WPCACHEHOME looks like a reasonable constant to test for the plugin's presence as per https://github.com/Automattic/wp-super-cache/blob/master/wp-cache.php


Lets remove this comment. Since we are not using WPCACHEHOME constant any more.

lezama · 2017-03-09T20:52:27Z

sync/class.jetpack-sync-defaults.php

@@ -5,6 +5,13 @@
 * Just some defaults that we share with the server
 */
 class Jetpack_Sync_Defaults {
+
+	static $initialized_options_whitelist;


we don't seem to be using these anymore :)

lezama · 2017-03-09T20:53:26Z

tests/php/bootstrap.php

@@ -31,6 +31,17 @@
 	define( 'JETPACK_WOOCOMMERCE_INSTALL_DIR', dirname( __FILE__ ) . '/../../../woocommerce' );
 }

+if ( "1" != getenv( 'JETPACK_TEST_WP_SUPER_CACHE' ) ) {


"1" could be written as '1' to match coding standards

lezama · 2017-03-09T20:53:42Z

tests/php/bootstrap.php

@@ -31,6 +31,17 @@
 	define( 'JETPACK_WOOCOMMERCE_INSTALL_DIR', dirname( __FILE__ ) . '/../../../woocommerce' );
 }

+if ( "1" != getenv( 'JETPACK_TEST_WP_SUPER_CACHE' ) ) {
+	echo "To run Jetpack WP Super Cache tests, prefix phpunit with JETPACK_TEST_WP_SUPER_CACHE=1" . PHP_EOL;


…es-119

…enabled() instead of if WPCACHEHOME is defined in case the latter is left behind by a config file.

…listing mechanism for WP Super Cache Module Updated "default" whitelisting mechanism to ensure filters (which add values to whitelisted array) are only run once when getters are called so that they don't repeatedly add the same values if getters are called again. Using mechanism to add values to constant and callable whitelists to sync WP Super Cache data.

… file

… test file

…on before defining it

lezama

Great work 👍

… as expected.

@SInCE

* Readme: remove old release and add skeleton for 4.8. * Changelog: add #6572 * Changelog: add #6567 * Changelog: add #6542 * Changelog: add #6527 * Changelog: add #6508 * Changelog: add #6478 * Changelog: add #6477 * Changelog: add #6249 * Update stable version and remove old version from readme. * Changelog: add 4.7.1 to changelog. * Readme: add new contributor. * Sync: update docblock @SInCE version. Related: #6053 * Changelog: add release post. * changelog: add #6053 * Changelog: add #6413 * Changelog: add #6482 * Changelog: add #6584 * Changelog add #6603 * Changelog: add #6606 * Changelog: add #6611 * Changelog: add #6635 * Changelog: add #6639 * Changelog: add #6684 * Changelog: add #6710 * Changelog: add #6711 * Changelog: add #5461 * Testing list: update Settings UI feedback prompt. Props @MichaelArestad * Changelog: add #6789 * Changelog: add #6778 * Changelog: add #6777 * Changelog: add #6775 * Changelog: add #6755 * Changelog: add #6731 * Changelog: add #6721 * Changelog: add #6705 * Changelog: add #6702 * Changelog: add #6671 * Changelog: add #6637 * Changelog: add #6582 * Changelog: add #6566 * Changelog: add #6555 * Changelog: add #6529 * Changelog: add #6344 * Changelog: add #5763 * Changelog: add #5503 * Changelog: update #6637 changelog. @see 40e115c#commitcomment-21523982 * Changelog: add #6699 * Changelog: add #6632 * Changelog: add #6769 * Changelog: add #6707 * Changelog: add #6590

gititon added [Package] Sync [Status] In Progress [Team] Poseidon labels Feb 22, 2017

ebinnion assigned ebinnion and gititon and unassigned ebinnion and gititon Feb 23, 2017

ebinnion reviewed Feb 23, 2017

View reviewed changes

matticbot added the Touches WP.com Files label Mar 6, 2017

gititon force-pushed the jpop-issues-119 branch from bdd223d to 5459a21 Compare March 6, 2017 22:28

enejb reviewed Mar 6, 2017

View reviewed changes

lezama reviewed Mar 7, 2017

View reviewed changes

gititon force-pushed the jpop-issues-119 branch 2 times, most recently from 76a69dc to f073c7c Compare March 8, 2017 20:32