Start Edge with a clean profile on Android (#2647)

Edge kept its data between tests, because it showed welcome screens when the data was removed. That left state from earlier tests, so Browsertime had to clear the cache and cookies, close restored tabs and leave an empty page behind, and Edge results were still not comparable with Chrome and Samsung Internet, which start with no data. Edge skips the welcome screens with --disable-fre, but when it starts with no data and no URL, as Chromedriver starts it, it shows its new tab page on top of the tab and never paints the measured page. It also asks for the notification permission again. Browsertime now clears the data itself, gives the permission and opens Edge once on a local error page, so Edge starts on a normal tab. This makes each Edge test about 20 seconds longer, and all the Edge code for this is in one place.

Assisted-by: Claude Opus 5.5 noreply@anthropic.com

Author: soulgalore

README.md

@@ -136,7 +136,7 @@ If you want to set connectivity you need to use something like [gnirehtet](https
 $ browsertime --chrome.android.package com.android.chrome https://www.sitespeed.io --video --visualMetrics
 </pre>
 
-To test with Edge, use `--android -b edge`. To test with Samsung Internet, use `--android -b samsung`. Edge shows welcome screens and dialogs when its data is removed, so Browsertime keeps its data and clears the cache and cookies before each test instead. Before the first test, open Edge on the phone and accept the welcome screen and the dialogs. Local storage and service workers are kept between tests. Samsung Internet starts with no data for each test, the same as Chrome. If the phone uses a dark theme, Samsung Internet also shows web pages in dark mode. To test the pages as most users see them, turn off the dark theme on the phone, for example with `adb shell cmd uimode night no`.
+To test with Edge, use `--android -b edge`. To test with Samsung Internet, use `--android -b samsung`. Both start with no data for each test, the same as Chrome. Edge shows its new tab page on top of the page when it starts with no data, so before each test Browsertime opens Edge once with an error page. That makes each test about 20 seconds longer. If the phone uses a dark theme, Samsung Internet also shows web pages in dark mode. To test the pages as most users see them, turn off the dark theme on the phone, for example with `adb shell cmd uimode night no`.
 
 To check that all Android features work with your phone, run `npm run test:android` in a Browsertime checkout. It tests Chrome and Firefox (use `npm run test:android -- --browser chrome` or `-- --browser firefox` to test only one) and prints which features pass. Add `--rooted` (for example `npm run test:android -- --rooted`) to also test `--android.rooted`, which changes the CPU, GPU and kernel settings on the phone until it reboots.
 

lib/android/edge.js

@@ -0,0 +1,63 @@
+import { getLogger } from '@sitespeed.io/log';
+import { Android } from './index.js';
+const log = getLogger('browsertime.android');
+const delay = ms => new Promise(res => setTimeout(res, ms));
+
+const EDGE_PACKAGE = 'com.microsoft.emmx';
+// The port is not safe, so Edge shows an error page at once and does not use
+// the network.
+const FIRST_URL = 'http://127.0.0.1:1/';
+
+/**
+ * Edge on Android needs more than Chromedriver gives it to start with no data.
+ * Chromedriver clears the data and starts Edge without a URL. Edge then shows
+ * its new tab page on top of the tab, and does not paint the page that we
+ * measure in that tab. Clearing the data also removes the notification
+ * permission, and Edge asks for it on top of the page. Browsertime therefore
+ * clears the data, gives the permission and opens a page once, so Edge saves a
+ * normal tab. Chromedriver keeps that data and Edge opens that tab when it
+ * starts.
+ */
+export class AndroidEdge {
+  static isConfigured(browserOptions) {
+    return browserOptions.android?.package === EDGE_PACKAGE;
+  }
+
+  constructor(options) {
+    this.android = new Android(options);
+  }
+
+  async startWithCleanProfile() {
+    log.info('Clear the data of Edge and open it once');
+    const run = command => this.android._runCommand(command);
+    await run(`am force-stop ${EDGE_PACKAGE}`);
+    await run(`pm clear ${EDGE_PACKAGE}`);
+    await run(`pm grant ${EDGE_PACKAGE} android.permission.POST_NOTIFICATIONS`);
+    // Edge reads the flags file, with --disable-fre, only as the debug app.
+    await run(`am set-debug-app --persistent ${EDGE_PACKAGE}`);
+    await run(
+      `am start -W -a android.intent.action.VIEW -p ${EDGE_PACKAGE} -d ${FIRST_URL}`
+    );
+    // The first start can take more time than am start waits, and Edge can
+    // show other activities before the tab.
+    const end = Date.now() + 30_000;
+    for (;;) {
+      const window = await this.android.getFocusedWindow();
+      if (window.includes('ChromeTabbedActivity')) {
+        break;
+      }
+      if (Date.now() > end) {
+        log.info(
+          'Edge did not show the tab, the page can be hidden in the test'
+        );
+        break;
+      }
+      await delay(500);
+    }
+    await delay(2000);
+    // Edge saves its tabs when it goes to the background.
+    await this.android.pressHomeButton();
+    await delay(2000);
+    await run(`am force-stop ${EDGE_PACKAGE}`);
+  }
+}

lib/chrome/chromeDevtoolsProtocol.js

@@ -74,19 +74,6 @@ export class ChromeDevtoolsProtocol {
       throw error;
     }
   }
-  async closeOtherTabs(target) {
-    const connection = { local: true, port: this.options.devToolsPort };
-    const tabs = await CDP.List(connection);
-    // Never close the tab that WebDriver uses.
-    if (!tabs.some(tab => tab.id === target)) {
-      return;
-    }
-    for (const tab of tabs) {
-      if (tab.type === 'page' && tab.id !== target) {
-        await CDP.Close({ ...connection, id: tab.id });
-      }
-    }
-  }
 
   async startTrace() {
     this.events = [];

lib/chrome/webdriver/builder.js

@@ -5,6 +5,7 @@ import {
   setupChromiumOptions,
   writeAndroidCommandLine
 } from './setupChromiumOptions.js';
+import { AndroidEdge } from '../../android/edge.js';
 import { pick, isEmpty, getProperty } from '../../support/util.js';
 
 /**
@@ -81,6 +82,9 @@ export async function configureBuilder(builder, baseDir, options, tmpDir) {
 
   setupChromiumOptions(chromeOptions, chromeConfig, options, baseDir);
   await writeAndroidCommandLine(chromeConfig, options);
+  if (AndroidEdge.isConfigured(chromeConfig)) {
+    await new AndroidEdge(options).startWithCleanProfile();
+  }
 
   builder.setChromeOptions(chromeOptions);
 }

lib/chrome/webdriver/chromium.js

@@ -4,7 +4,6 @@ import path from 'node:path';
 import { logging } from 'selenium-webdriver';
 import { getLogger } from '@sitespeed.io/log';
 const log = getLogger('browsertime.chrome');
-const delay = ms => new Promise(res => setTimeout(res, ms));
 const { Type } = logging;
 import { longTaskMetrics } from '../longTaskMetrics.js';
 import { parseCPUTrace } from '../parseCpuTrace.js';
@@ -23,10 +22,7 @@ import { ChromeDevtoolsProtocol } from '../chromeDevtoolsProtocol.js';
 import { Coverage } from '../coverage.js';
 import { NetworkManager } from '../networkManager.js';
 import { Android, isAndroidConfigured } from '../../android/index.js';
-import {
-  getAndroidDevtoolsSocket,
-  keepsAndroidAppData
-} from './setupChromiumOptions.js';
+import { getAndroidDevtoolsSocket } from './setupChromiumOptions.js';
 import { getRenderBlocking } from './traceUtilities.js';
 import { loafTimeLine } from './devtools/loaf.js';
 import { lcpTimeLine } from './devtools/lcp.js';
@@ -104,10 +100,6 @@ export class Chromium {
       ? await runner.getDriver().getWindowHandle()
       : undefined;
     await this.cdpClient.setup(target);
-    if (keepsAndroidAppData(this.chrome)) {
-      // The browser keeps its tabs between tests when we keep its data.
-      await this.cdpClient.closeOtherTabs(target);
-    }
   }
 
   /**
@@ -123,7 +115,7 @@ export class Chromium {
       await this.cdpClient.blockUrls(this.options.block);
     }
 
-    if (this.options.cacheClearRaw || keepsAndroidAppData(this.chrome)) {
+    if (this.options.cacheClearRaw) {
       await this.cdpClient.clearBrowserCache();
       await this.cdpClient.clearBrowserCookies();
     }
@@ -718,20 +710,7 @@ export class Chromium {
   /**
    * Before the browser is stopped/closed.
    */
-  async beforeBrowserStop(runner) {
-    if (keepsAndroidAppData(this.chrome)) {
-      // The browser opens the last page again when it starts, and that page
-      // opens a connection that the next test then uses. The browser saves
-      // its tabs when it goes to the background, so press home after.
-      try {
-        await runner.getDriver().get('data:,');
-        await delay(2000);
-        await this.android.pressHomeButton();
-      } catch (error) {
-        log.info('Could not open about:blank before the browser stops', error);
-      }
-    }
-
+  async beforeBrowserStop() {
     if (this.chrome.collectNetLog && !this.chrome.android) {
       const netlog = `${this.baseDir}/chromeNetlog.json`;
       await unlink(netlog);

lib/chrome/webdriver/setupChromiumOptions.js

@@ -9,9 +9,8 @@ const log = getLogger('browsertime.chrome');
 
 // Chromedriver only knows Chrome by its package name. For other Chromium
 // browsers on Android it needs the name of the DevTools socket, and the
-// browser reads its flags from its own file. keepAppData: the browser shows a
-// welcome screen after its data is cleared, so we keep the data and clear the
-// cache and cookies instead.
+// browser reads its flags from its own file. keepAppData: Chromedriver keeps
+// the data, because Browsertime clears it itself, see lib/android/edge.js.
 const OTHER_ANDROID_BROWSERS = {
   'com.microsoft.emmx': {
     activity: 'com.microsoft.ruby.Main',
@@ -360,9 +359,3 @@ export function getAndroidDevtoolsSocket(browserOptions) {
     'chrome_devtools_remote'
   );
 }
-
-export function keepsAndroidAppData(browserOptions) {
-  return Boolean(
-    OTHER_ANDROID_BROWSERS[browserOptions.android?.package]?.keepAppData
-  );
-}

lib/edge/webdriver/builder.js

@@ -5,6 +5,7 @@ import {
   setupChromiumOptions,
   writeAndroidCommandLine
 } from '../../chrome/webdriver/setupChromiumOptions.js';
+import { AndroidEdge } from '../../android/edge.js';
 import { pac, manual } from 'selenium-webdriver/proxy.js';
 import { pick, isEmpty, getProperty } from '../../support/util.js';
 const log = getLogger('browsertime.edge');
@@ -86,6 +87,9 @@ export async function configureBuilder(builder, baseDir, options, tmpDir) {
 
   setupChromiumOptions(edgeOptions, chromeConfig, options, baseDir);
   await writeAndroidCommandLine(chromeConfig, options);
+  if (AndroidEdge.isConfigured(chromeConfig)) {
+    await new AndroidEdge(options).startWithCleanProfile();
+  }
 
   builder.setEdgeOptions(edgeOptions);
 }