wp-calypso/packages/calypso-e2e/src/lib/flows/start-import-flow.ts

import { Page } from 'playwright';
import { DataHelper } from '../..';

const selectors = {
	// Generic
	button: ( text: string ) => `button:text("${ text }")`,
	backLink: '.navigation-link:text("Back"), button:text-matches("Back")',
	dontHaveASiteButton: 'button:text-matches("choose a content platform", "i")',
	migrationModalCancel: 'button.action-buttons__cancel',
	// Inputs
	urlInput: 'input.capture__input',
	goalsCaptureUrlInput: 'input.form-text-input[value]',

	// ImporterDrag page
	importerDrag: ( text: string ) => `div.importer-wrapper__${ text }`,

	// Errors
	analyzeError: ( text: string ) => `:text("${ text }")`,

	// Headers
	setupHeader: 'h1:text("Themes")',
	startBuildingHeader: ( text: string ) =>
		`h1:text("${ text }"), h1.onboarding-title:text("${ text }")`,

	importModal: 'div.import__confirm-modal',

	// Buttons
	checkUrlButton: 'form.capture__input-wrapper button.action-buttons__next',
	startBuildingButton: 'div.import__onboarding-page button.action-buttons__next',
	startImportButton: 'button:text("Import your site content")',
	startImportGoalButton: 'span:has-text("Import my existing website content")',
	// And entry of the list of selectable importers
	importerListButton: ( index: number ) =>
		`div.list__importers-primary button:nth-child(${ index + 1 })`,
};

/**
 * Class encapsulating the flow when starting a new start importer ('/start/importer')
 */
export class StartImportFlow {
	/**
	 * Constructs an instance of the flow.
	 *
	 * @param {Page} page The underlying page.
	 */
	constructor( private page: Page ) {}

	/**
	 * Given text, click on the button's first instance with the text.
	 *
	 * @param {string} text User-visible text on the button.
	 */
	async clickButton( text: string ): Promise< void > {
		const selector = selectors.button( text );

		await this.page.locator( selector ).click();
	}

	/**
	 * Validates that we've landed on the setup page.
	 */
	async validateSetupPage(): Promise< void > {
		await this.page.locator(
			`${ selectors.startImportButton }, ${ selectors.startImportGoalButton }`
		);
	}

	/**
	 * Validates that we show migration modal.
	 */
	async validateImportModal(): Promise< void > {
		await this.page.locator( `${ selectors.importModal }` ).waitFor();
	}

	/**
	 * Validates that we've landed on the URL capture page.
	 */
	async validateURLCapturePage(): Promise< void > {
		await this.page.waitForURL( /.*setup\/site-setup\/import.*/ );
	}

	/**
	 * Validates that we've landed on the URL capture page.
	 */
	async validateURLMigrationFlow(): Promise< void > {
		await this.page.waitForURL( /.*setup\/site-migration.*/ );
	}

	/**
	 * Validates that we've landed on the URL capture page with 'typo' error.
	 */
	async validateErrorCapturePage( error: string ): Promise< void > {
		await this.page.locator( selectors.analyzeError( error ) ).waitFor();
	}

	/**
	 * Validates that we've landed on the import page.
	 */
	async validateImportPage(): Promise< void > {
		await this.page
			.locator( selectors.startBuildingHeader( 'Your content is ready for its brand new home' ) )
			.waitFor();
	}

	/**
	 * Validates that we've landed on the upgrade plan page.
	 */
	async validateUpgradePlanPage(): Promise< void > {
		await this.page
			.locator( selectors.startBuildingHeader( 'Take your site to the next level' ) )
			.waitFor();
	}

	/**
	 * Validates that we've landed on the "Install Jetpack" page.
	 */
	async validateInstallJetpackPage(): Promise< void > {
		await this.page.locator( selectors.startBuildingHeader( 'Install Jetpack' ) ).waitFor();
	}

	/**
	 * Validates that we've landed on the checkout page.
	 */
	async validateCheckoutPage(): Promise< void > {
		await this.page.getByText( 'Secure checkout' ).waitFor();
	}

	/**
	 * Validates that we've landed on the site picker page.
	 */
	async validateSitePickerPage(): Promise< void > {
		await this.page.getByText( 'Pick your destination' ).waitFor();
	}

