feat: show call participants in room list (Discord-style)

apps/web/playwright/pages/settings.ts

@@ -0,0 +1,100 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { type Locator, type Page } from "@playwright/test";
+
+import type { SettingLevel } from "../../src/settings/SettingLevel";
+
+export class Settings {
+    public constructor(private readonly page: Page) {}
+
+    /**
+     * Open the top left user menu, returning a Locator to the resulting context menu.
+     */
+    public async openUserMenu(): Promise<Locator> {
+        const locator = this.page.getByRole("menu", { name: "User menu" });
+        if (await locator.isVisible()) return locator;
+        await this.page.getByRole("button", { name: "User menu" }).click();
+        await locator.waitFor();
+        return locator;
+    }
+
+    /**
+     * Close dialog currently open dialog
+     */
+    public async closeDialog(): Promise<void> {
+        return this.page.getByRole("button", { name: "Close dialog", exact: true }).click();
+    }
+
+    /**
+     * Sets the value for a setting. The room ID is optional if the
+     * setting is not being set for a particular room, otherwise it
+     * should be supplied. The value may be null to indicate that the
+     * level should no longer have an override.
+     * @param {string} settingName The name of the setting to change.
+     * @param {String} roomId The room ID to change the value in, may be
+     * null.
+     * @param {SettingLevel} level The level to change the value at.
+     * @param {*} value The new value of the setting, may be null.
+     * @return {Promise} Resolves when the setting has been changed.
+     */
+    public async setValue(settingName: string, roomId: string | null, level: SettingLevel, value: any): Promise<void> {
+        return this.page.evaluate<
+            Promise<void>,
+            {
+                settingName: string;
+                roomId: string | null;
+                level: SettingLevel;
+                value: any;
+            }
+        >(
+            ({ settingName, roomId, level, value }) => {
+                return window.mxSettingsStore.setValue(settingName, roomId, level, value);
+            },
+            { settingName, roomId, level, value },
+        );
+    }
+
+    /**
+     * Switch settings tab to the one by the given name
+     * @param tab the name of the tab to switch to.
+     */
+    public async switchTab(tab: string): Promise<void> {
+        await this.page
+            .locator(".mx_TabbedView_tabLabels")
+            .locator(".mx_TabbedView_tabLabel", { hasText: tab })
+            .click();
+    }
+
+    /**
+     * Open user settings (via user menu), returns a locator to the dialog
+     * @param tab the name of the tab to switch to after opening, optional.
+     */
+    public async openUserSettings(tab?: string): Promise<Locator> {
+        const locator = await this.openUserMenu();
+        await locator.getByRole("menuitem", { name: "All settings", exact: true }).click();
+        if (tab) await this.switchTab(tab);
+        return this.page.locator(".mx_Dialog").filter({ has: this.page.locator(".mx_UserSettingsDialog") });
+    }
+
+    /**
+     * Open room settings (via room info panel), returns a locator to the dialog
+     * @param tab the name of the tab to switch to after opening, optional.
+     */
+    public async openRoomSettings(tab?: string): Promise<Locator> {
+        // Open right panel if not open
+        const rightPanel = this.page.locator(".mx_RightPanel");
+        if ((await rightPanel.count()) === 0) {
+            await this.page.getByRole("button", { name: "Room info" }).first().click();
+        }
+        await rightPanel.getByRole("menuitem", { name: "Settings" }).click();
+
+        if (tab) await this.switchTab(tab);
+        return this.page.locator(".mx_Dialog").filter({ has: this.page.locator(".mx_RoomSettingsDialog") });
+    }
+}