Support the old room sorting algorithm and SettingsStore watchers

docs/settings.md

@@ -131,6 +131,32 @@ SettingsStore.getValue(...); // this will return the value set in `setValue` abo
 ```
 
 
+## Watching for changes
+
+Most use cases do not need to set up a watcher because they are able to react to changes as they are made, or the changes which are made are not significant enough for it to matter. Watchers are intended to be used in scenarios where it is important to react to changes made by other logged in devices. Typically, this would be done within the component itself, however the component should not be aware of the intricacies of setting inversion or remapping to particular data structures. Instead, a generic watcher interface is provided on `SettingsStore` to watch (and subsequently unwatch) for changes in a setting.
+
+An example of a watcher in action would be:
+
+```javascript
+class MyComponent extends React.Component {
+
+    settingWatcherRef = null;
+
+    componentWillMount() {
+        this.settingWatcherRef = SettingsStore.watchSetting("roomColor", "!example:matrix.org", (settingName, roomId, level, newVal) => {
+            // Always re-read the setting value from the store to avoid reacting to changes which do not have a consequence. For example, the
+            // room color could have been changed at the device level, but an account override prevents that change from making a difference.
+           const actualVal = SettingsStore.getValue(settingName, "!example:matrix.org");
+           if (actualVal !== this.state.color) this.setState({color: actualVal});
+        });
+    }
+
+    componentWillUnmount() {
+        SettingsStore.unwatchSetting(this.settingWatcherRef);
+    }
+}
+```
+
 
 # Maintainers Reference
 
@@ -159,3 +185,10 @@ Features automatically get considered as `disabled` if they are not listed in th
 ```
 
 If `enableLabs` is true in the configuration, the default for features becomes `"labs"`.
+
+### Watchers
+
+Watchers can appear complicated under the hood: the request to watch a setting is actually forked off to individual handlers for watching. This means that the handlers need to track their changes and listen for remote changes where possible, but also makes it much easier for the `SettingsStore` to react to changes. The handler is going to know the best things to listen for (specific events, account data, etc) and thus it is left as a responsibility for the handler to track changes. 
+
+In practice, handlers which rely on remote changes (account data, room events, etc) will always attach a listener to the `MatrixClient`. They then watch for changes to events they care about and send off appropriate updates to the generalized `WatchManager` - a class specifically designed to deduplicate the logic of managing watchers. The handlers which are localized to the local client (device) generally just trigger the `WatchManager` when they manipulate the setting themselves as there's nothing to really 'watch'.
+

src/MatrixClientPeg.js

@@ -30,6 +30,7 @@ import MatrixActionCreators from './actions/MatrixActionCreators';
 import {phasedRollOutExpiredForUser} from "./PhasedRollOut";
 import Modal from './Modal';
 import {verificationMethods} from 'matrix-js-sdk/lib/crypto';
