Release 2.6.4

.github/workflows/php-unit-tests.yml

@@ -16,13 +16,25 @@ on:
       - composer.json
       - composer.lock
       - .github/workflows/php-unit-tests.yml
-
+  workflow_dispatch:
+    inputs:
+      php-version:
+        description: 'PHP Version'
+        default: '8.2'
+      wp-rc-version:
+        description: 'WordPress version for Release Candidate (ex. 6.5-RC3)'
+        default: 'latest'
+      wc-rc-version:
+        description: 'WooCommerce version for Release Candidate (ex. 8.7.0-rc.1)'
+        default: 'latest'
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
   GetMatrix:
+    if: github.event_name != 'workflow_dispatch'
     name: Get WP and WC version Matrix
     runs-on: ubuntu-latest
     outputs:
@@ -42,12 +54,14 @@ jobs:
           slug: woocommerce
 
   UnitTests:
+    if: github.event_name != 'workflow_dispatch'
     name: PHP unit tests - PHP ${{ matrix.php }}, WP ${{ matrix.wp-version || 'latest' }}, WC ${{ matrix.wc-versions || 'latest' }}
     needs: GetMatrix
     runs-on: ubuntu-latest
     env:
       WP_CORE_DIR: "/tmp/wordpress/src"
       WP_TESTS_DIR: "/tmp/wordpress/tests/phpunit"
+      generate_coverage: 'false'
     strategy:
       matrix:
         php: [ 8.2 ]
@@ -96,3 +110,30 @@ jobs:
           files: tests/php-coverage/report.xml
           flags: php-unit-tests
           name: php-coverage-report
+
+  ReleaseCandidateUnitTests:
+    if: github.event_name == 'workflow_dispatch'
+    name: PHP unit tests (for Release Candidates)
+    runs-on: ubuntu-latest
+    env:
+      WP_CORE_DIR: "/tmp/wordpress/src"
+      WP_TESTS_DIR: "/tmp/wordpress/tests/phpunit"
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Prepare PHP
+        uses: woocommerce/grow/prepare-php@actions-v1
+        with:
+          php-version: "${{ inputs.php-version }}"
+
+      - name: Prepare MySQL
+        uses: woocommerce/grow/prepare-mysql@actions-v1
+
+      - name: Install WP tests
+        run: ./bin/install-wp-tests.sh wordpress_test root root localhost ${{ inputs.wp-rc-version }} ${{ inputs.wc-rc-version }}
+
+      - name: Run PHP unit tests
+        run: composer test-unit
+

changelog.txt

@@ -1,5 +1,12 @@
 *** WooCommerce Google Listings and Ads Changelog ***
 
+= 2.6.4 - 2024-03-26 =
+* Add - Filter WC REST API responses for gla_syncable param.
+* Add - Missing functions for the WPCOM OAuth flow.
+* Add - Notify when product changes.
+* Dev - Add a manual workflow run for PHP unit tests.
+* Update - Refactor Product Stats.
+
 = 2.6.3 - 2024-03-19 =
 * Fix - Handle parse JSON exception when Creating Ads Account.
 * Fix - Inline Javascript encoding for gtag events.

google-listings-and-ads.php

@@ -3,7 +3,7 @@
  * Plugin Name: Google Listings and Ads
  * Plugin URL: https://wordpress.org/plugins/google-listings-and-ads/
  * Description: Native integration with Google that allows merchants to easily display their products across Google’s network.
- * Version: 2.6.3
+ * Version: 2.6.4
  * Author: WooCommerce
  * Author URI: https://woo.com/
  * Text Domain: google-listings-and-ads
@@ -30,7 +30,7 @@
 
 defined( 'ABSPATH' ) || exit;
 
-define( 'WC_GLA_VERSION', '2.6.3' ); // WRCS: DEFINED_VERSION.
+define( 'WC_GLA_VERSION', '2.6.4' ); // WRCS: DEFINED_VERSION.
 define( 'WC_GLA_MIN_PHP_VER', '7.4' );
 define( 'WC_GLA_MIN_WC_VER', '6.9' );
 

js/src/data/actions.js

@@ -106,7 +106,9 @@ import { adaptAdsCampaign } from './adapters';
  * @typedef {Object} ProductStatistics
  * @property {number} scheduled_sync Number of scheduled jobs which will sync products to Google.
  * @property {number} timestamp Timestamp reflecting when the product status statistics were last generated.
