Fix multiple debug in headless mode warnings (closes DevExpress#6605)

AlexKamaev · Nov 2, 2021 · e21ca68 · e21ca68
1 parent 08833c1
commit e21ca68
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 14 deletions.
diff --git a/src/test-run/index.ts b/src/test-run/index.ts
@@ -766,21 +766,11 @@ export default class TestRun extends AsyncEventEmitter {
         return consoleMessageCopy[String(this.activeWindowId)];
     }
 
-    private async _enqueueSetBreakpointCommand (callsite: CallsiteRecord | undefined, error?: string, command?: CommandBase): Promise<void> {
-        const inCompilerService = !!this.compilerService;
-
-        // NOTE: In regular mode, it's possible to debug tests only using TestCafe UI ('Resume' and 'Next step' buttons).
-        // So, we should warn on trying to debug in headless mode.
-        // In compiler service mode, we can debug even in headless mode using any debugging tools. So, in this case, the warning is excessive.
-        if (!inCompilerService && this.browserConnection.isHeadlessBrowser()) {
-            this.warningLog.addWarning({ message: WARNING_MESSAGE.debugInHeadlessError, actionId: command ? command.actionId : null });
-            return;
-        }
-
+    private async _enqueueSetBreakpointCommand (callsite: CallsiteRecord | undefined, error?: string): Promise<void> {
         if (this.debugLogger)
             this.debugLogger.showBreakpoint(this.session.id, this.browserConnection.userAgent, callsite, error);
 
-        this.debugging = await this._internalExecuteCommand(new serviceCommands.SetBreakpointCommand(!!error, inCompilerService), callsite) as boolean;
+        this.debugging = await this._internalExecuteCommand(new serviceCommands.SetBreakpointCommand(!!error, !!this.compilerService), callsite) as boolean;
     }
 
     private _removeAllNonServiceTasks (): void {
@@ -1179,8 +1169,21 @@ export default class TestRun extends AsyncEventEmitter {
         if (command.type === COMMAND_TYPE.setPageLoadTimeout)
             return null;
 
-        if (command.type === COMMAND_TYPE.debug)
-            return await this._enqueueSetBreakpointCommand(callsite as CallsiteRecord, void 0, command);
+        if (command.type === COMMAND_TYPE.debug) {
+            // NOTE: In regular mode, it's possible to debug tests only using TestCafe UI ('Resume' and 'Next step' buttons).
+            // So, we should warn on trying to debug in headless mode.
+            // In compiler service mode, we can debug even in headless mode using any debugging tools. So, in this case, the warning is excessive.
+            const canDebug = !!this.compilerService || !this.browserConnection.isHeadlessBrowser();
+
+            if (canDebug)
+                return await this._enqueueSetBreakpointCommand(callsite as CallsiteRecord, void 0);
+
+            this.debugging = false;
+
+            this.warningLog.addWarning({ message: WARNING_MESSAGE.debugInHeadlessError, actionId: command.actionId });
+
+            return null;
+        }
 
         if (command.type === COMMAND_TYPE.useRole) {
             let fn = (): Promise<void> => this._useRole((command as any).role, callsite as CallsiteRecord);

diff --git a/test/functional/fixtures/regression/gh-2846/testcafe-fixtures/index.js b/test/functional/fixtures/regression/gh-2846/testcafe-fixtures/index.js
@@ -2,4 +2,7 @@ fixture `GH-2846`;
 
 test(`Debug`, async t => {
     await t.debug();
+
+    // NOTE: for https://github.com/DevExpress/testcafe/issues/6605
+    await t.wait(1);
 });