Separate utils into PageUtils and RequestUtils

packages/e2e-test-utils-playwright/README.md

@@ -16,12 +16,25 @@ npm install @wordpress/e2e-test-utils-playwright --save-dev
 
 ## API
 
-### TestUtils
+### PageUtils
 
 Create the test utils instance of the current page.
 
 ```js
-const testUtils = new TestUtils( page );
+const pageUtils = new PageUtils( page );
+```
+
+### RequestUtils
+
+Create the request utils instance of the request instance.
+
+```js
+const requestUtils = await RequestUtils.setup( {
+	user: {
+		username: 'admin',
+		password: 'password',
+	},
+} );
 ```
 
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

packages/e2e-test-utils-playwright/package.json

@@ -35,6 +35,7 @@
 		"@wordpress/keycodes": "file:../keycodes",
 		"@wordpress/url": "file:../url",
 		"form-data": "^4.0.0",
+		"lodash": "^4.17.21",
 		"node-fetch": "^2.6.0"
 	},
 	"peerDependencies": {

packages/e2e-test-utils-playwright/src/shared/config.js → packages/e2e-test-utils-playwright/src/config.ts

@@ -1,7 +1,7 @@
 const WP_ADMIN_USER = {
 	username: 'admin',
 	password: 'password',
-};
+} as const;
 
 const {
 	WP_USERNAME = WP_ADMIN_USER.username,

packages/e2e-test-utils-playwright/src/index.ts

@@ -1,63 +1,5 @@
-/**
- * External dependencies
- */
-import type { Browser, Page, BrowserContext } from '@playwright/test';
-
 /**
  * Internal dependencies
  */
-import { activatePlugin } from './activate-plugin';
-import { activateTheme } from './activate-theme';
-import { deleteAllBlocks } from './blocks';
-import { clickBlockToolbarButton } from './click-block-toolbar-button';
-import { createNewPost } from './create-new-post';
-import { createURL } from './create-url';
-import { deactivatePlugin } from './deactivate-plugin';
-import { getCurrentUser } from './get-current-user';
-import { getPageError } from './get-page-error';
-import { isCurrentURL } from './is-current-url';
-import { loginUser } from './login-user';
-import { deleteAllPosts } from './posts';
-import {
-	rest as __experimentalRest,
-	batch as __experimentalBatch,
-} from './rest-api';
-import { showBlockToolbar } from './show-block-toolbar';
-import { switchUserToAdmin } from './switch-user-to-admin';
-import { switchUserToTest } from './switch-user-to-test';
-import { visitAdminPage } from './visit-admin-page';
-import { deleteAllWidgets } from './widgets';
-
-class TestUtils {
-	browser: Browser;
-	page: Page;
-	context: BrowserContext;
-
-	constructor( page: Page ) {
-		this.page = page;
-		this.context = page.context();
-		this.browser = this.context.browser()!;
-	}
-
-	activatePlugin = activatePlugin;
-	activateTheme = activateTheme;
-	clickBlockToolbarButton = clickBlockToolbarButton;
-	createNewPost = createNewPost;
-	createURL = createURL;
-	deactivatePlugin = deactivatePlugin;
-	deleteAllBlocks = deleteAllBlocks;
-	deleteAllPosts = deleteAllPosts;
-	getCurrentUser = getCurrentUser;
-	getPageError = getPageError;
-	isCurrentURL = isCurrentURL;
-	loginUser = loginUser;
-	showBlockToolbar = showBlockToolbar;
-	switchUserToAdmin = switchUserToAdmin;
-	switchUserToTest = switchUserToTest;
-	visitAdminPage = visitAdminPage;
-	deleteAllWidgets = deleteAllWidgets;
-	__experimentalRest = __experimentalRest;
-	__experimentalBatch = __experimentalBatch;
-}
-
-export { TestUtils };
+export { PageUtils } from './page';
+export { RequestUtils } from './request';

packages/e2e-test-utils-playwright/src/click-block-toolbar-button.js → packages/e2e-test-utils-playwright/src/page/click-block-toolbar-button.js

@@ -1,7 +1,7 @@
 /**
  * Clicks a block toolbar button.
  *
- * @this {import('./').TestUtils}
+ * @this {import('./').PageUtils}
  * @param {string} label  The text string of the button label.
  * @param {string} [type] The type of button label: 'ariaLabel' or 'content'.
  */

packages/e2e-test-utils-playwright/src/create-new-post.js → packages/e2e-test-utils-playwright/src/page/create-new-post.js

@@ -6,7 +6,7 @@ import { addQueryArgs } from '@wordpress/url';
 /**
  * Creates new post.
  *
- * @this {import('./').TestUtils}
+ * @this {import('./').PageUtils}
  * @param {Object}  object                    Object to create new post, along with tips enabling option.
  * @param {string}  [object.postType]         Post type of the new post.
  * @param {string}  [object.title]            Title of the new post.

packages/e2e-test-utils-playwright/src/get-current-user.js → packages/e2e-test-utils-playwright/src/page/get-current-user.js

@@ -1,7 +1,7 @@
 /**
  * Get the username of the user that's currently logged into WordPress (if any).
  *
- * @this {import('./').TestUtils}
+ * @this {import('./').PageUtils}
  * @return {string?} username The user that's currently logged into WordPress (if any).
  */
 export async function getCurrentUser() {

packages/e2e-test-utils-playwright/src/get-page-error.js → packages/e2e-test-utils-playwright/src/page/get-page-error.js

@@ -15,7 +15,7 @@ const REGEXP_PHP_ERROR = /(<b>)?(Fatal error|Recoverable fatal error|Warning|Par
  *
  * @see http://php.net/manual/en/function.error-reporting.php
  *
- * @this {import('./').TestUtils}
+ * @this {import('./').PageUtils}
  * @return {Promise<?string>} Promise resolving to a string or null, depending
  *                            whether a page error is present.
  */

packages/e2e-test-utils-playwright/src/page/index.ts

@@ -0,0 +1,43 @@
+/**
+ * External dependencies
+ */
+import type { Browser, Page, BrowserContext } from '@playwright/test';
+
+/**
+ * Internal dependencies
+ */
+import { clickBlockToolbarButton } from './click-block-toolbar-button';
+import { createNewPost } from './create-new-post';
+import { getCurrentUser } from './get-current-user';
+import { getPageError } from './get-page-error';
+import { isCurrentURL } from './is-current-url';
+import { loginUser } from './login-user';
+import { showBlockToolbar } from './show-block-toolbar';
+import { switchUserToAdmin } from './switch-user-to-admin';
+import { switchUserToTest } from './switch-user-to-test';
+import { visitAdminPage } from './visit-admin-page';
+
+class PageUtils {
+	browser: Browser;
+	page: Page;
+	context: BrowserContext;
+
+	constructor( page: Page ) {
+		this.page = page;
+		this.context = page.context();
+		this.browser = this.context.browser()!;
+	}
+
+	clickBlockToolbarButton = clickBlockToolbarButton;
+	createNewPost = createNewPost;
+	getCurrentUser = getCurrentUser;
+	getPageError = getPageError;
+	isCurrentURL = isCurrentURL;
+	loginUser = loginUser;
+	showBlockToolbar = showBlockToolbar;
+	switchUserToAdmin = switchUserToAdmin;
+	switchUserToTest = switchUserToTest;
+	visitAdminPage = visitAdminPage;
+}
+
+export { PageUtils };

packages/e2e-test-utils-playwright/src/page/is-current-url.js

@@ -0,0 +1,18 @@
+/**
+ * Internal dependencies
+ */
+import { WP_BASE_URL } from '../config';
+
+/**
+ * Checks if current URL is a WordPress path.
+ *
+ * @this {import('./').PageUtils}
+ * @param {string} WPPath String to be serialized as pathname.
+ * @return {boolean} Boolean represents whether current URL is or not a WordPress path.
+ */
+export function isCurrentURL( WPPath ) {
+	const currentURL = new URL( this.page.url() );
+	const expectedURL = new URL( WPPath, WP_BASE_URL );
+
+	return expectedURL.pathname === currentURL.pathname;
+}

packages/e2e-test-utils-playwright/src/login-user.js → packages/e2e-test-utils-playwright/src/page/login-user.js

@@ -1,12 +1,12 @@
 /**
  * Internal dependencies
  */
-import { WP_USERNAME, WP_PASSWORD } from './shared/config';
+import { WP_USERNAME, WP_PASSWORD } from '../config';
 
 /**
  * Performs log in with specified username and password.
  *
- * @this {import('./').TestUtils}
+ * @this {import('./').PageUtils}
  * @param {?string} username String to be used as user credential.
  * @param {?string} password String to be used as user credential.
  */
@@ -15,7 +15,7 @@ export async function loginUser(
 	password = WP_PASSWORD
 ) {
 	if ( ! this.isCurrentURL( 'wp-login.php' ) ) {
-		await this.page.goto( this.createURL( 'wp-login.php' ) );
+		await this.page.goto( 'wp-login.php' );
 	}
 
 	await this.page.press( '#user_login', 'Control+A' );