Merge branch 'develop' into johannes/webpack-cli-4.10.0

.github/workflows/build.yml

@@ -36,6 +36,9 @@ jobs:
               with:
                   cache: "yarn"
 
+            # Workaround for yarn install timeouts, especially on Windows
+            - run: yarn config set network-timeout 300000
+
             - name: Install Dependencies
               run: "./scripts/layered.sh"
 

.github/workflows/docs.yml

@@ -0,0 +1,102 @@
+name: Deploy documentation
+
+on:
+    push:
+        branches: [develop]
+    workflow_dispatch: {}
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+concurrency:
+    group: "pages"
+    cancel-in-progress: false
+
+jobs:
+    build:
+        name: GitHub Pages
+        runs-on: ubuntu-latest
+        steps:
+            - name: Fetch element-desktop
+              uses: actions/checkout@v4
+              with:
+                  repository: vector-im/element-desktop
+                  path: element-desktop
+
+            - name: Fetch element-web
+              uses: actions/checkout@v4
+              with:
+                  path: element-web
+
+            - name: Fetch matrix-react-sdk
+              uses: actions/checkout@v4
+              with:
+                  repository: matrix-org/matrix-react-sdk
+                  path: matrix-react-sdk
+
+            - name: Fetch matrix-js-sdk
+              uses: actions/checkout@v4
+              with:
+                  repository: matrix-org/matrix-js-sdk
+                  path: matrix-js-sdk
+
+            - name: Setup mdBook
+              uses: peaceiris/actions-mdbook@v1
+              with:
+                  mdbook-version: "0.4.10"
+
+            - name: Install mdbook-combiner
+              run: cargo install mdbook-combiner
+
+            - name: Prepare docs
+              run: |
+                  mkdir docs
+
+                  mv element-desktop/README.md element-desktop/docs/
+                  mv element-desktop/docs "docs/Element Desktop"
+
+                  mv element-web/README.md element-web/docs/
+                  mv element-web/docs "docs/Element Web"
+
+                  mv matrix-react-sdk/README.md matrix-react-sdk/docs/
+                  mv matrix-react-sdk/docs "docs/Matrix React SDK"
+
+                  mv matrix-js-sdk/README.md matrix-js-sdk/docs/
+                  mv matrix-js-sdk/docs "docs/Matrix JS SDK"
+
+                  sed -i -e 's/\.\.\/README.md/README.md/' docs/**/SUMMARY.md
+
+                  mdbook-combiner -m docs
+                  sed -i -E 's/^\t# (.+)$/- [\1]()/gm;t' SUMMARY.md
+                  sed -i -E 's/^- \[(.+)]\(<>\)$/---\n# \1/gm;t' SUMMARY.md
+                  sed -i -E 's/\t- \[Introduction]/- [Introduction]/gm;t' SUMMARY.md
+
+                  cat <<EOF > docs/SUMMARY.md
+                  # Summary
+                  - [Introduction](<Element Web/README.md>)
+
+                  EOF
+                  cat SUMMARY.md >> docs/SUMMARY.md
+
+                  mv element-web/book.toml .
+
+            - name: Build docs
+              run: mdbook build
+
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v2
+              with:
+                  path: ./book
+
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        needs: build
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v2

.github/workflows/localazy_upload.yaml

@@ -3,7 +3,7 @@ on:
     push:
         branches: [develop]
         paths:
-            - "src/strings/i18n/en_EN.json"
+            - "src/i18n/strings/en_EN.json"
 jobs:
     upload:
         uses: matrix-org/matrix-web-i18n/.github/workflows/localazy_upload.yaml@main

.github/workflows/triage-assigned.yml

@@ -10,7 +10,7 @@ jobs:
         if: |
             contains(github.event.issue.assignees.*.login, 't3chguy') ||
             contains(github.event.issue.assignees.*.login, 'andybalaam') ||
-            contains(github.event.issue.assignees.*.login, 'justjanne')
+            contains(github.event.issue.assignees.*.login, 'MidhunSureshR')
         steps:
             - uses: actions/add-to-project@main
               with:

.github/workflows/triage-labelled.yml

@@ -20,7 +20,8 @@ jobs:
             contains(github.event.issue.labels.*.name, 'A-Video-Rooms') ||
             contains(github.event.issue.labels.*.name, 'A-Message-Starring') ||
             contains(github.event.issue.labels.*.name, 'A-Rich-Text-Editor') ||
