Move threads e2e tests over to cypress (#8501)

* Add non-consent (default) Synapse template * Add consent test * Add create room test * Stash work * Initial threads tests * fix * Delete old threads e2e tests, plan new ones * Fix typed s'more * Try something else * specify d.ts * Fix types once and for all? * Fix the consent tests * Iterate threads test harness * Fix dispatcher types * Iterate threads test * fix typing * Alternative import attempt * let it break let it break let it break * Tweak types * Stash * delint and update docs * null-guard scrollIntoView * Iterate threads test * Apply suggestions from code review
2022-05-10 18:09:31 +01:00 · 2022-05-10 18:09:31 +01:00 · ad4d3f9a88
commit ad4d3f9a88
parent 14127c777b
27 changed files with 810 additions and 288 deletions
--- a/cypress/support/client.ts
+++ b/cypress/support/client.ts
@ -0,0 +1,78 @@
+/*
+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.
+*/
+
+/// <reference types="cypress" />
+
+import type { ICreateRoomOpts } from "matrix-js-sdk/src/@types/requests";
+import type { MatrixClient } from "matrix-js-sdk/src/client";
+import type { Room } from "matrix-js-sdk/src/models/room";
+import Chainable = Cypress.Chainable;
+
+declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
+    namespace Cypress {
+        interface Chainable {
+            /**
+             * Returns the MatrixClient from the MatrixClientPeg
+             */
+            getClient(): Chainable<MatrixClient | undefined>;
+            /**
+             * Create a room with given options.
+             * @param options the options to apply when creating the room
+             * @return the ID of the newly created room
+             */
+            createRoom(options: ICreateRoomOpts): Chainable<string>;
+            /**
+             * Invites the given user to the given room.
+             * @param roomId the id of the room to invite to
+             * @param userId the id of the user to invite
+             */
+            inviteUser(roomId: string, userId: string): Chainable<{}>;
+        }
+    }
+}
+
+Cypress.Commands.add("getClient", (): Chainable<MatrixClient | undefined> => {
+    return cy.window().then(win => win.mxMatrixClientPeg.matrixClient);
+});
+
+Cypress.Commands.add("createRoom", (options: ICreateRoomOpts): Chainable<string> => {
+    return cy.window().then(async win => {
+        const cli = win.mxMatrixClientPeg.matrixClient;
+        const resp = await cli.createRoom(options);
+        const roomId = resp.room_id;
+
+        if (!cli.getRoom(roomId)) {
+            await new Promise<void>(resolve => {
+                const onRoom = (room: Room) => {
+                    if (room.roomId === roomId) {
+                        cli.off(win.matrixcs.ClientEvent.Room, onRoom);
+                        resolve();
+                    }
+                };
+                cli.on(win.matrixcs.ClientEvent.Room, onRoom);
+            });
+        }
+
+        return roomId;
+    });
+});
+
+Cypress.Commands.add("inviteUser", (roomId: string, userId: string): Chainable<{}> => {
+    return cy.getClient().then(async (cli: MatrixClient) => {
+        return cli.invite(roomId, userId);
+    });
+});