WooCommerce Analytics: Fix proxy speed module installation with proper error/path handling (#45801)

* Enhance WooCommerce Analytics: Add checks for mu-plugin directory writability and source file existence, improve error logging, and ensure proper file copying.

* Add changelog

* Update projects/packages/woocommerce-analytics/changelog/fix-woocomerce-analytics-proxy-speed-copy

Co-authored-by: Copilot <[email protected]>

* Apply suggestions from code review

Co-authored-by: Copilot <[email protected]>

* Apply suggestions from code review

Co-authored-by: Copilot <[email protected]>

* Use copy directly

* WooCommerce Analytics: Use WP_Filesystem API consistently

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: Jasper Kang <[email protected]>

Committed via a GitHub action: https://github.com/Automattic/jetpack/actions/runs/19650795756

Upstream-Ref: Automattic/jetpack@88386db

Author: kangzj

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.12.3-alpha] - unreleased
+
+This is an alpha version! The changes listed here are not final.
+
+### Fixed
+- Fix proxy speed module installation using WP_Filesystem API with proper error handling
+
 ## [0.12.2] - 2025-11-24
 ### Fixed
 - Improve compatibility with old WooCommerce versions. [#46003]
@@ -216,6 +223,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix namespace issue with WooCommerce class reference. [#35857]
 - General: bail early when WooCommerce is not active. [#36278]
 
+[0.12.3-alpha]: https://github.com/Automattic/woocommerce-analytics/compare/v0.12.2...v0.12.3-alpha
 [0.12.2]: https://github.com/Automattic/woocommerce-analytics/compare/v0.12.1...v0.12.2
 [0.12.1]: https://github.com/Automattic/woocommerce-analytics/compare/v0.12.0...v0.12.1
 [0.12.0]: https://github.com/Automattic/woocommerce-analytics/compare/v0.11.0...v0.12.0

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/woocommerce-analytics",
-	"version": "0.12.2",
+	"version": "0.12.3-alpha",
 	"private": true,
 	"description": "WooCommerce Analytics package to track frontend events",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/packages/woocommerce-analytics/#readme",

src/class-woocommerce-analytics.php

@@ -21,7 +21,7 @@ class Woocommerce_Analytics {
 	/**
 	 * Package version.
 	 */
-	const PACKAGE_VERSION = '0.12.2';
+	const PACKAGE_VERSION = '0.12.3-alpha';
 
 	/**
 	 * Proxy speed module version.
@@ -174,12 +174,11 @@ public static function register_rest_routes() {
 	 * Maybe add proxy speed module.
 	 */
 	public static function maybe_add_proxy_speed_module() {
-		if ( ! function_exists( 'WP_Filesystem' ) ) {
-			require_once ABSPATH . 'wp-admin/includes/file.php';
+		if ( ! self::init_filesystem() ) {
+			return;
 		}
 
-		// Initialize the WP filesystem.
-		WP_Filesystem();
+		global $wp_filesystem;
 
 		// Create the mu-plugin directory if it doesn't exist.
 		if ( ! is_dir( WPMU_PLUGIN_DIR ) ) {
@@ -191,36 +190,85 @@ public static function maybe_add_proxy_speed_module() {
 			return;
 		}
 
+		// Check if the mu-plugin directory is writable.
+		if ( ! $wp_filesystem->is_writable( WPMU_PLUGIN_DIR ) ) {
+			if ( function_exists( 'wc_get_logger' ) ) {
+				wc_get_logger()->debug( 'WooCommerce Analytics proxy speed module not installed: mu-plugins directory is not writable.', array( 'source' => 'woocommerce-analytics' ) );
+			}
+			return;
+		}
+
 		if ( get_option( 'woocommerce_analytics_proxy_speed_module_version' ) === self::PROXY_SPEED_MODULE_VERSION ) {
 			// No need to copy the files again.
 			return;
 		}
 
-		update_option( 'woocommerce_analytics_proxy_speed_module_version', self::PROXY_SPEED_MODULE_VERSION );
 		$mu_plugin_src_file  = __DIR__ . '/mu-plugin/woocommerce-analytics-proxy-speed-module.php';
-		$mu_plugin_dest_file = WPMU_PLUGIN_DIR . '/woocommerce-analytics-proxy-speed-module.php';
-		$results             = copy( $mu_plugin_src_file, $mu_plugin_dest_file );
+		$mu_plugin_dest_file = trailingslashit( WPMU_PLUGIN_DIR ) . 'woocommerce-analytics-proxy-speed-module.php';
+
+		// Verify source file exists before attempting to copy.
+		if ( ! file_exists( $mu_plugin_src_file ) ) {
+			if ( function_exists( 'wc_get_logger' ) ) {
+				wc_get_logger()->error( 'WooCommerce Analytics proxy speed module source file not found.', array( 'source' => 'woocommerce-analytics' ) );
+			}
+			return;
+		}
+
+		$content = $wp_filesystem->get_contents( $mu_plugin_src_file );
+		if ( false === $content ) {
+			if ( function_exists( 'wc_get_logger' ) ) {
+				wc_get_logger()->error( 'Failed to read the WooCommerce Analytics proxy speed module source file.', array( 'source' => 'woocommerce-analytics' ) );
+			}
+			return;
+		}
 
-		if ( ! $results ) {
+		if ( ! $wp_filesystem->put_contents( $mu_plugin_dest_file, $content ) ) {
 			if ( function_exists( 'wc_get_logger' ) ) {
-				wc_get_logger()->error( 'Failed to copy the WooCommerce Analytics proxy speed module files.', array( 'source' => 'woocommerce-analytics' ) );
+				wc_get_logger()->error( 'Failed to copy the WooCommerce Analytics proxy speed module file.', array( 'source' => 'woocommerce-analytics' ) );
 			}
+			return;
 		}
+
+		update_option( 'woocommerce_analytics_proxy_speed_module_version', self::PROXY_SPEED_MODULE_VERSION );
 	}
 
 	/**
 	 * Maybe removes the proxy speed module. This should be invoked when the plugin is deactivated.
 	 */
 	public static function maybe_remove_proxy_speed_module() {
+		if ( ! self::init_filesystem() ) {
+			return;
+		}
+
+		global $wp_filesystem;
+
 		/**
 		 * Clean up MU plugin.
 		 */
-		$file_path = WPMU_PLUGIN_DIR . '/woocommerce-analytics-proxy-speed-module.php';
+		$file_path = trailingslashit( WPMU_PLUGIN_DIR ) . 'woocommerce-analytics-proxy-speed-module.php';
 
-		if ( file_exists( $file_path ) ) {
-			wp_delete_file( $file_path );
+		if ( $wp_filesystem->exists( $file_path ) && $wp_filesystem->is_writable( $file_path ) ) {
+			$wp_filesystem->delete( $file_path );
 		}
 
 		delete_option( 'woocommerce_analytics_proxy_speed_module_version' );
 	}
+
+	/**
+	 * Initialize the WP filesystem.
+	 *
+	 * @return bool True if filesystem is initialized, false otherwise.
+	 */
+	private static function init_filesystem() {
+		if ( ! function_exists( 'WP_Filesystem' ) ) {
+			require_once ABSPATH . 'wp-admin/includes/file.php';
+		}
+
+		// Initialize the WP filesystem.
+		ob_start();
+		$initialized = WP_Filesystem();
+		ob_end_clean();
+
+		return $initialized;
+	}
 }