wp-calypso/packages/calypso-e2e/src/lib/components/block-widget-editor-component.ts

import { Page } from 'playwright';

const selectors = {
	editor: '#widgets-editor',

	// Welcome Guide and Welcome Tour
	welcomeModalDismissButton: 'div.components-modal__header > button', // Instead of aria-label, which changes depending on English UK/US.
	welcomeTourDismissButton: 'button[aria-label="Close Tour"]',

	// Block Widget editor
	addBlockButton: 'button[aria-label="Add block"]',
	blockSearch: 'input[placeholder="Search"]',
};

/**
 * Component for the block-based Widget editor in Appearance > Widgets.
 */
export class BlockWidgetEditorComponent {
	private page: Page;

	/**
	 * Constructs an instance of the component.
	 *
	 * @param {Page} page The underlying page.
	 */
	constructor( page: Page ) {
		this.page = page;
	}

	/**
	 * Dismiss any welcome modals that appear.
	 *
	 * These include:
	 * 	- Welcome modal
	 * 	- Welcome Tour
	 */
	async dismissModals(): Promise< void > {
		await this.page.waitForLoadState( 'networkidle' );

		const locators = [
			this.page.locator( selectors.welcomeModalDismissButton ),
			this.page.locator( selectors.welcomeTourDismissButton ),
		];

		for await ( const locator of locators ) {
			try {
				// Whether Welcome Tour appears is not deterministic.
				// If it is not present, exit early.
				if ( ( await locator.count() ) === 0 ) {
					return;
				}
				await locator.click();
			} catch {
				//noop
			}
		}
	}
}