matrix-react-sdk
Version:
SDK for matrix.org using React
94 lines (89 loc) • 12.9 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _MatrixClientBackedController = _interopRequireDefault(require("./MatrixClientBackedController"));
var _SettingsStore = _interopRequireDefault(require("../SettingsStore"));
/*
Copyright 2024 New Vector Ltd.
Copyright 2023 The Matrix.org Foundation C.I.C.
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
Please see LICENSE files in the repository root for full details.
*/
/**
* 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
*/
class ServerSupportUnstableFeatureController extends _MatrixClientBackedController.default {
/**
* Construct a new ServerSupportUnstableFeatureController.
*
* @param unstableFeatureGroups - If any one of the feature groups is satisfied,
* then the setting is considered enabled. A feature group is satisfied if all of
* the features in the group are supported (all features in a group are required).
*/
constructor(settingName, watchers, unstableFeatureGroups, stableVersion, disabledMessage, forcedValue = false) {
super();
// Starts off as `undefined` so when we first compare the `newDisabledValue`, it sees
// it as a change and updates the watchers.
(0, _defineProperty2.default)(this, "enabled", void 0);
this.settingName = settingName;
this.watchers = watchers;
this.unstableFeatureGroups = unstableFeatureGroups;
this.stableVersion = stableVersion;
this.disabledMessage = disabledMessage;
this.forcedValue = forcedValue;
}
get disabled() {
return !this.enabled;
}
set disabled(newDisabledValue) {
if (!newDisabledValue === this.enabled) return;
this.enabled = !newDisabledValue;
const level = _SettingsStore.default.firstSupportedLevel(this.settingName);
if (!level) return;
const settingValue = _SettingsStore.default.getValue(this.settingName, null);
this.watchers.notifyUpdate(this.settingName, null, level, settingValue);
}
async initMatrixClient() {
// Check for stable version support first
if (this.stableVersion && (await this.client.isVersionSupported(this.stableVersion))) {
this.disabled = false;
return;
}
// Otherwise, only one of the unstable feature groups needs to be satisfied in
// order for this setting overall to be enabled
let isEnabled = false;
for (const featureGroup of this.unstableFeatureGroups) {
const featureSupportList = await Promise.all(featureGroup.map(async feature => {
const isFeatureSupported = await this.client.doesServerSupportUnstableFeature(feature);
return isFeatureSupported;
}));
// Every feature in a feature group is required in order
// for this setting overall to be enabled.
const isFeatureGroupSatisfied = featureSupportList.every(isFeatureSupported => isFeatureSupported);
if (isFeatureGroupSatisfied) {
isEnabled = true;
break;
}
}
this.disabled = !isEnabled;
}
getValueOverride(level, roomId, calculatedValue, calculatedAtLevel) {
if (this.settingDisabled) {
return this.forcedValue;
}
return null; // no override
}
get settingDisabled() {
if (this.disabled) {
return this.disabledMessage ?? true;
}
return false;
}
}
exports.default = ServerSupportUnstableFeatureController;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["_MatrixClientBackedController","_interopRequireDefault","require","_SettingsStore","ServerSupportUnstableFeatureController","MatrixClientBackedController","constructor","settingName","watchers","unstableFeatureGroups","stableVersion","disabledMessage","forcedValue","_defineProperty2","default","disabled","enabled","newDisabledValue","level","SettingsStore","firstSupportedLevel","settingValue","getValue","notifyUpdate","initMatrixClient","client","isVersionSupported","isEnabled","featureGroup","featureSupportList","Promise","all","map","feature","isFeatureSupported","doesServerSupportUnstableFeature","isFeatureGroupSatisfied","every","getValueOverride","roomId","calculatedValue","calculatedAtLevel","settingDisabled","exports"],"sources":["../../../src/settings/controllers/ServerSupportUnstableFeatureController.ts"],"sourcesContent":["/*\nCopyright 2024 New Vector Ltd.\nCopyright 2023 The Matrix.org Foundation C.I.C.\n\nSPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only\nPlease see LICENSE files in the repository root for full details.\n*/\n\nimport { SettingLevel } from \"../SettingLevel\";\nimport MatrixClientBackedController from \"./MatrixClientBackedController\";\nimport { WatchManager } from \"../WatchManager\";\nimport SettingsStore from \"../SettingsStore\";\n\n/**\n * Disables a given setting if the server unstable feature it requires is not supported\n * When a setting gets disabled or enabled from this controller it notifies the given WatchManager\n */\nexport default class ServerSupportUnstableFeatureController extends MatrixClientBackedController {\n    // Starts off as `undefined` so when we first compare the `newDisabledValue`, it sees\n    // it as a change and updates the watchers.\n    private enabled: boolean | undefined;\n\n    /**\n     * Construct a new ServerSupportUnstableFeatureController.\n     *\n     * @param unstableFeatureGroups - If any one of the feature groups is satisfied,\n     * then the setting is considered enabled. A feature group is satisfied if all of\n     * the features in the group are supported (all features in a group are required).\n     */\n    public constructor(\n        private readonly settingName: string,\n        private readonly watchers: WatchManager,\n        private readonly unstableFeatureGroups: string[][],\n        private readonly stableVersion?: string,\n        private readonly disabledMessage?: string,\n        private readonly forcedValue: any = false,\n    ) {\n        super();\n    }\n\n    public get disabled(): boolean {\n        return !this.enabled;\n    }\n\n    public set disabled(newDisabledValue: boolean) {\n        if (!newDisabledValue === this.enabled) return;\n        this.enabled = !newDisabledValue;\n        const level = SettingsStore.firstSupportedLevel(this.settingName);\n        if (!level) return;\n        const settingValue = SettingsStore.getValue(this.settingName, null);\n        this.watchers.notifyUpdate(this.settingName, null, level, settingValue);\n    }\n\n    protected async initMatrixClient(): Promise<void> {\n        // Check for stable version support first\n        if (this.stableVersion && (await this.client!.isVersionSupported(this.stableVersion))) {\n            this.disabled = false;\n            return;\n        }\n\n        // Otherwise, only one of the unstable feature groups needs to be satisfied in\n        // order for this setting overall to be enabled\n        let isEnabled = false;\n        for (const featureGroup of this.unstableFeatureGroups) {\n            const featureSupportList = await Promise.all(\n                featureGroup.map(async (feature) => {\n                    const isFeatureSupported = await this.client!.doesServerSupportUnstableFeature(feature);\n                    return isFeatureSupported;\n                }),\n            );\n\n            // Every feature in a feature group is required in order\n            // for this setting overall to be enabled.\n            const isFeatureGroupSatisfied = featureSupportList.every((isFeatureSupported) => isFeatureSupported);\n            if (isFeatureGroupSatisfied) {\n                isEnabled = true;\n                break;\n            }\n        }\n\n        this.disabled = !isEnabled;\n    }\n\n    public getValueOverride(\n        level: SettingLevel,\n        roomId: string | null,\n        calculatedValue: any,\n        calculatedAtLevel: SettingLevel | null,\n    ): any {\n        if (this.settingDisabled) {\n            return this.forcedValue;\n        }\n        return null; // no override\n    }\n\n    public get settingDisabled(): boolean | string {\n        if (this.disabled) {\n            return this.disabledMessage ?? true;\n        }\n        return false;\n    }\n}\n"],"mappings":";;;;;;;;AASA,IAAAA,6BAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,cAAA,GAAAF,sBAAA,CAAAC,OAAA;AAXA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACe,MAAME,sCAAsC,SAASC,qCAA4B,CAAC;EAK7F;AACJ;AACA;AACA;AACA;AACA;AACA;EACWC,WAAWA,CACGC,WAAmB,EACnBC,QAAsB,EACtBC,qBAAiC,EACjCC,aAAsB,EACtBC,eAAwB,EACxBC,WAAgB,GAAG,KAAK,EAC3C;IACE,KAAK,CAAC,CAAC;IAnBX;IACA;IAAA,IAAAC,gBAAA,CAAAC,OAAA;IAAA,KAWqBP,WAAmB,GAAnBA,WAAmB;IAAA,KACnBC,QAAsB,GAAtBA,QAAsB;IAAA,KACtBC,qBAAiC,GAAjCA,qBAAiC;IAAA,KACjCC,aAAsB,GAAtBA,aAAsB;IAAA,KACtBC,eAAwB,GAAxBA,eAAwB;IAAA,KACxBC,WAAgB,GAAhBA,WAAgB;EAGrC;EAEA,IAAWG,QAAQA,CAAA,EAAY;IAC3B,OAAO,CAAC,IAAI,CAACC,OAAO;EACxB;EAEA,IAAWD,QAAQA,CAACE,gBAAyB,EAAE;IAC3C,IAAI,CAACA,gBAAgB,KAAK,IAAI,CAACD,OAAO,EAAE;IACxC,IAAI,CAACA,OAAO,GAAG,CAACC,gBAAgB;IAChC,MAAMC,KAAK,GAAGC,sBAAa,CAACC,mBAAmB,CAAC,IAAI,CAACb,WAAW,CAAC;IACjE,IAAI,CAACW,KAAK,EAAE;IACZ,MAAMG,YAAY,GAAGF,sBAAa,CAACG,QAAQ,CAAC,IAAI,CAACf,WAAW,EAAE,IAAI,CAAC;IACnE,IAAI,CAACC,QAAQ,CAACe,YAAY,CAAC,IAAI,CAAChB,WAAW,EAAE,IAAI,EAAEW,KAAK,EAAEG,YAAY,CAAC;EAC3E;EAEA,MAAgBG,gBAAgBA,CAAA,EAAkB;IAC9C;IACA,IAAI,IAAI,CAACd,aAAa,KAAK,MAAM,IAAI,CAACe,MAAM,CAAEC,kBAAkB,CAAC,IAAI,CAAChB,aAAa,CAAC,CAAC,EAAE;MACnF,IAAI,CAACK,QAAQ,GAAG,KAAK;MACrB;IACJ;;IAEA;IACA;IACA,IAAIY,SAAS,GAAG,KAAK;IACrB,KAAK,MAAMC,YAAY,IAAI,IAAI,CAACnB,qBAAqB,EAAE;MACnD,MAAMoB,kBAAkB,GAAG,MAAMC,OAAO,CAACC,GAAG,CACxCH,YAAY,CAACI,GAAG,CAAC,MAAOC,OAAO,IAAK;QAChC,MAAMC,kBAAkB,GAAG,MAAM,IAAI,CAACT,MAAM,CAAEU,gCAAgC,CAACF,OAAO,CAAC;QACvF,OAAOC,kBAAkB;MAC7B,CAAC,CACL,CAAC;;MAED;MACA;MACA,MAAME,uBAAuB,GAAGP,kBAAkB,CAACQ,KAAK,CAAEH,kBAAkB,IAAKA,kBAAkB,CAAC;MACpG,IAAIE,uBAAuB,EAAE;QACzBT,SAAS,GAAG,IAAI;QAChB;MACJ;IACJ;IAEA,IAAI,CAACZ,QAAQ,GAAG,CAACY,SAAS;EAC9B;EAEOW,gBAAgBA,CACnBpB,KAAmB,EACnBqB,MAAqB,EACrBC,eAAoB,EACpBC,iBAAsC,EACnC;IACH,IAAI,IAAI,CAACC,eAAe,EAAE;MACtB,OAAO,IAAI,CAAC9B,WAAW;IAC3B;IACA,OAAO,IAAI,CAAC,CAAC;EACjB;EAEA,IAAW8B,eAAeA,CAAA,EAAqB;IAC3C,IAAI,IAAI,CAAC3B,QAAQ,EAAE;MACf,OAAO,IAAI,CAACJ,eAAe,IAAI,IAAI;IACvC;IACA,OAAO,KAAK;EAChB;AACJ;AAACgC,OAAA,CAAA7B,OAAA,GAAAV,sCAAA","ignoreList":[]}