Handle SIGINT via async-exit-hook (closes DevExpress#1378)

bin/testcafe-with-v8-flag-filter.js

@@ -5,4 +5,4 @@
 var path          = require('path');
 var v8FlagsFilter = require('bin-v8-flags-filter');
 
-v8FlagsFilter(path.join(__dirname, '../lib/cli'));
+v8FlagsFilter(path.join(__dirname, '../lib/cli'), { useShutdownMessage: true });

package.json

@@ -54,14 +54,15 @@
     "prepublish": "publish-please guard"
   },
   "dependencies": {
+    "async-exit-hook": "^1.1.2",
     "babel-core": "^6.22.1",
     "babel-plugin-transform-class-properties": "^6.24.1",
     "babel-plugin-transform-runtime": "^6.22.0",
     "babel-preset-env": "^1.1.8",
     "babel-preset-flow": "^6.23.0",
     "babel-preset-stage-2": "^6.22.0",
     "babel-runtime": "^6.22.0",
-    "bin-v8-flags-filter": "^1.0.0",
+    "bin-v8-flags-filter": "^1.1.1",
     "callsite": "^1.0.0",
     "callsite-record": "^4.0.0",
     "chai": "^3.0.0",
@@ -78,7 +79,7 @@
     "is-ci": "^1.0.10",
     "is-glob": "^2.0.1",
     "lodash": "^4.13.1",
-    "log-update": "^1.0.2",
+    "log-update-async-hook": "^2.0.2",
     "map-reverse": "^1.0.1",
     "mkdirp": "^0.5.1",
     "moment": "^2.10.3",

src/browser/connection/gateway.js

@@ -75,8 +75,9 @@ export default class BrowserConnectionGateway {
 
     static onHeartbeat (req, res, connection) {
         if (BrowserConnectionGateway.ensureConnectionReady(res, connection)) {
-            connection.heartbeat();
-            res.end();
+            var status = connection.heartbeat();
+
+            respondWithJSON(res, status);
         }
     }
 

src/browser/connection/index.js

@@ -7,6 +7,7 @@ import { readSync as read } from 'read-file-relative';
 import promisifyEvent from 'promisify-event';
 import shortId from 'shortid';
 import COMMAND from './command';
+import STATUS from './status';
 import { GeneralError } from '../../errors/runtime';
 import MESSAGE from '../../errors/runtime/message';
 
@@ -36,6 +37,7 @@ export default class BrowserConnection extends EventEmitter {
         this.provider = browserInfo.provider;
 
         this.permanent        = permanent;
+        this.closing          = false;
         this.closed           = false;
         this.ready            = false;
         this.opened           = false;
@@ -164,9 +166,11 @@ export default class BrowserConnection extends EventEmitter {
     }
 
     close () {
-        if (this.closed)
+        if (this.closed || this.closing)
             return;
 
+        this.closing = true;
+
         this._closeBrowser()
             .then(() => {
                 this.browserConnectionGateway.stopServingConnection(this);
@@ -193,6 +197,11 @@ export default class BrowserConnection extends EventEmitter {
     heartbeat () {
         clearTimeout(this.heartbeatTimeout);
         this._waitForHeartbeat();
+
+        return {
+            code: this.closing ? STATUS.closing : STATUS.ok,
+            url:  this.closing ? this.idleUrl : ''
+        };
     }
 
     renderIdlePage () {

src/browser/connection/status.js

@@ -0,0 +1,4 @@
+export default {
+    ok:      'ok',
+    closing: 'closing'
+};

src/browser/provider/index.js

@@ -195,6 +195,14 @@ export default class BrowserProvider {
     }
 
     async closeBrowser (browserId) {
+        var isLocalBrowser    = await this.plugin.isLocalBrowser(browserId);
+        var supportedFeatures = await this.plugin.hasCustomActionForBrowser(browserId);
+
+        if (isLocalBrowser && !supportedFeatures.hasCloseBrowser) {
+            await this.plugin.closeBrowser(this.windowDescriptors[browserId]);
+            return;
+        }
+
         await this.plugin.closeBrowser(browserId);
     }
 

src/browser/provider/plugin-host.js

@@ -87,6 +87,7 @@ export default class BrowserProviderPluginHost {
 
     async hasCustomActionForBrowser (/* browserId */) {
         return {
+            hasCloseBrowser:                this.hasOwnProperty('closeBrowser'),
             hasResizeWindow:                this.hasOwnProperty('resizeWindow'),
             hasTakeScreenshot:              this.hasOwnProperty('takeScreenshot'),
             hasCanResizeWindowToDimensions: this.hasOwnProperty('canResizeWindowToDimensions'),

src/cli/index.js

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
 import resolveCwd from 'resolve-cwd';
+import setupExitHook from 'async-exit-hook';
 import browserProviderPool from '../browser/provider/pool';
 import { GeneralError, APIError } from '../errors/runtime';
 import MESSAGE from '../errors/runtime/message';
@@ -8,8 +9,50 @@ import log from './log';
 import remotesWizard from './remotes-wizard';
 import createTestCafe from '../';
 
-function exit (code) {
+
+const TERMINATION_TYPES = {
+    sigint:   'sigint',
+    shutdown: 'shutdown'
+};
+
+var showMessageOnExit = true;
+var exiting           = false;
+
+var handledSignalsCount = {
+    [TERMINATION_TYPES.sigint]:   0,
+    [TERMINATION_TYPES.shutdown]: 0
+};
+
+function exitHandler () {
+    if (!showMessageOnExit)
+        return;
+
     log.hideSpinner();
+    log.write('Stopping TestCafe...');
+    log.showSpinner();
+
+    process.on('exit', () => log.hideSpinner(true));
+}
+
+function forcedExitHandler (terminationType) {
+    handledSignalsCount[terminationType]++;
+
+    if (exiting || handledSignalsCount[terminationType] < 2)
+        return;
+
+    exiting = true;
+
+    exit(0);
+}
+
+function setupForcedExitHandler () {
+    process.on('SIGINT', () => forcedExitHandler(TERMINATION_TYPES.sigint));
+
+    process.on('message', message => message === 'shutdown' && forcedExitHandler(TERMINATION_TYPES.shutdown));
+}
+
+function exit (code) {
+    log.hideSpinner(true);
 
     // NOTE: give a process time to flush the output.
     // It's necessary in some environments.
@@ -70,6 +113,7 @@ async function runTests (argParser) {
     }
 
     finally {
+        showMessageOnExit = false;
         await testCafe.close();
     }
 
@@ -115,6 +159,9 @@ function useLocalInstallation () {
     if (useLocalInstallation())
         return;
 
+    setupExitHook(exitHandler);
+    setupForcedExitHandler(forcedExitHandler);
+
     try {
         var argParser = new CliArgumentParser();
 
@@ -126,6 +173,7 @@ function useLocalInstallation () {
             await runTests(argParser);
     }
     catch (err) {
+        showMessageOnExit = false;
         error(err);
     }
 })();

src/cli/log.js

@@ -1,6 +1,6 @@
 import tty from 'tty';
 import elegantSpinner from 'elegant-spinner';
-import logUpdate from 'log-update';
+import logUpdate from 'log-update-async-hook';
 import chalk from 'chalk';
 import isCI from 'is-ci';
 
@@ -24,11 +24,14 @@ export default {
         }
     },
 
-    hideSpinner () {
+    hideSpinner (isExit) {
         if (this.animation) {
             clearInterval(this.animation);
             logUpdate.stderr.clear();
 
+            if (isExit)
+                logUpdate.stderr.done();
+
             this.animation = null;
         }
     },

src/client/browser/index.js

@@ -1,8 +1,9 @@
 // TODO: once we'll have client commons load it from there instead of node modules (currently it's leads to two copies of this packages on client)
 import Promise from 'pinkie';
 import COMMAND from '../../browser/connection/command';
+import STATUS from '../../browser/connection/status';
 
-const HEARTBEAT_INTERVAL = 30 * 1000;
+const HEARTBEAT_INTERVAL = 2 * 1000;
 
 var allowInitScriptExecution = false;
 
@@ -37,8 +38,19 @@ function isCurrentLocation (url) {
 
 //API
 export function startHeartbeat (heartbeatUrl, createXHR) {
-    sendXHR(heartbeatUrl, createXHR);
-    window.setInterval(() => sendXHR(heartbeatUrl, createXHR), HEARTBEAT_INTERVAL);
+    function heartbeat () {
+        sendXHR(heartbeatUrl, createXHR)
+            .then(status => {
+                if (status.code === STATUS.closing && !isCurrentLocation(status.url)) {
+                    stopInitScriptExecution();
+                    document.location = status.url;
+                }
+            });
+    }
+
+    window.setInterval(heartbeat, HEARTBEAT_INTERVAL);
+
+    heartbeat();
 }
 
 function executeInitScript (initScriptUrl, createXHR) {

src/index.js

@@ -1,6 +1,7 @@
 import Promise from 'pinkie';
 import TestCafe from './testcafe';
 import * as endpointUtils from 'endpoint-utils';
+import setupExitHook from 'async-exit-hook';
 import { GeneralError } from './errors/runtime';
 import MESSAGE from './errors/runtime/message';
 import embeddingUtils from './embedding-utils';
@@ -42,7 +43,11 @@ async function createTestCafe (hostname, port1, port2) {
         getValidPort(port2)
     ]);
 
-    return new TestCafe(hostname, port1, port2);
+    var testcafe = new TestCafe(hostname, port1, port2);
+
+    setupExitHook(cb => testcafe.close().then(cb));
+
+    return testcafe;
 }
 
 // Embedding utils

src/notifications/debug-logger.js

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 import { findIndex } from 'lodash';
-import logUpdate from 'log-update';
+import logUpdate from 'log-update-async-hook';
 import createStackFilter from '../errors/create-stack-filter';
 
 export default {

src/testcafe.js

@@ -19,6 +19,7 @@ const FAVICON           = read('./client/ui/favicon.ico', true);
 
 export default class TestCafe {
     constructor (hostname, port1, port2) {
+        this.closed                   = false;
         this.proxy                    = new Proxy(hostname, port1, port2);
         this.browserConnectionGateway = new BrowserConnectionGateway(this.proxy);
         this.runners                  = [];
@@ -62,6 +63,11 @@ export default class TestCafe {
     }
 
     async close () {
+        if (this.closed)
+            return;
+
+        this.closed = true;
+
         await Promise.all(this.runners.map(runner => runner.stop()));
 
         await browserProviderPool.dispose();