w3wallets 1.0.0-beta.7 → 1.0.0-beta.9

package/dist/index.d.mts

@@ -2,10 +2,16 @@ import * as playwright_test from 'playwright/test';
 import { Page, test, BrowserContext } from '@playwright/test';
 
 interface IWallet {
-    readonly page: Page;
+    page: Page;
     gotoOnboardPage(): Promise<void>;
     approve(): Promise<void>;
     deny(): Promise<void>;
+    /**
+     * Called by the cache builder after setupFn completes, before the browser
+     * context is closed. Wallet implementations can override this to force
+     * persistence of in-memory state (e.g., locking the vault).
+     */
+    beforeCacheClose?(): Promise<void>;
 }
 /**
  * Configuration object for a wallet.
@@ -78,7 +84,7 @@ declare function withWallets<const T extends readonly WalletConfig[]>(test: type
 }, playwright_test.PlaywrightWorkerArgs & playwright_test.PlaywrightWorkerOptions>;
 
 declare abstract class Wallet implements IWallet {
-    readonly page: Page;
+    page: Page;
     readonly extensionId: string;
     constructor(page: Page, extensionId: string);
     abstract gotoOnboardPage(): Promise<void>;
@@ -121,10 +127,22 @@ declare class Metamask extends Wallet {
      * confirmation-cancel-button is available.
      */
     private dismissQueuedNotifications;
+    /**
+     * Close extra MetaMask extension pages that the service worker opened
+     * during onboarding (e.g. home.html#/onboarding/completion).
+     * Keeps only this.page alive.
+     */
+    private closeExtraExtensionPages;
+    /**
+     * Poll the URL until it leaves a confirmation route. Uses polling instead
+     * of waitForURL because MetaMask uses HashRouter and hash-only changes
+     * are not reliably caught by Playwright's navigation events.
+     */
+    private waitForConfirmRouteExit;
     /**
      * Wait for a target button while handling the Transaction Shield popup.
-     * Always navigates to sidepanel.html fresh so MetaMask's
-     * ConfirmationHandler can route to the pending approval.
+     * Navigates to sidepanel.html so MetaMask's ConfirmationHandler routes
+     * to the pending approval, then waits for the button to become visible.
      */
     private waitAndClickButton;
     approve(): Promise<void>;
@@ -134,10 +152,12 @@ declare class Metamask extends Wallet {
      */
     lock(): Promise<void>;
     /**
-     * Unlock MetaMask with password.
-     * After unlocking, stabilizes the wallet UI by handling post-unlock
-     * screens (metametrics, onboarding completion) and dismissing queued
-     * notifications. Ends on home.html with the wallet UI ready.
+     * Force-persist the vault by locking the wallet. Called by the cache builder
+     * before closing the browser context. MetaMask MV3 stores the vault lazily —
+     * locking forces the encrypted vault to be written to chrome.storage.local.
+     */
+    beforeCacheClose(): Promise<void>;
+    /**
      * Unlock MetaMask with password.
      * After unlocking, stabilizes the wallet UI by handling post-unlock
      * screens (metametrics, onboarding completion) and dismissing queued

package/dist/index.d.ts

@@ -2,10 +2,16 @@ import * as playwright_test from 'playwright/test';
 import { Page, test, BrowserContext } from '@playwright/test';
 
 interface IWallet {
-    readonly page: Page;
+    page: Page;
     gotoOnboardPage(): Promise<void>;
     approve(): Promise<void>;
     deny(): Promise<void>;
+    /**
+     * Called by the cache builder after setupFn completes, before the browser
+     * context is closed. Wallet implementations can override this to force
+     * persistence of in-memory state (e.g., locking the vault).
+     */
+    beforeCacheClose?(): Promise<void>;
 }
 /**
  * Configuration object for a wallet.
@@ -78,7 +84,7 @@ declare function withWallets<const T extends readonly WalletConfig[]>(test: type
 }, playwright_test.PlaywrightWorkerArgs & playwright_test.PlaywrightWorkerOptions>;
 
 declare abstract class Wallet implements IWallet {
-    readonly page: Page;
+    page: Page;
     readonly extensionId: string;
     constructor(page: Page, extensionId: string);
     abstract gotoOnboardPage(): Promise<void>;
@@ -121,10 +127,22 @@ declare class Metamask extends Wallet {
      * confirmation-cancel-button is available.
      */
     private dismissQueuedNotifications;
