Merge branch 'fix/issue-wootax-298' of https://github.com/Automattic/woocommerce-services into fix/issue-wootax-298

Author: iyut

tests/php/test-woocommerce-connect-client.php

@@ -286,12 +286,21 @@ public function test_extend_store_api_skips_registration_when_store_api_unavaila
 	}
 
 	/**
-	 * is_store_api_available() reflects whether the StoreApi class the plugin
-	 * depends on actually exists, so the guard tracks the real class.
+	 * is_store_api_available() returns true when the StoreApi class the plugin
+	 * depends on is present. The PHPUnit harness loads WooCommerce, so the class
+	 * exists here - pinning to true means a typo or rename in the guarded class
+	 * string would fail this test rather than silently tracking the change.
 	 *
 	 * @covers WC_Connect_Loader::is_store_api_available
 	 */
-	public function test_is_store_api_available_tracks_store_api_class() {
+	public function test_is_store_api_available_returns_true_when_store_api_class_present() {
+		// Precondition: the harness must actually load the StoreApi class for the
+		// assertion below to be meaningful.
+		$this->assertTrue(
+			class_exists( '\Automattic\WooCommerce\StoreApi\StoreApi' ),
+			'Test precondition: the StoreApi class must be loaded in the test harness.'
+		);
+
 		$sut = $this->getMockBuilder( 'WC_Connect_Loader' )
 			->disableOriginalConstructor()
 			->setMethods( null )
@@ -300,11 +309,52 @@ public function test_is_store_api_available_tracks_store_api_class() {
 		$method = new ReflectionMethod( 'WC_Connect_Loader', 'is_store_api_available' );
 		$method->setAccessible( true );
 
-		$this->assertSame(
-			class_exists( '\Automattic\WooCommerce\StoreApi\StoreApi' ),
+		$this->assertTrue(
 			$method->invoke( $sut ),
-			'is_store_api_available() should mirror the existence of the StoreApi class.'
+			'is_store_api_available() should return true when the StoreApi class is present.'
 		);
 	}
 
+	/**
+	 * On the unavailable path, extend_store_api() logs a notice - but at most
+	 * once per day, because it runs on `woocommerce_blocks_loaded` (nearly every
+	 * request). The throttle transient must suppress the second same-day call.
+	 *
+	 * @covers WC_Connect_Loader::extend_store_api
+	 * @covers WC_Connect_Loader::log_store_api_unavailable
+	 */
+	public function test_extend_store_api_logs_unavailable_notice_once_per_day() {
+		delete_transient( 'wcservices_store_api_unavailable_logged' );
+
+		// Spy logger injected via the woocommerce_logging_class filter. Returning
+		// an object bypasses wc_get_logger()'s static cache.
+		$logger = $this->getMockBuilder( 'WC_Logger_Interface' )->getMock();
+		$logger->expects( $this->once() )
+			->method( 'notice' )
+			->with(
+				'StoreApi class not found. Store API extensions will not be registered.',
+				array( 'source' => 'woocommerce-services' )
+			);
+
+		$inject_logger = function () use ( $logger ) {
+			return $logger;
+		};
+		add_filter( 'woocommerce_logging_class', $inject_logger );
+
+		$sut = $this->getMockBuilder( 'WC_Connect_Loader' )
+			->disableOriginalConstructor()
+			->setMethods( array( 'is_store_api_available', 'register_store_api_extensions' ) )
+			->getMock();
+
+		$sut->method( 'is_store_api_available' )->willReturn( false );
+		$sut->expects( $this->never() )->method( 'register_store_api_extensions' );
+
+		// First skip logs the notice; the second same-day skip is throttled.
+		$sut->extend_store_api();
+		$sut->extend_store_api();
+
+		remove_filter( 'woocommerce_logging_class', $inject_logger );
+		delete_transient( 'wcservices_store_api_unavailable_logged' );
+	}
+
 }

woocommerce-services.php

@@ -990,10 +990,7 @@ public function init_store_notices() {
 		 */
 		public function extend_store_api() {
 			if ( ! $this->is_store_api_available() ) {
-				wc_get_logger()->notice(
-					'StoreApi class not found. Store API extensions will not be registered.',
-					array( 'source' => 'woocommerce-services' )
-				);
+				$this->log_store_api_unavailable();
 				return;
 			}
 
@@ -1009,6 +1006,29 @@ protected function is_store_api_available() {
 			return class_exists( '\Automattic\WooCommerce\StoreApi\StoreApi' );
 		}
 
+		/**
+		 * Log, at most once per day, that the Store API is unavailable.
+		 *
+		 * `extend_store_api()` runs on `woocommerce_blocks_loaded`, which fires on
+		 * nearly every request. On installs missing the StoreApi class the notice
+		 * would otherwise be written on every page load, so it is throttled to once
+		 * per day via a transient.
+		 */
+		protected function log_store_api_unavailable() {
+			$transient_key = 'wcservices_store_api_unavailable_logged';
+
+			if ( get_transient( $transient_key ) ) {
+				return;
+			}
+
+			wc_get_logger()->notice(
+				'StoreApi class not found. Store API extensions will not be registered.',
+				array( 'source' => 'woocommerce-services' )
+			);
+
+			set_transient( $transient_key, 1, DAY_IN_SECONDS );
+		}
+
 		/**
 		 * Register the plugin's Store API extensions.
 		 */