Migrate right-panel/* from Cypress to Playwright (#11954)

* Migrate file-panel.spec.ts from Cypress to Playwright

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Migrate right-panel.spec.ts from Cypress to Playwright

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Migrate notification-panel.spec.ts from Cypress to Playwright

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Update screenshots

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Update screenshots

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Fix test flakes

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* delint

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Update screenshot

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Fix tests

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Update screenshots

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Try stabilise test

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* sleep

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Handle both cases

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Fix assertion

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Flip

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Test

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Iterate

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Test

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

---------

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

playwright/pages/ElementAppPage.ts

@@ -14,14 +14,16 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { type Locator, type Page } from "@playwright/test";
+import { type Locator, type Page, expect } from "@playwright/test";
 
 import { Settings } from "./settings";
 import { Client } from "./client";
+import { Labs } from "./labs";
 
 export class ElementAppPage {
     public constructor(private readonly page: Page) {}
 
+    public labs = new Labs(this.page);
     public settings = new Settings(this.page);
     public client: Client = new Client(this.page);
 
@@ -94,4 +96,25 @@ export class ElementAppPage {
         await composer.getByRole("button", { name: "More options", exact: true }).click();
         return this.page.getByRole("menu");
     }
+
+    /**
+     * Returns the space panel space button based on a name. The space
+     * must be visible in the space panel
+     * @param name The space name to find
+     */
+    public async getSpacePanelButton(name: string): Promise<Locator> {
+        const button = this.page.getByRole("button", { name: name });
+        await expect(button).toHaveClass(/mx_SpaceButton/);
+        return button;
+    }
+
+    /**
+     * Opens the given space home by name. The space must be visible in
+     * the space list.
+     * @param name The space name to find and click on/open.
+     */
+    public async viewSpaceHomeByName(name: string): Promise<void> {
+        const button = await this.getSpacePanelButton(name);
+        return button.dblclick();
+    }
 }

playwright/pages/client.ts

@@ -116,6 +116,21 @@ export class Client {
         }, options);
     }
 
+    /**
+     * Create a space with given options.
+     * @param options the options to apply when creating the space
+     * @return the ID of the newly created space (room)
+     */
+    public async createSpace(options: ICreateRoomOpts): Promise<string> {
+        return this.createRoom({
+            ...options,
+            creation_content: {
+                ...options.creation_content,
+                type: "m.space",
+            },
+        });
+    }
+
     /**
      * Joins the given room by alias or ID
      * @param roomIdOrAlias the id or alias of the room to join

playwright/pages/labs.ts

@@ -0,0 +1,32 @@
+/*
+Copyright 2023 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 { Page } from "playwright-core";
+
+export class Labs {
+    constructor(private page: Page) {}
+
+    /**
+     * Enables a labs feature for an element session.
+     * Has to be called before the session is initialized
+     * @param feature labsFeature to enable (e.g. "feature_spotlight")
+     */
+    public async enableLabsFeature(feature: string): Promise<void> {
+        await this.page.evaluate((feature) => {
+            window.localStorage.setItem(`mx_labs_feature_${feature}`, "true");
+        }, feature);
+    }
+}