Fix 'Testcafe hungs if the window closed immediately after opening' (c…

…lose #3762) (#4786)
DevExpress · Feb 25, 2020 · 32005b2 · 32005b2
1 parent a37788a
commit 32005b2
Show file tree

Hide file tree

Showing 10 changed files with 99 additions and 5 deletions.
diff --git a/package.json b/package.json
@@ -116,7 +116,7 @@
     "source-map-support": "^0.5.16",
     "strip-bom": "^2.0.0",
     "testcafe-browser-tools": "2.0.9",
-    "testcafe-hammerhead": "16.1.2",
+    "testcafe-hammerhead": "16.1.3",
     "testcafe-legacy-api": "3.1.11",
     "testcafe-reporter-json": "^2.1.0",
     "testcafe-reporter-list": "^2.1.0",

diff --git a/src/client/driver/driver.js b/src/client/driver/driver.js
@@ -47,7 +47,8 @@ import {
     UncaughtErrorInCustomClientScriptLoadedFromModule,
     ChildWindowIsNotLoadedError,
     CannotSwitchToWindowError,
-    CloseChildWindowError
+    CloseChildWindowError,
+    ChildWindowClosedBeforeSwitchingError
 } from '../../errors/test-run';
 
 import BrowserConsoleMessages from '../../test-run/browser-console-messages';
@@ -585,6 +586,16 @@ export default class Driver extends serviceUtils.EventEmitter {
         return this._createWaitForEventPromise(EMPTY_COMMAND_EVENT, EMPTY_COMMAND_EVENT_WAIT_TIMEOUT);
     }
 
+    _abortSwitchingToChildWindowIfItClosed () {
+        if (!this.activeChildWindowDriverLink.driverWindow.closed)
+            return;
+
+        arrayUtils.remove(this.childWindowDriverLinks, this.activeChildWindowDriverLink);
+        this.activeChildWindowDriverLink = null;
+
+        throw new ChildWindowClosedBeforeSwitchingError();
+    }
+
     _switchToChildWindow (selector) {
         this.contextStorage.setItem(this.PENDING_WINDOW_SWITCHING_FLAG, true);
 
@@ -601,16 +612,23 @@ export default class Driver extends serviceUtils.EventEmitter {
                 return this._waitForEmptyCommand();
             })
             .then(() => {
+                this._abortSwitchingToChildWindowIfItClosed();
                 this._stopInternal();
 
                 return this.activeChildWindowDriverLink.setAsMaster();
             })
             .then(() => {
                 this.contextStorage.setItem(this.PENDING_WINDOW_SWITCHING_FLAG, false);
             })
-            .catch(() => {
+            .catch(err => {
                 this.contextStorage.setItem(this.PENDING_WINDOW_SWITCHING_FLAG, false);
 
+                if (err instanceof ChildWindowClosedBeforeSwitchingError) {
+                    this._onReady(new DriverStatus());
+
+                    return;
+                }
+
                 this._onReady(new DriverStatus({
                     isCommandResult: true,
                     executionError:  new CannotSwitchToWindowError()

diff --git a/src/errors/test-run/index.js b/src/errors/test-run/index.js
@@ -618,3 +618,9 @@ export class RequestHookNotImplementedMethodError extends TestRunErrorBase {
     }
 }
 
+export class ChildWindowClosedBeforeSwitchingError extends TestRunErrorBase {
+    constructor () {
+        super(TEST_RUN_ERRORS.childWindowClosedBeforeSwitchingError);
+    }
+}
+
diff --git a/src/errors/test-run/templates.js b/src/errors/test-run/templates.js
@@ -330,5 +330,9 @@ export default {
 
     [TEST_RUN_ERRORS.closeChildWindowError]: () => `
         An error occurred while closing child windows.
+    `,
+
+    [TEST_RUN_ERRORS.childWindowClosedBeforeSwitchingError]: () => `
+        The child window was closed before TestCafe could switch to it.
     `
 };
diff --git a/src/errors/types.js b/src/errors/types.js
@@ -72,7 +72,8 @@ export const TEST_RUN_ERRORS = {
     childWindowIsNotLoadedError:                           'E68',
     childWindowNotFoundError:                              'E69',
     cannotSwitchToWindowError:                             'E70',
-    closeChildWindowError:                                 'E71'
+    closeChildWindowError:                                 'E71',
+    childWindowClosedBeforeSwitchingError:                 'E72'
 };
 
 export const RUNTIME_ERRORS = {

diff --git a/...un-options/allow-multiple-windows/pages/close-window-immediately-after-opening/index.html b/...un-options/allow-multiple-windows/pages/close-window-immediately-after-opening/index.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Index page</title>
+</head>
+<body>
+    <button id="openPopUp">Open pop-up window</button>
+    <div>
+        <span id="openWndResult"></span>
+    </div>
+    <script>
+        var openPopUpBtn      = document.getElementById('openPopUp');
+        var openWndResultSpan = document.getElementById('openWndResult');
+
+        openPopUpBtn.addEventListener('click', function () {
+            var wnd = window.open('about:blank', '', "left=9999, top=9999, height=100,width=100");
+
+            wnd.focus();
+            wnd.blur();
+            wnd.close();
+
+            openWndResultSpan.textContent = 'The window was closed.';
+        });
+    </script>
+</body>
+</html>
diff --git a/test/functional/fixtures/run-options/allow-multiple-windows/test.js b/test/functional/fixtures/run-options/allow-multiple-windows/test.js
@@ -42,4 +42,8 @@ describe('Allow multiple windows', () => {
                 expect(errs[0]).to.contain('A JavaScript error occurred on "http://localhost:3000/fixtures/run-options/allow-multiple-windows/pages/handle-errors/page-with-js-error.html"');
             });
     });
+
+    it('Close the window immediately after opening (GH-3762)', () => {
+        return runTests('testcafe-fixtures/close-window-immediately-after-opeping.js', null, { allowMultipleWindows: true });
+    });
 });
diff --git a/...ptions/allow-multiple-windows/testcafe-fixtures/close-window-immediately-after-opeping.js b/...ptions/allow-multiple-windows/testcafe-fixtures/close-window-immediately-after-opeping.js
@@ -0,0 +1,10 @@
+import { Selector } from 'testcafe';
+
+fixture `Close window immediately after opening`
+    .page('http://localhost:3000/fixtures/run-options/allow-multiple-windows/pages/close-window-immediately-after-opening/index.html');
+
+test('test', async t => {
+    await t
+        .click('#openPopUp')
+        .expect(Selector('#openWndResult').textContent).eql('The window was closed.');
+});
diff --git a/test/server/data/expected-test-run-errors/child-window-closed-before-switching-error b/test/server/data/expected-test-run-errors/child-window-closed-before-switching-error
@@ -0,0 +1,19 @@
+The child window was closed before TestCafe could switch to it.
+
+Browser: Chrome 15.0.874.120 / macOS 10.15
+Screenshot: /unix/path/with/<tag>
+
+   18 |function func1 () {
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
+   20 |}
+   21 |
+   22 |(function func2 () {
+ > 23 |    func1();
+   24 |})();
+   25 |
+   26 |stackTrace.filter.deattach(stackFilter);
+   27 |
+   28 |module.exports = record;
+
+   at func2 (testfile.js:23:5)
+   at Object.<anonymous> (testfile.js:24:3)
diff --git a/test/server/test-run-error-formatting-test.js b/test/server/test-run-error-formatting-test.js
@@ -75,7 +75,8 @@ const {
     ChildWindowIsNotLoadedError,
     ChildWindowNotFoundError,
     CannotSwitchToWindowError,
-    CloseChildWindowError
+    CloseChildWindowError,
+    ChildWindowClosedBeforeSwitchingError
 } = require('../../lib/errors/test-run');
 
 const untestedErrorTypes = Object.keys(TEST_RUN_ERRORS).map(key => TEST_RUN_ERRORS[key]);
@@ -414,6 +415,10 @@ describe('Error formatting', () => {
         it('Should format "closeChildWindowError"', () => {
             assertErrorMessage('close-child-window-error', new CloseChildWindowError());
         });
+
+        it('Should format "childWindowClosedBeforeSwitchingError"', () => {
+            assertErrorMessage('child-window-closed-before-switching-error', new ChildWindowClosedBeforeSwitchingError());
+        });
     });
 
     describe('Test coverage', () => {