Upgrade to Cypress 10 (#9008)

* Upgrade to Cypress 10

* Remove stale comment

cypress.config.ts

@@ -0,0 +1,33 @@
+/*
+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 { defineConfig } from 'cypress';
+
+export default defineConfig({
+    videoUploadOnPasses: false,
+    projectId: 'ppvnzg',
+    experimentalInteractiveRunEvents: true,
+    defaultCommandTimeout: 10000,
+    chromeWebSecurity: false,
+    e2e: {
+        setupNodeEvents(on, config) {
+            return require('./cypress/plugins/index.ts').default(on, config);
+        },
+        baseUrl: 'http://localhost:8080',
+        experimentalSessionAndOrigin: true,
+        specPattern: 'cypress/e2e/**/*.{js,jsx,ts,tsx}',
+    },
+});

cypress.json

@@ -1,13 +0,0 @@
-{
-    "baseUrl": "http://localhost:8080",
-    "videoUploadOnPasses": false,
-    "projectId": "ppvnzg",
-    "experimentalSessionAndOrigin": true,
-    "experimentalInteractiveRunEvents": true,
-    "retries": {
-        "runMode": 2,
-        "openMode": 0
-    },
-    "defaultCommandTimeout": 10000,
-    "chromeWebSecurity": false
-}

cypress/integration/14-timeline/timeline.spec.ts

