tracking.js

import { debounce } from '@wordpress/compose';
import { use, select } from '@wordpress/data';
import { applyFilters } from '@wordpress/hooks';
import { __ } from '@wordpress/i18n';
import { registerPlugin } from '@wordpress/plugins';
import debugFactory from 'debug';
import { find, isEqual, cloneDeep } from 'lodash';
import delegateEventTracking, {
	registerSubscriber as registerDelegateEventSubscriber,
} from './tracking/delegate-event-tracking';
import tracksRecordEvent from './tracking/track-record-event';
import {
	buildGlobalStylesContentEvents,
	getFlattenedBlockNames,
	getBlockEventContextProperties,
	findSavingSource,
} from './utils';

const INSERTERS = {
	HEADER_INSERTER: 'header-inserter',
	SLASH_INSERTER: 'slash-inserter',
	QUICK_INSERTER: 'quick-inserter',
	BLOCK_SWITCHER: 'block-switcher',
	PAYMENTS_INTRO_BLOCK: 'payments-intro-block',
	PATTERNS_EXPLORER: 'patterns-explorer',
	PATTERN_SELECTION_MODAL: 'pattern-selection-modal',
};

const SELECTORS = {
	/**
	 * Explore all patterns modal
	 */
	PATTERNS_EXPLORER: '.block-editor-block-patterns-explorer',
	PATTERNS_EXPLORER_SELECTED_CATEGORY:
		'.block-editor-block-patterns-explorer__sidebar__categories-list__item.is-pressed',
	PATTERNS_EXPLORER_SEARCH_INPUT: '.block-editor-block-patterns-explorer__search input',

	/**
	 * Pattern Inserter
	 */
	PATTERN_INSERTER_SELECTED_CATEGORY: '.block-editor-inserter__patterns-selected-category',
	PATTERN_INSERTER_SEARCH_INPUT: '.block-editor-inserter__search input',

	/**
	 * Pattern Selection Modal
	 */
	PATTERN_SELECTION_MODAL: '.block-library-query-pattern__selection-modal',
	PATTERN_SELECTION_MODAL_SEARCH_INPUT: '.block-library-query-pattern__selection-search input',

	/**
	 * Quick Inserter
	 */
	QUICK_INSERTER: '.block-editor-inserter__quick-inserter',
	QUICK_INSERTER_SEARCH_INPUT: '.block-editor-inserter__quick-inserter input',

	/**
	 * Legacy block inserter
	 */
	LEGACY_BLOCK_INSERTER: '.block-editor-inserter__block-list',

	/**
	 * Command Palette
	 */
	COMMAND_PALETTE_ROOT: '.commands-command-menu__container div[cmdk-root]',
	COMMAND_PALETTE_INPUT: '.commands-command-menu__container input[cmdk-input]',
	COMMAND_PALETTE_LIST: '.commands-command-menu__container div[cmdk-list]',
};

// Debugger.
const debug = debugFactory( 'wpcom-block-editor:tracking' );

const noop = () => {};

let ignoreNextReplaceBlocksAction = false;

/**
 * Global handler.
 * Use this function when you need to inspect the block
 * to get specific data and populate the record.
 * @param {Object} block - Block object data.
 * @returns {Object} Record properties object.
 */
function globalEventPropsHandler( block ) {
	if ( ! block?.name ) {
		return {};
	}

	// `getActiveBlockVariation` selector is only available since Gutenberg 10.6.
	// To avoid errors, we make sure the selector exists. If it doesn't,
	// then we fallback to the old way.
	const { getActiveBlockVariation } = select( 'core/blocks' );
	if ( getActiveBlockVariation ) {
		return {
			variation_slug: getActiveBlockVariation( block.name, block.attributes )?.name,
		};
	}

	// Pick up variation slug from `core/embed` block.
	if ( block.name === 'core/embed' && block?.attributes?.providerNameSlug ) {
		return { variation_slug: block.attributes.providerNameSlug };
	}

	// Pick up variation slug from `core/social-link` block.
	if ( block.name === 'core/social-link' && block?.attributes?.service ) {
		return { variation_slug: block.attributes.service };
	}

	return {};
}
/**
 * Looks up the block name based on its id.
 * @param {string} blockId Block identifier.
 * @returns {string|null} Block name if it exists. Otherwise, `null`.
 */
const getTypeForBlockId = ( blockId ) => {
	const block = select( 'core/block-editor' ).getBlock( blockId );
	return block ? block.name : null;
};

/**
 * Guess which inserter was used to insert/replace blocks.
 * @param {string[]|string} originalBlockIds ids or blocks that are being replaced
 * @returns {'header-inserter'|'slash-inserter'|'quick-inserter'|'block-switcher'|'payments-intro-block'|'patterns-explorer'|'pattern-selection-modal'|undefined} ID representing the insertion method that was used
 */
