wp-calypso/client/lib/analytics/tracker-buckets.ts

import { getDoNotTrack, getTrackingPrefs } from '@automattic/calypso-analytics';
import config from '@automattic/calypso-config';
import {
	isPiiUrl,
	isUrlExcludedForPerformance,
	mayWeTrackUserGpcInCcpaRegion,
	mayWeSessionTrack,
	getExceptions,
} from 'calypso/lib/analytics/utils';
import { isE2ETest } from 'calypso/lib/e2e';

const allAdTrackers = [
	'bing',
	'floodlight',
	'googleAds',
	'googleTagManager',
	'ga',
	'gaEnhancedEcommerce',
	'hotjar',
	'outbrain',
	'pinterest',
	'twitter',
	'facebook',
	'quantcast',
	'gemini',
	'experian',
	'iconMedia',
	'linkedin',
	'logrocket',
	'criteo',
	'pandora',
	'quora',
	'adroll',
	'parsely',
	'clarity',
	'reddit',
] as const;

const sessionAdTrackers = [ 'hotjar', 'logrocket' ];

export type AdTracker = ( typeof allAdTrackers )[ number ];

export enum Bucket {
	ESSENTIAL = 'essential',
	ADVERTISING = 'advertising',
	ANALYTICS = 'analytics',
}

export const AdTrackersBuckets: { [ key in AdTracker ]: Bucket | null } = {
	// Analytics trackers:
	parsely: Bucket.ANALYTICS,

	// Advertising trackers:
	ga: Bucket.ADVERTISING,
	gaEnhancedEcommerce: Bucket.ADVERTISING,
	hotjar: Bucket.ADVERTISING,
	bing: Bucket.ADVERTISING,
	floodlight: Bucket.ADVERTISING,
	googleAds: Bucket.ADVERTISING,
	googleTagManager: Bucket.ADVERTISING,
	logrocket: Bucket.ADVERTISING,
	twitter: Bucket.ADVERTISING,
	facebook: Bucket.ADVERTISING,
	reddit: Bucket.ADVERTISING,
	linkedin: Bucket.ADVERTISING,

	// Disabled trackers:
	quantcast: null,
	gemini: null,
	experian: null,
	iconMedia: null,
	criteo: null,
	pandora: null,
	quora: null,
	adroll: null,
	clarity: null,
	outbrain: null,
	pinterest: null,
};

const checkGtagInit = (): boolean => 'dataLayer' in window && 'gtag' in window;

const checkGtmInit = (): boolean => {
	return 'dataLayer' in window && 'google_tag_manager' in window;
};

export const AdTrackersInitGuards: Partial< { [ key in AdTracker ]: () => boolean } > = {
	ga: checkGtagInit,
	gaEnhancedEcommerce: checkGtagInit,
	floodlight: checkGtagInit,
	googleAds: checkGtagInit,
	googleTagManager: checkGtmInit,
	bing: () => 'uetq' in window,
	outbrain: () => 'obApi' in window,
	pinterest: () => 'pintrk' in window,
	twitter: () => 'twq' in window,
	facebook: () => 'fbq' in window,
	linkedin: () => '_linkedin_data_partner_ids' in window && 'lintrk' in window,
	criteo: () => 'criteo_q' in window,
	quora: () => 'qp' in window,
	adroll: () => 'adRoll' in window,
	clarity: () => 'clarity' in window,
	reddit: () => 'rdt' in window,
};

const isTrackerIntialized = ( tracker: AdTracker ): boolean => {
	const guardFunction = AdTrackersInitGuards[ tracker ];
	// If there is no guard function, skip the check
	return guardFunction ? guardFunction() : true;
};

export const mayWeTrackGeneral = () =>
	! isE2ETest() && ! getDoNotTrack() && ! isPiiUrl() && config.isEnabled( 'ad-tracking' );

export const mayWeTrackByBucket = ( bucket: Bucket ) => {
	if ( ! mayWeTrackGeneral() ) {
		return false;
	}

	if ( Bucket.ADVERTISING === bucket ) {
		// Disable advertising trackers on specific urls
		if ( isUrlExcludedForPerformance() ) {
			return false;
		}
		// Disable advertising trackers if GPC browser flag is set, and the user location pertains to CCPA.
		if ( ! mayWeTrackUserGpcInCcpaRegion() ) {
			return false;
		}
	}

	const prefs = getTrackingPrefs();
	return prefs.ok && prefs.buckets[ bucket ];
};

export const mayWeInitTracker = ( tracker: AdTracker ) => {
	const exceptions = getExceptions();

	if ( exceptions[ tracker ] ) {
		return false;
	}

	const bucket = AdTrackersBuckets[ tracker ];
	return null !== bucket && mayWeTrackByBucket( bucket );
};

export const mayWeTrackByTracker = ( tracker: AdTracker ) => {
	const mayTrackerInit = mayWeInitTracker( tracker ) && isTrackerIntialized( tracker );

	if ( sessionAdTrackers.includes( tracker ) ) {
		return mayWeSessionTrack() && mayTrackerInit;
	}

	return mayTrackerInit;
};