index.js

/**
 * Ads module initialization.
 *
 * Site Kit by Google, Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * WordPress dependencies
 */
import { __ } from '@wordpress/i18n';
import { getQueryArg } from '@wordpress/url';

/**
 * Internal dependencies
 */
import AdsIcon from '@/svg/graphics/ads.svg';
import { SettingsEdit, SettingsView } from './components/settings';
import { SetupMain } from './components/setup';
import { MODULES_ADS } from './datastore/constants';
import { MODULE_SLUG_ADS } from './constants';
import { CORE_MODULES } from '@/js/googlesitekit/modules/datastore/constants';
import {
	CORE_USER,
	ERROR_CODE_ADBLOCKER_ACTIVE,
} from '@/js/googlesitekit/datastore/user/constants';
import {
	PAXSetupSuccessSubtleNotification,
	SetupSuccessSubtleNotification,
	AccountLinkedViaGoogleForWooCommerceSubtleNotification,
	AdsModuleSetupCTABanner,
} from './components/notifications';
import {
	NOTIFICATION_GROUPS,
	NOTIFICATION_AREAS,
	PRIORITY,
} from '@/js/googlesitekit/notifications/constants';
import {
	VIEW_CONTEXT_MAIN_DASHBOARD,
	VIEW_CONTEXT_MAIN_DASHBOARD_VIEW_ONLY,
} from '@/js/googlesitekit/constants';
import { PAX_SETUP_SUCCESS_NOTIFICATION } from './pax/constants';
import EnhancedConversionsNotification, {
	ENHANCED_CONVERSIONS_NOTIFICATION_ADS,
} from './components/notifications/EnhancedConversionsNotification';
import SettingsDisconnectNote from './components/settings/SettingsDisconnectNote';

export { registerStore } from './datastore';

export function registerModule( modules ) {
	modules.registerModule( MODULE_SLUG_ADS, {
		storeName: MODULES_ADS,
		SettingsEditComponent: SettingsEdit,
		SettingsViewComponent: SettingsView,
		SetupComponent: SetupMain,
		Icon: AdsIcon,
		features: [
			__(
				'Tagging necessary for your ads campaigns to work will be disabled',
				'google-site-kit'
			),
			__(
				'Conversion tracking for your ads campaigns will be disabled',
				'google-site-kit'
			),
		],
		SettingsDisconnectNoteComponent: SettingsDisconnectNote,
		overrideSetupSuccessNotification: true,
		checkRequirements: async ( registry ) => {
			const adBlockerActive = await registry
				.resolveSelect( CORE_USER )
				.isAdBlockerActive();

			if ( ! adBlockerActive ) {
				return;
			}

			const message = registry
				.select( MODULES_ADS )
				.getAdBlockerWarningMessage();

			throw {
				code: ERROR_CODE_ADBLOCKER_ACTIVE,
				message,
				data: null,
			};
		},
	} );
}

export function registerWidgets() {}

