Merge pull request #2829 from Strategy11/omit_changelog_from_autoloaded_option_with_plugin_api_data

Omit changelog from autoloaded option with plugin api data and exclude invalid plugins

Author: Crabcyborg

classes/models/FrmAddon.php

@@ -195,7 +195,21 @@ public function plugins_api_filter( $_data, $_action = '', $_args = null ) {
 
 		$item_id = $this->download_id;
 
-		if ( ! $item_id ) {
+		if ( $item_id ) {
+			$api = new FrmFormApi( $this->license );
+
+			// Force new API info so we can pull changelog data.
+			// Change log data is intentionally omitted from the cached API response
+			// to help reduce the size of the autoloaded option.
+			$api->force_api_request();
+			$plugins = $api->get_api_info();
+
+			if ( $plugins ) {
+				$_data = $plugins[ $item_id ];
+			}
+		}
+
+		if ( empty( $plugins ) ) {
 			$_data = array(
 				'name'      => $this->plugin_name,
 				'excerpt'   => '',
@@ -205,10 +219,6 @@ public function plugins_api_filter( $_data, $_action = '', $_args = null ) {
 					'low'  => 'https://ps.w.org/formidable/assets/banner-1544x500.png',
 				),
 			);
-		} else {
-			$api     = new FrmFormApi( $this->license );
-			$plugins = $api->get_api_info();
-			$_data   = $plugins[ $item_id ];
 		}
 
 		$_data['sections'] = array(

classes/models/FrmFormApi.php

@@ -27,6 +27,14 @@ class FrmFormApi {
 	 */
 	protected $new_days = 90;
 
+	/**
+	 * If true, calls to get_api_info will bypass cache.
+	 * This is set true by calling force_api_request.
+	 *
+	 * @var bool
+	 */
+	protected $force = false;
+
 	/**
 	 * @since 3.06
 	 *
@@ -84,6 +92,18 @@ public function get_cache_key() {
 		return $this->cache_key;
 	}
 
+	/**
+	 * Flag the force property as true, so the next API request bypasses cache.
+	 * This is used to pull API data for change logs, which are excluded from the cached data.
+	 *
+	 * @since x.x
+	 *
+	 * @return void
+	 */
+	public function force_api_request() {
+		$this->force = true;
+	}
+
 	/**
 	 * @since 3.06
 	 *
@@ -96,7 +116,12 @@ public function get_api_info() {
 			$url .= '?l=' . urlencode( base64_encode( $this->license ) );
 		}
 
-		$addons = $this->get_cached();
+		if ( $this->force ) {
+			$addons      = false;
+			$this->force = false;
+		} else {
+			$addons = $this->get_cached();
+		}
 
 		if ( is_array( $addons ) ) {
 			return $addons;
@@ -344,6 +369,8 @@ protected function get_cached_option() {
 	 * @return void
 	 */
 	protected function set_cached( $addons ) {
+		$addons = $this->reduce_addon_data_before_caching( $addons );
+
 		$data = array(
 			'timeout' => strtotime( $this->get_cache_timeout( $addons ), time() ),
 			'value'   => wp_json_encode( $addons ),
@@ -359,6 +386,74 @@ protected function set_cached( $addons ) {
 		}
 	}
 
+	/**
+	 * Remove certain add-on API data that we don't need to cache.
+	 * This is to help keep the option data (which is auto-loaded) small.
+	 *
+	 * @since x.x
+	 *
+	 * @param array $addons
+	 *
+	 * @return array
+	 */
+	private function reduce_addon_data_before_caching( $addons ) {
+		if ( is_subclass_of( $this, 'FrmFormApi' ) ) {
+			// We only want to modify FrmFormApi. Leave the other APIs alone for now.
+			return $addons;
+		}
+
+		$reduced_addons = array();
+
+		foreach ( $addons as $key => $addon ) {
+			if ( ! is_array( $addon ) ) {
+				$reduced_addons[ $key ] = $addon;
+				continue;
+			}
+
+			if ( ! $this->should_include_addon_in_cached_data( $addon ) ) {
+				continue;
+			}
+
+			if ( isset( $addon['changelog'] ) ) {
+				unset( $addon['changelog'], $addon['banners'] );
+			}
+
+			$reduced_addons[ $key ] = $addon;
+		}
+
+		return $reduced_addons;
+	}
+
+	/**
+	 * @since x.x
+	 *
+	 * @param array $addon
+	 *
+	 * @return bool True if the add-on should be included in cached data.
+	 */
+	private function should_include_addon_in_cached_data( $addon ) {
+		if ( isset( $addon['version'] ) && '' === $addon['version'] ) {
+			// If version is set but blank, the plugin is not actually live.
+			return false;
+		}
+
+		if ( isset( $addon['categories'] ) ) {
+			if ( 'views' === $addon['slug'] ) {
+				// Legacy views has no categories set, but we should still
+				// include it in cache since it is a valid add-on.
+				return true;
+			}
+
+			$categories_are_empty = ! $addon['categories'] || $addon['categories'] === array( 'Strategy11' );
+
+			if ( $categories_are_empty ) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
 	/**
 	 * If the last check was a a rate limit, we'll need to check again sooner.
 	 *

tests/cypress/e2e/Applications/validateApplicationsPage.cy.js

@@ -27,7 +27,8 @@ describe( 'Applications page', () => {
 							t.includes( 'the most advanced wordpress form builder' ) ||
 							t.includes( 'more than just a wordpress form builder' ) ||
 							t.includes( 'get more done in less time with better wordpress forms' ) ||
-							t.includes( 'power your wordpress site like never before' )
+							t.includes( 'power your wordpress site like never before' ) ||
+							t.includes( 'stop patching together plugins. start building what you actually need.' )
 						);
 					} );
 				} );