Move Enterprise Erin tests from Puppeteer to Cypress

cypress/integration/2-login/login.spec.ts

@@ -54,4 +54,39 @@ describe("Login", () => {
             cy.url().should('contain', '/#/home');
         });
     });
+
+    describe("logout", () => {
+        beforeEach(() => {
+            cy.initTestUser(synapse, "Erin");
+        });
+
+        it("should go to login page on logout", () => {
+            cy.get('[aria-label="User menu"]').click();
+
+            cy.get(".mx_UserMenu_contextMenu").within(() => {
+                cy.get(".mx_UserMenu_iconSignOut").click();
+            });
+
+            cy.url().should("contain", "/#/login");
+        });
+
+        it("should respect logout_redirect_url", () => {
+            cy.tweakConfig({
+                // We redirect to decoder-ring because it's a predictable page that isn't Element itself.
+                // We could use example.org, matrix.org, or something else, however this puts dependency of external
+                // infrastructure on our tests. In the same vein, we don't really want to figure out how to ship a
+                // `test-landing.html` page when running with an uncontrolled Element (via `yarn start`).
+                // Using the decoder-ring is just as fine, and we can search for strategic names.
+                logout_redirect_url: "/decoder-ring/",
+            });
+
+            cy.get('[aria-label="User menu"]').click();
+
+            cy.get(".mx_UserMenu_contextMenu").within(() => {
+                cy.get(".mx_UserMenu_iconSignOut").click();
+            });
+
+            cy.url().should("contains", "decoder-ring");
+        });
+    });
 });

cypress/integration/3-user-menu/user-menu.spec.ts

