RoomListViewModel: Provide a way to resort the room list and track the active sort method (#29499)

* Add a hook that deals with the sorting behaviour

Hook will provide a function to sort the list and also provides a state
which tracks the currently active sort option.

* Use hook in vm

* Write test for the vm

* Fix broken view tests

test/unit-tests/components/viewmodels/roomlist/RoomListViewModel-test.tsx

@@ -16,6 +16,9 @@ import dispatcher from "../../../../../src/dispatcher/dispatcher";
 import { Action } from "../../../../../src/dispatcher/actions";
 import { FilterKey } from "../../../../../src/stores/room-list-v3/skip-list/filters";
 import { SecondaryFilters } from "../../../../../src/components/viewmodels/roomlist/useFilteredRooms";
+import { SortingAlgorithm } from "../../../../../src/stores/room-list-v3/skip-list/sorters";
+import { SortOption } from "../../../../../src/components/viewmodels/roomlist/useSorter";
+import SettingsStore from "../../../../../src/settings/SettingsStore";
 
 describe("RoomListViewModel", () => {
     function mockAndCreateRooms() {
@@ -26,6 +29,10 @@ describe("RoomListViewModel", () => {
         return { rooms, fn };
     }
 
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+
     it("should return a list of rooms", async () => {
         const { rooms } = mockAndCreateRooms();
         const { result: vm } = renderHook(() => useRoomListViewModel());
@@ -203,5 +210,29 @@ describe("RoomListViewModel", () => {
                 expect(vm.current.primaryFilters.find((f) => f.name === primaryFilterName)).toBeUndefined();
             });
         });
+
+        it("should change sort order", () => {
+            mockAndCreateRooms();
+            const { result: vm } = renderHook(() => useRoomListViewModel());
+
+            const resort = jest.spyOn(RoomListStoreV3.instance, "resort").mockImplementation(() => {});
+
+            // Change the sort option
+            act(() => {
+                vm.current.sort(SortOption.AToZ);
+            });
+
+            // Resort method in RLS must have been called
+            expect(resort).toHaveBeenCalledWith(SortingAlgorithm.Alphabetic);
+        });
+
+        it("should set activeSortOption based on value from settings", () => {
+            // Let's say that the user's preferred sorting is alphabetic
+            jest.spyOn(SettingsStore, "getValue").mockImplementation(() => SortingAlgorithm.Alphabetic);
+
+            mockAndCreateRooms();
+            const { result: vm } = renderHook(() => useRoomListViewModel());
+            expect(vm.current.activeSortOption).toEqual(SortOption.AToZ);
+        });
     });
 });

test/unit-tests/components/views/rooms/RoomListPanel/RoomList-test.tsx

@@ -15,6 +15,7 @@ import { type RoomListViewState } from "../../../../../../src/components/viewmod
 import { RoomList } from "../../../../../../src/components/views/rooms/RoomListPanel/RoomList";
 import DMRoomMap from "../../../../../../src/utils/DMRoomMap";
 import { SecondaryFilters } from "../../../../../../src/components/viewmodels/roomlist/useFilteredRooms";
+import { SortOption } from "../../../../../../src/components/viewmodels/roomlist/useSorter";
 
 describe("<RoomList />", () => {
     let matrixClient: MatrixClient;
@@ -34,6 +35,8 @@ describe("<RoomList />", () => {
             primaryFilters: [],
             activateSecondaryFilter: () => {},
             activeSecondaryFilter: SecondaryFilters.AllActivity,
+            sort: jest.fn(),
+            activeSortOption: SortOption.Activity,
         };
 
         // Needed to render a room list cell

test/unit-tests/components/views/rooms/RoomListPanel/RoomListPrimaryFilters-test.tsx

@@ -12,6 +12,7 @@ import userEvent from "@testing-library/user-event";
 import { type RoomListViewState } from "../../../../../../src/components/viewmodels/roomlist/RoomListViewModel";
 import { SecondaryFilters } from "../../../../../../src/components/viewmodels/roomlist/useFilteredRooms";
 import { RoomListPrimaryFilters } from "../../../../../../src/components/views/rooms/RoomListPanel/RoomListPrimaryFilters";
+import { SortOption } from "../../../../../../src/components/viewmodels/roomlist/useSorter";
 
 describe("<RoomListPrimaryFilters />", () => {
     let vm: RoomListViewState;
@@ -26,6 +27,8 @@ describe("<RoomListPrimaryFilters />", () => {
             ],
             activateSecondaryFilter: () => {},
             activeSecondaryFilter: SecondaryFilters.AllActivity,
+            sort: jest.fn(),
+            activeSortOption: SortOption.Activity,
         };
     });