- * @property {ProductStatisticsDetails} statistics Statistics information of product status on Google Merchant Center.
+ * @property {boolean} loading Whether the product status statistics are being loaded.
+ * @property {string | null} error In case of error, it will contain the error message.
+ * @property {ProductStatisticsDetails | null } statistics Statistics information of product status on Google Merchant Center or null if the stats are loading.
  */
 
 /**

js/src/hooks/useMCProductStatistics.js

@@ -1,15 +1,76 @@
+/**
+ * External dependencies
+ */
+import { useEffect, useCallback } from '@wordpress/element';
+
 /**
  * Internal dependencies
  */
-import useAppSelectDispatch from '.~/hooks/useAppSelectDispatch';
+import useAppSelectDispatch from './useAppSelectDispatch';
+import useCountdown from './useCountdown';
+import useApiFetchCallback from '.~/hooks/useApiFetchCallback';
+import { useAppDispatch } from '.~/data';
 
 /**
  * Call `useAppSelectDispatch` with `"getMCProductStatistics"`.
+ * If the background process is loading, start a countdown and invalidate  the resolution for getMCProductStatistics and getMCProductFeed.
  *
  * @return {useAppSelectDispatch} Result of useAppSelectDispatch.
  */
 const useMCProductStatistics = () => {
-	return useAppSelectDispatch( 'getMCProductStatistics' );
+	const { second, callCount, startCountdown } = useCountdown();
+	const { invalidateResolutionForStoreSelector } = useAppDispatch();
+	const { data, hasFinishedResolution, invalidateResolution, ...rest } =
+		useAppSelectDispatch( 'getMCProductStatistics' );
+
+	// Weather the AS job is still processing the data.
+	const isCalculatingStats =
+		hasFinishedResolution && data?.loading ? true : false;
+	const hasStats = hasFinishedResolution && data?.statistics ? true : false;
+
+	const [ refreshProductStats ] = useApiFetchCallback( {
+		path: `/wc/gla/mc/product-statistics/refresh`,
+		method: 'GET',
+	} );
+
+	const refreshStats = useCallback( async () => {
+		await refreshProductStats();
+		invalidateResolution();
+	}, [ refreshProductStats, invalidateResolution ] );
+
+	useEffect( () => {
+		// If the job is still processing the data, start the countdown.
+		if ( isCalculatingStats && second === 0 ) {
+			startCountdown( 15 );
+			// After the countdown started and the job is still processing the data, invalidate the resolution/refetch the data to get the latest status.
+			if ( callCount > 0 ) {
+				invalidateResolution();
+			}
+		}
+
+		// Stop the countdown when the data is loaded.
+		if ( hasStats && callCount > 0 ) {
+			startCountdown( 0 );
+			// Refresh the product feed data so product statuses are updated.
+			invalidateResolutionForStoreSelector( 'getMCProductFeed' );
+		}
+	}, [
+		second,
+		callCount,
+		isCalculatingStats,
+		hasStats,
+		invalidateResolution,
+		invalidateResolutionForStoreSelector,
+		startCountdown,
+	] );
+
+	return {
+		data,
+		invalidateResolution,
+		hasFinishedResolution,
+		refreshStats,
+		...rest,
+	};
 };
 
 export default useMCProductStatistics;

js/src/hooks/useMCProductStatistics.test.js