const getBlockInserterUsed = ( originalBlockIds = [] ) => {
	const clientIds = Array.isArray( originalBlockIds ) ? originalBlockIds : [ originalBlockIds ];

	if ( document.querySelector( SELECTORS.PATTERNS_EXPLORER ) ) {
		return INSERTERS.PATTERNS_EXPLORER;
	}

	// Check if the main inserter (opened using the [+] button in the header) is open.
	// If it is then the block was inserted using this menu. This inserter closes
	// automatically when the user tries to use another form of block insertion
	// (at least at the time of writing), which is why we can rely on this method.
	if (
		select( 'core/edit-post' )?.isInserterOpened() ||
		select( 'core/edit-site' )?.isInserterOpened() ||
		select( 'core/edit-widgets' )?.isInserterOpened() ||
		document
			.querySelector( '.customize-widgets-layout__inserter-panel' )
			?.contains( document.activeElement )
	) {
		return INSERTERS.HEADER_INSERTER;
	}

	// The block switcher open state is not stored in Redux, it's component state
	// inside a <Dropdown>, so we can't access it. Work around this by checking if
	// the DOM elements are present on the page while the block is being replaced.
	if ( clientIds.length && document.querySelector( '.block-editor-block-switcher__container' ) ) {
		return INSERTERS.BLOCK_SWITCHER;
	}

	// Inserting a block using a slash command is always a block replacement of
	// a paragraph block. Checks the block contents to see if it starts with '/'.
	// This check must go _after_ the block switcher check because it's possible
	// for the user to type something like "/abc" that matches no block type and
	// then use the block switcher, and the following tests would incorrectly capture
	// that case too.
	if (
		clientIds.length === 1 &&
		select( 'core/block-editor' ).getBlockName( clientIds[ 0 ] ) === 'core/paragraph' &&
		select( 'core/block-editor' ).getBlockAttributes( clientIds[ 0 ] ).content.startsWith( '/' )
	) {
		return INSERTERS.SLASH_INSERTER;
	}

	// The quick inserter open state is not stored in Redux, it's component state
	// inside a <Dropdown>, so we can't access it. Work around this by checking if
	// the DOM elements are present on the page while the block is being inserted.
	if (
		// The new quick-inserter UI, marked as __experimental
		document.querySelector( SELECTORS.QUICK_INSERTER ) ||
		// Legacy block inserter UI
		document.querySelector( SELECTORS.LEGACY_BLOCK_INSERTER )
	) {
		return INSERTERS.QUICK_INSERTER;
	}

	// This checks validates if we are inserting a block from the Payments Inserter block.
	if (
		clientIds.length === 1 &&
		select( 'core/block-editor' ).getBlockName( clientIds[ 0 ] ) === 'jetpack/payments-intro'
	) {
		return INSERTERS.PAYMENTS_INTRO_BLOCK;
	}

	if ( document.querySelector( SELECTORS.PATTERN_SELECTION_MODAL ) ) {
		return INSERTERS.PATTERN_SELECTION_MODAL;
	}

	return undefined;
};

/**
 * Get the search term from the inserter.
 * @param {string} inserter
 * @returns {string} The search term
 */
const getBlockInserterSearchTerm = ( inserter ) => {
	let searchInput;

	switch ( inserter ) {
		case INSERTERS.PATTERNS_EXPLORER:
			searchInput = document.querySelector( SELECTORS.PATTERNS_EXPLORER_SEARCH_INPUT );
			break;
		case INSERTERS.HEADER_INSERTER:
			searchInput = document.querySelector( SELECTORS.PATTERN_INSERTER_SEARCH_INPUT );
			break;
		case INSERTERS.QUICK_INSERTER:
			searchInput = document.querySelector( SELECTORS.QUICK_INSERTER_SEARCH_INPUT );
			break;
		case INSERTERS.PATTERN_SELECTION_MODAL:
			searchInput = document.querySelector( SELECTORS.PATTERN_SELECTION_MODAL_SEARCH_INPUT );
			break;
	}

	return searchInput ? searchInput.value : '';
};

/**
 * Ensure you are working with block object. This either returns the object
 * or tries to lookup the block by id.
 * @param {string | Object} block Block object or string identifier.
 * @returns {Object} block object or an empty object if not found.
 */
const ensureBlockObject = ( block ) => {
	if ( typeof block === 'object' ) {
		return block;
	}
	return select( 'core/block-editor' ).getBlock( block ) || {};
};

/**
 * This helper function tracks the given blocks recursively
 * in order to track inner blocks.
 *
 * The event properties will be populated (optional)
 * propertiesHandler function. It acts as a callback
 * passing two arguments: the current block and
 * the parent block (if exists). Take this as
 * an advantage to add other custom properties to the event.
 *
 * Also, it adds default `inner_block`,
 * and `parent_block_client_id` (if parent exists) properties.
 * @param {Array}    blocks            Block instances object or an array of such objects
 * @param {string}   eventName         Event name used to track.
 * @param {Function} propertiesHandler Callback function to populate event properties
 * @param {Object}   parentBlock       parent block. optional.
 * @returns {void}
 */
