Enhance/#8795 - Implement RRM findMatchedPublication() action

assets/js/modules/reader-revenue-manager/datastore/constants.js

@@ -19,3 +19,9 @@
 export const MODULES_READER_REVENUE_MANAGER = 'modules/reader-revenue-manager';
 
 export const ERROR_CODE_NON_HTTPS_SITE = 'non_https_site';
+
+export const PUBLICATION_ONBOARDING_STATES = {
+	ONBOARDING_COMPLETE: 'ONBOARDING_COMPLETE',
+	ONBOARDING_ACTION_REQUIRED: 'ONBOARDING_ACTION_REQUIRED',
+	PENDING_VERIFICATION: 'PENDING_VERIFICATION',
+};

assets/js/modules/reader-revenue-manager/datastore/publications.js

@@ -22,7 +22,10 @@
 import API from 'googlesitekit-api';
 import { commonActions, combineStores } from 'googlesitekit-data';
 import { createFetchStore } from '../../../googlesitekit/data/create-fetch-store';
-import { MODULES_READER_REVENUE_MANAGER } from './constants';
+import {
+	MODULES_READER_REVENUE_MANAGER,
+	PUBLICATION_ONBOARDING_STATES,
+} from './constants';
 
 const fetchGetPublicationsStore = createFetchStore( {
 	baseName: 'getPublications',
@@ -41,7 +44,37 @@ const baseInitialState = {
 	publications: undefined,
 };
 
-const baseActions = {};
+const baseActions = {
+	/**
+	 * Finds a matched publication.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @return {Object|null} Matched publication; `null` if none found.
+	 */
+	*findMatchedPublication() {
+		const { resolveSelect } = yield commonActions.getRegistry();
+		const publications = yield commonActions.await(
+			resolveSelect( MODULES_READER_REVENUE_MANAGER ).getPublications()
+		);
+
+		if ( publications.length === 0 ) {
+			return null;
+		}
+
+		if ( publications.length === 1 ) {
+			return publications[ 0 ];
+		}
+
+		const completedOnboardingPublication = publications.find(
+			( publication ) =>
+				publication.onboardingState ===
+				PUBLICATION_ONBOARDING_STATES.ONBOARDING_COMPLETE
+		);
+
+		return completedOnboardingPublication || publications[ 0 ];
+	},
+};
 
 const baseControls = {};
 

assets/js/modules/reader-revenue-manager/datastore/publications.test.js

@@ -25,7 +25,10 @@ import {
 	untilResolved,
 } from '../../../../../tests/js/utils';
 import * as fixtures from './__fixtures__';
-import { MODULES_READER_REVENUE_MANAGER } from './constants';
+import {
+	MODULES_READER_REVENUE_MANAGER,
+	PUBLICATION_ONBOARDING_STATES,
+} from './constants';
 
 describe( 'modules/reader-revenue-manager publications', () => {
 	let registry;
@@ -120,4 +123,71 @@ describe( 'modules/reader-revenue-manager publications', () => {
 			} );
 		} );
 	} );
+
+	describe( 'actions', () => {
+		describe( 'findMatchedPublication', () => {
+			it( 'should return null if there are no publications', async () => {
+				registry
+					.dispatch( MODULES_READER_REVENUE_MANAGER )
+					.receiveGetPublications( [] );
+
+				const publication = await registry
+					.dispatch( MODULES_READER_REVENUE_MANAGER )
+					.findMatchedPublication();
+
+				expect( publication ).toBeNull();
+			} );
+
+			it( 'should return the publication if that is the only one in the list', async () => {
+				registry
+					.dispatch( MODULES_READER_REVENUE_MANAGER )
+					.receiveGetPublications( [ fixtures.publications[ 0 ] ] );
+
+				const publication = await registry
+					.dispatch( MODULES_READER_REVENUE_MANAGER )
+					.findMatchedPublication();
+
+				expect( publication ).toEqual( fixtures.publications[ 0 ] );
+			} );
+
+			it( 'should return the publication with ONBOARDING_COMPLETE if more than one publication exists', async () => {
+				const completedOnboardingPublication =
+					fixtures.publications.find(
+						( publication ) =>
+							publication.onboardingState ===
+							PUBLICATION_ONBOARDING_STATES.ONBOARDING_COMPLETE
+					);
+
+				registry
+					.dispatch( MODULES_READER_REVENUE_MANAGER )
+					.receiveGetPublications( fixtures.publications );
+
+				const publication = await registry
+					.dispatch( MODULES_READER_REVENUE_MANAGER )
+					.findMatchedPublication();
+
+				expect( publication ).toEqual( completedOnboardingPublication );
+			} );
+
+			it( 'should return the first publication if none have ONBOARDING_COMPLETE', async () => {
+				const publications = fixtures.publications.map(
+					( publication ) => ( {
+						...publication,
+						onboardingState:
+							PUBLICATION_ONBOARDING_STATES.PENDING_VERIFICATION,
+					} )
+				);
+
+				registry
+					.dispatch( MODULES_READER_REVENUE_MANAGER )
+					.receiveGetPublications( publications );
+
+				const publication = await registry
+					.dispatch( MODULES_READER_REVENUE_MANAGER )
+					.findMatchedPublication();
+
+				expect( publication ).toEqual( publications[ 0 ] );
+			} );
+		} );
+	} );
 } );