Rename folders for pageUtils and requestUtils and move isCurrentUrl b…

…ack to pageUtils
WordPress · May 5, 2022 · 40365bf · 40365bf
1 parent b14538e
commit 40365bf
Show file tree

Hide file tree

Showing 21 changed files with 32 additions and 28 deletions.
diff --git a/packages/e2e-test-utils-playwright/src/admin/index.ts b/packages/e2e-test-utils-playwright/src/admin/index.ts
@@ -11,24 +11,25 @@ import type { Browser, Page, BrowserContext } from '@playwright/test';
  */
 import { createNewPost } from './create-new-post';
 import { getPageError } from './get-page-error';
-import { isCurrentURL } from './is-current-url';
 import { visitAdminPage } from './visit-admin-page';
 import { visitSiteEditor } from './visit-site-editor';
+import type { PageUtils } from '../page-utils';
 
 export class Admin {
 	browser: Browser;
 	page: Page;
+	pageUtils: PageUtils;
 	context: BrowserContext;
 
-	constructor( page: Page ) {
+	constructor( page: Page, pageUtils: PageUtils ) {
 		this.page = page;
 		this.context = page.context();
 		this.browser = this.context.browser()!;
+		this.pageUtils = pageUtils;
 	}
 
 	createNewPost = createNewPost;
 	getPageError = getPageError;
-	isCurrentURL = isCurrentURL;
 	visitAdminPage = visitAdminPage;
 	visitSiteEditor = visitSiteEditor;
 }
diff --git a/packages/e2e-test-utils-playwright/src/admin/is-current-url.ts b/packages/e2e-test-utils-playwright/src/admin/is-current-url.ts
diff --git a/packages/e2e-test-utils-playwright/src/admin/visit-admin-page.ts b/packages/e2e-test-utils-playwright/src/admin/visit-admin-page.ts
@@ -25,14 +25,14 @@ export async function visitAdminPage(
 	);
 
 	// Handle upgrade required screen
-	if ( this.isCurrentURL( 'wp-admin/upgrade.php' ) ) {
+	if ( this.pageUtils.isCurrentURL( 'wp-admin/upgrade.php' ) ) {
 		// Click update
 		await this.page.click( '.button.button-large.button-primary' );
 		// Click continue
 		await this.page.click( '.button.button-large' );
 	}
 
-	if ( this.isCurrentURL( 'wp-login.php' ) ) {
+	if ( this.pageUtils.isCurrentURL( 'wp-login.php' ) ) {
 		throw new Error( 'Not logged in' );
 	}
 

diff --git a/packages/e2e-test-utils-playwright/src/index.ts b/packages/e2e-test-utils-playwright/src/index.ts
@@ -10,6 +10,6 @@ selectors.register( 'role', selectorScript, { contentScript: true } );
 
 export { Admin } from './admin';
 export { Editor } from './editor';
-export { PageUtils } from './page';
-export { RequestUtils } from './request';
+export { PageUtils } from './page-utils';
+export { RequestUtils } from './request-utils';
 export { test, expect } from './test';
diff --git a/...e-test-utils-playwright/src/page/index.ts → ...-utils-playwright/src/page-utils/index.ts b/...e-test-utils-playwright/src/page/index.ts → ...-utils-playwright/src/page-utils/index.ts
@@ -6,6 +6,7 @@ import type { Browser, Page, BrowserContext } from '@playwright/test';
 /**
  * Internal dependencies
  */
+import { isCurrentURL } from './is-current-url';
 import {
 	setClipboardData,
 	pressKeyWithModifier,
@@ -24,6 +25,7 @@ class PageUtils {
 		this.browser = this.context.browser()!;
 	}
 
+	isCurrentURL = isCurrentURL;
 	pressKeyTimes = pressKeyTimes;
 	pressKeyWithModifier = pressKeyWithModifier;
 	setBrowserViewport = setBrowserViewport;

diff --git a/packages/e2e-test-utils-playwright/src/page-utils/is-current-url.ts b/packages/e2e-test-utils-playwright/src/page-utils/is-current-url.ts
@@ -0,0 +1,20 @@
+/**
+ * Internal dependencies
+ */
+import { WP_BASE_URL } from '../config';
+import type { PageUtils } from './';
+
+/**
+ * Checks if current path of the URL matches the provided path.
+ *
+ * @param {PageUtils} this
+ * @param {string}    path String to be serialized as pathname.
+ *
+ * @return {boolean} Boolean represents whether current URL is or not a WordPress path.
+ */
+export function isCurrentURL( this: PageUtils, path: string ) {
+	const currentURL = new URL( this.page.url() );
+	const expectedURL = new URL( path, WP_BASE_URL );
+
+	return expectedURL.pathname === currentURL.pathname;
+}
diff --git a/...ls-playwright/src/page/press-key-times.js → ...ywright/src/page-utils/press-key-times.js b/...ls-playwright/src/page/press-key-times.js → ...ywright/src/page-utils/press-key-times.js
diff --git a/...right/src/page/press-key-with-modifier.ts → ...src/page-utils/press-key-with-modifier.ts b/...right/src/page/press-key-with-modifier.ts → ...src/page-utils/press-key-with-modifier.ts
diff --git a/...aywright/src/page/set-browser-viewport.js → ...ht/src/page-utils/set-browser-viewport.js b/...aywright/src/page/set-browser-viewport.js → ...ht/src/page-utils/set-browser-viewport.js
diff --git a/...st-utils-playwright/src/request/blocks.js → ...ls-playwright/src/request-utils/blocks.js b/...st-utils-playwright/src/request/blocks.js → ...ls-playwright/src/request-utils/blocks.js
diff --git a/...est-utils-playwright/src/request/index.ts → ...ils-playwright/src/request-utils/index.ts b/...est-utils-playwright/src/request/index.ts → ...ils-playwright/src/request-utils/index.ts
diff --git a/...est-utils-playwright/src/request/login.ts → ...ils-playwright/src/request-utils/login.ts b/...est-utils-playwright/src/request/login.ts → ...ils-playwright/src/request-utils/login.ts
diff --git a/...est-utils-playwright/src/request/media.ts → ...ils-playwright/src/request-utils/media.ts b/...est-utils-playwright/src/request/media.ts → ...ils-playwright/src/request-utils/media.ts
diff --git a/...t-utils-playwright/src/request/plugins.ts → ...s-playwright/src/request-utils/plugins.ts b/...t-utils-playwright/src/request/plugins.ts → ...s-playwright/src/request-utils/plugins.ts
diff --git a/...est-utils-playwright/src/request/posts.js → ...ils-playwright/src/request-utils/posts.js b/...est-utils-playwright/src/request/posts.js → ...ils-playwright/src/request-utils/posts.js
diff --git a/...ils-playwright/src/request/preferences.ts → ...aywright/src/request-utils/preferences.ts b/...ils-playwright/src/request/preferences.ts → ...aywright/src/request-utils/preferences.ts
diff --git a/...test-utils-playwright/src/request/rest.ts → ...tils-playwright/src/request-utils/rest.ts b/...test-utils-playwright/src/request/rest.ts → ...tils-playwright/src/request-utils/rest.ts
diff --git a/...utils-playwright/src/request/templates.ts → ...playwright/src/request-utils/templates.ts b/...utils-playwright/src/request/templates.ts → ...playwright/src/request-utils/templates.ts
diff --git a/...st-utils-playwright/src/request/themes.ts → ...ls-playwright/src/request-utils/themes.ts b/...st-utils-playwright/src/request/themes.ts → ...ls-playwright/src/request-utils/themes.ts
diff --git a/...t-utils-playwright/src/request/widgets.js → ...s-playwright/src/request-utils/widgets.js b/...t-utils-playwright/src/request/widgets.js → ...s-playwright/src/request-utils/widgets.js
diff --git a/packages/e2e-test-utils-playwright/src/test.ts b/packages/e2e-test-utils-playwright/src/test.ts
@@ -106,8 +106,8 @@ const test = base.extend<
 		requestUtils: RequestUtils;
 	}
 >( {
-	admin: async ( { page }, use ) => {
-		await use( new Admin( page ) );
+	admin: async ( { page, pageUtils }, use ) => {
+		await use( new Admin( page, pageUtils ) );
 	},
 	page: async ( { page }, use ) => {
 		page.on( 'console', observeConsoleLogging );