Merge pull request #273 from GuillaumeGomez/reduce-puppeteer-failures

Reduce puppeteer failures

Author: GuillaumeGomez

README.md

@@ -177,7 +177,7 @@ The list of fields of the `Options` class is the following:
  * `generateImages`: if provided, it'll generate test images and won't run comparison tests
  * `imageFolder`: path of the folder where screenshots are and where they are generated (`testFolder` value by default)
  * `noHeadless`: disable headless mode
- * `noScreenshot`: disable screenshots generation and comparison at the end of the scripts
+ * `noScreenshotComparison`: disable screenshots generation and comparison at the end of the scripts
  * `onPageCreatedCallback`: callback which is called when a new puppeteer page is created. It provides the puppeteer `page` and the test name as arguments.
  * `pauseOnError`: will pause indefinitely if an error occurs.
  * `permissions`: list of permissions to enable (you can see the full list by running with `--show-permissions`)

src/index.js

@@ -435,20 +435,25 @@ async function innerRunTests(logs, options) {
         return [logs.logs, failures];
     }
 
-    const browser = await utils.loadPuppeteer(options);
-    for (let i = 0; i < loaded.length; ++i) {
-        const ret = await runCommand(loaded[i], logs, options, browser);
-        if (ret !== Status.Ok) {
-            failures += 1;
+    try {
+        const browser = await utils.loadPuppeteer(options);
+        for (let i = 0; i < loaded.length; ++i) {
+            const ret = await runCommand(loaded[i], logs, options, browser);
+            if (ret !== Status.Ok) {
+                failures += 1;
+            }
         }
-    }
-    await browser.close();
+        await browser.close();
 
-    logs.append(
-        '\n<= doc-ui tests done: ' + (total - failures) + ' succeeded, ' + failures + ' failed');
+        logs.append(`\n<= doc-ui tests done: ${total - failures} succeeded, ${failures} failed`);
 
-    if (logs.showLogs === true) {
-        logs.append('');
+        if (logs.showLogs === true) {
+            logs.append('');
+        }
+    } catch (error) {
+        logs.append(`An exception occured: ${error.message}\n== STACKTRACE ==\n` +
+            `${new Error().stack}`);
+        return [logs.logs, 1];
     }
 
     return [logs.logs, failures];
@@ -475,13 +480,13 @@ async function innerRunTestCode(testName, content, options, showLogs, checkTestF
         if (ret !== Status.Ok) {
             return [logs.logs, 1];
         }
-
-        return [logs.logs, 0];
     } catch (error) {
         logs.append(`An exception occured: ${error.message}\n== STACKTRACE ==\n` +
             `${new Error().stack}`);
         return [logs.logs, 1];
     }
+
+    return [logs.logs, 0];
 }
 
 async function runTestCode(testName, content, options = new Options(), showLogs = false) {

src/puppeteer-wrapper.js

@@ -18,6 +18,20 @@ function buildPuppeteerOptions(options) {
     return puppeteer_options;
 }
 
+function check_if_known_error(error) {
+    const KNOWN_ERRORS = [
+        'Failed to launch the browser process!',
+        'read ECONNRESET',
+    ];
+
+    for (const known_error of KNOWN_ERRORS) {
+        if (error.message.indexOf(known_error) !== -1) {
+            return true;
+        }
+    }
+    return false;
+}
+
 class PuppeteerWrapper {
     constructor() {
         this.puppeteer = require('puppeteer');
@@ -26,7 +40,24 @@ class PuppeteerWrapper {
     }
 
     async init(options) {
-        this.browser = await this.puppeteer.launch(buildPuppeteerOptions(options));
+        let i;
+        let last_error;
+
+        for (i = 0; i < 3; ++i) {
+            try {
+                this.browser = await this.puppeteer.launch(buildPuppeteerOptions(options));
+            } catch (error) {
+                if (!check_if_known_error(error)) {
+                    throw error;
+                }
+                last_error = error;
+                continue;
+            }
+            break;
+        }
+        if (i === 3) {
+            throw last_error;
+        }
         if (options.incognito === true) {
             this.context = await this.browser.createIncognitoBrowserContext();
         }
@@ -49,7 +80,9 @@ class PuppeteerWrapper {
             await this.context.close();
             this.context = null;
         }
-        await this.browser.close();
+        if (this.browser !== null) {
+            await this.browser.close();
+        }
     }
 
     async overridePermissions(url, permissions) {