Implement third-party invite waiting room (#10229)

test/utils/room/shouldEncryptRoomWithSingle3rdPartyInvite-test.ts

@@ -0,0 +1,110 @@
+/*
+Copyright 2023 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 { mocked } from "jest-mock";
+import { MatrixClient, MatrixEvent, Room } from "matrix-js-sdk/src/matrix";
+
+import DMRoomMap from "../../../src/utils/DMRoomMap";
+import { shouldEncryptRoomWithSingle3rdPartyInvite } from "../../../src/utils/room/shouldEncryptRoomWithSingle3rdPartyInvite";
+import { privateShouldBeEncrypted } from "../../../src/utils/rooms";
+import { mkRoomMemberJoinEvent, mkThirdPartyInviteEvent, stubClient } from "../../test-utils";
+
+jest.mock("../../../src/utils/rooms", () => ({
+    privateShouldBeEncrypted: jest.fn(),
+}));
+
+describe("shouldEncryptRoomWithSingle3rdPartyInvite", () => {
+    let client: MatrixClient;
+    let thirdPartyInviteEvent: MatrixEvent;
+    let roomWithOneThirdPartyInvite: Room;
+
+    beforeAll(() => {
+        client = stubClient();
+        DMRoomMap.makeShared();
+    });
+
+    beforeEach(() => {
+        roomWithOneThirdPartyInvite = new Room("!room1:example.com", client, client.getSafeUserId());
+        thirdPartyInviteEvent = mkThirdPartyInviteEvent(
+            client.getSafeUserId(),
+            "user@example.com",
+            roomWithOneThirdPartyInvite.roomId,
+        );
+
+        roomWithOneThirdPartyInvite.currentState.setStateEvents([
+            mkRoomMemberJoinEvent(client.getSafeUserId(), roomWithOneThirdPartyInvite.roomId),
+            thirdPartyInviteEvent,
+        ]);
+        jest.spyOn(DMRoomMap.shared(), "getRoomIds").mockReturnValue(new Set([roomWithOneThirdPartyInvite.roomId]));
+    });
+
+    describe("when well-known promotes encryption", () => {
+        beforeEach(() => {
+            mocked(privateShouldBeEncrypted).mockReturnValue(true);
+        });
+
+        it("should return true + invite event for a DM room with one third-party invite", () => {
+            expect(shouldEncryptRoomWithSingle3rdPartyInvite(roomWithOneThirdPartyInvite)).toEqual({
+                shouldEncrypt: true,
+                inviteEvent: thirdPartyInviteEvent,
+            });
+        });
+
+        it("should return false for a non-DM room with one third-party invite", () => {
+            mocked(DMRoomMap.shared().getRoomIds).mockReturnValue(new Set());
+
+            expect(shouldEncryptRoomWithSingle3rdPartyInvite(roomWithOneThirdPartyInvite)).toEqual({
+                shouldEncrypt: false,
+            });
+        });
+
+        it("should return false for a DM room with two members", () => {
+            roomWithOneThirdPartyInvite.currentState.setStateEvents([
+                mkRoomMemberJoinEvent("@user2:example.com", roomWithOneThirdPartyInvite.roomId),
+            ]);
+
+            expect(shouldEncryptRoomWithSingle3rdPartyInvite(roomWithOneThirdPartyInvite)).toEqual({
+                shouldEncrypt: false,
+            });
+        });
+
+        it("should return false for a DM room with two third-party invites", () => {
+            roomWithOneThirdPartyInvite.currentState.setStateEvents([
+                mkThirdPartyInviteEvent(
+                    client.getSafeUserId(),
+                    "user2@example.com",
+                    roomWithOneThirdPartyInvite.roomId,
+                ),
+            ]);
+
+            expect(shouldEncryptRoomWithSingle3rdPartyInvite(roomWithOneThirdPartyInvite)).toEqual({
+                shouldEncrypt: false,
+            });
+        });
+    });
+
+    describe("when well-known does not promote encryption", () => {
+        beforeEach(() => {
+            mocked(privateShouldBeEncrypted).mockReturnValue(false);
+        });
+
+        it("should return false for a DM room with one third-party invite", () => {
+            expect(shouldEncryptRoomWithSingle3rdPartyInvite(roomWithOneThirdPartyInvite)).toEqual({
+                shouldEncrypt: false,
+            });
+        });
+    });
+});