WIP: Add E2E Contacts test to run on desktop and mobile in BrowserStack

.github/workflows/e2e-desktop-nightly-firefox.yml

@@ -1,13 +1,13 @@
 name: e2e-desktop-nightly-firefox
 
 concurrency:
-  group: e2e-desktop-nightly-firefox
-  cancel-in-progress: true
+  group: e2e-browserstack-production-account
+  cancel-in-progress: false
 
 on:
   schedule:
-    # run every day at 5:15am UTC
-    - cron:  '15 5 * * *'
+    # run every day at 5:45am UTC
+    - cron:  '45 5 * * *'
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 

.github/workflows/e2e-desktop-nightly-safari.yml

@@ -1,13 +1,13 @@
 name: e2e-desktop-nightly-safari
 
 concurrency:
-  group: e2e-desktop-nightly-safari
-  cancel-in-progress: true
+  group: e2e-browserstack-production-account
+  cancel-in-progress: false
 
 on:
   schedule:
-    # run every day at 5:30am UTC
-    - cron:  '30 5 * * *'
+    # run every day at 6:30am UTC
+    - cron:  '30 6 * * *'
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 

.github/workflows/e2e-mobile-nightly-android.yml

@@ -1,13 +1,13 @@
 name: e2e-mobile-nightly-android
 
 concurrency:
-  group: e2e-mobile-nightly-android
-  cancel-in-progress: true
+  group: e2e-browserstack-production-account
+  cancel-in-progress: false
 
 on:
   schedule:
-    # run every day at 5:45am UTC
-    - cron:  '45 5 * * *'
+    # run every day at 7:15am UTC
+    - cron:  '15 7 * * *'
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 

.github/workflows/e2e-nightly-desktop-chrome.yml

@@ -1,8 +1,8 @@
 name: e2e-desktop-nightly-chrome
 
 concurrency:
-  group: e2e-desktop-nightly-chrome
-  cancel-in-progress: true
+  group: e2e-browserstack-production-account
+  cancel-in-progress: false
 
 on:
   schedule:

.gitignore

@@ -50,6 +50,7 @@ screenshots/
 # Temporary configuration generated by the BrowserStack Playwright SDK
 tests/browserstack/playwright-browserstack-sdk.config.ts
 tests/browserstack/playwright-browserstack-sdk.config.temp.json
+tests/browserstack/browserstackSetupConfig.json
 
 # Temporary files
 *.tmp

tests/browserstack/README.md

@@ -1,6 +1,6 @@
 # Stormbox BrowserStack E2E Tests
 
-This package contains Playwright tests for deployed Stormbox stage and production. Test actions and assertions run through the public Stormbox UI on your local machine or in BrowserStack. The folder-management suite also uses direct JMAP access from the Node test runner solely to remove test folders left by earlier interrupted runs.
+This package contains Playwright tests for deployed Stormbox stage and production. Test actions and assertions run through the public Stormbox UI on your local machine or in BrowserStack. The folder-management and Contacts suites use direct JMAP access from the Node test runner solely to remove test data left by earlier interrupted runs.
 
 These tests are not for the local Stormbox stack. The local-stack integration tests live in `../e2e` and retain their own JMAP helper, database reads, local stack setup, and cache assertions. The BrowserStack JMAP helper connects only to a deployed stage or production Thundermail account using that dedicated test account's app password.
 

tests/browserstack/helpers/jmap-client.ts

@@ -23,7 +23,9 @@ import {
 const CORE_CAPABILITY = 'urn:ietf:params:jmap:core';
 const MAIL_CAPABILITY = 'urn:ietf:params:jmap:mail';
 const SUBMISSION_CAPABILITY = 'urn:ietf:params:jmap:submission';
+const CONTACTS_CAPABILITY = 'urn:ietf:params:jmap:contacts';
 const REQUEST_TIMEOUT_MS = 30_000;
+const CONTACT_PAGE_SIZE = 200;
 
 type JmapMethodCall = [string, Record<string, unknown>, string];
 type JmapMethodResponse = [string, Record<string, unknown>, string];
@@ -39,11 +41,16 @@ interface JmapSession {
 
 interface JmapClient {
   accountId: string;
+  contactsAccountId?: string;
   apiUrl: string;
   authHeader: string;
   identityAccountId: string;
 }
 
+interface JmapContactsClient extends JmapClient {
+  contactsAccountId: string;
+}
+
 interface JmapMailbox {
   id: string;
   name: string;
@@ -208,6 +215,7 @@ async function connectJmap(): Promise<JmapClient> {
 
   const client: JmapClient = {
     accountId,
+    contactsAccountId: session.primaryAccounts?.[CONTACTS_CAPABILITY],
     apiUrl,
     authHeader,
     identityAccountId: session.primaryAccounts?.[SUBMISSION_CAPABILITY] ?? accountId,
@@ -216,6 +224,183 @@ async function connectJmap(): Promise<JmapClient> {
   return client;
 }
 
+async function connectContactsJmap(): Promise<JmapContactsClient> {
+  const client = await connectJmap();
+  if (!client.contactsAccountId || client.contactsAccountId !== client.accountId
+    || client.identityAccountId !== client.accountId) {
+    throw new Error('JMAP primary contacts, mail, and identity accounts differ; refusing cleanup');
+  }
+  return client as JmapContactsClient;
+}
+
+interface JmapContactCard {
+  id: string;
+  name?: { full?: string } | null;
+}
+
+interface JmapAddressBook {
+  id: string;
+  name: string;
+  isDefault: boolean;
+}
+
+/** Page the complete card inventory and reject an inconsistent query snapshot. */
+async function listContactCardIds(client: JmapContactsClient, filter?: Record<string, unknown>): Promise<string[]> {
+  const ids: string[] = [];
+  let queryState: string | null = null;
+  let total: number | null = null;
+
+  while (total == null || ids.length < total) {
+    const payload = await jmapRequest(client, [[
+      'ContactCard/query',
+      {
+        accountId: client.contactsAccountId,
+        ...(filter ? { filter } : {}),
+        position: ids.length,
+        limit: CONTACT_PAGE_SIZE,
+        calculateTotal: true,
+      },
+      'contactCards',
+    ]], [CORE_CAPABILITY, CONTACTS_CAPABILITY]);
+    const result = responseFor(payload, 'ContactCard/query');
+    if (typeof result.queryState !== 'string' || !result.queryState
+      || !Number.isSafeInteger(result.total) || Number(result.total) < 0
+      || result.position !== ids.length || !Array.isArray(result.ids)
+      || result.ids.length > CONTACT_PAGE_SIZE
+      || result.ids.some((id) => typeof id !== 'string')) {
+      throw new Error('ContactCard/query did not return a complete inventory page');
+    }
+    if (queryState !== null && (queryState !== result.queryState || total !== result.total)) {
+      throw new Error('ContactCard/query changed while paging; refusing cleanup');
+    }
+    queryState = result.queryState;
+    total = Number(result.total);
+    if (result.ids.length === 0 && ids.length < total) {
+      throw new Error('ContactCard/query stopped before the complete inventory was read');
+    }
+    ids.push(...result.ids as string[]);
+  }
+
+  if (ids.length !== total || new Set(ids).size !== ids.length) {
+    throw new Error('ContactCard/query returned an incomplete or duplicate inventory');
+  }
+  return ids;
+}
+
+async function listContactCards(client: JmapContactsClient): Promise<JmapContactCard[]> {
+  const ids = await listContactCardIds(client);
+  const cards: JmapContactCard[] = [];
+  for (let offset = 0; offset < ids.length; offset += CONTACT_PAGE_SIZE) {
+    const pageIds = ids.slice(offset, offset + CONTACT_PAGE_SIZE);
+    const payload = await jmapRequest(client, [[
+      'ContactCard/get',
+      { accountId: client.contactsAccountId, ids: pageIds, properties: ['id', 'name'] },
+      'contactCardDetails',
+    ]], [CORE_CAPABILITY, CONTACTS_CAPABILITY]);
+    const result = responseFor(payload, 'ContactCard/get');
+    if (!Array.isArray(result.list) || result.list.length !== pageIds.length
+      || (Array.isArray(result.notFound) && result.notFound.length > 0)) {
+      throw new Error('ContactCard/get did not return every queried card');
+    }
+    for (const card of result.list) {
+      if (typeof card !== 'object' || card == null
+        || typeof card.id !== 'string'
+        || (card.name != null && (typeof card.name !== 'object'
+          || (card.name.full != null && typeof card.name.full !== 'string')))) {
+        throw new Error('ContactCard/get returned a malformed card');
+      }
+      cards.push(card as JmapContactCard);
+    }
+  }
+  const expected = new Set(ids);
+  if (cards.length !== ids.length || cards.some((card) => !expected.delete(card.id))
+    || expected.size !== 0) {
+    throw new Error('ContactCard/get returned a mismatched card inventory');
+  }
+  return cards;
+}
+
+/** Remove only named test cards, before test address books are inspected. */
+export async function deleteContactsByPrefix(prefix: string): Promise<number> {
+  if (prefix !== 'E2E-Contact') {
+    throw new Error('Contact cleanup requires the E2E-Contact prefix');
+  }
+  const client = await connectContactsJmap();
+  const matching = (await listContactCards(client))
+    .filter((card) => card.name?.full?.startsWith(prefix));
+  for (let offset = 0; offset < matching.length; offset += CONTACT_PAGE_SIZE) {
+    const ids = matching.slice(offset, offset + CONTACT_PAGE_SIZE).map((card) => card.id);
+    const payload = await jmapRequest(client, [[
+      'ContactCard/set',
+      { accountId: client.contactsAccountId, destroy: ids },
+      'deleteContactCards',
+    ]], [CORE_CAPABILITY, CONTACTS_CAPABILITY]);
+    const result = responseFor(payload, 'ContactCard/set');
+    const destroyed = new Set(Array.isArray(result.destroyed) ? result.destroyed : []);
+    if (result.notDestroyed && Object.keys(result.notDestroyed).length > 0
+      || ids.some((id) => !destroyed.has(id))) {
+      throw new Error(`Could not delete test contacts: ${JSON.stringify(result.notDestroyed ?? {})}`);
+    }
+  }
+  if ((await listContactCards(client)).some((card) => card.name?.full?.startsWith(prefix))) {
+    throw new Error('JMAP cleanup left matching contacts');
+  }
+  return matching.length;
+}
+
+async function listAddressBooks(client: JmapContactsClient): Promise<JmapAddressBook[]> {
+  const payload = await jmapRequest(client, [[
+    'AddressBook/get',
+    { accountId: client.contactsAccountId, ids: null, properties: ['id', 'name', 'isDefault'] },
+    'addressBooks',
+  ]], [CORE_CAPABILITY, CONTACTS_CAPABILITY]);
+  const list = responseFor(payload, 'AddressBook/get').list;
+  if (!Array.isArray(list) || list.some((book) =>
+    typeof book !== 'object' || book == null
+    || typeof book.id !== 'string' || typeof book.name !== 'string'
+    || typeof book.isDefault !== 'boolean')) {
+    throw new Error('AddressBook/get did not return valid address books');
+  }
+  return list as JmapAddressBook[];
+}
+
+/** Refuse books containing other cards; never destroy their contents implicitly. */
+export async function deleteAddressBooksByPrefix(prefix: string): Promise<number> {
+  if (prefix !== 'E2E-AddressBook') {
+    throw new Error('Address book cleanup requires the E2E-AddressBook prefix');
+  }
+  const client = await connectContactsJmap();
+  const matching = (await listAddressBooks(client))
+    .filter((book) => book.name.startsWith(prefix));
+  for (const book of matching) {
+    if (book.isDefault) {
+      throw new Error(`Refusing to delete default address book "${book.name}"`);
+    }
+    const cardIds = await listContactCardIds(client, { inAddressBook: book.id });
+    if (cardIds.length > 0) {
+      throw new Error(`Refusing to delete test address book "${book.name}" containing unmatched cards`);
+    }
+    const payload = await jmapRequest(client, [[
+      'AddressBook/set',
+      {
+        accountId: client.contactsAccountId,
+        destroy: [book.id],
+        onDestroyRemoveContents: false,
+      },
+      'deleteAddressBook',
+    ]], [CORE_CAPABILITY, CONTACTS_CAPABILITY]);
+    const result = responseFor(payload, 'AddressBook/set');
+    if (result.notDestroyed && Object.keys(result.notDestroyed).length > 0
+      || !Array.isArray(result.destroyed) || !result.destroyed.includes(book.id)) {
+      throw new Error(`Could not delete test address book "${book.name}": ${JSON.stringify(result.notDestroyed ?? {})}`);
+    }
+  }
+  if ((await listAddressBooks(client)).some((book) => book.name.startsWith(prefix))) {
+    throw new Error('JMAP cleanup left matching address books');
+  }
+  return matching.length;
+}
+
 /** Fetch the complete mailbox tree needed to delete children before parents. */
 async function listMailboxes(client: JmapClient): Promise<JmapMailbox[]> {
   const payload = await jmapRequest(client, [[