@@ -0,0 +1,183 @@
+/**
+ * External dependencies
+ */
+import { renderHook } from '@testing-library/react-hooks';
+
+/**
+ * Internal dependencies
+ */
+import useMCProductStatistics from '.~/hooks/useMCProductStatistics';
+import useCountdown from '.~/hooks/useCountdown';
+import useAppSelectDispatch from '.~/hooks/useAppSelectDispatch';
+import { useAppDispatch } from '.~/data';
+import useApiFetchCallback from '.~/hooks/useApiFetchCallback';
+
+jest.mock( '.~/hooks/useAppSelectDispatch' );
+jest.mock( '.~/hooks/useCountdown' );
+jest.mock( '.~/data' );
+jest.mock( '.~/hooks/useApiFetchCallback', () => ( {
+	__esModule: true,
+	default: jest.fn().mockImplementation( () => {
+		return [ jest.fn(), null ];
+	} ),
+} ) );
+
+describe( 'useMCProductStatistics', () => {
+	const startCountdown = jest.fn();
+	const invalidateResolution = jest.fn();
+	const invalidateResolutionForStoreSelector = jest.fn();
+
+	useAppDispatch.mockImplementation( () => {
+		return {
+			invalidateResolutionForStoreSelector,
+		};
+	} );
+
+	const statsData = {
+		loading: false,
+		statistics: {
+			active: 10,
+			expiring: 20,
+			pending: 30,
+			disapproved: 2132,
+			not_synced: 1074,
+		},
+		error: null,
+	};
+
+	describe( 'The update_merchant_product_statuses job is completed', () => {
+		beforeAll( () => {
+			jest.clearAllMocks();
+		} );
+
+		it( 'The response contains the statistics', () => {
+			useCountdown.mockImplementation( () => {
+				return {
+					second: 0,
+					callCount: 0,
+					startCountdown,
+				};
+			} );
+
+			useAppSelectDispatch.mockImplementation( () => {
+				return {
+					hasFinishedResolution: true,
+					invalidateResolution,
+					data: statsData,
+				};
+			} );
+
+			const { result } = renderHook( () => useMCProductStatistics() );
+
+			expect( startCountdown ).not.toHaveBeenCalled();
+			expect( invalidateResolution ).not.toHaveBeenCalled();
+			expect( result.current.data ).toEqual( statsData );
+			expect( result.current.hasFinishedResolution ).toEqual( true );
+		} );
+	} );
+
+	describe( 'Retry two times until the update_merchant_product_statuses job is completed', () => {
+		beforeAll( () => {
+			jest.clearAllMocks();
+
+			useCountdown.mockImplementation( () => {
+				return {
+					second: 0,
+					callCount: 0,
+					startCountdown,
+				};
+			} );
+		} );
+		it( "The first time the job is in progress/scheduled and the response doesn't contains statistics", () => {
+			useAppSelectDispatch.mockImplementation( () => {
+				return {
+					hasFinishedResolution: true,
+					invalidateResolution,
+					data: {
+						loading: true,
+						statistics: null,
+						error: null,
+					},
+				};
+			} );
+
+			renderHook( () => useMCProductStatistics() );
+
+			expect( startCountdown ).toHaveBeenCalledTimes( 1 );
+			expect( startCountdown ).toHaveBeenCalledWith( 15 );
+			expect( invalidateResolution ).not.toHaveBeenCalled();
+		} );
+		it( 'The countdown is completed, so we invalidate the call and try again', () => {
+			useCountdown.mockImplementation( () => {
+				return {
+					second: 0,
+					callCount: 1,
+					startCountdown,
+				};
+			} );
+
+			renderHook( () => useMCProductStatistics() );
+
+			expect( startCountdown ).toHaveBeenCalledTimes( 2 );
+			expect( startCountdown ).toHaveBeenCalledWith( 15 );
+			expect( invalidateResolution ).toHaveBeenCalledTimes( 1 );
+			expect( invalidateResolution ).toHaveBeenCalledWith();
+		} );
+		it( 'The third time the job is completed and the response contains the statistics', () => {
+			useAppSelectDispatch.mockImplementation( () => {
+				return {
+					hasFinishedResolution: true,
+					invalidateResolution,
+					data: statsData,
+				};
+			} );
+
+			renderHook( () => useMCProductStatistics() );
+
+			expect( startCountdown ).toHaveBeenCalledTimes( 3 );
+			expect( startCountdown ).toHaveBeenLastCalledWith( 0 );
+			expect( invalidateResolution ).toHaveBeenCalledTimes( 1 );
+			expect( invalidateResolution ).toHaveBeenCalledWith();
+			expect(
+				invalidateResolutionForStoreSelector
+			).toHaveBeenCalledTimes( 1 );
+			expect( invalidateResolutionForStoreSelector ).toHaveBeenCalledWith(
+				'getMCProductFeed'
+			);
+		} );
+	} );
+	describe( 'Refresh the product statistics', () => {
+		beforeAll( () => {
+			jest.clearAllMocks();
+		} );
+		it( 'The user clicks the refresh button', async () => {
+			const refreshProductStats = jest.fn();
+			useCountdown.mockImplementation( () => {
+				return {
+					second: 0,
+					callCount: 0,
+					startCountdown,
+				};
+			} );
+
+			useAppSelectDispatch.mockImplementation( () => {
+				return {
+					hasFinishedResolution: true,
+					invalidateResolution,
+					data: statsData,
+				};
+			} );
+
+			useApiFetchCallback.mockImplementation( () => {
+				return [ refreshProductStats, null ];
+			} );
+
+			const { result } = renderHook( () => useMCProductStatistics() );
+
+			await result.current.refreshStats();
+
+			expect( refreshProductStats ).toHaveBeenCalledTimes( 1 );
+			expect( invalidateResolution ).toHaveBeenCalledTimes( 1 );
+		} );
+	} );
+} );