@wordpress/e2e-test-utils-playwright 1.48.0 → 1.48.1

package/src/request-utils/themes.ts

@@ -1,110 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-import { WP_BASE_URL } from '../config';
-
-const THEMES_URL = new URL( 'wp-admin/themes.php', WP_BASE_URL ).href;
-
-async function activateTheme(
-	this: RequestUtils,
-	themeSlug: string
-): Promise< void > {
-	let response = await this.request.get( THEMES_URL );
-	const html = await response.text();
-	const optionalFolder = '([a-z0-9-]+%2F)?';
-
-	// The `optionalFolder` regex part matches paths with a folder,
-	// so it will return the first match, which might contain a folder.
-	// First try to honor the included theme slug, that is, without a folder.
-	let matchGroup = html.match(
-		`action=activate&amp;stylesheet=${ encodeURIComponent(
-			themeSlug
-		) }&amp;_wpnonce=[a-z0-9]+`
-	);
-
-	// If the theme is not found, try to match the theme slug with a folder.
-	if ( ! matchGroup ) {
-		matchGroup = html.match(
-			`action=activate&amp;stylesheet=${ optionalFolder }${ encodeURIComponent(
-				themeSlug
-			) }&amp;_wpnonce=[a-z0-9]+`
-		);
-	}
-
-	if ( ! matchGroup ) {
-		if ( html.includes( `data-slug="${ themeSlug }"` ) ) {
-			// The theme is already activated.
-			return;
-		}
-
-		throw new Error( `The theme "${ themeSlug }" is not installed` );
-	}
-
-	const [ activateQuery ] = matchGroup;
-	const activateLink =
-		THEMES_URL + `?${ activateQuery }`.replace( /&amp;/g, '&' );
-
-	response = await this.request.get( activateLink );
-
-	await response.dispose();
-}
-
-// https://developer.wordpress.org/rest-api/reference/themes/#definition
-async function getCurrentThemeGlobalStylesPostId( this: RequestUtils ) {
-	type ThemeItem = {
-		stylesheet: string;
-		status: string;
-		_links: { 'wp:user-global-styles': { href: string }[] };
-	};
-	const themes = await this.rest< ThemeItem[] >( {
-		path: '/wp/v2/themes',
-	} );
-	let themeGlobalStylesId: string = '';
-	if ( themes && themes.length ) {
-		const currentTheme: ThemeItem | undefined = themes.find(
-			( { status } ) => status === 'active'
-		);
-
-		const globalStylesURL =
-			currentTheme?._links?.[ 'wp:user-global-styles' ]?.[ 0 ]?.href;
-		if ( globalStylesURL ) {
-			// Extract the ID from the URL. The URL format depends on
-			// the permalink structure:
-			// - Plain: ?rest_route=/wp/v2/global-styles/123
-			// - Pretty: /wp-json/wp/v2/global-styles/123
-			const idMatch = globalStylesURL.match(
-				/\/wp\/v2\/global-styles\/(\d+)/
-			);
-			if ( idMatch ) {
-				themeGlobalStylesId = idMatch[ 1 ];
-			}
-		}
-	}
-	return themeGlobalStylesId;
-}
-
-/**
- * Deletes all post revisions using the REST API.
- *
- * @param {}              this     RequestUtils.
- * @param {string|number} parentId Post attributes.
- */
-async function getThemeGlobalStylesRevisions(
-	this: RequestUtils,
-	parentId: number | string
-) {
-	// Lists all global styles revisions.
-	return await this.rest< Record< string, Object >[] >( {
-		path: `/wp/v2/global-styles/${ parentId }/revisions`,
-		params: {
-			per_page: 100,
-		},
-	} );
-}
-
-export {
-	activateTheme,
-	getCurrentThemeGlobalStylesPostId,
-	getThemeGlobalStylesRevisions,
-};

package/src/request-utils/users.ts

