From 13458250bcbca2bd1a2f310afeca7c98318f8bc1 Mon Sep 17 00:00:00 2001
From: Kerry <kerrya@element.io>
Date: Fri, 7 Oct 2022 13:34:28 +0200
Subject: [PATCH] Cypress - stabilise "creating a DM should work" test (#9373)

* better error message for failed bot room join

* wait for room invite before attempting bot join

* remove sent receipt assertion

* lint

* remove debug formatting

* use RoomMemberEvent enum from window
---
 cypress/e2e/crypto/crypto.spec.ts | 22 ++++++++++++++++++----
 cypress/support/bot.ts            |  2 +-
 2 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/cypress/e2e/crypto/crypto.spec.ts b/cypress/e2e/crypto/crypto.spec.ts
index 99bde7ad1d..650f8d585c 100644
--- a/cypress/e2e/crypto/crypto.spec.ts
+++ b/cypress/e2e/crypto/crypto.spec.ts
@@ -14,9 +14,10 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import { MatrixClient, Room } from "matrix-js-sdk/src/matrix";
+
 import type { VerificationRequest } from "matrix-js-sdk/src/crypto/verification/request/VerificationRequest";
 import type { ISasEvent } from "matrix-js-sdk/src/crypto/verification/SAS";
-import type { MatrixClient, Room } from "matrix-js-sdk/src/matrix";
 import { SynapseInstance } from "../../plugins/synapsedocker";
 import Chainable = Cypress.Chainable;
 
@@ -60,7 +61,6 @@ const testMessages = function(this: CryptoTestContext) {
     // check the invite message
     cy.contains(".mx_EventTile_body", "Hey!").closest(".mx_EventTile").within(() => {
         cy.get(".mx_EventTile_e2eIcon_warning").should("not.exist");
-        cy.get(".mx_EventTile_receiptSent").should("exist");
     });
 
     // Bob sends a response
@@ -73,17 +73,31 @@ const testMessages = function(this: CryptoTestContext) {
 };
 
 const bobJoin = function(this: CryptoTestContext) {
-    cy.botJoinRoomByName(this.bob, "Alice").as("bobsRoom");
+    cy.window({ log: false }).then(async win => {
+        const bobRooms = this.bob.getRooms();
+        if (!bobRooms.length) {
+            await new Promise<void>(resolve => {
+                const onMembership = (_event) => {
+                    this.bob.off(win.matrixcs.RoomMemberEvent.Membership, onMembership);
+                    resolve();
+                };
+                this.bob.on(win.matrixcs.RoomMemberEvent.Membership, onMembership);
+            });
+        }
+    }).then(() => {
+        cy.botJoinRoomByName(this.bob, "Alice").as("bobsRoom");
+    });
+
     cy.contains(".mx_TextualEvent", "Bob joined the room").should("exist");
 };
 
 const handleVerificationRequest = (request: VerificationRequest): Chainable<EmojiMapping[]> => {
     return cy.wrap(new Promise<EmojiMapping[]>((resolve) => {
         const onShowSas = (event: ISasEvent) => {
-            resolve(event.sas.emoji);
             verifier.off("show_sas", onShowSas);
             event.confirm();
             verifier.done();
+            resolve(event.sas.emoji);
         };
 
         const verifier = request.beginKeyVerification("m.sas.v1");
diff --git a/cypress/support/bot.ts b/cypress/support/bot.ts
index f724d6b3d3..35da14ebd7 100644
--- a/cypress/support/bot.ts
+++ b/cypress/support/bot.ts
@@ -128,7 +128,7 @@ Cypress.Commands.add("botJoinRoomByName", (cli: MatrixClient, roomName: string):
         return cy.botJoinRoom(cli, room.roomId);
     }
 
-    return cy.wrap(Promise.reject());
+    return cy.wrap(Promise.reject(`Bot room join failed. Cannot find room '${roomName}'`));
 });
 
 Cypress.Commands.add("botSendMessage", (