function trackBlocksHandler( blocks, eventName, propertiesHandler = noop, parentBlock ) {
	const castBlocks = Array.isArray( blocks ) ? blocks : [ blocks ];
	if ( ! castBlocks || ! castBlocks.length ) {
		return;
	}

	castBlocks.forEach( ( block ) => {
		// Make this compatible with actions that pass only block id, not objects.
		block = ensureBlockObject( block );

		const eventProperties = {
			...globalEventPropsHandler( block ),
			...propertiesHandler( block, parentBlock ),
			inner_block: !! parentBlock,
		};

		if ( parentBlock ) {
			eventProperties.parent_block_name = parentBlock.name;
		}

		tracksRecordEvent( eventName, eventProperties );

		if ( block.innerBlocks && block.innerBlocks.length ) {
			trackBlocksHandler( block.innerBlocks, eventName, propertiesHandler, block );
		}
	} );
}

/**
 * A lot of actions accept either string (block id)
 * or an array of multiple string when operating with multiple blocks selected.
 * This is a convenience method that processes the first argument of the action (blocks)
 * and calls your tracking for each of the blocks involved in the action.
 *
 * This method tracks only blocks explicitly listed as a target of the action.
 * If you also want to track an event for all child blocks, use `trackBlocksHandler`.
 * @see {@link trackBlocksHandler} for a recursive version.
 * @param {string} eventName event name
 * @returns {Function} track handler
 */
const getBlocksTracker = ( eventName ) => ( blockIds, fromRootClientId, toRootClientId ) => {
	const blockIdArray = Array.isArray( blockIds ) ? blockIds : [ blockIds ];

	const fromContext = getBlockEventContextProperties( fromRootClientId );
	const toContext = getBlockEventContextProperties( toRootClientId );

	if ( toRootClientId === undefined || isEqual( fromContext, toContext ) ) {
		// track separately for each block
		blockIdArray.forEach( ( blockId ) => {
			tracksRecordEvent( eventName, {
				block_name: getTypeForBlockId( blockId ),
				...fromContext,
			} );
		} );
	} else {
		const fromProps = {};
		const toProps = {};
		for ( const key of Object.keys( fromContext ) ) {
			fromProps[ `from_${ key }` ] = fromContext[ key ];
		}
		for ( const key of Object.keys( toContext ) ) {
			toProps[ `from_${ key }` ] = toContext[ key ];
		}
		// track separately for each block
		blockIdArray.forEach( ( blockId ) => {
			tracksRecordEvent( eventName, {
				block_name: getTypeForBlockId( blockId ),
				...fromProps,
				...toProps,
			} );
		} );
	}
};

/**
 * Determines whether a block pattern has been inserted and if so, records
 * a track event for it. The recorded event will also reflect whether the
 * inserted pattern replaced blocks.
 * @param {Array} actionData Data supplied to block insertion or replacement tracking functions.
 * @param {Object} additionalData Additional information.
 * @returns {Object|null} The inserted pattern with its name and category if available.
 */
const maybeTrackPatternInsertion = ( actionData, additionalData ) => {
	const { rootClientId, blocks_replaced, insert_method, search_term } = additionalData;
	const context = getBlockEventContextProperties( rootClientId );
	const { __experimentalBlockPatternCategories: patternCategories } =
		select( 'core/block-editor' ).getSettings();
	const patterns = select( 'core/block-editor' ).__experimentalGetAllowedPatterns();

	const meta = find( actionData, ( item ) => item?.patternName );
	let patternName = meta?.patternName;
	// Quick block inserter doesn't use an object to store the patternName
	// in the metadata. The pattern name is just directly used as a string.
	if ( ! patternName ) {
		const actionDataToCheck = Object.values( actionData ).filter(
			( data ) => typeof data === 'string'
		);
		const foundPattern = patterns.find( ( pattern ) => actionDataToCheck.includes( pattern.name ) );
		if ( foundPattern ) {
			patternName = foundPattern.name;
		}
	}

	if ( patternName ) {
		const categoryElement =
			document.querySelector( SELECTORS.PATTERNS_EXPLORER_SELECTED_CATEGORY ) ||
			document.querySelector( SELECTORS.PATTERN_INSERTER_SELECTED_CATEGORY );

		const patternCategory = patternCategories.find(
			( { label } ) => label === categoryElement?.ariaLabel
		);

		tracksRecordEvent( 'wpcom_pattern_inserted', {
			pattern_name: patternName,
			pattern_category: patternCategory?.name,
			blocks_replaced,
			insert_method,
			search_term,
			is_user_created: patternName?.startsWith( 'core/block/' ),
			...context,
		} );

		return {
			name: patternName,
			categoryName: patternCategory?.name,
		};
	}

	return null;
};

