Fix some features not being configurable via features
(#10276)
This commit is contained in:
parent
6746ce2da3
commit
ad8d27d2b2
12 changed files with 329 additions and 61 deletions
|
@ -44,6 +44,10 @@ import SdkConfig from "../SdkConfig";
|
|||
import SlidingSyncController from "./controllers/SlidingSyncController";
|
||||
import { FontWatcher } from "./watchers/FontWatcher";
|
||||
import RustCryptoSdkController from "./controllers/RustCryptoSdkController";
|
||||
import ServerSupportUnstableFeatureController from "./controllers/ServerSupportUnstableFeatureController";
|
||||
import { WatchManager } from "./WatchManager";
|
||||
|
||||
export const defaultWatchManager = new WatchManager();
|
||||
|
||||
// These are just a bunch of helper arrays to avoid copy/pasting a bunch of times
|
||||
const LEVELS_ROOM_SETTINGS = [
|
||||
|
@ -218,9 +222,14 @@ export const SETTINGS: { [setting: string]: ISetting } = {
|
|||
},
|
||||
},
|
||||
"feature_exploring_public_spaces": {
|
||||
isFeature: true,
|
||||
labsGroup: LabGroup.Spaces,
|
||||
displayName: _td("Explore public spaces in the new search dialog"),
|
||||
supportedLevels: LEVELS_FEATURE,
|
||||
default: false,
|
||||
controller: new ServerSupportUnstableFeatureController("feature_exploring_public_spaces", defaultWatchManager, [
|
||||
"org.matrix.msc3827.stable",
|
||||
]),
|
||||
},
|
||||
"feature_msc3531_hide_messages_pending_moderation": {
|
||||
isFeature: true,
|
||||
|
@ -359,13 +368,14 @@ export const SETTINGS: { [setting: string]: ISetting } = {
|
|||
default: false,
|
||||
},
|
||||
"feature_jump_to_date": {
|
||||
// We purposely leave out `isFeature: true` so it doesn't show in Labs
|
||||
// by default. We will conditionally show it depending on whether we can
|
||||
// detect MSC3030 support (see LabUserSettingsTab.tsx).
|
||||
// labsGroup: LabGroup.Messaging,
|
||||
isFeature: true,
|
||||
labsGroup: LabGroup.Messaging,
|
||||
displayName: _td("Jump to date (adds /jumptodate and jump to date headers)"),
|
||||
supportedLevels: LEVELS_FEATURE,
|
||||
default: false,
|
||||
controller: new ServerSupportUnstableFeatureController("feature_jump_to_date", defaultWatchManager, [
|
||||
"org.matrix.msc3030",
|
||||
]),
|
||||
},
|
||||
"RoomList.backgroundImage": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
|
@ -387,6 +397,7 @@ export const SETTINGS: { [setting: string]: ISetting } = {
|
|||
controller: new SlidingSyncController(),
|
||||
},
|
||||
"feature_sliding_sync_proxy_url": {
|
||||
// This is not a distinct feature, it is a setting for feature_sliding_sync above
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
||||
default: "",
|
||||
},
|
||||
|
|
|
@ -27,9 +27,9 @@ import RoomSettingsHandler from "./handlers/RoomSettingsHandler";
|
|||
import ConfigSettingsHandler from "./handlers/ConfigSettingsHandler";
|
||||
import { _t } from "../languageHandler";
|
||||
import dis from "../dispatcher/dispatcher";
|
||||
import { IFeature, ISetting, LabGroup, SETTINGS } from "./Settings";
|
||||
import { IFeature, ISetting, LabGroup, SETTINGS, defaultWatchManager } from "./Settings";
|
||||
import LocalEchoWrapper from "./handlers/LocalEchoWrapper";
|
||||
import { CallbackFn as WatchCallbackFn, WatchManager } from "./WatchManager";
|
||||
import { CallbackFn as WatchCallbackFn } from "./WatchManager";
|
||||
import { SettingLevel } from "./SettingLevel";
|
||||
import SettingsHandler from "./handlers/SettingsHandler";
|
||||
import { SettingUpdatedPayload } from "../dispatcher/payloads/SettingUpdatedPayload";
|
||||
|
@ -39,8 +39,6 @@ import dispatcher from "../dispatcher/dispatcher";
|
|||
import { ActionPayload } from "../dispatcher/payloads";
|
||||
import { MatrixClientPeg } from "../MatrixClientPeg";
|
||||
|
||||
const defaultWatchManager = new WatchManager();
|
||||
|
||||
// Convert the settings to easier to manage objects for the handlers
|
||||
const defaultSettings: Record<string, any> = {};
|
||||
const invertedDefaultSettings: Record<string, boolean> = {};
|
||||
|
|
|
@ -39,7 +39,7 @@ export class WatchManager {
|
|||
public unwatchSetting(cb: CallbackFn): void {
|
||||
this.watchers.forEach((map) => {
|
||||
map.forEach((callbacks) => {
|
||||
let idx;
|
||||
let idx: number;
|
||||
while ((idx = callbacks.indexOf(cb)) !== -1) {
|
||||
callbacks.splice(idx, 1);
|
||||
}
|
||||
|
|
52
src/settings/controllers/MatrixClientBackedController.ts
Normal file
52
src/settings/controllers/MatrixClientBackedController.ts
Normal file
|
@ -0,0 +1,52 @@
|
|||
/*
|
||||
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 { MatrixClient } from "matrix-js-sdk/src/client";
|
||||
|
||||
import SettingController from "./SettingController";
|
||||
|
||||
// Dev note: This whole class exists in the event someone logs out and back in - we want
|
||||
// to make sure the right MatrixClient is listening for changes.
|
||||
|
||||
/**
|
||||
* Represents the base class for settings controllers which need access to a MatrixClient.
|
||||
* This class performs no logic and should be overridden.
|
||||
*/
|
||||
export default abstract class MatrixClientBackedController extends SettingController {
|
||||
private static _matrixClient: MatrixClient;
|
||||
private static instances: MatrixClientBackedController[] = [];
|
||||
|
||||
public static set matrixClient(client: MatrixClient) {
|
||||
const oldClient = MatrixClientBackedController._matrixClient;
|
||||
MatrixClientBackedController._matrixClient = client;
|
||||
|
||||
for (const instance of MatrixClientBackedController.instances) {
|
||||
instance.initMatrixClient(oldClient, client);
|
||||
}
|
||||
}
|
||||
|
||||
protected constructor() {
|
||||
super();
|
||||
|
||||
MatrixClientBackedController.instances.push(this);
|
||||
}
|
||||
|
||||
public get client(): MatrixClient {
|
||||
return MatrixClientBackedController._matrixClient;
|
||||
}
|
||||
|
||||
protected abstract initMatrixClient(oldClient: MatrixClient, newClient: MatrixClient): void;
|
||||
}
|
|
@ -0,0 +1,77 @@
|
|||
/*
|
||||
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 { MatrixClient } from "matrix-js-sdk/src/matrix";
|
||||
|
||||
import { SettingLevel } from "../SettingLevel";
|
||||
import MatrixClientBackedController from "./MatrixClientBackedController";
|
||||
import { WatchManager } from "../WatchManager";
|
||||
import SettingsStore from "../SettingsStore";
|
||||
|
||||
/**
|
||||
* Disables a given setting if the server unstable feature it requires is not supported
|
||||
* When a setting gets disabled or enabled from this controller it notifies the given WatchManager
|
||||
*/
|
||||
export default class ServerSupportUnstableFeatureController extends MatrixClientBackedController {
|
||||
private enabled: boolean | undefined;
|
||||
|
||||
public constructor(
|
||||
private readonly settingName: string,
|
||||
private readonly watchers: WatchManager,
|
||||
private readonly unstableFeatures: string[],
|
||||
private readonly forcedValue: any = false,
|
||||
) {
|
||||
super();
|
||||
}
|
||||
|
||||
public get disabled(): boolean {
|
||||
return !this.enabled;
|
||||
}
|
||||
|
||||
public set disabled(v: boolean) {
|
||||
if (!v === this.enabled) return;
|
||||
this.enabled = !v;
|
||||
const level = SettingsStore.firstSupportedLevel(this.settingName);
|
||||
const settingValue = SettingsStore.getValue(this.settingName, null);
|
||||
this.watchers.notifyUpdate(this.settingName, null, level, settingValue);
|
||||
}
|
||||
|
||||
protected async initMatrixClient(oldClient: MatrixClient, newClient: MatrixClient): Promise<void> {
|
||||
this.disabled = true;
|
||||
let supported = true;
|
||||
for (const feature of this.unstableFeatures) {
|
||||
supported = await this.client.doesServerSupportUnstableFeature(feature);
|
||||
if (!supported) break;
|
||||
}
|
||||
this.disabled = !supported;
|
||||
}
|
||||
|
||||
public getValueOverride(
|
||||
level: SettingLevel,
|
||||
roomId: string,
|
||||
calculatedValue: any,
|
||||
calculatedAtLevel: SettingLevel | null,
|
||||
): any {
|
||||
if (this.settingDisabled) {
|
||||
return this.forcedValue;
|
||||
}
|
||||
return null; // no override
|
||||
}
|
||||
|
||||
public get settingDisabled(): boolean {
|
||||
return this.disabled;
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue