feat: waitForNumberOfTabs (#4124)

Author: kobenguyent

docs/helpers/Playwright.md

@@ -2492,6 +2492,21 @@ See [Playwright's reference][41]
 
 -   `options` **any**  
 
+### waitForNumberOfTabs
+
+Waits for number of tabs.
+
+```js
+I.waitForNumberOfTabs(2);
+```
+
+#### Parameters
+
+-   `expectedTabs` **[number][20]** expecting the number of tabs.
+-   `sec` **[number][20]** number of secs to wait.
+
+Returns **void** automatically synchronized promise through #recorder
+
 ### waitForRequest
 
 Waits for a network request.

docs/helpers/Puppeteer.md

@@ -2101,6 +2101,21 @@ See [Puppeteer's reference][23]
 
 -   `opts` **any**  
 
+### waitForNumberOfTabs
+
+Waits for number of tabs.
+
+```js
+I.waitForNumberOfTabs(2);
+```
+
+#### Parameters
+
+-   `expectedTabs` **[number][10]** expecting the number of tabs.
+-   `sec` **[number][10]** number of secs to wait.
+
+Returns **void** automatically synchronized promise through #recorder
+
 ### waitForRequest
 
 Waits for a network request.

docs/helpers/WebDriver.md

@@ -2337,6 +2337,21 @@ I.waitForInvisible('#popup');
 
 Returns **void** automatically synchronized promise through #recorder
 
+### waitForNumberOfTabs
+
+Waits for number of tabs.
+
+```js
+I.waitForNumberOfTabs(2);
+```
+
+#### Parameters
+
+-   `expectedTabs` **[number][22]** expecting the number of tabs.
+-   `sec` **[number][22]** number of secs to wait.
+
+Returns **void** automatically synchronized promise through #recorder
+
 ### waitForText
 
 Waits for a text to appear (by default waits for 1sec).

docs/webapi/waitForNumberOfTabs.mustache

@@ -0,0 +1,9 @@
+Waits for number of tabs.
+
+```js
+I.waitForNumberOfTabs(2);
+```
+
+@param {number} expectedTabs expecting the number of tabs.
+@param {number} sec number of secs to wait.
+@returns {void} automatically synchronized promise through #recorder

lib/helper/Playwright.js

@@ -2584,6 +2584,24 @@ class Playwright extends Helper {
     });
   }
 
+  /**
+   * {{> waitForNumberOfTabs }}
+   */
+  async waitForNumberOfTabs(expectedTabs, sec) {
+    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
+    let currentTabs;
+    let count = 0;
+
+    do {
+      currentTabs = await this.grabNumberOfOpenTabs();
+      await this.wait(1);
+      count += 1000;
+      if (currentTabs >= expectedTabs) return;
+    } while (count <= waitTimeout);
+
+    throw new Error(`Expected ${expectedTabs} tabs are not met after ${waitTimeout / 1000} sec.`);
+  }
+
   async _getContext() {
     if (this.context && this.context.constructor.name === 'FrameLocator') {
       return this.context;

lib/helper/Puppeteer.js

@@ -2151,6 +2151,24 @@ class Puppeteer extends Helper {
     });
   }
 
+  /**
+   * {{> waitForNumberOfTabs }}
+   */
+  async waitForNumberOfTabs(expectedTabs, sec) {
+    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
+    let currentTabs;
+    let count = 0;
+
+    do {
+      currentTabs = await this.grabNumberOfOpenTabs();
+      await this.wait(1);
+      count += 1000;
+      if (currentTabs >= expectedTabs) return;
+    } while (count <= waitTimeout);
+
+    throw new Error(`Expected ${expectedTabs} tabs are not met after ${waitTimeout / 1000} sec.`);
+  }
+
   async _getContext() {
     if (this.context && this.context.constructor.name === 'Frame') {
       return this.context;

lib/helper/WebDriver.js

@@ -2374,6 +2374,24 @@ class WebDriver extends Helper {
     return this.browser.waitUntil(async () => this.browser.execute(fn, ...args), { timeout: aSec * 1000, timeoutMsg: '' });
   }
 
+  /**
+   * {{> waitForNumberOfTabs }}
+   */
+  async waitForNumberOfTabs(expectedTabs, sec) {
+    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeoutInSeconds;
+    let currentTabs;
+    let count = 0;
+
+    do {
+      currentTabs = await this.grabNumberOfOpenTabs();
+      await this.wait(1);
+      count += 1000;
+      if (currentTabs >= expectedTabs) return;
+    } while (count <= waitTimeout);
+
+    throw new Error(`Expected ${expectedTabs} tabs are not met after ${waitTimeout / 1000} sec.`);
+  }
+
   /**
    * {{> switchTo }}
    */

test/helper/Playwright_test.js

@@ -256,7 +256,7 @@ describe('Playwright', function () {
       .then(() => I.dontSee('Hovered', '#show')));
   });
 
-  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs', () => {
+  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs, #waitForNumberOfTabs', () => {
     it('should only have 1 tab open when the browser starts and navigates to the first page', () => I.amOnPage('/')
       .then(() => I.wait(1))
       .then(() => I.grabNumberOfOpenTabs())
@@ -298,13 +298,13 @@ describe('Playwright', function () {
 
     it('should close other tabs', () => I.amOnPage('/')
       .then(() => I.openNewTab())
-      .then(() => I.wait(1))
+      .then(() => I.waitForNumberOfTabs(2))
       .then(() => I.seeInCurrentUrl('about:blank'))
       .then(() => I.amOnPage('/info'))
       .then(() => I.openNewTab())
       .then(() => I.amOnPage('/login'))
       .then(() => I.closeOtherTabs())
-      .then(() => I.wait(1))
+      .then(() => I.waitForNumberOfTabs(1))
       .then(() => I.seeInCurrentUrl('/login'))
       .then(() => I.grabNumberOfOpenTabs())
       .then(numPages => assert.equal(numPages, 1)));

test/helper/Puppeteer_test.js

@@ -226,7 +226,7 @@ describe('Puppeteer', function () {
       .then(() => I.dontSee('Hovered', '#show')));
   });
 
-  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs', () => {
+  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs, #waitForNumberOfTabs', () => {
     it('should only have 1 tab open when the browser starts and navigates to the first page', () => I.amOnPage('/')
       .then(() => I.wait(1))
       .then(() => I.grabNumberOfOpenTabs())
@@ -238,7 +238,7 @@ describe('Puppeteer', function () {
       .then(numPages => assert.equal(numPages, 1))
       .then(() => I.click('New tab'))
       .then(() => I.switchToNextTab())
-      .then(() => I.wait(2))
+      .then(() => I.waitForNumberOfTabs(2))
       .then(() => I.seeCurrentUrlEquals('/login'))
       .then(() => I.grabNumberOfOpenTabs())
       .then(numPages => assert.equal(numPages, 2)));

test/helper/WebDriver_test.js

@@ -601,7 +601,7 @@ describe('WebDriver', function () {
     });
   });
 
-  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs', () => {
+  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs, #waitForNumberOfTabs', () => {
     it('should only have 1 tab open when the browser starts and navigates to the first page', async () => {
       await wd.amOnPage('/');
       const numPages = await wd.grabNumberOfOpenTabs();
@@ -614,6 +614,7 @@ describe('WebDriver', function () {
       assert.equal(numPages, 1);
 
       await wd.click('New tab');
+      await wd.waitForNumberOfTabs(2);
       await wd.switchToNextTab();
       await wd.waitInUrl('/login');
       const numPagesAfter = await wd.grabNumberOfOpenTabs();