packages/e2e-test-utils-playwright/src/request-utils/plugins.ts - trunk - githubmirror/gutenberg

packages/e2e-test-utils-playwright/src/request-utils/plugins.ts

96 строк2 KB

Marco Ciampini

ESLint: Replace strict config with bulk suppressions (#81248)

07 авг 2026, 14:34

07 авг 2026, 14:347f43eaf

import { paramCase as kebabCase } from 'change-case';
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 };