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

package/src/request-utils/pages.ts

@@ -1,75 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-const PAGE_STATUS = [
-	'publish',
-	'future',
-	'draft',
-	'pending',
-	'private',
-	'trash',
-] as const;
-
-export type Page = {
-	id: number;
-	status: ( typeof PAGE_STATUS )[ number ];
-};
-
-export type CreatePagePayload = {
-	title?: string;
-	content?: string;
-	status: ( typeof PAGE_STATUS )[ number ];
-	date?: string;
-	date_gmt?: string;
-};
-
-export async function deletePage( this: RequestUtils, id: number ) {
-	// https://developer.wordpress.org/rest-api/reference/pages/#delete-a-page
-	return await this.rest( {
-		method: 'DELETE',
-		path: `/wp/v2/pages/${ id }`,
-		params: {
-			force: true,
-		},
-	} );
-}
-
-/**
- * Delete all pages using REST API.
- *
- * @param this
- */
-export async function deleteAllPages( this: RequestUtils ) {
-	// List all pages.
-	// https://developer.wordpress.org/rest-api/reference/pages/#list-pages
-	const pages = await this.rest< Page[] >( {
-		path: '/wp/v2/pages',
-		params: {
-			per_page: 100,
-
-			status: PAGE_STATUS.join( ',' ),
-		},
-	} );
-
-	// Delete all pages one by one.
-	// "/wp/v2/pages" not yet supports batch requests.
-	await Promise.all(
-		pages.map( ( page ) => deletePage.call( this, page.id ) )
-	);
-}
-
-/**
- * Create a new page.
- *
- * @param this
- * @param payload The page payload.
- */
-export async function createPage(
-	this: RequestUtils,
-	payload: CreatePagePayload
-) {
-	// https://developer.wordpress.org/rest-api/reference/pages/#create-a-page
-	return this.createRecord< Page >( 'pages', { ...payload } );
-}

package/src/request-utils/patterns.ts

@@ -1,31 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-/**
- * Delete all pattern categories using REST API.
- *
- * @see https://developer.wordpress.org/rest-api/reference/categories/#list-categories
- * @param this
- */
-export async function deleteAllPatternCategories( this: RequestUtils ) {
-	// List all pattern categories.
-	// https://developer.wordpress.org/rest-api/reference/categories/#list-categories
-	const categories = await this.rest( {
-		path: '/wp/v2/wp_pattern_category',
-		params: {
-			per_page: 100,
-		},
-	} );
-
-	// Delete pattern categories.
-	// https://developer.wordpress.org/rest-api/reference/categories/#delete-a-category
-	// "/wp/v2/category" does not yet supports batch requests.
-	await this.batchRest(
-		categories.map( ( category: { id: number } ) => ( {
-			method: 'DELETE',
-			path: `/wp/v2/wp_pattern_category/${ category.id }?force=true`,
-		} ) )
-	);
-}

package/src/request-utils/plugins.ts

@@ -1,103 +0,0 @@
-/**
- * External dependencies
- */
-import { paramCase as kebabCase } from 'change-case';
-
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-/**
- * Fetch the plugins from API and cache them in memory,
- * since they are unlikely to change during testing.
- *
- * @param this
- * @param forceRefetch Force refetch the installed plugins to update the cache.
- */
-async function getPluginsMap( this: RequestUtils, forceRefetch = false ) {
-	if ( ! forceRefetch && this.pluginsMap ) {
-		return this.pluginsMap;
-	}
-
-	const plugins = await this.rest( {
-		path: '/wp/v2/plugins',
-	} );
-	this.pluginsMap = {};
-	for ( const plugin of plugins ) {
-		// Ideally, we should be using sanitize_title() in PHP rather than kebabCase(),
-		// but we don't have the exact port of it in JS.
-		// This is a good approximation though.
-		const slug = kebabCase( plugin.name.toLowerCase() );
-		this.pluginsMap[ slug ] = plugin.plugin;
-	}
-	return this.pluginsMap;
-}
-
-/**
- * Finds a plugin in the plugin map.
- *
- * Attempts to provide a helpful error message if not found.
- *
- * @param slug       Plugin slug.
- * @param pluginsMap Plugins map.
- */
-function getPluginFromMap(
-	slug: string,
-	pluginsMap: Record< string, string >
-) {
-	const plugin = pluginsMap[ slug ];
-
-	if ( ! plugin ) {
-		for ( const key of Object.keys( pluginsMap ) ) {
-			if (
-				key.toLowerCase().replace( /-/g, '' ) ===
-				slug.toLowerCase().replace( /-/g, '' )
-			) {
-				throw new Error(
-					`The plugin "${ slug }" isn't installed. Did you perhaps mean "${ key }"?`
-				);
-			}
-		}
-
-		throw new Error( `The plugin "${ slug }" isn't installed` );
-	}
-
-	return plugin;
-}
-
-/**
- * Activates an installed plugin.
- *
- * @param this RequestUtils.
- * @param slug Plugin slug.
- */
-async function activatePlugin( this: RequestUtils, slug: string ) {
-	const pluginsMap = await this.getPluginsMap();
-	const plugin = getPluginFromMap( slug, pluginsMap );
-
-	await this.rest( {
-		method: 'PUT',
-		path: `/wp/v2/plugins/${ plugin }`,
-		data: { status: 'active' },
-	} );
-}
-
-/**
- * Deactivates an active plugin.
- *
- * @param this RequestUtils.
- * @param slug Plugin slug.
- */
-async function deactivatePlugin( this: RequestUtils, slug: string ) {
-	const pluginsMap = await this.getPluginsMap();
-	const plugin = getPluginFromMap( slug, pluginsMap );
-
-	await this.rest( {
-		method: 'PUT',
-		path: `/wp/v2/plugins/${ plugin }`,
-		data: { status: 'inactive' },
-	} );
-}
-
-export { getPluginsMap, activatePlugin, deactivatePlugin };

