Merge pull request #16478 from mozilla/change-selector-objects

ashrivastava-qa · web-flow · commit 7f6172ccbfa5 · 2024-02-27T15:03:25.000-05:00
update waitForSelector() to page.locator()
diff --git a/packages/functional-tests/pages/cookiesDisabled.ts b/packages/functional-tests/pages/cookiesDisabled.ts
@@ -7,19 +7,17 @@ import { BaseLayout } from './layout';
 export class CookiesDisabledPage extends BaseLayout {
   readonly path = 'cookies_disabled';
 
-  async waitForCookiesDisabledHeader() {
-    await this.page.waitForSelector('.card-header', {
-      timeout: 3000,
-    });
+  async cookiesDisabledHeader() {
+    const header = this.page.locator('.card-header');
+    await header.waitFor();
+    return header;
   }
 
   async clickRetry() {
     return this.page.getByRole('button', { name: 'Try again' }).click();
   }
 
   async isCookiesDiabledError() {
-    return this.page
-      .getByText('Local storage or cookies are still disabled')
-      .isVisible();
+    return this.page.getByText('Local storage or cookies are still disabled');
   }
 }
diff --git a/packages/functional-tests/pages/login.ts b/packages/functional-tests/pages/login.ts
@@ -253,16 +253,12 @@ export class LoginPage extends BaseLayout {
     return header.isVisible();
   }
 
-  async waitForSignUpCodeHeader() {
-    await this.page.waitForSelector(selectors.SIGN_UP_CODE_HEADER, {
-      timeout: 3000,
-    });
+  signUpCodeHeader() {
+    return this.page.locator(selectors.SIGN_UP_CODE_HEADER);
   }
 
-  async waitForSignInCodeHeader() {
-    await this.page.waitForSelector(selectors.SIGN_IN_CODE_HEADER, {
-      timeout: 2000,
-    });
+  signInCodeHeader() {
+    return this.page.locator(selectors.SIGN_IN_CODE_HEADER);
   }
 
   async confirmEmail() {
@@ -303,10 +299,8 @@ export class LoginPage extends BaseLayout {
     return this.page.locator(selectors.PERMISSION_ACCEPT).click();
   }
 
-  async waitForSigninUnblockHeader() {
-    await this.page.waitForSelector(selectors.SIGNIN_UNBLOCK_HEADER, {
-      timeout: 2000,
-    });
+  signInUnblockHeader() {
+    return this.page.locator(selectors.SIGNIN_UNBLOCK_HEADER);
   }
 
   async signInError() {
@@ -411,9 +405,9 @@ export class LoginPage extends BaseLayout {
   }
 
   async waitForPasswordHeader() {
-    await this.page.waitForSelector(selectors.PASSWORD_HEADER, {
-      timeout: 4000,
-    });
+    const header = this.page.locator(selectors.PASSWORD_HEADER);
+    await header.waitFor();
+    return header;
   }
 
   async clickSignIn() {
diff --git a/packages/functional-tests/pages/relier.ts b/packages/functional-tests/pages/relier.ts
@@ -75,7 +75,7 @@ export class RelierPage extends BaseLayout {
   }
 
   async promptNoneError() {
-    await this.page.waitForSelector('.error');
+    this.page.locator('.error');
     return this.page.innerText('.error');
   }
 
diff --git a/packages/functional-tests/tests/misc/cookiesDisabled.spec.ts b/packages/functional-tests/tests/misc/cookiesDisabled.spec.ts
@@ -24,13 +24,13 @@ test.describe('cookies disabled', () => {
 
     //Verify the Cookies disabled header
     await page.waitForURL(/\/cookies_disabled/);
-    await cookiesDisabled.waitForCookiesDisabledHeader();
+    expect(await cookiesDisabled.cookiesDisabledHeader()).toBeVisible();
 
     //Click retry
     await cookiesDisabled.clickRetry();
 
     //Verify the error
-    expect(await cookiesDisabled.isCookiesDiabledError()).toBe(true);
+    expect(await cookiesDisabled.isCookiesDiabledError()).toBeVisible();
   });
 
   test('synthesize enabling cookies by visiting the enter email page, then cookies_disabled, then clicking "try again', async ({
@@ -56,7 +56,7 @@ test.describe('cookies disabled', () => {
 
     //Verify the Cookies disabled header
     await page.waitForURL(/\/cookies_disabled/);
-    await cookiesDisabled.waitForCookiesDisabledHeader();
+    expect(await cookiesDisabled.cookiesDisabledHeader()).toBeVisible();
 
     //Click retry
     await cookiesDisabled.clickRetry();
@@ -84,6 +84,6 @@ test.describe('cookies disabled', () => {
     await page.waitForTimeout(500);
 
     //Verify the Cookies disabled header
-    await cookiesDisabled.waitForCookiesDisabledHeader();
+    expect(await cookiesDisabled.cookiesDisabledHeader()).toBeVisible();
   });
 });
diff --git a/packages/functional-tests/tests/oauth/oauthPermissions.spec.ts b/packages/functional-tests/tests/oauth/oauthPermissions.spec.ts
@@ -35,7 +35,7 @@ test.describe('severity-1 #smoke', () => {
       await login.fillOutFirstSignUp(email, password, { verify: false });
 
       //no permissions asked for, straight to confirm
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
     });
 
     test('signup with `prompt=consent`', async ({
@@ -56,7 +56,7 @@ test.describe('severity-1 #smoke', () => {
       await login.acceptOauthPermissions();
 
       //Verify sign up code header
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
     });
   });
 
diff --git a/packages/functional-tests/tests/oauth/oauthPromptNone.spec.ts b/packages/functional-tests/tests/oauth/oauthPromptNone.spec.ts
@@ -119,6 +119,7 @@ test.describe('severity-1 #smoke', () => {
       target,
       pages: { relier, login },
     }) => {
+      test.fixme(true, 'test to be fixed, see FXA-9194');
       await target.auth.signUp(email, password, {
         lang: 'en',
         preVerified: 'false',
@@ -129,7 +130,7 @@ test.describe('severity-1 #smoke', () => {
       await login.fillOutEmailFirstSignIn(email, password);
 
       //Verify sign up code header
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
 
       const query = new URLSearchParams({
         login_hint: email,
diff --git a/packages/functional-tests/tests/oauth/signUp.spec.ts b/packages/functional-tests/tests/oauth/signUp.spec.ts
@@ -39,7 +39,7 @@ test.describe('severity-1 #smoke', () => {
       await login.fillOutFirstSignUp(email, password, { verify: false });
 
       //Verify sign up code header
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
 
       await login.fillOutSignUpCode(email);
 
@@ -58,7 +58,7 @@ test.describe('severity-1 #smoke', () => {
       await login.fillOutFirstSignUp(bouncedEmail, password, { verify: false });
 
       //Verify sign up code header
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
       await client.accountDestroy(bouncedEmail, password);
 
       //Verify error message
@@ -71,7 +71,7 @@ test.describe('severity-1 #smoke', () => {
       await login.fillOutFirstSignUp(email, password, { verify: false });
 
       //Verify sign up code header
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
       await login.fillOutSignUpCode(email);
 
       //Verify logged in on relier page
diff --git a/packages/functional-tests/tests/signUp/signUp.spec.ts b/packages/functional-tests/tests/signUp/signUp.spec.ts
@@ -47,7 +47,7 @@ test.describe('severity-2 #smoke', () => {
       });
 
       // Verify the confirm code header and the email
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
       expect(await login.confirmEmail()).toContain(emailWithoutSpace);
 
       // Need to clear the cache to get the new email
@@ -60,7 +60,7 @@ test.describe('severity-2 #smoke', () => {
       await login.fillOutFirstSignUp(emailWithSpace, password, {
         verify: false,
       });
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
       expect(await login.confirmEmail()).toContain(emailWithoutSpace);
     });
 
diff --git a/packages/functional-tests/tests/signin/signIn.spec.ts b/packages/functional-tests/tests/signin/signIn.spec.ts
@@ -121,7 +121,7 @@ test.describe('severity-2 #smoke', () => {
       await login.fillOutEmailFirstSignIn(email, password);
 
       // Verify the header after login
-      await login.waitForSignInCodeHeader();
+      expect(login.signInCodeHeader()).toBeVisible();
       await target.auth.accountDestroy(email, password);
       await page.waitForURL(/signin_bounced/);
 
diff --git a/packages/functional-tests/tests/signin/signinBlocked.spec.ts b/packages/functional-tests/tests/signin/signinBlocked.spec.ts
@@ -53,7 +53,7 @@ test.describe('severity-2 #smoke', () => {
       await login.fillOutEmailFirstSignIn(blockedEmail, password);
 
       //Verify sign in block header
-      await login.waitForSigninUnblockHeader();
+      expect(login.signInUnblockHeader()).toBeVisible();
       expect(await login.getUnblockEmail()).toContain(blockedEmail);
 
       //Unblock the email
@@ -74,7 +74,7 @@ test.describe('severity-2 #smoke', () => {
       await login.fillOutEmailFirstSignIn(blockedEmail, password);
 
       //Verify sign in block header
-      await login.waitForSigninUnblockHeader();
+      expect(login.signInUnblockHeader()).toBeVisible();
       expect(await login.getUnblockEmail()).toContain(blockedEmail);
       await login.enterUnblockCode('incorrect');
 
@@ -101,7 +101,7 @@ test.describe('severity-2 #smoke', () => {
       await login.fillOutEmailFirstSignIn(blockedEmail, password);
 
       //Verify sign in block header
-      await login.waitForSigninUnblockHeader();
+      expect(login.signInUnblockHeader()).toBeVisible();
       expect(await login.getUnblockEmail()).toContain(blockedEmail);
 
       //Click resend link
@@ -144,7 +144,7 @@ test.describe('severity-2 #smoke', () => {
       await login.fillOutEmailFirstSignIn(newEmail, password);
 
       //Verify sign in block header
-      await login.waitForSigninUnblockHeader();
+      expect(login.signInUnblockHeader()).toBeVisible();
       expect(await login.getUnblockEmail()).toContain(newEmail);
 
       //Unblock the email
@@ -161,14 +161,14 @@ test.describe('severity-2 #smoke', () => {
       await login.fillOutEmailFirstSignIn(unverifiedEmail, password);
 
       //Verify sign in block header
-      await login.waitForSigninUnblockHeader();
+      expect(login.signInUnblockHeader()).toBeVisible();
       expect(await login.getUnblockEmail()).toContain(unverifiedEmail);
 
       //Unblock the email
       await login.unblock(unverifiedEmail);
 
       //Verify confirm code header
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
 
       await login.fillOutSignInCode(unverifiedEmail);
 
diff --git a/packages/functional-tests/tests/signin/signinCached.spec.ts b/packages/functional-tests/tests/signin/signinCached.spec.ts
@@ -174,6 +174,7 @@ test.describe('severity-2 #smoke', () => {
     test('unverified cached signin redirects to confirm email', async ({
       target,
     }) => {
+      test.fixme(true, 'test to be fixed, see FXA-9194');
       const { page, login } = syncBrowserPages;
       const email_unverified = login.createEmail();
       await target.auth.signUp(email_unverified, password, {
@@ -186,7 +187,7 @@ test.describe('severity-2 #smoke', () => {
       await login.fillOutEmailFirstSignIn(email_unverified, password);
 
       //Verify sign up code header is visible
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
       await page.goto(target.contentServerUrl, {
         waitUntil: 'load',
       });
@@ -195,7 +196,7 @@ test.describe('severity-2 #smoke', () => {
       await login.clickSignIn();
 
       //Cached login should still go to email confirmation screen for unverified accounts
-      await login.waitForSignUpCodeHeader();
+      expect(login.signUpCodeHeader()).toBeVisible();
 
       //Fill the code and submit
       await login.fillOutSignUpCode(email_unverified);
diff --git a/packages/functional-tests/tests/syncV3/settings.spec.ts b/packages/functional-tests/tests/syncV3/settings.spec.ts
@@ -34,7 +34,7 @@ test.describe('severity-2 #smoke', () => {
       );
       await login.respondToWebChannelMessage(customEventDetail);
       await login.fillOutEmailFirstSignIn(email, firstPassword);
-      await login.waitForSignInCodeHeader();
+      expect(login.signInCodeHeader()).toBeVisible();
 
       await login.checkWebChannelMessage(FirefoxCommand.LinkAccount);
       await login.fillOutSignInCode(email);
diff --git a/packages/functional-tests/tests/syncV3/signUp.spec.ts b/packages/functional-tests/tests/syncV3/signUp.spec.ts
@@ -138,7 +138,7 @@ test.describe('severity-1 #smoke', () => {
       );
 
       // Verify user lands on the sign in password page
-      await login.waitForPasswordHeader();
+      expect(await login.waitForPasswordHeader()).toBeVisible();
 
       // Verify the correct email is displayed
       expect(await login.getPrefilledEmail()).toContain(credentials.email);
diff --git a/packages/functional-tests/tests/syncV3/signinCached.spec.ts b/packages/functional-tests/tests/syncV3/signinCached.spec.ts
@@ -44,14 +44,15 @@ test.describe('severity-2 #smoke', () => {
     test('sign in on desktop then specify a different email on query parameter continues to cache desktop signin', async ({
       target,
     }) => {
+      test.fixme(true, 'test to be fixed, see FXA-9194');
       const { page, login, connectAnotherDevice } = syncBrowserPages;
       await page.goto(
         `${target.contentServerUrl}?context=fx_desktop_v3&service=sync`
       );
       await login.fillOutEmailFirstSignIn(email, password);
 
       //Verify sign up code header is visible
-      await login.waitForSignInCodeHeader();
+      expect(login.signInCodeHeader()).toBeVisible();
 
       const query = { email: email2 };
       const queryParam = new URLSearchParams(query);
@@ -85,14 +86,15 @@ test.describe('severity-2 #smoke', () => {
     test('sign in with desktop context then no context, desktop credentials should persist', async ({
       target,
     }) => {
+      test.fixme(true, 'test to be fixed, see FXA-9194');
       const { page, login } = syncBrowserPages;
       await page.goto(
         `${target.contentServerUrl}?context=fx_desktop_v3&service=sync`
       );
       await login.fillOutEmailFirstSignIn(email, password);
 
       //Verify sign up code header is visible
-      await login.waitForSignInCodeHeader();
+      expect(login.signInCodeHeader()).toBeVisible();
 
       await page.goto(target.contentServerUrl, {
         waitUntil: 'load',
diff --git a/packages/functional-tests/tests/syncV3/syncV3EmailFirst.spec.ts b/packages/functional-tests/tests/syncV3/syncV3EmailFirst.spec.ts
@@ -65,7 +65,7 @@ test.describe('Firefox Desktop Sync v3 email first', () => {
     await login.submit();
 
     // Verify user is redirected to the password page
-    await login.waitForPasswordHeader();
+    expect(await login.waitForPasswordHeader()).toBeVisible();
 
     //Refresh the page
     await page.reload({ waitUntil: 'load' });

Original file line number	Diff line number	Diff line change
`@@ -7,19 +7,17 @@ import { BaseLayout } from './layout';`
`7`	`7`	`export class CookiesDisabledPage extends BaseLayout {`
`8`	`8`	`readonly path = 'cookies_disabled';`
`9`	`9`
`10`		`- async waitForCookiesDisabledHeader() {`
`11`		`- await this.page.waitForSelector('.card-header', {`
`12`		`- timeout: 3000,`
`13`		`- });`
	`10`	`+ async cookiesDisabledHeader() {`
	`11`	`+ const header = this.page.locator('.card-header');`
	`12`	`+ await header.waitFor();`
	`13`	`+ return header;`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`async clickRetry() {`
`17`	`17`	`return this.page.getByRole('button', { name: 'Try again' }).click();`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`async isCookiesDiabledError() {`
`21`		`- return this.page`
`22`		`- .getByText('Local storage or cookies are still disabled')`
`23`		`- .isVisible();`
	`21`	`+ return this.page.getByText('Local storage or cookies are still disabled');`
`24`	`22`	`}`
`25`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -253,16 +253,12 @@ export class LoginPage extends BaseLayout {`
`253`	`253`	`return header.isVisible();`
`254`	`254`	`}`
`255`	`255`
`256`		`- async waitForSignUpCodeHeader() {`
`257`		`- await this.page.waitForSelector(selectors.SIGN_UP_CODE_HEADER, {`
`258`		`- timeout: 3000,`
`259`		`- });`
	`256`	`+ signUpCodeHeader() {`
	`257`	`+ return this.page.locator(selectors.SIGN_UP_CODE_HEADER);`
`260`	`258`	`}`
`261`	`259`
`262`		`- async waitForSignInCodeHeader() {`
`263`		`- await this.page.waitForSelector(selectors.SIGN_IN_CODE_HEADER, {`
`264`		`- timeout: 2000,`
`265`		`- });`
	`260`	`+ signInCodeHeader() {`
	`261`	`+ return this.page.locator(selectors.SIGN_IN_CODE_HEADER);`
`266`	`262`	`}`
`267`	`263`
`268`	`264`	`async confirmEmail() {`
`@@ -303,10 +299,8 @@ export class LoginPage extends BaseLayout {`
`303`	`299`	`return this.page.locator(selectors.PERMISSION_ACCEPT).click();`
`304`	`300`	`}`
`305`	`301`
`306`		`- async waitForSigninUnblockHeader() {`
`307`		`- await this.page.waitForSelector(selectors.SIGNIN_UNBLOCK_HEADER, {`
`308`		`- timeout: 2000,`
`309`		`- });`
	`302`	`+ signInUnblockHeader() {`
	`303`	`+ return this.page.locator(selectors.SIGNIN_UNBLOCK_HEADER);`
`310`	`304`	`}`
`311`	`305`
`312`	`306`	`async signInError() {`
`@@ -411,9 +405,9 @@ export class LoginPage extends BaseLayout {`
`411`	`405`	`}`
`412`	`406`
`413`	`407`	`async waitForPasswordHeader() {`
`414`		`- await this.page.waitForSelector(selectors.PASSWORD_HEADER, {`
`415`		`- timeout: 4000,`
`416`		`- });`
	`408`	`+ const header = this.page.locator(selectors.PASSWORD_HEADER);`
	`409`	`+ await header.waitFor();`
	`410`	`+ return header;`
`417`	`411`	`}`
`418`	`412`
`419`	`413`	`async clickSignIn() {`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ export class RelierPage extends BaseLayout {`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`async promptNoneError() {`
`78`		`- await this.page.waitForSelector('.error');`
	`78`	`+ this.page.locator('.error');`
`79`	`79`	`return this.page.innerText('.error');`
`80`	`80`	`}`
`81`	`81`