Disable ICE fallback based on well-known configuration

Signed-off-by: Michael Telatynski <[email protected]>

Author: t3chguy

src/LegacyCallHandler.tsx

@@ -764,7 +764,6 @@ export default class LegacyCallHandler extends EventEmitter {
                 cancelButton: _t("action|ok"),
                 onFinished: (allow) => {
                     SettingsStore.setValue("fallbackICEServerAllowed", null, SettingLevel.DEVICE, allow);
-                    cli.setFallbackICEServerAllowed(!!allow);
                 },
             },
             undefined,

src/Lifecycle.ts

@@ -75,6 +75,7 @@ import {
 } from "./utils/tokens/tokens";
 import { TokenRefresher } from "./utils/oidc/TokenRefresher";
 import { checkBrowserSupport } from "./SupportedBrowser";
+import MatrixClientBackedController from "./settings/controllers/MatrixClientBackedController.ts";
 
 const HOMESERVER_URL_KEY = "mx_hs_url";
 const ID_SERVER_URL_KEY = "mx_is_url";
@@ -1037,6 +1038,7 @@ async function startMatrixClient(
 
     // Now that we have a MatrixClientPeg, update the Jitsi info
     Jitsi.getInstance().start();
+    MatrixClientBackedController.start();
 
     // dispatch that we finished starting up to wire up any other bits
     // of the matrix client that cannot be set prior to starting up.

src/components/views/settings/tabs/user/VoiceUserSettingsTab.tsx

@@ -112,10 +112,6 @@ export default class VoiceUserSettingsTab extends React.Component<{}, IState> {
         this.context.setForceTURN(!p2p);
     };
 
-    private changeFallbackICEServerAllowed = (allow: boolean): void => {
-        this.context.setFallbackICEServerAllowed(allow);
-    };
-
     private renderDeviceOptions(devices: Array<MediaDeviceInfo>, category: MediaDeviceKindEnum): Array<JSX.Element> {
         return devices.map((d) => {
             return (
@@ -226,7 +222,7 @@ export default class VoiceUserSettingsTab extends React.Component<{}, IState> {
                                 server: new URL(FALLBACK_ICE_SERVER).pathname,
                             })}
                             level={SettingLevel.DEVICE}
-                            onChange={this.changeFallbackICEServerAllowed}
+                            hideIfCannotSet
                         />
                     </SettingsSubsection>
                 </SettingsSection>

src/settings/Settings.tsx

@@ -37,6 +37,7 @@ import ServerSupportUnstableFeatureController from "./controllers/ServerSupportU
 import { WatchManager } from "./WatchManager";
 import { CustomTheme } from "../theme";
 import AnalyticsController from "./controllers/AnalyticsController";
+import FallbackIceServerController from "./controllers/FallbackIceServerController";
 
 export const defaultWatchManager = new WatchManager();
 
@@ -992,6 +993,7 @@ export const SETTINGS: { [setting: string]: ISetting } = {
         description: _td("settings|voip|enable_fallback_ice_server_description"),
         // This is a tri-state value, where `null` means "prompt the user".
         default: null,
+        controller: new FallbackIceServerController(),
     },
     "showImages": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,

src/settings/controllers/FallbackIceServerController.ts

@@ -0,0 +1,55 @@
+/*
+Copyright 2024 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { ClientEvent, IClientWellKnown, MatrixClient } from "matrix-js-sdk/src/matrix";
+
+import { SettingLevel } from "../SettingLevel";
+import SettingsStore from "../SettingsStore.ts";
+import MatrixClientBackedController from "./MatrixClientBackedController.ts";
+
+/**
+ * Settings controller for the fallback ICE server setting.
+ * This setting may be forcibly disabled by well-known value ["io.element.voip"]["disable_fallback_ice"].
+ * This controller will update the MatrixClient's knowledge when the setting is changed.
+ */
+export default class FallbackIceServerController extends MatrixClientBackedController {
+    private disabled = false;
+
+    public constructor() {
+        super();
+    }
+
+    private checkWellKnown(wellKnown: IClientWellKnown): void {
+        this.disabled = !!wellKnown["io.element.voip"]?.["disable_fallback_ice"];
+    }
+
+    protected async initMatrixClient(newClient: MatrixClient, oldClient?: MatrixClient): Promise<void> {
+        oldClient?.off(ClientEvent.ClientWellKnown, this.checkWellKnown);
+        newClient.on(ClientEvent.ClientWellKnown, this.checkWellKnown);
+    }
+
+    protected async startMatrixClient(): Promise<void> {
+        if (!this.client) return;
+        this.checkWellKnown(await this.client.waitForClientWellKnown());
+    }
+
+    public getValueOverride(): any {
+        if (this.disabled) {
+            return false;
+        }
+
+        return null; // no override
+    }
+
+    public get settingDisabled(): boolean | string {
+        return this.disabled;
+    }
+
+    public onChange(_level: SettingLevel, _roomId: string | null, _newValue: any): void {
+        this.client?.setFallbackICEServerAllowed(!SettingsStore.getValue("fallbackICEServerAllowed"));
+    }
+}

src/settings/controllers/MatrixClientBackedController.ts

@@ -30,6 +30,12 @@ export default abstract class MatrixClientBackedController extends SettingContro
         }
     }
 
+    public static start(): void {
+        for (const instance of MatrixClientBackedController.instances) {
+            instance.startMatrixClient();
+        }
+    }
+
     protected constructor() {
         super();
 
@@ -41,4 +47,5 @@ export default abstract class MatrixClientBackedController extends SettingContro
     }
 
     protected abstract initMatrixClient(newClient: MatrixClient, oldClient?: MatrixClient): void;
+    protected abstract startMatrixClient(): void;
 }

src/settings/controllers/ServerSupportUnstableFeatureController.ts

@@ -81,6 +81,8 @@ export default class ServerSupportUnstableFeatureController extends MatrixClient
         this.disabled = !isEnabled;
     }
 
+    protected async startMatrixClient(): Promise<void> {}
+
     public getValueOverride(
         level: SettingLevel,
         roomId: string | null,