Added support to pass new headless flag

Author: ChiragRupani

azure-pipelines.yml

@@ -30,6 +30,7 @@ steps:
   - script: |
       npm install --no-progress --loglevel=error --no-fund
       npm run build
+      npm run test
       npm run coverage
       npm run integration-test
     displayName: "npm install, build and test"

src/BaseBrowser.ts

@@ -20,7 +20,7 @@ export default class BaseBrowser {
       }
     });
 
-    var allflags = [
+    let allflags = [
       '--user-data-dir=' + this.userDataDir,
       // https://github.com/GoogleChrome/chrome-launcher/blob/master/docs/chrome-flags-for-tools.md#--enable-automation
       '--enable-automation',
@@ -41,20 +41,28 @@ export default class BaseBrowser {
   }
 
   _getHeadlessOptions(url: string): string[] {
-    var mergedArgs = this._getOptions(url).concat([
-      '--headless',
+    let mergedArgs = this._getOptions(url);
+
+    // Adding Headless flag
+    // If there is arg with --headless=new or --headless=old, don't add --headless flag
+    mergedArgs = mergedArgs.some((flag) => flag.indexOf('--headless=') !== -1)
+      ? mergedArgs
+      : mergedArgs.concat(['--headless']);
+
+    // Add other flags to support headless mode
+    mergedArgs = mergedArgs.concat([
       '--no-proxy-server',
       //'--no-sandbox',
       //'--disable-gpu',
     ]);
 
-    var args: string[];
+    // Add remote debugging port
+    mergedArgs = mergedArgs.some(
+      (flag) => flag.indexOf('--remote-debugging-port=') !== -1
+    )
+      ? mergedArgs
+      : mergedArgs.concat(['--remote-debugging-port=9222']);
 
-    if (mergedArgs.some((f) => f.indexOf('--remote-debugging-port=') !== -1)) {
-      args = mergedArgs;
-    } else {
-      args = mergedArgs.concat(['--remote-debugging-port=9222']);
-    }
-    return args;
+    return mergedArgs;
   }
 }

src/Utilities.ts

@@ -19,7 +19,7 @@ export default class Utilities {
       '/bin',
     ];
 
-    var edgeBIN: string = '/usr/bin/' + command;
+    let edgeBIN: string = '/usr/bin/' + command;
 
     try {
       fs.accessSync(edgeBIN, fs.constants.X_OK);
@@ -34,7 +34,7 @@ export default class Utilities {
       return null;
     }
 
-    var darwinPaths = [
+    let darwinPaths = [
       path.join(process.env.HOME || '', defaultPath),
       defaultPath,
     ];
@@ -56,18 +56,18 @@ export default class Utilities {
       return null;
     }
 
-    var suffix = '\\Microsoft\\' + edgeDirName + '\\Application\\msedge.exe';
-    var prefixes = [
+    let suffix = '\\Microsoft\\' + edgeDirName + '\\Application\\msedge.exe';
+    let prefixes = [
       process.env["PROGRAMFILES(X86)"],
       process.env.PROGRAMFILES,
       process.env.LOCALAPPDATA,
       process.env.ProgramW6432,
     ];
 
-    var edgePath: string | null = null;
+    let edgePath: string | null = null;
     for (let i = 0; i < prefixes.length; i++) {
       try {
-        var windowsEdgeDirectory = path.join(prefixes[i] || '', suffix);
+        let windowsEdgeDirectory = path.join(prefixes[i] || '', suffix);
         fs.accessSync(windowsEdgeDirectory);
         edgePath = windowsEdgeDirectory;
         break;
@@ -81,13 +81,13 @@ export default class Utilities {
   }
 
   static sanitizeJSFlags(flag: string) {
-    var test = /--js-flags=(['"])/.exec(flag);
+    let test = /--js-flags=(['"])/.exec(flag);
     if (!test) {
       return flag;
     }
-    var escapeChar = test[1];
-    var endExp = new RegExp(escapeChar + '$');
-    var startExp = new RegExp('--js-flags=' + escapeChar);
+    let escapeChar = test[1];
+    let endExp = new RegExp(escapeChar + '$');
+    let startExp = new RegExp('--js-flags=' + escapeChar);
     return flag.replace(startExp, '--js-flags=').replace(endExp, '');
   }
 

tests/Launcher.test.ts

@@ -1,5 +1,6 @@
 import { expect } from 'chai';
 import EdgeDevBrowser from '../src/channels/EdgeDev';
+import EdgeAnyHeadlessBrowser from '../src/headlessChannels/EdgeAnyHeadless';
 import EdgeDevHeadlessBrowser from '../src/headlessChannels/EdgeDevHeadless';
 
 describe('Verify options are returned', function () {
@@ -49,4 +50,21 @@ describe('Verify options are returned', function () {
       '--js-flags=--trace-opt --trace-deopt --trace-bailout'
     );
   });
+
+  it('Verify options for Edge Any Headless with new headless flag', function () {
+    var launcher = {
+      _getOptions: (url) => {},
+    };
+
+    var browser = EdgeAnyHeadlessBrowser.call(launcher, function () {}, {
+      edgeDataDir: 'C:\\Users\\UserName\\AppData\\Local\\Temp\\karma-27597020',
+      flags: ['--headless=new'],
+    });
+
+    var options = launcher._getOptions('https://localhost:4200');
+
+    expect(options).contains('--enable-automation');
+    expect(options).contains('--headless=new');
+    expect(options).not.contains('--headless');
+  });
 });