vault.ts

1/**2 * Shared vault setup for the Playwright specs.3 *4 * Every spec used to carry its own copy of this flow, and most copies still5 * filled "password123" — which fails the create-vault gate (12 chars AND6 * zxcvbn score >= 2), so the button stayed disabled, no vault was created, and7 * the rest of the spec ran against a locked popup while still reporting green.8 * setupVault() below asserts it reached the unlocked vault, so that failure9 * mode is now a loud error instead of a silent pass.10 */11import { expect, type BrowserContext, type Page } from "@playwright/test";12import { fileURLToPath } from "url";13import { dirname, join } from "path";14import os from "os";15import fs from "fs/promises";1617const __filename = fileURLToPath(import.meta.url);18const __dirname = dirname(__filename);19export const EXTENSION_PATH = join(__dirname, "..", "..", "dist");2021/** Passes both the 12-character minimum and the zxcvbn strength gate. */22export const VAULT_PASSWORD = "correct horse battery staple";2324/** The unlocked vault's tell — present only once the vault view is mounted. */25export const UNLOCKED = ".peach-lock-btn[aria-label='Lock vault']";2627export async function makeContext(prefix = "peach"): Promise<BrowserContext> {28  const { chromium } = await import("playwright");29  const userDataDir = join(30    os.tmpdir(),31    `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2)}`,32  );33  await fs.mkdir(userDataDir, { recursive: true });34  return chromium.launchPersistentContext(userDataDir, {35    headless: false,36    args: [37      `--load-extension=${EXTENSION_PATH}`,38      `--disable-extensions-except=${EXTENSION_PATH}`,39    ],40  });41}4243export async function waitForSW(ctx: BrowserContext, maxWait = 15000): Promise<string> {44  const start = Date.now();45  let sw = ctx.serviceWorkers()[0];46  while (!sw && Date.now() - start < maxWait) {47    await new Promise((r) => setTimeout(r, 500));48    sw = ctx.serviceWorkers()[0];49  }50  if (!sw) throw new Error(`No SW after ${maxWait}ms`);51  return new URL(sw.url()).host;52}5354export async function loadPopup(ctx: BrowserContext): Promise<{ popup: Page; extId: string }> {55  const extId = await waitForSW(ctx);56  const popup = await ctx.newPage();57  await popup.goto(`chrome-extension://${extId}/src/popup/index.html`);58  await popup.waitForTimeout(3000);59  return { popup, extId };60}6162/** Click through the intro carousel until the create-vault form is on screen. */63async function reachCreateScreen(popup: Page): Promise<void> {64  const advanceButton = popup.getByRole("button", { name: /next|get started/i });65  // Create screen uses #master-password; the unlock/lock screen uses66  // #unlock-password. Keep this one pointed at the create field.67  const pw = popup.locator("#master-password");68  for (let i = 0; i < 5 && !(await pw.isVisible().catch(() => false)); i++) {69    if (await advanceButton.isVisible({ timeout: 500 }).catch(() => false)) {70      await advanceButton.click();71      await popup.waitForTimeout(300);72      continue;73    }74    await popup.locator(".peach-onboarding-card").click();75    await popup.waitForTimeout(300);76  }77  if (!(await pw.isVisible().catch(() => false))) {78    throw new Error("setupVault: never reached the create-vault screen (#master-password)");79  }80}8182/**83 * Create a vault and land in the unlocked view.84 *85 * confirmRecovery: false stops on the recovery-words screen instead — only for86 * specs that assert on that screen itself.87 */88export async function setupVault(89  ctx: BrowserContext,90  password = VAULT_PASSWORD,91  opts: { confirmRecovery?: boolean } = {},92): Promise<{ popup: Page; extId: string }> {93  const { confirmRecovery = true } = opts;94  const { popup, extId } = await loadPopup(ctx);95  await reachCreateScreen(popup);96  await popup.locator("#master-password").fill(password);97  await popup.locator("#confirm-password").fill(password);98  // The submit button's label is replaced by the blocker message while the99  // gate is unmet ("need 4 more characters"), so locate it by class rather100  // than by name — and surface that label if it never becomes enabled.101  const createBtn = popup.locator(".peach-newvault-submit");102  if (!(await createBtn.isEnabled().catch(() => false))) {103    await expect(createBtn, `create-vault gate not met: "${await createBtn.textContent()}"`)104      .toBeEnabled({ timeout: 5000 });105  }106  await createBtn.click();107  // Vault creation runs Argon2id, which can exceed a few seconds under load —108  // give the recovery display room so this doesn't flake.109  await expect(popup.locator(".lock-screen--recovery-display")).toBeVisible({ timeout: 30000 });110  if (confirmRecovery) await completeRecoveryConfirmation(popup);111  return { popup, extId };112}113114export async function completeRecoveryConfirmation(popup: Page): Promise<void> {115  const recoveryWords = popup.locator(".peach-recovery-word-text");116  const confirmInputs = popup.locator(".peach-recovery-confirm-input");117  const confirmButton = popup.getByRole("button", { name: /i wrote them down/i });118119  await expect(confirmInputs).toHaveCount(3);120  await expect(confirmInputs.first()).toBeEnabled({ timeout: 15000 });121122  const words = await recoveryWords.allTextContents();123  const confirmedWords = [words[2], words[6], words[10]];124  for (let i = 0; i < confirmedWords.length; i++) {125    const word = confirmedWords[i]?.trim();126    if (!word) throw new Error(`missing recovery word at position ${i}`);127    await confirmInputs.nth(i).fill(word);128  }129130  await expect(confirmButton).toBeEnabled({ timeout: 2000 });131  await confirmButton.click();132  await expect(133    popup.locator(UNLOCKED),134    "setupVault: recovery confirmation did not land in the unlocked vault",135  ).toBeVisible({ timeout: 10000 });136}137138export async function lockVault(popup: Page): Promise<void> {139  const lockBtn = popup.locator(UNLOCKED);140  await expect(lockBtn).toBeVisible({ timeout: 15000 });141  await lockBtn.click();142  await expect(popup.locator("#unlock-password")).toBeVisible({ timeout: 15000 });143}144145export async function unlockVault(popup: Page, password = VAULT_PASSWORD): Promise<void> {146  await popup.locator("#unlock-password").fill(password);147  await popup.getByRole("button", { name: /unlock/i }).click();148  await expect(popup.locator(UNLOCKED)).toBeVisible({ timeout: 20000 });149}150151export async function openSettings(popup: Page): Promise<void> {152  await popup.locator(".peach-icon-btn[aria-label='Settings']").click();153  await expect(popup.locator(".stk-shell")).toBeVisible({ timeout: 10000 });154}155156/**157 * Open the entry list. The top search bar is readOnly — clicking it is what158 * mounts the list overlay, which is where the real search input and the159 * new-entry button live.160 */161export async function openList(popup: Page): Promise<void> {162  if (await popup.locator(".peach-overlay-view .peach-search-input").isVisible().catch(() => false)) return;163  await popup.locator(".peach-search-wrap .peach-search-input").click();164  await expect(popup.locator(".peach-overlay-view .peach-search-input")).toBeVisible({ timeout: 5000 });165}166167/** The editable search field, inside the list overlay. */168export function listSearch(popup: Page) {169  return popup.locator(".peach-overlay-view .peach-search-input");170}171172/**173 * Fill and submit the new-entry form. Selectors follow Add.tsx: the title field174 * is .peach-new-title-input (it was .peach-new-name-input in an older UI, which175 * is why the specs that still use that class fail to find it).176 */177export async function createEntryViaForm(178  popup: Page,179  entry: { title: string; url?: string; username?: string; password?: string; totp?: string; notes?: string },180): Promise<void> {181  await openList(popup);182  await popup.locator(".peach-new-entry-row").click();183  await popup.locator(".peach-new-title-input").fill(entry.title);184  if (entry.url) await popup.locator(".peach-domain-value--edit").fill(entry.url);185  if (entry.username) await popup.locator('input[placeholder="johndoe"]').fill(entry.username);186  if (entry.password) await popup.locator('input[placeholder="password"]').fill(entry.password);187  // 2FA and notes are behind "+ add" links until they hold a value.188  if (entry.totp) {189    await popup.getByRole("button", { name: /add 2FA/i }).click();190    await popup.locator('input[placeholder*="BASE32" i]').fill(entry.totp);191  }192  if (entry.notes) {193    await popup.getByRole("button", { name: /add notes/i }).click();194    await popup.locator(".peach-new-textarea").fill(entry.notes);195  }196  const create = popup.getByRole("button", { name: /^create$/i });197  await expect(create, "create button stayed disabled — the entry form rejected the input").toBeEnabled();198  await create.click();199  await expect(popup.locator(".peach-new-title-input")).toHaveCount(0, { timeout: 10000 });200}201202/** Add an entry through the background message API (faster than the new-entry form). */203export async function addEntry(204  popup: Page,205  entry: { title: string; url?: string; username?: string; password?: string; totp?: string },206): Promise<void> {207  const result = await popup.evaluate(async (payload) => {208    return new Promise<{ ok?: boolean; error?: string }>((resolve) => {209      chrome.runtime.sendMessage({ type: "ADD_ENTRY", payload: { type: "login", ...payload } }, resolve);210    });211  }, entry);212  // A locked vault answers { ok: false, error: "vault_locked" } — without this213  // check the entry silently never exists and the spec asserts nothing.214  if (!result?.ok) throw new Error(`addEntry(${entry.title}) failed: ${result?.error ?? "no response"}`);215}