Fix some features not being configurable via features (#10276)

test/MatrixClientPeg-test.ts

@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 import { logger } from "matrix-js-sdk/src/logger";
+import fetchMockJest from "fetch-mock-jest";
 
 import { advanceDateAndTime, stubClient } from "./test-utils";
 import { IMatrixClientPeg, MatrixClientPeg as peg } from "../src/MatrixClientPeg";
@@ -68,6 +69,7 @@ describe("MatrixClientPeg", () => {
             // instantiate a MatrixClientPegClass instance, with a new MatrixClient
             const PegClass = Object.getPrototypeOf(peg).constructor;
             testPeg = new PegClass();
+            fetchMockJest.get("http://example.com/_matrix/client/versions", {});
             testPeg.replaceUsingCreds({
                 accessToken: "SEKRET",
                 homeserverUrl: "http://example.com",

test/components/views/settings/tabs/user/LabsUserSettingsTab-test.tsx

@@ -16,6 +16,7 @@ limitations under the License.
 
 import React from "react";
 import { render } from "@testing-library/react";
+import { defer } from "matrix-js-sdk/src/utils";
 
 import LabsUserSettingsTab from "../../../../../../src/components/views/settings/tabs/user/LabsUserSettingsTab";
 import SettingsStore from "../../../../../../src/settings/SettingsStore";
@@ -25,6 +26,7 @@ import {
     mockClientMethodsUser,
 } from "../../../../../test-utils";
 import SdkConfig from "../../../../../../src/SdkConfig";
+import MatrixClientBackedController from "../../../../../../src/settings/controllers/MatrixClientBackedController";
 
 describe("<SecurityUserSettingsTab />", () => {
     const sdkConfigSpy = jest.spyOn(SdkConfig, "get");
@@ -35,7 +37,7 @@ describe("<SecurityUserSettingsTab />", () => {
     const getComponent = () => <LabsUserSettingsTab {...defaultProps} />;
 
     const userId = "@alice:server.org";
-    getMockClientWithEventEmitter({
+    const cli = getMockClientWithEventEmitter({
         ...mockClientMethodsUser(userId),
         ...mockClientMethodsServer(),
     });
@@ -70,4 +72,21 @@ describe("<SecurityUserSettingsTab />", () => {
         const labsSections = container.getElementsByClassName("mx_SettingsTab_section");
         expect(labsSections.length).toEqual(11);
     });
+
+    it("renders a labs flag which requires unstable support once support is confirmed", async () => {
+        // enable labs
+        sdkConfigSpy.mockImplementation((configName) => configName === "show_labs_settings");
+
+        const deferred = defer<boolean>();
+        cli.doesServerSupportUnstableFeature.mockImplementation(async (featureName) => {
+            return featureName === "org.matrix.msc3827.stable" ? deferred.promise : false;
+        });
+        MatrixClientBackedController.matrixClient = cli;
+
+        const { queryByText, findByText } = render(getComponent());
+
+        expect(queryByText("Explore public spaces in the new search dialog")).toBeFalsy();
+        deferred.resolve(true);
+        await expect(findByText("Explore public spaces in the new search dialog")).resolves.toBeDefined();
+    });
 });

test/settings/controllers/ServerSupportUnstableFeatureController-test.ts

@@ -0,0 +1,119 @@
+/*
+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 { defer } from "matrix-js-sdk/src/utils";
+import { MatrixClient } from "matrix-js-sdk/src/matrix";
+
+import ServerSupportUnstableFeatureController from "../../../src/settings/controllers/ServerSupportUnstableFeatureController";
+import { SettingLevel } from "../../../src/settings/SettingLevel";
+import { LabGroup, SETTINGS } from "../../../src/settings/Settings";
+import { stubClient } from "../../test-utils";
+import { WatchManager } from "../../../src/settings/WatchManager";
+import MatrixClientBackedController from "../../../src/settings/controllers/MatrixClientBackedController";
+
+describe("ServerSupportUnstableFeatureController", () => {
+    const watchers = new WatchManager();
+    const setting = "setting_name";
+
+    async function prepareSetting(
+        cli: MatrixClient,
+        controller: ServerSupportUnstableFeatureController,
+    ): Promise<void> {
+        SETTINGS[setting] = {
+            isFeature: true,
+            labsGroup: LabGroup.Messaging,
+            displayName: "name of some kind",
+            supportedLevels: [SettingLevel.DEVICE, SettingLevel.CONFIG],
+            default: false,
+            controller,
+        };
+
+        const deferred = defer<any>();
+        watchers.watchSetting(setting, null, deferred.resolve);
+        MatrixClientBackedController.matrixClient = cli;
+        await deferred.promise;
+    }
+
+    describe("getValueOverride()", () => {
+        it("should return forced value is setting is disabled", async () => {
+            const cli = stubClient();
+            cli.doesServerSupportUnstableFeature = jest.fn(async () => false);
+
+            const controller = new ServerSupportUnstableFeatureController(
+                setting,
+                watchers,
+                ["feature"],
+                "other_value",
+            );
+            await prepareSetting(cli, controller);
+
+            expect(controller.getValueOverride(SettingLevel.DEVICE, null, true, SettingLevel.ACCOUNT)).toEqual(
+                "other_value",
+            );
+        });
+
+        it("should pass through to the handler if setting is not disabled", async () => {
+            const cli = stubClient();
+            cli.doesServerSupportUnstableFeature = jest.fn(async () => true);
+
+            const controller = new ServerSupportUnstableFeatureController(
+                setting,
+                watchers,
+                ["feature"],
+                "other_value",
+            );
+            await prepareSetting(cli, controller);
+
+            expect(controller.getValueOverride(SettingLevel.DEVICE, null, true, SettingLevel.ACCOUNT)).toEqual(null);
+        });
+    });
+
+    describe("settingDisabled()", () => {
+        it("returns true if there is no matrix client", () => {
+            const controller = new ServerSupportUnstableFeatureController(setting, watchers, ["org.matrix.msc3030"]);
+            expect(controller.settingDisabled).toEqual(true);
+        });
+
+        it("returns true if not all required features are supported", async () => {
+            const cli = stubClient();
+            cli.doesServerSupportUnstableFeature = jest.fn(async (featureName) => {
+                return featureName === "org.matrix.msc3827.stable";
+            });
+
+            const controller = new ServerSupportUnstableFeatureController(setting, watchers, [
+                "org.matrix.msc3827.stable",
+                "org.matrix.msc3030",
+            ]);
+            await prepareSetting(cli, controller);
+
+            expect(controller.settingDisabled).toEqual(true);
+        });
+
+        it("returns false if all required features are supported", async () => {
+            const cli = stubClient();
+            cli.doesServerSupportUnstableFeature = jest.fn(async (featureName) => {
+                return featureName === "org.matrix.msc3827.stable" || featureName === "org.matrix.msc3030";
+            });
+            const controller = new ServerSupportUnstableFeatureController(setting, watchers, [
+                "org.matrix.msc3827.stable",
+                "org.matrix.msc3030",
+            ]);
+            await prepareSetting(cli, controller);
+
+            expect(controller.settingDisabled).toEqual(false);
+        });
+    });
+});

test/setup/setupManualMocks.ts

@@ -85,6 +85,7 @@ window.HTMLElement.prototype.scrollIntoView = jest.fn();
 fetchMock.config.overwriteRoutes = false;
 fetchMock.catch("");
 fetchMock.get("/image-file-stub", "image file stub");
+fetchMock.get("/_matrix/client/versions", {});
 // @ts-ignore
 window.fetch = fetchMock.sandbox();
 

test/test-utils/test-utils.ts

@@ -509,6 +509,7 @@ export function mkStubRoom(
     return {
         canInvite: jest.fn(),
         client,
+        findThreadForEvent: jest.fn(),
         createThreadsTimelineSets: jest.fn().mockReturnValue(new Promise(() => {})),
         currentState: {
             getStateEvents: jest.fn((_type, key) => (key === undefined ? [] : null)),