+    /**
+     * Close extra MetaMask extension pages that the service worker opened
+     * during onboarding (e.g. home.html#/onboarding/completion).
+     * Keeps only this.page alive.
+     */
+    private closeExtraExtensionPages;
+    /**
+     * Poll the URL until it leaves a confirmation route. Uses polling instead
+     * of waitForURL because MetaMask uses HashRouter and hash-only changes
+     * are not reliably caught by Playwright's navigation events.
+     */
+    private waitForConfirmRouteExit;
     /**
      * Wait for a target button while handling the Transaction Shield popup.
-     * Always navigates to sidepanel.html fresh so MetaMask's
-     * ConfirmationHandler can route to the pending approval.
+     * Navigates to sidepanel.html so MetaMask's ConfirmationHandler routes
+     * to the pending approval, then waits for the button to become visible.
      */
     private waitAndClickButton;
     approve(): Promise<void>;
@@ -134,10 +152,12 @@ declare class Metamask extends Wallet {
      */
     lock(): Promise<void>;
     /**
-     * Unlock MetaMask with password.
-     * After unlocking, stabilizes the wallet UI by handling post-unlock
-     * screens (metametrics, onboarding completion) and dismissing queued
-     * notifications. Ends on home.html with the wallet UI ready.
+     * Force-persist the vault by locking the wallet. Called by the cache builder
+     * before closing the browser context. MetaMask MV3 stores the vault lazily —
+     * locking forces the encrypted vault to be written to chrome.storage.local.
+     */
+    beforeCacheClose(): Promise<void>;
+    /**
      * Unlock MetaMask with password.
      * After unlocking, stabilizes the wallet UI by handling post-unlock
      * screens (metametrics, onboarding completion) and dismissing queued

package/dist/index.js

@@ -98,12 +98,12 @@ var ARIA_CLOSE_TIMEOUT = 500;
 var POPUP_HIDDEN_TIMEOUT = 3e3;
 var POST_UNLOCK_TIMEOUT = 3e4;
 var NOTIFICATION_CHECK_TIMEOUT = 5e3;
-var CONFIRMATION_ROUTE_TIMEOUT = 15e3;
 var POST_CLICK_TIMEOUT = 1e4;
 var BUTTON_OR_POPUP_TIMEOUT = 3e4;
 var LAST_RESORT_CLICK_TIMEOUT = 1e4;
 var LOCK_SCREEN_TIMEOUT = 3e4;
 var MENU_BUTTON_TIMEOUT = 3e4;
+var ONBOARD_VISIBLE_TIMEOUT = 3e4;
 var MNEMONIC_KEY_DELAY = 5;
 var MNEMONIC_WORD_DELAY = 100;
 
@@ -293,7 +293,6 @@ async function findCachedExtension(context, ExtensionClass, expectedExtensionId,
   const page = await context.newPage();
   if (homeUrl) {
     await page.goto(`chrome-extension://${expectedExtensionId}/${homeUrl}`);
-    await page.goto(`chrome-extension://${expectedExtensionId}/${homeUrl}`);
   }
   const extension = new ExtensionClass(page, expectedExtensionId);
   return extension;
@@ -360,7 +359,7 @@ var Metamask = class extends Wallet {
     await this.page.goto(`chrome-extension://${this.extensionId}/home.html`);
     await (0, import_test3.expect)(
       this.page.getByRole("button", { name: "I have an existing wallet" })
-    ).toBeVisible({ timeout: config.expectTimeout });
+    ).toBeVisible({ timeout: ONBOARD_VISIBLE_TIMEOUT });
   }
   /**
    * Onboard MetaMask with a mnemonic phrase
@@ -385,7 +384,6 @@ var Metamask = class extends Wallet {
     }
     const continueBtn = this.page.getByTestId("import-srp-confirm");
     await (0, import_test3.expect)(continueBtn).toBeEnabled({ timeout: config.expectTimeout });
-    await (0, import_test3.expect)(continueBtn).toBeEnabled({ timeout: config.expectTimeout });
     await continueBtn.click();
     const passwordInputs = this.page.locator('input[type="password"]');
     await passwordInputs.nth(0).fill(pwd);
@@ -399,10 +397,28 @@ var Metamask = class extends Wallet {
     });
     await openWalletBtn.click();
     await this.page.goto(`chrome-extension://${this.extensionId}/home.html`);
-    await this.page.goto(`chrome-extension://${this.extensionId}/home.html`);
+    const readyIndicator = this.page.getByTestId("account-options-menu-button");
+    const lockInput = this.page.getByTestId("unlock-password");
+    const state = await Promise.race([
+      readyIndicator.waitFor({ state: "visible", timeout: POST_UNLOCK_TIMEOUT }).then(() => "ready"),
+      lockInput.waitFor({ state: "visible", timeout: POST_UNLOCK_TIMEOUT }).then(() => "locked")
+    ]).catch(() => "timeout");
+    debug(`metamask.onboard: post-navigate state=${state}`);
+    if (state === "locked") {
+      debug("metamask.onboard: vault locked after onboarding, auto-unlocking");
+      await lockInput.fill(password ?? this.defaultPassword);
+      await this.page.getByTestId("unlock-submit").click();
+      await this.page.waitForSelector('[data-testid="unlock-password"]', {
+        state: "hidden",
+        timeout: LOCK_SCREEN_TIMEOUT
+      });
+      await this.stabilizePostUnlock();
+    }
+    await this.closeExtraExtensionPages();
     await this.page.goto(
       `chrome-extension://${this.extensionId}/sidepanel.html`
     );
+    await this.page.waitForLoadState("networkidle");
     debug("metamask.onboard: complete");
   }
   /**
@@ -518,10 +534,37 @@ var Metamask = class extends Wallet {
     }
     await (0, import_test3.expect)(readyIndicator).toBeVisible({ timeout: POST_UNLOCK_TIMEOUT });
   }
+  /**
+   * Close extra MetaMask extension pages that the service worker opened
+   * during onboarding (e.g. home.html#/onboarding/completion).
+   * Keeps only this.page alive.
+   */
+  async closeExtraExtensionPages() {
+    const extOrigin = `chrome-extension://${this.extensionId}`;
+    const context = this.page.context();
+    const extras = context.pages().filter((p) => p !== this.page && p.url().startsWith(extOrigin));
+    if (extras.length > 0) {
+      debug(
+        `metamask.closeExtraExtensionPages: closing ${extras.length} extra page(s)`
+      );
+      await Promise.all(extras.map((p) => p.close()));
+    }
+  }
+  /**
+   * Poll the URL until it leaves a confirmation route. Uses polling instead
+   * of waitForURL because MetaMask uses HashRouter and hash-only changes
+   * are not reliably caught by Playwright's navigation events.
+   */
+  async waitForConfirmRouteExit(routePattern) {
+    const deadline = Date.now() + POST_CLICK_TIMEOUT;
+    while (routePattern.test(this.page.url()) && Date.now() < deadline) {
+      await this.page.waitForTimeout(500);
+    }
+  }
   /**
    * Wait for a target button while handling the Transaction Shield popup.
-   * Always navigates to sidepanel.html fresh so MetaMask's
-   * ConfirmationHandler can route to the pending approval.
+   * Navigates to sidepanel.html so MetaMask's ConfirmationHandler routes
+   * to the pending approval, then waits for the button to become visible.
    */
   async waitAndClickButton(btnLocator) {
     debug(`metamask.waitAndClickButton: navigating to sidepanel`);
@@ -532,63 +575,36 @@ var Metamask = class extends Wallet {
       btnLocator.first().waitFor({ state: "visible", timeout }).then(() => "button"),
       popup.first().waitFor({ state: "visible", timeout }).then(() => "popup")
     ]).catch(() => "timeout");
-    const handlePopupAndClick = async () => {
-      await this.dismissPopups();
-      await btnLocator.first().waitFor({ state: "visible", timeout: BUTTON_OR_POPUP_TIMEOUT });
-      await btnLocator.first().click();
-    };
     await this.page.goto(sidepanelUrl);
-    try {
-      await this.page.waitForURL(confirmRoutePattern, {
-        timeout: CONFIRMATION_ROUTE_TIMEOUT
-      });
-    } catch {
-      console.warn(
-        `[w3wallets] confirmation route not found, retrying. URL: ${this.page.url()}`
+    let result = await waitForButtonOrPopup(BUTTON_OR_POPUP_TIMEOUT);
+    if (result === "timeout") {
+      debug(
+        `metamask.waitAndClickButton: first wait timed out, reloading. URL: ${this.page.url()}`
       );
       await this.page.goto(sidepanelUrl);
-      try {
-        await this.page.waitForURL(confirmRoutePattern, {
-          timeout: CONFIRMATION_ROUTE_TIMEOUT
-        });
-      } catch {
-        console.warn(
-          `[w3wallets] confirmation route not found after retry. URL: ${this.page.url()}`
-        );
-      }
+      result = await waitForButtonOrPopup(BUTTON_OR_POPUP_TIMEOUT);
     }
-    const result = await waitForButtonOrPopup(BUTTON_OR_POPUP_TIMEOUT);
     debug(
       `metamask.waitAndClickButton: result=${result}, URL=${this.page.url()}`
     );
     if (result === "button") {
       await btnLocator.first().click();
-      await this.page.waitForURL((url) => !confirmRoutePattern.test(url.toString()), {
-        timeout: POST_CLICK_TIMEOUT
-      }).catch(() => {
-        console.warn(
-          `[w3wallets] still on confirmation route after click. URL: ${this.page.url()}`
-        );
-      });
+      await this.waitForConfirmRouteExit(confirmRoutePattern);
       return;
     }
     if (result === "popup") {
-      await handlePopupAndClick();
-      await this.page.waitForURL((url) => !confirmRoutePattern.test(url.toString()), {
-        timeout: POST_CLICK_TIMEOUT
-      }).catch(() => {
-        console.warn(
-          `[w3wallets] still on confirmation route after popup dismiss. URL: ${this.page.url()}`
-        );
-      });
+      await this.dismissPopups();
+      await btnLocator.first().waitFor({ state: "visible", timeout: BUTTON_OR_POPUP_TIMEOUT });
+      await btnLocator.first().click();
+      await this.waitForConfirmRouteExit(confirmRoutePattern);
       return;
     }
     const isOnConfirmRoute = confirmRoutePattern.test(this.page.url());
     debug(
-      `metamask.waitAndClickButton: timeout after ${BUTTON_OR_POPUP_TIMEOUT}ms. URL: ${this.page.url()}, onConfirmRoute: ${isOnConfirmRoute}`
+      `metamask.waitAndClickButton: timeout. URL: ${this.page.url()}, onConfirmRoute: ${isOnConfirmRoute}`
     );
     console.warn(
-      `[w3wallets] no button or popup found after ${BUTTON_OR_POPUP_TIMEOUT / 1e3}s. URL: ${this.page.url()}`
+      `[w3wallets] no button or popup found after waiting. URL: ${this.page.url()}`
     );
     await btnLocator.first().click({ timeout: LAST_RESORT_CLICK_TIMEOUT });
   }
@@ -610,14 +626,50 @@ var Metamask = class extends Wallet {
     await this.page.goto(`chrome-extension://${this.extensionId}/home.html`);
     const menuBtn = this.page.getByTestId("account-options-menu-button");
     await menuBtn.waitFor({ state: "visible", timeout: MENU_BUTTON_TIMEOUT });
-    await menuBtn.click();
+    await menuBtn.click({ force: true });
     await this.page.locator("text=Log out").click();
   }
   /**
-   * Unlock MetaMask with password.
-   * After unlocking, stabilizes the wallet UI by handling post-unlock
-   * screens (metametrics, onboarding completion) and dismissing queued
-   * notifications. Ends on home.html with the wallet UI ready.
+   * Force-persist the vault by locking the wallet. Called by the cache builder
+   * before closing the browser context. MetaMask MV3 stores the vault lazily —
+   * locking forces the encrypted vault to be written to chrome.storage.local.
+   */
+  async beforeCacheClose() {
+    debug("metamask.beforeCacheClose: locking wallet to force vault persistence");
+    await this.page.goto(`chrome-extension://${this.extensionId}/home.html`);
+    const menuBtn = this.page.getByTestId("account-options-menu-button");
+    const lockInput = this.page.getByTestId("unlock-password");
+    const state = await Promise.race([
+      menuBtn.waitFor({ state: "visible", timeout: MENU_BUTTON_TIMEOUT }).then(() => "ready"),
+      lockInput.waitFor({ state: "visible", timeout: MENU_BUTTON_TIMEOUT }).then(() => "locked")
+    ]).catch(() => "timeout");
+    debug(`metamask.beforeCacheClose: state=${state}`);
+    if (state === "ready") {
+      await this.lock();
+      await lockInput.waitFor({ state: "visible", timeout: LOCK_SCREEN_TIMEOUT }).catch(() => {
+      });
+    } else if (state === "timeout") {
+      debug("metamask.beforeCacheClose: forcing state sync via new UI connection");
+      const syncPage = await this.page.context().newPage();
+      await syncPage.goto(`chrome-extension://${this.extensionId}/home.html`);
+      await syncPage.waitForLoadState("networkidle");
+      const syncMenuBtn = syncPage.getByTestId("account-options-menu-button");
+      const syncLockInput = syncPage.getByTestId("unlock-password");
+      const syncState = await Promise.race([
+        syncMenuBtn.waitFor({ state: "visible", timeout: MENU_BUTTON_TIMEOUT }).then(() => "ready"),
+        syncLockInput.waitFor({ state: "visible", timeout: MENU_BUTTON_TIMEOUT }).then(() => "locked")
+      ]).catch(() => "timeout");
+      debug(`metamask.beforeCacheClose: syncPage state=${syncState}`);
+      if (syncState === "ready") {
+        await syncMenuBtn.click({ force: true });
+        await syncPage.locator("text=Log out").click();
+        await syncLockInput.waitFor({ state: "visible", timeout: LOCK_SCREEN_TIMEOUT }).catch(() => {
+        });
+      }
+      await syncPage.close();
+    }
+  }
+  /**
    * Unlock MetaMask with password.
    * After unlocking, stabilizes the wallet UI by handling post-unlock
    * screens (metametrics, onboarding completion) and dismissing queued
@@ -627,14 +679,21 @@ var Metamask = class extends Wallet {
     debug("metamask.unlock: starting");
     const pwd = password ?? this.defaultPassword;
     await this.page.goto(`chrome-extension://${this.extensionId}/home.html`);
-    await this.page.goto(`chrome-extension://${this.extensionId}/home.html`);
-    const passwordInput = this.page.getByTestId("unlock-password");
-    await passwordInput.fill(pwd);
-    await this.page.getByTestId("unlock-submit").click();
-    await this.page.waitForSelector('[data-testid="unlock-password"]', {
-      state: "hidden",
-      timeout: LOCK_SCREEN_TIMEOUT
-    });
+    const lockInput = this.page.getByTestId("unlock-password");
+    const readyIndicator = this.page.getByTestId("account-options-menu-button");
+    const state = await Promise.race([
+      lockInput.waitFor({ state: "visible", timeout: POST_UNLOCK_TIMEOUT }).then(() => "locked"),
+      readyIndicator.waitFor({ state: "visible", timeout: POST_UNLOCK_TIMEOUT }).then(() => "ready")
+    ]).catch(() => "timeout");
+    debug(`metamask.unlock: state=${state}`);
+    if (state === "locked") {
+      await lockInput.fill(pwd);
+      await this.page.getByTestId("unlock-submit").click();
+      await this.page.waitForSelector('[data-testid="unlock-password"]', {
+        state: "hidden",
+        timeout: LOCK_SCREEN_TIMEOUT
+      });
+    }
     await this.stabilizePostUnlock();
     debug("metamask.unlock: complete");
   }
@@ -646,7 +705,7 @@ var Metamask = class extends Wallet {
     debug(`metamask.switchNetwork: ${networkName} (${networkType})`);
     await this.page.getByTestId("sort-by-networks").click();
     if (networkType === "Custom") {
-      await this.page.getByRole("tab", { name: "Custom" }).click();
+      await this.page.getByRole("tab", { name: "Custom" }).click({ force: true });
     }
     await this.page.getByText(networkName).click();
     await (0, import_test3.expect)(this.page.getByTestId("sort-by-networks")).toHaveText(
@@ -672,7 +731,7 @@ var Metamask = class extends Wallet {
     await this.page.getByRole("button", { name: /save/i }).click();
   }
   async addCustomNetwork(settings) {
-    await this.page.getByTestId("account-options-menu-button").click();
+    await this.page.getByTestId("account-options-menu-button").click({ force: true });
     await this.page.getByTestId("global-menu-networks").click();
     await this.page.getByRole("button", { name: "Add a custom network" }).click();
     await this.page.getByTestId("network-form-network-name").fill(settings.name);
@@ -683,11 +742,17 @@ var Metamask = class extends Wallet {
     await this.page.getByTestId("rpc-url-input-test").fill(settings.rpc);
     await this.page.getByRole("button", { name: "Add URL" }).click();
     await this.page.getByRole("button", { name: "Save" }).click();
+    await this.page.goto(`chrome-extension://${this.extensionId}/home.html`);
+    await this.page.waitForLoadState("domcontentloaded");
   }
   async enableTestNetworks() {
-    await this.page.getByTestId("account-options-menu-button").click();
+    await this.page.getByTestId("account-options-menu-button").click({ force: true });
     await this.page.getByTestId("global-menu-networks").click();
-    await this.page.locator("text=Show test networks >> xpath=following-sibling::label").click();
+    const toggle = this.page.locator(
+      "text=Show test networks >> xpath=following-sibling::label"
+    );
+    await (0, import_test3.expect)(toggle).toBeVisible({ timeout: config.expectTimeout });
+    await toggle.click();
     await this.page.keyboard.press("Escape");
   }
   async importAccount(privateKey) {