v1.4.2

Document troubleshooting for memory leaks and getting profiles

CHANGELOG.md

@@ -1,3 +1,19 @@
+Changes in [1.4.2](https://github.com/vector-im/riot-web/releases/tag/v1.4.2) (2019-10-04)
+==========================================================================================
+[Full Changelog](https://github.com/vector-im/riot-web/compare/v1.4.2-rc.1...v1.4.2)
+
+ * Document troubleshooting for memory leaks and getting profiles
+   [\#11031](https://github.com/vector-im/riot-web/pull/11031)
+
+Changes in [1.4.2-rc.1](https://github.com/vector-im/riot-web/releases/tag/v1.4.2-rc.1) (2019-10-02)
+====================================================================================================
+[Full Changelog](https://github.com/vector-im/riot-web/compare/v1.4.1...v1.4.2-rc.1)
+
+ * Custom themes MVP
+   [\#11017](https://github.com/vector-im/riot-web/pull/11017)
+ * Document permalinkPrefix setting
+   [\#11007](https://github.com/vector-im/riot-web/pull/11007)
+
 Changes in [1.4.1](https://github.com/vector-im/riot-web/releases/tag/v1.4.1) (2019-10-01)
 ==========================================================================================
 [Full Changelog](https://github.com/vector-im/riot-web/compare/v1.4.0...v1.4.1)

docs/config.md

@@ -80,8 +80,15 @@ For a good example, see https://riot.im/develop/config.json.
 1. `defaultCountryCode`: The ISO 3166 alpha2 country code to use when showing
    country selectors, like the phone number input on the registration page.
    Defaults to `GB` if the given code is unknown or not provided.
+1. `settingDefaults`:  Defaults for settings that support the `config` level,
+   as an object mapping setting name to value (note that the "theme" setting
+   is special cased to the `default_theme` in the config file).
 1. `disable_custom_urls`: disallow the user to change the
    default homeserver when signing up or logging in.
+1. `permalinkPrefix`: Used to change the URL that Riot generates permalinks with.
+   By default, this is "https://matrix.to" to generate matrix.to (spec) permalinks.
+   Set this to your Riot instance URL if you run an unfederated server (eg: 
+   "https://riot.example.org").
 
 Note that `index.html` also has an og:image meta tag that is set to an image
 hosted on riot.im. This is the image used if links to your copy of Riot

docs/memory-profiles-and-leaks.md

@@ -0,0 +1,53 @@
+## Memory leaks
+
+Riot usually emits slow behaviour just before it is about to crash. Getting a 
+memory snapshot (below) just before that happens is ideal in figuring out what
+is going wrong.
+
+Common symptoms are clicking on a room and it feels like the tab froze and scrolling
+becoming jumpy/staggered. 
+
+If you receive a white screen (electron) or the chrome crash page, it is likely
+run out of memory and it is too late for a memory profile. Please do report when
+this happens though so we can try and narrow down what might have gone wrong.
+
+## Memory profiles/snapshots
+
+When investigating memory leaks/problems it's usually important to compare snapshots
+from different points in the Riot session lifecycle. Most importantly, a snapshot
+to establish the baseline or "normal" memory usage is useful. Taking a snapshot
+roughly 30-60 minutes after starting Riot is a good time to establish "normal"
+memory usage for the app - anything after that is at risk of hiding the memory leak
+and anything newer is still in the warmup stages of the app.
+
+**Memory profiles can contain sensitive information.** If you are submitting a memory
+profile to us for debugging purposes, please pick the appropriate Riot developer and
+send them over an encrypted private message. *Do not share your memory profile in
+public channels or with people you do not trust.*
+
+### Taking a memory profile (Firefox)
+
+1. Press CTRL+SHIFT+I (I as in eye).
+2. Click the Memory tab.
+3. Press the camera icon in the top left of the pane.
+4. Wait a bit (coffee is a good option).
+5. When the save button appears on the left side of the panel, click it to save the
+   profile locally.
+6. Compress the file (gzip or regular zip) to make the file smaller.
+7. Send the compressed file to whoever asked for it (if you trust them).
+
+While the profile is in progress, the tab might be frozen or unresponsive.
+
+### Taking a memory profile (Chrome/Desktop)
+
+1. Press CTRL+SHIFT+I (I as in eye).
+2. Click the Memory tab.
+3. Select "Heap Snapshot" and the riot.im VM instance (not the indexeddb one).
+4. Click "Take Snapshot".
+5. Wait a bit (coffee is a good option).
+6. When the save button appears on the left side of the panel, click it to save the
+   profile locally.
+7. Compress the file (gzip or regular zip) to make the file smaller.
+8. Send the compressed file to whoever asked for it (if you trust them).
+
+While the profile is in progress, the tab might be frozen or unresponsive.

electron_app/package.json

@@ -2,7 +2,7 @@
   "name": "riot-web",
   "productName": "Riot",
   "main": "src/electron-main.js",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "A feature-rich client for Matrix.org",
   "author": "New Vector Ltd.",
   "dependencies": {

package.json

@@ -2,7 +2,7 @@
   "name": "riot-web",
   "productName": "Riot",
   "main": "electron_app/src/electron-main.js",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "A feature-rich client for Matrix.org",
   "author": "New Vector Ltd.",
   "repository": {
@@ -75,7 +75,7 @@
     "gfm.css": "^1.1.2",
     "highlight.js": "^9.13.1",
     "matrix-js-sdk": "2.4.1",
-    "matrix-react-sdk": "1.6.1",
+    "matrix-react-sdk": "1.6.2",
     "modernizr": "^3.6.0",
     "olm": "https://packages.matrix.org/npm/olm/olm-3.1.0.tgz",
     "prop-types": "^15.7.2",
@@ -152,7 +152,7 @@
   },
   "build": {
     "appId": "im.riot.app",
-    "electronVersion": "6.0.10",
+    "electronVersion": "6.0.11",
     "files": [
       "node_modules/**",
       "src/**"

webpack.config.js

@@ -18,6 +18,8 @@ module.exports = {
         // CSS themes
         "theme-light": "./node_modules/matrix-react-sdk/res/themes/light/css/light.scss",
         "theme-dark": "./node_modules/matrix-react-sdk/res/themes/dark/css/dark.scss",
+        "theme-light-custom": "./node_modules/matrix-react-sdk/res/themes/light-custom/css/light-custom.scss",
+        "theme-dark-custom": "./node_modules/matrix-react-sdk/res/themes/dark-custom/css/dark-custom.scss",
     },
     module: {
         rules: [

yarn.lock

@@ -3175,7 +3175,7 @@ emoji-regex@^8.0.0:
   resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37"
   integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==
 
-emojibase-data@^4.0.1:
+emojibase-data@^4.0.2:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/emojibase-data/-/emojibase-data-4.0.2.tgz#6b5ee0b6e8d04f9fcbca2c308c3341da8be47797"
   integrity sha512-ezU6rqxbrsINFD+lg28IQwRsWLoSpwpt6TH65fBEx/GxIrPpbIP1ZvNu1jUkRD+oALspstjyujZvcv0VlJozhg==
@@ -5971,10 +5971,10 @@ matrix-mock-request@^1.2.3:
     bluebird "^3.5.0"
     expect "^1.20.2"
 
-matrix-react-sdk@1.6.1:
-  version "1.6.1"
-  resolved "https://registry.yarnpkg.com/matrix-react-sdk/-/matrix-react-sdk-1.6.1.tgz#37608f7e6ecf5d8a57411c0e2d63e516f897f42c"
-  integrity sha512-+hjM+aGU/Rc39Ebu/SONLX8XJ/Y1Ig7uEOGTV5R+BJMRlLtpK/rYwJk24tpn1LiVMhPU5HJCApnmvpBv3Xo/GQ==
+matrix-react-sdk@1.6.2:
+  version "1.6.2"
+  resolved "https://registry.yarnpkg.com/matrix-react-sdk/-/matrix-react-sdk-1.6.2.tgz#c2659a2479e85b8a3e4ebbb436b1daafcb76fef5"
+  integrity sha512-+SmsM94Bolbwj+4I5bGF00zUAmlsZ4D4r7s1An/6SHMFL2+ly8QG4wDt1Q2KZ2vrcT3tnLqsp2zRsmKpCTD7ZA==
   dependencies:
     babel-plugin-syntax-dynamic-import "^6.18.0"
     babel-runtime "^6.26.0"
@@ -5988,7 +5988,7 @@ matrix-react-sdk@1.6.1:
     create-react-class "^15.6.0"
     diff-dom "^4.1.3"
     diff-match-patch "^1.0.4"
-    emojibase-data "^4.0.1"
+    emojibase-data "^4.0.2"
     emojibase-regex "^3.0.0"
     file-saver "^1.3.3"
     filesize "3.5.6"