Puppeteer fixes (codeceptjs#1136)

* improved bdd chapter, acceptance and changedlog

* fixed puppeteer

Author: DavertMik

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.3.1
+
+* [Puppeteer] Fixed process hanging for 30 seconds. Page loading timeout default via `getPageTimeout` set 0 seconds.
+* [Puppeteer] Improved displaying client-side console messages in debug mode.
+* [Puppeteer] Fixed closing sessions in `restart:false` mode for multi-session mode.
+
 ## 1.3.0
 
 * **Cucumber-style BDD Introduced [Gherkin support](https://codecept.io/bdd). Thanks to [David Vins](https://github.com/dvins) and [Omedym](https://www.omedym.com) for sponsoring this feature**.
@@ -30,6 +36,8 @@ Run it with `--features --steps` flag:
 codeceptjs run --steps --features
 ```
 
+---
+
 * **Brekaing Chnage** `run` command now uses relative path + test name to run exactly one test file.
 
 Previous behavior (removed):
@@ -43,6 +51,7 @@ codeceptjs run tests/basic_test.js
 ```
 This change allows using auto-completion when running a specific test.
 
+---
 
 * Nested steps output enabled for page objects.
     * to see high-level steps only run tests with `--steps` flag.

docs/basics.md

@@ -217,37 +217,9 @@ Scenario("Stop me faster", {timeout: 1000}, (I) => {});
 Scenario("Don't stop me", {timeout: 0}, (I) => {});
 ```
 
-### Retries
+## Retries
 
-#### Retry Feature
-
-Browser tests can be very fragile and some time you need to re run the few times just to make them pass.
-This can be done with `retries` option added to `Feature` declaration.
-
-CodeceptJS implements retries the same way [Mocha do](https://mochajs.org#retry-tests);
-You can set number of a retries for a feature:
-
-```js
-Feature('Complex JS Stuff').retry(3);
-```
-
-Every Scenario inside this feature will be rerun 3 times.
-You can make an exception for a specific scenario by passing `retries` option to a Scenario.
-
-#### Retry Scenario
-
-```js
-Scenario('Really complex', (I) => {
-  // test goes here
-}).retry(2);
-
-// alternative
-Scenario('Really complex', { retries: 2 }, (I) => {});
-```
-
-This scenario will be restarted two times on a failure
-
-#### Retry Step
+### Retry Step
 
 If you have a step which often fails you can retry execution for this single step.
 Use `retry()` function before an action to ask CodeceptJS to retry this step on failure:
@@ -281,6 +253,36 @@ I.retry({
 
 Pass a function to `when` option to  retry only when error matches the expected one.
 
+
+### Retry Scenario
+
+When you need to rerun scenarios few times just add `retries` option added to `Scenario` declaration.
+
+CodeceptJS implements retries the same way [Mocha do](https://mochajs.org#retry-tests);
+You can set number of a retries for a feature:
+
+```js
+Scenario('Really complex', (I) => {
+  // test goes here
+}).retry(2);
+
+// alternative
+Scenario('Really complex', { retries: 2 }, (I) => {});
+```
+
+This scenario will be restarted two times on a failure.
+
+### Retry Feature
+
+To set this option for all scenarios in a file, add retry to a feature:
+
+```js
+Feature('Complex JS Stuff').retry(3);
+```
+
+Every Scenario inside this feature will be rerun 3 times.
+You can make an exception for a specific scenario by passing `retries` option to a Scenario.
+
 ---
 
 ### done()

docs/bdd.md

@@ -71,13 +71,13 @@ Every step in this scenario requires a code which defines it.
 
 ## Gherkin
 
-Let's learn some more about Gherkin format and then we will see how to execute it with CodeceptJS. We can enable Gherkin for current project by running `gherkin:init` command:
+Let's learn some more about Gherkin format and then we will see how to execute it with CodeceptJS. We can enable Gherkin for current project by running `gherkin:init` command on **already initialized project**:
 
 ```
 codeceptjs gherkin:init
 ```
 
-It will add `gherkin` section to config. It will also prepare directories for features and step definition. And it will create the first feature file for you.
+It will add `gherkin` section to the current config. It will also prepare directories for features and step definition. And it will create the first feature file for you.
 
 ### Features
 

lib/helper/Puppeteer.js

@@ -9,9 +9,9 @@ const { empty } = require('../assert/empty');
 const { truth } = require('../assert/truth');
 const {
   xpathLocator,
+  ucfirst,
   fileExists,
   clearString,
-  decodeUrl,
   chunkArray,
   convertCssPropertiesToCamelCase,
 } = require('../utils');
@@ -49,8 +49,8 @@ const consoleLogStore = new Console();
  * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
  * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
  * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
- * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions)
- * * `getPageTimeout` (optional, default: '30000') config option to set maximum navigation time in milliseconds. Default is 30 seconds. Pass 0 to disable timeout.
+ * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions). Array values are accepted as well.
+ * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
  * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
  * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
  * * `userAgent`: (optional) user-agent string.
@@ -63,7 +63,7 @@ const consoleLogStore = new Console();
  * }
  * ```
  *
- * #### Sample Config
+ * #### Example #1: Wait for 0 network connections.
  *
  * ```json
  * {
@@ -78,7 +78,22 @@ const consoleLogStore = new Console();
  * }
  * ```
  *
- * #### Sample Config
+ * #### Example #2: Wait for DOMContentLoaded event and 0 netowrk connections
+ *
+ * ```json
+ * {
+ *    "helpers": {
+ *      "Puppeteer" : {
+ *        "url": "http://localhost",
+ *        "restart": false,
+ *        "waitForNavigation": "networkidle0",
+ *        "waitForAction": 500
+ *      }
+ *    }
+ * }
+ * ```
+ *
+ * #### Example #3: Debug in window mode
  *
  * ```json
  * {
@@ -124,7 +139,7 @@ class Puppeteer extends Helper {
       disableScreenshots: false,
       uniqueScreenshotNames: false,
       manualStart: false,
-      getPageTimeout: 30000,
+      getPageTimeout: 0,
       waitForNavigation: 'load',
       restart: true,
       keepCookies: false,
@@ -179,6 +194,12 @@ class Puppeteer extends Helper {
 
   async _after() {
     if (!this.isRunning) return;
+
+    // close other sessions
+    const contexts = this.browser.browserContexts();
+    contexts.shift();
+    await Promise.all(contexts.map(c => c.close()));
+
     if (this.options.restart) {
       this.isRunning = false;
       return this._stopBrowser();
@@ -194,9 +215,6 @@ class Puppeteer extends Helper {
       if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
     });
     await this.closeOtherTabs();
-    const contexts = this.browser.browserContexts();
-    contexts.shift();
-    await Promise.all(contexts.map(c => c.close()));
     return this.browser;
   }
 
@@ -301,6 +319,7 @@ class Puppeteer extends Helper {
     this._addPopupListener(page);
     this.page = page;
     if (!page) return;
+    page.setDefaultNavigationTimeout(this.options.getPageTimeout);
     this.context = await page.$('body');
     await page.bringToFront();
   }
@@ -441,7 +460,7 @@ class Puppeteer extends Helper {
     if (url.indexOf('http') !== 0) {
       url = this.options.url + url;
     }
-    await this.page.goto(url, { timeout: this.options.getPageTimeout, waitUntil: this.options.waitForNavigation });
+    await this.page.goto(url, { waitUntil: this.options.waitForNavigation });
     return this._waitForAction();
   }
 
@@ -2002,7 +2021,7 @@ function targetCreatedHandler(page) {
   this.withinLocator = null;
   page.on('load', frame => this.context = page.$('body'));
   page.on('console', (msg) => {
-    this.debugSection(msg.type(), msg.args().join(' '));
+    this.debugSection(`Browser:${ucfirst(msg.type())}`, (msg._text || '') + msg.args().join(' '));
     consoleLogStore.add(msg);
   });
 }