/**
 * Track block insertion.
 * @param {Object | Array} blocks block instance object or an array of such objects
 * @param {Array} args additional insertBlocks data e.g. metadata containing pattern name.
 * @returns {void}
 */
const trackBlockInsertion = ( blocks, ...args ) => {
	const [ , rootClientId ] = args;
	const insert_method = getBlockInserterUsed();
	const search_term = getBlockInserterSearchTerm( insert_method );
	const insertedPattern = maybeTrackPatternInsertion( args, {
		rootClientId,
		blocks_replaced: false,
		insert_method,
		search_term,
	} );
	const context = getBlockEventContextProperties( rootClientId );

	trackBlocksHandler( blocks, 'wpcom_block_inserted', ( { name } ) => ( {
		block_name: name,
		blocks_replaced: false,
		pattern_name: insertedPattern?.name,
		pattern_category: insertedPattern?.categoryName,
		insert_method,
		search_term,
		...context,
	} ) );
};

/**
 * Track block removal.
 * @param {Object | Array} blocks block instance object or an array of such objects
 * @returns {void}
 */
const trackBlockRemoval = ( blocks ) => {
	const rootClientId = select( 'core/block-editor' ).getBlockRootClientId(
		Array.isArray( blocks ) ? blocks[ 0 ] : blocks
	);
	const context = getBlockEventContextProperties( rootClientId );
	trackBlocksHandler( blocks, 'wpcom_block_deleted', ( { name } ) => ( {
		block_name: name,
		...context,
	} ) );
};

/**
 * Track block replacement.
 * @param {Array} originalBlockIds ids or blocks that are being replaced
 * @param {Object | Array} blocks block instance object or an array of such objects
 * @param {Array} args Additional data supplied to replaceBlocks action
 * @returns {void}
 */
const trackBlockReplacement = ( originalBlockIds, blocks, ...args ) => {
	if ( ignoreNextReplaceBlocksAction ) {
		ignoreNextReplaceBlocksAction = false;
		return;
	}

	const rootClientId = select( 'core/block-editor' ).getBlockRootClientId(
		Array.isArray( originalBlockIds ) ? originalBlockIds[ 0 ] : originalBlockIds
	);
	const insert_method = getBlockInserterUsed( originalBlockIds );
	const search_term = getBlockInserterSearchTerm( insert_method );
	const insertedPattern = maybeTrackPatternInsertion( args, {
		rootClientId,
		blocks_replaced: true,
		insert_method,
		search_term,
	} );
	const context = getBlockEventContextProperties( rootClientId );

	trackBlocksHandler( blocks, 'wpcom_block_picker_block_inserted', ( { name } ) => ( {
		block_name: name,
		blocks_replaced: true,
		pattern_name: insertedPattern?.name,
		pattern_category: insertedPattern?.categoryName,
		insert_method,
		search_term,
		...context,
	} ) );
};

/**
 * Track inner blocks replacement.
 * Page Templates insert their content into the page replacing everything that was already there.
 * @param {Array} rootClientId id of parent block
 * @param {Object | Array} blocks block instance object or an array of such objects
 * @returns {void}
 */
const trackInnerBlocksReplacement = ( rootClientId, blocks ) => {
	/*
		We are ignoring `replaceInnerBlocks` action for template parts and
		reusable blocks for the following reasons:

		1. Template Parts and Reusable Blocks are asynchronously loaded blocks.
		   Content is fetched from the REST API so the inner blocks are
		   populated when the response is received. We want to ignore
		   `replaceInnerBlocks` action calls when the `innerBlocks` are replaced
		   because the template part or reusable block just loaded.

		2. Having multiple instances of the same template part or reusable block
		   and making edits to a single instance will cause all the other instances
		   to update via `replaceInnerBlocks`.

		3. Performing undo or redo related to template parts and reusable blocks
		   will update the instances via `replaceInnerBlocks`.
	*/
	const parentBlock = select( 'core/block-editor' ).getBlocksByClientId( rootClientId )?.[ 0 ];
	if ( parentBlock ) {
		const { name } = parentBlock;
		if (
			// Template Part
			name === 'core/template-part' ||
			// Reusable Block
			name === 'core/block' ||
			// Post Content
			name === 'core/post-content'
		) {
			return;
		}
	}
	const context = getBlockEventContextProperties( rootClientId );

	trackBlocksHandler( blocks, 'wpcom_block_inserted', ( { name } ) => ( {
		block_name: name,
		blocks_replaced: true,
		// isInsertingPagePattern filter is set by Starter Page Templates.
		// Also support isInsertingPageTemplate filter as this was used in older ETK versions.
		from_template_selector:
			applyFilters( 'isInsertingPagePattern', false ) ||
			applyFilters( 'isInsertingPageTemplate', false ),
		...context,
	} ) );
};

