Merge pull request #578 from woocommerce/fix/STORMA-39-ensure-settings-defaults-populated

Fix STORMA-39: Backfill missing settings defaults on fresh activation

Author: stuartduff

includes/class-wc-google-analytics.php

@@ -38,6 +38,17 @@ public function __construct() {
 		$this->init_form_fields();
 		$this->init_settings();
 
+		// Backfill any settings keys not yet stored in the database.
+		// On a fresh activation, maybe_set_defaults() writes a partial settings array before
+		// init_settings() runs. WC_Integration::init_settings() only applies defaults when no
+		// settings exist at all, so keys missing from a partial array would be absent from
+		// $this->settings. We fill them in here using the same fallback logic as get_option().
+		foreach ( $this->get_form_fields() as $key => $field ) {
+			if ( ! array_key_exists( $key, $this->settings ) ) {
+				$this->settings[ $key ] = $this->get_field_default( $field );
+			}
+		}
+
 		add_action( 'admin_notices', array( $this, 'universal_analytics_upgrade_notice' ) );
 
 		include_once 'class-wc-abstract-google-analytics-js.php';

tests/unit-tests/Configuration.php

@@ -372,6 +372,48 @@ public function test_track_settings_linker_allow_incoming_normalization() {
 		$this->assertEquals( 'no', $data['wc-google-analytics']['linker_allow_incoming_enabled'] );
 	}
 
+	/**
+	 * Test that $this->settings is fully populated when the database contains only the partial
+	 * defaults written by maybe_set_defaults() on a fresh activation.
+	 *
+	 * @return void
+	 */
+	public function test_settings_are_complete_after_partial_activation_defaults() {
+		// Simulate what maybe_set_defaults() writes on a fresh install.
+		update_option( 'woocommerce_google_analytics_settings', [ 'ga_product_identifier' => 'product_id' ] );
+
+		$ga = new WC_Google_Analytics();
+
+		$reflection = new \ReflectionProperty( WC_Google_Analytics::class, 'settings' );
+		$reflection->setAccessible( true );
+		$settings = $reflection->getValue( $ga );
+
+		$expected_keys = [
+			'ga_product_identifier',
+			'ga_id',
+			'ga_support_display_advertising',
+			'ga_404_tracking_enabled',
+			'ga_linker_allow_incoming_enabled',
+			'ga_ecommerce_tracking_enabled',
+			'ga_event_tracking_enabled',
+			'ga_enhanced_remove_from_cart_enabled',
+			'ga_enhanced_product_impression_enabled',
+			'ga_enhanced_product_click_enabled',
+			'ga_enhanced_product_detail_view_enabled',
+			'ga_enhanced_checkout_process_enabled',
+			'ga_linker_cross_domains',
+		];
+
+		foreach ( $expected_keys as $key ) {
+			$this->assertArrayHasKey( $key, $settings, "Expected '{$key}' to be present in settings after construction with partial defaults." );
+		}
+
+		// The value set by maybe_set_defaults() should be preserved, not overwritten.
+		$this->assertEquals( 'product_id', $settings['ga_product_identifier'] );
+
+		delete_option( 'woocommerce_google_analytics_settings' );
+	}
+
 	/**
 	 * Call a protected or private method via reflection.
 	 *