dappress 0.3.0 → 0.3.1

package/README.md

@@ -95,12 +95,14 @@ Add the command types to `tsconfig.json`:
 
 JavaScript projects use the same files with a `.js` extension and `module.exports`.
 
-Run the tests in a headed browser that supports extensions:
+Run the tests in a browser that supports extensions:
 
 ```bash
 npx cypress run --browser chrome-for-testing --headed
 ```
 
+Without `--headed`, the run is headless and works the same, except for the wallet cache, which needs a headed browser.
+
 ## Usage
 
 ```ts
@@ -157,7 +159,7 @@ Settings normally live in `cypress/wallet.setup.ts`. Secrets go in `cypress.env.
 | `network` | | None. The dapp stays on the network MetaMask starts on, Ethereum mainnet. |
 | `backupAndSync` | | `false`. Dappress turns off MetaMask's backup and sync while importing the wallet, so that an account a test adds is not restored by the next import of the same seed phrase. With `true`, MetaMask keeps saving and restoring the accounts and contacts of that phrase. |
 | `autoSetup` | | `true`. Dappress imports or unlocks the wallet before the first test of each spec. Set to `false` to call `cy.setupMetaMask()` yourself. |
-| `cache` | | `false`. The wallet is imported in every run, about fifteen seconds. With `true`, and a seed phrase of your own, it is imported once, in a browser Dappress opens before the run, and the resulting profile is reused by later runs, which then start by unlocking the wallet. |
+| `cache` | | `false`. The wallet is imported in every run, about fifteen seconds. With `true`, and a seed phrase of your own, it is imported once, in a browser Dappress opens before the run, and the resulting profile is reused by later runs, which then start by unlocking the wallet. Headed runs only: a headless run imports the wallet as usual. |
 | `timeout` | | `20000` ms. The time allowed for MetaMask to display a request before a command fails. |
 
 ### Security