/**
 * Track update and publish action for Global Styles plugin.
 * @param {string} eventName Name of the track event.
 * @returns {Function} tracker
 */
const trackGlobalStyles = ( eventName ) => ( options ) => {
	tracksRecordEvent( eventName, {
		...options,
	} );
};

/**
 * Logs any error notice which is shown to the user so we can determine how often
 * folks see different errors and what types of sites they occur on.
 * @param {string} content The error message. Like "Update failed."
 * @param {Object} options Optional. Extra data logged with the error in Gutenberg.
 */
const trackErrorNotices = ( content, options ) =>
	tracksRecordEvent( 'wpcom_gutenberg_error_notice', {
		notice_text: content,
		notice_options: JSON.stringify( options ), // Returns undefined if options is undefined.
	} );

const trackEnableComplementaryArea = ( scope, id ) => {
	const activeArea = select( 'core/interface' ).getActiveComplementaryArea( scope );
	// We are tracking both global styles open here and when global styles
	// is closed by opening another sidebar in its place.
	if ( activeArea !== 'edit-site/global-styles' && id === 'edit-site/global-styles' ) {
		tracksRecordEvent( 'wpcom_block_editor_global_styles_panel_toggle', {
			open: true,
		} );
	} else if ( activeArea === 'edit-site/global-styles' && id !== 'edit-site/global-styles' ) {
		tracksRecordEvent( 'wpcom_block_editor_global_styles_panel_toggle', {
			open: false,
		} );
	}
};

const trackDisableComplementaryArea = ( scope ) => {
	const activeArea = select( 'core/interface' ).getActiveComplementaryArea( scope );
	if ( activeArea === 'edit-site/global-styles' && scope === 'core/edit-site' ) {
		tracksRecordEvent( 'wpcom_block_editor_global_styles_panel_toggle', {
			open: false,
		} );
	}
};

const trackSaveEntityRecord = ( kind, name, record ) => {
	if ( kind === 'postType' && name === 'wp_template_part' ) {
		const variationSlug = record.area !== 'uncategorized' ? record.area : undefined;
		if ( document.querySelector( '.edit-site-create-template-part-modal' ) ) {
			ignoreNextReplaceBlocksAction = true;
			const convertedParentBlocks = select( 'core/block-editor' ).getBlocksByClientId(
				select( 'core/block-editor' ).getSelectedBlockClientIds()
			);
			// We fire the event with and without the block names. We do this to
			// make sure the event is tracked all the time. The block names
			// might become a string that's too long and as a result it will
			// fail because of URL length browser limitations.
			tracksRecordEvent( 'wpcom_block_editor_convert_to_template_part', {
				variation_slug: variationSlug,
			} );
			tracksRecordEvent( 'wpcom_block_editor_convert_to_template_part', {
				variation_slug: variationSlug,
				block_names: getFlattenedBlockNames( convertedParentBlocks ).join( ',' ),
			} );
		} else {
			tracksRecordEvent( 'wpcom_block_editor_create_template_part', {
				variation_slug: variationSlug,
				content: record.content ? record.content : undefined,
			} );
		}
	}
};

/**
 * Track list view open and close events.
 * @param {boolean} isOpen new state of the list view
 */
const trackListViewToggle = ( isOpen ) => {
	tracksRecordEvent( 'wpcom_block_editor_list_view_toggle', {
		is_open: isOpen,
	} );
};

const trackSiteEditorBrowsingSidebarOpen = () => {
	// We want to make sure the browsing sidebar is closed.
	// This action is triggered even if the sidebar is open
	// which we want to avoid tracking.
	const isOpen = select( 'core/edit-site' ).isNavigationOpened();
	if ( isOpen ) {
		return;
	}

	tracksRecordEvent( 'wpcom_block_editor_nav_sidebar_open' );
};

const trackSiteEditorCreateTemplate = ( { slug } ) => {
	tracksRecordEvent( 'wpcom_block_editor_nav_sidebar_item_add', {
		item_type: 'template',
		item_slug: slug,
	} );
};

/**
 * Flag used to track the first call of tracking
 * `wpcom_block_editor_nav_sidebar_item_edit`. When the site editor is loaded
 * with query params specified to load a specific template/template part, then
 * `setTemplate`, `setTemplatePart` or `setPage` is called editor load. We don't
 * want to track the first call so we use this flag to track it.
 */
let isSiteEditorFirstSidebarItemEditCalled = false;
const trackSiteEditorChangeTemplate = ( id, slug ) => {
	if ( ! isSiteEditorFirstSidebarItemEditCalled ) {
		isSiteEditorFirstSidebarItemEditCalled = true;
		return;
	}

	tracksRecordEvent( 'wpcom_block_editor_nav_sidebar_item_edit', {
		item_type: 'template',
		item_id: id,
		item_slug: slug,
	} );
};

