Merge pull request #466 from newfold-labs/fix/object-cache-connection-constants

Update Redis connection constants for availability check

Author: arunshenoy99

composer.json

@@ -40,7 +40,8 @@
         "newfold-labs/wp-module-features": "^1.5",
         "newfold-labs/wp-module-installer": "^1.7",
         "newfold-labs/wp-module-htaccess": "^1.0",
-        "predis/predis": "^3.4"
+        "predis/predis": "^3.4",
+        "wp-cli/wp-config-transformer": "^1.4"
     },
     "require-dev": {
         "newfold-labs/wp-php-standards": "^1.2",

composer.lock

@@ -90,9 +90,10 @@ public function manual_purge_request() {
 	}
 
 	/**
-	 * Purge everything.
+	 * Purge page caches only (File, Browser). Does not flush object cache.
+	 * Use when enabling object cache so session/auth data is not flushed.
 	 */
-	public function purge_all() {
+	public function purge_page_caches() {
 		foreach ( $this->cache_types as $instance ) {
 			if ( array_key_exists( Purgeable::class, class_implements( $instance ) ) ) {
 				/**
@@ -103,6 +104,13 @@ public function purge_all() {
 				$instance->purge_all();
 			}
 		}
+	}
+
+	/**
+	 * Purge everything (page caches and object cache).
+	 */
+	public function purge_all() {
+		$this->purge_page_caches();
 		ObjectCache::flush_object_cache();
 	}
 

includes/Cache/CachePurgingService.php

@@ -38,11 +38,8 @@ class ObjectCache {
 	 * @var string[]
 	 */
 	const REDIS_CONNECTION_CONSTANTS = array(
-		'WP_REDIS_HOST',
-		'WP_REDIS_SERVERS',
-		'WP_REDIS_CLUSTER',
-		'WP_REDIS_SHARDS',
-		'WP_REDIS_SENTINEL',
+		'WP_REDIS_PREFIX',
+		'WP_REDIS_PASSWORD',
 	);
 
 	/**
@@ -61,11 +58,49 @@ class ObjectCache {
 	 */
 	public static function is_available() {
 		foreach ( self::REDIS_CONNECTION_CONSTANTS as $constant ) {
-			if ( defined( $constant ) ) {
-				return true;
+			if ( ! defined( $constant ) ) {
+				return false;
 			}
 		}
-		return false;
+		return true;
+	}
+
+	/**
+	 * Whether Redis is configured in wp-config.php (at least one connection constant is defined there).
+	 * Used for removal: we remove the drop-in when wp-config no longer has Redis config, even if the
+	 * drop-in has already defined a constant (e.g. WP_REDIS_PREFIX from WP_CACHE_KEY_SALT or env).
+	 * Uses WP-CLI's wp-config-transformer so commented-out defines are not counted as present.
+	 * Result is cached per request to avoid repeated file reads and parsing.
+	 *
+	 * @return bool
+	 */
+	public static function is_configured_in_wp_config() {
+		static $result = null;
+		if ( null !== $result ) {
+			return $result;
+		}
+		$path = defined( 'WP_CONFIG_FILE' ) ? constant( 'WP_CONFIG_FILE' ) : ( ABSPATH . 'wp-config.php' );
+		if ( ! file_exists( $path ) ) {
+			$path = dirname( ABSPATH ) . '/wp-config.php';
+		}
+		if ( ! file_exists( $path ) || ! is_readable( $path ) ) {
+			$result = false;
+			return $result;
+		}
+		try {
+			$transformer = new \WPConfigTransformer( $path, true );
+			foreach ( self::REDIS_CONNECTION_CONSTANTS as $constant ) {
+				if ( ! $transformer->exists( 'constant', $constant ) ) {
+					$result = false;
+					return $result;
+				}
+			}
+		} catch ( \Exception $e ) {
+			$result = false;
+			return $result;
+		}
+		$result = true;
+		return $result;
 	}
 
 	/**
@@ -308,18 +343,20 @@ public static function maybe_restore_on_activation() {
 	/**
 	 * If Redis config is no longer present (e.g. constants commented out in wp-config) but our drop-in
 	 * is still in place, remove the drop-in so WordPress does not load a broken object cache.
-	 * Also clears the enabled preference so state stays consistent.
+	 * Uses wp-config content (not defined()) so we still remove when the drop-in has already defined
+	 * a constant (e.g. WP_REDIS_PREFIX from WP_CACHE_KEY_SALT or env). Also clears the enabled preference.
+	 * Checks for the drop-in file first so we skip wp-config read/parse on most requests (no drop-in).
 	 *
 	 * @return void
 	 */
 	public static function maybe_remove_dropin_if_unavailable() {
-		if ( self::is_available() ) {
-			return;
-		}
 		$path = self::get_drop_in_path();
 		if ( ! file_exists( $path ) || ! self::is_our_drop_in( $path ) ) {
 			return;
 		}
+		if ( self::is_configured_in_wp_config() ) {
+			return;
+		}
 		if ( ! function_exists( 'WP_Filesystem' ) ) {
 			require_once ABSPATH . 'wp-admin/includes/file.php';
 		}

includes/Cache/Types/ObjectCache.php

@@ -115,8 +115,9 @@ public function hooks() {
 	 * @return void
 	 */
 	public function on_activation() {
-		// Purge object cache on shutdown so the next request reads active_plugins from DB (not Redis).
-		add_action( 'shutdown', array( $this, 'purge_object_cache_on_shutdown' ), PHP_INT_MAX );
+		// Clear plugin list from object cache on shutdown so the next request reads active_plugins from DB (not Redis).
+		// Only clears options group — avoids full flush which would destroy session/auth data and log the user out.
+		add_action( 'shutdown', array( $this, 'clear_plugin_cache_on_shutdown' ), PHP_INT_MAX );
 		// Cache feature bits.
 		File::on_activation();
 		Browser::on_activation();
@@ -146,7 +147,17 @@ protected function delete_plugin_list_option_cache() {
 	}
 
 	/**
-	 * Purge object cache (options + full flush + runtime) on shutdown after activate/deactivate.
+	 * Clear only the plugin list from object cache on shutdown after activation.
+	 * Ensures the next request reads active_plugins from DB without destroying session/auth data.
+	 *
+	 * @return void
+	 */
+	public function clear_plugin_cache_on_shutdown() {
+		$this->delete_plugin_list_option_cache();
+	}
+
+	/**
+	 * Purge object cache (options + full flush + runtime) on shutdown after deactivation.
 	 * Ensures the next request reads active_plugins from DB even if something re-cached after our hooks.
 	 *
 	 * @return void

includes/PerformanceLifecycleHooks.php

@@ -130,8 +130,14 @@ public function update_settings( \WP_REST_Request $request ) {
 					$out = ObjectCache::disable();
 				}
 				if ( $out['success'] ) {
-					// Purge page cache and object cache (purge_all includes flush_object_cache).
-					container()->get( 'cachePurger' )->purge_all();
+					// When enabling: only purge page caches so we don't flush object cache (avoids logging out the user).
+					// When disabling: purge everything including object cache.
+					$purger = container()->get( 'cachePurger' );
+					if ( $enable ) {
+						$purger->purge_page_caches();
+					} else {
+						$purger->purge_all();
+					}
 					return new \WP_REST_Response( array( 'result' => true ), 200 );
 				}
 				return new \WP_REST_Response(