@@ -1,125 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-export interface User {
-	id: number;
-	name: string;
-	email: string;
-}
-
-export interface UserData {
-	username: string;
-	email: string;
-	firstName?: string;
-	lastName?: string;
-	password?: string;
-	roles?: string[];
-}
-
-export interface UserRequestData {
-	username: string;
-	email: string;
-	first_name?: string;
-	last_name?: string;
-	password?: string;
-	roles?: string[];
-}
-
-/**
- * List all users.
- *
- * @see https://developer.wordpress.org/rest-api/reference/users/#list-users
- * @param this
- */
-async function listUsers( this: RequestUtils ) {
-	const response = await this.rest< User[] >( {
-		method: 'GET',
-		path: '/wp/v2/users',
-		params: {
-			per_page: 100,
-		},
-	} );
-
-	return response;
-}
-
-/**
- * Add a test user.
- *
- * @see https://developer.wordpress.org/rest-api/reference/users/#create-a-user
- * @param this
- * @param user User data to create.
- */
-async function createUser( this: RequestUtils, user: UserData ) {
-	const userData: UserRequestData = {
-		username: user.username,
-		email: user.email,
-	};
-
-	if ( user.firstName ) {
-		userData.first_name = user.firstName;
-	}
-
-	if ( user.lastName ) {
-		userData.last_name = user.lastName;
-	}
-
-	if ( user.password ) {
-		userData.password = user.password;
-	}
-
-	if ( user.roles ) {
-		userData.roles = user.roles;
-	}
-
-	const response = await this.rest< User >( {
-		method: 'POST',
-		path: '/wp/v2/users',
-		data: userData,
-	} );
-
-	return response;
-}
-
-/**
- * Delete a user.
- *
- * @see https://developer.wordpress.org/rest-api/reference/users/#delete-a-user
- * @param this
- * @param userId The ID of the user.
- */
-async function deleteUser( this: RequestUtils, userId: number ) {
-	const response = await this.rest( {
-		method: 'DELETE',
-		path: `/wp/v2/users/${ userId }`,
-		params: { force: true, reassign: 1 },
-	} );
-
-	return response;
-}
-
-/**
- * Delete all users except main root user.
- *
- * @param this
- */
-async function deleteAllUsers( this: RequestUtils ) {
-	const users = await listUsers.bind( this )();
-
-	// The users endpoint doesn't support batch request yet.
-	const responses = await Promise.all(
-		users
-			// Do not delete neither root user nor the current user.
-			.filter(
-				( user: User ) =>
-					user.id !== 1 && user.name !== this.user.username
-			)
-			.map( ( user: User ) => deleteUser.bind( this )( user.id ) )
-	);
-
-	return responses;
-}
-
-export { createUser, deleteAllUsers };

package/src/request-utils/widgets.js

@@ -1,68 +0,0 @@
-/**
- * Delete all the widgets in the widgets screen.
- *
- * @this {import('./index').RequestUtils}
- */
-export async function deleteAllWidgets() {
-	const [ widgets, sidebars ] = await Promise.all( [
-		this.rest( { path: '/wp/v2/widgets' } ),
-		this.rest( { path: '/wp/v2/sidebars' } ),
-	] );
-
-	await this.batchRest(
-		widgets.map( ( widget ) => ( {
-			method: 'DELETE',
-			path: `/wp/v2/widgets/${ widget.id }?force=true`,
-		} ) )
-	);
-
-	// The endpoint doesn't support batch requests yet.
-	await Promise.all(
-		sidebars.map( ( sidebar ) =>
-			this.rest( {
-				method: 'POST',
-				path: `/wp/v2/sidebars/${ sidebar.id }`,
-				data: { id: sidebar.id, widgets: [] },
-			} )
-		)
-	);
-}
-
-/**
- * Add a widget block to the widget area.
- *
- * @this {import('./index').RequestUtils}
- * @param {string} serializedBlock The serialized content of the inserted block HTML.
- * @param {string} widgetAreaId    The ID of the widget area.
- */
-export async function addWidgetBlock( serializedBlock, widgetAreaId ) {
-	const { id: blockId } = await this.rest( {
-		method: 'POST',
-		path: '/wp/v2/widgets',
-		data: {
-			id_base: 'block',
-			sidebar: widgetAreaId,
-			instance: {
-				raw: { content: serializedBlock },
-			},
-		},
-	} );
-
-	const { widgets } = await this.rest( {
-		path: `/wp/v2/sidebars/${ widgetAreaId }`,
-	} );
-
-	const updatedWidgets = new Set( widgets );
-	// Remove duplicate.
-	updatedWidgets.delete( blockId );
-	// Add to last block.
-	updatedWidgets.add( blockId );
-
-	await this.rest( {
-		method: 'PUT',
-		path: `/wp/v2/sidebars/${ widgetAreaId }`,
-		data: {
-			widgets: [ ...updatedWidgets ],
-		},
-	} );
-}