@@ -1,145 +0,0 @@
-/*
-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 { MessageEvent } from "matrix-events-sdk";
-
-import type { ISendEventResponse } from "matrix-js-sdk/src/@types/requests";
-import type { EventType } from "matrix-js-sdk/src/@types/event";
-import type { MatrixClient } from "matrix-js-sdk/src/client";
-import { SynapseInstance } from "../../plugins/synapsedocker";
-import { SettingLevel } from "../../../src/settings/SettingLevel";
-import Chainable = Cypress.Chainable;
-
-// The avatar size used in the timeline
-const AVATAR_SIZE = 30;
-// The resize method used in the timeline
-const AVATAR_RESIZE_METHOD = "crop";
-
-const ROOM_NAME = "Test room";
-const OLD_AVATAR = "avatar_image1";
-const NEW_AVATAR = "avatar_image2";
-const OLD_NAME = "Alan";
-const NEW_NAME = "Alan (away)";
-
-const getEventTilesWithBodies = (): Chainable<JQuery> => {
-    return cy.get(".mx_EventTile").filter((_i, e) => e.getElementsByClassName("mx_EventTile_body").length > 0);
-};
-
-const expectDisplayName = (e: JQuery<HTMLElement>, displayName: string): void => {
-    expect(e.find(".mx_DisambiguatedProfile_displayName").text()).to.equal(displayName);
-};
-
-const expectAvatar = (e: JQuery<HTMLElement>, avatarUrl: string): void => {
-    cy.getClient().then((cli: MatrixClient) => {
-        expect(e.find(".mx_BaseAvatar_image").attr("src")).to.equal(
-            // eslint-disable-next-line no-restricted-properties
-            cli.mxcUrlToHttp(avatarUrl, AVATAR_SIZE, AVATAR_SIZE, AVATAR_RESIZE_METHOD),
-        );
-    });
-};
-
-const sendEvent = (roomId: string): Chainable<ISendEventResponse> => {
-    return cy.sendEvent(
-        roomId,
-        null,
-        "m.room.message" as EventType,
-        MessageEvent.from("Message").serialize().content,
-    );
-};
-
-describe("Timeline", () => {
-    let synapse: SynapseInstance;
-
-    let roomId: string;
-
-    let oldAvatarUrl: string;
-    let newAvatarUrl: string;
-
-    describe("useOnlyCurrentProfiles", () => {
-        beforeEach(() => {
-            cy.startSynapse("default").then(data => {
-                synapse = data;
-                cy.initTestUser(synapse, OLD_NAME).then(() =>
-                    cy.window({ log: false }).then(() => {
-                        cy.createRoom({ name: ROOM_NAME }).then(_room1Id => {
-                            roomId = _room1Id;
-                        });
-                    }),
-                ).then(() => {
-                    cy.uploadContent(OLD_AVATAR).then((url) => {
-                        oldAvatarUrl = url;
-                        cy.setAvatarUrl(url);
-                    });
-                }).then(() => {
-                    cy.uploadContent(NEW_AVATAR).then((url) => {
-                        newAvatarUrl = url;
-                    });
-                });
-            });
-        });
-
-        afterEach(() => {
-            cy.stopSynapse(synapse);
-        });
-
-        it("should show historical profiles if disabled", () => {
-            cy.setSettingValue("useOnlyCurrentProfiles", null, SettingLevel.ACCOUNT, false);
-            sendEvent(roomId);
-            cy.setDisplayName("Alan (away)");
-            cy.setAvatarUrl(newAvatarUrl);
-            // XXX: If we send the second event too quickly, there won't be
-            // enough time for the client to register the profile change
-            cy.wait(500);
-            sendEvent(roomId);
-            cy.viewRoomByName(ROOM_NAME);
-
-            const events = getEventTilesWithBodies();
-
-            events.should("have.length", 2);
-            events.each((e, i) => {
-                if (i === 0) {
-                    expectDisplayName(e, OLD_NAME);
-                    expectAvatar(e, oldAvatarUrl);
-                } else if (i === 1) {
-                    expectDisplayName(e, NEW_NAME);
-                    expectAvatar(e, newAvatarUrl);
-                }
-            });
-        });
-
-        it("should not show historical profiles if enabled", () => {
-            cy.setSettingValue("useOnlyCurrentProfiles", null, SettingLevel.ACCOUNT, true);
-            sendEvent(roomId);
-            cy.setDisplayName(NEW_NAME);
-            cy.setAvatarUrl(newAvatarUrl);
-            // XXX: If we send the second event too quickly, there won't be
-            // enough time for the client to register the profile change
-            cy.wait(500);
-            sendEvent(roomId);
-            cy.viewRoomByName(ROOM_NAME);
-
-            const events = getEventTilesWithBodies();
-
-            events.should("have.length", 2);
-            events.each((e) => {
-                expectDisplayName(e, NEW_NAME);
-                expectAvatar(e, newAvatarUrl);
-            });
-        });
-    });
-});

package.json

@@ -170,7 +170,7 @@
     "babel-jest": "^26.6.3",
     "blob-polyfill": "^6.0.20211015",
     "chokidar": "^3.5.1",
-    "cypress": "^9.6.1",
+    "cypress": "^10.3.0",
     "cypress-real-events": "^1.7.0",
     "enzyme": "^3.11.0",
     "enzyme-to-json": "^3.6.2",

yarn.lock

@@ -3651,10 +3651,10 @@ cypress-real-events@^1.7.0:
   resolved "https://registry.yarnpkg.com/cypress-real-events/-/cypress-real-events-1.7.0.tgz#ad6a78de33af3af0e6437f5c713e30691c44472c"
   integrity sha512-iyXp07j0V9sG3YClVDcvHN2DAQDgr+EjTID82uWDw6OZBlU3pXEBqTMNYqroz3bxlb0k+F74U81aZwzMNaKyew==
 
-cypress@^9.6.1:
-  version "9.6.1"
-  resolved "https://registry.yarnpkg.com/cypress/-/cypress-9.6.1.tgz#a7d6b5a53325b3dc4960181f5800a5ade0f085eb"
-  integrity sha512-ECzmV7pJSkk+NuAhEw6C3D+RIRATkSb2VAHXDY6qGZbca/F9mv5pPsj2LO6Ty6oIFVBTrwCyL9agl28MtJMe2g==
+cypress@^10.3.0:
+  version "10.3.0"
+  resolved "https://registry.yarnpkg.com/cypress/-/cypress-10.3.0.tgz#fae8d32f0822fcfb938e79c7c31ef344794336ae"
+  integrity sha512-txkQWKzvBVnWdCuKs5Xc08gjpO89W2Dom2wpZgT9zWZT5jXxqPIxqP/NC1YArtkpmp3fN5HW8aDjYBizHLUFvg==
   dependencies:
     "@cypress/request" "^2.88.10"
     "@cypress/xvfb" "^1.2.4"