@@ -171,8 +173,9 @@ With `cache: true`, the profile under `~/.cache/dappress/profiles` holds the wal
 The suite runs one test per command against [MetaMask's test dapp](https://metamask.github.io/test-dapp/). Each run makes a wallet nobody has used, with Foundry's `cast`, and starts a local [Anvil](https://getfoundry.sh) node that funds it. It requires Chrome for Testing and Foundry.
 
 ```bash
-npm run conformance               # default MetaMask version
-npm run conformance -- 13.51.0    # a specific release
+npm run conformance                        # default MetaMask version
+npm run conformance -- 13.51.0             # a specific release
+DAPPRESS_HEADLESS=1 npm run conformance    # without a browser window
 ```
 
 Each run writes `reports/metamask-<version>.json`. The GitHub workflow runs the suite daily against the latest MetaMask release that has no report yet.
@@ -189,6 +192,8 @@ Cypress executes tests inside the dapp's tab and has no access to the extension.
 
 MetaMask displays requests in its side panel when the panel is open, and in its popup window otherwise. Without the cache, the import of the wallet ends by opening the side panel, so requests appear there. With the cache, the wallet was imported in another browser, the panel is closed, and requests appear in the popup. Dappress handles both, and the conformance suite covers both.
 
+Cypress leaves extensions out of a headless launch, so Dappress passes MetaMask to Chrome itself. Headless Chrome displays the side panel but does not open the popup window, which is why the cache, whose requests appear in the popup, is limited to headed runs.
+
 With `cache: true`, Dappress imports the wallet once before the run, in a browser of its own, and keeps the profile; MetaMask's storage is copied from it into the profile Cypress is about to launch, so each run starts from a wallet that has never seen the dapp.
 
 ```
@@ -217,7 +222,7 @@ Selectors are MetaMask's `data-testid` attributes, each with the button's Englis
 
 ## Status
 
-Verified with MetaMask 13.49.0 and 13.50.0, Cypress 16 and Chrome for Testing 154, in headed mode, on macOS and on GitHub's Linux runners. Headless execution is not validated yet.
+Verified with MetaMask 13.49.0 and 13.50.0, Cypress 16 and Chrome for Testing 154: in headed mode on macOS and on GitHub's Linux runners, and in headless mode on macOS.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dappress",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "MetaMask automation for Cypress: load the real extension, import a test wallet, answer dapp requests with cy.* commands. Tracks the latest MetaMask release.",
   "license": "MIT",
   "author": "Benjamin Lassaut",

package/src/index.js

@@ -20,9 +20,12 @@ function configureDappress(on, config, userOptions = {}) {
     console.warn('[dappress] chromeWebSecurity is off: MetaMask cannot start its snaps, so adding or importing an account will hang');
   }
 
+  // A cached wallet gets its requests in MetaMask's popup window, which headless Chrome doesn't open
+  const usesCache = (browser) => options.cache && !browser.isHeadless;
+
   // Build the wallet profile before the run, out of the time Cypress allows a browser to come up
   on('before:run', async ({ browser }) => {
-    if (options.cache && browser) await prepareProfile({ browserPath: browser.path, extensionDir: await prepareExtension(options), options });
+    if (browser && usesCache(browser)) await prepareProfile({ browserPath: browser.path, extensionDir: await prepareExtension(options), options });
   });
 
   on('before:browser:launch', async (browser, launchOptions) => {
@@ -31,7 +34,12 @@ function configureDappress(on, config, userOptions = {}) {
     }
     const extensionDir = await prepareExtension(options);
     launchOptions.extensions.push(extensionDir);
-    if (options.cache) {
+    if (browser.isHeadless) {
+      // Cypress leaves extensions out of a headless launch, so ask Chrome directly
+      launchOptions.args.push(`--load-extension=${extensionDir}`);
+      if (options.cache) console.warn('[dappress] The wallet cache needs a headed browser: importing the wallet in this run instead');
+    }
+    if (usesCache(browser)) {
       const profileDir = await prepareProfile({ browserPath: browser.path, extensionDir, options });
       await installProfile(profileDir, browser, config.isTextTerminal);
     }

package/src/metamask.js

@@ -259,15 +259,23 @@ async function switchAccount(page, name) {
   await selectAccount(page, name);
 }
 
-// Picking an account closes the list and shows it in the home header
+// Picking an account closes the list and shows it in the home header. As with
+// adding one, a lost click leaves the list open, so the account is pressed again.
 async function selectAccount(page, name) {
-  await click(page, selectors.accounts.cell(name));
-  const deadline = Date.now() + 15000;
+  for (let attempt = 0; attempt < 3; attempt++) {
+    await click(page, selectors.accounts.cell(name));
+    if (await isSelected(page, name, 5000)) return;
+  }
+  throw await failure(page, `MetaMask did not select "${name}"`);
+}
+
+async function isSelected(page, name, timeout) {
+  const deadline = Date.now() + timeout;
   while (Date.now() < deadline) {
-    if ((await selectedAccount(page)) === name) return;
+    if ((await selectedAccount(page)) === name) return true;
     await sleep(250);
   }
-  throw await failure(page, `MetaMask did not select "${name}"`);
+  return false;
 }
 
 async function selectedAccount(page) {

package/types/index.d.ts

@@ -33,7 +33,7 @@ export interface DappressOptions extends WalletSetup {
   backupAndSync?: boolean;
   /** Run cy.setupMetaMask() before the first test of each spec. Default: true. */
   autoSetup?: boolean;
-  /** Import the wallet once and reuse the profile across runs. Keeps the vault under cacheDir. Default: false. */
+  /** Import the wallet once and reuse the profile across runs. Keeps the vault under cacheDir. Headed runs only. Default: false. */
   cache?: boolean;
   /** Time allowed for MetaMask to display a request, in ms. Default: 20000. */
   timeout?: number;