element-web/playwright/e2e/room-directory/room-directory.spec.ts

/*
Copyright 2022 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import type { Preset, Visibility } from "matrix-js-sdk/src/matrix";
import { test, expect } from "../../element-web-test";

test.describe("Room Directory", () => {
    test.use({
        displayName: "Ray",
        botCreateOpts: { displayName: "Paul" },
    });

    test("should allow admin to add alias & publish room to directory", async ({ page, app, user, bot }) => {
        const roomId = await app.client.createRoom({
            name: "Gaming",
            preset: "public_chat" as Preset,
        });

        await app.viewRoomByName("Gaming");
        await app.settings.openRoomSettings();

        // First add a local address `gaming`
        const localAddresses = page.locator(".mx_SettingsFieldset", { hasText: "Local Addresses" });
        await localAddresses.getByRole("textbox").fill("gaming");
        await localAddresses.getByRole("button", { name: "Add" }).click();
        await expect(localAddresses.getByText("#gaming:localhost")).toHaveClass("mx_EditableItem_item");

        // Publish into the public rooms directory
        const publishedAddresses = page.locator(".mx_SettingsFieldset", { hasText: "Published Addresses" });
        await expect(publishedAddresses.locator("#canonicalAlias")).toHaveValue("#gaming:localhost");
        const checkbox = publishedAddresses.getByLabel(
            "Publish this room to the public in localhost's room directory?",
        );
        await checkbox.check();
        await expect(checkbox).toBeChecked();

        await app.closeDialog();

        const resp = await bot.publicRooms({});
        expect(resp.total_room_count_estimate).toEqual(1);
        expect(resp.chunk).toHaveLength(1);
        expect(resp.chunk[0].room_id).toEqual(roomId);
    });

    test("should allow finding published rooms in directory", async ({ page, app, user, bot }) => {
        const name = "This is a public room";
        await bot.createRoom({
            visibility: "public" as Visibility,
            name,
            room_alias_name: "test1234",
        });

        await page.getByRole("button", { name: "Explore rooms" }).click();

        const dialog = page.locator(".mx_SpotlightDialog");
        await dialog.getByRole("textbox", { name: "Search" }).fill("Unknown Room");
        await expect(
            dialog.getByText("If you can't find the room you're looking for, ask for an invite or create a new room."),
        ).toHaveClass("mx_SpotlightDialog_otherSearches_messageSearchText");

        await expect(page.locator(".mx_Dialog")).toMatchScreenshot("filtered-no-results.png");

        await dialog.getByRole("textbox", { name: "Search" }).fill("test1234");
        await expect(dialog.getByText(name)).toHaveClass("mx_SpotlightDialog_result_publicRoomName");

        await expect(page.locator(".mx_Dialog")).toMatchScreenshot("filtered-one-result.png");

        await page
            .locator(".mx_SpotlightDialog .mx_SpotlightDialog_option")
            .getByRole("button", { name: "Join" })
            .click();

        await expect(page).toHaveURL("/#/room/#test1234:localhost");
    });
});