const trackSiteEditorChangeTemplatePart = ( id ) => {
	if ( ! isSiteEditorFirstSidebarItemEditCalled ) {
		isSiteEditorFirstSidebarItemEditCalled = true;
		return;
	}

	tracksRecordEvent( 'wpcom_block_editor_nav_sidebar_item_edit', {
		item_type: 'template_part',
		item_id: id,
	} );
};

/**
 * Variable used to track the time of the last `trackSiteEditorChange` function
 * call. This is used to debounce the function because it's called twice due to
 * a bug. We prefer the first call because that's when the
 * `getNavigationPanelActiveMenu` function returns the actual active menu.
 *
 * Keep this for backward compatibility.
 * Fixed in: https://github.com/WordPress/gutenberg/pull/33286
 */
let lastTrackSiteEditorChangeContentCall = 0;
const trackSiteEditorChangeContent = ( { type, slug } ) => {
	if ( Date.now() - lastTrackSiteEditorChangeContentCall < 50 ) {
		return;
	}

	if ( ! isSiteEditorFirstSidebarItemEditCalled ) {
		isSiteEditorFirstSidebarItemEditCalled = true;
		return;
	}

	const activeMenu = select( 'core/edit-site' ).getNavigationPanelActiveMenu();
	if ( ! type && activeMenu === 'content-categories' ) {
		type = 'taxonomy_category';
	}

	tracksRecordEvent( 'wpcom_block_editor_nav_sidebar_item_edit', {
		item_type: type,
		item_slug: slug,
	} );

	lastTrackSiteEditorChangeContentCall = Date.now();
};

/**
 * Tracks editEntityRecord for global styles updates.
 * @param {string} kind    Kind of the edited entity record.
 * @param {string} type    Name of the edited entity record.
 * @param {number} id      Record ID of the edited entity record.
 * @param {Object} updates The edits made to the record.
 */
const trackEditEntityRecord = ( kind, type, id, updates ) => {
	// When the site editor is loaded without query params specified to which
	// template or template part to load, then the `setPage`, `setTemplate` and
	// `setTemplatePart` call is skipped. In this case we want to make sure the
	// first call is tracked.
	if (
		! isSiteEditorFirstSidebarItemEditCalled &&
		kind === 'postType' &&
		( type === 'wp_template' || type === 'wp_template_part' )
	) {
		isSiteEditorFirstSidebarItemEditCalled = true;
		return;
	}

	if ( kind === 'root' && type === 'globalStyles' ) {
		const editedEntity = select( 'core' ).getEditedEntityRecord( kind, type, id );
		const entityContent = {
			settings: cloneDeep( editedEntity.settings ),
			styles: cloneDeep( editedEntity.styles ),
		};
		const updatedContent = {
			settings: cloneDeep( updates.settings ),
			styles: cloneDeep( updates.styles ),
		};

		// Sometimes a second update is triggered corresponding to no changes since the last update.
		// Therefore we must check if there is a change to avoid debouncing a valid update to a changeless update.
		if ( ! isEqual( updatedContent, entityContent ) ) {
			buildGlobalStylesContentEvents(
				updatedContent,
				entityContent,
				'wpcom_block_editor_global_styles_update'
			);
		}
	}
};

/**
 * Tracks saveEditedEntityRecord for saving various entities.
 * @param {string} kind Kind of the edited entity record.
 * @param {string} type Name of the edited entity record.
 * @param {number} id   Record ID of the edited entity record.
 */
const trackSaveEditedEntityRecord = ( kind, type, id ) => {
	const savedEntity = select( 'core' ).getEntityRecord( kind, type, id );
	const editedEntity = select( 'core' ).getEditedEntityRecord( kind, type, id );

	// If the item saved is a template part, make note of the area variation.
	const templatePartArea = type === 'wp_template_part' ? savedEntity?.area : undefined;
	// If the template parts area variation changed, add the new area classification as well.
	const newTemplatePartArea =
		type === 'wp_template_part' && savedEntity?.area !== editedEntity?.area
			? editedEntity.area
			: undefined;

	tracksRecordEvent( 'wpcom_block_editor_edited_entity_saved', {
		entity_kind: kind,
		entity_type: type,
		entity_id: id,
		saving_source: findSavingSource(),
		template_part_area: templatePartArea,
		new_template_part_area: newTemplatePartArea,
	} );

	if ( kind === 'root' && type === 'globalStyles' ) {
		const entityContent = {
			settings: cloneDeep( savedEntity.settings ),
			styles: cloneDeep( savedEntity.styles ),
		};
		const updatedContent = {
			settings: cloneDeep( editedEntity.settings ),
			styles: cloneDeep( editedEntity.styles ),
		};

		buildGlobalStylesContentEvents(
			updatedContent,
			entityContent,
			'wpcom_block_editor_global_styles_save'
		);
	}
};

