[Puppeteer] Use default tab instead of opening a new tab when starting the browser and new helper function I.grabNumberOfTabs (codeceptjs#918)

* [WebDriverIO] Added support for nested iframes in the within block

* Added the @Nightmare tags to the extended nested iframe tests

* Modified default window size because the a few tab tests were failing because the clickable element was not visible.

* Added acceptance tests for the within feature for both WebDriverIO and Nightmare

* Updated expected window height in webapi tests due to changing it in a previous commit

* Fixed initial window size in the SeleniumWebdriver and Nightmare Helpers so it matches with the tests now

* Change the example with nested iframes in the docs so it shows the full use of within for the sake of consistency

* merged from upstream branch

* Init. commit for adding iframe support to the puppeteer helper along with acceptance tests

* Adding I.switchTo and iframe array support in within blocks

* Minor fix when accessing the current context. When it is an element then the current page is used

* Merged nightmare and webdriverio helper files from the upstream master

* Updated contribution.md to include the new puppeteer acceptance tests

* Refactoring/cleanup before creating a pull request

* Updated docker config to work with the puppeteer tests

* Updated docs to include the new information about iframes with puppeteer

* [Rest] Removed conversion of the body to a json formatted string in the HTTP Requests (codeceptjs#779)

* Removed some comments and logic that is obsolete due to new support for within blocks and iframes

* [Puppeteer]: WIP: Adding support for I.acceptPopup, I.dismissPopup and I.seeInPopup

* [Puppeteer] Refactoring closeCurrentTab because it was failing sometimes due to a timing issue. Now the page object is first switch before closing the page. This error was picked up in the ci tests

* Adding function headers and refactoring some func names

* Adding support for dialog interactions include the default handling of dialogs when they occur

* Remove assert when grabbing text from the popup and changed the references to dialog to popup, and dimiss to cancel (except for the function calls and in the listener

* Added delay before interacting with the popup in Puppeteer

* [WebDriverIO] Added new function I.grabPopupText() to get the text in the popup without throwing an error if it does not exist.

* Added missing Puppeteer test options from codecept master

* Removed invalid references to Appium and moved the Popupstore class to a seperate file

* Fixing silent bug in Puppeteer where calling I.switchToNextTab and I.switchToPreviousTab would not throw an error if the index did not exist, because the index catered for array wrapping. The test was failing silently because there was not an explicit error being thrown in the case when no exception is thrown by the I.switchToNextTab function

* [Protractor] Added support for I.openNewTab, I.switchToNextTab, I.switchToPreviousTab, I.closeCurrentTab and refactoring of I.closeOtherTabs

* Added check if the url is chrome's special data:, url. When detected then the localstorage won't be cleared, because this page does not have any localstorage, thus causing an exception

* [Protractor] Replaced explicit setting of ignoreSynchronization with a call to browser.waitForAngularEnabled() function which was introduced in Protractor 5.x

* [Protractor|Puppeteer|WebDriverIO] Added I.closeOtherTabs and missing tests. Also fixed a type in the doc string

* [WebDriverIO|Puppeteer|Protractor] Added support for I.grabSource across the three helpers and added missing tests

* [Puppeteer] Added I.seeNumberOfElements

* [Protractor] Added I.seeNumberOfElements and tests

* Changed assertion error message to use double quotes around parameters so it matches the include.js assertion style.

* Adding the Error.message so the message can be accessed in the tests. Before the .message property was an empty string, i.e. ''

* [Puppeteer|WebDriverIO|Protractor] Adding I.seeTitleEquals across the Helpers

* [Puppeteer|Protractor] Adding support for I.seeTextEquals

* [Puppeteer] Extending support of _locateCheckable, I.seeInField and I.dontSeeInField. Corrections were required to the functions after adding all of the tests from WebDriverIO.

* [Puppeteer] Adding support for _locateFields

* [Puppeteer] Adding support for _locateClickable

* [Puppeteer] Adding I.scrollPageToTop and I.scrollPageToBottom

* Removed reference to Appium

* [Pupppeteer] Adding support for I.waitInUrl and I.waitUrlEquals

* [Puppeteer|Nightmare] Added support for I.waitForInvisible

* [Puppeteer] Added support for I.seeNumberOfVisibleElements and I.seeNumberOfVisibleElements

* Removed reference to Appium in Puppeteer helper

* [Puppeteer] Added support for I.grabCssPropertyFrom

* [Puppeteer] Added support for I.grabHTMLFrom

* [Pupppeteer] Added support for I.seeCssPropertiesOnElements.

* [Puppeteer] Added support for I.seeAttributesOnElements and changed I.grabAttributeFrom to have the same behaviour as I.seeAttributesOnElements

* [Puppeteer] Added support for I.rightClick

* [Mochawesome] Added null checking in _before hook which caused the codeceptjs shell mode to fail. Fixes codeceptjs#896

* [Puppeteer] Added support for I.grabBrowserLogs, and added tests for both Puppeteer and WebDriverIO

* [docs] Added option about supporting the --invert option with --grep

* [WebDriverIO] Fixing resizeWindow when resizing to 'maximize' which was previously not working. Also added unit test

* [Puppeteer] Performing the decodeUrl manually rather than by passing the function in. The function serialization wasn't working for some reason

* [WebDriverIO] Changed all arrow functions in webdriverio .execute calls so that it is compatible with older Internet Explorer versions.

* [WebDriverIO] Fixed lint issue in tests

* [Puppeteer] Fixed I.seeTextEquals function and test. The test was passing when it shouldn't have. Added strict matching option in proceedSee so it aligns with the behaviour in the WebDriverIO helper

* [WebDriverIO] Fixing test case for I.seeTextEquals. The catch block was not triggered. Now there is an explicit error to force the assertion in the catch block in case if the expected exception is not thrown (i.e. due to an error in the I.seeTextEquals function it self which causes a false positive

* [WebDriverIO] Refactoring how promises are resolved. Instead of resolving promises in parallel, now everything is done in serial. Reason being is that the tests were very flakey because random 'The connection was reset' or 'Invalid argument' errors were occuring. After some research it appears that the issue is with the chromedriver and too many parallel requests [https://bugs.chromium.org/p/chromedriver/issues/detail?id=2152#c9]. Now the tests are a lot more stable!

* [WebDriverIO] Removing some debug console statements, and set retries to 0, in order to highlight flakey tests quicker so they can be fixed

* [WebDriverIO] Refactoring async filter and foreach functions and proceedSeeField

* [Puppeteer] Refactoring proceedSeeInField

* [Puppeteer] Refactoring proceedSeeInField

* [Puppeteer] Added support for I.dragAndDrop and offset support in I.moveCursorTo

* [Puppeteer] Added support for I.scrollTo (though there are no tests yet)

* [WebDriverIO] Changed test retries to 1

* [Puppeteer|WebDriverIO|Protractor] Added new I.grabNumberOfTabs function

* [Puppeteer] Don't create a new page when launching the browser for the first time because a tab already exists. Fixes codeceptjs#908

* Moved I.grabNumberOfOpenTabs doc string to a common grabNumberOfOpenTabs.mustache doc file

Author: reubenmiller

docs/webapi/grabNumberOfOpenTabs.mustache

@@ -0,0 +1,5 @@
+Grab number of open tabs
+
+```js
+I.grabNumberOfOpenTabs();
+```

lib/helper/Protractor.js

@@ -874,6 +874,14 @@ class Protractor extends Helper {
     return client.switchTo().window(newHandle);
   }
 
+  /**
+   * {{> ../webapi/grabNumberOfOpenTabs }}
+   */
+  async grabNumberOfOpenTabs() {
+    const pages = await this.browser.getAllWindowHandles();
+    return pages.length;
+  }
+
   /**
    * {{> ../webapi/wait }}
    */

lib/helper/Puppeteer.js

@@ -216,23 +216,31 @@ class Puppeteer extends Helper {
 
   async _startBrowser() {
     this.browser = await puppeteer.launch(this.puppeteerOptions);
-    this.browser.on('targetcreated', (target) => {
-      target.page().then((page) => {
-        if (!page) return;
-        this.withinLocator = null;
-        page.on('load', frame => this.context = page.$('body'));
-        page.on('console', (msg) => {
-          this.debugSection(msg.type(), msg.args().join(' '));
-          consoleLogStore.add(msg);
-        });
+    const targetCreatedHandler = (page) => {
+      if (!page) return;
+      this.withinLocator = null;
+      page.on('load', frame => this.context = page.$('body'));
+      page.on('console', (msg) => {
+        this.debugSection(msg.type(), msg.args().join(' '));
+        consoleLogStore.add(msg);
       });
+    };
+    this.browser.on('targetcreated', (target) => {
+      target.page().then(page => targetCreatedHandler(page));
     });
 
     this.browser.on('targetchanged', (target) => {
       this.debugSection('Url', target.url());
     });
 
-    this._setPage(await this.browser.newPage());
+    const existingPages = await this.browser.pages();
+    const mainPage = existingPages[0] || await this.browser.newPage();
+
+    if (existingPages.length) {
+      // Run the handler as it will not be triggered if the page already exists
+      targetCreatedHandler(mainPage);
+    }
+    this._setPage(mainPage);
 
     if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0) {
       const dimensions = this.options.windowSize.split('x');
@@ -552,7 +560,8 @@ class Puppeteer extends Helper {
   async closeCurrentTab() {
     const oldPage = this.page;
     await this.switchToPreviousTab();
-    return oldPage.close();
+    await oldPage.close();
+    return this._waitForAction();
   }
 
   /**
@@ -570,7 +579,8 @@ class Puppeteer extends Helper {
     otherPages.forEach((page) => {
       p = p.then(() => page.close());
     });
-    return p;
+    await p;
+    return this._waitForAction();
   }
 
   /**
@@ -582,6 +592,15 @@ class Puppeteer extends Helper {
    */
   async openNewTab() {
     this._setPage(await this.browser.newPage());
+    return this._waitForAction();
+  }
+
+  /**
+   * {{> ../webapi/grabNumberOfOpenTabs }}
+   */
+  async grabNumberOfOpenTabs() {
+    const pages = await this.browser.pages();
+    return pages.length;
   }
 
   /**

lib/helper/WebDriverIO.js

@@ -1701,6 +1701,13 @@ class WebDriverIO extends Helper {
     return client.newWindow('about:blank');
   }
 
+  /**
+   * {{> ../webapi/grabNumberOfOpenTabs }}
+   */
+  async grabNumberOfOpenTabs() {
+    const pages = await this.browser.getTabIds();
+    return pages.length;
+  }
 
   /**
    * {{> ../webapi/refreshPage }}

test/helper/Protractor_test.js

@@ -380,8 +380,14 @@ describe('Protractor', function () {
     });
   });
 
-  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs', () => {
+  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs', () => {
+    it('should only have 1 tab open when the browser starts and navigates to the first page', () => I.amOnPage('/')
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
+
     it('should switch to next tab', () => I.amOnPage('/')
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1))
       .then(() => I.click('Get More Options'))
       .then(() => I.seeCurrentUrlEquals('/#/options'))
       .then(() => I.openNewTab())
@@ -391,7 +397,9 @@ describe('Protractor', function () {
       .then(() => I.switchToPreviousTab())
       .then(() => I.seeCurrentUrlEquals('/#/options'))
       .then(() => I.switchToNextTab())
-      .then(() => I.seeCurrentUrlEquals('/#/info')));
+      .then(() => I.seeCurrentUrlEquals('/#/info'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2)));
 
     it('should assert when there is no ability to switch to next tab', () => I.amOnPage('/')
       .then(() => I.click('Get More Options'))
@@ -414,10 +422,14 @@ describe('Protractor', function () {
       .then(() => I.seeInCurrentUrl('#/info'))
       .then(() => I.openNewTab())
       .then(() => I.amOnPage('/'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2))
       .then(() => I.seeInCurrentUrl('#/'))
       .then(() => I.dontSeeInCurrentUrl('#/info'))
       .then(() => I.closeCurrentTab())
-      .then(() => I.seeInCurrentUrl('#/info')));
+      .then(() => I.seeInCurrentUrl('#/info'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
 
     it('should close other tabs', () => I.amOnPage('/')
       .then(() => I.click('Get more info!'))
@@ -426,15 +438,23 @@ describe('Protractor', function () {
       .then(() => I.amOnPage('/'))
       .then(() => I.openNewTab())
       .then(() => I.amOnPage('/'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 3))
       .then(() => I.click('Get More Options'))
       .then(() => I.seeCurrentUrlEquals('/#/options'))
       .then(() => I.closeOtherTabs())
-      .then(() => I.seeCurrentUrlEquals('/#/options')));
+      .then(() => I.seeCurrentUrlEquals('/#/options'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
 
     it('should open new tab', () => I.amOnPage('/')
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1))
       .then(() => I.openNewTab())
       .then(() => I.amOutsideAngularApp())
-      .then(() => I.seeInCurrentUrl('about:blank')));
+      .then(() => I.seeInCurrentUrl('about:blank'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2)));
 
     it('should switch to previous tab', () => I.amOnPage('/')
       .then(() => I.click('Get more info!'))
@@ -443,7 +463,6 @@ describe('Protractor', function () {
       .then(() => I.seeInCurrentUrl('/#/'))
       .then(() => I.switchToPreviousTab())
       .then(() => I.wait(2))
-
       .then(() => I.seeInCurrentUrl('/#/info')));
   });
 

test/helper/Puppeteer_test.js

@@ -99,14 +99,23 @@ describe('Puppeteer', function () {
       .then(() => I.dontSee('Hovered', '#show')));
   });
 
-  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs', () => {
+  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs', () => {
+    it('should only have 1 tab open when the browser starts and navigates to the first page', () => I.amOnPage('/')
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
+
     it('should switch to next tab', () => I.amOnPage('/info')
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1))
       .then(() => I.click('New tab'))
       .then(() => I.switchToNextTab())
-      .then(() => I.seeCurrentUrlEquals('/login')));
+      .then(() => I.seeCurrentUrlEquals('/login'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2)));
 
     it('should assert when there is no ability to switch to next tab', () => I.amOnPage('/')
       .then(() => I.click('More info'))
+      .then(() => I.wait(1)) // Wait is required because the url is change by previous statement (maybe related to #914)
       .then(() => I.switchToNextTab(2))
       .then(() => assert.equal(true, false, 'Throw an error if it gets this far (which it should not)!'))
       .catch((e) => {
@@ -117,8 +126,12 @@ describe('Puppeteer', function () {
       .then(() => I.click('New tab'))
       .then(() => I.switchToNextTab())
       .then(() => I.seeInCurrentUrl('/login'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2))
       .then(() => I.closeCurrentTab())
-      .then(() => I.seeInCurrentUrl('/info')));
+      .then(() => I.seeInCurrentUrl('/info'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
 
     it('should close other tabs', () => I.amOnPage('/')
       .then(() => I.openNewTab())
@@ -128,17 +141,30 @@ describe('Puppeteer', function () {
       .then(() => I.switchToNextTab())
       .then(() => I.seeInCurrentUrl('/login'))
       .then(() => I.closeOtherTabs())
-      .then(() => I.seeInCurrentUrl('/login')));
+      .then(() => I.seeInCurrentUrl('/login'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
 
     it('should open new tab', () => I.amOnPage('/info')
       .then(() => I.openNewTab())
-      .then(() => I.seeInCurrentUrl('about:blank')));
+      .then(() => I.seeInCurrentUrl('about:blank'))
+      .then(() => I.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2)));
 
     it('should switch to previous tab', () => I.amOnPage('/info')
       .then(() => I.openNewTab())
       .then(() => I.seeInCurrentUrl('about:blank'))
       .then(() => I.switchToPreviousTab())
       .then(() => I.seeInCurrentUrl('/info')));
+
+    it('should assert when there is no ability to switch to previous tab', () => I.amOnPage('/info')
+      .then(() => I.openNewTab())
+      .then(() => I.waitInUrl('about:blank'))
+      .then(() => I.switchToPreviousTab(2))
+      .then(() => I.waitInUrl('/info'))
+      .catch((e) => {
+        assert.equal(e.message, 'There is no ability to switch to previous tab with offset 2');
+      }));
   });
 
   describe('popup : #acceptPopup, #seeInPopup, #cancelPopup, #grabPopupText', () => {

test/helper/WebDriverIO_test.js

@@ -321,23 +321,39 @@ describe('WebDriverIO', function () {
       .then(() => wd.dontSee('Hovered', '#show')));
   });
 
-  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs', () => {
+  describe('#switchToNextTab, #switchToPreviousTab, #openNewTab, #closeCurrentTab, #closeOtherTabs, #grabNumberOfOpenTabs', () => {
+    it('should only have 1 tab open when the browser starts and navigates to the first page', () => wd.amOnPage('/')
+      .then(() => wd.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
+
     it('should switch to next tab', () => wd.amOnPage('/info')
+      .then(() => wd.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1))
       .then(() => wd.click('New tab'))
       .then(() => wd.switchToNextTab())
-      .then(() => wd.waitInUrl('/login')));
+      .then(() => wd.waitInUrl('/login'))
+      .then(() => wd.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2)));
+
     it('should assert when there is no ability to switch to next tab', () => wd.amOnPage('/')
       .then(() => wd.click('More info'))
+      .then(() => wd.wait(1)) // Wait is required because the url is change by previous statement (maybe related to #914)
       .then(() => wd.switchToNextTab(2))
+      .then(() => assert.equal(true, false, 'Throw an error if it gets this far (which it should not)!'))
       .catch((e) => {
         assert.equal(e.message, 'There is no ability to switch to next tab with offset 2');
       }));
+
     it('should close current tab', () => wd.amOnPage('/info')
       .then(() => wd.click('New tab'))
       .then(() => wd.switchToNextTab())
-      .then(() => wd.waitInUrl('/login'))
+      .then(() => wd.seeInCurrentUrl('/login'))
+      .then(() => wd.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2))
       .then(() => wd.closeCurrentTab())
-      .then(() => wd.waitInUrl('/info')));
+      .then(() => wd.seeInCurrentUrl('/info'))
+      .then(() => wd.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
 
     it('should close other tabs', () => wd.amOnPage('/')
       .then(() => wd.openNewTab())
@@ -347,16 +363,22 @@ describe('WebDriverIO', function () {
       .then(() => wd.switchToNextTab())
       .then(() => wd.seeInCurrentUrl('/login'))
       .then(() => wd.closeOtherTabs())
-      .then(() => wd.seeInCurrentUrl('/login')));
+      .then(() => wd.seeInCurrentUrl('/login'))
+      .then(() => wd.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 1)));
 
     it('should open new tab', () => wd.amOnPage('/info')
       .then(() => wd.openNewTab())
-      .then(() => wd.waitInUrl('about:blank')));
+      .then(() => wd.waitInUrl('about:blank'))
+      .then(() => wd.grabNumberOfOpenTabs())
+      .then(numPages => assert.equal(numPages, 2)));
+
     it('should switch to previous tab', () => wd.amOnPage('/info')
       .then(() => wd.openNewTab())
       .then(() => wd.waitInUrl('about:blank'))
       .then(() => wd.switchToPreviousTab())
       .then(() => wd.waitInUrl('/info')));
+
     it('should assert when there is no ability to switch to previous tab', () => wd.amOnPage('/info')
       .then(() => wd.openNewTab())
       .then(() => wd.waitInUrl('about:blank'))