|
| 1 | +/* |
| 2 | + * Copyright 2026 Element Creations Ltd. |
| 3 | + * |
| 4 | + * SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial |
| 5 | + * Please see LICENSE files in the repository root for full details. |
| 6 | + */ |
| 7 | + |
| 8 | +import { expect, type Locator, type Page } from "@playwright/test"; |
| 9 | + |
| 10 | +// We want to avoid using `mergeTests` in index.ts because it drops useful type |
| 11 | +// information about the fixtures. Instead, we add `services` into our fixture |
| 12 | +// suite by using its `test` as a base, so that there is a linear hierarchy. |
| 13 | +import { test as base } from "./services.js"; |
| 14 | + |
| 15 | +// This fixture provides convenient handling of Element Web's toasts. |
| 16 | +export const test = base.extend<{ |
| 17 | + /** |
| 18 | + * Convenience functions for handling toasts. |
| 19 | + */ |
| 20 | + toasts: Toasts; |
| 21 | +}>({ |
| 22 | + toasts: async ({ page }, use) => { |
| 23 | + const toasts = new Toasts(page); |
| 24 | + await use(toasts); |
| 25 | + }, |
| 26 | +}); |
| 27 | + |
| 28 | +class Toasts { |
| 29 | + public constructor(public readonly page: Page) {} |
| 30 | + |
| 31 | + /** |
| 32 | + * Assert that no toasts exist |
| 33 | + */ |
| 34 | + public async assertNoToasts(): Promise<void> { |
| 35 | + await expect(this.page.locator(".mx_Toast_toast")).not.toBeVisible(); |
| 36 | + } |
| 37 | + |
| 38 | + /** |
| 39 | + * Assert that a toast with the given title exists, and return it |
| 40 | + * |
| 41 | + * @param title - Expected title of the toast |
| 42 | + * @param timeout - Time to retry the assertion for in milliseconds. |
| 43 | + * Defaults to `timeout` in `TestConfig.expect`. |
| 44 | + * @returns the Locator for the matching toast |
| 45 | + */ |
| 46 | + public async getToast(title: string, timeout?: number): Promise<Locator> { |
| 47 | + const toast = this.getToastIfExists(title); |
| 48 | + await expect(toast).toBeVisible({ timeout }); |
| 49 | + return toast; |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * Find a toast with the given title, if it exists. |
| 54 | + * |
| 55 | + * @param title - Title of the toast. |
| 56 | + * @returns the Locator for the matching toast, or an empty locator if it |
| 57 | + * doesn't exist. |
| 58 | + */ |
| 59 | + public getToastIfExists(title: string): Locator { |
| 60 | + return this.page.locator(".mx_Toast_toast", { hasText: title }).first(); |
| 61 | + } |
| 62 | + |
| 63 | + /** |
| 64 | + * Accept a toast with the given title. Only works for the first toast in |
| 65 | + * the stack. |
| 66 | + * |
| 67 | + * @param title - Expected title of the toast |
| 68 | + */ |
| 69 | + public async acceptToast(title: string): Promise<void> { |
| 70 | + const toast = await this.getToast(title); |
| 71 | + await toast.locator('.mx_Toast_buttons button[data-kind="primary"]').click(); |
| 72 | + } |
| 73 | + /** |
| 74 | + * Accept a toast with the given title, if it exists. Only works for the |
| 75 | + * first toast in the stack. |
| 76 | + * |
| 77 | + * @param title - Title of the toast |
| 78 | + */ |
| 79 | + public async acceptToastIfExists(title: string): Promise<void> { |
| 80 | + const toast = this.getToastIfExists(title).locator('.mx_Toast_buttons button[data-kind="primary"]'); |
| 81 | + if ((await toast.count()) > 0) { |
| 82 | + await toast.click(); |
| 83 | + } |
| 84 | + } |
| 85 | + |
| 86 | + /** |
| 87 | + * Reject a toast with the given title. Only works for the first toast in |
| 88 | + * the stack. |
| 89 | + * |
| 90 | + * @param title - Expected title of the toast |
| 91 | + */ |
| 92 | + public async rejectToast(title: string): Promise<void> { |
| 93 | + const toast = await this.getToast(title); |
| 94 | + await toast.locator('.mx_Toast_buttons button[data-kind="secondary"]').click(); |
| 95 | + } |
| 96 | + |
| 97 | + /** |
| 98 | + * Reject a toast with the given title, if it exists. Only works for the |
| 99 | + * first toast in the stack. |
| 100 | + * |
| 101 | + * @param title - Title of the toast |
| 102 | + */ |
| 103 | + public async rejectToastIfExists(title: string): Promise<void> { |
| 104 | + const toast = this.getToastIfExists(title).locator('.mx_Toast_buttons button[data-kind="secondary"]'); |
| 105 | + if ((await toast.count()) > 0) { |
| 106 | + await toast.click(); |
| 107 | + } |
| 108 | + } |
| 109 | +} |
0 commit comments