Add basic performance testing via Cypress (#8586)

cypress/support/bot.ts

@@ -40,7 +40,7 @@ Cypress.Commands.add("getBot", (synapse: SynapseInstance, displayName?: string):
     const username = Cypress._.uniqueId("userId_");
     const password = Cypress._.uniqueId("password_");
     return cy.registerUser(synapse, username, password, displayName).then(credentials => {
-        return cy.window().then(win => {
+        return cy.window({ log: false }).then(win => {
             const cli = new win.matrixcs.MatrixClient({
                 baseUrl: synapse.baseUrl,
                 userId: credentials.userId,

cypress/support/client.ts

@@ -46,11 +46,11 @@ declare global {
 }
 
 Cypress.Commands.add("getClient", (): Chainable<MatrixClient | undefined> => {
-    return cy.window().then(win => win.mxMatrixClientPeg.matrixClient);
+    return cy.window({ log: false }).then(win => win.mxMatrixClientPeg.matrixClient);
 });
 
 Cypress.Commands.add("createRoom", (options: ICreateRoomOpts): Chainable<string> => {
-    return cy.window().then(async win => {
+    return cy.window({ log: false }).then(async win => {
         const cli = win.mxMatrixClientPeg.matrixClient;
         const resp = await cli.createRoom(options);
         const roomId = resp.room_id;

cypress/support/index.ts

@@ -16,6 +16,7 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
+import "./performance";
 import "./synapse";
 import "./login";
 import "./client";

cypress/support/login.ts

@@ -43,7 +43,7 @@ declare global {
 
 Cypress.Commands.add("initTestUser", (synapse: SynapseInstance, displayName: string): Chainable<UserCredentials> => {
     // XXX: work around Cypress not clearing IDB between tests
-    cy.window().then(win => {
+    cy.window({ log: false }).then(win => {
         win.indexedDB.databases().then(databases => {
             databases.forEach(database => {
                 win.indexedDB.deleteDatabase(database.name);
@@ -73,7 +73,7 @@ Cypress.Commands.add("initTestUser", (synapse: SynapseInstance, displayName: str
             },
         });
     }).then(response => {
-        cy.window().then(win => {
+        cy.window({ log: false }).then(win => {
             // Seed the localStorage with the required credentials
             win.localStorage.setItem("mx_hs_url", synapse.baseUrl);
             win.localStorage.setItem("mx_user_id", response.body.user_id);

cypress/support/performance.ts

@@ -0,0 +1,74 @@
+/*
+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 Chainable = Cypress.Chainable;
+import AUTWindow = Cypress.AUTWindow;
+
+declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
+    namespace Cypress {
+        interface Chainable {
+            /**
+             * Start measuring the duration of some task.
+             * @param task The task name.
+             */
+            startMeasuring(task: string): Chainable<AUTWindow>;
+            /**
+             * Stop measuring the duration of some task.
+             * The duration is reported in the Cypress log.
+             * @param task The task name.
+             */
+            stopMeasuring(task: string): Chainable<AUTWindow>;
+        }
+    }
+}
+
+function getPrefix(task: string): string {
+    return `cy:${Cypress.spec.name.split(".")[0]}:${task}`;
+}
+
+function startMeasuring(task: string): Chainable<AUTWindow> {
+    return cy.window({ log: false }).then((win) => {
+        win.mxPerformanceMonitor.start(getPrefix(task));
+    });
+}
+
+function stopMeasuring(task: string): Chainable<AUTWindow> {
+    return cy.window({ log: false }).then((win) => {
+        const measure = win.mxPerformanceMonitor.stop(getPrefix(task));
+        cy.log(`**${task}** ${measure.duration} ms`);
+    });
+}
+
+Cypress.Commands.add("startMeasuring", startMeasuring);
+Cypress.Commands.add("stopMeasuring", stopMeasuring);
+
+Cypress.on("window:before:unload", (event: BeforeUnloadEvent) => {
+    const doc = event.target as Document;
+    if (doc.location.href === "about:blank") return;
+    const win = doc.defaultView as AUTWindow;
+    if (!win.mxPerformanceMonitor) return;
+    const entries = win.mxPerformanceMonitor.getEntries().filter(entry => {
+        return entry.name.startsWith("cy:");
+    });
+    if (!entries || entries.length === 0) return;
+    cy.task("addMeasurements", entries);
+});
+
+// Needed to make this file a module
+export { };

cypress/support/synapse.ts

@@ -63,7 +63,7 @@ function startSynapse(template: string): Chainable<SynapseInstance> {
 function stopSynapse(synapse?: SynapseInstance): Chainable<AUTWindow> {
     if (!synapse) return;
     // Navigate away from app to stop the background network requests which will race with Synapse shutting down
-    return cy.window().then((win) => {
+    return cy.window({ log: false }).then((win) => {
         win.location.href = 'about:blank';
         cy.task("synapseStop", synapse.synapseId);
     });