@@ -39,7 +39,7 @@ describe("User Menu", () => {
 
     it("should contain our name & userId", () => {
         cy.get('[aria-label="User menu"]').click();
-        cy.get(".mx_ContextualMenu").within(() => {
+        cy.get(".mx_UserMenu_contextMenu").within(() => {
             cy.get(".mx_UserMenu_contextMenu_displayName").should("contain", "Jeff");
             cy.get(".mx_UserMenu_contextMenu_userId").should("contain", user.userId);
         });

cypress/support/app.ts

@@ -0,0 +1,43 @@
+/*
+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 "./client"; // XXX: without an (any) import here, types break down
+import Chainable = Cypress.Chainable;
+import AUTWindow = Cypress.AUTWindow;
+
+declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
+    namespace Cypress {
+        interface Chainable {
+            /**
+             * Applies tweaks to the config read from config.json
+             */
+            tweakConfig(tweaks: Record<string, any>): Chainable<AUTWindow>;
+        }
+    }
+}
+
+Cypress.Commands.add("tweakConfig", (tweaks: Record<string, any>): Chainable<AUTWindow> => {
+    return cy.window().then(win => {
+        // note: we can't *set* the object because the window version is effectively a pointer.
+        for (const [k, v] of Object.entries(tweaks)) {
+            // @ts-ignore - for some reason it's not picking up on global.d.ts types.
+            win.mxReactSdkConfig[k] = v;
+        }
+    });
+});

cypress/support/index.ts

@@ -21,3 +21,4 @@ import "./login";
 import "./client";
 import "./settings";
 import "./bot";
+import "./app";

src/Lifecycle.ts

@@ -166,7 +166,7 @@ export async function loadSession(opts: ILoadSessionOpts = {}): Promise<boolean>
  * Gets the user ID of the persisted session, if one exists. This does not validate
  * that the user's credentials still work, just that they exist and that a user ID
  * is associated with them. The session is not loaded.
- * @returns {[String, bool]} The persisted session's owner and whether the stored
+ * @returns {[string, boolean]} The persisted session's owner and whether the stored
  *     session is for a guest user, if an owner exists. If there is no stored session,
  *     return [null, null].
  */
@@ -492,7 +492,7 @@ async function handleLoadSessionFailure(e: Error): Promise<boolean> {
  * Also stops the old MatrixClient and clears old credentials/etc out of
  * storage before starting the new client.
  *
- * @param {MatrixClientCreds} credentials The credentials to use
+ * @param {IMatrixClientCreds} credentials The credentials to use
  *
  * @returns {Promise} promise which resolves to the new MatrixClient once it has been started
  */
@@ -523,7 +523,7 @@ export async function setLoggedIn(credentials: IMatrixClientCreds): Promise<Matr
  * If the credentials belong to a different user from the session already stored,
  * the old session will be cleared automatically.
  *
- * @param {MatrixClientCreds} credentials The credentials to use
+ * @param {IMatrixClientCreds} credentials The credentials to use
  *
  * @returns {Promise} promise which resolves to the new MatrixClient once it has been started
  */
@@ -729,27 +729,25 @@ export function logout(): void {
     if (MatrixClientPeg.get().isGuest()) {
         // logout doesn't work for guest sessions
         // Also we sometimes want to re-log in a guest session if we abort the login.
-        // defer until next tick because it calls a synchronous dispatch and we are likely here from a dispatch.
+        // defer until next tick because it calls a synchronous dispatch, and we are likely here from a dispatch.
         setImmediate(() => onLoggedOut());
         return;
     }
 
     _isLoggingOut = true;
     const client = MatrixClientPeg.get();
     PlatformPeg.get().destroyPickleKey(client.getUserId(), client.getDeviceId());
-    client.logout().then(onLoggedOut,
-        (err) => {
-            // Just throwing an error here is going to be very unhelpful
-            // if you're trying to log out because your server's down and
-            // you want to log into a different server, so just forget the
-            // access token. It's annoying that this will leave the access
-            // token still valid, but we should fix this by having access
-            // tokens expire (and if you really think you've been compromised,
-            // change your password).
-            logger.log("Failed to call logout API: token will not be invalidated");
-            onLoggedOut();
-        },
-    );
+    client.logout(undefined, true).then(onLoggedOut, (err) => {
+        // Just throwing an error here is going to be very unhelpful
+        // if you're trying to log out because your server's down and
+        // you want to log into a different server, so just forget the
+        // access token. It's annoying that this will leave the access
+        // token still valid, but we should fix this by having access
+        // tokens expire (and if you really think you've been compromised,
+        // change your password).
+        logger.warn("Failed to call logout API: token will not be invalidated", err);
+        onLoggedOut();
+    });
 }
 
 export function softLogout(): void {
@@ -851,14 +849,14 @@ async function startMatrixClient(startSyncing = true): Promise<void> {
 export async function onLoggedOut(): Promise<void> {
     _isLoggingOut = false;
     // Ensure that we dispatch a view change **before** stopping the client so
-    // so that React components unmount first. This avoids React soft crashes
+    // that React components unmount first. This avoids React soft crashes
     // that can occur when components try to use a null client.
     dis.dispatch({ action: 'on_logged_out' }, true);
     stopMatrixClient();
     await clearStorage({ deleteEverything: true });
     LifecycleCustomisations.onLoggedOutAndStorageCleared?.();
 
-    // Do this last so we can make sure all storage has been cleared and all
+    // Do this last, so we can make sure all storage has been cleared and all
     // customisations got the memo.
     if (SdkConfig.get().logout_redirect_url) {
         logger.log("Redirecting to external provider to finish logout");
@@ -901,9 +899,7 @@ async function clearStorage(opts?: { deleteEverything?: boolean }): Promise<void
         }
     }
 
-    if (window.sessionStorage) {
-        window.sessionStorage.clear();
-    }
+    window.sessionStorage?.clear();
 
     // create a temporary client to clear out the persistent stores.
     const cli = createMatrixClient({
@@ -930,7 +926,7 @@ export function stopMatrixClient(unsetClient = true): void {
     IntegrationManagers.sharedInstance().stopWatching();
     Mjolnir.sharedInstance().stop();
     DeviceListener.sharedInstance().stop();
-    if (DMRoomMap.shared()) DMRoomMap.shared().stop();
+    DMRoomMap.shared()?.stop();
     EventIndexPeg.stop();
     const cli = MatrixClientPeg.get();
     if (cli) {

test/end-to-end-tests/src/scenario.ts

@@ -28,13 +28,12 @@ import { spacesScenarios } from './scenarios/spaces';
 import { RestSession } from "./rest/session";
 import { stickerScenarios } from './scenarios/sticker';
 import { userViewScenarios } from "./scenarios/user-view";
-import { ssoCustomisationScenarios } from "./scenarios/sso-customisations";
 import { updateScenarios } from "./scenarios/update";
 
 export async function scenario(createSession: (s: string) => Promise<ElementSession>,
     restCreator: RestSessionCreator): Promise<void> {
     let firstUser = true;
-    async function createUser(username) {
+    async function createUser(username: string) {
         const session = await createSession(username);
         if (firstUser) {
             // only show browser version for first browser opened
@@ -68,12 +67,6 @@ export async function scenario(createSession: (s: string) => Promise<ElementSess
     const stickerSession = await createSession("sally");
     await stickerScenarios("sally", "ilikestickers", stickerSession, restCreator);
 
-    // we spawn yet another session for SSO stuff because it involves authentication and
-    // logout, which can/does affect other tests dramatically. See notes above regarding
-    // stickers for the performance loss of doing this.
-    const ssoSession = await createUser("enterprise_erin");
-    await ssoCustomisationScenarios(ssoSession);
-
     // Create a new window to test app auto-updating
     const updateSession = await createSession("update");
     await updateScenarios(updateSession);

test/end-to-end-tests/src/util.ts

@@ -28,7 +28,7 @@ export const range = function(start: number, amount: number, step = 1): Array<nu
     return r;
 };
 
-export const delay = function(ms): Promise<void> {
+export const delay = function(ms: number): Promise<void> {
     return new Promise((resolve) => setTimeout(resolve, ms));
 };
 
@@ -44,17 +44,6 @@ export const measureStop = function(session: ElementSession, name: string): Prom
     }, name);
 };
 
-// TODO: Proper types on `config` - for some reason won't accept an import of ConfigOptions.
-export async function applyConfigChange(session: ElementSession, config: any): Promise<void> {
-    await session.page.evaluate((_config) => {
-        // note: we can't *set* the object because the window version is effectively a pointer.
-        for (const [k, v] of Object.entries(_config)) {
-            // @ts-ignore - for some reason it's not picking up on global.d.ts types.
-            window.mxReactSdkConfig[k] = v;
-        }
-    }, config);
-}
-
 export async function serializeLog(msg: ConsoleMessage): Promise<string> {
     // 9 characters padding is somewhat arbitrary ("warning".length + some)
     let s = `${new Date().toISOString()} | ${ padEnd(msg.type(), 9, ' ')}| ${msg.text()} `; // trailing space is intentional