Ready to come out of beta (#2)

* sync clearing cache with github updater
* upgrade utility
* adjust rest table columns
* fixes GHU issues with caching vs transients
* have rest cache admin delete function use new utility
* add transient disabler to ghu plugin
* version bump
* Update changelog.md

Author: scarstens

admin/class-wrc-admin.php

@@ -55,7 +55,7 @@ static function add_menu_page() {
 		static function options_page() {
 
 			if ( ! empty( $_REQUEST['wrc-entry-delete'] ) ) {
-				$deleted = static::delete_by_md5( $_REQUEST['wrc-entry-delete'] );
+				$deleted = WRC_Utility::clear_cache_by( 'rest_md5', $_REQUEST['wrc-entry-delete'] );
 
 				if ( false !== $deleted ) {
 					echo '<div class="updated"><p>The following entry was deleted:';
@@ -277,34 +277,6 @@ static function query_rest_table( $limit = 10, $domain, $path ) {
 			return false;
 		}
 
-		static function delete_by_md5( $md5 ) {
-			global $wpdb;
-
-			$select = '
-			SELECT rest_md5, rest_domain, rest_path
-			FROM   ' . REST_CACHE_TABLE . '
-			WHERE rest_md5 = "' . esc_attr( $md5 ) . '" 
-			LIMIT 1;
-			';
-
-			$select_result = $wpdb->get_results( $select, ARRAY_A );
-
-			if ( ! empty( $select_result ) ) {
-				$delete = '
-				DELETE
-				FROM   ' . REST_CACHE_TABLE . '
-				WHERE rest_md5 = "' . esc_attr( $md5 ) . '" 
-				LIMIT 1;
-				';
-
-				$delete_it = $wpdb->get_results( $delete, ARRAY_A );
-
-				return $select_result[0];
-			}
-
-			return false;
-		}
-
 	} // END class
 
 } // END if(!class_exists())

changelog.md

@@ -1,3 +1,7 @@
+#### 1.0.0
+* Tested in production at scale for several days, ready to call plugin released and out of beta
+* Fixed github updater double caching issues and removed transients from GHU to reduce transient cache overhead, especially useful for reducing VARNISH / REDIS bandwidth issues.
+
 #### 0.10.0
 * Major bugfix: Cached values were never properly updating. Fixed with better code organization 
   and a clearer update-via-cron process!
@@ -34,4 +38,4 @@
 * Hooking into HTTP class actions
 
 #### 0.1
-* Initial plugin as boilerplate from https://github.com/scarstens/worpress-plugin-boilerplate-redux
+* Initial plugin as boilerplate from https://github.com/scarstens/worpress-plugin-boilerplate-redux

inc/class-wrc-caching.php

@@ -17,10 +17,10 @@ class WRC_Caching {
 	static function init() {
 		// ensure our filters don't run during crons
 		if ( ! defined( 'DOING_CRON' ) ) {
-			add_filter( 'pre_http_request', array( get_called_class(), 'pre_http_request' ), 2, 3 );
+			add_filter( 'pre_http_request', array( get_called_class(), 'pre_http_request' ), 9, 3 );
 			// If it gets past pre_http_request and to the http response filter,
 			// check if we should create/update the data via store_data
-			add_filter( 'http_response', array( get_called_class(), 'store_data' ), 1, 3 );
+			add_filter( 'http_response', array( get_called_class(), 'store_data' ), 9, 3 );
 		}
 	}
 
@@ -187,7 +187,7 @@ static function maybe_return_requested_data( $url, $args ) {
 			return maybe_unserialize( $cached_request['rest_response'] );
 		}
 
-		// false is returned because it tells the `pre_http_request` filter that it needs to move on to theactual http request
+		// false is returned because it tells the `pre_http_request` filter that it needs to move on to the actual http request
 		return false;
 	}
 
@@ -261,4 +261,4 @@ protected static function check_for_expired_result( $data, $args ) {
 
 	}
 
-}
+}

inc/class-wrc-filters.php

@@ -27,7 +27,7 @@ static function always_filters() {
 	 * Admin only filters are registered
 	 */
 	static function admin_filters() {
-
+		add_filter( 'ghu_use_remote_call_transients', '__return_false' );
 	}
 
 	/**

inc/class-wrc-utility.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Class WRC_Utility
+ *
+ * Utility functions used to help and simplify clearing out cache in different ways
+ *
+ */
+class WRC_Utility {
+
+	/**
+	 * Utility to easily delete cache by exact column value
+	 *
+	 * @param $column
+	 * @param $value
+	 *
+	 * @return false|int
+	 */
+	public static function clear_cache_by( $column, $value ) {
+		global $wpdb;
+
+		return $wpdb->delete( $wpdb->base_prefix . WP_Rest_Cache::$table, array( $column => $value ) );
+	}
+
+	/**
+	 * Deletes all github api calls from the rest cache to operate with afragen/github-updater plugin
+	 *
+	 * @return false|int number of deleted cache rows
+	 */
+	public static function clear_ghu_cache( $type = '' ) {
+		// only run on plugins since that action happens first
+		// if it runs on themes it will delete plugin cache twice
+		if ( ! empty( $type ) && 'plugin' === $type ) {
+			return self::clear_cache_by( 'rest_domain', 'https://api.github.com' );
+		}
+
+		return false;
+	}
+
+}

wp-rest-cache.php

@@ -4,7 +4,7 @@
  * Plugin URI: https://github.com/WordPress-Phoenix/wordpress-rest-cache
  * Description: A solution to caching REST data calls without relying on transients or wp_options tables. Note: for multisite "Network Activate", table may need manually created before activation.
  * Author: scarstens
- * Version: 0.10.0
+ * Version: 1.0.0
  * Author URI: http://github.com/scarstens
  * License: GPL V2
  * Text Domain: rest_cache
@@ -64,6 +64,8 @@ public function __construct() {
 			// nesting actions/filters within the init action was causing the transport filter to run too late in some cases
 			$this->init();
 
+			add_action( 'before_ghu_delete_all_transients', array( 'WRC_Utility', 'clear_ghu_cache') );
+
 			// init for use with logged in users, see this::authenticated_init for more details
 			add_action( 'init', array( $this, 'authenticated_init' ) );
 
@@ -129,14 +131,14 @@ public static function activate() {
 			// create our table if it doesn't already exist
 
 			$sql = "CREATE TABLE " . REST_CACHE_TABLE . " (
-  `rest_md5` char(32) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',
-  `rest_domain` varchar(1055) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',
-  `rest_path` varchar(1055) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',
-  `rest_response` longtext COLLATE utf8mb4_unicode_ci NOT NULL,
-  `rest_expires` datetime DEFAULT NULL,
   `rest_last_requested` date NOT NULL,
-  `rest_tag` varchar(1055) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',
+  `rest_expires` datetime DEFAULT NULL,
+  `rest_domain` varchar(1055) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
+  `rest_path` varchar(1055) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
+  `rest_response` longtext COLLATE utf8mb4_unicode_ci NOT NULL,
+  `rest_tag` varchar(1055) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
   `rest_to_update` tinyint(1) DEFAULT '0',
+  `rest_md5` char(32) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
   `rest_args` longtext COLLATE utf8mb4_unicode_ci,
   PRIMARY KEY (`rest_md5`),
   KEY `rest_domain` (`rest_domain`(191),`rest_path`(191)),
@@ -211,4 +213,4 @@ public static function is_dev() {
 	// instantiate the plugin class, which should never be instantiated more then once
 	global $WP_Rest_Cache;
 	$WP_Rest_Cache = new WP_Rest_Cache();
-}
+}