package/src/request-utils/posts.ts

@@ -1,69 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-export interface Post {
-	id: number;
-	content: string;
-	status: 'publish' | 'future' | 'draft' | 'pending' | 'private';
-	link: string;
-}
-
-export interface CreatePostPayload {
-	title?: string;
-	content?: string;
-	status: 'publish' | 'future' | 'draft' | 'pending' | 'private';
-	date?: string;
-	date_gmt: string;
-}
-
-/**
- * Delete all posts using REST API.
- *
- * @param this
- * @param postType The type of post to delete. Defaults to 'posts'.
- */
-export async function deleteAllPosts(
-	this: RequestUtils,
-	postType: string = 'posts'
-) {
-	// List all posts.
-	// https://developer.wordpress.org/rest-api/reference/posts/#list-posts
-	const posts = await this.rest< Post[] >( {
-		path: `/wp/v2/${ postType }`,
-		params: {
-			per_page: 100,
-			// All possible statuses.
-			status: 'publish,future,draft,pending,private,trash',
-		},
-	} );
-
-	// Delete all posts one by one.
-	// https://developer.wordpress.org/rest-api/reference/posts/#delete-a-post
-	// "/wp/v2/posts" not yet supports batch requests.
-	await Promise.all(
-		posts.map( ( post ) =>
-			this.rest( {
-				method: 'DELETE',
-				path: `/wp/v2/${ postType }/${ post.id }`,
-				params: {
-					force: true,
-				},
-			} )
-		)
-	);
-}
-
-/**
- * Creates a new post using the REST API.
- *
- * @param this
- * @param payload Post attributes.
- */
-export async function createPost(
-	this: RequestUtils,
-	payload: CreatePostPayload
-) {
-	return this.createRecord< Post >( 'posts', { ...payload } );
-}

package/src/request-utils/preferences.ts

@@ -1,63 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-/**
- * Reset user preferences
- *
- * @param this Request utils.
- */
-export async function resetPreferences( this: RequestUtils ) {
-	await this.rest( {
-		path: '/wp/v2/users/me',
-		method: 'PUT',
-		data: {
-			meta: {
-				persisted_preferences: {},
-			},
-		},
-	} );
-}
-
-/**
- * Set scoped user preferences via the REST API.
- *
- * Reads the current persisted preferences, merges the new values under the
- * given scope, and writes them back.
- *
- * @param this        Request utils.
- * @param scope       The preference scope (e.g. 'core/edit-post').
- * @param preferences Key/value map of preference names to values.
- */
-export async function setPreferences(
-	this: RequestUtils,
-	scope: string,
-	preferences: Record< string, any >
-) {
-	const user = await this.rest< {
-		meta: { persisted_preferences: Record< string, any > };
-	} >( {
-		path: '/wp/v2/users/me',
-		method: 'GET',
-		params: { context: 'edit' },
-	} );
-
-	const currentPreferences = user.meta?.persisted_preferences ?? {};
-
-	await this.rest( {
-		path: '/wp/v2/users/me',
-		method: 'PUT',
-		data: {
-			meta: {
-				persisted_preferences: {
-					...currentPreferences,
-					[ scope ]: {
-						...( currentPreferences[ scope ] ?? {} ),
-						...preferences,
-					},
-				},
-			},
-		},
-	} );
-}

package/src/request-utils/rest.ts

