Allow setting room join rule to knock (#11248)

Signed-off-by: Charly Nguyen <charly.nguyen@nordeck.net>
This commit is contained in:
Charly Nguyen 2023-07-19 12:48:24 +02:00 committed by GitHub
parent b03433ef8b
commit 9a31cd0fa8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 188 additions and 127 deletions

View file

@ -38,6 +38,7 @@ import { filterBoolean } from "../../../../src/utils/arrays";
import JoinRuleSettings, { JoinRuleSettingsProps } from "../../../../src/components/views/settings/JoinRuleSettings";
import { PreferredRoomVersions } from "../../../../src/utils/PreferredRoomVersions";
import SpaceStore from "../../../../src/stores/spaces/SpaceStore";
import SettingsStore from "../../../../src/settings/SettingsStore";
describe("<JoinRuleSettings />", () => {
const userId = "@alice:server.org";
@ -64,7 +65,7 @@ describe("<JoinRuleSettings />", () => {
const setRoomStateEvents = (
room: Room,
version = "9",
roomVersion: string,
joinRule?: JoinRule,
guestAccess?: GuestAccess,
history?: HistoryVisibility,
@ -72,7 +73,7 @@ describe("<JoinRuleSettings />", () => {
const events = filterBoolean<MatrixEvent>([
new MatrixEvent({
type: EventType.RoomCreate,
content: { version },
content: { room_version: roomVersion },
sender: userId,
state_key: "",
room_id: room.roomId,
@ -111,51 +112,72 @@ describe("<JoinRuleSettings />", () => {
client.isRoomEncrypted.mockReturnValue(false);
client.upgradeRoom.mockResolvedValue({ replacement_room: newRoomId });
client.getRoom.mockReturnValue(null);
jest.spyOn(SettingsStore, "getValue").mockImplementation((setting) => setting === "feature_ask_to_join");
});
describe("Restricted rooms", () => {
type TestCase = [string, { label: string; unsupportedRoomVersion: string; preferredRoomVersion: string }];
const testCases: TestCase[] = [
[
JoinRule.Knock,
{
label: "Ask to join",
unsupportedRoomVersion: "6",
preferredRoomVersion: PreferredRoomVersions.KnockRooms,
},
],
[
JoinRule.Restricted,
{
label: "Space members",
unsupportedRoomVersion: "8",
preferredRoomVersion: PreferredRoomVersions.RestrictedRooms,
},
],
];
describe.each(testCases)("%s rooms", (joinRule, { label, unsupportedRoomVersion, preferredRoomVersion }) => {
afterEach(async () => {
await clearAllModals();
});
describe("When room does not support restricted rooms", () => {
it("should not show restricted room join rule when upgrade not enabled", () => {
// room that doesnt support restricted rooms
const v8Room = new Room(roomId, client, userId);
setRoomStateEvents(v8Room, "8");
getComponent({ room: v8Room, promptUpgrade: false });
describe(`when room does not support join rule ${joinRule}`, () => {
it(`should not show ${joinRule} room join rule when upgrade is disabled`, () => {
// room that doesn't support the join rule
const room = new Room(roomId, client, userId);
setRoomStateEvents(room, unsupportedRoomVersion);
expect(screen.queryByText("Space members")).not.toBeInTheDocument();
getComponent({ room: room, promptUpgrade: false });
expect(screen.queryByText(label)).not.toBeInTheDocument();
});
it("should show restricted room join rule when upgrade is enabled", () => {
// room that doesnt support restricted rooms
const v8Room = new Room(roomId, client, userId);
setRoomStateEvents(v8Room, "8");
it(`should show ${joinRule} room join rule when upgrade is enabled`, () => {
// room that doesn't support the join rule
const room = new Room(roomId, client, userId);
setRoomStateEvents(room, unsupportedRoomVersion);
getComponent({ room: v8Room, promptUpgrade: true });
getComponent({ room: room, promptUpgrade: true });
expect(screen.getByText("Space members")).toBeInTheDocument();
expect(screen.getByText("Upgrade required")).toBeInTheDocument();
expect(within(screen.getByText(label)).getByText("Upgrade required")).toBeInTheDocument();
});
it("upgrades room when changing join rule to restricted", async () => {
it(`upgrades room when changing join rule to ${joinRule}`, async () => {
const deferredInvites: IDeferred<any>[] = [];
// room that doesnt support restricted rooms
const v8Room = new Room(roomId, client, userId);
// room that doesn't support the join rule
const room = new Room(roomId, client, userId);
const parentSpace = new Room("!parentSpace:server.org", client, userId);
jest.spyOn(SpaceStore.instance, "getKnownParents").mockReturnValue(new Set([parentSpace.roomId]));
setRoomStateEvents(v8Room, "8");
setRoomStateEvents(room, unsupportedRoomVersion);
const memberAlice = new RoomMember(roomId, "@alice:server.org");
const memberBob = new RoomMember(roomId, "@bob:server.org");
const memberCharlie = new RoomMember(roomId, "@charlie:server.org");
jest.spyOn(v8Room, "getMembersWithMembership").mockImplementation((membership) =>
jest.spyOn(room, "getMembersWithMembership").mockImplementation((membership) =>
membership === "join" ? [memberAlice, memberBob] : [memberCharlie],
);
const upgradedRoom = new Room(newRoomId, client, userId);
setRoomStateEvents(upgradedRoom);
setRoomStateEvents(upgradedRoom, preferredRoomVersion);
client.getRoom.mockImplementation((id) => {
if (roomId === id) return v8Room;
if (roomId === id) return room;
if (parentSpace.roomId === id) return parentSpace;
return null;
});
@ -168,15 +190,15 @@ describe("<JoinRuleSettings />", () => {
return p.promise;
});
getComponent({ room: v8Room, promptUpgrade: true });
getComponent({ room: room, promptUpgrade: true });
fireEvent.click(screen.getByText("Space members"));
fireEvent.click(screen.getByText(label));
const dialog = await screen.findByRole("dialog");
fireEvent.click(within(dialog).getByText("Upgrade"));
expect(client.upgradeRoom).toHaveBeenCalledWith(roomId, PreferredRoomVersions.RestrictedRooms);
expect(client.upgradeRoom).toHaveBeenCalledWith(roomId, preferredRoomVersion);
expect(within(dialog).getByText("Upgrading room")).toBeInTheDocument();
@ -186,7 +208,7 @@ describe("<JoinRuleSettings />", () => {
// "create" our new room, have it come thru sync
client.getRoom.mockImplementation((id) => {
if (roomId === id) return v8Room;
if (roomId === id) return room;
if (newRoomId === id) return upgradedRoom;
if (parentSpace.roomId === id) return parentSpace;
return null;
@ -208,22 +230,22 @@ describe("<JoinRuleSettings />", () => {
expect(screen.queryByRole("dialog")).not.toBeInTheDocument();
});
it("upgrades room with no parent spaces or members when changing join rule to restricted", async () => {
// room that doesnt support restricted rooms
const v8Room = new Room(roomId, client, userId);
setRoomStateEvents(v8Room, "8");
it(`upgrades room with no parent spaces or members when changing join rule to ${joinRule}`, async () => {
// room that doesn't support the join rule
const room = new Room(roomId, client, userId);
setRoomStateEvents(room, unsupportedRoomVersion);
const upgradedRoom = new Room(newRoomId, client, userId);
setRoomStateEvents(upgradedRoom);
setRoomStateEvents(upgradedRoom, preferredRoomVersion);
getComponent({ room: v8Room, promptUpgrade: true });
getComponent({ room: room, promptUpgrade: true });
fireEvent.click(screen.getByText("Space members"));
fireEvent.click(screen.getByText(label));
const dialog = await screen.findByRole("dialog");
fireEvent.click(within(dialog).getByText("Upgrade"));
expect(client.upgradeRoom).toHaveBeenCalledWith(roomId, PreferredRoomVersions.RestrictedRooms);
expect(client.upgradeRoom).toHaveBeenCalledWith(roomId, preferredRoomVersion);
expect(within(dialog).getByText("Upgrading room")).toBeInTheDocument();
@ -233,7 +255,7 @@ describe("<JoinRuleSettings />", () => {
// "create" our new room, have it come thru sync
client.getRoom.mockImplementation((id) => {
if (roomId === id) return v8Room;
if (roomId === id) return room;
if (newRoomId === id) return upgradedRoom;
return null;
});
@ -247,4 +269,11 @@ describe("<JoinRuleSettings />", () => {
});
});
});
it("should not show knock room join rule", async () => {
jest.spyOn(SettingsStore, "getValue").mockReturnValue(false);
const room = new Room(newRoomId, client, userId);
getComponent({ room: room });
expect(screen.queryByText("Ask to join")).not.toBeInTheDocument();
});
});