Should not stop while async report methods are executing (closes DevE…

…xpress#3835)
AlexKamaev · Jun 3, 2019 · 683f7f0 · 683f7f0
1 parent 1a603cd
commit 683f7f0
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 1 deletion.
diff --git a/src/reporter/index.js b/src/reporter/index.js
@@ -17,6 +17,8 @@ export default class Reporter {
         this.stopOnFirstFail = task.opts.stopOnFirstFail;
         this.outStream       = outStream;
 
+        this.pendingTaskDonePromise = Reporter._createPendingPromise();
+
         this._assignTaskEventHandlers();
     }
 
@@ -186,6 +188,8 @@ export default class Reporter {
             };
 
             await this.plugin.reportTaskDone(endTime, this.passed, task.warningLog.messages, result);
+
+            this.pendingTaskDonePromise.resolve();
         });
     }
 

diff --git a/src/runner/index.js b/src/runner/index.js
@@ -112,7 +112,10 @@ export default class Runner extends EventEmitter {
         const browserSetErrorPromise = promisifyEvent(browserSet, 'error');
 
         const taskDonePromise = task.once('done')
-            .then(() => browserSetErrorPromise.cancel());
+            .then(() => browserSetErrorPromise.cancel())
+            .then(() => {
+                return Promise.all(reporters.map(reporter => reporter.pendingTaskDonePromise));
+            });
 
 
         const promises = [

diff --git a/test/functional/fixtures/regression/gh-3835/pages/index.html b/test/functional/fixtures/regression/gh-3835/pages/index.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <title></title>
+</head>
+<body>
+</body>
+</html>
diff --git a/test/functional/fixtures/regression/gh-3835/test.js b/test/functional/fixtures/regression/gh-3835/test.js
@@ -0,0 +1,51 @@
+const expect = require('chai').expect;
+
+function timeout (ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+let startedReportTaskCount  = 0;
+let finishedReportTaskCount = 0;
+
+
+const getReporter = function (delay) {
+    return {
+        name: () => {
+            return {
+                reportTestDone () {
+                },
+                reportFixtureStart: () => {
+                },
+                reportTaskStart: () => {
+                },
+                reportTaskDone: async () => {
+                    startedReportTaskCount++;
+
+                    await timeout(delay);
+
+                    finishedReportTaskCount++;
+                }
+            };
+        },
+        output: {
+            write: () => {
+            },
+            end: () => {
+            }
+        }
+    };
+};
+
+describe('[Regression](GH-3835) - Should not stop while async report methods are executiing', function () {
+    const reporters = [ getReporter(1), getReporter(500), getReporter(1000) ];
+
+    it('Click on hidden element recreated on timeout', function () {
+        return runTests('testcafe-fixtures/index.js', null, { reporter: reporters })
+            .then(() => {
+                expect(finishedReportTaskCount).eql(startedReportTaskCount);
+                expect(finishedReportTaskCount).eql(reporters.length);
+            });
+    });
+});
+
+
diff --git a/test/functional/fixtures/regression/gh-3835/testcafe-fixtures/index.js b/test/functional/fixtures/regression/gh-3835/testcafe-fixtures/index.js
@@ -0,0 +1,5 @@
+fixture `Should not stop while async report methods are executing (GH-3835)`
+    .page `http://localhost:3000/fixtures/regression/gh-3835/pages/index.html`;
+
+test(`Custom async reporters with delay`, async () => {
+});