export const ADS_NOTIFICATIONS = {
	'setup-success-notification-ads': {
		Component: SetupSuccessSubtleNotification,
		areaSlug: NOTIFICATION_AREAS.DASHBOARD_TOP,
		viewContexts: [
			VIEW_CONTEXT_MAIN_DASHBOARD,
			VIEW_CONTEXT_MAIN_DASHBOARD_VIEW_ONLY,
		],
		checkRequirements: () => {
			const notification = getQueryArg( location.href, 'notification' );
			const slug = getQueryArg( location.href, 'slug' );

			if (
				'authentication_success' === notification &&
				slug === MODULE_SLUG_ADS
			) {
				return true;
			}

			return false;
		},
	},
	'setup-success-notification-pax': {
		Component: PAXSetupSuccessSubtleNotification,
		areaSlug: NOTIFICATION_AREAS.DASHBOARD_TOP,
		viewContexts: [
			VIEW_CONTEXT_MAIN_DASHBOARD,
			VIEW_CONTEXT_MAIN_DASHBOARD_VIEW_ONLY,
		],
		checkRequirements: () => {
			const notification = getQueryArg( location.href, 'notification' );

			if ( PAX_SETUP_SUCCESS_NOTIFICATION === notification ) {
				return true;
			}

			return false;
		},
	},
	'account-linked-via-google-for-woocommerce': {
		Component: AccountLinkedViaGoogleForWooCommerceSubtleNotification,
		areaSlug: NOTIFICATION_AREAS.DASHBOARD_TOP,
		viewContexts: [ VIEW_CONTEXT_MAIN_DASHBOARD ],
		checkRequirements: async ( { select, resolveSelect } ) => {
			// isWooCommerceActivated, isGoogleForWooCommerceActivated and isGoogleForWooCommerceLinked are all relying
			// on the data being resolved in getModuleData() selector.
			const [ , isModuleConnected ] = await Promise.all( [
				resolveSelect( MODULES_ADS ).getModuleData(),
				resolveSelect( CORE_MODULES ).isModuleConnected(
					MODULE_SLUG_ADS
				),
			] );

			const {
				isWooCommerceActivated,
				isGoogleForWooCommerceActivated,
				hasGoogleForWooCommerceAdsAccount,
			} = select( MODULES_ADS );

			return (
				! isModuleConnected &&
				isWooCommerceActivated() &&
				isGoogleForWooCommerceActivated() &&
				hasGoogleForWooCommerceAdsAccount()
			);
		},
		isDismissible: true,
	},
	'ads-setup-cta': {
		Component: AdsModuleSetupCTABanner,
		// This notification should be displayed before audience segmentation one,
		// which has priority of PRIORITY.SETUP_CTA_LOW
		priority: PRIORITY.SETUP_CTA_HIGH,
		areaSlug: NOTIFICATION_AREAS.DASHBOARD_TOP,
		groupID: NOTIFICATION_GROUPS.SETUP_CTAS,
		viewContexts: [ VIEW_CONTEXT_MAIN_DASHBOARD ],
		checkRequirements: async ( { select, resolveSelect } ) => {
			await Promise.all( [
				// isGoogleForWooCommerceLinked is relying
				// on the data being resolved in getModuleData() selector.
				resolveSelect( MODULES_ADS ).getModuleData(),
				resolveSelect( CORE_MODULES ).isModuleConnected(
					MODULE_SLUG_ADS
				),
				resolveSelect( CORE_MODULES ).canActivateModule(
					MODULE_SLUG_ADS
				),
			] );

			const { isModuleConnected } = select( CORE_MODULES );
			const { hasGoogleForWooCommerceAdsAccount } = select( MODULES_ADS );

			const isAdsConnected = isModuleConnected( MODULE_SLUG_ADS );

			return (
				isAdsConnected === false &&
				hasGoogleForWooCommerceAdsAccount() === false
			);
		},
		isDismissible: true,
		dismissRetries: 1,
	},
	[ ENHANCED_CONVERSIONS_NOTIFICATION_ADS ]: {
		Component: EnhancedConversionsNotification,
		priority: PRIORITY.SETUP_CTA_HIGH,
		areaSlug: NOTIFICATION_AREAS.DASHBOARD_TOP,
		groupID: NOTIFICATION_GROUPS.SETUP_CTAS,
		viewContexts: [ VIEW_CONTEXT_MAIN_DASHBOARD ],
		checkRequirements: async ( { resolveSelect } ) => {
			const adsConnected = await resolveSelect(
				CORE_MODULES
			).isModuleConnected( MODULE_SLUG_ADS );

			if ( ! adsConnected ) {
				return false;
			}

			return true;
		},
		isDismissible: true,
		featureFlag: 'gtagUserData',
	},
};

export function registerNotifications( notifications ) {
	for ( const notificationID in ADS_NOTIFICATIONS ) {
		notifications.registerNotification(
			notificationID,
			ADS_NOTIFICATIONS[ notificationID ]
		);
	}
}