-            contains(github.event.issue.labels.*.name, 'A-Element-Call')
+            contains(github.event.issue.labels.*.name, 'A-Element-Call') ||
+            contains(github.event.issue.labels.*.name, 'A-Element-R')
         steps:
             - uses: actions/github-script@v6
               with:
@@ -136,3 +137,26 @@ jobs:
               with:
                   project-url: https://github.com/orgs/vector-im/projects/101
                   github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
+
+    element_r:
+        name: Add Element R issues to Crypto Team board
+        runs-on: ubuntu-latest
+        if: >
+            contains(github.event.issue.labels.*.name, 'A-Element-R')
+        steps:
+            - id: add_to_project
+              uses: actions/add-to-project@v0.5.0
+              with:
+                  project-url: ${{ env.PROJECT_URL }}
+                  github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
+
+            - id: set_fields
+              uses: titoportas/update-project-fields@020b5aa9db8f9501d4b16d6417c2132ff26e6279 # v0.1.0
+              with:
+                  project-url: ${{ env.PROJECT_URL }}
+                  github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
+                  item-id: ${{ steps.add_to_project.outputs.itemId }} # Use the item-id output of the previous step
+                  field-keys: Workstream,module
+                  field-values: Element-R,web
+        env:
+            PROJECT_URL: https://github.com/orgs/vector-im/projects/76

.gitignore

@@ -27,3 +27,4 @@ electron/pub
 # Auto-generated file
 /src/modules.ts
 /build_config.yaml
+/book

book.toml

@@ -0,0 +1,26 @@
+# Documentation for possible options in this file is at
+# https://rust-lang.github.io/mdBook/format/config.html
+[book]
+title = "Element Web & Desktop"
+authors = ["New Vector Ltd.", "The Matrix.org Foundation C.I.C."]
+language = "en"
+multilingual = false
+
+# The directory that documentation files are stored in
+src = "docs"
+
+[build]
+# Prevent markdown pages from being automatically generated when they're
+# linked to in SUMMARY.md
+create-missing = false
+
+[output.html]
+# Remove the numbers that appear before each item in the sidebar, as they can
+# get quite messy as we nest deeper
+no-section-label = true
+
+# The source code URL of the repository
+git-repository-url = "https://github.com/vector-im/element-web"
+
+# The path that the docs are hosted on
+site-url = "/element-web/"

docs/SUMMARY.md

@@ -0,0 +1,39 @@
+# Summary
+
+-   [Introduction](../README.md)
+
+# Usage
+
+-   [Betas](betas.md)
+-   [Labs](labs.md)
+
+# Setup
+
+-   [Config](config.md)
+-   [Custom home page](custom-home.md)
+-   [Kubernetes](kubernetes.md)
+-   [Jitsi](jitsi.md)
+-   [Encryption](e2ee.md)
+
+# Build
+
+-   [Customisations](customisations.md)
+-   [Modules](modules.md)
+-   [Native Node modules](native-node-modules.md)
+
+# Contribution
+
+-   [Choosing an issue](choosing-an-issue.md)
+-   [Translation](translating.md)
+-   [Netlify builds](pr-previews.md)
+-   [Code review](review.md)
+
+# Development
+
+-   [App load order](app-load.md)
+-   [Translation](translating-dev.md)
+-   [Theming](theming.md)
+-   [Memory profiling](memory-profiles-and-leaks.md)
+-   [Jitsi](jitsi-dev.md)
+-   [Feature flags](feature-flags.md)
+-   [OIDC and delegated authentication](oidc.md)

docs/config.md

@@ -54,8 +54,8 @@ One of the following options **must** be supplied:
    being optional.
 
 If both `default_server_config` and `default_server_name` are used, Element will try to look up the connection
-infomation using `.well-known`, and if that fails, take `default_server_config` as the homeserver connection
-infomation.
+information using `.well-known`, and if that fails, take `default_server_config` as the homeserver connection
+information.
 
 ## Labs flags
 

docs/e2ee.md

@@ -36,7 +36,7 @@ When `force_disable` is true:
 -   any `io.element.e2ee.default` value will be disregarded.
 
 Note: If the server is configured to forcibly enable encryption for some or all rooms,
-this behaviour will be overriden.
+this behaviour will be overridden.
 
 # Secure backup
 

docs/labs.md

