add warning when use t.debug in headless browsers (closes DevExpress#…

…2846) (DevExpress#3003)

* [WIP]add warning when use t.debug in headless browsers (closes DevExpress#2846)

* fix

* define IsHeadlessBrowser method only in pluginHost

src/browser/connection/index.js

@@ -292,6 +292,10 @@ export default class BrowserConnection extends EventEmitter {
             initScriptPromise.resolve(JSON.parse(data));
     }
 
+    isHeadlessBrowser () {
+        return this.provider.isHeadlessBrowser(this.id);
+    }
+
     async reportJobResult (status, data) {
         await this.provider.reportJobResult(this.id, status, data);
     }

src/browser/provider/built-in/chrome/index.js

@@ -58,6 +58,12 @@ export default {
         return !config.headless;
     },
 
+    isHeadlessBrowser (browserId) {
+        const config = this.openedBrowsers[browserId].config;
+
+        return config && config.headless;
+    },
+
     async takeScreenshot (browserId, path) {
         const runtimeInfo = this.openedBrowsers[browserId];
 

src/browser/provider/built-in/firefox/index.js

@@ -65,6 +65,12 @@ export default {
         return !config.headless;
     },
 
+    isHeadlessBrowser (browserId) {
+        const config = this.openedBrowsers[browserId].config;
+
+        return config && config.headless;
+    },
+
     async takeScreenshot (browserId, path) {
         const { marionetteClient } = this.openedBrowsers[browserId];
 

src/browser/provider/index.js

@@ -212,6 +212,10 @@ export default class BrowserProvider {
         return await this.plugin.isLocalBrowser(browserId, browserName);
     }
 
+    isHeadlessBrowser (browserId) {
+        return this.plugin.isHeadlessBrowser(browserId);
+    }
+
     async openBrowser (browserId, pageUrl, browserName) {
         await this.plugin.openBrowser(browserId, pageUrl, browserName);
 

src/browser/provider/plugin-host.js

@@ -99,6 +99,10 @@ export default class BrowserProviderPluginHost {
         return false;
     }
 
+    isHeadlessBrowser () {
+        return false;
+    }
+
     async hasCustomActionForBrowser (/* browserId */) {
         return {
             hasCloseBrowser:                this.hasOwnProperty('closeBrowser'),

src/test-run/index.js

@@ -25,6 +25,7 @@ import ClientFunctionBuilder from '../client-functions/client-function-builder';
 import ReporterPluginHost from '../reporter/plugin-host';
 import BrowserConsoleMessages from './browser-console-messages';
 import { UNSTABLE_NETWORK_MODE_HEADER } from '../browser/connection/unstable-network-mode';
+import WARNING_MESSAGE from '../notifications/warning-message';
 
 import { TakeScreenshotOnFailCommand } from './commands/browser-manipulation';
 import { SetNativeDialogHandlerCommand, SetTestSpeedCommand, SetPageLoadTimeoutCommand } from './commands/actions';
@@ -365,6 +366,11 @@ export default class TestRun extends EventEmitter {
     }
 
     async _enqueueSetBreakpointCommand (callsite, error) {
+        if (this.browserConnection.isHeadlessBrowser()) {
+            this.warningLog.addWarning(WARNING_MESSAGE.debugInHeadlessError);
+            return;
+        }
+
         debugLogger.showBreakpoint(this.session.id, this.browserConnection.userAgent, callsite, error);
 
         this.debugging = await this.executeCommand(new SetBreakpointCommand(!!error), callsite);

test/functional/config.js

@@ -134,8 +134,7 @@ testingEnvironments[testingEnvironmentNames.localBrowsersIE] = {
 };
 
 testingEnvironments[testingEnvironmentNames.localBrowsersChromeFirefox] = {
-    isLocalBrowsers:    true,
-    isHeadlessBrowsers: true,
+    isLocalBrowsers: true,
 
     browsers: [
         {
@@ -152,7 +151,8 @@ testingEnvironments[testingEnvironmentNames.localBrowsersChromeFirefox] = {
 };
 
 testingEnvironments[testingEnvironmentNames.localHeadlessBrowsers] = {
-    isLocalBrowsers: true,
+    isLocalBrowsers:    true,
+    isHeadlessBrowsers: true,
 
     browsers: [
         {
@@ -232,6 +232,10 @@ module.exports = {
         return this.currentEnvironment.isLocalBrowsers;
     },
 
+    get useHeadlessBrowsers () {
+        return this.currentEnvironment.isHeadlessBrowsers;
+    },
+
     get devMode () {
         return !!process.env.DEV_MODE;
     },

test/functional/fixtures/regression/gh-2846/pages/index.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <title>gh-2846</title>
+</head>
+<body>
+</body>
+</html>

test/functional/fixtures/regression/gh-2846/test.js

@@ -0,0 +1,14 @@
+const config = require('../../../config');
+const expect = require('chai').expect;
+
+if (config.useHeadlessBrowsers) {
+    describe('[Regression](GH-2846)', function () {
+        it('Should add warning on t.debug', function () {
+            return runTests('./testcafe-fixtures/index.js')
+                .then(() => {
+                    expect(testReport.warnings).eql(['It is not allowed to debug in Headless mode']);
+                });
+        });
+    });
+}
+

test/functional/fixtures/regression/gh-2846/testcafe-fixtures/index.js

@@ -0,0 +1,6 @@
+fixture `GH-2846`
+    .page `http://localhost:3000/fixtures/regression/gh-2846/pages/index.html`;
+
+test(`Debug`, async t => {
+    await t.debug();
+});