Improve cypress support

Signed-off-by: Šimon Brandner <[email protected]>

Author: SimonBrandner

cypress/global.d.ts

@@ -28,11 +28,13 @@ import type {
 } from "matrix-js-sdk/src/matrix";
 import type { MatrixDispatcher } from "../src/dispatcher/dispatcher";
 import type PerformanceMonitor from "../src/performance";
+import type SettingsStore from "../src/settings/SettingsStore";
 
 declare global {
     // eslint-disable-next-line @typescript-eslint/no-namespace
     namespace Cypress {
         interface ApplicationWindow {
+            mxSettingsStore: typeof SettingsStore;
             mxMatrixClientPeg: {
                 matrixClient?: MatrixClient;
             };

cypress/support/client.ts

@@ -16,9 +16,10 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import type { ICreateRoomOpts } from "matrix-js-sdk/src/@types/requests";
+import type { ICreateRoomOpts, ISendEventResponse } 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 type { IContent } from "matrix-js-sdk/src/models/event";
 import Chainable = Cypress.Chainable;
 
 declare global {
@@ -53,6 +54,26 @@ declare global {
              * @param data The data to store.
              */
             setAccountData(type: string, data: object): Chainable<{}>;
+            /**
+             * @param {string} roomId
+             * @param {string} threadId
+             * @param {string} eventType
+             * @param {Object} content
+             * @return {module:http-api.MatrixError} Rejects: with an error response.
+             */
+            sendEvent(
+                roomId: string,
+                threadId: string | null,
+                eventType: string,
+                content: IContent
+            ): Chainable<ISendEventResponse>;
+            /**
+             * @param {string} name
+             * @param {module:client.callback} callback Optional.
+             * @return {Promise} Resolves: {} an empty object.
+             * @return {module:http-api.MatrixError} Rejects: with an error response.
+             */
+            setDisplayName(name: string): Chainable<{}>;
         }
     }
 }
@@ -103,3 +124,20 @@ Cypress.Commands.add("setAccountData", (type: string, data: object): Chainable<{
         return cli.setAccountData(type, data);
     });
 });
+
+Cypress.Commands.add("sendEvent", (
+    roomId: string,
+    threadId: string | null,
+    eventType: string,
+    content: IContent,
+): Chainable<ISendEventResponse> => {
+    return cy.getClient().then(async (cli: MatrixClient) => {
+        return cli.sendEvent(roomId, threadId, eventType, content);
+    });
+});
+
+Cypress.Commands.add("setDisplayName", (name: string): Chainable<{}> => {
+    return cy.getClient().then(async (cli: MatrixClient) => {
+        return cli.setDisplayName(name);
+    });
+});

cypress/support/settings.ts

@@ -17,11 +17,17 @@ limitations under the License.
 /// <reference types="cypress" />
 
 import Chainable = Cypress.Chainable;
+import type { SettingLevel } from "../../src/settings/SettingLevel";
+import SettingsStore from "../../src/settings/SettingsStore";
 
 declare global {
     // eslint-disable-next-line @typescript-eslint/no-namespace
     namespace Cypress {
         interface Chainable {
+            /**
+             * Returns the SettingsStore
+             */
+            getSettingsStore(): Chainable<typeof SettingsStore | undefined>;
             /**
              * Open the top left user menu, returning a handle to the resulting context menu.
              */
@@ -63,10 +69,59 @@ declare global {
              * @param name the name of the beta to leave.
              */
             leaveBeta(name: string): Chainable<JQuery<HTMLElement>>;
+
+            /**
+             * 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.
+             */
+            setSettingValue(name: string, roomId: string, level: SettingLevel, value: any): Chainable<void>;
+
+            /**
+             * Gets the value of a setting. The room ID is optional if the
+             * setting is not to be applied to any particular room, otherwise it
+             * should be supplied.
+             * @param {string} settingName The name of the setting to read the
+             * value of.
+             * @param {String} roomId The room ID to read the setting value in,
+             * may be null.
+             * @param {boolean} excludeDefault True to disable using the default
+             * value.
+             * @return {*} The value, or null if not found
+             */
+            getSettingValue<T>(name: string, roomId?: string): Chainable<T>;
         }
     }
 }
 
+Cypress.Commands.add("getSettingsStore", (): Chainable<typeof SettingsStore> => {
+    return cy.window({ log: false }).then(win => win.mxSettingsStore);
+});
+
+Cypress.Commands.add("setSettingValue", (
+    name: string,
+    roomId: string,
+    level: SettingLevel,
+    value: any,
+): Chainable<void> => {
+    return cy.getSettingsStore().then(async (store: typeof SettingsStore) => {
+        return store.setValue(name, roomId, level, value);
+    });
+});
+
+Cypress.Commands.add("getSettingValue", <T = any>(name: string, roomId?: string): Chainable<T> => {
+    return cy.getSettingsStore().then(<T>(store: typeof SettingsStore) => {
+        return store.getValue<T>(name, roomId);
+    });
+});
+
 Cypress.Commands.add("openUserMenu", (): Chainable<JQuery<HTMLElement>> => {
     cy.get('[aria-label="User menu"]').click();
     return cy.get(".mx_ContextualMenu");