@@ -128,7 +128,7 @@ Enables rendering of MD / HTML in room topics.
 
 Configures Element to use a new cryptography implementation based on the [matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk).
 
-This setting is (currently) _sticky_ to a user's session: it only takes effect when the user logs in to a new session. Likewise, even after disabling the setting in `config.json`, the Rust implemention will remain in use until users log out.
+This setting is (currently) _sticky_ to a user's session: it only takes effect when the user logs in to a new session. Likewise, even after disabling the setting in `config.json`, the Rust implementation will remain in use until users log out.
 
 ## New room header & details (`feature_new_room_decoration_ui`) [In Development]
 

docs/oidc.md

@@ -0,0 +1,43 @@
+# OIDC and delegated authentication
+
+## Compatibility/OIDC-aware mode
+
+[MSC2965: OIDC provider discovery](https://github.com/matrix-org/matrix-spec-proposals/pull/2965)
+[MSC3824: OIDC aware clients](https://github.com/matrix-org/matrix-spec-proposals/pull/3824)
+This mode uses an SSO flow to gain a `loginToken` from the authentication provider, then continues with SSO login.
+Element Web uses [MSC2965: OIDC provider discovery](https://github.com/matrix-org/matrix-spec-proposals/pull/2965) to discover the configured provider.
+Wherever valid MSC2965 configuration is discovered, OIDC-aware login flow will be the only option offered.
+
+## (🧪Experimental) OIDC-native flow
+
+Can be enabled by a config-level-only setting in `config.json`
+
+```json
+{
+    "features": {
+        "feature_oidc_native_flow": true
+    }
+}
+```
+
+See https://areweoidcyet.com/client-implementation-guide/ for implementation details.
+
+Element Web uses [MSC2965: OIDC provider discovery](https://github.com/matrix-org/matrix-spec-proposals/pull/2965) to discover the configured provider.
+Where OIDC native login flow is enabled and valid MSC2965 configuration is discovered, OIDC native login flow will be the only login option offered.
+Element Web will attempt to [dynamically register](https://openid.net/specs/openid-connect-registration-1_0.html) with the configured OP.
+Then, authentication will be completed [as described here](https://areweoidcyet.com/client-implementation-guide/).
+
+#### Statically configured OIDC clients
+
+Clients that are already registered with the OP can configure their `client_id` in `config.json`.
+Where static configuration exists for the OP dynamic client registration will not be attempted.
+
+```json
+{
+    "oidc_static_clients": {
+        "https://dummyoidcprovider.com/": {
+            "client_id": "abc123"
+        }
+    }
+}
+```

docs/translating-dev.md

@@ -70,7 +70,7 @@ There you can also require all translations to be redone if the meaning of the s
 1. Add it to the array in `_t` for example `_t(TKEY, {variable: this.variable})`
 1. Add the variable inside the string. The syntax for variables is `%(variable)s`. Please note the _s_ at the end. The name of the variable has to match the previous used name.
 
--   You can use the special `count` variable to choose between multiple versions of the same string, in order to get the correct pluralization. E.g. `_t('You have %(count)s new messages', { count: 2 })` would show 'You have 2 new messages', while `_t('You have %(count)s new messages', { count: 1 })` would show 'You have one new message' (assuming a singular version of the string has been added to the translation file. See above). Passing in `count` is much prefered over having an if-statement choose the correct string to use, because some languages have much more complicated plural rules than english (e.g. they might need a completely different form if there are three things rather than two).
+-   You can use the special `count` variable to choose between multiple versions of the same string, in order to get the correct pluralization. E.g. `_t('You have %(count)s new messages', { count: 2 })` would show 'You have 2 new messages', while `_t('You have %(count)s new messages', { count: 1 })` would show 'You have one new message' (assuming a singular version of the string has been added to the translation file. See above). Passing in `count` is much preferred over having an if-statement choose the correct string to use, because some languages have much more complicated plural rules than english (e.g. they might need a completely different form if there are three things rather than two).
 -   If you want to translate text that includes e.g. hyperlinks or other HTML you have to also use tag substitution, e.g. `_t('<a>Click here!</a>', {}, { 'a': (sub) => <a>{sub}</a> })`. If you don't do the tag substitution you will end up showing literally '<a>' rather than making a hyperlink.
 -   You can also use React components with normal variable substitution if you want to insert HTML markup, e.g. `_t('Your email address is %(emailAddress)s', { emailAddress: <i>{userEmailAddress}</i> })`.