Be more positive with setting labels

Fixes element-hq/element-web#6435 This is done through an on-the-fly inverter for the settings. All the settings changed are boolean values, so this should be more than safe to just let happen throughout the SettingsStore. Typically a change like this would be done in the individual handlers (similar to how setting names are remapped to different properties or even different storage locations on the fly), however doing that for this many settings would be a huge nightmare and involve changing *all* the layers. By putting a global "invert this" flag on the setting, we can get away with doing the inversion as the last possible step during a read (or write). To speed up calculations of the default values, we cache all the inverted values into a lookup table similar to how we represent the defaults already. Without this, the DefaultHandler would need to iterate the setting list and invert the values, slowing things down over time. We invert the value up front so we can keep the generic inversion logic without checking the level ahead of time. It is fully intended that a default value represents the new setting name, not the legacy name. This commit also includes a debugger for settings because it was hard to visualize what the SettingsStore was doing during development. Some added information is included as it may be helpful for when someone has a problem with their settings and we need to debug it. Typically the debugger would be run in conjunction with `mxSendRageshake`: `mxSettingsStore.debugSetting('showJoinLeaves') && mxSendRageshake('Debugging showJoinLeaves setting')`.
matrix-org · Jan 25, 2019 · cb6f415 · cb6f415
1 parent c5deeea
commit cb6f415
Show file tree

Hide file tree

Showing 15 changed files with 255 additions and 96 deletions.
diff --git a/src/MatrixClientPeg.js b/src/MatrixClientPeg.js
@@ -183,7 +183,7 @@ class MatrixClientPeg {
             userId: creds.userId,
             deviceId: creds.deviceId,
             timelineSupport: true,
-            forceTURN: SettingsStore.getValue('webRtcForceTURN', false),
+            forceTURN: !SettingsStore.getValue('webRtcForcePeerToPeer', false),
         };
 
         this.matrixClient = createMatrixClient(opts, useIndexedDb);