/**
 * Tracks __experimentalSaveEditedEntityRecord for saving various entities. Currently this is only
 * expected to be triggered for site entity items like logo, description, and title.
 * @param {string} kind Kind of the edited entity record.
 * @param {string} type Name of the edited entity record.
 * @param {number} id   Record ID of the edited entity record.
 */
const trackSaveSpecifiedEntityEdits = ( kind, type, id, itemsToSave ) => {
	const source = findSavingSource();

	itemsToSave.forEach( ( item ) =>
		tracksRecordEvent( 'wpcom_block_editor_edited_entity_saved', {
			entity_kind: kind,
			entity_type: type,
			entity_id: id,
			saving_source: source,
			item_saved: item,
		} )
	);
};

/**
 * Track block install.
 * @param {Object} block block instance object
 * @returns {void}
 */
const trackInstallBlockType = ( block ) => {
	tracksRecordEvent( 'wpcom_block_directory_install', {
		block_slug: block.id,
	} );
};

/**
 * Command Palette
 */
const trackCommandPaletteSearch = debounce( ( event ) => {
	tracksRecordEvent( 'wpcom_editor_command_palette_search', {
		keyword: event.target.value,
	} );
}, 500 );

const trackCommandPaletteSelected = ( event ) => {
	let selectedCommandElement;
	if ( event.type === 'keydown' && event.code === 'Enter' ) {
		selectedCommandElement = event.currentTarget.querySelector(
			'div[cmdk-item][aria-selected="true"]'
		);
	} else if ( event.type === 'click' ) {
		selectedCommandElement = event.target.closest( 'div[cmdk-item][aria-selected="true"]' );
	}

	if ( selectedCommandElement ) {
		tracksRecordEvent( 'wpcom_editor_command_palette_selected', {
			value: selectedCommandElement.dataset.value,
		} );
	}
};

const trackCommandPaletteOpen = () => {
	tracksRecordEvent( 'wpcom_editor_command_palette_open' );

	window.setTimeout( () => {
		const commandPaletteInputElement = document.querySelector( SELECTORS.COMMAND_PALETTE_INPUT );
		if ( commandPaletteInputElement ) {
			commandPaletteInputElement.addEventListener( 'input', trackCommandPaletteSearch );
		}

		const commandPaletteListElement = document.querySelector( SELECTORS.COMMAND_PALETTE_LIST );
		if ( commandPaletteListElement ) {
			commandPaletteListElement.addEventListener( 'click', trackCommandPaletteSelected );
		}

		const commandPaletteRootElement = document.querySelector( SELECTORS.COMMAND_PALETTE_ROOT );
		if ( commandPaletteRootElement ) {
			commandPaletteRootElement.addEventListener( 'keydown', trackCommandPaletteSelected );
		}
	} );
};

const trackCommandPaletteClose = () => {
	tracksRecordEvent( 'wpcom_editor_command_palette_close' );

	const commandPaletteInputElement = document.querySelector( SELECTORS.COMMAND_PALETTE_INPUT );
	if ( commandPaletteInputElement ) {
		commandPaletteInputElement.removeEventListener( 'input', trackCommandPaletteSearch );
	}

	const commandPaletteListElement = document.querySelector( SELECTORS.COMMAND_PALETTE_LIST );
	if ( commandPaletteListElement ) {
		commandPaletteListElement.removeEventListener( 'click', trackCommandPaletteSelected );
	}

	const commandPaletteRootElement = document.querySelector( SELECTORS.COMMAND_PALETTE_ROOT );
	if ( commandPaletteRootElement ) {
		commandPaletteRootElement.removeEventListener( 'keydown', trackCommandPaletteSelected );
	}
};

/**
 * Tracker can be
 * - string - which means it is an event name and should be tracked as such automatically
 * - function - in case you need to load additional properties from the action.
 * @type {Object}
 */
