Spaces.includeSubSpaceRoomsInRoomList settings

src/i18n/strings/en_EN.json

@@ -955,6 +955,7 @@
     "Show chat effects (animations when receiving e.g. confetti)": "Show chat effects (animations when receiving e.g. confetti)",
     "Show all rooms in Home": "Show all rooms in Home",
     "All rooms you're in will appear in Home.": "All rooms you're in will appear in Home.",
+    "Display all people and rooms from nested spaces in the room list for a space": "Display all people and rooms from nested spaces in the room list for a space",
     "Display Communities instead of Spaces": "Display Communities instead of Spaces",
     "Temporarily show communities instead of Spaces for this session. Support for this will be removed in the near future. This will reload Element.": "Temporarily show communities instead of Spaces for this session. Support for this will be removed in the near future. This will reload Element.",
     "Developer mode": "Developer mode",

src/settings/Settings.tsx

@@ -866,6 +866,11 @@ export const SETTINGS: {[setting: string]: ISetting} = {
         default: true,
         controller: new IncompatibleController("showCommunitiesInsteadOfSpaces", null),
     },
+    "Spaces.includeSubSpaceRoomsInRoomList": {
+        displayName: _td("Display all people and rooms from nested spaces in the room list for a space"),
+        supportedLevels: LEVELS_ROOM_SETTINGS,
+        default: true,
+    },
     "showCommunitiesInsteadOfSpaces": {
         displayName: _td("Display Communities instead of Spaces"),
         description: _td("Temporarily show communities instead of Spaces for this session. " +

src/stores/room-list/filters/SpaceFilterCondition.ts

@@ -34,31 +34,40 @@ export class SpaceFilterCondition extends EventEmitter implements IFilterConditi
     private roomIds = new Set<string>();
     private userIds = new Set<string>();
     private showPeopleInSpace = true;
+    private showSubSpaceRoomsInSpace = true;
     private space: SpaceKey = MetaSpace.Home;
 
     public get kind(): FilterKind {
         return FilterKind.Prefilter;
     }
 
     public isVisible(room: Room): boolean {
-        return SpaceStore.instance.isRoomInSpace(this.space, room.roomId);
+        return SpaceStore.instance.isRoomInSpace(this.space, room.roomId, this.showSubSpaceRoomsInSpace);
     }
 
     private onStoreUpdate = async (forceUpdate = false): Promise<void> => {
+        const beforeShowSubSpaceRoomsInSpace = this.showSubSpaceRoomsInSpace;
+        this.showSubSpaceRoomsInSpace = SettingsStore.getValue("Spaces.includeSubSpaceRoomsInRoomList", this.space);
+
         const beforeRoomIds = this.roomIds;
         // clone the set as it may be mutated by the space store internally
-        this.roomIds = new Set(SpaceStore.instance.getSpaceFilteredRoomIds(this.space));
+        this.roomIds = new Set(
+            SpaceStore.instance.getSpaceFilteredRoomIds(this.space, this.showSubSpaceRoomsInSpace, true),
+        );
 
         const beforeUserIds = this.userIds;
         // clone the set as it may be mutated by the space store internally
-        this.userIds = new Set(SpaceStore.instance.getSpaceFilteredUserIds(this.space));
+        this.userIds = new Set(
+            SpaceStore.instance.getSpaceFilteredUserIds(this.space, this.showSubSpaceRoomsInSpace, true),
+        );
 
         const beforeShowPeopleInSpace = this.showPeopleInSpace;
         this.showPeopleInSpace = isMetaSpace(this.space[0]) ||
             SettingsStore.getValue("Spaces.showPeopleInSpace", this.space);
 
         if (forceUpdate ||
             beforeShowPeopleInSpace !== this.showPeopleInSpace ||
+            beforeShowSubSpaceRoomsInSpace !== this.showSubSpaceRoomsInSpace ||
             setHasDiff(beforeRoomIds, this.roomIds) ||
             setHasDiff(beforeUserIds, this.userIds)
         ) {

src/stores/spaces/SpaceStore.ts

@@ -136,6 +136,7 @@ export class SpaceStoreClass extends AsyncStoreWithClient<IState> {
         SettingsStore.monitorSetting("Spaces.allRoomsInHome", null);
         SettingsStore.monitorSetting("Spaces.enabledMetaSpaces", null);
         SettingsStore.monitorSetting("Spaces.showPeopleInSpace", null);
+        SettingsStore.monitorSetting("Spaces.includeSubSpaceRoomsInRoomList", null);
     }
 
     public get invitedSpaces(): Room[] {

test/stores/room-list/filters/SpaceFilterCondition-test.ts

@@ -53,6 +53,7 @@ describe('SpaceFilterCondition', () => {
     beforeEach(() => {
         jest.resetAllMocks();
         SettingsStoreMock.getValue.mockClear().mockImplementation(makeMockGetValue());
+        SpaceStoreInstanceMock.getSpaceFilteredRoomIds.mockReturnValue(new Set([]));
         SpaceStoreInstanceMock.getSpaceFilteredUserIds.mockReturnValue(new Set([]));
         SpaceStoreInstanceMock.isRoomInSpace.mockReturnValue(true);
     });
@@ -66,11 +67,26 @@ describe('SpaceFilterCondition', () => {
 
     describe('isVisible', () => {
         const room1 = { roomId: room1Id } as unknown as Room;
-        it('calls isRoomInSpace correctly', () => {
+        it('calls isRoomInSpace correctly when showSubSpaceRoomsInSpace is truthy', () => {
+            SettingsStoreMock.getValue.mockImplementation(makeMockGetValue({
+                ["Spaces.includeSubSpaceRoomsInRoomList"]: { [space1]: true },
+            }));
+
+            const filter = initFilter(space1);
+
+            expect(filter.isVisible(room1)).toEqual(true);
+            expect(SpaceStoreInstanceMock.isRoomInSpace).toHaveBeenCalledWith(space1, room1Id, true);
+        });
+
+        it('calls isRoomInSpace correctly when showSubSpaceRoomsInSpace is truthy', () => {
+            SettingsStoreMock.getValue.mockImplementation(makeMockGetValue({
+                ["Spaces.includeSubSpaceRoomsInRoomList"]: { [space1]: false },
+            }));
+
             const filter = initFilter(space1);
 
             expect(filter.isVisible(room1)).toEqual(true);
-            expect(SpaceStoreInstanceMock.isRoomInSpace).toHaveBeenCalledWith(space1, room1Id);
+            expect(SpaceStoreInstanceMock.isRoomInSpace).toHaveBeenCalledWith(space1, room1Id, false);
         });
     });
 
@@ -83,6 +99,45 @@ describe('SpaceFilterCondition', () => {
             expect(emitSpy).toHaveBeenCalledWith(FILTER_CHANGED);
         });
 
+        it('compares sub space rooms and dms when Spaces.includeSubSpaceRoomsInRoomList enabled', async () => {
+            SettingsStoreMock.getValue.mockImplementation(makeMockGetValue({
+                ["Spaces.includeSubSpaceRoomsInRoomList"]: { [space1]: true },
+            }));
+            const filter = new SpaceFilterCondition();
+            filter.updateSpace(space1);
+            jest.runOnlyPendingTimers();
+            expect(SpaceStoreInstanceMock.getSpaceFilteredRoomIds).toHaveBeenCalledWith(space1, true, true);
+            expect(SpaceStoreInstanceMock.getSpaceFilteredUserIds).toHaveBeenCalledWith(space1, true, true);
+        });
+
+        it('compares only direct child rooms and dms when Spaces.includeSubSpaceRoomsInRoomList disabled', async () => {
+            SettingsStoreMock.getValue.mockImplementation(makeMockGetValue({
+                ["Spaces.includeSubSpaceRoomsInRoomList"]: { [space1]: false },
+            }));
+            const filter = new SpaceFilterCondition();
+            filter.updateSpace(space1);
+            jest.runOnlyPendingTimers();
+            expect(SpaceStoreInstanceMock.getSpaceFilteredRoomIds).toHaveBeenCalledWith(space1, false, true);
+            expect(SpaceStoreInstanceMock.getSpaceFilteredUserIds).toHaveBeenCalledWith(space1, false, true);
+        });
+
+        it('emits filter changed event when Spaces.includeSubSpaceRoomsInRoomList setting changes', async () => {
+            // init filter with setting true for space1
+            SettingsStoreMock.getValue.mockImplementation(makeMockGetValue({
+                ["Spaces.includeSubSpaceRoomsInRoomList"]: { [space1]: true },
+            }));
+            const filter = initFilter(space1);
+            const emitSpy = jest.spyOn(filter, 'emit');
+
+            SettingsStoreMock.getValue.mockImplementation(makeMockGetValue({
+                ["Spaces.includeSubSpaceRoomsInRoomList"]: { [space1]: false },
+            }));
+
+            SpaceStoreInstanceMock.emit(space1);
+            jest.runOnlyPendingTimers();
+            expect(emitSpy).toHaveBeenCalledWith(FILTER_CHANGED);
+        });
+
         describe('showPeopleInSpace setting', () => {
             it('emits filter changed event when setting changes', async () => {
                 // init filter with setting true for space1
@@ -151,7 +206,7 @@ describe('SpaceFilterCondition', () => {
             expect(emitSpy).not.toHaveBeenCalledWith(FILTER_CHANGED);
         });
 
-        describe('when directChildRoomIds change', () => {
+        describe('when spaceFilteredRoomIds change', () => {
             beforeEach(() => {
                 SpaceStoreInstanceMock.getSpaceFilteredRoomIds.mockReturnValue(new Set([room1Id, room2Id]));
             });