diff --git a/src/autocomplete/EmojiProvider.js b/src/autocomplete/EmojiProvider.js
@@ -97,7 +97,7 @@ export default class EmojiProvider extends AutocompleteProvider {
     }
 
     async getCompletions(query: string, selection: SelectionRange, force?: boolean): Array<Completion> {
-        if (SettingsStore.getValue("MessageComposerInput.dontSuggestEmoji")) {
+        if (!SettingsStore.getValue("MessageComposerInput.suggestEmoji")) {
             return []; // don't give any suggestions if the user doesn't want them
         }
 

diff --git a/src/components/structures/BottomLeftMenu.js b/src/components/structures/BottomLeftMenu.js
@@ -170,7 +170,7 @@ module.exports = React.createClass({
         const SettingsButton = sdk.getComponent('elements.SettingsButton');
         const GroupsButton = sdk.getComponent('elements.GroupsButton');
 
-        const groupsButton = SettingsStore.getValue("TagPanel.disableTagPanel") ?
+        const groupsButton = !SettingsStore.getValue("TagPanel.enableTagPanel") ?
             <GroupsButton tooltip={true} /> : null;
 
         return (

diff --git a/src/components/structures/LeftPanel.js b/src/components/structures/LeftPanel.js
@@ -187,7 +187,7 @@ const LeftPanel = React.createClass({
         const SearchBox = sdk.getComponent('structures.SearchBox');
         const CallPreview = sdk.getComponent('voip.CallPreview');
 
-        const tagPanelEnabled = !SettingsStore.getValue("TagPanel.disableTagPanel");
+        const tagPanelEnabled = SettingsStore.getValue("TagPanel.enableTagPanel");
         const tagPanel = tagPanelEnabled ? <TagPanel /> : <div />;
 
         const containerClasses = classNames(

diff --git a/src/components/structures/RoomView.js b/src/components/structures/RoomView.js
@@ -1838,7 +1838,7 @@ module.exports = React.createClass({
         const messagePanel = (
             <TimelinePanel ref={this._gatherTimelinePanelRef}
                 timelineSet={this.state.room.getUnfilteredTimelineSet()}
-                showReadReceipts={!SettingsStore.getValue('hideReadReceipts')}
+                showReadReceipts={SettingsStore.getValue('showReadReceipts')}
                 manageReadReceipts={!this.state.isPeeking}
                 manageReadMarkers={!this.state.isPeeking}
                 hidden={hideMessagePanel}

diff --git a/src/components/structures/UserSettings.js b/src/components/structures/UserSettings.js
@@ -65,22 +65,22 @@ const SIMPLE_SETTINGS = [
     { id: "autoplayGifsAndVideos" },
     { id: "alwaysShowEncryptionIcons" },
     { id: "showRoomRecoveryReminder" },
-    { id: "hideReadReceipts" },
-    { id: "dontSendTypingNotifications" },
+    { id: "showReadReceipts" },
+    { id: "sendTypingNotifications" },
     { id: "alwaysShowTimestamps" },
     { id: "showTwelveHourTimestamps" },
-    { id: "hideJoinLeaves" },
-    { id: "hideAvatarChanges" },
-    { id: "hideDisplaynameChanges" },
+    { id: "showJoinLeaves" },
+    { id: "showAvatarChanges" },
+    { id: "showDisplaynameChanges" },
     { id: "useCompactLayout" },
-    { id: "hideRedactions" },
+    { id: "showRedactions" },
     { id: "enableSyntaxHighlightLanguageDetection" },
     { id: "MessageComposerInput.autoReplaceEmoji" },
-    { id: "MessageComposerInput.dontSuggestEmoji" },
-    { id: "Pill.shouldHidePillAvatar" },
-    { id: "TextualBody.disableBigEmoji" },
+    { id: "MessageComposerInput.suggestEmoji" },
+    { id: "Pill.shouldShowPillAvatar" },
+    { id: "TextualBody.enableBigEmoji" },
     { id: "VideoView.flipVideoHorizontally" },
-    { id: "TagPanel.disableTagPanel" },
+    { id: "TagPanel.enableTagPanel" },
     { id: "enableWidgetScreenshots" },
     { id: "pinMentionedRooms" },
     { id: "pinUnreadRooms" },
@@ -101,9 +101,9 @@ const ANALYTICS_SETTINGS = [
 // These settings must be defined in SettingsStore
 const WEBRTC_SETTINGS = [
     {
-        id: 'webRtcForceTURN',
+        id: 'webRtcForcePeerToPeer',
         fn: (val) => {
-            MatrixClientPeg.get().setForceTURN(val);
+            MatrixClientPeg.get().setForceTURN(!val);
         },
     },
 ];

diff --git a/src/components/views/messages/TextualBody.js b/src/components/views/messages/TextualBody.js
@@ -174,7 +174,7 @@ module.exports = React.createClass({
     },
 
     pillifyLinks: function(nodes) {
-        const shouldShowPillAvatar = !SettingsStore.getValue("Pill.shouldHidePillAvatar");
+        const shouldShowPillAvatar = SettingsStore.getValue("Pill.shouldShowPillAvatar");
         let node = nodes[0];
         while (node) {
             let pillified = false;
@@ -436,7 +436,7 @@ module.exports = React.createClass({
 
         const stripReply = ReplyThread.getParentEventId(mxEvent);
         let body = HtmlUtils.bodyToHtml(content, this.props.highlights, {
-            disableBigEmoji: SettingsStore.getValue('TextualBody.disableBigEmoji'),
+            disableBigEmoji: !SettingsStore.getValue('TextualBody.enableBigEmoji'),
             // Part of Replies fallback support
             stripReplyFallback: stripReply,
         });

diff --git a/src/components/views/rooms/MessageComposerInput.js b/src/components/views/rooms/MessageComposerInput.js
@@ -486,7 +486,7 @@ export default class MessageComposerInput extends React.Component {
     }
 
     sendTyping(isTyping) {
-        if (SettingsStore.getValue('dontSendTypingNotifications')) return;
+        if (!SettingsStore.getValue('sendTypingNotifications')) return;
         MatrixClientPeg.get().sendTyping(
             this.props.room.roomId,
             this.isTyping, TYPING_SERVER_TIMEOUT,
@@ -1443,7 +1443,7 @@ export default class MessageComposerInput extends React.Component {
                 const url = data.get('href');
                 const completion = data.get('completion');
 
-                const shouldShowPillAvatar = !SettingsStore.getValue("Pill.shouldHidePillAvatar");
+                const shouldShowPillAvatar = SettingsStore.getValue("Pill.shouldShowPillAvatar");
                 const Pill = sdk.getComponent('elements.Pill');
 
                 if (completion === '@room') {

diff --git a/src/components/views/settings/tabs/PreferencesSettingsTab.js b/src/components/views/settings/tabs/PreferencesSettingsTab.js
@@ -26,8 +26,8 @@ const PlatformPeg = require("../../../../PlatformPeg");
 export default class PreferencesSettingsTab extends React.Component {
     static COMPOSER_SETTINGS = [
         'MessageComposerInput.autoReplaceEmoji',
-        'MessageComposerInput.dontSuggestEmoji', // TODO: Positive wording
-        'dontSendTypingNotifications', // TODO: Positive wording
+        'MessageComposerInput.suggestEmoji',
+        'sendTypingNotifications',
     ];
 
     static ROOM_LIST_SETTINGS = [
@@ -38,21 +38,21 @@ export default class PreferencesSettingsTab extends React.Component {
     static TIMELINE_SETTINGS = [
         'autoplayGifsAndVideos',
         'urlPreviewsEnabled',
-        'TextualBody.disableBigEmoji', // TODO: Positive wording
-        'hideReadReceipts', // TODO: Positive wording
+        'TextualBody.enableBigEmoji',
+        'showReadReceipts',
         'showTwelveHourTimestamps',
         'alwaysShowTimestamps',
-        'hideRedactions', // TODO: Positive wording ("Show a placeholder for removed messages")
+        'showRedactions',
         'enableSyntaxHighlightLanguageDetection',
-        'hideJoinLeaves', // TODO: Positive wording
-        'hideAvatarChanges', // TODO: Positive wording
-        'hideDisplaynameChanges', // TODO: Positive wording
+        'showJoinLeaves',
+        'showAvatarChanges',
+        'showDisplaynameChanges',
     ];
 
     static ADVANCED_SETTINGS = [
         'alwaysShowEncryptionIcons',
-        'Pill.shouldHidePillAvatar', // TODO: Positive wording
-        'TagPanel.disableTagPanel', // TODO: Positive wording
+        'Pill.shouldShowPillAvatar',
+        'TagPanel.enableTagPanel',
         'promptBeforeInviteUnknownUsers',
         // Start automatically after startup (electron-only)
         // Autocomplete delay (niche text box)

diff --git a/src/components/views/settings/tabs/VoiceSettingsTab.js b/src/components/views/settings/tabs/VoiceSettingsTab.js
@@ -80,8 +80,8 @@ export default class VoiceSettingsTab extends React.Component {
         CallMediaHandler.setVideoInput(e.target.value);
     };
 
-    _setForceTurn = (forced) => {
-        MatrixClientPeg.get().setForceTURN(forced);
+    _changeWebRtcMethod = (p2p) => {
+        MatrixClientPeg.get().setForceTURN(!p2p);
     };
 
     _renderDeviceOptions(devices, category) {
@@ -159,7 +159,6 @@ export default class VoiceSettingsTab extends React.Component {
             }
         }
 
-        // TODO: Make 'webRtcForceTURN' be positively worded
         return (
             <div className="mx_SettingsTab mx_VoiceSettingsTab">
                 <div className="mx_SettingsTab_heading">{_t("Voice & Video")}</div>
@@ -169,7 +168,7 @@ export default class VoiceSettingsTab extends React.Component {
                     {microphoneDropdown}
                     {webcamDropdown}
                     <SettingsFlag name='VideoView.flipVideoHorizontally' level={SettingLevel.ACCOUNT} />
-                    <SettingsFlag name='webRtcForceTURN' level={SettingLevel.DEVICE} onChange={this._setForceTurn} />
+                    <SettingsFlag name='webRtcForcePeerToPeer' level={SettingLevel.DEVICE} onChange={this._changeWebRtcMethod} />
                 </div>
             </div>
         );

diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
@@ -267,25 +267,25 @@
     "Increase performance by only loading room members on first view": "Increase performance by only loading room members on first view",
     "Backup of encryption keys to server": "Backup of encryption keys to server",
     "Render simple counters in room header": "Render simple counters in room header",
-    "Disable Emoji suggestions while typing": "Disable Emoji suggestions while typing",
+    "Enable Emoji suggestions while typing": "Enable Emoji suggestions while typing",
     "Use compact timeline layout": "Use compact timeline layout",
-    "Hide removed messages": "Hide removed messages",
-    "Hide join/leave messages (invites/kicks/bans unaffected)": "Hide join/leave messages (invites/kicks/bans unaffected)",
-    "Hide avatar changes": "Hide avatar changes",
-    "Hide display name changes": "Hide display name changes",
-    "Hide read receipts": "Hide read receipts",
+    "Show a placeholder for removed messages": "Show a placeholder for removed messages",
+    "Show join/leave messages (invites/kicks/bans unaffected)": "Show join/leave messages (invites/kicks/bans unaffected)",
+    "Show avatar changes": "Show avatar changes",
+    "Show display name changes": "Show display name changes",
+    "Show read receipts": "Show read receipts",
     "Show timestamps in 12 hour format (e.g. 2:30pm)": "Show timestamps in 12 hour format (e.g. 2:30pm)",
     "Always show message timestamps": "Always show message timestamps",
     "Autoplay GIFs and videos": "Autoplay GIFs and videos",
     "Always show encryption icons": "Always show encryption icons",
     "Show a reminder to enable Secure Message Recovery in encrypted rooms": "Show a reminder to enable Secure Message Recovery in encrypted rooms",
     "Enable automatic language detection for syntax highlighting": "Enable automatic language detection for syntax highlighting",
-    "Hide avatars in user and room mentions": "Hide avatars in user and room mentions",
-    "Disable big emoji in chat": "Disable big emoji in chat",
-    "Don't send typing notifications": "Don't send typing notifications",
+    "Show avatars in user and room mentions": "Show avatars in user and room mentions",
+    "Enable big emoji in chat": "Enable big emoji in chat",
+    "Send typing notifications": "Send typing notifications",
     "Automatically replace plain text Emoji": "Automatically replace plain text Emoji",
     "Mirror local video feed": "Mirror local video feed",
-    "Disable Community Filter Panel": "Disable Community Filter Panel",
+    "Enable Community Filter Panel": "Enable Community Filter Panel",
     "Disable Peer-to-Peer for 1:1 calls": "Disable Peer-to-Peer for 1:1 calls",
     "Send analytics data": "Send analytics data",
     "Never send encrypted messages to unverified devices from this device": "Never send encrypted messages to unverified devices from this device",

diff --git a/src/settings/Settings.js b/src/settings/Settings.js
@@ -77,6 +77,15 @@ export const SETTINGS = {
     //     // settings. The first element is treated as "most preferred". The "default"
     //     // level is always appended to the end.
     //     supportedLevelsAreOrdered: false,
+    //
+    //     // Optional value to invert a boolean setting's value. The string given will
+    //     // be read as the setting's ID instead of the one provided as the key for the
+    //     // setting definition. By setting this, the returned value will automatically
+    //     // be inverted, except for when the default value is returned. Inversion will
+    //     // occur after the controller is asked for an override. This should be used by
+    //     // historical settings which we don't want existing user's values be wiped. Do
+    //     // not use this for new settings.
+    //     invertedSettingName: "my-negative-setting",
     // },
     "feature_pinning": {
         isFeature: true,
@@ -116,40 +125,46 @@ export const SETTINGS = {
         supportedLevels: LEVELS_FEATURE,
         default: false,
     },
-    "MessageComposerInput.dontSuggestEmoji": {
+    "MessageComposerInput.suggestEmoji": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
-        displayName: _td('Disable Emoji suggestions while typing'),
-        default: false,
+        displayName: _td('Enable Emoji suggestions while typing'),
+        default: true,
+        invertedSettingName: 'MessageComposerInput.dontSuggestEmoji',
     },
     "useCompactLayout": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
         displayName: _td('Use compact timeline layout'),
         default: false,
     },
-    "hideRedactions": {
+    "showRedactions": {
         supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
-        displayName: _td('Hide removed messages'),
-        default: false,
+        displayName: _td('Show a placeholder for removed messages'),
+        default: true,
+        invertedSettingName: 'hideRedactions',
     },
-    "hideJoinLeaves": {
+    "showJoinLeaves": {
         supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
-        displayName: _td('Hide join/leave messages (invites/kicks/bans unaffected)'),
-        default: false,
+        displayName: _td('Show join/leave messages (invites/kicks/bans unaffected)'),
+        default: true,
+        invertedSettingName: 'hideJoinLeaves',
     },
-    "hideAvatarChanges": {
+    "showAvatarChanges": {
         supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
-        displayName: _td('Hide avatar changes'),
-        default: false,
+        displayName: _td('Show avatar changes'),
+        default: true,
+        invertedSettingName: 'hideAvatarChanges',
     },
-    "hideDisplaynameChanges": {
+    "showDisplaynameChanges": {
         supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
-        displayName: _td('Hide display name changes'),
-        default: false,
+        displayName: _td('Show display name changes'),
+        default: true,
+        invertedSettingName: 'hideDisplaynameChanges',
     },
-    "hideReadReceipts": {
+    "showReadReceipts": {
         supportedLevels: LEVELS_ROOM_SETTINGS,
-        displayName: _td('Hide read receipts'),
-        default: false,
+        displayName: _td('Show read receipts'),
+        default: true,
+        invertedSettingName: 'hideReadReceipts',
     },
     "showTwelveHourTimestamps": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
@@ -181,15 +196,17 @@ export const SETTINGS = {
         displayName: _td('Enable automatic language detection for syntax highlighting'),
         default: false,
     },
-    "Pill.shouldHidePillAvatar": {
+    "Pill.shouldShowPillAvatar": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
-        displayName: _td('Hide avatars in user and room mentions'),
-        default: false,
+        displayName: _td('Show avatars in user and room mentions'),
+        default: true,
+        invertedSettingName: 'Pill.shouldHidePillAvatar',
     },
-    "TextualBody.disableBigEmoji": {
+    "TextualBody.enableBigEmoji": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
-        displayName: _td('Disable big emoji in chat'),
-        default: false,
+        displayName: _td('Enable big emoji in chat'),
+        default: true,
+        invertedSettingName: 'TextualBody.disableBigEmoji',
     },
     "MessageComposerInput.isRichTextEnabled": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
@@ -199,10 +216,11 @@ export const SETTINGS = {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
         default: false,
     },
-    "dontSendTypingNotifications": {
+    "sendTypingNotifications": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
-        displayName: _td("Don't send typing notifications"),
-        default: false,
+        displayName: _td("Send typing notifications"),
+        default: true,
+        invertedSettingName: 'dontSendTypingNotifications',
     },
     "MessageComposerInput.autoReplaceEmoji": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
@@ -214,19 +232,21 @@ export const SETTINGS = {
         displayName: _td('Mirror local video feed'),
         default: false,
     },
-    "TagPanel.disableTagPanel": {
+    "TagPanel.enableTagPanel": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
-        displayName: _td('Disable Community Filter Panel'),
-        default: false,
+        displayName: _td('Enable Community Filter Panel'),
+        default: true,
+        invertedSettingName: 'TagPanel.disableTagPanel',
     },
     "theme": {
         supportedLevels: ['config'],
         default: "dharma",
     },
-    "webRtcForceTURN": {
+    "webRtcForcePeerToPeer": {
         supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
         displayName: _td('Disable Peer-to-Peer for 1:1 calls'),
-        default: false,
+        default: true,
+        invertedSettingName: 'webRtcForceTURN',
     },
     "webrtc_audiooutput": {
         supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,