v1.4.2

Document troubleshooting for memory leaks and getting profiles

CHANGELOG.md

@@ -1,3 +1,33 @@
+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)
+
+ * Upgrade to React SDK 1.6.1 to fix critical 
+   [blank screen issue](https://github.com/vector-im/riot-web/issues/10983)
+ * Upgrade to JS SDK 2.4.1 to to ignore crypto events with empty content
+ * Update from Weblate
+   [\#11010](https://github.com/vector-im/riot-web/pull/11010)
+ * Update from Weblate
+   [\#11001](https://github.com/vector-im/riot-web/pull/11001)
+ * Upgrade deps
+   [\#10980](https://github.com/vector-im/riot-web/pull/10980)
+
 Changes in [1.4.0](https://github.com/vector-im/riot-web/releases/tag/v1.4.0) (2019-09-27)
 ==========================================================================================
 [Full Changelog](https://github.com/vector-im/riot-web/compare/v1.4.0-rc.2...v1.4.0)

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.0",
+  "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.0",
+  "version": "1.4.2",
   "description": "A feature-rich client for Matrix.org",
   "author": "New Vector Ltd.",
   "repository": {
@@ -74,8 +74,8 @@
     "gemini-scrollbar": "github:matrix-org/gemini-scrollbar#91e1e566",
     "gfm.css": "^1.1.2",
     "highlight.js": "^9.13.1",
-    "matrix-js-sdk": "2.4.0",
-    "matrix-react-sdk": "1.6.0",
+    "matrix-js-sdk": "2.4.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/**"

scripts/electron-package.sh

@@ -85,6 +85,11 @@ if [ -n "$conffile" ]; then
     pushd "$builddir"
 fi
 
+# We use Git branch / commit dependencies for some packages, and Yarn seems
+# to have a hard time getting that right. See also
+# https://github.com/yarnpkg/yarn/issues/4734. As a workaround, we clean the
+# global cache here to ensure we get the right thing.
+yarn cache clean
 yarn install
 yarn build:electron
 

src/i18n/strings/da.json

@@ -34,5 +34,19 @@
     "Support for those using, running and writing other bridges": "Hjælp til dem der bruger, driver og skriver andre bridges",
     "Contributing code to Matrix and Riot": "Biddrag med kode til Matrix og Riot",
     "Dev chat for the Riot/Web dev team": "Udviklerchat til Riot/Web udviklerholdet",
-    "Dev chat for the Dendrite dev team": "Udviklerchat til Dendrite udviklerholdet"
+    "Dev chat for the Dendrite dev team": "Udviklerchat til Dendrite udviklerholdet",
+    "Your Riot configuration contains invalid JSON. Please correct the problem and reload the page.": "Din Riot konfiguration indeholder ugyldig JSON. Venligst korrigér problemet og opdatér siden.",
+    "The message from the parser is: %(message)s": "Beskeden fra parseren er: %(message)s",
+    "Invalid JSON": "Ugyldig JSON",
+    "Your Riot is misconfigured": "Din Riot er fejlkonfigureret",
+    "Unexpected error preparing the app. See console for details.": "Uventet fejl ved forberedelse af appen. Se konsollen for detaljer.",
+    "Invalid configuration: can only specify one of default_server_config, default_server_name, or default_hs_url.": "Ugyldig konfiguration: kan kun angive en af default_server_config, default_server_name eller default_hs_url.",
+    "Invalid configuration: no default server specified.": "Ugyldig konfiguration: ingen standardserver angivet.",
+    "You can use the custom server options to sign into other Matrix servers by specifying a different homeserver URL. This allows you to use Riot with an existing Matrix account on a different homeserver.": "Du kan bruge de brugertilpassede serverindstillinger til at logge på andre Matrix servere ved at angive en anden homeserver URL. Dette giver dig mulighed for at bruge Riot med en eksisterende Matrix konto på en anden homeserver.",
+    "You can also set a custom identity server, but you won't be able to invite users by email address, or be invited by email address yourself.": "Du kan også indstille en brugertilpasset identitetsserver, men så vil du ikke kunne invitere brugere pr. e-mail eller selv kunne inviteres pr. e-mail.",
+    "Sign In": "Log på",
+    "Create Account": "Opret konto",
+    "Need help?": "Brug for hjælp?",
+    "Explore rooms": "Udforsk rum",
+    "Room Directory": "Rumliste"
 }

src/i18n/strings/nn.json

@@ -34,13 +34,20 @@
     "Dev chat for the Riot/Web dev team": "Utviklar-prat for Riot/Web-utviklargruppa",
     "Dev chat for the Dendrite dev team": "Utviklar-prat for Dendrite-utviklargruppa",
     "Co-ordination for Riot translators": "Samordning for Riot-omsetjare",
-    "Custom Server Options": "Eigentenar-innstillingar",
+    "Custom Server Options": "Tilpassa tenar-innstillingar",
     "You can use the custom server options to sign into other Matrix servers by specifying a different Home server URL.<br/>This allows you to use Riot with an existing Matrix account on a different home server.<br/><br/>You can also set a custom identity server but you won't be able to invite users by email address, or be invited by email address yourself.": "Du kan bruka eigentenarinnstillingar til å logga inn på andre Matrixtenarar ved å oppgje ein annan Heimtenar-URL. <br/>Dette gjer at du kan bruka Riot med ein Matrixbrukar som allereie finst på ein annan heimtenar.<br/><br/>Du kan òg setja ein eigen identitetstenar men du kjem i so fall ikkje til å kunna byda brukare inn med epost, eller å sjølv verta boden inn med epost.",
     "You can use the custom server options to sign into other Matrix servers by specifying a different homeserver URL. This allows you to use Riot with an existing Matrix account on a different homeserver.": "Du kan nytta dei eigendefinerte tenarinstillingane for å logga inn på andre Matrix-tenarar ved å uppgje ein annan heimtenar-URL. Dette lèt deg bruka Riot med ein Matrix-konto som allereie finst på ein annan heimtenar.",
     "You can also set a custom identity server, but you won't be able to invite users by email address, or be invited by email address yourself.": "Du kan òg velja ein eigendefinert identitetstenar, men då kjem du ikkje til å innvitere brukarar gjennom e-post, eller verta invitert med e-post sjølv.",
     "Sign In": "Logg inn",
     "Create Account": "Lag brukar",
     "Need help?": "Treng du hjelp?",
-    "Explore rooms": "Vert kjend med romma",
-    "Room Directory": "Romutval"
+    "Explore rooms": "Utforsk romma",
+    "Room Directory": "Romkatalog",
+    "Your Riot configuration contains invalid JSON. Please correct the problem and reload the page.": "Riot-konfigurasjonen din har invalid JSON-kode. Korriger dette og last inn sida på nytt.",
+    "The message from the parser is: %(message)s": "Meldingen frå kodetolkaren er: %(message)s",
+    "Invalid JSON": "Ugyldig JSON",
+    "Your Riot is misconfigured": "Riot-klienten din er feilkonfiguert",
+    "Unexpected error preparing the app. See console for details.": "Uforventa feil under lasting av programmet. Sjå konsollet for detaljar.",
+    "Invalid configuration: can only specify one of default_server_config, default_server_name, or default_hs_url.": "Ugyldig konfigurasjon berre muleg å berre spesifiere ein av default_server_config, default_server_name eller default_hs_url.",
+    "Invalid configuration: no default server specified.": "Ugyldig konfigurasjon:  \"default server\" er uspesifisert."
 }

src/i18n/strings/pt_BR.json

@@ -42,5 +42,12 @@
     "Create Account": "Criar Conta",
     "Need help?": "Precisa de ajuda?",
     "Explore rooms": "Explore as salas",
-    "Room Directory": "Diretório de salas"
+    "Room Directory": "Diretório de salas",
+    "Your Riot configuration contains invalid JSON. Please correct the problem and reload the page.": "Sua configuração do Riot contém JSON inválido. Por favor corrija o erro e atualize a página.",
+    "The message from the parser is: %(message)s": "A mensagem do parser é: %(message)s",
+    "Invalid JSON": "JSON inválido",
+    "Your Riot is misconfigured": "Riot possui um erro de configuração",
+    "Unexpected error preparing the app. See console for details.": "Erro inesperado preparando o aplicativo. Veja o console para mais detalhes.",
+    "Invalid configuration: can only specify one of default_server_config, default_server_name, or default_hs_url.": "Configuração inválida: somente se pode especificar um valor entre default_server_config, default_server_name, ou default_hs_url.",
+    "Invalid configuration: no default server specified.": "Configuração inválida: servidor padrão não especificado."
 }

src/i18n/strings/sr.json

@@ -42,5 +42,12 @@
     "Explore rooms": "Истражи собе",
     "Room Directory": "Фасцикла са собама",
     "You can use the custom server options to sign into other Matrix servers by specifying a different homeserver URL. This allows you to use Riot with an existing Matrix account on a different homeserver.": "Можете користити опције прилагођеног сервера да бисте се пријавили на друге Матрикс сервере тако што ћете навести другачију адресу кућног сервера. Ово вам омогућава да користите Riot са постојећим Матрикс налогом на другом кућном серверу.",
-    "You can also set a custom identity server, but you won't be able to invite users by email address, or be invited by email address yourself.": "Такође, можете подесити прилагођени сервер идентитета али у том случају нећете моћи да позивате кориснике преко мејла адресе или да сами будете позвани преко мејл адресе."
+    "You can also set a custom identity server, but you won't be able to invite users by email address, or be invited by email address yourself.": "Такође, можете подесити прилагођени сервер идентитета али у том случају нећете моћи да позивате кориснике преко мејла адресе или да сами будете позвани преко мејл адресе.",
+    "Your Riot is misconfigured": "Ваш Riot није добро подешен",
+    "Invalid configuration: no default server specified.": "Погрешно подешавање: подразумевани сервер није наведен.",
+    "Your Riot configuration contains invalid JSON. Please correct the problem and reload the page.": "Ваша Riot конфигурација садржи погрешан JSON. Молим исправите проблем и поново учитајте страну.",
+    "The message from the parser is: %(message)s": "Порука из парсера: %(message)s",
+    "Invalid JSON": "Погрешан JSON",
+    "Unexpected error preparing the app. See console for details.": "Неочекивана грешка приликом припреме апликације. Погледајте конзолу за више детаља.",
+    "Invalid configuration: can only specify one of default_server_config, default_server_name, or default_hs_url.": "Погрешно подешавање: можете навести само један вредност од default_server_config, default_server_name, or default_hs_url."
 }

src/i18n/strings/th.json

@@ -4,7 +4,7 @@
     "Dismiss": "ไม่สนใจ",
     "Unknown device": "อุปกรณ์ที่ไม่รู้จัก",
     "You need to be using HTTPS to place a screen-sharing call.": "คุณต้องใช้ HTTPS เพื่อเริ่มติดต่อแบบแบ่งปันหน้าจอ",
-    "Riot Desktop on %(platformName)s": "Riot เดสก์ทอปบน %(platformName)s",
+    "Riot Desktop on %(platformName)s": "Riot Desktop บน %(platformName)s",
     "Riot is not supported on mobile web. Install the app?": "Riot ไม่รองรับเว็บบนอุปกรณ์พกพา ติดตั้งแอป?",
     "Custom Server Options": "กำหนดเซิร์ฟเวอร์เอง",
     "Welcome to Riot.im": "ยินดีต้อนรับสู่ Riot.im",
@@ -33,5 +33,13 @@
     "Design and implementation of E2E in Matrix": "การออกแบบและใช้งาน E2E ใน Matrix",
     "Discussion of the Identity Service API": "พูดคุยเกี่ยวกับ Identity Service API",
     "Decentralised, encrypted chat & collaboration powered by [matrix]": "ระบบแชทและประสานงาน ไร้ศูนย์กลางและเข้ารหัสได้ โดยใช้เทคโนโลยีจาก [matrix]",
-    "General discussion about Matrix and Riot": "พูดคุยเรื่องทั่วไป ทั้ง Matrix และ Riot"
+    "General discussion about Matrix and Riot": "พูดคุยเรื่องทั่วไป ทั้ง Matrix และ Riot",
+    "Your Riot configuration contains invalid JSON. Please correct the problem and reload the page.": "การตั้งค่า Riot ของคุณมี JSON ที่ไม่ถูกต้อง โปรดแก้ปัญหาและโหลดเพจอีกครั้ง",
+    "The message from the parser is: %(message)s": "ข้อความจากparserคือ:%(message)s",
+    "Invalid JSON": "JSON ไม่ถูกต้อง",
+    "Your Riot is misconfigured": "Riotของคุณตั้งค่าไม่ถูกต้อง",
+    "Sign In": "เข้าสู่ระบบ",
+    "Create Account": "สร้างบัญชี",
+    "Need help?": "ต้องการความช่วยเหลือ?",
+    "Explore rooms": "สำรวจห้อง"
 }

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: [