package/src/test.ts

@@ -1,204 +0,0 @@
-// Playwright fixtures use `use()` which is not a React hook.
-
-/**
- * External dependencies
- */
-import * as path from 'path';
-import { test as base, expect, chromium } from '@playwright/test';
-import type { ConsoleMessage } from '@playwright/test';
-import getPort from 'get-port';
-
-/**
- * Internal dependencies
- */
-import {
-	Admin,
-	Editor,
-	PageUtils,
-	RequestUtils,
-	Metrics,
-	Lighthouse,
-} from './index';
-
-const STORAGE_STATE_PATH =
-	process.env.STORAGE_STATE_PATH ||
-	path.join( process.cwd(), 'artifacts/storage-states/admin.json' );
-
-/**
- * Set of console logging types observed to protect against unexpected yet
- * handled (i.e. not catastrophic) errors or warnings. Each key corresponds
- * to the Playwright ConsoleMessage type, its value the corresponding function
- * on the console global object.
- */
-const OBSERVED_CONSOLE_MESSAGE_TYPES = [ 'warn', 'error' ] as const;
-
-/**
- * Adds a page event handler to emit uncaught exception to process if one of
- * the observed console logging types is encountered.
- *
- * @param message The console message.
- */
-function observeConsoleLogging( message: ConsoleMessage ) {
-	const type = message.type();
-	if (
-		! OBSERVED_CONSOLE_MESSAGE_TYPES.includes(
-			type as ( typeof OBSERVED_CONSOLE_MESSAGE_TYPES )[ number ]
-		)
-	) {
-		return;
-	}
-
-	const text = message.text();
-
-	// An exception is made for _blanket_ deprecation warnings: Those
-	// which log regardless of whether a deprecated feature is in use.
-	if ( text.includes( 'This is a global warning' ) ) {
-		return;
-	}
-
-	// A chrome advisory warning about SameSite cookies is informational
-	// about future changes, tracked separately for improvement in core.
-	//
-	// See: https://core.trac.wordpress.org/ticket/37000
-	// See: https://www.chromestatus.com/feature/5088147346030592
-	// See: https://www.chromestatus.com/feature/5633521622188032
-	if (
-		text.includes( 'A cookie associated with a cross-site resource' ) ||
-		text.includes(
-			'https://developer.mozilla.org/docs/Web/HTTP/Headers/Set-Cookie/SameSite'
-		)
-	) {
-		return;
-	}
-
-	// Viewing posts on the front end can result in this error, which
-	// has nothing to do with Gutenberg.
-	if ( text.includes( 'net::ERR_UNKNOWN_URL_SCHEME' ) ) {
-		return;
-	}
-
-	// TODO: Not implemented yet.
-	// Network errors are ignored only if we are intentionally testing
-	// offline mode.
-	// if (
-	// 	text.includes( 'net::ERR_INTERNET_DISCONNECTED' ) &&
-	// 	isOfflineMode()
-	// ) {
-	// 	return;
-	// }
-
-	// As of WordPress 5.3.2 in Chrome 79, navigating to the block editor
-	// (Posts > Add New) will display a console warning about
-	// non - unique IDs.
-	// See: https://core.trac.wordpress.org/ticket/23165
-	if ( text.includes( 'elements with non-unique id #_wpnonce' ) ) {
-		return;
-	}
-
-	// Ignore all JQMIGRATE (jQuery migrate) deprecation warnings.
-	if ( text.includes( 'JQMIGRATE' ) ) {
-		return;
-	}
-
-	// https://bugzilla.mozilla.org/show_bug.cgi?id=1404468
-	if (
-		text.includes( 'Layout was forced before the page was fully loaded' )
-	) {
-		return;
-	}
-
-	// Deprecated warnings coming from the third-party libraries.
-	if ( text.includes( 'MouseEvent.moz' ) ) {
-		return;
-	}
-
-	const logFunction =
-		type as ( typeof OBSERVED_CONSOLE_MESSAGE_TYPES )[ number ];
-
-	// Disable reason: We intentionally bubble up the console message
-	// which, unless the test explicitly anticipates the logging via
-	// @wordpress/jest-console matchers, will cause the intended test
-	// failure.
-	// eslint-disable-next-line no-console
-	console[ logFunction ]( text );
-}
-
-const test = base.extend<
-	{
-		admin: Admin;
-		editor: Editor;
-		pageUtils: PageUtils;
-		snapshotConfig: void;
-		metrics: Metrics;
-		lighthouse: Lighthouse;
-	},
-	{
-		requestUtils: RequestUtils;
-		lighthousePort: number;
-	}
->( {
-	admin: async ( { page, pageUtils, editor }, use ) => {
-		await use( new Admin( { page, pageUtils, editor } ) );
-	},
-	editor: async ( { page }, use ) => {
-		await use( new Editor( { page } ) );
-	},
-	page: async ( { page }, use ) => {
-		page.on( 'console', observeConsoleLogging );
-
-		await use( page );
-
-		// Clear local storage after each test.
-		// This needs to be wrapped with a try/catch because it can fail when
-		// the test is skipped (e.g. via fixme).
-		try {
-			await page.evaluate( () => {
-				window.localStorage.clear();
-			} );
-		} catch {
-			// noop.
-		}
-
-		await page.close();
-	},
-	pageUtils: async ( { page, browserName }, use ) => {
-		await use( new PageUtils( { page, browserName } ) );
-	},
-	requestUtils: [
-		async ( {}, use, workerInfo ) => {
-			const requestUtils = await RequestUtils.setup( {
-				baseURL: workerInfo.project.use.baseURL,
-				storageStatePath: STORAGE_STATE_PATH,
-			} );
-
-			await use( requestUtils );
-		},
-		{ scope: 'worker', auto: true },
-	],
-	// Spins up a new browser for use by the Lighthouse fixture
-	// so that Lighthouse can connect to the debugging port.
-	// As a worker-scoped fixture, this will only launch 1
-	// instance for the whole test worker, so multiple tests
-	// will share the same instance with the same port.
-	lighthousePort: [
-		async ( {}, use ) => {
-			const port = await getPort();
-			const browser = await chromium.launch( {
-				args: [ `--remote-debugging-port=${ port }` ],
-			} );
-
-			await use( port );
-
-			await browser.close();
-		},
-		{ scope: 'worker' },
-	],
-	lighthouse: async ( { page, lighthousePort }, use ) => {
-		await use( new Lighthouse( { page, port: lighthousePort } ) );
-	},
-	metrics: async ( { page }, use ) => {
-		await use( new Metrics( { page } ) );
-	},
-} );
-
-export { test, expect };

package/src/types.ts

@@ -1,13 +0,0 @@
-/**
- * External dependencies
- */
-declare global {
-	interface Window {
-		// Silence the warning for `window.wp` in Playwright's evaluate functions.
-		wp: any;
-		// Helper function added by Metrics fixture for web-vitals.js.
-		__reportVitals__: ( data: string ) => void;
-	}
-}
-
-export {};