@@ -1,222 +0,0 @@
-/**
- * External dependencies
- */
-import * as fs from 'fs/promises';
-import { dirname } from 'path';
-import { expect } from '@playwright/test';
-import type { APIRequestContext } from '@playwright/test';
-
-/**
- * Internal dependencies
- */
-import { WP_BASE_URL } from '../config';
-import type { RequestUtils, StorageState } from './index';
-
-function splitRequestsToChunks( requests: BatchRequest[], chunkSize: number ) {
-	const arr = [ ...requests ];
-	const cache = [];
-	while ( arr.length ) {
-		cache.push( arr.splice( 0, chunkSize ) );
-	}
-
-	return cache;
-}
-
-async function getAPIRootURL( request: APIRequestContext ) {
-	// Discover the API root url using link header.
-	// See https://developer.wordpress.org/rest-api/using-the-rest-api/discovery/#link-header
-	const response = await request.head( WP_BASE_URL );
-	const links = response.headers().link;
-	const restLink = links?.match( /<([^>]+)>; rel="https:\/\/api\.w\.org\/"/ );
-
-	if ( ! restLink ) {
-		throw new Error( `Failed to discover REST API endpoint.
- Link header: ${ links }` );
-	}
-
-	const [ , rootURL ] = restLink;
-
-	return rootURL;
-}
-
-async function setupRest( this: RequestUtils ): Promise< StorageState > {
-	let nonce = '';
-	let rootURL = '';
-
-	// Poll until the REST API is discovered.
-	// See https://github.com/WordPress/gutenberg/issues/61627
-	await expect
-		.poll(
-			async () => {
-				try {
-					[ nonce, rootURL ] = await Promise.all( [
-						this.login(),
-						getAPIRootURL( this.request ),
-					] );
-				} catch ( error ) {
-					// Prints the error if the timeout is reached.
-					return error;
-				}
-
-				return !! ( nonce && rootURL );
-			},
-			{
-				message: 'Failed to setup REST API.',
-				timeout: 60_000, // 1 minute.
-			}
-		)
-		.toBe( true );
-
-	const { cookies } = await this.request.storageState();
-
-	const storageState: StorageState = {
-		cookies,
-		nonce,
-		rootURL,
-	};
-
-	if ( this.storageStatePath ) {
-		await fs.mkdir( dirname( this.storageStatePath ), { recursive: true } );
-		await fs.writeFile(
-			this.storageStatePath,
-			JSON.stringify( storageState ),
-			'utf-8'
-		);
-	}
-
-	this.storageState = storageState;
-
-	return storageState;
-}
-
-type RequestFetchOptions = Exclude<
-	Parameters< APIRequestContext[ 'fetch' ] >[ 1 ],
-	undefined
->;
-export interface RestOptions extends RequestFetchOptions {
-	path: string;
-}
-
-async function rest< RestResponse = any >(
-	this: RequestUtils,
-	options: RestOptions
-): Promise< RestResponse > {
-	const { path, ...fetchOptions } = options;
-
-	if ( ! path ) {
-		throw new Error( '"path" is required to make a REST call' );
-	}
-
-	if ( ! this.storageState?.nonce || ! this.storageState?.rootURL ) {
-		await this.setupRest();
-	}
-
-	const relativePath = path.startsWith( '/' ) ? path.slice( 1 ) : path;
-
-	const url = this.storageState!.rootURL + relativePath;
-
-	try {
-		const response = await this.request.fetch( url, {
-			...fetchOptions,
-			failOnStatusCode: false,
-			headers: {
-				'X-WP-Nonce': this.storageState!.nonce,
-				...( fetchOptions.headers || {} ),
-			},
-		} );
-		const json: RestResponse = await response.json();
-
-		if ( ! response.ok() ) {
-			throw json;
-		}
-
-		return json;
-	} catch ( error ) {
-		// Nonce in invalid, retry again with a renewed nonce.
-		if (
-			typeof error === 'object' &&
-			error !== null &&
-			Object.prototype.hasOwnProperty.call( error, 'code' ) &&
-			( error as { code: string } ).code === 'rest_cookie_invalid_nonce'
-		) {
-			await this.setupRest();
-
-			return this.rest( options );
-		}
-
-		throw error;
-	}
-}
-
-/**
- * Get the maximum batch size for the REST API.
- *
- * @param this
- * @param forceRefetch Force revalidate the cached max batch size.
- */
-async function getMaxBatchSize( this: RequestUtils, forceRefetch = false ) {
-	if ( ! forceRefetch && this.maxBatchSize ) {
-		return this.maxBatchSize;
-	}
-
-	const response = await this.rest< {
-		endpoints: {
-			args: {
-				requests: {
-					maxItems: number;
-				};
-			};
-		}[];
-	} >( {
-		method: 'OPTIONS',
-		path: '/batch/v1',
-	} );
-	this.maxBatchSize = response.endpoints[ 0 ].args.requests.maxItems;
-	return this.maxBatchSize;
-}
-
-export interface BatchRequest {
-	method?: string;
-	path: string;
-	headers?: Record< string, string | string[] >;
-	body?: any;
-}
-
-async function batchRest< BatchResponse >(
-	this: RequestUtils,
-	requests: BatchRequest[]
-): Promise< BatchResponse[] > {
-	const maxBatchSize = await this.getMaxBatchSize();
-
-	if ( requests.length > maxBatchSize ) {
-		const chunks = splitRequestsToChunks( requests, maxBatchSize );
-
-		const chunkResponses = await Promise.all(
-			chunks.map( ( chunkRequests ) =>
-				this.batchRest< BatchResponse >( chunkRequests )
-			)
-		);
-
-		return chunkResponses.flat();
-	}
-
-	const batchResponses = await this.rest< {
-		failed?: string;
-		responses: BatchResponse[];
-	} >( {
-		method: 'POST',
-		path: '/batch/v1',
-		data: {
-			requests,
-			validation: 'require-all-validate',
-		},
-	} );
-
-	if ( batchResponses.failed ) {
-		throw batchResponses;
-	}
-
-	return batchResponses.responses;
-}
-
-export { setupRest, rest, getMaxBatchSize, batchRest };