	/**
	 * Validates that we've landed on the migration ready page.
	 */
	async validateMigrationReadyPage(): Promise< void > {
		await this.page.getByText( 'Your site is ready for its brand new home' ).waitFor();
	}

	/**
	 * Validates that we've landed on the building page.
	 *
	 * @param {string} reason The reason shown in main header.
	 */
	async validateBuildingPage( reason: string ): Promise< void > {
		await this.page.locator( selectors.startBuildingHeader( reason ) ).waitFor();
	}

	/**
	 * Validates that we've landed on the design setup page.
	 */
	async validateDesignPage(): Promise< void > {
		await this.page.locator( selectors.setupHeader ).waitFor();
	}

	/**
	 * Validates that we've landed on the importer drag page.
	 */
	async validateImporterDragPage( importer: string ): Promise< void > {
		await this.page.locator( selectors.importerDrag( importer ) ).waitFor();
	}

	/**
	 * Validates that we've landed on the importer list page.
	 */
	async validateImporterListPage(): Promise< void > {
		await this.page
			.locator( selectors.startBuildingHeader( 'Import content from another platform or file' ) )
			.waitFor();
	}

	/**
	 * Enter the URL to import from on the "Enter your site address" input form.
	 *
	 * @param {string} url The source URL.
	 * @throws {Error} If no URL input is found.
	 */
	async enterURL( url: string ): Promise< void > {
		await this.page.waitForLoadState( 'load' );

		const legacyURLInputLocator = this.page.locator( selectors.urlInput );
		const goalsCaptureURLInputLocator = this.page.locator( selectors.goalsCaptureUrlInput );

		// Support both Legacy and Goals Capture versions
		// of the URL input for importer.
		// See https://github.com/Automattic/wp-calypso/issues/65792
		const element = await Promise.race( [
			legacyURLInputLocator.elementHandle(),
			goalsCaptureURLInputLocator.elementHandle(),
		] );

		if ( ! element ) {
			throw new Error( 'No matching URL input found at Site Importer.' );
		}
		await element.fill( url );
		const continueLocator = this.page.locator(
			`${ selectors.checkUrlButton }, ${ selectors.button( 'Continue' ) }`
		);

		await continueLocator.click();
	}

	/**
	 * Go to first import page.
	 *
	 * @param {string} siteSlug The site slug URL.
	 */
	async startImport( siteSlug: string ): Promise< void > {
		const route = '/setup/setup-site';

		await this.page.goto( DataHelper.getCalypsoURL( route, { siteSlug } ) );
	}

	/**
	 * Go to first setup page.
	 *
	 * @param {string} siteSlug The site slug URL.
	 */
	async startSetup( siteSlug: string ): Promise< void > {
		const route = '/setup/site-setup/intent';

		await this.page.goto( DataHelper.getCalypsoURL( route, { siteSlug } ) );
		await this.validateSetupPage();
		await this.page.click( selectors.startImportButton );
	}

	/**
	 * Start the building.
	 */
	async startBuilding(): Promise< void > {
		await this.page.click( selectors.startBuildingButton );
	}

	/**
	 * Open the importer list page.
	 */
	async startImporterList(): Promise< void > {
		await this.page.click( selectors.dontHaveASiteButton );
	}

	/**
	 * An entry from the list of importers.
	 *
	 * @param index the desired importer
	 */
	async selectImporterFromList( index: number ): Promise< void > {
		await this.page.click( selectors.importerListButton( index ) );
		await this.page
			.locator( selectors.startBuildingHeader( 'Import content from WordPress' ) )
			.waitFor();
	}

	/**
	 * Click back button of the flow.
	 */
	async clickBack(): Promise< void > {
		await this.page.click( selectors.backLink );
	}

	/**
	 * Click migration modal cancel.
	 */
	async clickMigrationModalCancel(): Promise< void > {
		await this.page.click( selectors.migrationModalCancel );
	}

	/**
	 * Navigate back one screen in the flow.
	 */
	async goBackOneScreen(): Promise< void > {
		await this.clickBack();
		await this.page.waitForNavigation();
	}
}