Support dynamic room predecessors in leave-behaviour (#10340)

src/utils/leave-behaviour.ts

@@ -35,6 +35,7 @@ import LeaveSpaceDialog from "../components/views/dialogs/LeaveSpaceDialog";
 import { AfterLeaveRoomPayload } from "../dispatcher/payloads/AfterLeaveRoomPayload";
 import { bulkSpaceBehaviour } from "./space";
 import { SdkContextClass } from "../contexts/SDKContext";
+import SettingsStore from "../settings/SettingsStore";
 
 export async function leaveRoomBehaviour(roomId: string, retry = true, spinner = true): Promise<void> {
     let spinnerModal: IHandle<any> | undefined;
@@ -44,7 +45,11 @@ export async function leaveRoomBehaviour(roomId: string, retry = true, spinner =
 
     const cli = MatrixClientPeg.get();
     let leavingAllVersions = true;
-    const history = cli.getRoomUpgradeHistory(roomId);
+    const history = cli.getRoomUpgradeHistory(
+        roomId,
+        false,
+        SettingsStore.getValue("feature_dynamic_room_predecessors"),
+    );
     if (history && history.length > 0) {
         const currentRoom = history[history.length - 1];
         if (currentRoom.roomId !== roomId) {

test/utils/leave-behaviour-test.ts

@@ -29,6 +29,7 @@ import DMRoomMap from "../../src/utils/DMRoomMap";
 import SpaceStore from "../../src/stores/spaces/SpaceStore";
 import { MetaSpace } from "../../src/stores/spaces";
 import { ActionPayload } from "../../src/dispatcher/payloads";
+import SettingsStore from "../../src/settings/SettingsStore";
 
 describe("leaveRoomBehaviour", () => {
     SdkContextClass.instance.constructEagerStores(); // Initialize RoomViewStore
@@ -128,4 +129,29 @@ describe("leaveRoomBehaviour", () => {
             metricsTrigger: undefined,
         });
     });
+
+    describe("If the feature_dynamic_room_predecessors is not enabled", () => {
+        beforeEach(() => {
+            jest.spyOn(SettingsStore, "getValue").mockReturnValue(false);
+        });
+
+        it("Passes through the dynamic predecessor setting", async () => {
+            await leaveRoomBehaviour(room.roomId);
+            expect(client.getRoomUpgradeHistory).toHaveBeenCalledWith(room.roomId, false, false);
+        });
+    });
+
+    describe("If the feature_dynamic_room_predecessors is enabled", () => {
+        beforeEach(() => {
+            // Turn on feature_dynamic_room_predecessors setting
+            jest.spyOn(SettingsStore, "getValue").mockImplementation(
+                (settingName) => settingName === "feature_dynamic_room_predecessors",
+            );
+        });
+
+        it("Passes through the dynamic predecessor setting", async () => {
+            await leaveRoomBehaviour(room.roomId);
+            expect(client.getRoomUpgradeHistory).toHaveBeenCalledWith(room.roomId, false, true);
+        });
+    });
 });