package/src/request-utils/site-settings.ts

@@ -1,58 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-type SiteSettings = {
-	title: string;
-	description: string;
-	url: string;
-	email: string;
-	timezone: string;
-	date_format: string;
-	time_format: string;
-	start_of_week: number;
-	language: string;
-	use_smilies: boolean;
-	default_category: number;
-	default_post_format: string;
-	posts_per_page: number;
-	default_ping_status: 'open' | 'closed';
-	default_comment_status: 'open' | 'closed';
-	show_on_front: 'posts' | 'page';
-	page_on_front: number;
-	page_for_posts: number;
-};
-
-/**
- * Get the site settings.
- *
- * @see https://developer.wordpress.org/rest-api/reference/settings/#retrieve-a-site-setting
- *
- * @param this RequestUtils.
- */
-export async function getSiteSettings( this: RequestUtils ) {
-	return await this.rest< SiteSettings >( {
-		path: '/wp/v2/settings',
-		method: 'GET',
-	} );
-}
-
-/**
- * Update the site settings.
- *
- * @see https://developer.wordpress.org/rest-api/reference/settings/#update-a-site-setting
- *
- * @param this         RequestUtils.
- * @param siteSettings The partial settings payload to update.
- */
-export async function updateSiteSettings(
-	this: RequestUtils,
-	siteSettings: Partial< SiteSettings >
-) {
-	return await this.rest< SiteSettings >( {
-		path: '/wp/v2/settings',
-		method: 'POST',
-		data: siteSettings,
-	} );
-}

package/src/request-utils/templates.ts

@@ -1,83 +0,0 @@
-/**
- * Internal dependencies
- */
-import type { RequestUtils } from './index';
-
-type TemplateType = 'wp_template' | 'wp_template_part';
-
-interface Template {
-	wp_id: number;
-	id: string;
-}
-
-interface CreateTemplatePayload {
-	slug: string;
-	title?: string;
-	content?: string;
-	description?: string;
-}
-
-const PATH_MAPPING = {
-	wp_template: '/wp/v2/templates',
-	wp_template_part: '/wp/v2/template-parts',
-};
-
-/**
- * Delete all the templates of given type.
- *
- * @param this
- * @param type - Template type to delete.
- */
-async function deleteAllTemplates( this: RequestUtils, type: TemplateType ) {
-	const path = PATH_MAPPING[ type ];
-
-	if ( ! path ) {
-		throw new Error( `Unsupported template type: ${ type }.` );
-	}
-
-	const templates = await this.rest< Template[] >( { path } );
-
-	for ( const template of templates ) {
-		if ( ! template?.id || ! template?.wp_id ) {
-			continue;
-		}
-
-		try {
-			await this.rest( {
-				method: 'DELETE',
-				path: `${ path }/${ template.id }`,
-				params: { force: true },
-			} );
-		} catch ( responseError ) {
-			// Disable reason - the error provides valuable feedback about issues with tests.
-			// eslint-disable-next-line no-console
-			console.warn(
-				`deleteAllTemplates failed to delete template (id: ${ template.wp_id }) with the following error`,
-				responseError
-			);
-		}
-	}
-}
-
-/**
- * Creates a new template using the REST API.
- *
- * @param this
- * @param type    Template type to delete.
- * @param payload Template attributes.
- */
-async function createTemplate(
-	this: RequestUtils,
-	type: TemplateType,
-	payload: CreateTemplatePayload
-) {
-	const template = await this.rest< Template >( {
-		method: 'POST',
-		path: PATH_MAPPING[ type ],
-		params: { ...payload, type, status: 'publish', is_wp_suggestion: true },
-	} );
-
-	return template;
-}
-
-export { deleteAllTemplates, createTemplate };