const REDUX_TRACKING = {
	'jetpack/global-styles': {
		resetLocalChanges: 'wpcom_global_styles_reset',
		updateOptions: trackGlobalStyles( 'wpcom_global_styles_update' ),
		publishOptions: trackGlobalStyles( 'wpcom_global_styles_publish' ),
	},
	// Post Editor is using the undo/redo from the 'core/editor' store
	'core/editor': {
		undo: 'wpcom_block_editor_undo_performed',
		redo: 'wpcom_block_editor_redo_performed',
	},
	// Site Editor is using the undo/redo from the 'core' store
	core: {
		undo: 'wpcom_block_editor_undo_performed',
		redo: 'wpcom_block_editor_redo_performed',
		saveEntityRecord: trackSaveEntityRecord,
		editEntityRecord: trackEditEntityRecord,
		saveEditedEntityRecord: trackSaveEditedEntityRecord,
		__experimentalSaveSpecifiedEntityEdits: trackSaveSpecifiedEntityEdits,
	},
	'core/block-directory': {
		installBlockType: trackInstallBlockType,
	},
	'core/block-editor': {
		moveBlocksUp: getBlocksTracker( 'wpcom_block_moved_up' ),
		moveBlocksDown: getBlocksTracker( 'wpcom_block_moved_down' ),
		removeBlocks: trackBlockRemoval,
		removeBlock: trackBlockRemoval,
		moveBlockToPosition: getBlocksTracker( 'wpcom_block_moved_via_dragging' ),
		insertBlock: trackBlockInsertion,
		insertBlocks: trackBlockInsertion,
		replaceBlock: trackBlockReplacement,
		replaceBlocks: trackBlockReplacement,
		replaceInnerBlocks: trackInnerBlocksReplacement,
	},
	'core/notices': {
		createErrorNotice: trackErrorNotices,
	},
	'core/edit-site': {
		setIsListViewOpened: trackListViewToggle,
		openNavigationPanelToMenu: trackSiteEditorBrowsingSidebarOpen,
		addTemplate: trackSiteEditorCreateTemplate,
		setTemplate: trackSiteEditorChangeTemplate,
		setTemplatePart: trackSiteEditorChangeTemplatePart,
		setPage: trackSiteEditorChangeContent,
	},
	'core/edit-post': {
		setIsListViewOpened: trackListViewToggle,
	},
	'core/interface': {
		enableComplementaryArea: trackEnableComplementaryArea,
		disableComplementaryArea: trackDisableComplementaryArea,
	},
	'core/commands': {
		open: trackCommandPaletteOpen,
		close: trackCommandPaletteClose,
	},
};

/**
 * Mapping of Events by DOM selector.
 * Events are matched by selector and their handlers called.
 * @type {Array}
 */
const EVENT_TYPES = [ 'keyup', 'click' ];

// Store original and rewritten redux actions locally so we can return the same references when
// needed.
const rewrittenActions = {};
const originalActions = {};
// Registering tracking handlers.
if (
	undefined === window ||
	undefined === window._currentSiteId ||
	undefined === window._currentSiteType
) {
	debug( 'Skip: No data available.' );
} else {
	debug( 'registering tracking handlers.' );
	// Intercept dispatch function and add tracking for actions that need it.
	use( ( registry ) => ( {
		dispatch: ( namespace ) => {
			const namespaceName = typeof namespace === 'object' ? namespace.name : namespace;
			const actions = registry.dispatch( namespaceName );
			const trackers = REDUX_TRACKING[ namespaceName ];

			// Initialize namespace level objects if not yet done.
			if ( ! rewrittenActions[ namespaceName ] ) {
				rewrittenActions[ namespaceName ] = {};
			}
			if ( ! originalActions[ namespaceName ] ) {
				originalActions[ namespaceName ] = {};
			}

			if ( trackers ) {
				Object.keys( trackers ).forEach( ( actionName ) => {
					const originalAction = actions[ actionName ];
					const tracker = trackers[ actionName ];
					// If we haven't stored the originalAction we need to update.
					if ( ! originalActions[ namespaceName ][ actionName ] ) {
						// Save the originalAction and rewrittenAction for future reference.
						originalActions[ namespaceName ][ actionName ] = originalAction;
						rewrittenActions[ namespaceName ][ actionName ] = ( ...args ) => {
							debug( 'action "%s" called with %o arguments', actionName, [ ...args ] );
							// We use a try-catch here to make sure the `originalAction`
							// is always called. We don't want to break the original
							// behaviour when our tracking throws an error.
							try {
								if ( typeof tracker === 'string' ) {
									// Simple track - just based on the event name.
									tracksRecordEvent( tracker );
								} else if ( typeof tracker === 'function' ) {
									// Advanced tracking - call function.
									tracker( ...args );
								}
							} catch ( err ) {
								// eslint-disable-next-line no-console
								console.error( err );
							}
							return originalAction( ...args );
						};
					}
					// Replace the action in the registry with the rewrittenAction.
					actions[ actionName ] = rewrittenActions[ namespaceName ][ actionName ];
				} );
			}
			return actions;
		},
	} ) );

	const delegateNonCaptureListener = ( event ) => {
		delegateEventTracking( false, event );
	};

	const delegateCaptureListener = ( event ) => {
		delegateEventTracking( true, event );
	};

	// Registers Plugin.
	registerPlugin( 'wpcom-block-editor-tracking', {
		render: () => {
			EVENT_TYPES.forEach( ( eventType ) => {
				document.addEventListener( eventType, delegateNonCaptureListener );
				document.addEventListener( eventType, delegateCaptureListener, true );
			} );
			return null;
		},
	} );

	registerDelegateEventSubscriber(
		'wpcom-block-editor-template-part-detach-blocks',
		'before',
		( mapping, event, target ) => {
			const item = target.querySelector( '.components-menu-item__item' );
			if ( item?.innerText === __( 'Detach blocks from template part' ) ) {
				ignoreNextReplaceBlocksAction = true;
			}
		}
	);
}