+import MatrixClientBackedSettingsHandler from "./settings/handlers/MatrixClientBackedSettingsHandler";
 
 interface MatrixClientCreds {
     homeserverUrl: string,
@@ -137,8 +138,9 @@ class MatrixClientPeg {
         opts.pendingEventOrdering = "detached";
         opts.lazyLoadMembers = true;
 
-        // Connect the matrix client to the dispatcher
+        // Connect the matrix client to the dispatcher and setting handlers
         MatrixActionCreators.start(this.matrixClient);
+        MatrixClientBackedSettingsHandler.matrixClient = this.matrixClient;
 
         console.log(`MatrixClientPeg: really starting MatrixClient`);
         await this.get().startClient(opts);

src/components/views/settings/tabs/PreferencesSettingsTab.js

@@ -44,6 +44,10 @@ export default class PreferencesSettingsTab extends React.Component {
         'showDisplaynameChanges',
     ];
 
+    static ROOM_LIST_SETTINGS = [
+        'RoomList.orderByImportance',
+    ];
+
     static ADVANCED_SETTINGS = [
         'alwaysShowEncryptionIcons',
         'Pill.shouldShowPillAvatar',
@@ -104,6 +108,9 @@ export default class PreferencesSettingsTab extends React.Component {
                     <span className="mx_SettingsTab_subheading">{_t("Timeline")}</span>
                     {this._renderGroup(PreferencesSettingsTab.TIMELINE_SETTINGS)}
 
+                    <span className="mx_SettingsTab_subheading">{_t("Room list")}</span>
+                    {this._renderGroup(PreferencesSettingsTab.ROOM_LIST_SETTINGS)}
+
                     <span className="mx_SettingsTab_subheading">{_t("Advanced")}</span>
                     {this._renderGroup(PreferencesSettingsTab.ADVANCED_SETTINGS)}
                     {autoLaunchOption}

src/i18n/strings/en_EN.json

@@ -306,6 +306,7 @@
     "Enable widget screenshots on supported widgets": "Enable widget screenshots on supported widgets",
     "Prompt before sending invites to potentially invalid matrix IDs": "Prompt before sending invites to potentially invalid matrix IDs",
     "Show developer tools": "Show developer tools",
+    "Order rooms in the room list by most important first instead of most recent": "Order rooms in the room list by most important first instead of most recent",
     "Collecting app version information": "Collecting app version information",
     "Collecting logs": "Collecting logs",
     "Uploading report": "Uploading report",
@@ -554,6 +555,7 @@
     "Preferences": "Preferences",
     "Composer": "Composer",
     "Timeline": "Timeline",
+    "Room list": "Room list",
     "Autocomplete delay (ms)": "Autocomplete delay (ms)",
     "To change the room's avatar, you must be a": "To change the room's avatar, you must be a",
     "To change the room's name, you must be a": "To change the room's name, you must be a",

src/settings/Settings.js

@@ -1,6 +1,6 @@
 /*
 Copyright 2017 Travis Ralston
-Copyright 2018 New Vector Ltd
+Copyright 2018, 2019 New Vector Ltd.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -340,4 +340,9 @@ export const SETTINGS = {
         displayName: _td('Show developer tools'),
         default: false,
     },
+    "RoomList.orderByImportance": {
+        supportedLevels: LEVELS_ACCOUNT_SETTINGS,
+        displayName: _td('Order rooms in the room list by most important first instead of most recent'),
+        default: true,
+    },
 };

src/settings/SettingsStore.js

@@ -1,5 +1,6 @@
 /*
 Copyright 2017 Travis Ralston
+Copyright 2019 New Vector Ltd.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -23,6 +24,7 @@ import RoomSettingsHandler from "./handlers/RoomSettingsHandler";
 import ConfigSettingsHandler from "./handlers/ConfigSettingsHandler";
 import {_t} from '../languageHandler';
 import SdkConfig from "../SdkConfig";
+import dis from '../dispatcher';
 import {SETTINGS} from "./Settings";
 import LocalEchoWrapper from "./handlers/LocalEchoWrapper";
 
@@ -98,6 +100,121 @@ const LEVEL_ORDER = [
  * be enabled).
  */
 export default class SettingsStore {
+    // We support watching settings for changes, and do so only at the levels which are
+    // relevant to the setting. We pass the watcher on to the handlers and aggregate it
+    // before sending it off to the caller. We need to track which callback functions we
+    // provide to the handlers though so we can unwatch it on demand. In practice, we
+    // return a "callback reference" to the caller which correlates to an entry in this
+    // dictionary for each handler's callback function.
+    //
+    // We also maintain a list of monitors which are special watchers: they cause dispatches
+    // when the setting changes. We track which rooms we're monitoring though to ensure we
+    // don't duplicate updates on the bus.
+    static _watchers = {}; // { callbackRef => { level => callbackFn } }
+    static _monitors = {}; // { settingName => { roomId => callbackRef } }
+
+    /**
+     * Watches for changes in a particular setting. This is done without any local echo
+     * wrapping and fires whenever a change is detected in a setting's value. Watching
+     * is intended to be used in scenarios where the app needs to react to changes made
+     * by other devices. It is otherwise expected that callers will be able to use the
+     * Controller system or track their own changes to settings. Callers should retain
+     * @param {string} settingName The setting name to watch
+     * @param {String} roomId The room ID to watch for changes in. May be null for 'all'.
+     * @param {function} callbackFn A function to be called when a setting change is
+     * detected. Four arguments can be expected: the setting name, the room ID (may be null),
+     * the level the change happened at, and finally the new value for those arguments. The
+     * callback may need to do a call to #getValue() to see if a consequential change has
+     * occurred.
+     * @returns {string} A reference to the watcher that was employed.
+     */
+    static watchSetting(settingName, roomId, callbackFn) {
+        const setting = SETTINGS[settingName];
+        const originalSettingName = settingName;
+        if (!setting) throw new Error(`${settingName} is not a setting`);
+
+        if (setting.invertedSettingName) {
+            settingName = setting.invertedSettingName;
+        }
+
+        const watcherId = `${new Date().getTime()}_${settingName}_${roomId}`;
+        SettingsStore._watchers[watcherId] = {};
+
+        const levels = Object.keys(LEVEL_HANDLERS);
+        for (const level of levels) {
+            const handler = SettingsStore._getHandler(originalSettingName, level);
+            if (!handler) continue;
+
+            const localizedCallback = (changedInRoomId, newVal) => {
+                callbackFn(originalSettingName, changedInRoomId, level, newVal);
+            };
+
+            console.log(`Starting watcher for ${settingName}@${roomId || '<null room>'} at level ${level}`);
+            SettingsStore._watchers[watcherId][level] = localizedCallback;
+            handler.watchSetting(settingName, roomId, localizedCallback);
+        }
+
+        return watcherId;
+    }
+
+    /**
+     * Stops the SettingsStore from watching a setting. This is a no-op if the watcher
+     * provided is not found.
+     * @param {string} watcherReference The watcher reference (received from #watchSetting)
+     * to cancel.
+     */
+    static unwatchSetting(watcherReference) {
+        if (!SettingsStore._watchers[watcherReference]) return;
+
+        for (const handlerName of Object.keys(SettingsStore._watchers[watcherReference])) {
+            const handler = LEVEL_HANDLERS[handlerName];
+            if (!handler) continue;
+            handler.unwatchSetting(SettingsStore._watchers[watcherReference][handlerName]);
+        }
+
+        delete SettingsStore._watchers[watcherReference];
+    }
+
+    /**
+     * Sets up a monitor for a setting. This behaves similar to #watchSetting except instead
+     * of making a call to a callback, it forwards all changes to the dispatcher. Callers can
+     * expect to listen for the 'setting_updated' action with an object containing settingName,
+     * roomId, level, and newValue.
+     * @param {string} settingName The setting name to monitor.
+     * @param {String} roomId The room ID to monitor for changes in. Use null for all rooms.
+     */
+    static monitorSetting(settingName, roomId) {
+        if (!this._monitors[settingName]) this._monitors[settingName] = {};
+
+        const registerWatcher = () => {
+            this._monitors[settingName][roomId] = SettingsStore.watchSetting(
+                settingName, roomId, (settingName, inRoomId, level, newValue) => {
+                    dis.dispatch({
+                        action: 'setting_updated',
+                        settingName,
+                        roomId: inRoomId,
+                        level,
+                        newValue,
+                    });
+                },
+            );
+        };
+
+        const hasRoom = Object.keys(this._monitors[settingName]).find((r) => r === roomId || r === null);
+        if (!hasRoom) {
+            registerWatcher();
+        } else {
+            if (roomId === null) {
+                // Unregister all existing watchers and register the new one
+                for (const roomId of Object.keys(this._monitors[settingName])) {
+                    SettingsStore.unwatchSetting(this._monitors[settingName][roomId]);
+                }
+                this._monitors[settingName] = {};
+                registerWatcher();
+            } // else a watcher is already registered for the room, so don't bother registering it again
+        }
+    }
+
     /**
      * Gets the translated display name for a given setting
      * @param {string} settingName The setting to look up.

src/settings/WatchManager.js

@@ -0,0 +1,57 @@
+/*
+Copyright 2019 New Vector Ltd.
+
+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.
+*/
+
+/**
+ * Generalized management class for dealing with watchers on a per-handler (per-level)
+ * basis without duplicating code. Handlers are expected to push updates through this
+ * class, which are then proxied outwards to any applicable watchers.
+ */
+export class WatchManager {
+    _watchers = {}; // { settingName: { roomId: callbackFns[] } }
+
+    // Proxy for handlers to delegate changes to this manager
+    watchSetting(settingName, roomId, cb) {
+        if (!this._watchers[settingName]) this._watchers[settingName] = {};
+        if (!this._watchers[settingName][roomId]) this._watchers[settingName][roomId] = [];
+        this._watchers[settingName][roomId].push(cb);
+    }
+
+    // Proxy for handlers to delegate changes to this manager
+    unwatchSetting(cb) {
+        for (const settingName of Object.keys(this._watchers)) {
+            for (const roomId of Object.keys(this._watchers[settingName])) {
+                let idx;
+                while ((idx = this._watchers[settingName][roomId].indexOf(cb)) !== -1) {
+                    this._watchers[settingName][roomId].splice(idx, 1);
+                }
+            }
+        }
+    }
+
+    notifyUpdate(settingName, inRoomId, newValue) {
+        if (!this._watchers[settingName]) return;
+
+        const roomWatchers = this._watchers[settingName];
+        const callbacks = [];
+
+        if (inRoomId !== null && roomWatchers[inRoomId]) callbacks.push(...roomWatchers[inRoomId]);
+        if (roomWatchers[null]) callbacks.push(...roomWatchers[null]);
+
+        for (const callback of callbacks) {
+            callback(inRoomId, newValue);
+        }
+    }
+}

src/settings/handlers/AccountSettingsHandler.js

@@ -1,5 +1,6 @@
 /*
 Copyright 2017 Travis Ralston
+Copyright 2019 New Vector Ltd.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -14,14 +15,49 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import SettingsHandler from "./SettingsHandler";
 import MatrixClientPeg from '../../MatrixClientPeg';
+import {WatchManager} from "../WatchManager";
+import MatrixClientBackedSettingsHandler from "./MatrixClientBackedSettingsHandler";
 
 /**
  * Gets and sets settings at the "account" level for the current user.
  * This handler does not make use of the roomId parameter.
  */
-export default class AccountSettingHandler extends SettingsHandler {
+export default class AccountSettingsHandler extends MatrixClientBackedSettingsHandler {
+    constructor() {
+        super();
+
+        this._watchers = new WatchManager();
+        this._onAccountData = this._onAccountData.bind(this);
+    }
+
+    initMatrixClient(oldClient, newClient) {
+        if (oldClient) {
+            oldClient.removeListener("accountData", this._onAccountData);
+        }
+
+        newClient.on("accountData", this._onAccountData);
+    }
+
+    _onAccountData(event) {
+        if (event.getType() === "org.matrix.preview_urls") {
+            let val = event.getContent()['disable'];
+            if (typeof(val) !== "boolean") {
+                val = null;
+            } else {
+                val = !val;
+            }
+
+            this._watchers.notifyUpdate("urlPreviewsEnabled", null, val);
+        } else if (event.getType() === "im.vector.web.settings") {
+            // We can't really discern what changed, so trigger updates for everything
+            for (const settingName of Object.keys(event.getContent())) {
+                console.log(settingName);
+                this._watchers.notifyUpdate(settingName, null, event.getContent()[settingName]);
+            }
+        }
+    }
+
     getValue(settingName, roomId) {
         // Special case URL previews
         if (settingName === "urlPreviewsEnabled") {
@@ -67,6 +103,14 @@ export default class AccountSettingHandler extends SettingsHandler {
         return cli !== undefined && cli !== null;
     }
 
+    watchSetting(settingName, roomId, cb) {
+        this._watchers.watchSetting(settingName, roomId, cb);
+    }
+
+    unwatchSetting(cb) {
+        this._watchers.unwatchSetting(cb);
+    }
+
     _getSettings(eventType = "im.vector.web.settings") {
         const cli = MatrixClientPeg.get();
         if (!cli) return null;