Merge pull request #5216 from matrix-org/t3chguy/fix/15182

UI Feature Flag: Communities
This commit is contained in:
Michael Telatynski 2020-09-18 19:46:51 +01:00 committed by GitHub
commit 2a46f59a0b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 37 additions and 9 deletions

View file

@ -23,7 +23,6 @@ import Field from "../../../elements/Field";
import * as sdk from "../../../../..";
import PlatformPeg from "../../../../../PlatformPeg";
import {SettingLevel} from "../../../../../settings/SettingLevel";
import {UIFeature} from "../../../../../settings/UIFeature";
export default class PreferencesUserSettingsTab extends React.Component {
static ROOM_LIST_SETTINGS = [
@ -138,12 +137,10 @@ export default class PreferencesUserSettingsTab extends React.Component {
};
_renderGroup(settingIds) {
if (!SettingsStore.getValue(UIFeature.URLPreviews)) {
settingIds = settingIds.filter(i => i !== 'urlPreviewsEnabled');
}
const SettingsFlag = sdk.getComponent("views.elements.SettingsFlag");
return settingIds.map(i => <SettingsFlag key={i} name={i} level={SettingLevel.ACCOUNT} />);
return settingIds.filter(SettingsStore.isEnabled).map(i => {
return <SettingsFlag key={i} name={i} level={SettingLevel.ACCOUNT} />;
});
}
render() {

View file

@ -332,6 +332,8 @@ export const SETTINGS: {[setting: string]: ISetting} = {
displayName: _td('Enable Community Filter Panel'),
default: true,
invertedSettingName: 'TagPanel.disableTagPanel',
// We force the value to true because the invertedSettingName causes it to flip
controller: new UIFeatureController(UIFeature.Communities, true),
},
"theme": {
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
@ -659,6 +661,12 @@ export const SETTINGS: {[setting: string]: ISetting} = {
[UIFeature.Flair]: {
supportedLevels: LEVELS_UI_FEATURE,
default: true,
// Disable Flair when Communities are disabled
controller: new UIFeatureController(UIFeature.Communities),
},
[UIFeature.Communities]: {
supportedLevels: LEVELS_UI_FEATURE,
default: true,
},
[UIFeature.AdvancedSettings]: {
supportedLevels: LEVELS_UI_FEATURE,

View file

@ -257,6 +257,17 @@ export default class SettingsStore {
return SETTINGS[settingName].isFeature;
}
/**
* Determines if a setting is enabled.
* If a setting is disabled then it should be hidden from the user.
* @param {string} settingName The setting to look up.
* @return {boolean} True if the setting is enabled.
*/
public static isEnabled(settingName: string): boolean {
if (!SETTINGS[settingName]) return false;
return SETTINGS[settingName].controller ? !SETTINGS[settingName].controller.settingDisabled : true;
}
/**
* Gets the value of a setting. The room ID is optional if the setting is not to
* be applied to any particular room, otherwise it should be supplied.

View file

@ -28,5 +28,6 @@ export enum UIFeature {
IdentityServer = "UIFeature.identityServer",
ThirdPartyID = "UIFeature.thirdPartyId",
Flair = "UIFeature.flair",
Communities = "UIFeature.communities",
AdvancedSettings = "UIFeature.advancedSettings",
}

View file

@ -55,4 +55,11 @@ export default abstract class SettingController {
public onChange(level: SettingLevel, roomId: string, newValue: any) {
// do nothing by default
}
/**
* Gets whether the setting has been disabled due to this controller.
*/
public get settingDisabled() {
return false;
}
}

View file

@ -26,7 +26,7 @@ import SettingsStore from "../SettingsStore";
* Settings using this controller are assumed to return `false` when disabled.
*/
export default class UIFeatureController extends SettingController {
public constructor(private uiFeatureName: string) {
public constructor(private uiFeatureName: string, private forcedValue = false) {
super();
}
@ -36,10 +36,14 @@ export default class UIFeatureController extends SettingController {
calculatedValue: any,
calculatedAtLevel: SettingLevel,
): any {
if (!SettingsStore.getValue(this.uiFeatureName)) {
if (this.settingDisabled) {
// per the docs: we force a disabled state when the feature isn't active
return false;
return this.forcedValue;
}
return null; // no override
}
public get settingDisabled(): boolean {
return !SettingsStore.getValue(this.uiFeatureName);
}
}