From d5a4fc96aed005089ca61428b5e16e228dc8887e Mon Sep 17 00:00:00 2001 From: Erwan Leboucher Date: Sun, 26 Jul 2026 14:40:22 +0200 Subject: [PATCH] test(e2e): cover device verification reset and sliding sync account data --- tests/e2e/device-verification-reset.spec.ts | 173 ++++++++++++++++++++ 1 file changed, 173 insertions(+) create mode 100644 tests/e2e/device-verification-reset.spec.ts diff --git a/tests/e2e/device-verification-reset.spec.ts b/tests/e2e/device-verification-reset.spec.ts new file mode 100644 index 000000000..a39bcf0c4 --- /dev/null +++ b/tests/e2e/device-verification-reset.spec.ts @@ -0,0 +1,173 @@ +import { readFile } from 'node:fs/promises'; +import { test, expect, type Page } from '@playwright/test'; +import { registerUser } from './fixtures/continuwuity'; + +const PASSWORD = 'test-passw0rd'; +const UPLOAD_ROUTE = '**/_matrix/client/*/keys/device_signing/upload'; +const TICKET_PATH = '/e2e-oauth-ticket'; +const SESSION = 'e2e-reset-oauth-session'; + +type AuthDict = { type?: string; session?: string }; + +type InjectedSession = { + baseUrl: string; + userId: string; + deviceId: string; + accessToken: string; + slidingSyncOptIn?: boolean; +}; + +async function homeserverBaseUrl(storageStatePath: string): Promise { + const state = JSON.parse(await readFile(storageStatePath, 'utf8')) as { + origins: { localStorage: { name: string; value: string }[] }[]; + }; + const entry = state.origins[0]!.localStorage.find((item) => item.name === 'matrixSessions')!; + return (JSON.parse(entry.value) as InjectedSession[])[0]!.baseUrl; +} + +async function loginAsFreshUser( + page: Page, + baseUrl: string, + name: string, + slidingSync = false +): Promise { + const user = await registerUser(baseUrl, name, PASSWORD); + const session: InjectedSession = { + baseUrl, + userId: user.userId, + deviceId: user.deviceId, + accessToken: user.accessToken, + ...(slidingSync ? { slidingSyncOptIn: true } : {}), + }; + await page.addInitScript((injected: InjectedSession) => { + localStorage.setItem('matrixSessions', JSON.stringify([injected])); + localStorage.setItem('matrixActiveSession', JSON.stringify(injected.userId)); + localStorage.setItem('dismissNotice', 'true'); + }, session); +} + +const recoveryKeyShown = (page: Page) => page.getByRole('button', { name: 'Copy', exact: true }); + +test.describe('device verification reset', () => { + test('completes the UIA stage and reveals a new recovery key', async ({ page }, testInfo) => { + test.setTimeout(180_000); + const storageStatePath = testInfo.project.use.storageState as string; + const hsBaseUrl = await homeserverBaseUrl(storageStatePath); + await loginAsFreshUser(page, hsBaseUrl, `reset-uia-${testInfo.project.name}-${process.pid}`); + + await page.goto('/settings/devices'); + + await page.getByRole('button', { name: 'Enable' }).click({ timeout: 180_000 }); + await expect(page.getByText('Setup Device Verification')).toBeVisible(); + await page.locator('form').getByRole('button', { name: 'Continue' }).click(); + await expect(recoveryKeyShown(page)).toBeVisible({ timeout: 120_000 }); + + await page.reload(); + await page + .locator('#device-verification') + .locator('button[aria-pressed]') + .click({ timeout: 180_000 }); + await page.getByRole('button', { name: 'Reset', exact: true }).click(); + + await expect(page.getByText('Reset Device Verification')).toBeVisible(); + await page.getByRole('button', { name: 'Reset', exact: true }).last().click(); + await page.locator('input[name="passphraseInput"]').fill('a memorable passphrase'); + await page.locator('form').getByRole('button', { name: 'Continue' }).click(); + + await expect(page.getByText('Account Password', { exact: true })).toBeVisible({ + timeout: 60_000, + }); + const password = page.locator('input[name="passwordInput"]'); + await password.fill(PASSWORD); + await password.press('Enter'); + + await expect(recoveryKeyShown(page)).toBeVisible({ timeout: 120_000 }); + await expect(page.getByText('Account Password', { exact: true })).toBeHidden(); + }); + + test('completes the m.oauth UIA stage and reveals a new recovery key', async ({ + page, + baseURL, + }, testInfo) => { + test.setTimeout(180_000); + const storageStatePath = testInfo.project.use.storageState as string; + const hsBaseUrl = await homeserverBaseUrl(storageStatePath); + await loginAsFreshUser(page, hsBaseUrl, `reset-oauth-${testInfo.project.name}-${process.pid}`); + + await page.goto('/settings/devices'); + + await page.getByRole('button', { name: 'Enable' }).click({ timeout: 180_000 }); + await expect(page.getByText('Setup Device Verification')).toBeVisible(); + await page.locator('form').getByRole('button', { name: 'Continue' }).click(); + await expect(recoveryKeyShown(page)).toBeVisible({ timeout: 120_000 }); + + const ticketUrl = `${baseURL}${TICKET_PATH}`; + const authDicts: (AuthDict | undefined)[] = []; + await page.route(`**${TICKET_PATH}`, (route) => + route.fulfill({ contentType: 'text/html', body: 'ticket' }) + ); + await page.route(UPLOAD_ROUTE, async (route) => { + const { auth } = route.request().postDataJSON() as { auth?: AuthDict }; + authDicts.push(auth); + + if (auth?.type === 'm.oauth' && auth.session === SESSION) { + await route.fulfill({ status: 200, contentType: 'application/json', body: '{}' }); + return; + } + + await route.fulfill({ + status: 401, + contentType: 'application/json', + body: JSON.stringify({ + flows: [{ stages: ['m.oauth'] }], + params: { 'm.oauth': { url: ticketUrl } }, + session: SESSION, + }), + }); + }); + + await page.reload(); + await page + .locator('#device-verification') + .locator('button[aria-pressed]') + .click({ timeout: 180_000 }); + await page.getByRole('button', { name: 'Reset', exact: true }).click(); + + await expect(page.getByText('Reset Device Verification')).toBeVisible(); + await page.getByRole('button', { name: 'Reset', exact: true }).last().click(); + await page.locator('form').getByRole('button', { name: 'Continue' }).click(); + + await expect(page.getByText('Account Authorization')).toBeVisible({ timeout: 120_000 }); + + const popup = page.waitForEvent('popup'); + await page.getByRole('button', { name: 'Continue in Browser' }).click(); + await (await popup).close(); + await page.getByRole('button', { name: 'Continue', exact: true, disabled: false }).click(); + + await expect(recoveryKeyShown(page)).toBeVisible({ timeout: 120_000 }); + await expect(page.getByText('Account Authorization')).toBeHidden(); + expect(authDicts[authDicts.length - 1]).toEqual({ type: 'm.oauth', session: SESSION }); + }); + + test('sets up verification when the session syncs over sliding sync', async ({ + page, + }, testInfo) => { + test.setTimeout(180_000); + const storageStatePath = testInfo.project.use.storageState as string; + const hsBaseUrl = await homeserverBaseUrl(storageStatePath); + await loginAsFreshUser( + page, + hsBaseUrl, + `setup-sliding-${testInfo.project.name}-${process.pid}`, + true + ); + + await page.goto('/settings/devices'); + + await page.getByRole('button', { name: 'Enable' }).click({ timeout: 180_000 }); + await expect(page.getByText('Setup Device Verification')).toBeVisible(); + await page.locator('form').getByRole('button', { name: 'Continue' }).click(); + + await expect(recoveryKeyShown(page)).toBeVisible({ timeout: 120_000 }); + }); +});