Compare commits

..

1 Commits

Author SHA1 Message Date
Kat Gerasimova
de8b99de3d Fix indentation in automation
Fix indention and capitalisation
2022-09-01 15:30:49 +01:00
230 changed files with 9662 additions and 13571 deletions

View File

@@ -23,7 +23,7 @@ indent_size = 4
trim_trailing_whitespace = true trim_trailing_whitespace = true
[*.{yml,yaml}] [*.{yml,yaml}]
indent_size = 4 indent_size = 2
[package.json] [package.json]
indent_size = 2 indent_size = 2

View File

@@ -1,72 +0,0 @@
module.exports = {
plugins: ["matrix-org"],
extends: ["./.eslintrc.js"],
parserOptions: {
project: ["./tsconfig.module_system.json"],
},
overrides: [
{
files: ["module_system/**/*.{ts,tsx}"],
extends: ["plugin:matrix-org/typescript", "plugin:matrix-org/react"],
// NOTE: These rules are frozen and new rules should not be added here.
// New changes belong in https://github.com/matrix-org/eslint-plugin-matrix-org/
rules: {
// Things we do that break the ideal style
"prefer-promise-reject-errors": "off",
"quotes": "off",
// We disable this while we're transitioning
"@typescript-eslint/no-explicit-any": "off",
// We're okay with assertion errors when we ask for them
"@typescript-eslint/no-non-null-assertion": "off",
// Ban matrix-js-sdk/src imports in favour of matrix-js-sdk/src/matrix imports to prevent unleashing hell.
"no-restricted-imports": [
"error",
{
paths: [
{
name: "matrix-js-sdk",
message: "Please use matrix-js-sdk/src/matrix instead",
},
{
name: "matrix-js-sdk/",
message: "Please use matrix-js-sdk/src/matrix instead",
},
{
name: "matrix-js-sdk/src",
message: "Please use matrix-js-sdk/src/matrix instead",
},
{
name: "matrix-js-sdk/src/",
message: "Please use matrix-js-sdk/src/matrix instead",
},
{
name: "matrix-js-sdk/src/index",
message: "Please use matrix-js-sdk/src/matrix instead",
},
{
name: "matrix-react-sdk",
message: "Please use matrix-react-sdk/src/index instead",
},
{
name: "matrix-react-sdk/",
message: "Please use matrix-react-sdk/src/index instead",
},
],
patterns: [
{
group: ["matrix-js-sdk/lib", "matrix-js-sdk/lib/", "matrix-js-sdk/lib/**"],
message: "Please use matrix-js-sdk/src/* instead",
},
{
group: ["matrix-react-sdk/lib", "matrix-react-sdk/lib/", "matrix-react-sdk/lib/**"],
message: "Please use matrix-react-sdk/src/* instead",
},
],
},
],
},
},
],
};

View File

@@ -1,94 +1,72 @@
module.exports = { module.exports = {
plugins: ["matrix-org"], plugins: ["matrix-org"],
extends: ["plugin:matrix-org/babel", "plugin:matrix-org/react"], extends: [
parserOptions: { "plugin:matrix-org/babel",
project: ["./tsconfig.json"], "plugin:matrix-org/react",
}, ],
env: { env: {
browser: true, browser: true,
node: true, node: true,
}, },
rules: { rules: {
// Things we do that break the ideal style // Things we do that break the ideal style
quotes: "off", "quotes": "off",
}, },
settings: { settings: {
react: { react: {
version: "detect", version: 'detect'
}, }
}, },
overrides: [ overrides: [{
{ files: ["src/**/*.{ts,tsx}", "module_system/**/*.{ts,tsx}"],
files: ["src/**/*.{ts,tsx}", "test/**/*.{ts,tsx}"], extends: [
extends: ["plugin:matrix-org/typescript", "plugin:matrix-org/react"], "plugin:matrix-org/typescript",
// NOTE: These rules are frozen and new rules should not be added here. "plugin:matrix-org/react",
// New changes belong in https://github.com/matrix-org/eslint-plugin-matrix-org/ ],
rules: { // NOTE: These rules are frozen and new rules should not be added here.
// Things we do that break the ideal style // New changes belong in https://github.com/matrix-org/eslint-plugin-matrix-org/
"prefer-promise-reject-errors": "off", rules: {
"quotes": "off", // Things we do that break the ideal style
"prefer-promise-reject-errors": "off",
"quotes": "off",
// We disable this while we're transitioning // We disable this while we're transitioning
"@typescript-eslint/no-explicit-any": "off", "@typescript-eslint/no-explicit-any": "off",
// We're okay with assertion errors when we ask for them // We're okay with assertion errors when we ask for them
"@typescript-eslint/no-non-null-assertion": "off", "@typescript-eslint/no-non-null-assertion": "off",
// Ban matrix-js-sdk/src imports in favour of matrix-js-sdk/src/matrix imports to prevent unleashing hell. // Ban matrix-js-sdk/src imports in favour of matrix-js-sdk/src/matrix imports to prevent unleashing hell.
"no-restricted-imports": [ "no-restricted-imports": ["error", {
"error", "paths": [{
{ "name": "matrix-js-sdk",
paths: [ "message": "Please use matrix-js-sdk/src/matrix instead",
{ }, {
name: "matrix-js-sdk", "name": "matrix-js-sdk/",
message: "Please use matrix-js-sdk/src/matrix instead", "message": "Please use matrix-js-sdk/src/matrix instead",
}, }, {
{ "name": "matrix-js-sdk/src",
name: "matrix-js-sdk/", "message": "Please use matrix-js-sdk/src/matrix instead",
message: "Please use matrix-js-sdk/src/matrix instead", }, {
}, "name": "matrix-js-sdk/src/",
{ "message": "Please use matrix-js-sdk/src/matrix instead",
name: "matrix-js-sdk/src", }, {
message: "Please use matrix-js-sdk/src/matrix instead", "name": "matrix-js-sdk/src/index",
}, "message": "Please use matrix-js-sdk/src/matrix instead",
{ }, {
name: "matrix-js-sdk/src/", "name": "matrix-react-sdk",
message: "Please use matrix-js-sdk/src/matrix instead", "message": "Please use matrix-react-sdk/src/index instead",
}, }, {
{ "name": "matrix-react-sdk/",
name: "matrix-js-sdk/src/index", "message": "Please use matrix-react-sdk/src/index instead",
message: "Please use matrix-js-sdk/src/matrix instead", }],
}, "patterns": [{
{ "group": ["matrix-js-sdk/lib", "matrix-js-sdk/lib/", "matrix-js-sdk/lib/**"],
name: "matrix-react-sdk", "message": "Please use matrix-js-sdk/src/* instead",
message: "Please use matrix-react-sdk/src/index instead", }, {
}, "group": ["matrix-react-sdk/lib", "matrix-react-sdk/lib/", "matrix-react-sdk/lib/**"],
{ "message": "Please use matrix-react-sdk/src/* instead",
name: "matrix-react-sdk/", }],
message: "Please use matrix-react-sdk/src/index instead", }],
},
],
patterns: [
{
group: ["matrix-js-sdk/lib", "matrix-js-sdk/lib/", "matrix-js-sdk/lib/**"],
message: "Please use matrix-js-sdk/src/* instead",
},
{
group: ["matrix-react-sdk/lib", "matrix-react-sdk/lib/", "matrix-react-sdk/lib/**"],
message: "Please use matrix-react-sdk/src/* instead",
},
],
},
],
},
}, },
{ }],
files: ["test/**/*.{ts,tsx}"],
rules: {
// We don't need super strict typing in test utilities
"@typescript-eslint/explicit-function-return-type": "off",
"@typescript-eslint/explicit-member-accessibility": "off",
"@typescript-eslint/ban-ts-comment": "off",
},
},
],
}; };

View File

@@ -1,2 +0,0 @@
# prettier
7921a6cbf86b035d2b0c1daecb4c24beaf5a5abc

5
.github/CODEOWNERS vendored
View File

@@ -1,4 +1 @@
* @vector-im/element-web * @vector-im/element-web
/.github/workflows/** @vector-im/element-web-app-team
/package.json @vector-im/element-web-app-team
/yarn.lock @vector-im/element-web-app-team

View File

@@ -2,75 +2,75 @@ name: Bug report for the Element desktop app (not in a browser)
description: File a bug report if you are using the desktop Element application. description: File a bug report if you are using the desktop Element application.
labels: [T-Defect] labels: [T-Defect]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for taking the time to fill out this bug report! Thanks for taking the time to fill out this bug report!
Please report security issues by email to security@matrix.org Please report security issues by email to security@matrix.org
- type: textarea - type: textarea
id: reproduction-steps id: reproduction-steps
attributes: attributes:
label: Steps to reproduce label: Steps to reproduce
description: Please attach screenshots, videos or logs if you can. description: Please attach screenshots, videos or logs if you can.
placeholder: Tell us what you see! placeholder: Tell us what you see!
value: | value: |
1. Where are you starting? What can you see? 1. Where are you starting? What can you see?
2. What do you click? 2. What do you click?
3. More steps… 3. More steps…
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: result id: result
attributes: attributes:
label: Outcome label: Outcome
placeholder: Tell us what went wrong placeholder: Tell us what went wrong
value: | value: |
#### What did you expect? #### What did you expect?
#### What happened instead? #### What happened instead?
validations: validations:
required: true required: true
- type: input - type: input
id: os id: os
attributes: attributes:
label: Operating system label: Operating system
placeholder: Windows, macOS, Ubuntu, Arch Linux… placeholder: Windows, macOS, Ubuntu, Arch Linux…
validations: validations:
required: false required: false
- type: input - type: input
id: version id: version
attributes: attributes:
label: Application version label: Application version
description: You can find the version information in Settings -> Help & About. description: You can find the version information in Settings -> Help & About.
placeholder: e.g. Element version 1.7.34, olm version 3.2.3 placeholder: e.g. Element version 1.7.34, olm version 3.2.3
validations: validations:
required: false required: false
- type: input - type: input
id: source id: source
attributes: attributes:
label: How did you install the app? label: How did you install the app?
description: Where did you install the app from? Please give a link or a description. description: Where did you install the app from? Please give a link or a description.
placeholder: e.g. From https://element.io/get-started placeholder: e.g. From https://element.io/get-started
validations: validations:
required: false required: false
- type: input - type: input
id: homeserver id: homeserver
attributes: attributes:
label: Homeserver label: Homeserver
description: | description: |
Which server is your account registered on? If it is a local or non-public homeserver, please tell us what is the homeserver implementation (ex: Synapse/Dendrite/etc.) and the version. Which server is your account registered on? If it is a local or non-public homeserver, please tell us what is the homeserver implementation (ex: Synapse/Dendrite/etc.) and the version.
placeholder: e.g. matrix.org or Synapse 1.50.0rc1 placeholder: e.g. matrix.org or Synapse 1.50.0rc1
validations: validations:
required: false required: false
- type: dropdown - type: dropdown
id: rageshake id: rageshake
attributes: attributes:
label: Will you send logs? label: Will you send logs?
description: | description: |
Did you know that you can send a /rageshake command from your application to submit logs for this issue? Trigger the defect, then type `/rageshake` into the message input area followed by a description of the problem and send the command. You will be able to add a link to this defect report and submit anonymous logs to the developers. Did you know that you can send a /rageshake command from your application to submit logs for this issue? Trigger the defect, then type `/rageshake` into the message input area followed by a description of the problem and send the command. You will be able to add a link to this defect report and submit anonymous logs to the developers.
options: options:
- "Yes" - 'Yes'
- "No" - 'No'
validations: validations:
required: true required: true

View File

@@ -2,83 +2,83 @@ name: Bug report for Element Web (in browser)
description: File a bug report if you are using Element in a web browser like Firefox, Chrome, Edge, and so on. description: File a bug report if you are using Element in a web browser like Firefox, Chrome, Edge, and so on.
labels: [T-Defect] labels: [T-Defect]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for taking the time to fill out this bug report! Thanks for taking the time to fill out this bug report!
Please report security issues by email to security@matrix.org Please report security issues by email to security@matrix.org
- type: textarea - type: textarea
id: reproduction-steps id: reproduction-steps
attributes: attributes:
label: Steps to reproduce label: Steps to reproduce
description: Please attach screenshots, videos or logs if you can. description: Please attach screenshots, videos or logs if you can.
placeholder: Tell us what you see! placeholder: Tell us what you see!
value: | value: |
1. Where are you starting? What can you see? 1. Where are you starting? What can you see?
2. What do you click? 2. What do you click?
3. More steps… 3. More steps…
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: result id: result
attributes: attributes:
label: Outcome label: Outcome
placeholder: Tell us what went wrong placeholder: Tell us what went wrong
value: | value: |
#### What did you expect? #### What did you expect?
#### What happened instead? #### What happened instead?
validations: validations:
required: true required: true
- type: input - type: input
id: os id: os
attributes: attributes:
label: Operating system label: Operating system
placeholder: Windows, macOS, Ubuntu, Arch Linux… placeholder: Windows, macOS, Ubuntu, Arch Linux…
validations: validations:
required: false required: false
- type: input - type: input
id: browser id: browser
attributes: attributes:
label: Browser information label: Browser information
description: Which browser are you using? Which version? description: Which browser are you using? Which version?
placeholder: e.g. Chromium Version 92.0.4515.131 placeholder: e.g. Chromium Version 92.0.4515.131
validations: validations:
required: false required: false
- type: input - type: input
id: webapp-url id: webapp-url
attributes: attributes:
label: URL for webapp label: URL for webapp
description: Which URL are you using to access the webapp? If a private server, tell us what version of Element Web you are using. description: Which URL are you using to access the webapp? If a private server, tell us what version of Element Web you are using.
placeholder: e.g. develop.element.io, app.element.io placeholder: e.g. develop.element.io, app.element.io
validations: validations:
required: false required: false
- type: input - type: input
id: version id: version
attributes: attributes:
label: Application version label: Application version
description: You can find the version information in Settings -> Help & About. description: You can find the version information in Settings -> Help & About.
placeholder: e.g. Element version 1.7.34, olm version 3.2.3 placeholder: e.g. Element version 1.7.34, olm version 3.2.3
validations: validations:
required: false required: false
- type: input - type: input
id: homeserver id: homeserver
attributes: attributes:
label: Homeserver label: Homeserver
description: | description: |
Which server is your account registered on? If it is a local or non-public homeserver, please tell us what is the homeserver implementation (ex: Synapse/Dendrite/etc.) and the version. Which server is your account registered on? If it is a local or non-public homeserver, please tell us what is the homeserver implementation (ex: Synapse/Dendrite/etc.) and the version.
placeholder: e.g. matrix.org or Synapse 1.50.0rc1 placeholder: e.g. matrix.org or Synapse 1.50.0rc1
validations: validations:
required: false required: false
- type: dropdown - type: dropdown
id: rageshake id: rageshake
attributes: attributes:
label: Will you send logs? label: Will you send logs?
description: | description: |
Did you know that you can send a /rageshake command from the web application to submit logs for this issue? Trigger the defect, then type `/rageshake` into the message input area followed by a description of the problem and send the command. You will be able to add a link to this defect report and submit anonymous logs to the developers. Did you know that you can send a /rageshake command from the web application to submit logs for this issue? Trigger the defect, then type `/rageshake` into the message input area followed by a description of the problem and send the command. You will be able to add a link to this defect report and submit anonymous logs to the developers.
options: options:
- "Yes" - 'Yes'
- "No" - 'No'
validations: validations:
required: true required: true

View File

@@ -1,5 +1,5 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: Questions & support - name: Questions & support
url: https://matrix.to/#/#element-web:matrix.org url: https://matrix.to/#/#element-web:matrix.org
about: Please ask and answer questions here. about: Please ask and answer questions here.

View File

@@ -2,35 +2,35 @@ name: Enhancement request
description: Do you have a suggestion or feature request? description: Do you have a suggestion or feature request?
labels: [T-Enhancement] labels: [T-Enhancement]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thank you for taking the time to propose an enhancement to an existing feature. If you would like to propose a new feature or a major cross-platform change, please [start a discussion here](https://github.com/vector-im/element-meta/discussions/new?category=ideas). Thank you for taking the time to propose a new feature or make a suggestion.
- type: textarea - type: textarea
id: usecase id: usecase
attributes: attributes:
label: Your use case label: Your use case
description: What would you like to be able to do? Please feel welcome to include screenshots or mock ups. description: What would you like to be able to do? Please feel welcome to include screenshots or mock ups.
placeholder: Tell us what you would like to do! placeholder: Tell us what you would like to do!
value: | value: |
#### What would you like to do? #### What would you like to do?
#### Why would you like to do it? #### Why would you like to do it?
#### How would you like to achieve it? #### How would you like to achieve it?
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: alternative id: alternative
attributes: attributes:
label: Have you considered any alternatives? label: Have you considered any alternatives?
placeholder: A clear and concise description of any alternative solutions or features you've considered. placeholder: A clear and concise description of any alternative solutions or features you've considered.
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: additional-context id: additional-context
attributes: attributes:
label: Additional context label: Additional context
placeholder: Is there anything else you'd like to add? placeholder: Is there anything else you'd like to add?
validations: validations:
required: false required: false

View File

@@ -2,9 +2,9 @@
## Checklist ## Checklist
- [ ] Tests written for new code (and old code if feasible) * [ ] Tests written for new code (and old code if feasible)
- [ ] Linter and other CI checks pass * [ ] Linter and other CI checks pass
- [ ] Sign-off given on the changes (see [CONTRIBUTING.md](https://github.com/vector-im/element-web/blob/develop/CONTRIBUTING.md)) * [ ] Sign-off given on the changes (see [CONTRIBUTING.md](https://github.com/vector-im/element-web/blob/develop/CONTRIBUTING.md))
<!-- <!--
If you would like to specify text for the changelog entry other than your PR title, add the following: If you would like to specify text for the changelog entry other than your PR title, add the following:

13
.github/cfp_headers vendored
View File

@@ -1,13 +0,0 @@
/*
! Access-Control-Allow-Origin
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
Content-Security-Policy: frame-ancestors 'self'
Strict-Transport-Security: max-age=31536000; includeSubDomains; preload
/version
Content-Type: text/plain
/apple-app-site-association
Content-Type: application/json

View File

@@ -1,4 +1,6 @@
{ {
"$schema": "https://docs.renovatebot.com/renovate-schema.json", "$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["github>matrix-org/renovate-config-element-web"] "extends": [
"github>matrix-org/renovate-config-element-web"
]
} }

View File

@@ -1,30 +1,30 @@
name: Backport name: Backport
on: on:
pull_request_target: pull_request_target:
types: types:
- closed - closed
- labeled - labeled
branches: branches:
- develop - develop
jobs: jobs:
backport: backport:
name: Backport name: Backport
runs-on: ubuntu-latest runs-on: ubuntu-latest
# Only react to merged PRs for security reasons. # Only react to merged PRs for security reasons.
# See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target. # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
if: > if: >
github.event.pull_request.merged github.event.pull_request.merged
&& ( && (
github.event.action == 'closed' github.event.action == 'closed'
|| ( || (
github.event.action == 'labeled' github.event.action == 'labeled'
&& contains(github.event.label.name, 'backport') && contains(github.event.label.name, 'backport')
) )
) )
steps: steps:
- uses: tibdex/backport@9565281eda0731b1d20c4025c43339fb0a23812e # v2 - uses: tibdex/backport@v2
with: with:
labels_template: "<%= JSON.stringify([...labels, 'X-Release-Blocker']) %>" labels_template: "<%= JSON.stringify(labels) %>"
# We can't use GITHUB_TOKEN here or CI won't run on the new PR # We can't use GITHUB_TOKEN here or CI won't run on the new PR
github_token: ${{ secrets.ELEMENT_BOT_TOKEN }} github_token: ${{ secrets.ELEMENT_BOT_TOKEN }}

View File

@@ -1,26 +1,26 @@
name: Build name: Build
on: on:
pull_request: {} pull_request: { }
push: push:
branches: [master] branches: [ master ]
# develop pushes and repository_dispatch handled in build_develop.yaml # develop pushes and repository_dispatch handled in build_develop.yaml
env: env:
# These must be set for fetchdep.sh to get the right branch # These must be set for fetchdep.sh to get the right branch
REPOSITORY: ${{ github.repository }} REPOSITORY: ${{ github.repository }}
PR_NUMBER: ${{ github.event.pull_request.number }} PR_NUMBER: ${{ github.event.pull_request.number }}
jobs: jobs:
build: build:
name: "Build" name: "Build"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v2
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
cache: "yarn" cache: 'yarn'
- name: Install Dependencies - name: Install Dependencies
run: "./scripts/layered.sh" run: "./scripts/layered.sh"
- name: Build - name: Build
run: "yarn build" run: "yarn build"

View File

@@ -1,56 +0,0 @@
name: Build Debian package
on:
release:
types: [published]
concurrency: ${{ github.workflow }}
jobs:
build:
name: Build package
if: github.event.release.prerelease == false
environment: packages.element.io
runs-on: ubuntu-latest
env:
R2_INCOMING_BUCKET: ${{ vars.R2_INCOMING_BUCKET }}
R2_URL: ${{ vars.CF_R2_S3_API }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
mkdir -p /tmp/element-web-debian/DEBIAN
cp -R debian/ /tmp/element-web-debian/DEBIAN/
mkdir -p /tmp/element-web-debian/usr/share/element-web/
wget https://github.com/vector-im/element-web/releases/download/$VERSION/element-$VERSION.tar.gz
mv element-* /tmp/element-web-debian/usr/share/element-web
mv debian/usr/share/element-web/config.sample.json /tmp/element-web-debian/usr/share/element-web/config.json
env:
VERSION: ${{ github.ref_name }}
- name: Build deb package
run: |
VERSION=$(cat package.json | jq -r .version)
chmod -R u=rw,go=r /tmp/element-web-debian/usr/share/element-web/
dpkg-deb -Zxz --root-owner-group -VVersion=$VERSION --build /tmp/element-web-debian element-web.deb
# For now just upload the artifact to github
- uses: actions/upload-artifact@v3
with:
name: debs
path: "*.deb"
retention-days: 14
#- name: Upload incoming deb
# run: aws s3 cp element-io-archive-keyring.deb "s3://$R2_INCOMING_BUCKET" --endpoint-url "$R2_URL" --region auto
# env:
# AWS_ACCESS_KEY_ID: ${{ secrets.CF_R2_ACCESS_KEY_ID }}
# AWS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_TOKEN }}
#reprepro:
# needs: build
# name: Run reprepro
# if: inputs.deploy && github.event.release.prerelease == false
# uses: ./.github/workflows/reprepro.yaml
# secrets: inherit
# with:
# incoming: element-web.deb

View File

@@ -1,118 +1,53 @@
# Separate to the main build workflow for access to develop # Separate to the main build workflow for access to develop
# environment secrets, largely similar to build.yaml. # environment secrets, largely similar to build.yaml.
name: Build and Deploy develop name: Build and Package develop
on: on:
push: push:
branches: [develop] branches: [ develop ]
repository_dispatch: repository_dispatch:
types: [element-web-notify] types: [ element-web-notify ]
concurrency: concurrency:
group: ${{ github.repository_owner }}-${{ github.workflow }}-${{ github.ref_name }} group: ${{ github.workflow }}-${{ github.event.workflow_run.head_branch }}
cancel-in-progress: true cancel-in-progress: true
jobs: jobs:
build: build:
name: "Build & Deploy develop.element.io" name: "Build & Upload source maps to Sentry"
# Only respect triggers from our develop branch, ignore that of forks # Only respect triggers from our develop branch, ignore that of forks
if: github.repository == 'vector-im/element-web' if: github.repository == 'vector-im/element-web'
runs-on: ubuntu-latest runs-on: ubuntu-latest
environment: develop environment: develop
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
cache: 'yarn'
- name: Install Dependencies
run: "./scripts/layered.sh"
- name: Build, Package & Upload sourcemaps
run: "./scripts/ci_package.sh"
env: env:
R2_BUCKET: "element-web-develop" SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
R2_URL: ${{ vars.CF_R2_S3_API }} SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
R2_PUBLIC_URL: "https://element-web-develop.element.io" SENTRY_URL: ${{ secrets.SENTRY_URL }}
steps: SENTRY_ORG: element
- uses: actions/checkout@v3 SENTRY_PROJECT: riot-web
- uses: actions/setup-node@v3 - run: mv dist/element-*.tar.gz webapp.tar.gz
with:
cache: "yarn" - name: Wait for other steps to succeed
uses: lewagon/wait-on-check-action@v1.0.0
with:
ref: ${{ github.ref }}
running-workflow-name: 'Build & Upload source maps to Sentry'
repo-token: ${{ secrets.GITHUB_TOKEN }}
wait-interval: 10
check-regexp: ^((?!SonarQube|issues|board).)*$
- name: Install Dependencies - uses: actions/upload-artifact@v3
run: "./scripts/layered.sh" with:
name: webapp
- name: Build, Package & Upload sourcemaps path: webapp.tar.gz
run: "./scripts/ci_package.sh" retention-days: 1
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
SENTRY_URL: ${{ secrets.SENTRY_URL }}
SENTRY_ORG: element
SENTRY_PROJECT: riot-web
# We only deploy the latest bundles to Cloudflare Pages and use _redirects to fallback to R2 for
# older ones. This redirect means that 'self' is insufficient in the CSP,
# and we have to add the R2 URL.
# Once Cloudflare redirects support proxying mode we will be able to ditch this.
# See Proxying in support table at https://developers.cloudflare.com/pages/platform/redirects
CSP_EXTRA_SOURCE: ${{ env.R2_PUBLIC_URL }}
- run: mv dist/element-*.tar.gz dist/develop.tar.gz
- uses: actions/upload-artifact@v3
with:
name: webapp
path: dist/develop.tar.gz
retention-days: 1
- name: Extract webapp
run: |
mkdir _deploy
tar xf dist/develop.tar.gz -C _deploy --strip-components=1
- name: Copy config
run: cp element.io/develop/config.json _deploy/config.json
- name: Populate 404.html
run: echo "404 Not Found" > _deploy/404.html
- name: Populate _headers
run: cp .github/cfp_headers _deploy/_headers
# Redirect requests for the develop tarball and the historical bundles to R2
# We find the latest 100 bundle.css files and add their bundles to the redirects file
# S3 has no sane way to get the age of a directory as they don't really exist
- name: Populate _redirects
run: |
{
echo "/develop.tar.gz $R2_PUBLIC_URL/develop.tar.gz 301"
aws s3api --region auto --endpoint-url $R2_URL list-objects-v2 --bucket $R2_BUCKET \
--query "sort_by(Contents[?ends_with(Key, '/bundle.css')], &LastModified)[-100:].Key" \
--prefix "bundles/" | jq -r '.[]' | grep -oE '[^\"].*\/\s*' | while read -r path ; do
echo "/${path}* $R2_PUBLIC_URL/${path}:splat 301"
done
} | tee _deploy/_redirects
env:
AWS_ACCESS_KEY_ID: ${{ secrets.CF_R2_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_TOKEN }}
- name: Wait for other steps to succeed
uses: t3chguy/wait-on-check-action@05861d3a448898eb33dfce34153bd1ecb9422fb9 # fork
with:
ref: ${{ github.sha }}
running-workflow-name: "Build & Deploy develop.element.io"
repo-token: ${{ secrets.GITHUB_TOKEN }}
wait-interval: 10
check-regexp: ^((?!SonarCloud|SonarQube|issue|board|label).)*$
# We keep the latest develop.tar.gz on R2 instead of relying on the github artifact uploaded earlier
# as the expires after 24h and requires auth to download.
# Element Desktop's fetch script uses this tarball to fetch latest develop to build Nightlies.
- name: Deploy to R2
run: |
aws s3 cp dist/develop.tar.gz s3://$R2_BUCKET/develop.tar.gz --endpoint-url $R2_URL --region=auto
aws s3 cp _deploy/ s3://$R2_BUCKET/ --recursive --endpoint-url $R2_URL --region=auto
env:
AWS_ACCESS_KEY_ID: ${{ secrets.CF_R2_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_TOKEN }}
- name: Deploy to Cloudflare Pages
id: cfp
uses: cloudflare/pages-action@f0a1cd58cd66095dee69bfa18fa5efd1dde93bca # v1
with:
apiToken: ${{ secrets.CF_PAGES_TOKEN }}
accountId: ${{ secrets.CF_PAGES_ACCOUNT_ID }}
projectName: element-web-develop
directory: _deploy
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
- run: |
echo "Deployed to ${{ steps.cfp.outputs.url }}" >> $GITHUB_STEP_SUMMARY

View File

@@ -1,61 +1,59 @@
name: Dockerhub name: Dockerhub
on: on:
workflow_dispatch: {} workflow_dispatch: { }
push: push:
tags: [v*] tags: [ v* ]
schedule: schedule:
# This job can take a while, and we have usage limits, so just publish develop only twice a day # This job can take a while, and we have usage limits, so just publish develop only twice a day
- cron: "0 7/12 * * *" - cron: '0 7/12 * * *'
concurrency: ${{ github.workflow }}-${{ github.ref_name }} concurrency: ${{ github.ref_name }}
jobs: jobs:
buildx: buildx:
name: Docker Buildx name: Docker Buildx
runs-on: ubuntu-latest runs-on: ubuntu-latest
environment: dockerhub environment: dockerhub
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
with: with:
fetch-depth: 0 # needed for docker-package to be able to calculate the version fetch-depth: 0 # needed for docker-package to be able to calculate the version
- name: Set up QEMU - name: Set up QEMU
uses: docker/setup-qemu-action@2b82ce82d56a2a04d2637cd93a637ae1b359c0a7 # v2 uses: docker/setup-qemu-action@v1
- name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@4c0219f9ac95b02789c1075625400b2acbff50b1 # v2 uses: docker/setup-buildx-action@v2
with: with:
install: true install: true
- name: Login to Docker Hub - name: Login to Docker Hub
uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc # v2 uses: docker/login-action@v1
with: with:
username: ${{ secrets.DOCKERHUB_USERNAME }} username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }} password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Docker meta - name: Docker meta
id: meta id: meta
uses: docker/metadata-action@818d4b7b91585d195f67373fd9cb0332e31a7175 # v4 uses: docker/metadata-action@v3
with: with:
images: | images: |
vectorim/element-web vectorim/element-web
tags: | tags: |
type=ref,event=branch type=ref,event=branch
type=ref,event=tag type=ref,event=tag
flavor: |
latest=${{ contains(github.ref_name, '-rc.') && 'false' || 'auto' }}
- name: Build and push - name: Build and push
uses: docker/build-push-action@2eb1c1961a95fc15694676618e422e8ba1d63825 # v4 uses: docker/build-push-action@v2
with: with:
context: . context: .
push: true push: true
platforms: linux/amd64,linux/arm64 platforms: linux/amd64,linux/arm64
tags: ${{ steps.meta.outputs.tags }} tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }} labels: ${{ steps.meta.outputs.labels }}
- name: Update repo description - name: Update repo description
uses: peter-evans/dockerhub-description@dc67fad7001ef9e8e3c124cb7a64e16d0a63d864 # v3 uses: peter-evans/dockerhub-description@v2
continue-on-error: true continue-on-error: true
with: with:
username: ${{ secrets.DOCKERHUB_USERNAME }} username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }} password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: vectorim/element-web repository: vectorim/element-web

View File

@@ -2,155 +2,155 @@
# For all closed (completed) issues, cascade the closure onto any referenced rageshakes # For all closed (completed) issues, cascade the closure onto any referenced rageshakes
# For all closed (not planned) issues, comment on rageshakes to move them into the canonical issue if one exists # For all closed (not planned) issues, comment on rageshakes to move them into the canonical issue if one exists
on: on:
issues: issues:
types: [closed] types: [ closed ]
jobs: jobs:
tidy: tidy:
name: Tidy closed issues name: Tidy closed issues
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/github-script@v6 - uses: actions/github-script@v5
id: main id: main
with: with:
# PAT needed as the GITHUB_TOKEN won't be able to see cross-references from other orgs (matrix-org) # PAT needed as the GITHUB_TOKEN won't be able to see cross-references from other orgs (matrix-org)
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
script: | script: |
const variables = { const variables = {
owner: context.repo.owner, owner: context.repo.owner,
name: context.repo.repo, name: context.repo.repo,
number: context.issue.number, number: context.issue.number,
}; };
const query = `query($owner:String!, $name:String!, $number:Int!) { const query = `query($owner:String!, $name:String!, $number:Int!) {
repository(owner: $owner, name: $name) { repository(owner: $owner, name: $name) {
issue(number: $number) { issue(number: $number) {
stateReason, stateReason,
timelineItems(first: 100, itemTypes: [MARKED_AS_DUPLICATE_EVENT, UNMARKED_AS_DUPLICATE_EVENT, CROSS_REFERENCED_EVENT]) { timelineItems(first: 100, itemTypes: [MARKED_AS_DUPLICATE_EVENT, UNMARKED_AS_DUPLICATE_EVENT, CROSS_REFERENCED_EVENT]) {
edges { edges {
node { node {
__typename __typename
... on MarkedAsDuplicateEvent { ... on MarkedAsDuplicateEvent {
canonical { canonical {
... on Issue { ... on Issue {
repository { repository {
nameWithOwner nameWithOwner
}
number
}
... on PullRequest {
repository {
nameWithOwner
}
number
}
}
}
... on UnmarkedAsDuplicateEvent {
canonical {
... on Issue {
repository {
nameWithOwner
}
number
}
... on PullRequest {
repository {
nameWithOwner
}
number
}
}
}
... on CrossReferencedEvent {
source {
... on Issue {
repository {
nameWithOwner
}
number
}
... on PullRequest {
repository {
nameWithOwner
}
number
}
}
}
}
} }
number
}
... on PullRequest {
repository {
nameWithOwner
}
number
} }
} }
} }
}`; ... on UnmarkedAsDuplicateEvent {
canonical {
const result = await github.graphql(query, variables); ... on Issue {
const { stateReason, timelineItems: { edges } } = result.repository.issue; repository {
nameWithOwner
const RAGESHAKE_OWNER = "matrix-org"; }
const RAGESHAKE_REPO = "element-web-rageshakes"; number
const rageshakes = new Set();
const duplicateOf = new Set();
console.log("Edges: ", JSON.stringify(edges));
for (const { node } of edges) {
switch(node.__typename) {
case "MarkedAsDuplicateEvent":
duplicateOf.add(node.canonical.repository.nameWithOwner + "#" + node.canonical.number);
break;
case "UnmarkedAsDuplicateEvent":
duplicateOf.remove(node.canonical.repository.nameWithOwner + "#" + node.canonical.number);
break;
case "CrossReferencedEvent":
if (node.source.repository.nameWithOwner === (RAGESHAKE_OWNER + "/" + RAGESHAKE_REPO)) {
rageshakes.add(node.source.number);
} }
break; ... on PullRequest {
repository {
nameWithOwner
}
number
}
}
}
... on CrossReferencedEvent {
source {
... on Issue {
repository {
nameWithOwner
}
number
}
... on PullRequest {
repository {
nameWithOwner
}
number
}
}
} }
} }
}
}
}
}
}`;
console.log("Duplicate of: ", duplicateOf); const result = await github.graphql(query, variables);
console.log("Found rageshakes: ", rageshakes); const { stateReason, timelineItems: { edges } } = result.repository.issue;
if (duplicateOf.size) { const RAGESHAKE_OWNER = "matrix-org";
const body = Array.from(duplicateOf).join("\n"); const RAGESHAKE_REPO = "element-web-rageshakes";
const rageshakes = new Set();
const duplicateOf = new Set();
// Comment on all rageshakes to create relationship to the issue this was closed as duplicate of console.log("Edges: ", JSON.stringify(edges));
for (const rageshake of rageshakes) {
github.rest.issues.createComment({
owner: RAGESHAKE_OWNER,
repo: RAGESHAKE_REPO,
issue_number: rageshake,
body,
});
}
// Duplicate was closed with wrong reason, fix it for (const { node } of edges) {
if (stateReason === "COMPLETED") { switch(node.__typename) {
core.setOutput("closeAsNotPlanned", "true"); case "MarkedAsDuplicateEvent":
} duplicateOf.add(node.canonical.repository.nameWithOwner + "#" + node.canonical.number);
} else { break;
// This issue was closed, close all related rageshakes case "UnmarkedAsDuplicateEvent":
for (const rageshake of rageshakes) { duplicateOf.remove(node.canonical.repository.nameWithOwner + "#" + node.canonical.number);
github.rest.issues.update({ break;
owner: RAGESHAKE_OWNER, case "CrossReferencedEvent":
repo: RAGESHAKE_REPO, if (node.source.repository.nameWithOwner === (RAGESHAKE_OWNER + "/" + RAGESHAKE_REPO)) {
issue_number: rageshake, rageshakes.add(node.source.number);
state: "closed", }
}); break;
} }
} }
- uses: actions/github-script@v6
name: Close duplicate as Not Planned console.log("Duplicate of: ", duplicateOf);
if: steps.main.outputs.closeAsNotPlanned console.log("Found rageshakes: ", rageshakes);
with:
# We do this step separately, and with the default token so as to not re-trigger this workflow when re-closing if (duplicateOf.size) {
script: | const body = Array.from(duplicateOf).join("\n");
await github.graphql(`mutation($id:ID!) {
closeIssue(input: { issueId:$id, stateReason:NOT_PLANNED }) { // Comment on all rageshakes to create relationship to the issue this was closed as duplicate of
clientMutationId for (const rageshake of rageshakes) {
} github.rest.issues.createComment({
}`, { owner: RAGESHAKE_OWNER,
id: context.payload.issue.node_id, repo: RAGESHAKE_REPO,
}); issue_number: rageshake,
body,
});
}
// Duplicate was closed with wrong reason, fix it
if (stateReason === "COMPLETED") {
core.setOutput("closeAsNotPlanned", "true");
}
} else {
// This issue was closed, close all related rageshakes
for (const rageshake of rageshakes) {
github.rest.issues.update({
owner: RAGESHAKE_OWNER,
repo: RAGESHAKE_REPO,
issue_number: rageshake,
state: "closed",
});
}
}
- uses: actions/github-script@v5
name: Close duplicate as Not Planned
if: steps.main.outputs.closeAsNotPlanned
with:
# We do this step separately, and with the default token so as to not re-trigger this workflow when re-closing
script: |
await github.graphql(`mutation($id:ID!) {
closeIssue(input: { issueId:$id, stateReason:NOT_PLANNED }) {
clientMutationId
}
}`, {
id: context.payload.issue.node_id,
});

View File

@@ -1,90 +0,0 @@
name: Pending reviews automation
on:
# We run it on a schedule instead of on pull_request_* events to not create confusing messaging in the PR
schedule:
- cron: "*/10 * * * *"
concurrency: ${{ github.workflow }}
jobs:
bot:
name: Pending reviews bot
runs-on: ubuntu-latest
environment: Matrix
env:
URL: "https://github.com/pulls?q=is%3Apr+is%3Aopen+repo%3Amatrix-org%2Fmatrix-js-sdk+repo%3Amatrix-org%2Fmatrix-react-sdk+repo%3Avector-im%2Felement-web+repo%3Avector-im%2Felement-desktop+review-requested%3A%40me+sort%3Aupdated-desc+"
RELEASE_BLOCKERS_URL: "https://github.com/pulls?q=is%3Aopen+repo%3Amatrix-org%2Fmatrix-js-sdk+repo%3Amatrix-org%2Fmatrix-react-sdk+repo%3Avector-im%2Felement-web+repo%3Avector-im%2Felement-desktop+sort%3Aupdated-desc+label%3AX-Release-Blocker+"
steps:
- uses: actions/github-script@v6
env:
HS_URL: ${{ secrets.BETABOT_HS_URL }}
ROOM_ID: ${{ secrets.ROOM_ID }}
TOKEN: ${{ secrets.BETABOT_ACCESS_TOKEN }}
with:
# PAT needed as the GITHUB_TOKEN won't be able to see cross-references from other orgs (matrix-org)
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
script: |
const { HS_URL, ROOM_ID, TOKEN, URL, RELEASE_BLOCKERS_URL } = process.env;
async function updateCounter(counter, link, severity, title, value, clearOnZero) {
const apiUrl = `${HS_URL}/_matrix/client/v3/rooms/${ROOM_ID}/state/re.jki.counter/${counter}`;
const headers = {
"Content-Type": "application/json",
"Authorization": `Bearer ${TOKEN}`,
};
const res = await fetch(apiUrl, {
method: "GET",
headers,
});
const data = await res.json();
if (data.value === issueCount) {
console.log("Pending review count already correct");
return;
}
let body = {};
if (issueCount || !clearOnZero) {
body = JSON.stringify({
link,
severity,
title,
value,
});
}
await fetch(apiUrl, {
method: "PUT",
body,
headers,
});
}
const repos = [
"vector-im/element-desktop",
"vector-im/element-web",
"matrix-org/matrix-react-sdk",
"matrix-org/matrix-js-sdk",
];
const teams = [
"matrix-org/element-web-app-team",
"matrix-org/element-web",
"vector-im/element-web-app-team",
"vector-im/element-web",
];
let issueCount = 0;
for (const team of teams) {
const org = team.split("/", 2)[0];
const reposInOrg = repos.filter(repo => repo.startsWith(org + "/"));
const { data } = await github.rest.search.issuesAndPullRequests({
q: `is:pr is:open review:required ${reposInOrg.map(r => `repo:${r}`).join(" ")} team-review-requested:${team}`,
});
issueCount += data.total_count;
}
await updateCounter("gh_reviews", URL, "warning", "Pending reviews", issueCount);
const { data } = await github.rest.search.issuesAndPullRequests({
q: `is:open ${repos.map(repo => `repo:${repo}`).join(" ")} label:X-Release-Blocker`,
});
const blockerCount = data.total_count;
await updateCounter("release_blockers", RELEASE_BLOCKERS_URL, "alert", "Release Blockers", blockerCount, true);

View File

@@ -1,9 +1,12 @@
name: Pull Request name: Pull Request
on: on:
pull_request_target: pull_request_target:
types: [opened, edited, labeled, unlabeled, synchronize] types: [ opened, edited, labeled, unlabeled, synchronize ]
concurrency: ${{ github.workflow }}-${{ github.event.pull_request.head.ref }}
jobs: jobs:
action: action:
uses: matrix-org/matrix-js-sdk/.github/workflows/pull_request.yaml@develop uses: matrix-org/matrix-js-sdk/.github/workflows/pull_request.yaml@develop
secrets: with:
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }} labels: "T-Defect,T-Enhancement,T-Task"
secrets:
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}

View File

@@ -1,15 +1,15 @@
name: SonarQube name: SonarQube
on: on:
workflow_run: workflow_run:
workflows: ["Tests"] workflows: [ "Tests" ]
types: types:
- completed - completed
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.event.workflow_run.head_branch }} group: ${{ github.workflow }}-${{ github.event.workflow_run.head_branch }}
cancel-in-progress: true cancel-in-progress: true
jobs: jobs:
sonarqube: sonarqube:
name: 🩻 SonarQube name: 🩻 SonarQube
uses: matrix-org/matrix-js-sdk/.github/workflows/sonarcloud.yml@develop uses: matrix-org/matrix-js-sdk/.github/workflows/sonarcloud.yml@develop
secrets: secrets:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

View File

@@ -1,81 +1,116 @@
name: Static Analysis name: Static Analysis
on: on:
pull_request: {} pull_request: { }
push: push:
branches: [develop, master] branches: [ develop, master ]
repository_dispatch: repository_dispatch:
types: [element-web-notify] types: [ element-web-notify ]
env: env:
# These must be set for fetchdep.sh to get the right branch # These must be set for fetchdep.sh to get the right branch
REPOSITORY: ${{ github.repository }} REPOSITORY: ${{ github.repository }}
PR_NUMBER: ${{ github.event.pull_request.number }} PR_NUMBER: ${{ github.event.pull_request.number }}
jobs: jobs:
ts_lint: ts_lint:
name: "Typescript Syntax Check" name: "Typescript Syntax Check"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v2
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
cache: "yarn" cache: 'yarn'
- name: Install Dependencies - name: Install Dependencies
run: "./scripts/layered.sh" run: "./scripts/layered.sh"
- name: Typecheck - name: Typecheck
run: "yarn run lint:types" run: "yarn run lint:types"
i18n_lint: i18n_lint:
name: "i18n Check" name: "i18n Check"
uses: matrix-org/matrix-react-sdk/.github/workflows/i18n_check.yml@develop uses: matrix-org/matrix-react-sdk/.github/workflows/i18n_check.yml@develop
js_lint: js_lint:
name: "ESLint" name: "ESLint"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v2
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
cache: "yarn" cache: 'yarn'
# Does not need branch matching as only analyses this layer # Does not need branch matching as only analyses this layer
- name: Install Deps - name: Install Deps
run: "yarn install --frozen-lockfile" run: "yarn install --pure-lockfile"
- name: Run Linter - name: Run Linter
run: "yarn run lint:js" run: "yarn run lint:js"
style_lint: style_lint:
name: "Style Lint" name: "Style Lint"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v2
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
cache: "yarn" cache: 'yarn'
# Needs branch matching as it inherits .stylelintrc.js from matrix-react-sdk # Needs branch matching as it inherits .stylelintrc.js from matrix-react-sdk
- name: Install Dependencies - name: Install Dependencies
run: "./scripts/layered.sh" run: "./scripts/layered.sh"
- name: Run Linter - name: Run Linter
run: "yarn run lint:style" run: "yarn run lint:style"
analyse_dead_code: analyse_dead_code:
name: "Analyse Dead Code" name: "Analyse Dead Code"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v2
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
cache: "yarn" cache: 'yarn'
- name: Install Deps - name: Install Deps
run: "scripts/layered.sh" run: "scripts/layered.sh"
- name: Dead Code Analysis - name: Dead Code Analysis
run: "yarn run analyse:unused-exports" run: "yarn run analyse:unused-exports"
tsc-strict:
name: Typescript Strict Error Checker
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
permissions:
pull-requests: read
checks: write
steps:
- uses: actions/checkout@v3
- name: Get diff lines
id: diff
uses: Equip-Collaboration/diff-line-numbers@v1.0.0
with:
include: '["\\.tsx?$"]'
- name: Detecting files changed
id: files
uses: futuratrepadeira/changed-files@v3.2.1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
pattern: '^.*\.tsx?$'
- uses: t3chguy/typescript-check-action@main
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
use-check: false
check-fail-mode: added
output-behaviour: annotate
ts-extra-args: '--strict'
files-changed: ${{ steps.files.outputs.files_updated }}
files-added: ${{ steps.files.outputs.files_created }}
files-deleted: ${{ steps.files.outputs.files_deleted }}
line-numbers: ${{ steps.diff.outputs.lineNumbers }}

View File

@@ -1,41 +1,37 @@
name: Tests name: Tests
on: on:
pull_request: {} pull_request: { }
push: push:
branches: [develop, master] branches: [ develop, master ]
repository_dispatch: repository_dispatch:
types: [element-web-notify] types: [ element-web-notify ]
env: env:
# These must be set for fetchdep.sh to get the right branch # These must be set for fetchdep.sh to get the right branch
REPOSITORY: ${{ github.repository }} REPOSITORY: ${{ github.repository }}
PR_NUMBER: ${{ github.event.pull_request.number }} PR_NUMBER: ${{ github.event.pull_request.number }}
jobs: jobs:
jest: jest:
name: Jest name: Jest
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v3 uses: actions/checkout@v2
- name: Yarn cache - name: Yarn cache
uses: actions/setup-node@v3 uses: actions/setup-node@v3
with: with:
cache: "yarn" cache: 'yarn'
- name: Install Dependencies - name: Install Dependencies
run: "./scripts/layered.sh" run: "./scripts/layered.sh"
- name: Get number of CPU cores - name: Run tests with coverage
id: cpu-cores run: "yarn coverage --ci"
uses: SimenB/github-actions-cpu-cores@410541432439795d30db6501fb1d8178eb41e502 # v1
- name: Run tests with coverage - name: Upload Artifact
run: "yarn coverage --ci --max-workers ${{ steps.cpu-cores.outputs.count }}" uses: actions/upload-artifact@v2
with:
- name: Upload Artifact name: coverage
uses: actions/upload-artifact@v3 path: |
with: coverage
name: coverage !coverage/lcov-report
path: |
coverage
!coverage/lcov-report

View File

@@ -1,18 +1,18 @@
name: Move issued assigned to specific team members to their boards name: Move issued assigned to specific team members to their boards
on: on:
issues: issues:
types: [assigned] types: [ assigned ]
jobs: jobs:
web-app-team: web-app-team:
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: | if: |
contains(github.event.issue.assignees.*.login, 't3chguy') || contains(github.event.issue.assignees.*.login, 't3chguy') ||
contains(github.event.issue.assignees.*.login, 'andybalaam') || contains(github.event.issue.assignees.*.login, 'turt2live')
contains(github.event.issue.assignees.*.login, 'justjanne') steps:
steps: - uses: alex-page/github-project-automation-plus@bb266ff4dde9242060e2d5418e120a133586d488
- uses: actions/add-to-project@main with:
with: project: Web App Team
project-url: https://github.com/orgs/vector-im/projects/67 column: "In Progress"
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} repo-token: ${{ secrets.ELEMENT_BOT_TOKEN }}

View File

@@ -1,15 +1,15 @@
name: Move new issues into Issue triage board name: Move new issues into Issue triage board
on: on:
issues: issues:
types: [opened] types: [ opened ]
jobs: jobs:
automate-project-columns: automate-project-columns:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: alex-page/github-project-automation-plus@7ffb872c64bd809d23563a130a0a97d01dfa8f43 - uses: alex-page/github-project-automation-plus@bb266ff4dde9242060e2d5418e120a133586d488
with: with:
project: Issue triage project: Issue triage
column: Incoming column: Incoming
repo-token: ${{ secrets.ELEMENT_BOT_TOKEN }} repo-token: ${{ secrets.ELEMENT_BOT_TOKEN }}

View File

@@ -1,161 +1,255 @@
name: Move labelled issues to correct projects name: Move labelled issues to correct projects
on: on:
issues: issues:
types: [labeled] types: [labeled]
jobs: jobs:
apply_Z-Labs_label: apply_Z-Labs_label:
name: Add Z-Labs label for features behind labs flags name: Add Z-Labs label for features behind labs flags
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
contains(github.event.issue.labels.*.name, 'A-Maths') || contains(github.event.issue.labels.*.name, 'A-Maths') ||
contains(github.event.issue.labels.*.name, 'A-Message-Pinning') || contains(github.event.issue.labels.*.name, 'A-Message-Pinning') ||
contains(github.event.issue.labels.*.name, 'A-Location-Sharing') || contains(github.event.issue.labels.*.name, 'A-Location-Sharing') ||
contains(github.event.issue.labels.*.name, 'Z-IA') || contains(github.event.issue.labels.*.name, 'Z-IA') ||
contains(github.event.issue.labels.*.name, 'A-Jump-To-Date ') || contains(github.event.issue.labels.*.name, 'A-Themes-Custom') ||
contains(github.event.issue.labels.*.name, 'A-Themes-Custom') || contains(github.event.issue.labels.*.name, 'A-E2EE-Dehydration') ||
contains(github.event.issue.labels.*.name, 'A-E2EE-Dehydration') || contains(github.event.issue.labels.*.name, 'A-Tags') ||
contains(github.event.issue.labels.*.name, 'A-Tags') || contains(github.event.issue.labels.*.name, 'A-Video-Rooms') ||
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-Message-Starring') || steps:
contains(github.event.issue.labels.*.name, 'A-Rich-Text-Editor') || - uses: actions/github-script@v5
contains(github.event.issue.labels.*.name, 'A-Element-Call') with:
steps: script: |
- uses: actions/github-script@v6 github.rest.issues.addLabels({
with: issue_number: context.issue.number,
script: | owner: context.repo.owner,
github.rest.issues.addLabels({ repo: context.repo.repo,
issue_number: context.issue.number, labels: ['Z-Labs']
owner: context.repo.owner, })
repo: context.repo.repo,
labels: ['Z-Labs']
})
apply_Help-Wanted_label: move_needs_info_issues:
name: Add "Help Wanted" label to all "good first issue" and Hacktoberfest name: X-Needs-Info issues to Need info column on triage board
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > steps:
contains(github.event.issue.labels.*.name, 'good first issue') || - uses: konradpabjan/move-labeled-or-milestoned-issue@219d384e03fa4b6460cd24f9f37d19eb033a4338
contains(github.event.issue.labels.*.name, 'Hacktoberfest') with:
steps: action-token: "${{ secrets.ELEMENT_BOT_TOKEN }}"
- uses: actions/github-script@v6 project-url: "https://github.com/vector-im/element-web/projects/27"
with: column-name: "Need info"
script: | label-name: "X-Needs-Info"
github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ['Help Wanted']
})
move_needs_info_issues: add_priority_design_issues_to_project:
name: X-Needs-Info issues to Need info column on triage board name: P1 X-Needs-Design to Design project board
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: if: >
- uses: konradpabjan/move-labeled-or-milestoned-issue@190352295fe309fcb113b49193bc81d9aaa9cb01 contains(github.event.issue.labels.*.name, 'X-Needs-Design')
with: steps:
action-token: "${{ secrets.ELEMENT_BOT_TOKEN }}" - uses: octokit/graphql-action@v2.x
project-url: "https://github.com/vector-im/element-web/projects/27" id: add_to_project
column-name: "Need info" with:
label-name: "X-Needs-Info" headers: '{"GraphQL-Features": "projects_next_graphql"}'
query: |
mutation add_to_project($projectid:ID!,$contentid:ID!) {
addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
projectNextItem {
id
}
}
}
projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.issue.node_id }}
env:
PROJECT_ID: "PN_kwDOAM0swc0sUA"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
add_priority_design_issues_to_project: add_product_issues:
name: P1 X-Needs-Design to Design project board name: X-Needs-Product to Design project board
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
contains(github.event.issue.labels.*.name, 'X-Needs-Design') && contains(github.event.issue.labels.*.name, 'X-Needs-Product')
(contains(github.event.issue.labels.*.name, 'S-Critical') && steps:
(contains(github.event.issue.labels.*.name, 'O-Frequent') || - uses: octokit/graphql-action@v2.x
contains(github.event.issue.labels.*.name, 'O-Occasional')) || id: add_to_project
contains(github.event.issue.labels.*.name, 'S-Major') && with:
contains(github.event.issue.labels.*.name, 'O-Frequent') || headers: '{"GraphQL-Features": "projects_next_graphql"}'
contains(github.event.issue.labels.*.name, 'A11y')) query: |
steps: mutation add_to_project($projectid:ID!,$contentid:ID!) {
- uses: actions/add-to-project@main addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
with: projectNextItem {
project-url: https://github.com/orgs/vector-im/projects/18 id
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} }
}
}
projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.issue.node_id }}
env:
PROJECT_ID: "PN_kwDOAM0swc4AAg6N"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
add_product_issues: Delight_issues_to_board:
name: X-Needs-Product to product project board name: Delight issues to project board
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
contains(github.event.issue.labels.*.name, 'X-Needs-Product') contains(github.event.issue.labels.*.name, 'A-New-Search-Experience') ||
steps: (contains(github.event.issue.labels.*.name, 'A-Threads') &&
- uses: actions/add-to-project@main (contains(github.event.issue.labels.*.name, 'S-Major') ||
with: contains(github.event.issue.labels.*.name, 'S-Critical'))) ||
project-url: https://github.com/orgs/vector-im/projects/28 contains(github.event.issue.labels.*.name, 'Team: Delight') ||
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} contains(github.event.issue.labels.*.name, 'Z-NewUserJourney')
steps:
- uses: octokit/graphql-action@v2.x
with:
headers: '{"GraphQL-Features": "projects_next_graphql"}'
query: |
mutation add_to_project($projectid:ID!,$contentid:ID!) {
addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
projectNextItem {
id
}
}
}
projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.issue.node_id }}
env:
PROJECT_ID: "PN_kwDOAM0swc1HvQ"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
search_issues_to_board:
name: Search issues to project board
runs-on: ubuntu-latest
if: >
contains(github.event.issue.labels.*.name, 'A-New-Search-Experience')
steps:
- uses: octokit/graphql-action@v2.x
with:
headers: '{"GraphQL-Features": "projects_next_graphql"}'
query: |
mutation add_to_project($projectid:ID!,$contentid:ID!) {
addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
projectNextItem {
id
}
}
}
projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.issue.node_id }}
env:
PROJECT_ID: "PN_kwDOAM0swc4ADtaO"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
Search_issues_to_board: move_voice-message_issues:
name: Search issues to project board name: A-Voice Messages to voice message board
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
contains(github.event.issue.labels.*.name, 'A-New-Search-Experience') contains(github.event.issue.labels.*.name, 'A-Voice Messages')
steps: steps:
- uses: actions/add-to-project@main - uses: octokit/graphql-action@v2.x
with: with:
project-url: https://github.com/orgs/vector-im/projects/48 headers: '{"GraphQL-Features": "projects_next_graphql"}'
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} query: |
mutation add_to_project($projectid:ID!,$contentid:ID!) {
addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
projectNextItem {
id
}
}
}
projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.issue.node_id }}
env:
PROJECT_ID: "PN_kwDOAM0swc2KCw"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
ps_features1: move_threads_issues:
name: Add labelled issues to PS features team 1 name: A-Threads to Thread board
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
contains(github.event.issue.labels.*.name, 'A-Polls') || contains(github.event.issue.labels.*.name, 'A-Threads')
contains(github.event.issue.labels.*.name, 'A-Location-Sharing') || steps:
(contains(github.event.issue.labels.*.name, 'A-Voice-Messages') && - uses: octokit/graphql-action@v2.x
!contains(github.event.issue.labels.*.name, 'A-Broadcast')) || with:
(contains(github.event.issue.labels.*.name, 'A-Session-Mgmt') && headers: '{"GraphQL-Features": "projects_next_graphql"}'
contains(github.event.issue.labels.*.name, 'A-User-Settings')) query: |
steps: mutation add_to_project($projectid:ID!,$contentid:ID!) {
- uses: actions/add-to-project@main addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
with: projectNextItem {
project-url: https://github.com/orgs/vector-im/projects/56 id
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} }
}
}
projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.issue.node_id }}
env:
PROJECT_ID: "PN_kwDOAM0swc0rRA"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
ps_features2: move_message_bubbles_issues:
name: Add labelled issues to PS features team 2 name: A-Message-Bubbles to Message bubbles board
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
contains(github.event.issue.labels.*.name, 'A-DM-Start') || contains(github.event.issue.labels.*.name, 'A-Message-Bubbles')
contains(github.event.issue.labels.*.name, 'A-Broadcast') steps:
steps: - uses: octokit/graphql-action@v2.x
- uses: actions/add-to-project@main with:
with: headers: '{"GraphQL-Features": "projects_next_graphql"}'
project-url: https://github.com/orgs/vector-im/projects/58 query: |
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} mutation add_to_project($projectid:ID!,$contentid:ID!) {
addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
projectNextItem {
id
}
}
}
projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.issue.node_id }}
env:
PROJECT_ID: "PN_kwDOAM0swc3m-g"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
ps_features3: move_ftue_issues:
name: Add labelled issues to PS features team 3 name: Z-FTUE issues to the FTUE project board
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
contains(github.event.issue.labels.*.name, 'A-Rich-Text-Editor') contains(github.event.issue.labels.*.name, 'Z-FTUE')
steps: steps:
- uses: actions/add-to-project@main - uses: octokit/graphql-action@v2.x
with: with:
project-url: https://github.com/orgs/vector-im/projects/57 headers: '{"GraphQL-Features": "projects_next_graphql"}'
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} query: |
mutation add_to_project($projectid:ID!,$contentid:ID!) {
addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
projectNextItem {
id
}
}
}
projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.issue.node_id }}
env:
PROJECT_ID: "PN_kwDOAM0swc4AAqVx"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
voip: move_WTF_issues:
name: Add labelled issues to VoIP project board name: Z-WTF issues to the WTF project board
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
contains(github.event.issue.labels.*.name, 'Team: VoIP') contains(github.event.issue.labels.*.name, 'Z-WTF')
steps: steps:
- uses: actions/add-to-project@main - uses: octokit/graphql-action@v2.x
with: with:
project-url: https://github.com/orgs/vector-im/projects/41 headers: '{"GraphQL-Features": "projects_next_graphql"}'
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} query: |
mutation add_to_project($projectid:ID!,$contentid:ID!) {
verticals_feature: addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
name: Add labelled issues to Verticals Feature project projectNextItem {
runs-on: ubuntu-latest id
if: > }
contains(github.event.issue.labels.*.name, 'Team: Verticals Feature') }
steps: }
- uses: actions/add-to-project@main projectid: ${{ env.PROJECT_ID }}
with: contentid: ${{ github.event.issue.node_id }}
project-url: https://github.com/orgs/vector-im/projects/57 env:
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }} PROJECT_ID: "PN_kwDOAM0swc4AArk0"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}

View File

@@ -1,139 +1,139 @@
name: Move pull requests asking for review to the relevant project name: Move pull requests asking for review to the relevant project
on: on:
pull_request_target: pull_request_target:
types: [review_requested] types: [ review_requested ]
jobs: jobs:
add_design_pr_to_project: add_design_pr_to_project:
name: Move PRs asking for design review to the design board name: Move PRs asking for design review to the design board
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: octokit/graphql-action@v2.x - uses: octokit/graphql-action@v2.x
id: find_team_members id: find_team_members
with: with:
headers: '{"GraphQL-Features": "projects_next_graphql"}' headers: '{"GraphQL-Features": "projects_next_graphql"}'
query: | query: |
query find_team_members($team: String!) { query find_team_members($team: String!) {
organization(login: "vector-im") { organization(login: "vector-im") {
team(slug: $team) { team(slug: $team) {
members { members {
nodes { nodes {
login login
} }
} }
} }
} }
} }
team: ${{ env.TEAM }} team: ${{ env.TEAM }}
env: env:
TEAM: "design" TEAM: "design"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }} GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
- id: any_matching_reviewers - id: any_matching_reviewers
run: | run: |
# Fetch requested reviewers, and people who are on the team # Fetch requested reviewers, and people who are on the team
echo '${{ tojson(fromjson(steps.find_team_members.outputs.data).organization.team.members.nodes[*].login) }}' | tee /tmp/team_members.json echo '${{ tojson(fromjson(steps.find_team_members.outputs.data).organization.team.members.nodes[*].login) }}' | tee /tmp/team_members.json
echo '${{ tojson(github.event.pull_request.requested_reviewers[*].login) }}' | tee /tmp/reviewers.json echo '${{ tojson(github.event.pull_request.requested_reviewers[*].login) }}' | tee /tmp/reviewers.json
jq --raw-output .[] < /tmp/team_members.json | sort | tee /tmp/team_members.txt jq --raw-output .[] < /tmp/team_members.json | sort | tee /tmp/team_members.txt
jq --raw-output .[] < /tmp/reviewers.json | sort | tee /tmp/reviewers.txt jq --raw-output .[] < /tmp/reviewers.json | sort | tee /tmp/reviewers.txt
# Fetch requested team reviewers, and the name of the team # Fetch requested team reviewers, and the name of the team
echo '${{ tojson(github.event.pull_request.requested_teams[*].slug) }}' | tee /tmp/team_reviewers.json echo '${{ tojson(github.event.pull_request.requested_teams[*].slug) }}' | tee /tmp/team_reviewers.json
jq --raw-output .[] < /tmp/team_reviewers.json | sort | tee /tmp/team_reviewers.txt jq --raw-output .[] < /tmp/team_reviewers.json | sort | tee /tmp/team_reviewers.txt
echo '${{ env.TEAM }}' | tee /tmp/team.txt echo '${{ env.TEAM }}' | tee /tmp/team.txt
# If either a reviewer matches a team member, or a team matches our team, say "true" # If either a reviewer matches a team member, or a team matches our team, say "true"
if [ $(join /tmp/team_members.txt /tmp/reviewers.txt | wc -l) != 0 ]; then if [ $(join /tmp/team_members.txt /tmp/reviewers.txt | wc -l) != 0 ]; then
echo "match=true" >> $GITHUB_OUTPUT echo "::set-output name=match::true"
elif [ $(join /tmp/team.txt /tmp/team_reviewers.txt | wc -l) != 0 ]; then elif [ $(join /tmp/team.txt /tmp/team_reviewers.txt | wc -l) != 0 ]; then
echo "match=true" >> $GITHUB_OUTPUT echo "::set-output name=match::true"
else else
echo "match=false" >> $GITHUB_OUTPUT echo "::set-output name=match::false"
fi fi
env: env:
TEAM: "design" TEAM: "design"
- uses: octokit/graphql-action@v2.x - uses: octokit/graphql-action@v2.x
id: add_to_project id: add_to_project
if: steps.any_matching_reviewers.outputs.match == 'true' if: steps.any_matching_reviewers.outputs.match == 'true'
with: with:
headers: '{"GraphQL-Features": "projects_next_graphql"}' headers: '{"GraphQL-Features": "projects_next_graphql"}'
query: | query: |
mutation add_to_project($projectid:ID!, $contentid:ID!) { mutation add_to_project($projectid:ID!, $contentid:ID!) {
addProjectV2ItemById(input: {projectId: $projectid contentId: $contentid}) { addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
item { projectNextItem {
id id
} }
} }
} }
projectid: ${{ env.PROJECT_ID }} projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.pull_request.node_id }} contentid: ${{ github.event.pull_request.node_id }}
env: env:
PROJECT_ID: "PVT_kwDOAM0swc0sUA" PROJECT_ID: "PN_kwDOAM0swc0sUA"
TEAM: "design" TEAM: "design"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }} GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
add_product_pr_to_project: add_product_pr_to_project:
name: Move PRs asking for design review to the design board name: Move PRs asking for design review to the design board
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: octokit/graphql-action@v2.x - uses: octokit/graphql-action@v2.x
id: find_team_members id: find_team_members
with: with:
headers: '{"GraphQL-Features": "projects_next_graphql"}' headers: '{"GraphQL-Features": "projects_next_graphql"}'
query: | query: |
query find_team_members($team: String!) { query find_team_members($team: String!) {
organization(login: "vector-im") { organization(login: "vector-im") {
team(slug: $team) { team(slug: $team) {
members { members {
nodes { nodes {
login login
} }
} }
} }
} }
} }
team: ${{ env.TEAM }} team: ${{ env.TEAM }}
env: env:
TEAM: "product" TEAM: "product"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }} GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
- id: any_matching_reviewers - id: any_matching_reviewers
run: | run: |
# Fetch requested reviewers, and people who are on the team # Fetch requested reviewers, and people who are on the team
echo '${{ tojson(fromjson(steps.find_team_members.outputs.data).organization.team.members.nodes[*].login) }}' | tee /tmp/team_members.json echo '${{ tojson(fromjson(steps.find_team_members.outputs.data).organization.team.members.nodes[*].login) }}' | tee /tmp/team_members.json
echo '${{ tojson(github.event.pull_request.requested_reviewers[*].login) }}' | tee /tmp/reviewers.json echo '${{ tojson(github.event.pull_request.requested_reviewers[*].login) }}' | tee /tmp/reviewers.json
jq --raw-output .[] < /tmp/team_members.json | sort | tee /tmp/team_members.txt jq --raw-output .[] < /tmp/team_members.json | sort | tee /tmp/team_members.txt
jq --raw-output .[] < /tmp/reviewers.json | sort | tee /tmp/reviewers.txt jq --raw-output .[] < /tmp/reviewers.json | sort | tee /tmp/reviewers.txt
# Fetch requested team reviewers, and the name of the team # Fetch requested team reviewers, and the name of the team
echo '${{ tojson(github.event.pull_request.requested_teams[*].slug) }}' | tee /tmp/team_reviewers.json echo '${{ tojson(github.event.pull_request.requested_teams[*].slug) }}' | tee /tmp/team_reviewers.json
jq --raw-output .[] < /tmp/team_reviewers.json | sort | tee /tmp/team_reviewers.txt jq --raw-output .[] < /tmp/team_reviewers.json | sort | tee /tmp/team_reviewers.txt
echo '${{ env.TEAM }}' | tee /tmp/team.txt echo '${{ env.TEAM }}' | tee /tmp/team.txt
# If either a reviewer matches a team member, or a team matches our team, say "true" # If either a reviewer matches a team member, or a team matches our team, say "true"
if [ $(join /tmp/team_members.txt /tmp/reviewers.txt | wc -l) != 0 ]; then if [ $(join /tmp/team_members.txt /tmp/reviewers.txt | wc -l) != 0 ]; then
echo "match=true" >> $GITHUB_OUTPUT echo "::set-output name=match::true"
elif [ $(join /tmp/team.txt /tmp/team_reviewers.txt | wc -l) != 0 ]; then elif [ $(join /tmp/team.txt /tmp/team_reviewers.txt | wc -l) != 0 ]; then
echo "match=true" >> $GITHUB_OUTPUT echo "::set-output name=match::true"
else else
echo "match=false" >> $GITHUB_OUTPUT echo "::set-output name=match::false"
fi fi
env: env:
TEAM: "product" TEAM: "product"
- uses: octokit/graphql-action@v2.x - uses: octokit/graphql-action@v2.x
id: add_to_project id: add_to_project
if: steps.any_matching_reviewers.outputs.match == 'true' if: steps.any_matching_reviewers.outputs.match == 'true'
with: with:
headers: '{"GraphQL-Features": "projects_next_graphql"}' headers: '{"GraphQL-Features": "projects_next_graphql"}'
query: | query: |
mutation add_to_project($projectid:ID!, $contentid:ID!) { mutation add_to_project($projectid:ID!, $contentid:ID!) {
addProjectV2ItemById(input: {projectId: $projectid contentId: $contentid}) { addProjectNextItem(input:{projectId:$projectid contentId:$contentid}) {
item { projectNextItem {
id id
} }
} }
} }
projectid: ${{ env.PROJECT_ID }} projectid: ${{ env.PROJECT_ID }}
contentid: ${{ github.event.pull_request.node_id }} contentid: ${{ github.event.pull_request.node_id }}
env: env:
PROJECT_ID: "PVT_kwDOAM0swc4AAg6N" PROJECT_ID: "PN_kwDOAM0swc4AAg6N"
TEAM: "product" TEAM: "product"
GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }} GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}

View File

@@ -0,0 +1,30 @@
name: Move P1 bugs to boards
on:
issues:
types: [labeled, unlabeled]
jobs:
P1_issues_to_crypto_team_workboard:
runs-on: ubuntu-latest
if: >
contains(github.event.issue.labels.*.name, 'Z-UISI') ||
(contains(github.event.issue.labels.*.name, 'A-E2EE') ||
contains(github.event.issue.labels.*.name, 'A-E2EE-Cross-Signing') ||
contains(github.event.issue.labels.*.name, 'A-E2EE-Dehydration') ||
contains(github.event.issue.labels.*.name, 'A-E2EE-Key-Backup') ||
contains(github.event.issue.labels.*.name, 'A-E2EE-SAS-Verification')) &&
(contains(github.event.issue.labels.*.name, 'T-Defect') &&
contains(github.event.issue.labels.*.name, 'S-Critical') &&
(contains(github.event.issue.labels.*.name, 'O-Frequent') ||
contains(github.event.issue.labels.*.name, 'O-Occasional')) ||
contains(github.event.issue.labels.*.name, 'S-Major') &&
contains(github.event.issue.labels.*.name, 'O-Frequent') ||
contains(github.event.issue.labels.*.name, 'A11y') &&
contains(github.event.issue.labels.*.name, 'O-Frequent'))
steps:
- uses: alex-page/github-project-automation-plus@bb266ff4dde9242060e2d5418e120a133586d488
with:
project: Crypto Team
column: Ready
repo-token: ${{ secrets.ELEMENT_BOT_TOKEN }}

View File

@@ -1,71 +1,71 @@
name: Move unlabelled from needs info columns to triaged name: Move unlabelled from needs info columns to triaged
on: on:
issues: issues:
types: [unlabeled] types: [ unlabeled ]
jobs: jobs:
Move_Unabeled_Issue_On_Project_Board: Move_Unabeled_Issue_On_Project_Board:
name: Move no longer X-Needs-Info issues to Triaged name: Move no longer X-Needs-Info issues to Triaged
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
${{ ${{
!contains(github.event.issue.labels.*.name, 'X-Needs-Info') }} !contains(github.event.issue.labels.*.name, 'X-Needs-Info') }}
env: env:
BOARD_NAME: "Issue triage" BOARD_NAME: "Issue triage"
OWNER: ${{ github.repository_owner }} OWNER: ${{ github.repository_owner }}
REPO: ${{ github.event.repository.name }} REPO: ${{ github.event.repository.name }}
ISSUE: ${{ github.event.issue.number }} ISSUE: ${{ github.event.issue.number }}
steps: steps:
- name: Check if issue is already in "${{ env.BOARD_NAME }}" - name: Check if issue is already in "${{ env.BOARD_NAME }}"
run: | run: |
json=$(curl -s -H 'Content-Type: application/json' -H "Authorization: bearer ${{ secrets.GITHUB_TOKEN }}" -X POST -d '{"query": "query($issue: Int!, $owner: String!, $repo: String!) { repository(owner: $owner, name: $repo) { issue(number: $issue) { projectCards { nodes { project { name } isArchived } } } } } ", "variables" : "{ \"issue\": '${ISSUE}', \"owner\": \"'${OWNER}'\", \"repo\": \"'${REPO}'\" }" }' https://api.github.com/graphql) json=$(curl -s -H 'Content-Type: application/json' -H "Authorization: bearer ${{ secrets.GITHUB_TOKEN }}" -X POST -d '{"query": "query($issue: Int!, $owner: String!, $repo: String!) { repository(owner: $owner, name: $repo) { issue(number: $issue) { projectCards { nodes { project { name } isArchived } } } } } ", "variables" : "{ \"issue\": '${ISSUE}', \"owner\": \"'${OWNER}'\", \"repo\": \"'${REPO}'\" }" }' https://api.github.com/graphql)
if echo $json | jq '.data.repository.issue.projectCards.nodes | length'; then if echo $json | jq '.data.repository.issue.projectCards.nodes | length'; then
if [[ $(echo $json | jq '.data.repository.issue.projectCards.nodes[0].project.name') =~ "${BOARD_NAME}" ]]; then if [[ $(echo $json | jq '.data.repository.issue.projectCards.nodes[0].project.name') =~ "${BOARD_NAME}" ]]; then
if [[ $(echo $json | jq '.data.repository.issue.projectCards.nodes[0].isArchived') == 'true' ]]; then if [[ $(echo $json | jq '.data.repository.issue.projectCards.nodes[0].isArchived') == 'true' ]]; then
echo "Issue is already in Project '$BOARD_NAME', but is archived - skipping workflow"; echo "Issue is already in Project '$BOARD_NAME', but is archived - skipping workflow";
echo "SKIP_ACTION=true" >> $GITHUB_ENV echo "SKIP_ACTION=true" >> $GITHUB_ENV
else else
echo "Issue is already in Project '$BOARD_NAME', proceeding"; echo "Issue is already in Project '$BOARD_NAME', proceeding";
echo "ALREADY_IN_BOARD=true" >> $GITHUB_ENV echo "ALREADY_IN_BOARD=true" >> $GITHUB_ENV
fi fi
else else
echo "Issue is not in project '$BOARD_NAME', cancelling this workflow" echo "Issue is not in project '$BOARD_NAME', cancelling this workflow"
echo "ALREADY_IN_BOARD=false" >> $GITHUB_ENV echo "ALREADY_IN_BOARD=false" >> $GITHUB_ENV
fi fi
fi fi
- name: Move issue - name: Move issue
uses: alex-page/github-project-automation-plus@7ffb872c64bd809d23563a130a0a97d01dfa8f43 uses: alex-page/github-project-automation-plus@bb266ff4dde9242060e2d5418e120a133586d488
if: ${{ env.ALREADY_IN_BOARD == 'true' && env.SKIP_ACTION != 'true' }} if: ${{ env.ALREADY_IN_BOARD == 'true' && env.SKIP_ACTION != 'true' }}
with: with:
project: Issue triage project: Issue triage
column: Triaged column: Triaged
repo-token: ${{ secrets.ELEMENT_BOT_TOKEN }} repo-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
remove_Z-Labs_label: remove_Z-Labs_label:
name: Remove Z-Labs label when features behind labs flags are removed name: Remove Z-Labs label when features behind labs flags are removed
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: > if: >
!(contains(github.event.issue.labels.*.name, 'A-Maths') || !(contains(github.event.issue.labels.*.name, 'A-Maths') ||
contains(github.event.issue.labels.*.name, 'A-Message-Pinning') || contains(github.event.issue.labels.*.name, 'A-Message-Pinning') ||
contains(github.event.issue.labels.*.name, 'A-Location-Sharing') || contains(github.event.issue.labels.*.name, 'A-Threads') ||
contains(github.event.issue.labels.*.name, 'Z-IA') || contains(github.event.issue.labels.*.name, 'A-Polls') ||
contains(github.event.issue.labels.*.name, 'A-Jump-To-Date') || contains(github.event.issue.labels.*.name, 'A-Location-Sharing') ||
contains(github.event.issue.labels.*.name, 'A-Themes-Custom') || contains(github.event.issue.labels.*.name, 'A-Message-Bubbles') ||
contains(github.event.issue.labels.*.name, 'A-E2EE-Dehydration') || contains(github.event.issue.labels.*.name, 'Z-IA') ||
contains(github.event.issue.labels.*.name, 'A-Tags') || contains(github.event.issue.labels.*.name, 'A-Themes-Custom') ||
contains(github.event.issue.labels.*.name, 'A-Video-Rooms') || contains(github.event.issue.labels.*.name, 'A-E2EE-Dehydration') ||
contains(github.event.issue.labels.*.name, 'A-Message-Starring') || contains(github.event.issue.labels.*.name, 'A-Tags') ||
contains(github.event.issue.labels.*.name, 'A-Rich-Text-Editor') || contains(github.event.issue.labels.*.name, 'A-Video-Rooms') ||
contains(github.event.issue.labels.*.name, 'A-Element-Call')) && contains(github.event.issue.labels.*.name, 'A-Message-Starring')) &&
contains(github.event.issue.labels.*.name, 'Z-Labs') contains(github.event.issue.labels.*.name, 'Z-Labs')
steps: steps:
- uses: actions/github-script@v6 - uses: actions/github-script@v5
with: with:
script: | script: |
github.rest.issues.removeLabel({ github.rest.issues.removeLabel({
issue_number: context.issue.number, issue_number: context.issue.number,
owner: context.repo.owner, owner: context.repo.owner,
repo: context.repo.repo, repo: context.repo.repo,
name: ['Z-Labs'] name: ['Z-Labs']
}) })

View File

@@ -1,95 +0,0 @@
name: Update release topics
on:
workflow_dispatch:
inputs:
expected_status:
description: What type of release is the next expected release
required: true
default: RC
type: choice
options:
- RC
- Release
expected_date:
description: Expected release date e.g. July 11th
required: true
type: string
concurrency: ${{ github.workflow }}
jobs:
bot:
name: Release topic update
runs-on: ubuntu-latest
environment: Matrix
steps:
- uses: actions/github-script@v6
env:
HS_URL: ${{ secrets.BETABOT_HS_URL }}
LOBBY_ROOM_ID: ${{ secrets.ROOM_ID }}
PUBLIC_ROOM_ID: "!YTvKGNlinIzlkMTVRl:matrix.org"
ANNOUNCEMENT_ROOM_ID: "!bijaLdadorKgNGtHdA:matrix.org"
TOKEN: ${{ secrets.BETABOT_ACCESS_TOKEN }}
RELEASE_STATUS: "Release status: ${{ inputs.expected_status }} expected ${{ inputs.expected_date }}"
with:
script: |
const { HS_URL, TOKEN, RELEASE_STATUS, LOBBY_ROOM_ID, PUBLIC_ROOM_ID, ANNOUNCEMENT_ROOM_ID } = process.env;
const repo = context.repo;
const { data } = await github.rest.repos.getLatestRelease({
owner: repo.owner,
repo: repo.repo,
});
console.log("Found latest version: " + data.tag_name);
const releaseTopic = `Stable: ${data.tag_name} | ${RELEASE_STATUS}`;
console.log("Release topic: " + releaseTopic);
const regex = /Stable: v(.+) \| Release status: (\w+) expected (\w+ \d+\w\w)/gm;
async function updateReleaseInTopic(roomId) {
const apiUrl = `${HS_URL}/_matrix/client/v3/rooms/${roomId}/state/m.room.topic/`;
const headers = {
"Content-Type": "application/json",
"Authorization": `Bearer ${TOKEN}`,
};
await fetch(`${HS_URL}/_matrix/client/v3/rooms/${roomId}/join`, {
method: "POST",
headers,
body: "{}",
});
let res = await fetch(apiUrl, {
method: "GET",
headers,
});
const data = await res.json();
const topic = data.topic.replace(regex, releaseTopic);
if (topic === data.topic) {
console.log(roomId, "nothing to do");
return;
}
if (data["org.matrix.msc3765.topic"]) {
data["org.matrix.msc3765.topic"].forEach(d => {
d.body = d.body.replace(regex, releaseTopic);
});
}
res = await fetch(apiUrl, {
method: "PUT",
body: JSON.stringify({
...data,
topic,
}),
headers,
});
if (res.ok) {
console.log(roomId, "topic updated:", topic);
} else {
console.log(roomId, await res.text());
}
}
await updateReleaseInTopic(LOBBY_ROOM_ID);
await updateReleaseInTopic(PUBLIC_ROOM_ID);
await updateReleaseInTopic(ANNOUNCEMENT_ROOM_ID);

View File

@@ -1,8 +1,8 @@
name: Upgrade Dependencies name: Upgrade Dependencies
on: on:
workflow_dispatch: {} workflow_dispatch: { }
jobs: jobs:
upgrade: upgrade:
uses: matrix-org/matrix-js-sdk/.github/workflows/upgrade_dependencies.yml@develop uses: matrix-org/matrix-js-sdk/.github/workflows/upgrade_dependencies.yml@develop
secrets: secrets:
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }} ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}

View File

@@ -1,36 +1,36 @@
{ {
"minify": true, "minify": true,
"enableClasses": false, "enableClasses": false,
"feature-detects": [ "feature-detects": [
"test/css/animations", "test/css/animations",
"test/css/displaytable", "test/css/displaytable",
"test/css/filters", "test/css/filters",
"test/css/flexbox", "test/css/flexbox",
"test/css/objectfit", "test/css/objectfit",
"test/es5/date", "test/es5/date",
"test/es5/function", "test/es5/function",
"test/es5/object", "test/es5/object",
"test/es5/undefined", "test/es5/undefined",
"test/es6/array", "test/es6/array",
"test/es6/collections", "test/es6/collections",
"test/es6/promises", "test/es6/promises",
"test/es6/string", "test/es6/string",
"test/svg", "test/svg",
"test/svg/asimg", "test/svg/asimg",
"test/svg/filters", "test/svg/filters",
"test/url/parser", "test/url/parser",
"test/url/urlsearchparams", "test/url/urlsearchparams",
"test/cors", "test/cors",
"test/crypto", "test/crypto",
"test/iframe/sandbox", "test/iframe/sandbox",
"test/json", "test/json",
"test/network/fetch", "test/network/fetch",
"test/storage/localstorage", "test/storage/localstorage",
"test/window/resizeobserver" "test/window/resizeobserver"
] ]
} }

View File

@@ -1,27 +0,0 @@
/build
/dist
/lib
/node_modules
/packages/
/webapp
/*.log
yarn.lock
electron/dist
electron/pub
**/.idea
/.tmp
/webpack-stats.json
.vscode
.vscode/
.env
/coverage
# Auto-generated file
/src/modules.ts
/src/i18n/strings
/build_config.yaml
# Raises an error because it contains a template var breaking the script tag
src/vector/index.html
src/vector/modernizr.js
# This file is owned, parsed, and generated by allchange, which doesn't comply with prettier
/CHANGELOG.md

View File

@@ -1 +0,0 @@
module.exports = require("eslint-plugin-matrix-org/.prettierrc.js");

0
.sentryclirc Normal file
View File

View File

@@ -1,4 +1,3 @@
module.exports = { module.exports = {
...require("matrix-react-sdk/.stylelintrc.js"), ...require("matrix-react-sdk/.stylelintrc.js"),
extends: ["stylelint-config-standard"],
}; };

File diff suppressed because it is too large Load Diff

View File

@@ -1,4 +1,5 @@
# Contributing code to Element Web Contributing code to Element Web
================================
Everyone is welcome to contribute code to Element Web, provided that they are Everyone is welcome to contribute code to Element Web, provided that they are
willing to license their contributions under the same license as the project willing to license their contributions under the same license as the project
@@ -8,7 +9,8 @@ license the code under the same terms as the project's overall 'outbound'
license - in this case, Apache Software License v2 (see license - in this case, Apache Software License v2 (see
[LICENSE](LICENSE)). [LICENSE](LICENSE)).
## How to contribute How to contribute
-----------------
The preferred and easiest way to contribute changes to the project is to fork The preferred and easiest way to contribute changes to the project is to fork
it on github, and then create a pull request to ask us to pull your changes it on github, and then create a pull request to ask us to pull your changes
@@ -17,48 +19,39 @@ into our repo (https://help.github.com/articles/using-pull-requests/)
We use GitHub's pull request workflow to review the contribution, and either We use GitHub's pull request workflow to review the contribution, and either
ask you to make any refinements needed or merge it and make them ourselves. ask you to make any refinements needed or merge it and make them ourselves.
Your PR should have a title that describes what change is being made. This Things that should go into your PR description:
is used for the text in the Changelog entry by default (see below), so a good * A changelog entry in the `Notes` section (see below)
title will tell a user succinctly what change is being made. "Fix bug where * References to any bugs fixed by the change (in GitHub's `Fixes` notation)
cows had five legs" and, "Add support for miniature horses" are examples of good * Describe the why and what is changing in the PR description so it's easy for
titles. Don't include an issue number here: that belongs in the description. onlookers and reviewers to onboard and context switch. This information is
Definitely don't use the GitHub default of "Update file.ts". also helpful when we come back to look at this in 6 months and ask "why did
we do it like that?" we have a chance of finding out.
As for your PR description, it should include these things: * Why didn't it work before? Why does it work now? What use cases does it
- References to any bugs fixed by the change (in GitHub's `Fixes` notation)
- Describe the why and what is changing in the PR description so it's easy for
onlookers and reviewers to onboard and context switch. This information is
also helpful when we come back to look at this in 6 months and ask "why did
we do it like that?" we have a chance of finding out.
- Why didn't it work before? Why does it work now? What use cases does it
unlock? unlock?
- If you find yourself adding information on how the code works or why you * If you find yourself adding information on how the code works or why you
chose to do it the way you did, make sure this information is instead chose to do it the way you did, make sure this information is instead
written as comments in the code itself. written as comments in the code itself.
- Sometimes a PR can change considerably as it is developed. In this case, * Sometimes a PR can change considerably as it is developed. In this case,
the description should be updated to reflect the most recent state of the description should be updated to reflect the most recent state of
the PR. (It can be helpful to retain the old content under a suitable the PR. (It can be helpful to retain the old content under a suitable
heading, for additional context.) heading, for additional context.)
- Include both **before** and **after** screenshots to easily compare and discuss * Include both **before** and **after** screenshots to easily compare and discuss
what's changing. what's changing.
- Include a step-by-step testing strategy so that a reviewer can check out the * Include a step-by-step testing strategy so that a reviewer can check out the
code locally and easily get to the point of testing your change. code locally and easily get to the point of testing your change.
- Add comments to the diff for the reviewer that might help them to understand * Add comments to the diff for the reviewer that might help them to understand
why the change is necessary or how they might better understand and review it. why the change is necessary or how they might better understand and review it.
### Changelogs We rely on information in pull request to populate the information that goes into
the changelogs our users see, both for Element Web itself and other projects on
There's no need to manually add Changelog entries: we use information in the which it is based. This is picked up from both labels on the pull request and
pull request to populate the information that goes into the changelogs our the `Notes:` annotation in the description. By default, the PR title will be
users see, both for Element Web itself and other projects on which it is based. used for the changelog entry, but you can specify more options, as follows.
This is picked up from both labels on the pull request and the `Notes:`
annotation in the description. By default, the PR title will be used for the
changelog entry, but you can specify more options, as follows.
To add a longer, more detailed description of the change for the changelog: To add a longer, more detailed description of the change for the changelog:
_Fix llama herding bug_
*Fix llama herding bug*
``` ```
Notes: Fix a bug (https://github.com/matrix-org/notaproject/issues/123) where the 'Herd' button would not herd more than 8 Llamas if the moon was in the waxing gibbous phase Notes: Fix a bug (https://github.com/matrix-org/notaproject/issues/123) where the 'Herd' button would not herd more than 8 Llamas if the moon was in the waxing gibbous phase
@@ -67,8 +60,7 @@ Notes: Fix a bug (https://github.com/matrix-org/notaproject/issues/123) where th
For some PRs, it's not useful to have an entry in the user-facing changelog (this is For some PRs, it's not useful to have an entry in the user-facing changelog (this is
the default for PRs labelled with `T-Task`): the default for PRs labelled with `T-Task`):
_Remove outdated comment from `Ungulates.ts`_ *Remove outdated comment from `Ungulates.ts`*
``` ```
Notes: none Notes: none
``` ```
@@ -76,18 +68,16 @@ Notes: none
Sometimes, you're fixing a bug in a downstream project, in which case you want Sometimes, you're fixing a bug in a downstream project, in which case you want
an entry in that project's changelog. You can do that too: an entry in that project's changelog. You can do that too:
_Fix another herding bug_ *Fix another herding bug*
``` ```
Notes: Fix a bug where the `herd()` function would only work on Tuesdays Notes: Fix a bug where the `herd()` function would only work on Tuesdays
element-web notes: Fix a bug where the 'Herd' button only worked on Tuesdays element-web notes: Fix a bug where the 'Herd' button only worked on Tuesdays
``` ```
This example is for Element Web. You can specify: This example is for Element Web. You can specify:
* matrix-react-sdk
- matrix-react-sdk * element-web
- element-web * element-desktop
- element-desktop
If your PR introduces a breaking change, use the `Notes` section in the same If your PR introduces a breaking change, use the `Notes` section in the same
way, additionally adding the `X-Breaking-Change` label (see below). There's no need way, additionally adding the `X-Breaking-Change` label (see below). There's no need
@@ -95,18 +85,17 @@ to specify in the notes that it's a breaking change - this will be added
automatically based on the label - but remember to tell the developer how to automatically based on the label - but remember to tell the developer how to
migrate: migrate:
_Remove legacy class_ *Remove legacy class*
``` ```
Notes: Remove legacy `Camelopard` class. `Giraffe` should be used instead. Notes: Remove legacy `Camelopard` class. `Giraffe` should be used instead.
``` ```
Other metadata can be added using labels. Other metadata can be added using labels.
* `X-Breaking-Change`: A breaking change - adding this label will mean the change causes a *major* version bump.
- `X-Breaking-Change`: A breaking change - adding this label will mean the change causes a _major_ version bump. * `T-Enhancement`: A new feature - adding this label will mean the change causes a *minor* version bump.
- `T-Enhancement`: A new feature - adding this label will mean the change causes a _minor_ version bump. * `T-Defect`: A bug fix (in either code or docs).
- `T-Defect`: A bug fix (in either code or docs). * `T-Task`: No user-facing changes, eg. code comments, CI fixes, refactors or tests. Won't have a changelog entry unless you specify one.
- `T-Task`: No user-facing changes, eg. code comments, CI fixes, refactors or tests. Won't have a changelog entry unless you specify one.
If you don't have permission to add labels, your PR reviewer(s) can work with you If you don't have permission to add labels, your PR reviewer(s) can work with you
to add them: ask in the PR description or comments. to add them: ask in the PR description or comments.
@@ -115,8 +104,8 @@ We use continuous integration, and all pull requests get automatically tested:
if your change breaks the build, then the PR will show that there are failed if your change breaks the build, then the PR will show that there are failed
checks, so please check back after a few minutes. checks, so please check back after a few minutes.
## Tests Tests
-----
Your PR should include tests. Your PR should include tests.
For new user facing features in `matrix-js-sdk`, `matrix-react-sdk` or `element-web`, you For new user facing features in `matrix-js-sdk`, `matrix-react-sdk` or `element-web`, you
@@ -140,7 +129,7 @@ end-to-end test; which is best depends on what sort of test most concisely
exercises the area. exercises the area.
Changes to must be accompanied by unit tests written in Jest. Changes to must be accompanied by unit tests written in Jest.
These are located in `/spec/` in `matrix-js-sdk` or `/test/` in `element-web` These are located in `/spec/` in `matrix-js-sdk` or `/test/` in `element-web`
and `matrix-react-sdk`. and `matrix-react-sdk`.
When writing unit tests, please aim for a high level of test coverage When writing unit tests, please aim for a high level of test coverage
@@ -150,7 +139,6 @@ why it's not possible in your PR.
Some sections of code are not sensible to add coverage for, such as those Some sections of code are not sensible to add coverage for, such as those
which explicitly inhibit noisy logging for tests. Which can be hidden using which explicitly inhibit noisy logging for tests. Which can be hidden using
an istanbul magic comment as [documented here][1]. See example: an istanbul magic comment as [documented here][1]. See example:
```javascript ```javascript
/* istanbul ignore if */ /* istanbul ignore if */
if (process.env.NODE_ENV !== "test") { if (process.env.NODE_ENV !== "test") {
@@ -172,8 +160,8 @@ tests later will become progressively more difficult.
If you're not sure how to approach writing tests for your change, ask for help If you're not sure how to approach writing tests for your change, ask for help
in [#element-dev](https://matrix.to/#/#element-dev:matrix.org). in [#element-dev](https://matrix.to/#/#element-dev:matrix.org).
## Code style Code style
----------
Element Web aims to target TypeScript/ES6. All new files should be written in Element Web aims to target TypeScript/ES6. All new files should be written in
TypeScript and existing files should use ES6 principles where possible. TypeScript and existing files should use ES6 principles where possible.
@@ -186,11 +174,11 @@ The remaining code style is documented in [code_style.md](./code_style.md).
Contributors are encouraged to it and follow the principles set out there. Contributors are encouraged to it and follow the principles set out there.
Please ensure your changes match the cosmetic style of the existing project, Please ensure your changes match the cosmetic style of the existing project,
and **_never_** mix cosmetic and functional changes in the same commit, as it and ***never*** mix cosmetic and functional changes in the same commit, as it
makes it horribly hard to review otherwise. makes it horribly hard to review otherwise.
## Attribution Attribution
-----------
Everyone who contributes anything to Matrix is welcome to be listed in the Everyone who contributes anything to Matrix is welcome to be listed in the
AUTHORS.rst file for the project in question. Please feel free to include a AUTHORS.rst file for the project in question. Please feel free to include a
change to AUTHORS.rst in your pull request to list yourself and a short change to AUTHORS.rst in your pull request to list yourself and a short
@@ -199,8 +187,8 @@ give away to contributors - if you feel that Matrix-branded apparel is missing
from your life, please mail us your shipping address to matrix at matrix.org from your life, please mail us your shipping address to matrix at matrix.org
and we'll try to fix it :) and we'll try to fix it :)
## Sign off Sign off
--------
In order to have a concrete record that your contribution is intentional In order to have a concrete record that your contribution is intentional
and you agree to license it under the same terms as the project's license, we've and you agree to license it under the same terms as the project's license, we've
adopted the same lightweight approach that the Linux Kernel adopted the same lightweight approach that the Linux Kernel
@@ -271,16 +259,19 @@ on Git 2.17+ you can mass signoff using rebase:
git rebase --signoff origin/develop git rebase --signoff origin/develop
``` ```
# Review expectations Review expectations
===================
See https://github.com/vector-im/element-meta/wiki/Review-process See https://github.com/vector-im/element-meta/wiki/Review-process
# Merge Strategy
Merge Strategy
==============
The preferred method for merging pull requests is squash merging to keep the The preferred method for merging pull requests is squash merging to keep the
commit history trim, but it is up to the discretion of the team member merging commit history trim, but it is up to the discretion of the team member merging
the change. We do not support rebase merges due to `allchange` being unable to the change. We do not support rebase merges due to `allchange` being unable to
handle them. When merging make sure to leave the default commit title, or handle them. When merging make sure to leave the default commit title, or
at least leave the PR number at the end in brackets like by default. at least leave the PR number at the end in brackets like by default.
When stacking pull requests, you may wish to do the following: When stacking pull requests, you may wish to do the following:
@@ -288,11 +279,5 @@ When stacking pull requests, you may wish to do the following:
2. Branch from your base branch (branch1) to your work branch (branch2), push commits and open a pull request configuring the base to be branch1, saying in the description that it is based on your other PR. 2. Branch from your base branch (branch1) to your work branch (branch2), push commits and open a pull request configuring the base to be branch1, saying in the description that it is based on your other PR.
3. Merge the first PR using a merge commit otherwise your stacked PR will need a rebase. Github will automatically adjust the base branch of your other PR to be develop. 3. Merge the first PR using a merge commit otherwise your stacked PR will need a rebase. Github will automatically adjust the base branch of your other PR to be develop.
[1]: https://github.com/gotwarlost/istanbul/blob/master/ignoring-code-for-coverage.md [1]: https://github.com/gotwarlost/istanbul/blob/master/ignoring-code-for-coverage.md
# Decoding Stack Traces
Element Web has crashed and given you an obfuscated stack trace? Don't panic:
use the [Decoder Ring](https://app.element.io/decoder-ring/) (or /decoder-ring/
on any Element Web deploy). It is somewhat of a manual process, but it should
tell you what lines the stack trace corresponds to from the source maps.

View File

@@ -1,5 +1,5 @@
# Builder # Builder
FROM --platform=$BUILDPLATFORM node:20-bullseye as builder FROM node:14-buster as builder
# Support custom branches of the react-sdk and js-sdk. This also helps us build # Support custom branches of the react-sdk and js-sdk. This also helps us build
# images of element-web develop. # images of element-web develop.
@@ -15,7 +15,7 @@ WORKDIR /src
COPY . /src COPY . /src
RUN dos2unix /src/scripts/docker-link-repos.sh && bash /src/scripts/docker-link-repos.sh RUN dos2unix /src/scripts/docker-link-repos.sh && bash /src/scripts/docker-link-repos.sh
RUN yarn --network-timeout=200000 install RUN yarn --network-timeout=100000 install
RUN dos2unix /src/scripts/docker-package.sh && bash /src/scripts/docker-package.sh RUN dos2unix /src/scripts/docker-package.sh && bash /src/scripts/docker-package.sh
@@ -23,7 +23,7 @@ RUN dos2unix /src/scripts/docker-package.sh && bash /src/scripts/docker-package.
RUN cp /src/config.sample.json /src/webapp/config.json RUN cp /src/config.sample.json /src/webapp/config.json
# App # App
FROM nginx:alpine-slim FROM nginx:alpine
COPY --from=builder /src/webapp /app COPY --from=builder /src/webapp /app

143
README.md
View File

@@ -7,35 +7,37 @@
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=element-web&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=element-web) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=element-web&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=element-web)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=element-web&metric=bugs)](https://sonarcloud.io/summary/new_code?id=element-web) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=element-web&metric=bugs)](https://sonarcloud.io/summary/new_code?id=element-web)
# Element Element
=======
Element (formerly known as Vector and Riot) is a Matrix web client built using the [Matrix Element (formerly known as Vector and Riot) is a Matrix web client built using the [Matrix
React SDK](https://github.com/matrix-org/matrix-react-sdk). React SDK](https://github.com/matrix-org/matrix-react-sdk).
# Supported Environments Supported Environments
======================
Element has several tiers of support for different environments: Element has several tiers of support for different environments:
- Supported * Supported
- Definition: Issues **actively triaged**, regressions **block** the release * Definition: Issues **actively triaged**, regressions **block** the release
- Last 2 major versions of Chrome, Firefox, and Edge on desktop OSes * Last 2 major versions of Chrome, Firefox, Safari, and Edge on desktop OSes
- Last 2 versions of Safari * Latest release of official Element Desktop app on desktop OSes
- Latest release of official Element Desktop app on desktop OSes * Desktop OSes means macOS, Windows, and Linux versions for desktop devices
- Desktop OSes means macOS, Windows, and Linux versions for desktop devices that are actively supported by the OS vendor and receive security updates
that are actively supported by the OS vendor and receive security updates * Experimental
- Experimental * Definition: Issues **accepted**, regressions **do not block** the release
- Definition: Issues **accepted**, regressions **do not block** the release * Element as an installed PWA via current stable version of Chrome, Firefox, and Safari
- Element as an installed PWA via current stable version of Chrome * Mobile web for current stable version of Chrome, Firefox, and Safari on Android, iOS, and iPadOS
- Mobile web for current stable version of Chrome, Firefox, and Safari on Android, iOS, and iPadOS * Not supported
- Not supported * Definition: Issues only affecting unsupported environments are **closed**
- Definition: Issues only affecting unsupported environments are **closed** * Everything else
- Everything else
For accessing Element on an Android or iOS device, we currently recommend the For accessing Element on an Android or iOS device, we currently recommend the
native apps [element-android](https://github.com/vector-im/element-android) native apps [element-android](https://github.com/vector-im/element-android)
and [element-ios](https://github.com/vector-im/element-ios). and [element-ios](https://github.com/vector-im/element-ios).
# Getting Started Getting Started
===============
The easiest way to test Element is to just use the hosted copy at <https://app.element.io>. The easiest way to test Element is to just use the hosted copy at <https://app.element.io>.
The `develop` branch is continuously deployed to <https://develop.element.io> The `develop` branch is continuously deployed to <https://develop.element.io>
@@ -65,39 +67,47 @@ and thus allowed.
To install Element as a desktop application, see [Running as a desktop To install Element as a desktop application, see [Running as a desktop
app](#running-as-a-desktop-app) below. app](#running-as-a-desktop-app) below.
# Important Security Notes Important Security Notes
========================
## Separate domains Separate domains
----------------
We do not recommend running Element from the same domain name as your Matrix We do not recommend running Element from the same domain name as your Matrix
homeserver. The reason is the risk of XSS (cross-site-scripting) homeserver. The reason is the risk of XSS (cross-site-scripting)
vulnerabilities that could occur if someone caused Element to load and render vulnerabilities that could occur if someone caused Element to load and render
malicious user generated content from a Matrix API which then had trusted malicious user generated content from a Matrix API which then had trusted
access to Element (or other apps) due to sharing the same domain. access to Element (or other apps) due to sharing the same domain.
We have put some coarse mitigations into place to try to protect against this We have put some coarse mitigations into place to try to protect against this
situation, but it's still not good practice to do it in the first place. See situation, but it's still not good practice to do it in the first place. See
<https://github.com/vector-im/element-web/issues/1977> for more details. <https://github.com/vector-im/element-web/issues/1977> for more details.
## Configuration best practices Configuration best practices
----------------------------
Unless you have special requirements, you will want to add the following to Unless you have special requirements, you will want to add the following to
your web server configuration when hosting Element Web: your web server configuration when hosting Element Web:
- The `X-Frame-Options: SAMEORIGIN` header, to prevent Element Web from being * The `X-Frame-Options: SAMEORIGIN` header, to prevent Element Web from being
framed and protect from [clickjacking][owasp-clickjacking]. framed and protect from [clickjacking][owasp-clickjacking].
- The `frame-ancestors 'self'` directive to your `Content-Security-Policy` * The `frame-ancestors 'none'` directive to your `Content-Security-Policy`
header, as the modern replacement for `X-Frame-Options` (though both should be header, as the modern replacement for `X-Frame-Options` (though both should be
included since not all browsers support it yet, see included since not all browsers support it yet, see
[this][owasp-clickjacking-csp]). [this][owasp-clickjacking-csp]).
- The `X-Content-Type-Options: nosniff` header, to [disable MIME * The `X-Content-Type-Options: nosniff` header, to [disable MIME
sniffing][mime-sniffing]. sniffing][mime-sniffing].
- The `X-XSS-Protection: 1; mode=block;` header, for basic XSS protection in * The `X-XSS-Protection: 1; mode=block;` header, for basic XSS protection in
legacy browsers. legacy browsers.
[mime-sniffing]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#mime_sniffing [mime-sniffing]:
[owasp-clickjacking-csp]: https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet.html#content-security-policy-frame-ancestors-examples <https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#mime_sniffing>
[owasp-clickjacking]: https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet.html
[owasp-clickjacking-csp]:
<https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet.html#content-security-policy-frame-ancestors-examples>
[owasp-clickjacking]:
<https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet.html>
If you are using nginx, this would look something like the following: If you are using nginx, this would look something like the following:
@@ -105,23 +115,15 @@ If you are using nginx, this would look something like the following:
add_header X-Frame-Options SAMEORIGIN; add_header X-Frame-Options SAMEORIGIN;
add_header X-Content-Type-Options nosniff; add_header X-Content-Type-Options nosniff;
add_header X-XSS-Protection "1; mode=block"; add_header X-XSS-Protection "1; mode=block";
add_header Content-Security-Policy "frame-ancestors 'self'"; add_header Content-Security-Policy "frame-ancestors 'none'";
```
For Apache, the configuration looks like:
```
Header set X-Frame-Options SAMEORIGIN
Header set X-Content-Type-Options nosniff
Header set X-XSS-Protection "1; mode=block"
Header set Content-Security-Policy "frame-ancestors 'self'"
``` ```
Note: In case you are already setting a `Content-Security-Policy` header Note: In case you are already setting a `Content-Security-Policy` header
elsewhere, you should modify it to include the `frame-ancestors` directive elsewhere, you should modify it to include the `frame-ancestors` directive
instead of adding that last line. instead of adding that last line.
# Building From Source Building From Source
====================
Element is a modular webapp built with modern ES6 and uses a Node.js build system. Element is a modular webapp built with modern ES6 and uses a Node.js build system.
Ensure you have the latest LTS version of Node.js installed. Ensure you have the latest LTS version of Node.js installed.
@@ -134,7 +136,7 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread
1. Clone the repo: `git clone https://github.com/vector-im/element-web.git`. 1. Clone the repo: `git clone https://github.com/vector-im/element-web.git`.
1. Switch to the element-web directory: `cd element-web`. 1. Switch to the element-web directory: `cd element-web`.
1. Install the prerequisites: `yarn install`. 1. Install the prerequisites: `yarn install`.
- If you're using the `develop` branch, then it is recommended to set up a * If you're using the `develop` branch, then it is recommended to set up a
proper development environment (see [Setting up a dev proper development environment (see [Setting up a dev
environment](#setting-up-a-dev-environment) below). Alternatively, you environment](#setting-up-a-dev-environment) below). Alternatively, you
can use <https://develop.element.io> - the continuous integration release of can use <https://develop.element.io> - the continuous integration release of
@@ -151,7 +153,8 @@ will not appear in Settings without using the dist script. You can then mount th
`webapp` directory on your web server to actually serve up the app, which is `webapp` directory on your web server to actually serve up the app, which is
entirely static content. entirely static content.
# Running as a Desktop app Running as a Desktop app
========================
Element can also be run as a desktop app, wrapped in Electron. You can download a Element can also be run as a desktop app, wrapped in Electron. You can download a
pre-built version from <https://element.io/get-started> or, if you prefer, pre-built version from <https://element.io/get-started> or, if you prefer,
@@ -163,7 +166,7 @@ Many thanks to @aviraldg for the initial work on the Electron integration.
Other options for running as a desktop app: Other options for running as a desktop app:
- @asdf:matrix.org points out that you can use nativefier and it just works(tm) * @asdf:matrix.org points out that you can use nativefier and it just works(tm)
```bash ```bash
yarn global add nativefier yarn global add nativefier
@@ -173,7 +176,8 @@ nativefier https://app.element.io/
The [configuration docs](docs/config.md#desktop-app-configuration) show how to The [configuration docs](docs/config.md#desktop-app-configuration) show how to
override the desktop app's default settings if desired. override the desktop app's default settings if desired.
# Running from Docker Running from Docker
===================
The Docker image can be used to serve element-web as a web server. The easiest way to use The Docker image can be used to serve element-web as a web server. The easiest way to use
it is to use the prebuilt image: it is to use the prebuilt image:
@@ -212,22 +216,26 @@ docker build -t \
. .
``` ```
# Running in Kubernetes Running in Kubernetes
=====================
The provided element-web docker image can also be run from within a Kubernetes cluster. The provided element-web docker image can also be run from within a Kubernetes cluster.
See the [Kubernetes example](docs/kubernetes.md) for more details. See the [Kubernetes example](docs/kubernetes.md) for more details.
# config.json config.json
===========
Element supports a variety of settings to configure default servers, behaviour, themes, etc. Element supports a variety of settings to configure default servers, behaviour, themes, etc.
See the [configuration docs](docs/config.md) for more details. See the [configuration docs](docs/config.md) for more details.
# Labs Features Labs Features
=============
Some features of Element may be enabled by flags in the `Labs` section of the settings. Some features of Element may be enabled by flags in the `Labs` section of the settings.
Some of these features are described in [labs.md](https://github.com/vector-im/element-web/blob/develop/docs/labs.md). Some of these features are described in [labs.md](https://github.com/vector-im/element-web/blob/develop/docs/labs.md).
# Caching requirements Caching requirements
====================
Element requires the following URLs not to be cached, when/if you are serving Element from your own webserver: Element requires the following URLs not to be cached, when/if you are serving Element from your own webserver:
@@ -244,7 +252,8 @@ webserver to return `Cache-Control: no-cache` for `/`. This ensures the browser
the next page load after it's been deployed. Note that this is already configured for you in the nginx config of our the next page load after it's been deployed. Note that this is already configured for you in the nginx config of our
Dockerfile. Dockerfile.
# Development Development
===========
Before attempting to develop on Element you **must** read the [developer guide Before attempting to develop on Element you **must** read the [developer guide
for `matrix-react-sdk`](https://github.com/matrix-org/matrix-react-sdk#developer-guide), which for `matrix-react-sdk`](https://github.com/matrix-org/matrix-react-sdk#developer-guide), which
@@ -266,7 +275,7 @@ higher and lower level React components useful for building Matrix communication
apps using React. apps using React.
Please note that Element is intended to run correctly without access to the public Please note that Element is intended to run correctly without access to the public
internet. So please don't depend on resources (JS libs, CSS, images, fonts) internet. So please don't depend on resources (JS libs, CSS, images, fonts)
hosted by external CDNs or servers but instead please package all dependencies hosted by external CDNs or servers but instead please package all dependencies
into Element itself. into Element itself.
@@ -274,7 +283,8 @@ CSS hot-reload is available as an opt-in development feature. You can enable it
by defining a `CSS_HOT_RELOAD` environment variable, in a `.env` file in the root by defining a `CSS_HOT_RELOAD` environment variable, in a `.env` file in the root
of the repository. See `.env.example` for documentation and an example. of the repository. See `.env.example` for documentation and an example.
# Setting up a dev environment Setting up a dev environment
============================
Much of the functionality in Element is actually in the `matrix-react-sdk` and Much of the functionality in Element is actually in the `matrix-react-sdk` and
`matrix-js-sdk` modules. It is possible to set these up in a way that makes it `matrix-js-sdk` modules. It is possible to set these up in a way that makes it
@@ -283,7 +293,7 @@ having to manually rebuild each time.
First clone and build `matrix-js-sdk`: First clone and build `matrix-js-sdk`:
```bash ``` bash
git clone https://github.com/matrix-org/matrix-js-sdk.git git clone https://github.com/matrix-org/matrix-js-sdk.git
pushd matrix-js-sdk pushd matrix-js-sdk
yarn link yarn link
@@ -330,9 +340,9 @@ Wait a few seconds for the initial build to finish; you should see something lik
[element-js] 「wdm」: Compiled successfully. [element-js] 「wdm」: Compiled successfully.
``` ```
Remember, the command will not terminate since it runs the web server Remember, the command will not terminate since it runs the web server
and rebuilds source files when they change. This development server also and rebuilds source files when they change. This development server also
disables caching, so do NOT use it in production. disables caching, so do NOT use it in production.
Open <http://127.0.0.1:8080/> in your browser to see your newly built Element. Open <http://127.0.0.1:8080/> in your browser to see your newly built Element.
@@ -360,7 +370,7 @@ echo fs.inotify.max_user_instances=512 | sudo tee -a /etc/sysctl.conf
sudo sysctl -p sudo sysctl -p
``` ```
--- ___
When you make changes to `matrix-react-sdk` or `matrix-js-sdk` they should be When you make changes to `matrix-react-sdk` or `matrix-js-sdk` they should be
automatically picked up by webpack and built. automatically picked up by webpack and built.
@@ -369,7 +379,8 @@ If any of these steps error with, `file table overflow`, you are probably on a m
which has a very low limit on max open files. Run `ulimit -Sn 1024` and try again. which has a very low limit on max open files. Run `ulimit -Sn 1024` and try again.
You'll need to do this in each new terminal you open before building Element. You'll need to do this in each new terminal you open before building Element.
## Running the tests Running the tests
-----------------
There are a number of application-level tests in the `tests` directory; these There are a number of application-level tests in the `tests` directory; these
are designed to run with Jest and JSDOM. To run them are designed to run with Jest and JSDOM. To run them
@@ -382,7 +393,8 @@ yarn test
See [matrix-react-sdk](https://github.com/matrix-org/matrix-react-sdk/#end-to-end-tests) for how to run the end-to-end tests. See [matrix-react-sdk](https://github.com/matrix-org/matrix-react-sdk/#end-to-end-tests) for how to run the end-to-end tests.
# Translations Translations
============
To add a new translation, head to the [translating doc](docs/translating.md). To add a new translation, head to the [translating doc](docs/translating.md).
@@ -390,7 +402,8 @@ For a developer guide, see the [translating dev doc](docs/translating-dev.md).
[<img src="https://translate.element.io/widgets/element-web/-/multi-auto.svg" alt="translationsstatus" width="340">](https://translate.element.io/engage/element-web/?utm_source=widget) [<img src="https://translate.element.io/widgets/element-web/-/multi-auto.svg" alt="translationsstatus" width="340">](https://translate.element.io/engage/element-web/?utm_source=widget)
# Triaging issues Triaging issues
===============
Issues are triaged by community members and the Web App Team, following the [triage process](https://github.com/vector-im/element-meta/wiki/Triage-process). Issues are triaged by community members and the Web App Team, following the [triage process](https://github.com/vector-im/element-meta/wiki/Triage-process).

View File

@@ -1,34 +1,24 @@
module.exports = { module.exports = {
sourceMaps: true, "sourceMaps": true,
presets: [ "presets": [
[ ["@babel/preset-env", {
"@babel/preset-env", "targets": [
{ "last 2 Chrome versions",
targets: [ "last 2 Firefox versions",
"last 2 Chrome versions", "last 2 Safari versions",
"last 2 Firefox versions", "last 2 Edge versions",
"last 2 Safari versions", ],
"last 2 Edge versions", }],
],
},
],
"@babel/preset-typescript", "@babel/preset-typescript",
"@babel/preset-react", "@babel/preset-react",
], ],
plugins: [ "plugins": [
"@babel/plugin-proposal-export-default-from", "@babel/plugin-proposal-export-default-from",
"@babel/plugin-proposal-numeric-separator", "@babel/plugin-proposal-numeric-separator",
"@babel/plugin-proposal-class-properties", "@babel/plugin-proposal-class-properties",
"@babel/plugin-proposal-object-rest-spread", "@babel/plugin-proposal-object-rest-spread",
"@babel/plugin-proposal-optional-chaining", "@babel/plugin-proposal-optional-chaining",
"@babel/plugin-proposal-nullish-coalescing-operator", "@babel/plugin-proposal-nullish-coalescing-operator",
// transform logical assignment (??=, ||=, &&=). preset-env doesn't
// normally bother with these (presumably because all the target
// browsers support it natively), but they make our webpack version (or
// something downstream of babel, at least) fall over.
"@babel/plugin-proposal-logical-assignment-operators",
"@babel/plugin-syntax-dynamic-import", "@babel/plugin-syntax-dynamic-import",
"@babel/plugin-transform-runtime", "@babel/plugin-transform-runtime",
], ],

View File

@@ -3,10 +3,10 @@
This code style applies to projects which the element-web team directly maintains or is reasonably This code style applies to projects which the element-web team directly maintains or is reasonably
adjacent to. As of writing, these are: adjacent to. As of writing, these are:
- element-desktop * element-desktop
- element-web * element-web
- matrix-react-sdk * matrix-react-sdk
- matrix-js-sdk * matrix-js-sdk
Other projects might extend this code style for increased strictness. For example, matrix-events-sdk Other projects might extend this code style for increased strictness. For example, matrix-events-sdk
has stricter code organization to reduce the maintenance burden. These projects will declare their code has stricter code organization to reduce the maintenance burden. These projects will declare their code
@@ -51,28 +51,60 @@ in that order.
Unless otherwise specified, the following applies to all code: Unless otherwise specified, the following applies to all code:
1. Files must be formatted with Prettier. 1. 120 character limit per line. Match existing code in the file if it is using a lower guide.
2. 120 character limit per line. Match existing code in the file if it is using a lower guide. 2. A tab/indentation is 4 spaces.
3. A tab/indentation is 4 spaces. 3. Newlines are Unix.
4. Newlines are Unix. 4. A file has a single empty line at the end.
5. A file has a single empty line at the end. 5. Lines are trimmed of all excess whitespace, including blank lines.
6. Lines are trimmed of all excess whitespace, including blank lines. 6. Long lines are broken up for readability.
7. Long lines are broken up for readability.
## TypeScript / JavaScript ## TypeScript / JavaScript {#typescript-javascript}
1. Write TypeScript. Turn JavaScript into TypeScript when working in the area. 1. Write TypeScript. Turn JavaScript into TypeScript when working in the area.
2. Use [TSDoc](https://tsdoc.org/) to document your code. See [Comments](#comments) below. 2. Use named exports.
3. Use named exports. 3. Break long lines to appear as follows:
```typescript
// Function arguments
function doThing(
arg1: string,
arg2: string,
arg3: string,
): boolean {
return !!arg1
&& !!arg2
&& !!arg3;
}
// Calling a function
doThing(
"String 1",
"String 2",
"String 3",
);
// Reduce line verbosity when possible/reasonable
doThing(
"String1", "String 2",
"A much longer string 3",
);
// Chaining function calls
something.doThing()
.doOtherThing()
.doMore()
.somethingElse(it =>
useIt(it)
);
```
4. Use semicolons for block/line termination. 4. Use semicolons for block/line termination.
1. Except when defining interfaces, classes, and non-arrow functions specifically. 1. Except when defining interfaces, classes, and non-arrow functions specifically.
5. When a statement's body is a single line, it must be written without curly braces, so long as the body is placed on 5. When a statement's body is a single line, it may be written without curly braces, so long as the body is placed on
the same line as the statement. the same line as the statement.
```typescript ```typescript
if (x) doThing(); if (x) doThing();
``` ```
6. Blocks for `if`, `for`, `switch` and so on must have a space surrounding the condition, but not 6. Blocks for `if`, `for`, `switch` and so on must have a space surrounding the condition, but not
within the condition. within the condition.
@@ -81,18 +113,59 @@ Unless otherwise specified, the following applies to all code:
doThing(); doThing();
} }
``` ```
7. Mixing of logical operands requires brackets to explicitly define boolean logic.
7. lowerCamelCase is used for function and variable naming. ```typescript
8. UpperCamelCase is used for general naming. if ((a > b && b > c) || (d < e)) return true;
9. Interface names should not be marked with an uppercase `I`. ```
10. One variable declaration per line. 8. Ternaries use the same rules as `if` statements, plus the following:
11. If a variable is not receiving a value on declaration, its type must be defined.
```typescript
// Single line is acceptable
const val = a > b ? doThing() : doOtherThing();
// Multiline is also okay
const val = a > b
? doThing()
: doOtherThing();
// Use brackets when using multiple conditions.
// Maximum 3 conditions, prefer 2 or less.
const val = (a > b && b > c) ? doThing() : doOtherThing();
```
9. lowerCamelCase is used for function and variable naming.
10. UpperCamelCase is used for general naming.
11. Interface names should not be marked with an uppercase `I`.
12. One variable declaration per line.
13. If a variable is not receiving a value on declaration, its type must be defined.
```typescript ```typescript
let errorMessage: Optional<string>; let errorMessage: Optional<string>;
``` ```
14. Objects, arrays, enums and so on must have each line terminated with a comma:
12. Objects can use shorthand declarations, including mixing of types. ```typescript
const obj = {
prop: 1,
else: 2,
};
const arr = [
"one",
"two",
];
enum Thing {
Foo,
Bar,
}
doThing(
"arg1",
"arg2",
);
```
15. Objects can use shorthand declarations, including mixing of types.
```typescript ```typescript
{ {
@@ -102,8 +175,7 @@ Unless otherwise specified, the following applies to all code:
// ... or ... // ... or ...
{ room, prop: this.prop } { room, prop: this.prop }
``` ```
16. Object keys should always be non-strings when possible.
13. Object keys should always be non-strings when possible.
```typescript ```typescript
{ {
@@ -112,30 +184,22 @@ Unless otherwise specified, the following applies to all code:
[EventType.RoomMessage]: true, [EventType.RoomMessage]: true,
} }
``` ```
17. Explicitly cast to a boolean.
14. Explicitly cast to a boolean, rather than relying on implicit truthiness of non-boolean values:
```typescript ```typescript
const isRealUser = !!userId && ...; !!stringVar || Boolean(stringVar)
// ... or ...
const isRealUser = Boolean(userId) && ...;
// but *not*:
const isRealUser = userId && ...; // invalid implicit cast
``` ```
18. Use `switch` statements when checking against more than a few enum-like values.
15. Use `switch` statements when checking against more than a few enum-like values. 19. Use `const` for constants, `let` for mutability.
16. Use `const` for constants, `let` for mutability. 20. Describe types exhaustively (ensure noImplictAny would pass).
17. Describe types exhaustively (ensure noImplictAny would pass).
1. Notable exceptions are arrow functions used as parameters, when a void return type is 1. Notable exceptions are arrow functions used as parameters, when a void return type is
obvious, and when declaring and assigning a variable in the same line. obvious, and when declaring and assigning a variable in the same line.
18. Declare member visibility (public/private/protected). 21. Declare member visibility (public/private/protected).
19. Private members are private and not prefixed unless required for naming conflicts. 22. Private members are private and not prefixed unless required for naming conflicts.
1. Convention is to use an underscore or the word "internal" to denote conflicted member names. 1. Convention is to use an underscore or the word "internal" to denote conflicted member names.
2. "Conflicted" typically refers to a getter which wants the same name as the underlying variable. 2. "Conflicted" typically refers to a getter which wants the same name as the underlying variable.
20. Prefer readonly members over getters backed by a variable, unless an internal setter is required. 23. Prefer readonly members over getters backed by a variable, unless an internal setter is required.
21. Prefer Interfaces for object definitions, and types for parameter-value-only declarations. 24. Prefer Interfaces for object definitions, and types for parameter-value-only declarations.
1. Note that an explicit type is optional if not expected to be used outside of the function call, 1. Note that an explicit type is optional if not expected to be used outside of the function call,
unlike in this example: unlike in this example:
@@ -150,26 +214,23 @@ Unless otherwise specified, the following applies to all code:
// ... // ...
} }
``` ```
25. Variables/properties which are `public static` should also be `readonly` when possible.
22. Variables/properties which are `public static` should also be `readonly` when possible. 26. Interface and type properties are terminated with semicolons, not commas.
23. Interface and type properties are terminated with semicolons, not commas. 27. Prefer arrow formatting when declaring functions for interfaces/types:
24. Prefer arrow formatting when declaring functions for interfaces/types:
```typescript ```typescript
interface Test { interface Test {
myCallback: (arg: string) => Promise<void>; myCallback: (arg: string) => Promise<void>;
} }
``` ```
28. Prefer a type definition over an inline type. For example, define an interface.
25. Prefer a type definition over an inline type. For example, define an interface. 29. Always prefer to add types or declare a type over the use of `any`. Prefer inferred types
26. Always prefer to add types or declare a type over the use of `any`. Prefer inferred types
when they are not `any`. when they are not `any`.
1. When using `any`, a comment explaining why must be present. 1. When using `any`, a comment explaining why must be present.
27. `import` should be used instead of `require`, as `require` does not have types. 30. `import` should be used instead of `require`, as `require` does not have types.
28. Export only what can be reused. 31. Export only what can be reused.
29. Prefer a type like `Optional<X>` (`type Optional<T> = T | null | undefined`) instead 32. Prefer a type like `Optional<X>` (`type Optional<T> = T | null | undefined`) instead
of truly optional parameters. of truly optional parameters.
1. A notable exception is when the likelihood of a bug is minimal, such as when a function 1. A notable exception is when the likelihood of a bug is minimal, such as when a function
takes an argument that is more often not required than required. An example where the takes an argument that is more often not required than required. An example where the
`?` operator is inappropriate is when taking a room ID: typically the caller should `?` operator is inappropriate is when taking a room ID: typically the caller should
@@ -184,13 +245,12 @@ Unless otherwise specified, the following applies to all code:
// ... // ...
} }
``` ```
33. There should be approximately one interface, class, or enum per file unless the file is named
30. There should be approximately one interface, class, or enum per file unless the file is named
"types.ts", "global.d.ts", or ends with "-types.ts". "types.ts", "global.d.ts", or ends with "-types.ts".
1. The file name should match the interface, class, or enum name. 1. The file name should match the interface, class, or enum name.
31. Bulk functions can be declared in a single file, though named as "foo-utils.ts" or "utils/foo.ts". 34. Bulk functions can be declared in a single file, though named as "foo-utils.ts" or "utils/foo.ts".
32. Imports are grouped by external module imports first, then by internal imports. 35. Imports are grouped by external module imports first, then by internal imports.
33. File ordering is not strict, but should generally follow this sequence: 36. File ordering is not strict, but should generally follow this sequence:
1. Licence header 1. Licence header
2. Imports 2. Imports
3. Constants 3. Constants
@@ -205,16 +265,15 @@ Unless otherwise specified, the following applies to all code:
5. Protected and abstract functions 5. Protected and abstract functions
6. Public/private functions 6. Public/private functions
7. Public/protected/private static functions 7. Public/protected/private static functions
34. Variable names should be noticeably unique from their types. For example, "str: string" instead 37. Variable names should be noticeably unique from their types. For example, "str: string" instead
of "string: string". of "string: string".
35. Use double quotes to enclose strings. You may use single quotes if the string contains double quotes. 38. Use double quotes to enclose strings. You may use single quotes if the string contains double quotes.
```typescript ```typescript
const example1 = "simple string"; const example1 = "simple string";
const example2 = 'string containing "double quotes"'; const example2 = 'string containing "double quotes"';
``` ```
39. Prefer async-await to promise-chaining
36. Prefer async-await to promise-chaining
```typescript ```typescript
async function () { async function () {
@@ -253,55 +312,81 @@ Inheriting all the rules of TypeScript, the following additionally apply:
} }
} }
``` ```
8. Stores must support using an alternative MatrixClient and dispatcher instance. 8. Stores must support using an alternative MatrixClient and dispatcher instance.
9. Utilities which require JSX must be split out from utilities which do not. This is to prevent import 9. Utilities which require JSX must be split out from utilities which do not. This is to prevent import
cycles during runtime where components accidentally include more of the app than they intended. cycles during runtime where components accidentally include more of the app than they intended.
10. Interdependence between stores should be kept to a minimum. Break functions and constants out to utilities 10. Interdependence between stores should be kept to a minimum. Break functions and constants out to utilities
if at all possible. if at all possible.
11. A component should only use CSS class names in line with the component name. 11. A component should only use CSS class names in line with the component name.
1. When knowingly using a class name from another component, document it.
12. Break components over multiple lines like so:
1. When knowingly using a class name from another component, document it with a [comment](#comments). ```typescript
function render() {
return <Component
prop1="test"
prop2={this.state.variable}
/>;
12. Curly braces within JSX should be padded with a space, however properties on those components should not. // or
return (
<Component
prop1="test"
prop2={this.state.variable}
/>
);
// or if children are needed (infer parens usage)
return <Component
prop1="test"
prop2={this.state.variable}
>{ _t("Short string here") }</Component>;
return <Component
prop1="test"
prop2={this.state.variable}
>
{ _t("Longer string here") }
</Component>;
}
```
13. Curly braces within JSX should be padded with a space, however properties on those components should not.
See above code example. See above code example.
13. Functions used as properties should either be defined on the class or stored in a variable. They should not 14. Functions used as properties should either be defined on the class or stored in a variable. They should not
be inline unless mocking/short-circuiting the value. be inline unless mocking/short-circuiting the value.
14. Prefer hooks (functional components) over class components. Be consistent with the existing area if unsure 15. Prefer hooks (functional components) over class components. Be consistent with the existing area if unsure
which should be used. which should be used.
1. Unless the component is considered a "structure", in which case use classes. 1. Unless the component is considered a "structure", in which case use classes.
15. Write more views than structures. Structures are chunks of functionality like MatrixChat while views are 16. Write more views than structures. Structures are chunks of functionality like MatrixChat while views are
isolated components. isolated components.
16. Components should serve a single, or near-single, purpose. 17. Components should serve a single, or near-single, purpose.
17. Prefer to derive information from component properties rather than establish state. 18. Prefer to derive information from component properties rather than establish state.
18. Do not use `React.Component::forceUpdate`. 19. Do not use `React.Component::forceUpdate`.
## Stylesheets (\*.pcss = PostCSS + Plugins) ## Stylesheets (\*.pcss = PostCSS + Plugins)
Note: We use PostCSS + some plugins to process our styles. It looks like SCSS, but actually it is not. Note: We use PostCSS + some plugins to process our styles. It looks like SCSS, but actually it is not.
1. Class names must be prefixed with "mx\_". 1. Class names must be prefixed with "mx_".
2. Class names must denote the component which defines them, followed by any context. 2. Class names should denote the component which defines them, followed by any context:
The context is not further specified here in terms of meaning or syntax. 1. mx_MyFoo
Use whatever is appropriate for your implementation use case. 2. mx_MyFoo_avatar
Some examples: 3. mx_MyFoo_avatar--user
1. `mx_MyFoo` 3. Use the `$font` and `$spacing` variables instead of manual values.
2. `mx_MyFoo_avatar`
3. `mx_MyFoo_avatarUser`
4. `mx_MyFoo_avatar--user`
3. Use the `$font` variables instead of manual values.
4. Keep indentation/nesting to a minimum. Maximum suggested nesting is 5 layers. 4. Keep indentation/nesting to a minimum. Maximum suggested nesting is 5 layers.
5. Use the whole class name instead of shortcuts: 5. Use the whole class name instead of shortcuts:
```scss ```scss
.mx_MyFoo { .mx_MyFoo {
& .mx_MyFoo_avatar { & .mx_MyFoo_avatar { // instead of &_avatar
// instead of &_avatar
// ... // ...
} }
} }
``` ```
6. Break multiple selectors over multiple lines this way: 6. Break multiple selectors over multiple lines this way:
```scss ```scss
@@ -311,10 +396,9 @@ Note: We use PostCSS + some plugins to process our styles. It looks like SCSS, b
// ... // ...
} }
``` ```
7. Non-shared variables should use $lowerCamelCase. Shared variables use $dashed-naming. 7. Non-shared variables should use $lowerCamelCase. Shared variables use $dashed-naming.
8. Overrides to Z indexes, adjustments of dimensions/padding with pixels, and so on should all be 8. Overrides to Z indexes, adjustments of dimensions/padding with pixels, and so on should all be
[documented](#comments) for what the values mean: documented for what the values mean:
```scss ```scss
.mx_MyFoo { .mx_MyFoo {
@@ -323,8 +407,7 @@ Note: We use PostCSS + some plugins to process our styles. It looks like SCSS, b
z-index: 10; // above user avatar, but below dialogs z-index: 10; // above user avatar, but below dialogs
} }
``` ```
9. Avoid the use of `!important`. If necessary, add a comment.
9. Avoid the use of `!important`. If `!important` is necessary, add a [comment](#comments) explaining why.
## Tests ## Tests
@@ -348,7 +431,9 @@ Note: We use PostCSS + some plugins to process our styles. It looks like SCSS, b
// Use "it should..." terminology // Use "it should..." terminology
it("should call the correct API", async () => { it("should call the correct API", async () => {
// test-specific variables go here // test-specific variables go here
// function calls/state changes go here // function calls/state changes go here
// expectations go here // expectations go here
}); });
}); });
@@ -368,38 +453,3 @@ Note: We use PostCSS + some plugins to process our styles. It looks like SCSS, b
}); });
}); });
``` ```
## Comments
1. As a general principle: be liberal with comments. This applies to all files: stylesheets as well as
JavaScript/TypeScript.
Good comments not only help future readers understand and maintain the code; they can also encourage good design
by clearly setting out how different parts of the codebase interact where that would otherwise be implicit and
subject to interpretation.
2. Aim to document all types, methods, class properties, functions, etc, with [TSDoc](https://tsdoc.org/) doc comments.
This is _especially_ important for public interfaces in `matrix-js-sdk`, but is good practice in general.
Even very simple interfaces can often benefit from a doc-comment, both as a matter of consistency, and because simple
interfaces have a habit of becoming more complex over time.
3. React components should be documented in the same way as other classes or functions. The documentation should give
a brief description of how the component should be used, and, especially for more complex components, each of its
properties should be clearly documented.
4. Inside a function, there is no need to comment every line, but consider:
- before a particular multiline section of code within the function, give an overview of what it does,
to make it easier for a reader to follow the flow through the function as a whole.
- if it is anything less than obvious, explain _why_ we are doing a particular operation, with particular emphasis
on how this function interacts with other parts of the codebase.
5. When making changes to existing code, authors are expected to read existing comments and make any necessary changes
to ensure they remain accurate.
6. Reviewers are encouraged to consider whether more comments would be useful, and to ask the author to add them.
It is natural for an author to feel that the code they have just written is "obvious" and that comments would be
redundant, whereas in reality it would take some time for reader unfamiliar with the code to understand it. A
reviewer is well-placed to make a more objective judgement.

View File

@@ -22,13 +22,17 @@
"https://scalar-staging.vector.im/api", "https://scalar-staging.vector.im/api",
"https://scalar-staging.riot.im/scalar/api" "https://scalar-staging.riot.im/scalar/api"
], ],
"bug_report_endpoint_url": "https://element.io/bugreports/submit",
"uisi_autorageshake_app": "element-auto-uisi",
"default_country_code": "GB", "default_country_code": "GB",
"show_labs_settings": false, "show_labs_settings": false,
"features": {}, "features": { },
"default_federate": true, "default_federate": true,
"default_theme": "light", "default_theme": "light",
"room_directory": { "room_directory": {
"servers": ["matrix.org"] "servers": [
"matrix.org"
]
}, },
"enable_presence_by_hs_url": { "enable_presence_by_hs_url": {
"https://matrix.org": false, "https://matrix.org": false,
@@ -40,10 +44,5 @@
"jitsi": { "jitsi": {
"preferred_domain": "meet.element.io" "preferred_domain": "meet.element.io"
}, },
"element_call": {
"url": "https://call.element.io",
"participant_limit": 8,
"brand": "Element Call"
},
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx" "map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx"
} }

View File

@@ -1,13 +1,17 @@
{ {
"name": "Element", "name": "Element",
"description": "A glossy Matrix collaboration client for the web.", "description": "A glossy Matrix collaboration client for the web.",
"repository": { "repository": {
"url": "https://github.com/vector-im/element-web", "url": "https://github.com/vector-im/element-web",
"license": "Apache License 2.0" "license": "Apache License 2.0"
}, },
"bugs": { "bugs": {
"list": "https://github.com/vector-im/element-web/issues", "list": "https://github.com/vector-im/element-web/issues",
"report": "https://github.com/vector-im/element-web/issues/new/choose" "report": "https://github.com/vector-im/element-web/issues/new/choose"
}, },
"keywords": ["chat", "riot", "matrix"] "keywords": [
"chat",
"riot",
"matrix"
]
} }

1
debian/conffiles vendored
View File

@@ -1 +0,0 @@
/usr/share/element-web/config.json

12
debian/control vendored
View File

@@ -1,12 +0,0 @@
Package: element-web
License: Apache-2.0
Vendor: support@element.io
Architecture: all
Maintainer: support@element.io
Recommends: element-io-archive-keyring
Section: web
Priority: optional
Homepage: https://element.io/
Version: ${Version}
Description:
A feature-rich client for Matrix.org

View File

@@ -15,10 +15,10 @@ Current more parallel flow:
digraph G { digraph G {
node [shape=box]; node [shape=box];
subgraph cluster_0 { subgraph cluster_0 {
color=orange; color=orange;
node [style=filled]; node [style=filled];
label = "index.ts"; label = "index.ts";
entrypoint, s0, ready [shape=point]; entrypoint, s0, ready [shape=point];
rageshake, config, i18n, theme, skin, olm [shape=parallelogram]; rageshake, config, i18n, theme, skin, olm [shape=parallelogram];
@@ -52,38 +52,33 @@ label = "index.ts";
skin -> ready [color=red]; skin -> ready [color=red];
theme -> ready [color=red]; theme -> ready [color=red];
i18n -> ready [color=red]; i18n -> ready [color=red];
}
} subgraph cluster_1 {
color = green;
subgraph cluster_1 { node [style=filled];
color = green; label = "init.tsx";
node [style=filled];
label = "init.tsx";
ready -> loadApp; ready -> loadApp;
loadApp -> matrixchat; loadApp -> matrixchat;
}
}
} }
</code></pre> </code></pre>
</p> </p>
</details> </details>
Key: Key:
+ Parallelogram: async/await task
- Parallelogram: async/await task + Box: sync task
- Box: sync task + Diamond: conditional branch
- Diamond: conditional branch + Egg: user interaction
- Egg: user interaction + Blue arrow: async task is allowed to settle but allowed to fail
- Blue arrow: async task is allowed to settle but allowed to fail + Red arrow: async task success is asserted
- Red arrow: async task success is asserted
Notes: Notes:
+ A task begins when all its dependencies (arrows going into it) are fulfilled.
- A task begins when all its dependencies (arrows going into it) are fulfilled. + The success of setting up rageshake is never asserted, element-web has a fallback path for running without IDB (and thus rageshake).
- The success of setting up rageshake is never asserted, element-web has a fallback path for running without IDB (and thus rageshake). + Everything is awaited to be settled before the Modernizr check, to allow it to make use of things like i18n if they are successful.
- Everything is awaited to be settled before the Modernizr check, to allow it to make use of things like i18n if they are successful.
Underlying dependencies: Underlying dependencies:
![image](https://user-images.githubusercontent.com/2403652/73848977-08624500-4821-11ea-9830-bb0317c41086.png) ![image](https://user-images.githubusercontent.com/2403652/73848977-08624500-4821-11ea-9830-bb0317c41086.png)

View File

@@ -1,14 +0,0 @@
# Beta features
Beta features are features that are not ready for production yet but the team
wants more people to try the features and give feedback on them.
Before a feature gets into its beta phase, it is often a labs feature (see
[Labs](https://github.com/vector-im/element-web/blob/develop/docs/labs.md)).
**Be warned! Beta features may not be completely finalised or stable!**
## Video rooms (`feature_video_rooms`)
Enables support for creating and joining video rooms, which are persistent video
chats that users can jump in and out of.

View File

@@ -33,19 +33,19 @@ someone to add something.
When you're looking through the list, here are some things that might make an When you're looking through the list, here are some things that might make an
issue a **GOOD** choice: issue a **GOOD** choice:
- It is a problem or feature you care about. * It is a problem or feature you care about.
- It concerns a type of code you know a little about. * It concerns a type of code you know a little about.
- You think you can understand what's needed. * You think you can understand what's needed.
- It already has approval from Element Web's designers (look for comments from * It already has approval from Element Web's designers (look for comments from
members of the members of the
[Product](https://github.com/orgs/vector-im/teams/product/members) or [Product](https://github.com/orgs/vector-im/teams/product/members) or
[Design](https://github.com/orgs/vector-im/teams/design/members) teams). [Design](https://github.com/orgs/vector-im/teams/design/members) teams).
Here are some things that might make it a **BAD** choice: Here are some things that might make it a **BAD** choice:
- You don't understand it (maybe add a comment asking a clarifying question). * You don't understand it (maybe add a comment asking a clarifying question).
- It sounds difficult, or is part of a larger change you don't know about. * It sounds difficult, or is part of a larger change you don't know about.
- **It is tagged with `X-Needs-Design` or `X-Needs-Product`.** * **It is tagged with `X-Needs-Design` or `X-Needs-Product`.**
**Element Web's Design and Product teams tend to be very busy**, so if you make **Element Web's Design and Product teams tend to be very busy**, so if you make
changes that require approval from one of those teams, you will probably have changes that require approval from one of those teams, you will probably have

View File

@@ -1,20 +1,8 @@
# Configuration # Configuration
### 🦖 Deprecation notice You can configure the app by copying `config.sample.json` to `config.json` and customising it. The possible options are
described here. If you run into issues, please visit [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org)
Configuration keys were previously a mix of camelCase and snake_case. on Matrix.
We standardised to snake_case but added compatibility for camelCase to all settings.
This backwards compatibility will be getting removed in a future release so please ensure you are using snake_case.
---
You can configure the app by copying `config.sample.json` to `config.json` or `config.$domain.json` and customising it.
Element will attempt to load first `config.$domain.json` and if it fails `config.json`. This mechanism allows different
configuration options depending on if you're hitting e.g. `app1.example.com` or `app2.example.com`. Configs are not mixed
in any way, it either entirely uses the domain config, or entirely uses `config.json`.
The possible configuration options are described here. If you run into issues, please visit
[#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) on Matrix.
For a good example of a production-tuned config, see https://app.element.io/config.json For a good example of a production-tuned config, see https://app.element.io/config.json
@@ -25,7 +13,7 @@ for the desktop app the application will need to be exited fully (including via
## Homeserver configuration ## Homeserver configuration
In order for Element to even start you will need to tell it what homeserver to connect to _by default_. Users will be In order for Element to even start you will need to tell it what homeserver to connect to *by default*. Users will be
able to use a different homeserver if they like, though this can be disabled with `"disable_custom_urls": true` in your able to use a different homeserver if they like, though this can be disabled with `"disable_custom_urls": true` in your
config. config.
@@ -34,18 +22,18 @@ One of the following options **must** be supplied:
1. `default_server_config`: The preferred method of setting the homeserver connection information. Simply copy/paste 1. `default_server_config`: The preferred method of setting the homeserver connection information. Simply copy/paste
your [`/.well-known/matrix/client`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient) your [`/.well-known/matrix/client`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient)
into this field. For example: into this field. For example:
```json ```json
{ {
"default_server_config": { "default_server_config": {
"m.homeserver": { "m.homeserver": {
"base_url": "https://matrix-client.matrix.org" "base_url": "https://matrix-client.matrix.org"
}, },
"m.identity_server": { "m.identity_server": {
"base_url": "https://vector.im" "base_url": "https://vector.im"
} }
} }
} }
``` ```
2. `default_server_name`: A different method of connecting to the homeserver by looking up the connection information 2. `default_server_name`: A different method of connecting to the homeserver by looking up the connection information
using `.well-known`. When using this option, simply use your server's domain name (the part at the end of user IDs): using `.well-known`. When using this option, simply use your server's domain name (the part at the end of user IDs):
`"default_server_name": "matrix.org"` `"default_server_name": "matrix.org"`
@@ -53,9 +41,8 @@ One of the following options **must** be supplied:
information. These are the same values seen as `base_url` in the `default_server_config` example, with `default_is_url` information. These are the same values seen as `base_url` in the `default_server_config` example, with `default_is_url`
being optional. being optional.
If both `default_server_config` and `default_server_name` are used, Element will try to look up the connection If a combination of these three methods is used then Element will fail to load. This is because it is unclear which
infomation using `.well-known`, and if that fails, take `default_server_config` as the homeserver connection should be considered "first".
infomation.
## Labs flags ## Labs flags
@@ -67,10 +54,10 @@ To force a labs flag on or off, use the following:
```json ```json
{ {
"features": { "features": {
"feature_you_want_to_turn_on": true, "feature_you_want_to_turn_on": true,
"feature_you_want_to_keep_off": false "feature_you_want_to_keep_off": false
} }
} }
``` ```
@@ -91,25 +78,25 @@ instance. As of writing those settings are not fully documented, however a few a
inputs. inputs.
3. `room_directory`: Optionally defines how the room directory component behaves. Currently only a single property, `servers` 3. `room_directory`: Optionally defines how the room directory component behaves. Currently only a single property, `servers`
is supported to add additional servers to the dropdown. For example: is supported to add additional servers to the dropdown. For example:
```json ```json
{ {
"room_directory": { "room_directory": {
"servers": ["matrix.org", "example.org"] "servers": ["matrix.org", "example.org"]
} }
} }
``` ```
4. `setting_defaults`: Optional configuration for settings which are not described by this document and support the `config` 4. `setting_defaults`: Optional configuration for settings which are not described by this document and support the `config`
level. This list is incomplete. For example: level. This list is incomplete. For example:
```json ```json
{ {
"setting_defaults": { "setting_defaults": {
"MessageComposerInput.showStickersButton": false, "MessageComposerInput.showStickersButton": false,
"MessageComposerInput.showPollsButton": false "MessageComposerInput.showPollsButton": false
} }
} }
``` ```
These values will take priority over the hardcoded defaults for the settings. For a list of available settings, see These values will take priority over the hardcoded defaults for the settings. For a list of available settings, see
[Settings.tsx](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.tsx). [Settings.tsx](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.tsx).
## Customisation & branding ## Customisation & branding
@@ -148,13 +135,6 @@ complete re-branding/private labeling, a more personalised experience can be ach
to hide this dropdown. to hide this dropdown.
16. `disable_guests`: When `false` (default), **enable** guest-related functionality (peeking/previewing rooms, etc) for unregistered 16. `disable_guests`: When `false` (default), **enable** guest-related functionality (peeking/previewing rooms, etc) for unregistered
users. Set to `true` to disable this functionality. users. Set to `true` to disable this functionality.
17. `user_notice`: Optional notice to show to the user, e.g. for sunsetting a deployment and pushing users to move in their own time.
Takes a configuration object as below:
1. `title`: Required. Title to show at the top of the notice.
2. `description`: Required. The description to use for the notice.
3. `show_once`: Optional. If true then the notice will only be shown once per device.
18. `help_url`: The URL to point users to for help with the app, defaults to `https://element.io/help`.
19. `help_encrption_url`: The URL to point users to for help with encryption, defaults to `https://element.io/help#encryption`.
### `desktop_builds` and `mobile_builds` ### `desktop_builds` and `mobile_builds`
@@ -181,16 +161,16 @@ Together, these two options might look like the following in your config:
```json ```json
{ {
"desktop_builds": { "desktop_builds": {
"available": true, "available": true,
"logo": "https://example.org/assets/logo-small.svg", "logo": "https://example.org/assets/logo-small.svg",
"url": "https://example.org/not_element/download" "url": "https://example.org/not_element/download"
}, },
"mobile_builds": { "mobile_builds": {
"ios": null, "ios": null,
"android": "https://example.org/not_element/android", "android": "https://example.org/not_element/android",
"fdroid": "https://example.org/not_element/fdroid" "fdroid": "https://example.org/not_element/fdroid"
} }
} }
``` ```
@@ -221,18 +201,18 @@ Together, the options might look like this in your config:
```json ```json
{ {
"branding": { "branding": {
"welcome_background_url": "https://example.org/assets/background.jpg", "welcome_background_url": "https://example.org/assets/background.jpg",
"auth_header_logo_url": "https://example.org/assets/logo.svg", "auth_header_logo_url": "https://example.org/assets/logo.svg",
"auth_footer_links": [ "auth_footer_links": [
{ "text": "FAQ", "url": "https://example.org/faq" }, {"text": "FAQ", "url": "https://example.org/faq"},
{ "text": "Donate", "url": "https://example.org/donate" } {"text": "Donate", "url": "https://example.org/donate"}
] ]
}, },
"embedded_pages": { "embedded_pages": {
"welcome_url": "https://example.org/assets/welcome.html", "welcome_url": "https://example.org/assets/welcome.html",
"home_url": "https://example.org/assets/home.html" "home_url": "https://example.org/assets/home.html"
} }
} }
``` ```
@@ -251,99 +231,88 @@ When Element is deployed alongside a homeserver with SSO-only login, some option
2. `sso_redirect_options`: Options to define how to handle unauthenticated users. If the object contains `"immediate": true`, then 2. `sso_redirect_options`: Options to define how to handle unauthenticated users. If the object contains `"immediate": true`, then
all unauthenticated users will be automatically redirected to the SSO system to start their login. If instead you'd only like to all unauthenticated users will be automatically redirected to the SSO system to start their login. If instead you'd only like to
have users which land on the welcome page to be redirected, use `"on_welcome_page": true`. As an example: have users which land on the welcome page to be redirected, use `"on_welcome_page": true`. As an example:
```json ```json
{ {
"sso_redirect_options": { "sso_redirect_options": {
"immediate": false, "immediate": false,
"on_welcome_page": true "on_welcome_page": true
} }
} }
``` ```
It is most common to use the `immediate` flag instead of `on_welcome_page`. It is most common to use the `immediate` flag instead of `on_welcome_page`.
## VoIP / Jitsi calls ## VoIP / Jitsi calls
Currently, Element uses Jitsi to offer conference calls in rooms, with an experimental Element Call implementation in the works. Currently, Element uses Jitsi to offer conference calls in rooms. A set of defaults are applied, pointing at our Jitsi instance,
A set of defaults are applied, pointing at our Jitsi and Element Call instances, to ensure conference calling works, however you to ensure conference calling works, however you can point Element at your own Jitsi if you prefer.
can point Element at your own if you prefer.
More information about the Jitsi setup can be found [here](./jitsi.md). More information about the Jitsi setup can be found [here](./jitsi.md).
The VoIP and Jitsi options are: The VoIP and Jitsi options are:
1. `jitsi`: Optional configuration for how to start Jitsi conferences. Currently can only contain a single `preferred_domain` 1. `jitsi`: Optional configuration for how to start Jitsi conferences. Currently can only contain a single `preferred_domain`
value which points at the domain of the Jitsi instance. Defaults to `meet.element.io`. This is _not_ used if the Jitsi widget value which points at the domain of the Jitsi instance. Defaults to `meet.element.io`. This is *not* used if the Jitsi widget
was created by an integration manager, or if the homeserver provides Jitsi information in `/.well-known/matrix/client`. For was created by an integration manager, or if the homeserver provides Jitsi information in `/.well-known/matrix/client`. For
example: example:
```json ```json
{ {
"jitsi": { "jitsi": {
"preferred_domain": "meet.jit.si" "preferred_domain": "meet.jit.si"
} }
} }
``` ```
2. `jitsi_widget`: Optional configuration for the built-in Jitsi widget. Currently can only contain a single `skip_built_in_welcome_screen` 2. `jitsi_widget`: Optional configuration for the built-in Jitsi widget. Currently can only contain a single `skip_built_in_welcome_screen`
value, denoting whether the "Join Conference" button should be shown. When `true` (default `false`), Jitsi calls will skip to value, denoting whether the "Join Conference" button should be shown. When `true` (default `false`), Jitsi calls will skip to
the call instead of having a screen with a single button on it. This is most useful if the Jitsi instance being used already the call instead of having a screen with a single button on it. This is most useful if the Jitsi instance being used already
has a landing page for users to test audio and video before joining the call, otherwise users will automatically join the call. has a landing page for users to test audio and video before joining the call, otherwise users will automatically join the call.
For example: For example:
```json ```json
{ {
"jitsi_widget": { "jitsi_widget": {
"skip_built_in_welcome_screen": true "skip_built_in_welcome_screen": true
} }
} }
``` ```
3. `voip`: Optional configuration for various VoIP features. Currently can only contain a single `obey_asserted_identity` value to 3. `voip`: Optional configuration for various VoIP features. Currently can only contain a single `obey_asserted_identity` value to
send MSC3086-style asserted identity messages during VoIP calls in the room corresponding to the asserted identity. This _must_ send MSC3086-style asserted identity messages during VoIP calls in the room corresponding to the asserted identity. This *must*
only be set in trusted environments. The option defaults to `false`. For example: only be set in trusted environments. The option defaults to `false`. For example:
```json ```json
{ {
"voip": { "voip": {
"obey_asserted_identity": false "obey_asserted_identity": false
} }
} }
``` ```
4. `widget_build_url`: Optional URL to have Element make a request to when a user presses the voice/video call buttons in the app, 4. `widget_build_url`: Optional URL to have Element make a request to when a user presses the voice/video call buttons in the app,
if a call would normally be started by the action. The URL will be called with a `roomId` query parameter to identify the room if a call would normally be started by the action. The URL will be called with a `roomId` query parameter to identify the room
being called in. The URL must respond with a JSON object similar to the following: being called in. The URL must respond with a JSON object similar to the following:
```json ```json
{ {
"widget_id": "$arbitrary_string", "widget_id": "$arbitrary_string",
"widget": { "widget": {
"creatorUserId": "@user:example.org", "creatorUserId": "@user:example.org",
"id": "$the_same_widget_id", "id": "$the_same_widget_id",
"type": "m.custom", "type": "m.custom",
"waitForIframeLoad": true, "waitForIframeLoad": true,
"name": "My Widget Name Here", "name": "My Widget Name Here",
"avatar_url": "mxc://example.org/abc123", "avatar_url": "mxc://example.org/abc123",
"url": "https://example.org/widget.html", "url": "https://example.org/widget.html",
"data": { "data": {
"title": "Subtitle goes here" "title": "Subtitle goes here"
} }
}, },
"layout": { "layout": {
"container": "top", "container": "top",
"index": 0, "index": 0,
"width": 65, "width": 65,
"height": 50 "height": 50
} }
} }
``` ```
The `widget` is the `content` of a normal widget state event. The `layout` is the layout specifier for the widget being created, The `widget` is the `content` of a normal widget state event. The `layout` is the layout specifier for the widget being created,
as defined by the `io.element.widgets.layout` state event. By default this applies to all rooms, but the behaviour can be skipped for DMs as defined by the `io.element.widgets.layout` state event.
by setting the option `widget_build_url_ignore_dm` to `true`.
5. `audio_stream_url`: Optional URL to pass to Jitsi to enable live streaming. This option is considered experimental and may be removed 5. `audio_stream_url`: Optional URL to pass to Jitsi to enable live streaming. This option is considered experimental and may be removed
at any time without notice. at any time without notice.
6. `element_call`: Optional configuration for native group calls using Element Call, with the following subkeys:
- `url`: The URL of the Element Call instance to use for native group calls. This option is considered experimental
and may be removed at any time without notice. Defaults to `https://call.element.io`.
- `use_exclusively`: A boolean specifying whether Element Call should be used exclusively as the only VoIP stack in
the app, removing the ability to start legacy 1:1 calls or Jitsi calls. Defaults to `false`.
- `participant_limit`: The maximum number of users who can join a call; if
this number is exceeded, the user will not be able to join a given call.
- `brand`: Optional name for the app. Defaults to `Element Call`. This is
used throughout the application in various strings/locations.
## Bug reporting ## Bug reporting
@@ -353,8 +322,10 @@ If you run your own rageshake server to collect bug reports, the following optio
not present in the config, the app will disable all rageshake functionality. Set to `https://element.io/bugreports/submit` to submit not present in the config, the app will disable all rageshake functionality. Set to `https://element.io/bugreports/submit` to submit
rageshakes to us, or use your own rageshake server. rageshakes to us, or use your own rageshake server.
2. `uisi_autorageshake_app`: If a user has enabled the "automatically send debug logs on decryption errors" flag, this option will be sent 2. `uisi_autorageshake_app`: If a user has enabled the "automatically send debug logs on decryption errors" flag, this option will be sent
alongside the rageshake so the rageshake server can filter them by app name. By default, this will be `element-auto-uisi` alongside the rageshake so the rageshake server can filter them by app name. By default, this will be `element-web`, as with any other
(in contrast to other rageshakes submitted by the app, which use `element-web`). rageshake submitted by the app.
If you are using the element.io rageshake server, please set this to `element-auto-uisi` so we can better filter them.
If you would like to use [Sentry](https://sentry.io/) for rageshake data, add a `sentry` object to your config with the following values: If you would like to use [Sentry](https://sentry.io/) for rageshake data, add a `sentry` object to your config with the following values:
@@ -365,17 +336,18 @@ For example:
```json ```json
{ {
"sentry": { "sentry": {
"dsn": "dsn-goes-here", "dsn": "dsn-goes-here",
"environment": "production" "environment": "production"
} }
} }
``` ```
## Integration managers ## Integration managers
Integration managers are embedded applications within Element to help the user configure bots, bridges, and widgets. An integration manager Integration managers are embedded applications within Element to help the user configure bots, bridges, and widgets. An integration manager
is a separate piece of software not typically available with your homeserver. To disable integrations, set the options defined here to `null`. is a separate piece of software not typically available with your homeserver. To disable integrations, leave the options defined here out of
your config.
1. `integrations_ui_url`: The UI URL for the integration manager. 1. `integrations_ui_url`: The UI URL for the integration manager.
2. `integrations_rest_url`: The REST interface URL for the integration manager. 2. `integrations_rest_url`: The REST interface URL for the integration manager.
@@ -385,15 +357,15 @@ If you would like to use Scalar, the integration manager maintained by Element,
```json ```json
{ {
"integrations_ui_url": "https://scalar.vector.im/", "integrations_ui_url": "https://scalar.vector.im/",
"integrations_rest_url": "https://scalar.vector.im/api", "integrations_rest_url": "https://scalar.vector.im/api",
"integrations_widgets_urls": [ "integrations_widgets_urls": [
"https://scalar.vector.im/_matrix/integrations/v1", "https://scalar.vector.im/_matrix/integrations/v1",
"https://scalar.vector.im/api", "https://scalar.vector.im/api",
"https://scalar-staging.vector.im/_matrix/integrations/v1", "https://scalar-staging.vector.im/_matrix/integrations/v1",
"https://scalar-staging.vector.im/api", "https://scalar-staging.vector.im/api",
"https://scalar-staging.riot.im/scalar/api" "https://scalar-staging.riot.im/scalar/api"
] ]
} }
``` ```
@@ -403,9 +375,9 @@ If you would like to include a custom message when someone is reporting an event
```json ```json
{ {
"report_event": { "report_event": {
"admin_message_md": "Please be sure to review our [terms of service](https://example.org/terms) before reporting a message." "admin_message_md": "Please be sure to review our [terms of service](https://example.org/terms) before reporting a message."
} }
} }
``` ```
@@ -413,7 +385,9 @@ To add additional "terms and conditions" links throughout the app, use the follo
```json ```json
{ {
"terms_and_conditions_links": [{ "text": "Code of conduct", "url": "https://example.org/code-of-conduct" }] "terms_and_conditions_links": [
{ "text": "Code of conduct", "url": "https://example.org/code-of-conduct" }
]
} }
``` ```
@@ -430,9 +404,42 @@ analytics are deemed impossible and the user won't be asked to opt in to the sys
There are additional root-level options which can be specified: There are additional root-level options which can be specified:
1. `analytics_owner`: the company name used in dialogs talking about analytics - this defaults to `brand`, 1. `analytics_owner`: the company name used in dialogs talking about analytics - this defaults to `brand`,
and is useful when the provider of analytics is different from the provider of the Element instance. and is useful when the provider of analytics is different from the provider of the Element instance.
2. `privacy_policy_url`: URL to the privacy policy including the analytics collection policy. 2. `privacy_policy_url`: URL to the privacy policy including the analytics collection policy.
## Server hosting links
If you would like to encourage matrix.org users to sign up for a service like [Element Matrix Services](https://element.io/matrix-services/server-hosting),
the following configuration options can be set. Note that if the options are missing from the configuration then the hosting prompts
will not be shown to the user.
1. `hosting_signup_link`: Optional URL to link the user to when talking about "Upgrading your account". Will contain a query parameter
of `utm_campaign` to denote which link the user clicked on within the app. Only ever applies to matrix.org users specifically.
2. `host_signup`: Optional configuration for an account importer to your hosting platform. The API surface of this is not documented
at the moment, but can be configured with the following subproperties:
1. `brand`: The brand name to use.
2. `url`: The iframe URL for the importer.
3. `domains`: The homeserver domains to show the importer to.
4. `cookie_policy_url`: The URL to the cookie policy for the importer.
5. `privacy_policy_url`: The URL to the privacy policy for the importer.
6. `terms_of_service_url`: The URL to the terms of service for the importer.
If you're looking to mirror a setup from our production/development environments, the following config should be used:
```json
{
"hosting_signup_link": "https://element.io/matrix-services?utm_source=element-web&utm_medium=web",
"host_signup": {
"brand": "Element Home",
"domains": [ "matrix.org" ],
"url": "https://ems.element.io/element-home/in-app-loader",
"cookie_policy_url": "https://element.io/cookie-policy",
"privacy_policy_url": "https://element.io/privacy",
"terms_of_service_url": "https://element.io/terms-of-service"
}
}
```
## Miscellaneous ## Miscellaneous
Element supports other options which don't quite fit into other sections of this document. Element supports other options which don't quite fit into other sections of this document.
@@ -442,10 +449,10 @@ set this value to the following at a minimum:
```json ```json
{ {
"enable_presence_by_hs_url": { "enable_presence_by_hs_url": {
"https://matrix.org": false, "https://matrix.org": false,
"https://matrix-client.matrix.org": false "https://matrix-client.matrix.org": false
} }
} }
``` ```
@@ -462,8 +469,8 @@ Element will check multiple sources when looking for an identity server to use i
the following order of preference: the following order of preference:
1. The identity server set in the user's account data 1. The identity server set in the user's account data
- For a new user, no value is present in their account data. It is only set * For a new user, no value is present in their account data. It is only set
if the user visits Settings and manually changes their identity server. if the user visits Settings and manually changes their identity server.
2. The identity server provided by the `.well-known` lookup that occurred at 2. The identity server provided by the `.well-known` lookup that occurred at
login login
3. The identity server provided by the Riot config file 3. The identity server provided by the Riot config file
@@ -489,38 +496,38 @@ preferences.
Currently, the following UI feature flags are supported: Currently, the following UI feature flags are supported:
- `UIFeature.urlPreviews` - Whether URL previews are enabled across the entire application. * `UIFeature.urlPreviews` - Whether URL previews are enabled across the entire application.
- `UIFeature.feedback` - Whether prompts to supply feedback are shown. * `UIFeature.feedback` - Whether prompts to supply feedback are shown.
- `UIFeature.voip` - Whether or not VoIP is shown readily to the user. When disabled, * `UIFeature.voip` - Whether or not VoIP is shown readily to the user. When disabled,
Jitsi widgets will still work though they cannot easily be added. Jitsi widgets will still work though they cannot easily be added.
- `UIFeature.widgets` - Whether or not widgets will be shown. * `UIFeature.widgets` - Whether or not widgets will be shown.
- `UIFeature.advancedSettings` - Whether or not sections titled "advanced" in room and * `UIFeature.flair` - Whether or not community flair is shown in rooms.
user settings are shown to the user. * `UIFeature.communities` - Whether or not to show any UI related to communities. Implicitly
- `UIFeature.shareQrCode` - Whether or not the QR code on the share room/event dialog disables `UIFeature.flair` when disabled.
is shown. * `UIFeature.advancedSettings` - Whether or not sections titled "advanced" in room and
- `UIFeature.shareSocial` - Whether or not the social icons on the share room/event dialog user settings are shown to the user.
are shown. * `UIFeature.shareQrCode` - Whether or not the QR code on the share room/event dialog
- `UIFeature.identityServer` - Whether or not functionality requiring an identity server is shown.
is shown. When disabled, the user will not be able to interact with the identity * `UIFeature.shareSocial` - Whether or not the social icons on the share room/event dialog
server (sharing email addresses, 3PID invites, etc). are shown.
- `UIFeature.thirdPartyId` - Whether or not UI relating to third party identifiers (3PIDs) * `UIFeature.identityServer` - Whether or not functionality requiring an identity server
is shown. Typically this is considered "contact information" on the homeserver, and is is shown. When disabled, the user will not be able to interact with the identity
not directly related to the identity server. server (sharing email addresses, 3PID invites, etc).
- `UIFeature.registration` - Whether or not the registration page is accessible. Typically * `UIFeature.thirdPartyId` - Whether or not UI relating to third party identifiers (3PIDs)
useful if accounts are managed externally. is shown. Typically this is considered "contact information" on the homeserver, and is
- `UIFeature.passwordReset` - Whether or not the password reset page is accessible. Typically not directly related to the identity server.
useful if accounts are managed externally. * `UIFeature.registration` - Whether or not the registration page is accessible. Typically
- `UIFeature.deactivate` - Whether or not the deactivate account button is accessible. Typically useful if accounts are managed externally.
useful if accounts are managed externally. * `UIFeature.passwordReset` - Whether or not the password reset page is accessible. Typically
- `UIFeature.advancedEncryption` - Whether or not advanced encryption options are shown to the useful if accounts are managed externally.
user. * `UIFeature.deactivate` - Whether or not the deactivate account button is accessible. Typically
- `UIFeature.roomHistorySettings` - Whether or not the room history settings are shown to the user. useful if accounts are managed externally.
This should only be used if the room history visibility options are managed by the server. * `UIFeature.advancedEncryption` - Whether or not advanced encryption options are shown to the
- `UIFeature.TimelineEnableRelativeDates` - Display relative date separators (eg: 'Today', 'Yesterday') in the user.
timeline for recent messages. When false day dates will be used. * `UIFeature.roomHistorySettings` - Whether or not the room history settings are shown to the user.
- `UIFeature.BulkUnverifiedSessionsReminder` - Display popup reminders to verify or remove unverified sessions. Defaults This should only be used if the room history visibility options are managed by the server.
to true. * `UIFeature.TimelineEnableRelativeDates` - Display relative date separators (eg: 'Today', 'Yesterday') in the
- `UIFeature.locationSharing` - Whether or not location sharing menus will be shown. timeline for recent messages. When false day dates will be used.
## Undocumented / developer options ## Undocumented / developer options
@@ -530,4 +537,3 @@ The following are undocumented or intended for developer use only.
2. `sync_timeline_limit` 2. `sync_timeline_limit`
3. `dangerously_allow_unsafe_and_insecure_passwords` 3. `dangerously_allow_unsafe_and_insecure_passwords`
4. `latex_maths_delims`: An optional setting to override the default delimiters used for maths parsing. See https://github.com/matrix-org/matrix-react-sdk/pull/5939 for details. Only used when `feature_latex_maths` is enabled. 4. `latex_maths_delims`: An optional setting to override the default delimiters used for maths parsing. See https://github.com/matrix-org/matrix-react-sdk/pull/5939 for details. Only used when `feature_latex_maths` is enabled.
5. `voice_broadcast.chunk_length`: Target chunk length in seconds for the Voice Broadcast feature currently under development.

View File

@@ -26,6 +26,7 @@ The home page can be overridden in `config.json` to provide all users of an elem
} }
``` ```
## `home.html` Example ## `home.html` Example
The following is a simple example for a custom `home.html`: The following is a simple example for a custom `home.html`:
@@ -61,3 +62,4 @@ It may be needed to set CORS headers for the `home.html` to enable element-deskt
``` ```
add_header Access-Control-Allow-Origin *; add_header Access-Control-Allow-Origin *;
``` ```

View File

@@ -1,13 +1,5 @@
# Customisations # Customisations
### 🦖 DEPRECATED
Customisations have been deprecated in favour of the [Module API](https://github.com/vector-im/element-web/blob/develop/docs/modules.md).
If you have use cases from customisations which are not yet available via the Module API please open an issue.
Customisations will be removed from the codebase in a future release.
---
Element Web and the React SDK support "customisation points" that can be used to Element Web and the React SDK support "customisation points" that can be used to
easily add custom logic specific to a particular deployment of Element Web. easily add custom logic specific to a particular deployment of Element Web.
@@ -38,7 +30,7 @@ maintenance.
**Note**: The project deliberately does not exclude `customisations.json` from Git. **Note**: The project deliberately does not exclude `customisations.json` from Git.
This is to ensure that in shared projects it's possible to have a common config. By This is to ensure that in shared projects it's possible to have a common config. By
default, Element Web does _not_ ship with this file to prevent conflicts. default, Element Web does *not* ship with this file to prevent conflicts.
### Custom components ### Custom components
@@ -49,10 +41,9 @@ that properties/state machines won't change.
### Component visibility customisation ### Component visibility customisation
UI for some actions can be hidden via the ComponentVisibility customisation: UI for some actions can be hidden via the ComponentVisibility customisation:
- inviting users to rooms and spaces,
- inviting users to rooms and spaces, - creating rooms,
- creating rooms, - creating spaces,
- creating spaces,
To customise visibility create a customisation module from [ComponentVisibility](https://github.com/matrix-org/matrix-react-sdk/blob/master/src/customisations/ComponentVisibility.ts) following the instructions above. To customise visibility create a customisation module from [ComponentVisibility](https://github.com/matrix-org/matrix-react-sdk/blob/master/src/customisations/ComponentVisibility.ts) following the instructions above.
@@ -64,7 +55,6 @@ might be shown to the user, but they won't have permission to invite users to
the current room: the button will appear disabled. the current room: the button will appear disabled.
For example, to only allow users who meet a certain condition to create spaces: For example, to only allow users who meet a certain condition to create spaces:
```typescript ```typescript
function shouldShowComponent(component: UIComponent): boolean { function shouldShowComponent(component: UIComponent): boolean {
if (component === UIComponent.CreateSpaces) { if (component === UIComponent.CreateSpaces) {
@@ -75,5 +65,4 @@ function shouldShowComponent(component: UIComponent): boolean {
return true; return true;
} }
``` ```
In this example, all UI related to creating a space will be hidden unless the users meets the custom condition. In this example, all UI related to creating a space will be hidden unless the users meets the custom condition.

View File

@@ -10,34 +10,12 @@ Set the following on your homeserver's
```json ```json
{ {
"io.element.e2ee": { "io.element.e2ee": {
"default": false "default": false
} }
} }
``` ```
## Disabling encryption
Set the following on your homeserver's
`/.well-known/matrix/client` config:
```json
{
"io.element.e2ee": {
"force_disable": true
}
}
```
When `force_disable` is true:
- all rooms will be created with encryption disabled, and it will not be possible to enable
encryption from room settings.
- 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.
# Secure backup # Secure backup
By default, Element strongly encourages (but does not require) users to set up By default, Element strongly encourages (but does not require) users to set up
@@ -51,9 +29,9 @@ following on your homeserver's `/.well-known/matrix/client` config:
```json ```json
{ {
"io.element.e2ee": { "io.element.e2ee": {
"secure_backup_required": true "secure_backup_required": true
} }
} }
``` ```
@@ -66,9 +44,9 @@ only offer one of these, you can signal this via the
```json ```json
{ {
"io.element.e2ee": { "io.element.e2ee": {
"secure_backup_setup_methods": ["passphrase"] "secure_backup_setup_methods": ["passphrase"]
} }
} }
``` ```

View File

@@ -5,10 +5,10 @@ flexibility and control over when and where those features are enabled.
For example, flags make the following things possible: For example, flags make the following things possible:
- Extended testing of a feature via labs on develop * Extended testing of a feature via labs on develop
- Enabling features when ready instead of the first moment the code is released * Enabling features when ready instead of the first moment the code is released
- Testing a feature with a specific set of users (by enabling only on a specific * Testing a feature with a specific set of users (by enabling only on a specific
Element instance) Element instance)
The size of the feature controlled by a feature flag may vary widely: it could The size of the feature controlled by a feature flag may vary widely: it could
be a large project like reactions or a smaller change to an existing algorithm. be a large project like reactions or a smaller change to an existing algorithm.
@@ -37,7 +37,6 @@ When starting work on a feature, we should create a matching feature flag:
1. Add a new 1. Add a new
[setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.tsx) [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.tsx)
of the form: of the form:
```js ```js
"feature_cats": { "feature_cats": {
isFeature: true, isFeature: true,
@@ -46,13 +45,10 @@ When starting work on a feature, we should create a matching feature flag:
default: false, default: false,
}, },
``` ```
2. Check whether the feature is enabled as appropriate: 2. Check whether the feature is enabled as appropriate:
```js ```js
SettingsStore.getValue("feature_cats"); SettingsStore.getValue("feature_cats")
``` ```
3. Document the feature in the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md) 3. Document the feature in the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md)
With these steps completed, the feature is disabled by default, but can be With these steps completed, the feature is disabled by default, but can be
@@ -92,14 +88,12 @@ cover these cases, change the setting's `default` in `Settings.tsx` to `true`.
Once we're confident that a feature is working well, we should remove or convert the flag. Once we're confident that a feature is working well, we should remove or convert the flag.
If the feature is meant to be turned off/on by the user: If the feature is meant to be turned off/on by the user:
1. Remove `isFeature` from the [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.ts) 1. Remove `isFeature` from the [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.ts)
2. Change the `default` to `true` (if desired). 2. Change the `default` to `true` (if desired).
3. Remove the feature from the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md) 3. Remove the feature from the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md)
4. Celebrate! 🥳 4. Celebrate! 🥳
If the feature is meant to be forced on (non-configurable): If the feature is meant to be forced on (non-configurable):
1. Remove the [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.ts) 1. Remove the [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.ts)
2. Remove all `getValue` lines that test for the feature. 2. Remove all `getValue` lines that test for the feature.
3. Remove the feature from the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md) 3. Remove the feature from the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md)

View File

@@ -1,7 +1,7 @@
# Jitsi wrapper developer docs # Jitsi wrapper developer docs
_If you're looking for information on how to set up Jitsi in your Element, see *If you're looking for information on how to set up Jitsi in your Element, see
[jitsi.md](./jitsi.md) instead._ [jitsi.md](./jitsi.md) instead.*
These docs are for developers wondering how the different conference buttons work These docs are for developers wondering how the different conference buttons work
within Element. If you're not a developer, you're probably looking for [jitsi.md](./jitsi.md). within Element. If you're not a developer, you're probably looking for [jitsi.md](./jitsi.md).
@@ -46,24 +46,24 @@ end up creating a widget with a URL like `https://integrations.example.org?widge
The integration manager's wrapper will typically have another iframe to isolate the The integration manager's wrapper will typically have another iframe to isolate the
widget from the client by yet another layer. The wrapper often provides other functionality widget from the client by yet another layer. The wrapper often provides other functionality
which might not be available on the embedded site, such as a fullscreen button or the which might not be available on the embedded site, such as a fullscreen button or the
communication layer with the client (all widgets _should_ be talking to the client communication layer with the client (all widgets *should* be talking to the client
over `postMessage`, even if they aren't going to be using the widget APIs). over `postMessage`, even if they aren't going to be using the widget APIs).
Widgets added with the `/addwidget` command will _not_ be wrapped as they are not going Widgets added with the `/addwidget` command will *not* be wrapped as they are not going
through an integration manager. The widgets themselves _should_ also work outside of through an integration manager. The widgets themselves *should* also work outside of
Element. Widgets currently have a "pop out" button which opens them in a new tab and Element. Widgets currently have a "pop out" button which opens them in a new tab and
therefore have no connection back to Riot. therefore have no connection back to Riot.
## Jitsi widgets from integration managers ## Jitsi widgets from integration managers
Integration managers will create an entire widget event and send it over `postMessage` Integration managers will create an entire widget event and send it over `postMessage`
for the client to add to the room. This means that the integration manager gets to for the client to add to the room. This means that the integration manager gets to
decide the conference domain, conference name, and other aspects of the widget. As decide the conference domain, conference name, and other aspects of the widget. As
a result, users can end up with a Jitsi widget that does not use the same conference a result, users can end up with a Jitsi widget that does not use the same conference
server they specified in their config.json - this is expected. server they specified in their config.json - this is expected.
Some integration managers allow the user to change the conference name while others Some integration managers allow the user to change the conference name while others
will generate one for the user. will generate one for the user.
## Jitsi widgets generated by Element itself ## Jitsi widgets generated by Element itself
@@ -79,7 +79,7 @@ The Jitsi widget created by Element uses a local `jitsi.html` wrapper (or one ho
required `postMessage` calls are fulfilled. required `postMessage` calls are fulfilled.
**Note**: Per [jitsi.md](./jitsi.md) the `preferredDomain` can also come from the server's **Note**: Per [jitsi.md](./jitsi.md) the `preferredDomain` can also come from the server's
client .well-known data. client .well-known data.
## The Jitsi wrapper in Element ## The Jitsi wrapper in Element
@@ -92,9 +92,9 @@ and less risky to load. The local wrapper URL is populated with the conference i
from the original widget (which could be a v1 or v2 widget) so the user joins the right from the original widget (which could be a v1 or v2 widget) so the user joins the right
call. call.
Critically, when the widget URL is reconstructed it does _not_ take into account the Critically, when the widget URL is reconstructed it does *not* take into account the
config.json's `preferredDomain` for Jitsi. If it did this, users would end up on different config.json's `preferredDomain` for Jitsi. If it did this, users would end up on different
conference servers and therefore different calls entirely. conference servers and therefore different calls entirely.
**Note**: Per [jitsi.md](./jitsi.md) the `preferredDomain` can also come from the server's **Note**: Per [jitsi.md](./jitsi.md) the `preferredDomain` can also come from the server's
client .well-known data. client .well-known data.

View File

@@ -24,14 +24,13 @@ Element will use the Jitsi server that is embedded in the widget, even if it is
one you configured. This is because conference calls must be held on a single Jitsi one you configured. This is because conference calls must be held on a single Jitsi
server and cannot be split over multiple servers. server and cannot be split over multiple servers.
However, you can configure Element to _start_ a conference with your Jitsi server by adding However, you can configure Element to *start* a conference with your Jitsi server by adding
to your [config](./config.md) the following: to your [config](./config.md) the following:
```json ```json
{ {
"jitsi": { "jitsi": {
"preferred_domain": "your.jitsi.example.org" "preferredDomain": "your.jitsi.example.org"
} }
} }
``` ```
@@ -47,12 +46,11 @@ domain will appear later in the URL as a configuration parameter.
**Hint**: If you want everyone on your homeserver to use the same Jitsi server by **Hint**: If you want everyone on your homeserver to use the same Jitsi server by
default, and you are using element-web 1.6 or newer, set the following on your homeserver's default, and you are using element-web 1.6 or newer, set the following on your homeserver's
`/.well-known/matrix/client` config: `/.well-known/matrix/client` config:
```json ```json
{ {
"im.vector.riot.jitsi": { "im.vector.riot.jitsi": {
"preferredDomain": "your.jitsi.example.org" "preferredDomain": "your.jitsi.example.org"
} }
} }
``` ```

View File

@@ -1,4 +1,5 @@
# Running in Kubernetes Running in Kubernetes
=====================
In case you would like to deploy element-web in a kubernetes cluster you can use In case you would like to deploy element-web in a kubernetes cluster you can use
the provided Kubernetes example below as a starting point. Note that this example assumes the the provided Kubernetes example below as a starting point. Note that this example assumes the
@@ -162,7 +163,7 @@ Then you can deploy it to your cluster with something like `kubectl apply -f my-
add_header X-Frame-Options SAMEORIGIN; add_header X-Frame-Options SAMEORIGIN;
add_header X-Content-Type-Options nosniff; add_header X-Content-Type-Options nosniff;
add_header X-XSS-Protection "1; mode=block"; add_header X-XSS-Protection "1; mode=block";
add_header Content-Security-Policy "frame-ancestors 'self'"; add_header Content-Security-Policy "frame-ancestors 'none'";
spec: spec:
rules: rules:
- host: element.example.nl - host: element.example.nl
@@ -177,3 +178,4 @@ Then you can deploy it to your cluster with something like `kubectl apply -f my-
number: 80 number: 80
--- ---

View File

@@ -4,9 +4,6 @@ If Labs is enabled in the [Element config](config.md), you can enable some of th
to `Settings->Labs`. This list is non-exhaustive and subject to change, chat in to `Settings->Labs`. This list is non-exhaustive and subject to change, chat in
[#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) for more information. [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) for more information.
If a labs features gets more stable, it _may_ be promoted to a beta feature
(see [Betas](https://github.com/vector-im/element-web/blob/develop/docs/betas.md)).
**Be warned! Labs features are not finalised, they may be fragile, they may change, they may be **Be warned! Labs features are not finalised, they may be fragile, they may change, they may be
dropped. Ask in the room if you are unclear about any details here.** dropped. Ask in the room if you are unclear about any details here.**
@@ -86,6 +83,11 @@ present in the room. The Bridge info tab pulls information from the `m.bridge` s
bridges are not expected to be compatible, and users should not rely on this bridges are not expected to be compatible, and users should not rely on this
tab as the single source of truth just yet. tab as the single source of truth just yet.
## Presence indicator in room list (`feature_presence_in_room_list`)
This adds a presence indicator in the room list next to DM rooms where the other
person is online.
## Custom themes (`feature_custom_themes`) ## Custom themes (`feature_custom_themes`)
Custom themes are possible through Element's [theme support](./theming.md), though Custom themes are possible through Element's [theme support](./theming.md), though
@@ -95,45 +97,80 @@ theme definition.
For some sample themes, check out [aaronraimist/element-themes](https://github.com/aaronraimist/element-themes). For some sample themes, check out [aaronraimist/element-themes](https://github.com/aaronraimist/element-themes).
## Message preview tweaks
To enable message previews in the left panel for reactions in all rooms, enable `feature_roomlist_preview_reactions_all`.
To enable message previews for reactions in DMs only, enable `feature_roomlist_preview_reactions_dms`. This is ignored when it is enabled for all rooms.
## Dehydrated devices (`feature_dehydration`) ## Dehydrated devices (`feature_dehydration`)
Allows users to receive encrypted messages by creating a device that is stored Allows users to receive encrypted messages by creating a device that is stored
encrypted on the server, as described in [MSC2697](https://github.com/matrix-org/matrix-doc/pull/2697). encrypted on the server, as described in [MSC2697](https://github.com/matrix-org/matrix-doc/pull/2697).
## Breadcrumbs v2 (`feature_breadcrumbs_v2`)
Instead of showing the horizontal list of breadcrumbs under the filter field, the new UX is an interactive context menu
triggered by the button to the right of the filter field.
## Spotlight search (`feature_spotlight`) [In Development]
Switches to a new room search experience.
## Extensible events rendering (`feature_extensible_events`) [In Development]
*Intended for developer use only at the moment.*
Extensible Events are a [new event format](https://github.com/matrix-org/matrix-doc/pull/1767) which
supports graceful fallback in unknown event types. Instead of rendering nothing or a blank space, events
can define a series of other events which represent the event's information but in different ways. The
base of these fallbacks being text.
Turning this flag on indicates that, when possible, the extensible events structure should be parsed on
supported event types. This should lead to zero perceptual change in the timeline except in cases where
the sender is using unknown/unrecognised event types.
Sending events with extensible events structure is always enabled - this should not affect any downstream
client.
## Right panel stays open (`feature_right_panel_default_open`)
This is an experimental default open right panel mode as a quick fix for those
who prefer to have the right panel open consistently across rooms.
If no right panel state is known for the room or it was closed on the last room
visit, it will default to the room member list. Otherwise, the saved card last
used in that room is shown.
## Pin drop location sharing (`feature_location_share_pin_drop`) [In Development]
Enables sharing a pin drop location to the timeline.
## Live location sharing (`feature_location_share_live`) [In Development] ## Live location sharing (`feature_location_share_live`) [In Development]
Enables sharing your current location to the timeline, with live updates. Enables sharing your current location to the timeline, with live updates.
## Threaded Messaging (`feature_thread`)
Threading allows users to branch out a new conversation from the main timeline of a room. This is particularly useful in high traffic rooms where multiple conversations can happen in parallel or when a single discussion might stretch over a very long period of time.
Threads can be access by clicking their summary below the root event on the room timeline. Users can find a comprehensive list of threads by click the icon on the room header button.
This feature might work in degraded mode if the homeserver a user is connected to does not advertise support for the unstable feature `org.matrix.msc3440` when calling the `/versions` API endpoint.
## Video rooms (`feature_video_rooms`) ## Video rooms (`feature_video_rooms`)
Enables support for creating and joining video rooms, which are persistent video chats that users can jump in and out of. Enables support for creating and joining video rooms, which are persistent video chats that users can jump in and out of.
## Element Call video rooms (`feature_element_call_video_rooms`) [In Development]
Enables support for video rooms that use Element Call rather than Jitsi, and causes the 'New video room' option to create Element Call video rooms rather than Jitsi ones.
This flag will not have any effect unless `feature_video_rooms` is also enabled.
## New group call experience (`feature_group_calls`) [In Development]
This feature allows users to place and join native [MSC3401](https://github.com/matrix-org/matrix-spec-proposals/pull/3401) group calls in compatible rooms, using Element Call.
If you're enabling this at the deployment level, you may also want to reference the docs for the `element_call` config section.
## Rich text in room topics (`feature_html_topic`) [In Development] ## Rich text in room topics (`feature_html_topic`) [In Development]
Enables rendering of MD / HTML in room topics. Enables rendering of MD / HTML in room topics.
## Use the Rust cryptography implementation (`feature_rust_crypto`) [In Development] ## Exploring public spaces (`feature_exploring_public_spaces`)
Configures Element to use a new cryptography implementation based on the [matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk). Enables exploring public spaces in the new search dialog. Requires the server to
have [MSC3827](https://github.com/matrix-org/matrix-spec-proposals/pull/3827) enabled.
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. ## Favourite Messages (`feature_favourite_messages`) [In Development]
## New room header & details (`feature_new_room_decoration_ui`) [In Development] Enables users to bookmark a message or content for a later reference.
Refactors visually the room header and room sidebar
## Knock rooms (`feature_ask_to_join`) [In Development]
Enables knock feature for rooms. This allows users to ask to join a room.

View File

@@ -1,11 +1,11 @@
## Memory leaks ## Memory leaks
Element usually emits slow behaviour just before it is about to crash. Getting a Element 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 memory snapshot (below) just before that happens is ideal in figuring out what
is going wrong. is going wrong.
Common symptoms are clicking on a room and it feels like the tab froze and scrolling Common symptoms are clicking on a room and it feels like the tab froze and scrolling
becoming jumpy/staggered. becoming jumpy/staggered.
If you receive a white screen (electron) or the chrome crash page, it is likely 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 run out of memory and it is too late for a memory profile. Please do report when
@@ -22,8 +22,8 @@ and anything newer is still in the warmup stages of the app.
**Memory profiles can contain sensitive information.** If you are submitting a memory **Memory profiles can contain sensitive information.** If you are submitting a memory
profile to us for debugging purposes, please pick the appropriate Element developer and profile to us for debugging purposes, please pick the appropriate Element developer and
send them over an encrypted private message. _Do not share your memory profile in send them over an encrypted private message. *Do not share your memory profile in
public channels or with people you do not trust._ public channels or with people you do not trust.*
### Taking a memory profile (Firefox) ### Taking a memory profile (Firefox)

View File

@@ -34,7 +34,6 @@ our [ILAG module](https://github.com/vector-im/element-web-ilag-module) which wi
structure of a module is and how it works. structure of a module is and how it works.
The following requirements are key for any module: The following requirements are key for any module:
1. The module must depend on `@matrix-org/react-sdk-module-api` (usually as a dev dependency). 1. The module must depend on `@matrix-org/react-sdk-module-api` (usually as a dev dependency).
2. The module's `main` entrypoint must have a `default` export for the `RuntimeModule` instance, supporting a constructor 2. The module's `main` entrypoint must have a `default` export for the `RuntimeModule` instance, supporting a constructor
which takes a single parameter: a `ModuleApi` instance. This instance is passed to `super()`. which takes a single parameter: a `ModuleApi` instance. This instance is passed to `super()`.

View File

@@ -10,53 +10,53 @@ When reviewing code, here are some things we look for and also things we avoid:
### We review for ### We review for
- Correctness * Correctness
- Performance * Performance
- Accessibility * Accessibility
- Security * Security
- Quality via automated and manual testing * Quality via automated and manual testing
- Comments and documentation where needed * Comments and documentation where needed
- Sharing knowledge of different areas among the team * Sharing knowledge of different areas among the team
- Ensuring it's something we're comfortable maintaining for the long term * Ensuring it's something we're comfortable maintaining for the long term
- Progress indicators and local echo where appropriate with network activity * Progress indicators and local echo where appropriate with network activity
### We should avoid ### We should avoid
- Style nits that are already handled by the linter * Style nits that are already handled by the linter
- Dramatically increasing scope * Dramatically increasing scope
### Good practices ### Good practices
- Use empathetic language * Use empathetic language
- See also [Mindful Communication in Code * See also [Mindful Communication in Code
Reviews](https://kickstarter.engineering/a-guide-to-mindful-communication-in-code-reviews-48aab5282e5e) Reviews](https://kickstarter.engineering/a-guide-to-mindful-communication-in-code-reviews-48aab5282e5e)
and [How to Do Code Reviews Like a Human](https://mtlynch.io/human-code-reviews-1/) and [How to Do Code Reviews Like a Human](https://mtlynch.io/human-code-reviews-1/)
- Authors should prefer smaller commits for easier reviewing and bisection * Authors should prefer smaller commits for easier reviewing and bisection
- Reviewers should be explicit about required versus optional changes * Reviewers should be explicit about required versus optional changes
- Reviews are conversations and the PR author should feel comfortable * Reviews are conversations and the PR author should feel comfortable
discussing and pushing back on changes before making them discussing and pushing back on changes before making them
- Reviewers are encouraged to ask for tests where they believe it is reasonable * Reviewers are encouraged to ask for tests where they believe it is reasonable
- Core team should lead by example through their tone and language * Core team should lead by example through their tone and language
- Take the time to thank and point out good code changes * Take the time to thank and point out good code changes
- Using softer language like "please" and "what do you think?" goes a long way * Using softer language like "please" and "what do you think?" goes a long way
towards making others feel like colleagues working towards a common goal towards making others feel like colleagues working towards a common goal
### Workflow ### Workflow
- Authors should request review from the element-web team by default (if someone on * Authors should request review from the element-web team by default (if someone on
the team is clearly the expert in an area, a direct review request to them may the team is clearly the expert in an area, a direct review request to them may
be more appropriate) be more appropriate)
- Reviewers should remove the team review request and request review from * Reviewers should remove the team review request and request review from
themselves when starting a review to avoid double review themselves when starting a review to avoid double review
- If there are multiple related PRs authors should reference each of the PRs in * If there are multiple related PRs authors should reference each of the PRs in
the others before requesting review. Reviewers might start reviewing from the others before requesting review. Reviewers might start reviewing from
different places and could miss other required PRs. different places and could miss other required PRs.
- Avoid force pushing to a PR after the first round of review * Avoid force pushing to a PR after the first round of review
- Use the GitHub default of merge commits when landing (avoid alternate options * Use the GitHub default of merge commits when landing (avoid alternate options
like squash or rebase) like squash or rebase)
- PR author merges after review (assuming they have write access) * PR author merges after review (assuming they have write access)
- Assign issues only when in progress to indicate to others what can be picked * Assign issues only when in progress to indicate to others what can be picked
up up
## Code Quality ## Code Quality
@@ -64,10 +64,10 @@ In the past, we have occasionally written different kinds of tests for
Element and the SDKs, but it hasn't been a consistent focus. Going forward, we'd Element and the SDKs, but it hasn't been a consistent focus. Going forward, we'd
like to change that. like to change that.
- For new features, code reviewers will expect some form of automated testing to * For new features, code reviewers will expect some form of automated testing to
be included by default be included by default
- For bug fixes, regression tests are of course great to have, but we don't want * For bug fixes, regression tests are of course great to have, but we don't want
to block fixes on this, so we won't require them at this time to block fixes on this, so we won't require them at this time
The above policy is not a strict rule, but instead it's meant to be a The above policy is not a strict rule, but instead it's meant to be a
conversation between the author and reviewer. As an author, try to think about conversation between the author and reviewer. As an author, try to think about
@@ -104,10 +104,10 @@ perspective.
In more detail, our usual process for changes that affect the UI or alter user In more detail, our usual process for changes that affect the UI or alter user
functionality is: functionality is:
- For changes that will go live when merged, always flag Design and Product * For changes that will go live when merged, always flag Design and Product
teams as appropriate teams as appropriate
- For changes guarded by a feature flag, Design and Product review is not * For changes guarded by a feature flag, Design and Product review is not
required (though may still be useful) since we can continue tweaking required (though may still be useful) since we can continue tweaking
As it can be difficult to review design work from looking at just the changed As it can be difficult to review design work from looking at just the changed
files in a PR, a [preview site](./pr-previews.md) that includes your changes files in a PR, a [preview site](./pr-previews.md) that includes your changes

View File

@@ -1,29 +1,31 @@
# Theming Element Theming Element
============
Themes are a very basic way of providing simple alternative look & feels to the Themes are a very basic way of providing simple alternative look & feels to the
Element app via CSS & custom imagery. Element app via CSS & custom imagery.
They are _NOT_ co be confused with 'skins', which describe apps which sit on top They are *NOT* co be confused with 'skins', which describe apps which sit on top
of matrix-react-sdk - e.g. in theory Element itself is a react-sdk skin. of matrix-react-sdk - e.g. in theory Element itself is a react-sdk skin.
As of March 2022, skins are not fully supported; Element is the only available skin. As of March 2022, skins are not fully supported; Element is the only available skin.
To define a theme for Element: To define a theme for Element:
1. Pick a name, e.g. `teal`. at time of writing we have `light` and `dark`. 1. Pick a name, e.g. `teal`. at time of writing we have `light` and `dark`.
2. Fork `src/skins/vector/css/themes/dark.pcss` to be `teal.pcss` 2. Fork `src/skins/vector/css/themes/dark.pcss` to be `teal.pcss`
3. Fork `src/skins/vector/css/themes/_base.pcss` to be `_teal.pcss` 3. Fork `src/skins/vector/css/themes/_base.pcss` to be `_teal.pcss`
4. Override variables in `_teal.pcss` as desired. You may wish to delete ones 4. Override variables in `_teal.pcss` as desired. You may wish to delete ones
which don't differ from `_base.pcss`, to make it clear which are being which don't differ from `_base.pcss`, to make it clear which are being
overridden. If every single colour is being changed (as per `_dark.pcss`) overridden. If every single colour is being changed (as per `_dark.pcss`)
then you might as well keep them all. then you might as well keep them all.
5. Add the theme to the list of entrypoints in webpack.config.js 5. Add the theme to the list of entrypoints in webpack.config.js
6. Add the theme to the list of themes in matrix-react-sdk's UserSettings.js 6. Add the theme to the list of themes in matrix-react-sdk's UserSettings.js
7. Sit back and admire your handywork. 7. Sit back and admire your handywork.
In future, the assets for a theme will probably be gathered together into a In future, the assets for a theme will probably be gathered together into a
single directory tree. single directory tree.
# Custom Themes Custom Themes
=============
Themes derived from the built in themes may also be defined in settings. Themes derived from the built in themes may also be defined in settings.

View File

@@ -2,11 +2,11 @@
## Requirements ## Requirements
- A working [Development Setup](../README.md#setting-up-a-dev-environment) - A working [Development Setup](../README.md#setting-up-a-dev-environment)
- Including up-to-date versions of matrix-react-sdk and matrix-js-sdk - Including up-to-date versions of matrix-react-sdk and matrix-js-sdk
- Latest LTS version of Node.js installed - Latest LTS version of Node.js installed
- Be able to understand English - Be able to understand English
- Be able to understand the language you want to translate Element into - Be able to understand the language you want to translate Element into
## Translating strings vs. marking strings for translation ## Translating strings vs. marking strings for translation
@@ -15,7 +15,6 @@ Translating strings are done with the `_t()` function found in matrix-react-sdk/
Basically, whenever a translatable string is introduced, you should call either `_t()` immediately OR `_td()` and later `_t()`. Basically, whenever a translatable string is introduced, you should call either `_t()` immediately OR `_td()` and later `_t()`.
Example: Example:
``` ```
// Module-level constant // Module-level constant
const COLORS = { const COLORS = {
@@ -31,10 +30,10 @@ function getColorName(hex) {
## Adding new strings ## Adding new strings
1. Check if the import `import { _t } from 'matrix-react-sdk/src/languageHandler';` is present. If not add it to the other import statements. Also import `_td` if needed. 1. Check if the import ``import { _t } from 'matrix-react-sdk/src/languageHandler';`` is present. If not add it to the other import statements. Also import `_td` if needed.
1. Add `_t()` to your string. (Don't forget curly braces when you assign an expression to JSX attributes in the render method). If the string is introduced at a point before the translation system has not yet been initialized, use `_td()` instead, and call `_t()` at the appropriate time. 1. Add ``_t()`` to your string. (Don't forget curly braces when you assign an expression to JSX attributes in the render method). If the string is introduced at a point before the translation system has not yet been initialized, use `_td()` instead, and call `_t()` at the appropriate time.
1. Run `yarn i18n` to update `src/i18n/strings/en_EN.json` 1. Run `yarn i18n` to update ``src/i18n/strings/en_EN.json``
1. If you added a string with a plural, you can add other English plural variants to `src/i18n/strings/en_EN.json` (remeber to edit the one in the same project as the source file containing your new translation). 1. If you added a string with a plural, you can add other English plural variants to ``src/i18n/strings/en_EN.json`` (remeber to edit the one in the same project as the source file containing your new translation).
## Editing existing strings ## Editing existing strings
@@ -44,21 +43,21 @@ function getColorName(hex) {
## Adding variables inside a string. ## Adding variables inside a string.
1. Extend your `_t()` call. Instead of `_t(STRING)` use `_t(STRING, {})` 1. Extend your ``_t()`` call. Instead of ``_t(STRING)`` use ``_t(STRING, {})``
1. Decide how to name it. Please think about if the person who has to translate it can understand what it does. E.g. using the name 'recipient' is bad, because a translator does not know if it is the name of a person, an email address, a user ID, etc. Rather use e.g. recipientEmailAddress. 1. Decide how to name it. Please think about if the person who has to translate it can understand what it does. E.g. using the name 'recipient' is bad, because a translator does not know if it is the name of a person, an email address, a user ID, etc. Rather use e.g. recipientEmailAddress.
1. Add it to the array in `_t` for example `_t(STRING, {variable: this.variable})` 1. Add it to the array in ``_t`` for example ``_t(STRING, {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. 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 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).
- 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. - 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> })`. - 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> })``.
## Things to know/Style Guides ## Things to know/Style Guides
- Do not use `_t()` inside `getDefaultProps`: the translations aren't loaded when `getDefaultProps` is called, leading to missing translations. Use `_td()` to indicate that `_t()` will be called on the string later. - Do not use `_t()` inside ``getDefaultProps``: the translations aren't loaded when `getDefaultProps` is called, leading to missing translations. Use `_td()` to indicate that `_t()` will be called on the string later.
- If using translated strings as constants, translated strings can't be in constants loaded at class-load time since the translations won't be loaded. Mark the strings using `_td()` instead and perform the actual translation later. - If using translated strings as constants, translated strings can't be in constants loaded at class-load time since the translations won't be loaded. Mark the strings using `_td()` instead and perform the actual translation later.
- If a string is presented in the UI with punctuation like a full stop, include this in the translation strings, since punctuation varies between languages too. - If a string is presented in the UI with punctuation like a full stop, include this in the translation strings, since punctuation varies between languages too.
- Avoid "translation in parts", i.e. concatenating translated strings or using translated strings in variable substitutions. Context is important for translations, and translating partial strings this way is simply not always possible. - Avoid "translation in parts", i.e. concatenating translated strings or using translated strings in variable substitutions. Context is important for translations, and translating partial strings this way is simply not always possible.
- Concatenating strings often also introduces an implicit assumption about word order (e.g. that the subject of the sentence comes first), which is incorrect for many languages. - Concatenating strings often also introduces an implicit assumption about word order (e.g. that the subject of the sentence comes first), which is incorrect for many languages.
- Translation 'smell test': If you have a string that does not begin with a capital letter (is not the start of a sentence) or it ends with e.g. ':' or a preposition (e.g. 'to') you should recheck that you are not trying to translate a partial sentence. - Translation 'smell test': If you have a string that does not begin with a capital letter (is not the start of a sentence) or it ends with e.g. ':' or a preposition (e.g. 'to') you should recheck that you are not trying to translate a partial sentence.
- If you have multiple strings, that are almost identical, except some part (e.g. a word or two) it is still better to translate the full sentence multiple times. It may seem like inefficient repetion, but unlike programming where you try to minimize repetition, translation is much faster if you have many, full, clear, sentences to work with, rather than fewer, but incomplete sentence fragments. - If you have multiple strings, that are almost identical, except some part (e.g. a word or two) it is still better to translate the full sentence multiple times. It may seem like inefficient repetion, but unlike programming where you try to minimize repetition, translation is much faster if you have many, full, clear, sentences to work with, rather than fewer, but incomplete sentence fragments.

View File

@@ -2,15 +2,15 @@
## Requirements ## Requirements
- Web Browser - Web Browser
- Be able to understand English - Be able to understand English
- Be able to understand the language you want to translate Element into - Be able to understand the language you want to translate Element into
## Step 0: Join #element-translations:matrix.org ## Step 0: Join #element-translations:matrix.org
1. Come and join https://matrix.to/#/#element-translations:matrix.org for general discussion 1. Come and join https://matrix.to/#/#element-translations:matrix.org for general discussion
2. Join https://matrix.to/#/#element-translators:matrix.org for language-specific rooms 2. Join https://matrix.to/#/#element-translators:matrix.org for language-specific rooms
3. Read scrollback and/or ask if anyone else is working on your language, and co-ordinate if needed. In general little-or-no coordination is needed though :) 3. Read scrollback and/or ask if anyone else is working on your language, and co-ordinate if needed. In general little-or-no coordination is needed though :)
## Step 1: Preparing your Weblate Profile ## Step 1: Preparing your Weblate Profile
@@ -27,7 +27,7 @@ If your language is listed go to Step 2a and if not go to Step 2b
## Step 2a: Helping on existing languages. ## Step 2a: Helping on existing languages.
1. Head to one of the projects listed https://translate.element.io/projects/element-web/ 1. Head to one of the projects listed https://translate.element.io/projects/element-web/
2. Click on the `translate` button on the right side of your language 2. Click on the ``translate`` button on the right side of your language
3. Fill in the translations in the writeable field. You will see the original English string and the string of your second language above. 3. Fill in the translations in the writeable field. You will see the original English string and the string of your second language above.
Head to the explanations under Steb 2b Head to the explanations under Steb 2b
@@ -35,7 +35,7 @@ Head to the explanations under Steb 2b
## Step 2b: Adding a new language ## Step 2b: Adding a new language
1. Go to one of the projects listed https://translate.element.io/projects/element-web/ 1. Go to one of the projects listed https://translate.element.io/projects/element-web/
2. Click the `Start new translation` button at the bottom 2. Click the ``Start new translation`` button at the bottom
3. Select a language 3. Select a language
4. Start translating like in 2a.3 4. Start translating like in 2a.3
5. Repeat these steps for the other projects which are listed at the link of step 2b.1 5. Repeat these steps for the other projects which are listed at the link of step 2b.1
@@ -52,12 +52,13 @@ The yellow button has to be used if you are unsure about the translation but you
These things are variables that are expanded when displayed by Element. They can be room names, usernames or similar. If you find one, you can move to the right place for your language, but not delete it as the variable will be missing if you do. These things are variables that are expanded when displayed by Element. They can be room names, usernames or similar. If you find one, you can move to the right place for your language, but not delete it as the variable will be missing if you do.
A special case is `%(urlStart)s` and `%(urlEnd)s` which are used to mark the beginning of a hyperlink (i.e. `<a href="/somewhere">` and `</a>`. You must keep these markers surrounding the equivalent string in your language that needs to be hyperlinked. A special case is `%(urlStart)s` and `%(urlEnd)s` which are used to mark the beginning of a hyperlink (i.e. `<a href="/somewhere">` and `</a>`. You must keep these markers surrounding the equivalent string in your language that needs to be hyperlinked.
### "I want to come back to this string. How?" ### "I want to come back to this string. How?"
You can use inside the translation field "Review needed" checkbox. It will be shown as Strings that need to be reviewed. You can use inside the translation field "Review needed" checkbox. It will be shown as Strings that need to be reviewed.
### Further reading ### Further reading
The official Weblate doc provides some more in-depth explanation on how to do translations and talks about do and don'ts. You can find it at: https://docs.weblate.org/en/latest/user/translating.html The official Weblate doc provides some more in-depth explanation on how to do translations and talks about do and don'ts. You can find it at: https://docs.weblate.org/en/latest/user/translating.html

View File

@@ -1,13 +1,5 @@
{ {
"default_server_name": "matrix.org", "default_server_name": "matrix.org",
"default_server_config": {
"m.homeserver": {
"base_url": "https://matrix-client.matrix.org"
},
"m.identity_server": {
"base_url": "https://vector.im"
}
},
"brand": "Element", "brand": "Element",
"integrations_ui_url": "https://scalar.vector.im/", "integrations_ui_url": "https://scalar.vector.im/",
"integrations_rest_url": "https://scalar.vector.im/api", "integrations_rest_url": "https://scalar.vector.im/api",
@@ -18,11 +10,16 @@
"https://scalar-staging.vector.im/api", "https://scalar-staging.vector.im/api",
"https://scalar-staging.riot.im/scalar/api" "https://scalar-staging.riot.im/scalar/api"
], ],
"hosting_signup_link": "https://element.io/matrix-services?utm_source=element-web&utm_medium=web",
"bug_report_endpoint_url": "https://element.io/bugreports/submit", "bug_report_endpoint_url": "https://element.io/bugreports/submit",
"uisi_autorageshake_app": "element-auto-uisi", "uisi_autorageshake_app": "element-auto-uisi",
"show_labs_settings": false, "showLabsSettings": false,
"room_directory": { "roomDirectory": {
"servers": ["matrix.org", "gitter.im", "libera.chat"] "servers": [
"matrix.org",
"gitter.im",
"libera.chat"
]
}, },
"enable_presence_by_hs_url": { "enable_presence_by_hs_url": {
"https://matrix.org": false, "https://matrix.org": false,
@@ -38,9 +35,19 @@
"text": "Cookie Policy" "text": "Cookie Policy"
} }
], ],
"hostSignup": {
"brand": "Element Home",
"cookiePolicyUrl": "https://element.io/cookie-policy",
"domains": [
"matrix.org"
],
"privacyPolicyUrl": "https://element.io/privacy",
"termsOfServiceUrl": "https://element.io/terms-of-service",
"url": "https://ems.element.io/element-home/in-app-loader"
},
"posthog": { "posthog": {
"project_api_key": "phc_Jzsm6DTm6V2705zeU5dcNvQDlonOR68XvX2sh1sEOHO", "projectApiKey": "phc_Jzsm6DTm6V2705zeU5dcNvQDlonOR68XvX2sh1sEOHO",
"api_host": "https://posthog.element.io" "apiHost": "https://posthog.element.io"
}, },
"privacy_policy_url": "https://element.io/cookie-policy", "privacy_policy_url": "https://element.io/cookie-policy",
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx" "map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx"

View File

@@ -1,13 +1,5 @@
{ {
"default_server_name": "matrix.org", "default_server_name": "matrix.org",
"default_server_config": {
"m.homeserver": {
"base_url": "https://matrix-client.matrix.org"
},
"m.identity_server": {
"base_url": "https://vector.im"
}
},
"brand": "Element", "brand": "Element",
"integrations_ui_url": "https://scalar.vector.im/", "integrations_ui_url": "https://scalar.vector.im/",
"integrations_rest_url": "https://scalar.vector.im/api", "integrations_rest_url": "https://scalar.vector.im/api",
@@ -18,11 +10,16 @@
"https://scalar-staging.vector.im/api", "https://scalar-staging.vector.im/api",
"https://scalar-staging.riot.im/scalar/api" "https://scalar-staging.riot.im/scalar/api"
], ],
"hosting_signup_link": "https://element.io/matrix-services?utm_source=element-web&utm_medium=web",
"bug_report_endpoint_url": "https://element.io/bugreports/submit", "bug_report_endpoint_url": "https://element.io/bugreports/submit",
"uisi_autorageshake_app": "element-auto-uisi", "uisi_autorageshake_app": "element-auto-uisi",
"show_labs_settings": true, "showLabsSettings": true,
"room_directory": { "roomDirectory": {
"servers": ["matrix.org", "gitter.im", "libera.chat"] "servers": [
"matrix.org",
"gitter.im",
"libera.chat"
]
}, },
"enable_presence_by_hs_url": { "enable_presence_by_hs_url": {
"https://matrix.org": false, "https://matrix.org": false,
@@ -38,20 +35,28 @@
"text": "Cookie Policy" "text": "Cookie Policy"
} }
], ],
"hostSignup": {
"brand": "Element Home",
"cookiePolicyUrl": "https://element.io/cookie-policy",
"domains": [
"matrix.org"
],
"privacyPolicyUrl": "https://element.io/privacy",
"termsOfServiceUrl": "https://element.io/terms-of-service",
"url": "https://ems.element.io/element-home/in-app-loader"
},
"sentry": { "sentry": {
"dsn": "https://029a0eb289f942508ae0fb17935bd8c5@sentry.matrix.org/6", "dsn": "https://029a0eb289f942508ae0fb17935bd8c5@sentry.matrix.org/6",
"environment": "develop" "environment": "develop"
}, },
"posthog": { "posthog": {
"project_api_key": "phc_Jzsm6DTm6V2705zeU5dcNvQDlonOR68XvX2sh1sEOHO", "projectApiKey": "phc_Jzsm6DTm6V2705zeU5dcNvQDlonOR68XvX2sh1sEOHO",
"api_host": "https://posthog.element.io" "apiHost": "https://posthog.element.io"
}, },
"privacy_policy_url": "https://element.io/cookie-policy", "privacy_policy_url": "https://element.io/cookie-policy",
"features": { "features": {
"feature_spotlight": true,
"feature_video_rooms": true "feature_video_rooms": true
}, },
"element_call": {
"url": "https://element-call-livekit.netlify.app"
},
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx" "map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx"
} }

View File

@@ -1,57 +0,0 @@
/*
Copyright 2023 The Matrix.org Foundation C.I.C.
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.
*/
import { env } from "process";
import type { Config } from "jest";
const config: Config = {
testEnvironment: "jsdom",
testEnvironmentOptions: {
url: "http://localhost/",
},
testMatch: ["<rootDir>/test/**/*-test.[tj]s?(x)"],
setupFiles: ["jest-canvas-mock"],
setupFilesAfterEnv: ["<rootDir>/node_modules/matrix-react-sdk/test/setupTests.ts"],
moduleNameMapper: {
"\\.(css|scss|pcss)$": "<rootDir>/__mocks__/cssMock.js",
"\\.(gif|png|ttf|woff2)$": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/imageMock.js",
"\\.svg$": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/svg.js",
"\\$webapp/i18n/languages.json": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/languages.json",
"^react$": "<rootDir>/node_modules/react",
"^react-dom$": "<rootDir>/node_modules/react-dom",
"^matrix-js-sdk$": "<rootDir>/node_modules/matrix-js-sdk/src",
"^matrix-react-sdk$": "<rootDir>/node_modules/matrix-react-sdk/src",
"decoderWorker\\.min\\.js": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
"decoderWorker\\.min\\.wasm": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
"waveWorker\\.min\\.js": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
"context-filter-polyfill": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
"FontManager.ts": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/FontManager.js",
"workers/(.+)\\.worker\\.ts": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/workerMock.js",
"^!!raw-loader!.*": "jest-raw-loader",
"RecorderWorklet": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
},
transformIgnorePatterns: ["/node_modules/(?!matrix-js-sdk).+$", "/node_modules/(?!matrix-react-sdk).+$"],
coverageReporters: ["text-summary", "lcov"],
testResultsProcessor: "@casualbot/jest-sonar-reporter",
};
// if we're running under GHA, enable the GHA reporter
if (env["GITHUB_ACTIONS"] !== undefined) {
config.reporters = [["github-actions", { silent: false }], "summary"];
}
export default config;

View File

@@ -65,7 +65,7 @@ export function installer(config: BuildConfig): void {
// else must be a module, we assume. // else must be a module, we assume.
const pkgJsonStr = fs.readFileSync("./package.json", "utf-8"); const pkgJsonStr = fs.readFileSync("./package.json", "utf-8");
const optionalDepNames = getOptionalDepNames(pkgJsonStr); const optionalDepNames = getOptionalDepNames(pkgJsonStr);
const installedModules = optionalDepNames.filter((d) => !currentOptDeps.includes(d)); const installedModules = optionalDepNames.filter(d => !currentOptDeps.includes(d));
// Ensure all the modules are compatible. We check them all and report at the end to // Ensure all the modules are compatible. We check them all and report at the end to
// try and save the user some time debugging this sort of failure. // try and save the user some time debugging this sort of failure.
@@ -80,7 +80,7 @@ export function installer(config: BuildConfig): void {
if (incompatibleNames.length > 0) { if (incompatibleNames.length > 0) {
console.error( console.error(
"The following modules are not compatible with this version of element-web. Please update the module " + "The following modules are not compatible with this version of element-web. Please update the module " +
"references and try again.", "references and try again.",
JSON.stringify(incompatibleNames, null, 4), // stringify to get prettier/complete output JSON.stringify(incompatibleNames, null, 4), // stringify to get prettier/complete output
); );
exitCode = 1; exitCode = 1;
@@ -123,43 +123,39 @@ function readCurrentPackageDetails(): RawDependencies {
}; };
} }
function writePackageDetails(deps: RawDependencies): void { function writePackageDetails(deps: RawDependencies) {
fs.writeFileSync("./yarn.lock", deps.lockfile, "utf-8"); fs.writeFileSync("./yarn.lock", deps.lockfile, "utf-8");
fs.writeFileSync("./package.json", deps.packageJson, "utf-8"); fs.writeFileSync("./package.json", deps.packageJson, "utf-8");
} }
function callYarnAdd(dep: string): void { function callYarnAdd(dep: string) {
// Add the module to the optional dependencies section just in case something // Add the module to the optional dependencies section just in case something
// goes wrong in restoring the original package details. // goes wrong in restoring the original package details.
childProcess.execSync(`yarn add -O ${dep}`, { childProcess.execSync(`yarn add -O ${dep}`, {
env: process.env, env: process.env,
stdio: ["inherit", "inherit", "inherit"], stdio: ['inherit', 'inherit', 'inherit'],
}); });
} }
function getOptionalDepNames(pkgJsonStr: string): string[] { function getOptionalDepNames(pkgJsonStr: string): string[] {
return Object.keys(JSON.parse(pkgJsonStr)?.["optionalDependencies"] ?? {}); return Object.keys(JSON.parse(pkgJsonStr)?.['optionalDependencies'] ?? {});
} }
function findDepVersionInPackageJson(dep: string, pkgJsonStr: string): string { function findDepVersionInPackageJson(dep: string, pkgJsonStr: string): string {
const pkgJson = JSON.parse(pkgJsonStr); const pkgJson = JSON.parse(pkgJsonStr);
const packages = { const packages = {
...(pkgJson["optionalDependencies"] ?? {}), ...(pkgJson['optionalDependencies'] ?? {}),
...(pkgJson["devDependencies"] ?? {}), ...(pkgJson['devDependencies'] ?? {}),
...(pkgJson["dependencies"] ?? {}), ...(pkgJson['dependencies'] ?? {}),
}; };
return packages[dep]; return packages[dep];
} }
function getTopLevelDependencyVersion(dep: string): string { function getTopLevelDependencyVersion(dep: string): string {
const dependencyTree = JSON.parse( const dependencyTree = JSON.parse(childProcess.execSync(`npm list ${dep} --depth=0 --json`, {
childProcess env: process.env,
.execSync(`npm list ${dep} --depth=0 --json`, { stdio: ['inherit', 'pipe', 'pipe'],
env: process.env, }).toString('utf-8'));
stdio: ["inherit", "pipe", "pipe"],
})
.toString("utf-8"),
);
/* /*
What a dependency tree looks like: What a dependency tree looks like:
@@ -185,22 +181,11 @@ function getModuleApiVersionFor(moduleName: string): string {
return findDepVersionInPackageJson(moduleApiDepName, pkgJsonStr); return findDepVersionInPackageJson(moduleApiDepName, pkgJsonStr);
} }
// A list of Module API versions that are supported in addition to the currently installed one
// defined in the package.json. This is necessary because semantic versioning is applied to both
// the Module-side surface of the API and the Client-side surface of the API. So breaking changes
// in the Client-side surface lead to a major bump even though the Module-side surface stays
// compatible. We aim to not break the Module-side surface so we maintain a list of compatible
// older versions.
const backwardsCompatibleMajorVersions = ["1.0.0"];
function isModuleVersionCompatible(ourApiVersion: string, moduleApiVersion: string): boolean { function isModuleVersionCompatible(ourApiVersion: string, moduleApiVersion: string): boolean {
if (!moduleApiVersion) return false; if (!moduleApiVersion) return false;
return ( return semver.satisfies(ourApiVersion, moduleApiVersion);
semver.satisfies(ourApiVersion, moduleApiVersion) ||
backwardsCompatibleMajorVersions.some((version) => semver.satisfies(version, moduleApiVersion))
);
} }
function writeModulesTs(content: string): void { function writeModulesTs(content: string) {
fs.writeFileSync("./src/modules.ts", content, "utf-8"); fs.writeFileSync("./src/modules.ts", content, "utf-8");
} }

View File

@@ -1,193 +1,215 @@
{ {
"name": "element-web", "name": "element-web",
"version": "1.11.40", "version": "1.11.4",
"description": "A feature-rich client for Matrix.org", "description": "A feature-rich client for Matrix.org",
"author": "New Vector Ltd.", "author": "New Vector Ltd.",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/vector-im/element-web" "url": "https://github.com/vector-im/element-web"
},
"license": "Apache-2.0",
"files": [
"lib",
"res",
"src",
"webpack.config.js",
"scripts",
"docs",
"release.sh",
"deploy",
"CHANGELOG.md",
"CONTRIBUTING.rst",
"LICENSE",
"README.md",
"AUTHORS.rst",
"package.json",
"contribute.json"
],
"style": "bundle.css",
"scripts": {
"i18n": "matrix-gen-i18n",
"prunei18n": "matrix-prune-i18n",
"diff-i18n": "cp src/i18n/strings/en_EN.json src/i18n/strings/en_EN_orig.json && matrix-gen-i18n && matrix-compare-i18n-files src/i18n/strings/en_EN_orig.json src/i18n/strings/en_EN.json",
"clean": "rimraf lib webapp",
"build": "yarn clean && yarn build:genfiles && yarn build:bundle",
"build-stats": "yarn clean && yarn build:genfiles && yarn build:bundle-stats",
"build:jitsi": "node scripts/build-jitsi.js",
"build:res": "node scripts/copy-res.js",
"build:genfiles": "yarn build:res && yarn build:jitsi && yarn build:module_system",
"build:modernizr": "modernizr -c .modernizr.json -d src/vector/modernizr.js",
"build:bundle": "webpack --progress --bail --mode production",
"build:bundle-stats": "webpack --progress --bail --mode production --json > webpack-stats.json",
"build:module_system": "tsc --project ./tsconfig.module_system.json && node ./lib/module_system/scripts/install.js",
"dist": "scripts/package.sh",
"start": "yarn build:module_system && concurrently --kill-others-on-fail --prefix \"{time} [{name}]\" -n res,element-js \"yarn start:res\" \"yarn start:js\"",
"start:https": "concurrently --kill-others-on-fail --prefix \"{time} [{name}]\" -n res,element-js \"yarn start:res\" \"yarn start:js --https\"",
"start:res": "yarn build:jitsi && node scripts/copy-res.js -w",
"start:js": "webpack-dev-server --host=0.0.0.0 --output-filename=bundles/_dev_/[name].js --output-chunk-filename=bundles/_dev_/[name].js -w --mode development --disable-host-check --hot",
"lint": "yarn lint:types && yarn lint:js && yarn lint:style",
"lint:js": "eslint --max-warnings 0 src module_system",
"lint:js-fix": "eslint --fix src module_system",
"lint:types": "tsc --noEmit --jsx react && tsc --noEmit --project ./tsconfig.module_system.json",
"lint:style": "stylelint \"res/css/**/*.pcss\"",
"test": "jest",
"coverage": "yarn test --coverage",
"analyse:unused-exports": "node ./scripts/analyse_unused_exports.js"
},
"dependencies": {
"@matrix-org/olm": "https://gitlab.matrix.org/api/v4/projects/27/packages/npm/@matrix-org/olm/-/@matrix-org/olm-3.2.12.tgz",
"@matrix-org/react-sdk-module-api": "^0.0.3",
"browser-request": "^0.3.3",
"gfm.css": "^1.1.2",
"jsrsasign": "^10.5.25",
"katex": "^0.12.0",
"matrix-js-sdk": "github:matrix-org/matrix-js-sdk#develop",
"matrix-react-sdk": "github:matrix-org/matrix-react-sdk#develop",
"matrix-widget-api": "^1.0.0",
"prop-types": "^15.7.2",
"react": "17.0.2",
"react-dom": "17.0.2",
"sanitize-html": "^2.3.2",
"ua-parser-js": "^0.7.24"
},
"devDependencies": {
"@babel/core": "^7.12.10",
"@babel/eslint-parser": "^7.12.10",
"@babel/eslint-plugin": "^7.12.10",
"@babel/plugin-proposal-class-properties": "^7.12.1",
"@babel/plugin-proposal-export-default-from": "^7.12.1",
"@babel/plugin-proposal-nullish-coalescing-operator": "^7.12.1",
"@babel/plugin-proposal-numeric-separator": "^7.12.7",
"@babel/plugin-proposal-object-rest-spread": "^7.12.1",
"@babel/plugin-proposal-optional-chaining": "^7.12.7",
"@babel/plugin-syntax-dynamic-import": "^7.8.3",
"@babel/plugin-transform-runtime": "^7.12.10",
"@babel/preset-env": "^7.12.11",
"@babel/preset-react": "^7.12.10",
"@babel/preset-typescript": "^7.12.7",
"@babel/register": "^7.12.10",
"@babel/runtime": "^7.12.5",
"@principalstudio/html-webpack-inject-preload": "^1.2.7",
"@sentry/webpack-plugin": "^1.18.1",
"@svgr/webpack": "^5.5.0",
"@types/flux": "^3.1.9",
"@types/jest": "^28.0.0",
"@types/modernizr": "^3.5.3",
"@types/node": "^14.14.22",
"@types/react": "17.0.14",
"@types/react-dom": "17.0.9",
"@types/sanitize-html": "^2.3.1",
"@types/ua-parser-js": "^0.7.36",
"@typescript-eslint/eslint-plugin": "^5.6.0",
"@typescript-eslint/parser": "^5.6.0",
"allchange": "^1.0.6",
"autoprefixer": "^9.8.6",
"babel-jest": "^28.0.0",
"babel-loader": "^8.2.2",
"chokidar": "^3.5.1",
"concurrently": "^5.3.0",
"cpx": "^1.5.0",
"css-loader": "^3.6.0",
"dotenv": "^10.0.0",
"eslint": "8.9.0",
"eslint-config-google": "^0.14.0",
"eslint-plugin-deprecate": "^0.7.0",
"eslint-plugin-import": "^2.25.4",
"eslint-plugin-matrix-org": "^0.6.1",
"eslint-plugin-react": "^7.28.0",
"eslint-plugin-react-hooks": "^4.3.0",
"extract-text-webpack-plugin": "^4.0.0-beta.0",
"fake-indexeddb": "^3.1.2",
"file-loader": "^5.1.0",
"fs-extra": "^0.30.0",
"html-webpack-plugin": "^4.5.2",
"jest": "^28.0.0",
"jest-environment-jsdom": "^28.1.3",
"jest-raw-loader": "^1.0.1",
"jest-sonar-reporter": "^2.0.0",
"json-loader": "^0.5.7",
"loader-utils": "^1.4.0",
"matrix-mock-request": "^2.0.0",
"matrix-react-test-utils": "^0.2.3",
"matrix-web-i18n": "^1.3.0",
"mini-css-extract-plugin": "^0.12.0",
"minimist": "^1.2.6",
"mkdirp": "^1.0.4",
"modernizr": "^3.12.0",
"node-fetch": "^2.6.7",
"optimize-css-assets-webpack-plugin": "^5.0.4",
"postcss-easings": "^2.0.0",
"postcss-hexrgba": "2.0.1",
"postcss-import": "^12.0.1",
"postcss-loader": "^3.0.0",
"postcss-mixins": "^6.2.3",
"postcss-nested": "^4.2.3",
"postcss-preset-env": "^6.7.0",
"postcss-scss": "^2.1.1",
"postcss-simple-vars": "^5.0.2",
"raw-loader": "^4.0.2",
"rimraf": "^3.0.2",
"semver": "^7.3.7",
"shell-escape": "^0.2.0",
"simple-proxy-agent": "^1.1.0",
"string-replace-loader": "2",
"style-loader": "2",
"stylelint": "^14.9.1",
"stylelint-config-standard": "^26.0.0",
"stylelint-scss": "^4.2.0",
"terser-webpack-plugin": "^2.3.8",
"ts-prune": "^0.10.3",
"typescript": "^4.7.4",
"webpack": "^4.46.0",
"webpack-cli": "^3.3.12",
"webpack-dev-server": "^3.11.2",
"worker-loader": "^2.0.0",
"worklet-loader": "^2.0.0",
"yaml": "^2.0.1"
},
"resolutions": {
"@types/react": "17.0.14"
},
"jest": {
"testEnvironment": "jsdom",
"testEnvironmentOptions": {
"url": "http://localhost/"
}, },
"license": "Apache-2.0", "testMatch": [
"files": [ "<rootDir>/test/**/*-test.[tj]s?(x)"
"lib",
"res",
"src",
"webpack.config.js",
"scripts",
"docs",
"release.sh",
"deploy",
"CHANGELOG.md",
"CONTRIBUTING.rst",
"LICENSE",
"README.md",
"AUTHORS.rst",
"package.json",
"contribute.json"
], ],
"style": "bundle.css", "setupFilesAfterEnv": [
"matrix_i18n_extra_translation_funcs": [ "<rootDir>/node_modules/matrix-react-sdk/test/setupTests.js"
"UserFriendlyError"
], ],
"scripts": { "moduleNameMapper": {
"i18n": "matrix-gen-i18n", "\\.(css|scss|pcss)$": "<rootDir>/__mocks__/cssMock.js",
"prunei18n": "matrix-prune-i18n", "\\.(gif|png|ttf|woff2)$": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/imageMock.js",
"diff-i18n": "cp src/i18n/strings/en_EN.json src/i18n/strings/en_EN_orig.json && matrix-gen-i18n && matrix-compare-i18n-files src/i18n/strings/en_EN_orig.json src/i18n/strings/en_EN.json", "\\.svg$": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/svg.js",
"clean": "rimraf lib webapp", "\\$webapp/i18n/languages.json": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/languages.json",
"build": "yarn clean && yarn build:genfiles && yarn build:bundle", "^browser-request$": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/browser-request.js",
"build-stats": "yarn clean && yarn build:genfiles && yarn build:bundle-stats", "^react$": "<rootDir>/node_modules/react",
"build:jitsi": "ts-node scripts/build-jitsi.ts", "^react-dom$": "<rootDir>/node_modules/react-dom",
"build:res": "node scripts/copy-res.js", "^matrix-js-sdk$": "<rootDir>/node_modules/matrix-js-sdk/src",
"build:genfiles": "yarn build:res && yarn build:jitsi && yarn build:module_system", "^matrix-react-sdk$": "<rootDir>/node_modules/matrix-react-sdk/src",
"build:modernizr": "modernizr -c .modernizr.json -d src/vector/modernizr.js", "decoderWorker\\.min\\.js": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
"build:bundle": "webpack --progress --bail --mode production", "decoderWorker\\.min\\.wasm": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
"build:bundle-stats": "webpack --progress --bail --mode production --json > webpack-stats.json", "waveWorker\\.min\\.js": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
"build:module_system": "tsc --project ./tsconfig.module_system.json && node ./lib/module_system/scripts/install.js", "context-filter-polyfill": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js",
"dist": "scripts/package.sh", "FontManager.ts": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/FontManager.js",
"start": "yarn build:module_system && concurrently --kill-others-on-fail --prefix \"{time} [{name}]\" -n res,element-js \"yarn start:res\" \"yarn start:js\"", "workers/(.+)\\.worker\\.ts": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/workerMock.js",
"start:https": "concurrently --kill-others-on-fail --prefix \"{time} [{name}]\" -n res,element-js \"yarn start:res\" \"yarn start:js --https\"", "^!!raw-loader!.*": "jest-raw-loader",
"start:res": "yarn build:jitsi && node scripts/copy-res.js -w", "RecorderWorklet": "<rootDir>/node_modules/matrix-react-sdk/__mocks__/empty.js"
"start:js": "webpack-dev-server --output-filename=bundles/_dev_/[name].js --output-chunk-filename=bundles/_dev_/[name].js -w --mode development --disable-host-check --hot",
"lint": "yarn lint:types && yarn lint:js && yarn lint:style",
"lint:js": "yarn lint:js:src && yarn lint:js:module_system",
"lint:js:src": "eslint --max-warnings 0 src test && prettier --check .",
"lint:js:module_system": "eslint --max-warnings 0 --config .eslintrc-module_system.js module_system",
"lint:js-fix": "yarn lint:js-fix:src && yarn lint:js-fix:module_system",
"lint:js-fix:src": "prettier --write . && eslint --fix src test",
"lint:js-fix:module_system": "eslint --fix --config .eslintrc-module_system.js module_system",
"lint:types": "yarn lint:types:src && yarn lint:types:module_system",
"lint:types:src": "tsc --noEmit --jsx react",
"lint:types:module_system": "tsc --noEmit --project ./tsconfig.module_system.json",
"lint:style": "stylelint \"res/css/**/*.pcss\"",
"test": "jest",
"coverage": "yarn test --coverage",
"analyse:unused-exports": "ts-node ./scripts/analyse_unused_exports.ts",
"analyse:webpack-bundles": "webpack-bundle-analyzer webpack-stats.json webapp"
}, },
"resolutions": { "transformIgnorePatterns": [
"@types/react-dom": "17.0.19", "/node_modules/(?!matrix-js-sdk).+$",
"@types/react": "17.0.58" "/node_modules/(?!matrix-react-sdk).+$"
}, ],
"dependencies": { "coverageReporters": [
"@matrix-org/olm": "https://gitlab.matrix.org/api/v4/projects/27/packages/npm/@matrix-org/olm/-/@matrix-org/olm-3.2.14.tgz", "text-summary",
"@matrix-org/react-sdk-module-api": "^2.0.0", "lcov"
"gfm.css": "^1.1.2", ],
"jsrsasign": "^10.5.25", "testResultsProcessor": "jest-sonar-reporter"
"katex": "^0.16.0", },
"matrix-js-sdk": "28.0.0", "jestSonar": {
"matrix-react-sdk": "3.79.0", "reportPath": "coverage",
"matrix-widget-api": "^1.3.1", "sonar56x": true
"react": "17.0.2", }
"react-dom": "17.0.2",
"ua-parser-js": "^1.0.0"
},
"devDependencies": {
"@babel/core": "^7.12.10",
"@babel/eslint-parser": "^7.12.10",
"@babel/eslint-plugin": "^7.12.10",
"@babel/plugin-proposal-class-properties": "^7.12.1",
"@babel/plugin-proposal-export-default-from": "^7.12.1",
"@babel/plugin-proposal-logical-assignment-operators": "^7.20.7",
"@babel/plugin-proposal-nullish-coalescing-operator": "^7.12.1",
"@babel/plugin-proposal-numeric-separator": "^7.12.7",
"@babel/plugin-proposal-object-rest-spread": "^7.12.1",
"@babel/plugin-proposal-optional-chaining": "^7.12.7",
"@babel/plugin-syntax-dynamic-import": "^7.8.3",
"@babel/plugin-transform-runtime": "^7.12.10",
"@babel/preset-env": "^7.12.11",
"@babel/preset-react": "^7.12.10",
"@babel/preset-typescript": "^7.12.7",
"@babel/register": "^7.12.10",
"@babel/runtime": "^7.12.5",
"@casualbot/jest-sonar-reporter": "^2.2.5",
"@principalstudio/html-webpack-inject-preload": "^1.2.7",
"@sentry/webpack-plugin": "^2.0.0",
"@svgr/webpack": "^5.5.0",
"@testing-library/react": "^12.1.5",
"@types/jest": "^29.0.0",
"@types/jitsi-meet": "^2.0.2",
"@types/jsrsasign": "^10.5.4",
"@types/modernizr": "^3.5.3",
"@types/node": "^16",
"@types/node-fetch": "^2.6.4",
"@types/react": "17.0.58",
"@types/react-dom": "17.0.19",
"@types/ua-parser-js": "^0.7.36",
"@typescript-eslint/eslint-plugin": "^5.45.0",
"@typescript-eslint/parser": "^5.45.0",
"allchange": "^1.0.6",
"babel-jest": "^29.0.0",
"babel-loader": "^8.2.2",
"chokidar": "^3.5.1",
"concurrently": "^8.0.0",
"cpx": "^1.5.0",
"css-loader": "^4",
"dotenv": "^16.0.2",
"eslint": "8.45.0",
"eslint-config-google": "^0.14.0",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-deprecate": "^0.7.0",
"eslint-plugin-import": "^2.26.0",
"eslint-plugin-matrix-org": "^1.0.0",
"eslint-plugin-react": "^7.28.0",
"eslint-plugin-react-hooks": "^4.3.0",
"eslint-plugin-unicorn": "^48.0.0",
"extract-text-webpack-plugin": "^4.0.0-beta.0",
"fake-indexeddb": "^4.0.0",
"fetch-mock-jest": "^1.5.1",
"file-loader": "^6.0.0",
"fs-extra": "^11.0.0",
"html-webpack-plugin": "^4.5.2",
"jest": "^29.0.0",
"jest-canvas-mock": "2.5.2",
"jest-environment-jsdom": "^29.0.0",
"jest-mock": "^29.0.0",
"jest-raw-loader": "^1.0.1",
"json-loader": "^0.5.7",
"loader-utils": "^3.0.0",
"matrix-mock-request": "^2.5.0",
"matrix-web-i18n": "^2.0.0",
"mini-css-extract-plugin": "^1",
"minimist": "^1.2.6",
"mkdirp": "^3.0.0",
"modernizr": "^3.12.0",
"node-fetch": "^2.6.7",
"optimize-css-assets-webpack-plugin": "^6.0.0",
"postcss": "^8.4.16",
"postcss-easings": "^2.0.0",
"postcss-hexrgba": "2.0.1",
"postcss-import": "^12.0.1",
"postcss-loader": "^3.0.0",
"postcss-mixins": "^6.2.3",
"postcss-nested": "^4.2.3",
"postcss-preset-env": "^6.7.0",
"postcss-scss": "^4.0.4",
"postcss-simple-vars": "^5.0.2",
"prettier": "2.8.8",
"proxy-agent": "^6.3.0",
"raw-loader": "^4.0.2",
"rimraf": "^5.0.0",
"semver": "^7.5.2",
"string-replace-loader": "3",
"style-loader": "2",
"stylelint": "^15.10.1",
"stylelint-config-standard": "^34.0.0",
"stylelint-scss": "^5.0.0",
"terser-webpack-plugin": "^4.0.0",
"ts-node": "^10.9.1",
"ts-prune": "^0.10.3",
"typescript": "5.1.6",
"webpack": "^4.46.0",
"webpack-bundle-analyzer": "^4.8.0",
"webpack-cli": "^3.3.12",
"webpack-dev-server": "^3.11.2",
"worker-loader": "^3.0.0",
"worklet-loader": "^2.0.0",
"yaml": "^2.0.1"
},
"@casualbot/jest-sonar-reporter": {
"outputDirectory": "coverage",
"outputName": "jest-sonar-report.xml",
"relativePaths": true
}
} }

View File

@@ -1,9 +1,68 @@
#!/usr/bin/env bash #!/bin/bash
# #
# Script to perform a release of element-web. # Script to perform a release of element-web.
#
# Requires github-changelog-generator; to install, do
# pip install git+https://github.com/matrix-org/github-changelog-generator.git
set -e set -e
cd "$(dirname "$0")" orig_args=$@
./node_modules/matrix-js-sdk/release.sh "$@" # chomp any args starting with '-' as these need to go
# through to the release script and otherwise we'll get
# confused about what the version arg is.
while [[ "$1" == -* ]]; do
shift
done
cd `dirname $0`
for i in matrix-js-sdk matrix-react-sdk
do
echo "Checking version of $i..."
depver=`cat package.json | jq -r .dependencies[\"$i\"]`
latestver=`yarn info -s $i dist-tags.next`
if [ "$depver" != "$latestver" ]
then
echo "The latest version of $i is $latestver but package.json depends on $depver."
echo -n "Type 'u' to auto-upgrade, 'c' to continue anyway, or 'a' to abort:"
read resp
if [ "$resp" != "u" ] && [ "$resp" != "c" ]
then
echo "Aborting."
exit 1
fi
if [ "$resp" == "u" ]
then
echo "Upgrading $i to $latestver..."
yarn add -E $i@$latestver
git add -u
git commit -m "Upgrade $i to $latestver"
fi
fi
done
./node_modules/matrix-js-sdk/release.sh -n "$orig_args"
release="${1#v}"
tag="v${release}"
prerelease=0
# We check if this build is a prerelease by looking to
# see if the version has a hyphen in it. Crude,
# but semver doesn't support postreleases so anything
# with a hyphen is a prerelease.
echo $release | grep -q '-' && prerelease=1
if [ $prerelease -eq 0 ]
then
# For a release, reset SDK deps back to the `develop` branch.
for i in matrix-js-sdk matrix-react-sdk
do
echo "Resetting $i to develop branch..."
yarn add github:matrix-org/$i#develop
git add -u
git commit -m "Reset $i back to develop branch"
done
git push origin develop
fi

View File

@@ -2,5 +2,3 @@ signing_id: releases@riot.im
subprojects: subprojects:
matrix-react-sdk: matrix-react-sdk:
includeByDefault: true includeByDefault: true
matrix-js-sdk:
includeByDefault: false

View File

@@ -1,26 +0,0 @@
{
"applinks": {
"apps": [],
"details": [
{
"appIDs":[
"7J4U792NQT.im.vector.app",
"7J4U792NQT.io.element.elementx",
"7J4U792NQT.io.element.elementx.nightly",
"7J4U792NQT.io.element.elementx.pr"
],
"paths": [
"*"
]
}
]
},
"webcredentials": {
"apps": [
"7J4U792NQT.im.vector.app",
"7J4U792NQT.io.element.elementx",
"7J4U792NQT.io.element.elementx.nightly",
"7J4U792NQT.io.element.elementx.pr"
]
}
}

View File

@@ -25,14 +25,21 @@ limitations under the License.
background: linear-gradient(to bottom, #c5e0f7 0%, #ffffff 100%); background: linear-gradient(to bottom, #c5e0f7 0%, #ffffff 100%);
/* stylelint-disable-next-line function-no-unknown */ /* stylelint-disable-next-line function-no-unknown */
filter: progid:dximagetransform.microsoft.gradient(startColorstr='#c5e0f7', endColorstr='#ffffff', GradientType=0); filter: progid:dximagetransform.microsoft.gradient(startColorstr='#c5e0f7', endColorstr='#ffffff', GradientType=0);
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, font-family:
"Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; -apple-system,
color: #000; BlinkMacSystemFont,
"Segoe UI",
Roboto,
Helvetica,
Arial,
sans-serif,
"Apple Color Emoji",
"Segoe UI Emoji",
"Segoe UI Symbol";
width: 100%; width: 100%;
height: 100%; min-height: 100%;
overflow: auto; height: auto;
padding: 0 20px; color: #000;
box-sizing: border-box;
.mx_ErrorView_container { .mx_ErrorView_container {
max-width: 680px; max-width: 680px;
@@ -90,8 +97,7 @@ limitations under the License.
margin: auto 20px auto 0; margin: auto 20px auto 0;
} }
h1, h1, h2 {
h2 {
font-weight: 600; font-weight: 600;
margin-bottom: 32px; margin-bottom: 32px;
} }

View File

@@ -20,7 +20,7 @@
class Optional { class Optional {
static from(value) { static from(value) {
return (value && Some.of(value)) || None; return value && Some.of(value) || None;
} }
map(f) { map(f) {
return this; return this;

View File

@@ -10,11 +10,11 @@ async function getBundleName(baseUrl) {
throw new StartupError(`Couldn't fetch index.html to prefill bundle; ${res.status} ${res.statusText}`); throw new StartupError(`Couldn't fetch index.html to prefill bundle; ${res.status} ${res.statusText}`);
} }
const index = await res.text(); const index = await res.text();
return index return index.split("\n").map((line) =>
.split("\n") line.match(/<script src="bundles\/([^/]+)\/bundle.js"/),
.map((line) => line.match(/<script src="bundles\/([^/]+)\/bundle.js"/)) )
.filter((result) => result) .filter((result) => result)
.map((result) => result[1])[0]; .map((result) => result[1])[0];
} }
function validateBundle(value) { function validateBundle(value) {
@@ -69,7 +69,7 @@ function observeReadableStream(readableStream, pendingContext = {}) {
return; return;
} }
bytesReceived += value.length; bytesReceived += value.length;
pendingSubject.next(Pending.of({ ...pendingContext, bytesReceived })); pendingSubject.next(Pending.of({...pendingContext, bytesReceived }));
/* string concatenation is apparently the most performant way to do this */ /* string concatenation is apparently the most performant way to do this */
buffer += utf8Decoder.decode(value); buffer += utf8Decoder.decode(value);
readNextChunk(); readNextChunk();
@@ -120,27 +120,25 @@ const e = React.createElement;
* Provides user feedback given a FetchStatus object. * Provides user feedback given a FetchStatus object.
*/ */
function ProgressBar({ fetchStatus }) { function ProgressBar({ fetchStatus }) {
return e( return e('span', { className: "progress "},
"span",
{ className: "progress " },
fetchStatus.fold({ fetchStatus.fold({
pending: ({ bytesReceived, length }) => { pending: ({ bytesReceived, length }) => {
if (!bytesReceived) { if (!bytesReceived) {
return e("span", { className: "spinner" }, "\u29b5"); return e('span', { className: "spinner" }, "\u29b5");
} }
const kB = Math.floor((10 * bytesReceived) / 1024) / 10; const kB = Math.floor(10 * bytesReceived / 1024) / 10;
if (!length) { if (!length) {
return e("span", null, `Fetching (${kB}kB)`); return e('span', null, `Fetching (${kB}kB)`);
} }
const percent = Math.floor((100 * bytesReceived) / length); const percent = Math.floor(100 * bytesReceived / length);
return e("span", null, `Fetching (${kB}kB) ${percent}%`); return e('span', null, `Fetching (${kB}kB) ${percent}%`);
}, },
success: () => e("span", null, "\u2713"), success: () => e('span', null, "\u2713"),
error: (reason) => { error: (reason) => {
return e("span", { className: "error" }, `\u2717 ${reason}`); return e('span', { className: 'error'}, `\u2717 ${reason}`);
}, },
}), },
); ));
} }
/* /*
@@ -195,24 +193,23 @@ function BundlePicker() {
setColumn(value); setColumn(value);
}, []); }, []);
/* ------------------------------------------------ */ /* ------------------------------------------------ */
/* Plumb data-fetching observables through to React */ /* Plumb data-fetching observables through to React */
/* ------------------------------------------------ */ /* ------------------------------------------------ */
/* Whenever a valid bundle name is input, go see if it's a real bundle on the server */ /* Whenever a valid bundle name is input, go see if it's a real bundle on the server */
React.useEffect( React.useEffect(() =>
() => validateBundle(bundle).fold({
validateBundle(bundle).fold({ some: (value) => {
some: (value) => { const subscription = bundleSubject(baseUrl, value)
const subscription = bundleSubject(baseUrl, value) .pipe(rxjs.operators.map(Some.of))
.pipe(rxjs.operators.map(Some.of)) .subscribe(setBundleFetchStatus);
.subscribe(setBundleFetchStatus); return () => subscription.unsubscribe();
return () => subscription.unsubscribe(); },
}, none: () => setBundleFetchStatus(None),
none: () => setBundleFetchStatus(None), }),
}), [baseUrl, bundle]);
[baseUrl, bundle],
);
/* Whenever a valid javascript file is input, see if it corresponds to a sourcemap file and initiate a fetch /* Whenever a valid javascript file is input, see if it corresponds to a sourcemap file and initiate a fetch
* if so. */ * if so. */
@@ -221,18 +218,17 @@ function BundlePicker() {
setFileFetchStatus(None); setFileFetchStatus(None);
return; return;
} }
const observable = fetchAsSubject(new URL(`bundles/${bundle}/${file}.map`, baseUrl).toString()).pipe( const observable = fetchAsSubject(new URL(`bundles/${bundle}/${file}.map`, baseUrl).toString())
rxjs.operators.map((fetchStatus) => .pipe(
fetchStatus.flatMap((value) => { rxjs.operators.map((fetchStatus) => fetchStatus.flatMap(value => {
try { try {
return Success.of(JSON.parse(value)); return Success.of(JSON.parse(value));
} catch (e) { } catch (e) {
return FetchError.of(e); return FetchError.of(e);
} }
}), })),
), rxjs.operators.map(Some.of),
rxjs.operators.map(Some.of), );
);
const subscription = observable.subscribe(setFileFetchStatus); const subscription = observable.subscribe(setFileFetchStatus);
return () => subscription.unsubscribe(); return () => subscription.unsubscribe();
}, [baseUrl, bundle, file]); }, [baseUrl, bundle, file]);
@@ -260,33 +256,26 @@ function BundlePicker() {
}); });
}, [fileFetchStatus, line, column]); }, [fileFetchStatus, line, column]);
/* ------ */ /* ------ */
/* Render */ /* Render */
/* ------ */ /* ------ */
return e( return e('div', {},
"div", e('div', { className: 'inputs' },
{}, e('div', { className: 'baseUrl' },
e( e('label', { htmlFor: 'baseUrl'}, 'Base URL'),
"div", e('input', {
{ className: "inputs" }, name: 'baseUrl',
e(
"div",
{ className: "baseUrl" },
e("label", { htmlFor: "baseUrl" }, "Base URL"),
e("input", {
name: "baseUrl",
required: true, required: true,
pattern: ".+", pattern: ".+",
onChange: onBaseUrlChange, onChange: onBaseUrlChange,
value: baseUrl, value: baseUrl,
}), }),
), ),
e( e('div', { className: 'bundle' },
"div", e('label', { htmlFor: 'bundle'}, 'Bundle'),
{ className: "bundle" }, e('input', {
e("label", { htmlFor: "bundle" }, "Bundle"), name: 'bundle',
e("input", {
name: "bundle",
required: true, required: true,
pattern: "[0-9a-f]{20}", pattern: "[0-9a-f]{20}",
onChange: onBundleChange, onChange: onBundleChange,
@@ -297,12 +286,10 @@ function BundlePicker() {
none: () => null, none: () => null,
}), }),
), ),
e( e('div', { className: 'file' },
"div", e('label', { htmlFor: 'file' }, 'File'),
{ className: "file" }, e('input', {
e("label", { htmlFor: "file" }, "File"), name: 'file',
e("input", {
name: "file",
required: true, required: true,
pattern: ".+\\.js", pattern: ".+\\.js",
onChange: onFileChange, onChange: onFileChange,
@@ -313,24 +300,20 @@ function BundlePicker() {
none: () => null, none: () => null,
}), }),
), ),
e( e('div', { className: 'line' },
"div", e('label', { htmlFor: 'line' }, 'Line'),
{ className: "line" }, e('input', {
e("label", { htmlFor: "line" }, "Line"), name: 'line',
e("input", {
name: "line",
required: true, required: true,
pattern: "[0-9]+", pattern: "[0-9]+",
onChange: onLineChange, onChange: onLineChange,
value: line, value: line,
}), }),
), ),
e( e('div', { className: 'column' },
"div", e('label', { htmlFor: 'column' }, 'Column'),
{ className: "column" }, e('input', {
e("label", { htmlFor: "column" }, "Column"), name: 'column',
e("input", {
name: "column",
required: true, required: true,
pattern: "[0-9]+", pattern: "[0-9]+",
onChange: onColumnChange, onChange: onColumnChange,
@@ -338,12 +321,10 @@ function BundlePicker() {
}), }),
), ),
), ),
e( e('div', null,
"div",
null,
result.fold({ result.fold({
none: () => "Select a bundle, file and line", none: () => "Select a bundle, file and line",
some: (value) => e("pre", null, value), some: (value) => e('pre', null, value),
}), }),
), ),
); );

View File

@@ -1,11 +1,11 @@
<!DOCTYPE html> <!doctype html>
<html lang="en"> <html lang="en">
<head> <head>
<title>Rageshake decoder ring</title> <title>Rageshake decoder ring</title>
<script crossorigin src="https://unpkg.com/source-map@0.7.3/dist/source-map.js"></script> <script crossorigin src="https://unpkg.com/source-map@0.7.3/dist/source-map.js"></script>
<script> <script>
sourceMap.SourceMapConsumer.initialize({ sourceMap.SourceMapConsumer.initialize({
"lib/mappings.wasm": "https://unpkg.com/source-map@0.7.3/lib/mappings.wasm", "lib/mappings.wasm": "https://unpkg.com/source-map@0.7.3/lib/mappings.wasm"
}); });
</script> </script>
<script crossorigin src="https://unpkg.com/react@16/umd/react.production.min.js"></script> <script crossorigin src="https://unpkg.com/react@16/umd/react.production.min.js"></script>
@@ -18,16 +18,12 @@
<style> <style>
@keyframes spin { @keyframes spin {
from { from {transform:rotate(0deg);}
transform: rotate(0deg); to {transform:rotate(359deg);}
}
to {
transform: rotate(359deg);
}
} }
body { body {
font-family: sans-serif; font-family: sans-serif
} }
.spinner { .spinner {
@@ -48,7 +44,7 @@
} }
.valid::after { .valid::after {
content: "✓"; content: "✓"
} }
label { label {
@@ -72,7 +68,7 @@
<script type="text/javascript"> <script type="text/javascript">
document.addEventListener("DOMContentLoaded", () => { document.addEventListener("DOMContentLoaded", () => {
try { try {
ReactDOM.render(React.createElement(Decoder.BundlePicker), document.getElementById("main")); ReactDOM.render(React.createElement(Decoder.BundlePicker), document.getElementById("main"))
} catch (e) { } catch (e) {
const n = document.createElement("div"); const n = document.createElement("div");
n.innerText = `Error starting: ${e.message}`; n.innerText = `Error starting: ${e.message}`;

View File

@@ -1 +1 @@
self.addEventListener("fetch", () => {}); self.addEventListener('fetch', () => {});

View File

@@ -1,173 +1,175 @@
<style type="text/css"> <style type="text/css">
/* we deliberately inline style here to avoid flash-of-CSS problems, and to avoid
/* we deliberately inline style here to avoid flash-of-CSS problems, and to avoid
* voodoo where we have to set display: none by default * voodoo where we have to set display: none by default
*/ */
h1::after { h1::after {
content: "!"; content: "!";
} }
.mx_Parent { .mx_Parent {
display: -webkit-box; display: -webkit-box;
display: -webkit-flex; display: -webkit-flex;
display: -ms-flexbox; display: -ms-flexbox;
display: flex; display: flex;
-webkit-box-orient: vertical; -webkit-box-orient: vertical;
-webkit-box-direction: normal; -webkit-box-direction: normal;
-webkit-flex-direction: column; -webkit-flex-direction: column;
-ms-flex-direction: column; -ms-flex-direction: column;
flex-direction: column; flex-direction: column;
-webkit-box-pack: center; -webkit-box-pack: center;
-webkit-justify-content: center; -webkit-justify-content: center;
-ms-flex-pack: center; -ms-flex-pack: center;
justify-content: center; justify-content: center;
-webkit-box-align: center; -webkit-box-align: center;
-webkit-align-items: center; -webkit-align-items: center;
-ms-flex-align: center; -ms-flex-align: center;
align-items: center; align-items: center;
text-align: center; text-align: center;
padding: 25px 35px; padding: 25px 35px;
color: #2e2f32; color: #2e2f32;
} }
.mx_Logo { .mx_Logo {
height: 54px; height: 54px;
margin-top: 2px; margin-top: 2px;
} }
.mx_ButtonGroup { .mx_ButtonGroup {
margin-top: 10px; margin-top: 10px;
} }
.mx_ButtonRow { .mx_ButtonRow {
display: -webkit-box; display: -webkit-box;
display: -webkit-flex; display: -webkit-flex;
display: -ms-flexbox; display: -ms-flexbox;
display: flex; display: flex;
-webkit-justify-content: space-around; -webkit-justify-content: space-around;
-ms-flex-pack: distribute; -ms-flex-pack: distribute;
-webkit-box-align: center; -webkit-box-align: center;
-webkit-align-items: center; -webkit-align-items: center;
-ms-flex-align: center; -ms-flex-align: center;
align-items: center; align-items: center;
justify-content: space-between; justify-content: space-between;
box-sizing: border-box; box-sizing: border-box;
margin: 12px 0 0; margin: 12px 0 0;
} }
.mx_ButtonRow > * { .mx_ButtonRow > * {
margin: 0 10px; margin: 0 10px;
} }
.mx_ButtonRow > *:first-child { .mx_ButtonRow > *:first-child {
margin-left: 0; margin-left: 0;
} }
.mx_ButtonRow > *:last-child { .mx_ButtonRow > *:last-child {
margin-right: 0; margin-right: 0;
} }
.mx_ButtonParent { .mx_ButtonParent {
display: -webkit-box; display: -webkit-box;
display: -webkit-flex; display: -webkit-flex;
display: -ms-flexbox; display: -ms-flexbox;
display: flex; display: flex;
padding: 10px 20px; padding: 10px 20px;
-webkit-box-orient: horizontal; -webkit-box-orient: horizontal;
-webkit-box-direction: normal; -webkit-box-direction: normal;
-webkit-flex-direction: row; -webkit-flex-direction: row;
-ms-flex-direction: row; -ms-flex-direction: row;
flex-direction: row; flex-direction: row;
-webkit-box-pack: center; -webkit-box-pack: center;
-webkit-justify-content: center; -webkit-justify-content: center;
-ms-flex-pack: center; -ms-flex-pack: center;
justify-content: center; justify-content: center;
-webkit-box-align: center; -webkit-box-align: center;
-webkit-align-items: center; -webkit-align-items: center;
-ms-flex-align: center; -ms-flex-align: center;
align-items: center; align-items: center;
border-radius: 4px; border-radius: 4px;
width: 150px; width: 150px;
background-repeat: no-repeat; background-repeat: no-repeat;
background-position: 10px center; background-position: 10px center;
text-decoration: none; text-decoration: none;
color: #2e2f32 !important; color: #2e2f32 !important;
} }
.mx_ButtonLabel { .mx_ButtonLabel {
margin-left: 20px; margin-left: 20px;
} }
.mx_Header_title { .mx_Header_title {
font-size: 24px; font-size: 24px;
font-weight: 600; font-weight: 600;
margin: 20px 0 0; margin: 20px 0 0;
} }
.mx_Header_subtitle { .mx_Header_subtitle {
font-size: 12px; font-size: 12px;
font-weight: normal; font-weight: normal;
margin: 8px 0 0; margin: 8px 0 0;
} }
.mx_ButtonSignIn { .mx_ButtonSignIn {
background-color: #368bd6; background-color: #368BD6;
color: white !important; color: white !important;
} }
.mx_ButtonCreateAccount { .mx_ButtonCreateAccount {
background-color: #0dbd8b; background-color: #0DBD8B;
color: white !important; color: white !important;
} }
.mx_SecondaryButton { .mx_SecondaryButton {
background-color: #ffffff; background-color: #FFFFFF;
color: #2e2f32; color: #2E2F32;
} }
.mx_Button_iconSignIn { .mx_Button_iconSignIn {
background-image: url("welcome/images/icon-sign-in.svg"); background-image: url('welcome/images/icon-sign-in.svg');
} }
.mx_Button_iconCreateAccount { .mx_Button_iconCreateAccount {
background-image: url("welcome/images/icon-create-account.svg"); background-image: url('welcome/images/icon-create-account.svg');
} }
.mx_Button_iconHelp { .mx_Button_iconHelp {
background-image: url("welcome/images/icon-help.svg"); background-image: url('welcome/images/icon-help.svg');
} }
.mx_Button_iconRoomDirectory { .mx_Button_iconRoomDirectory {
background-image: url("welcome/images/icon-room-directory.svg"); background-image: url('welcome/images/icon-room-directory.svg');
} }
/* /*
.mx_WelcomePage_loggedIn is applied by EmbeddedPage from the Welcome component .mx_WelcomePage_loggedIn is applied by EmbeddedPage from the Welcome component
If it is set on the page, we should show the buttons. Otherwise, we have to assume If it is set on the page, we should show the buttons. Otherwise, we have to assume
we don't have an account and should hide them. No account == no guest account either. we don't have an account and should hide them. No account == no guest account either.
*/ */
.mx_WelcomePage:not(.mx_WelcomePage_loggedIn) .mx_WelcomePage_guestFunctions { .mx_WelcomePage:not(.mx_WelcomePage_loggedIn) .mx_WelcomePage_guestFunctions {
display: none; display: none;
}
.mx_ButtonRow.mx_WelcomePage_guestFunctions {
margin-top: 20px;
}
.mx_ButtonRow.mx_WelcomePage_guestFunctions > div {
margin: 0 auto;
}
@media only screen and (max-width: 480px) {
.mx_ButtonRow {
flex-direction: column;
} }
.mx_ButtonRow.mx_WelcomePage_guestFunctions { .mx_ButtonRow > * {
margin-top: 20px; margin: 0 0 10px 0;
}
.mx_ButtonRow.mx_WelcomePage_guestFunctions > div {
margin: 0 auto;
} }
}
@media only screen and (max-width: 480px) {
.mx_ButtonRow {
flex-direction: column;
}
.mx_ButtonRow > * {
margin: 0 0 10px 0;
}
}
</style> </style>
<div class="mx_Parent"> <div class="mx_Parent">
<a href="https://element.io" target="_blank" rel="noopener"> <a href="https://element.io" target="_blank" rel="noopener">
<img src="$logoUrl" alt="" class="mx_Logo" /> <img src="welcome/images/logo.svg" alt="" class="mx_Logo"/>
</a> </a>
<h1 class="mx_Header_title">_t("Welcome to Element")</h1> <h1 class="mx_Header_title">_t("Welcome to Element")</h1>
<!-- XXX: Our translations system isn't smart enough to recognize variables in the HTML, so we manually do it --> <!-- XXX: Our translations system isn't smart enough to recognize variables in the HTML, so we manually do it -->
@@ -181,6 +183,11 @@ we don't have an account and should hide them. No account == no guest account ei
<div class="mx_ButtonLabel">_t("Create Account")</div> <div class="mx_ButtonLabel">_t("Create Account")</div>
</a> </a>
</div> </div>
<!-- The comments below are meant to be used by Ansible as a quick way
to strip out the marked content when desired.
See https://github.com/vector-im/element-web/issues/8622.
TODO: Strip out these comments and rely on the guest flag -->
<!-- BEGIN Ansible: Remove these lines when guest access is disabled -->
<div class="mx_ButtonRow mx_WelcomePage_guestFunctions"> <div class="mx_ButtonRow mx_WelcomePage_guestFunctions">
<div> <div>
<a href="#/directory" class="mx_ButtonParent mx_SecondaryButton mx_Button_iconRoomDirectory"> <a href="#/directory" class="mx_ButtonParent mx_SecondaryButton mx_Button_iconRoomDirectory">
@@ -188,5 +195,6 @@ we don't have an account and should hide them. No account == no guest account ei
</a> </a>
</div> </div>
</div> </div>
<!-- END Ansible: Remove these lines when guest access is disabled -->
</div> </div>
</div> </div>

View File

@@ -0,0 +1,7 @@
<svg width="200" height="200" viewBox="0 0 200 200" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M100 200C155.228 200 200 155.228 200 100C200 44.7715 155.228 0 100 0C44.7715 0 0 44.7715 0 100C0 155.228 44.7715 200 100 200Z" fill="#0DBD8B"/>
<path fill-rule="evenodd" clip-rule="evenodd" d="M81.7169 46.5946C81.7169 42.5581 84.9959 39.2859 89.0408 39.2859C116.456 39.2859 138.681 61.4642 138.681 88.8225C138.681 92.859 135.401 96.1312 131.357 96.1312C127.312 96.1312 124.033 92.859 124.033 88.8225C124.033 69.5372 108.366 53.9033 89.0408 53.9033C84.9959 53.9033 81.7169 50.6311 81.7169 46.5946Z" fill="white"/>
<path fill-rule="evenodd" clip-rule="evenodd" d="M153.39 81.5137C157.435 81.5137 160.714 84.7859 160.714 88.8224C160.714 116.181 138.49 138.359 111.075 138.359C107.03 138.359 103.751 135.087 103.751 131.05C103.751 127.014 107.03 123.742 111.075 123.742C130.4 123.742 146.066 108.108 146.066 88.8224C146.066 84.7859 149.345 81.5137 153.39 81.5137Z" fill="white"/>
<path fill-rule="evenodd" clip-rule="evenodd" d="M118.398 153.405C118.398 157.442 115.119 160.714 111.074 160.714C83.6592 160.714 61.4347 138.536 61.4347 111.177C61.4347 107.141 64.7138 103.869 68.7587 103.869C72.8035 103.869 76.0826 107.141 76.0826 111.177C76.0826 130.463 91.7489 146.097 111.074 146.097C115.119 146.097 118.398 149.369 118.398 153.405Z" fill="white"/>
<path fill-rule="evenodd" clip-rule="evenodd" d="M46.6097 118.486C42.5648 118.486 39.2858 115.214 39.2858 111.178C39.2858 83.8193 61.5102 61.6409 88.9255 61.6409C92.9704 61.6409 96.2494 64.9132 96.2494 68.9497C96.2494 72.9862 92.9704 76.2584 88.9255 76.2584C69.6 76.2584 53.9337 91.8922 53.9337 111.178C53.9337 115.214 50.6546 118.486 46.6097 118.486Z" fill="white"/>
</svg>

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

@@ -1,12 +1,13 @@
#!/usr/bin/env node #!/usr/bin/env node
'use strict';
import * as fs from "node:fs"; const fs = require("fs");
import { exec } from "node:child_process"; const { exec } = require("node:child_process");
const includeJSSDK = process.argv.includes("--include-js-sdk"); const includeJSSDK = process.argv.includes("--include-js-sdk");
const ignore: string[] = []; const ignore = [];
ignore.push(...Object.values<string>(JSON.parse(fs.readFileSync(`${__dirname}/../components.json`, "utf-8")))); ignore.push(...Object.values(JSON.parse(fs.readFileSync(`${__dirname}/../components.json`))));
ignore.push("/index.ts"); ignore.push("/index.ts");
// We ignore js-sdk by default as it may export for other non element-web projects // We ignore js-sdk by default as it may export for other non element-web projects
if (!includeJSSDK) ignore.push("matrix-js-sdk"); if (!includeJSSDK) ignore.push("matrix-js-sdk");
@@ -30,7 +31,7 @@ exec(command, (error, stdout, stderr) => {
// won't have an "/" character at the start, so we try to fix that for // won't have an "/" character at the start, so we try to fix that for
// better UX // better UX
// TODO: This might break on Windows // TODO: This might break on Windows
lines = lines.reduce<string[]>((newLines, line) => { lines = lines.reduce((newLines, line) => {
if (!line.startsWith("/")) newLines.push("/" + line); if (!line.startsWith("/")) newLines.push("/" + line);
else newLines.push(line); else newLines.push(line);
return newLines; return newLines;

31
scripts/build-jitsi.js Normal file
View File

@@ -0,0 +1,31 @@
// This is a JS script so that the directory is created in-process on Windows.
// If the script isn't run in-process, there's a risk of it racing or never running
// due to file associations in Windows.
// Sorry.
const fs = require("fs");
const path = require("path");
const mkdirp = require("mkdirp");
const fetch = require("node-fetch");
const ProxyAgent = require("simple-proxy-agent");
console.log("Making webapp directory");
mkdirp.sync("webapp");
// curl -s https://meet.element.io/libs/external_api.min.js > ./webapp/jitsi_external_api.min.js
console.log("Downloading Jitsi script");
const fname = path.join("webapp", "jitsi_external_api.min.js");
const options = {};
if (process.env.HTTPS_PROXY) {
options.agent = new ProxyAgent(process.env.HTTPS_PROXY, { tunnel: true });
}
fetch("https://meet.element.io/libs/external_api.min.js", options).then(res => {
const stream = fs.createWriteStream(fname);
return new Promise((resolve, reject) => {
res.body.pipe(stream);
res.body.on('error', err => reject(err));
res.body.on('finish', () => resolve());
});
}).then(() => console.log('Done with Jitsi download'));

View File

@@ -1,30 +0,0 @@
// This is a JS script so that the directory is created in-process on Windows.
// If the script isn't run in-process, there's a risk of it racing or never running
// due to file associations in Windows.
// Sorry.
import * as fs from "node:fs";
import * as path from "node:path";
import { mkdirpSync } from "mkdirp";
import fetch from "node-fetch";
import { ProxyAgent } from "proxy-agent";
console.log("Making webapp directory");
mkdirpSync("webapp");
// curl -s https://meet.element.io/libs/external_api.min.js > ./webapp/jitsi_external_api.min.js
console.log("Downloading Jitsi script");
const fname = path.join("webapp", "jitsi_external_api.min.js");
fetch("https://meet.element.io/libs/external_api.min.js", {
agent: new ProxyAgent(),
})
.then((res) => {
const stream = fs.createWriteStream(fname);
return new Promise<void>((resolve, reject) => {
res.body.pipe(stream);
res.body.on("error", (err) => reject(err));
res.body.on("finish", () => resolve());
});
})
.then(() => console.log("Done with Jitsi download"));

1
scripts/check-i18n.pl Symbolic link
View File

@@ -0,0 +1 @@
../../matrix-react-sdk/scripts/check-i18n.pl

View File

@@ -1,4 +1,4 @@
#!/usr/bin/env bash #!/bin/bash
# Runs package.sh, passing DIST_VERSION determined by git # Runs package.sh, passing DIST_VERSION determined by git

View File

@@ -11,59 +11,58 @@ const loaderUtils = require("loader-utils");
// This could readily be automated, but it's nice to explicitly // This could readily be automated, but it's nice to explicitly
// control when new languages are available. // control when new languages are available.
const INCLUDE_LANGS = [ const INCLUDE_LANGS = [
{ value: "bg", label: "Български" }, {'value': 'bg', 'label': 'Български'},
{ value: "ca", label: "Català" }, {'value': 'ca', 'label': 'Català'},
{ value: "cs", label: "čeština" }, {'value': 'cs', 'label': 'čeština'},
{ value: "da", label: "Dansk" }, {'value': 'da', 'label': 'Dansk'},
{ value: "de_DE", label: "Deutsch" }, {'value': 'de_DE', 'label': 'Deutsch'},
{ value: "el", label: "Ελληνικά" }, {'value': 'el', 'label': 'Ελληνικά'},
{ value: "en_EN", label: "English" }, {'value': 'en_EN', 'label': 'English'},
{ value: "en_US", label: "English (US)" }, {'value': 'en_US', 'label': 'English (US)'},
{ value: "eo", label: "Esperanto" }, {'value': 'eo', 'label': 'Esperanto'},
{ value: "es", label: "Español" }, {'value': 'es', 'label': 'Español'},
{ value: "et", label: "Eesti" }, {'value': 'et', 'label': 'Eesti'},
{ value: "eu", label: "Euskara" }, {'value': 'eu', 'label': 'Euskara'},
{ value: "fi", label: "Suomi" }, {'value': 'fi', 'label': 'Suomi'},
{ value: "fr", label: "Français" }, {'value': 'fr', 'label': 'Français'},
{ value: "gl", label: "Galego" }, {'value': 'gl', 'label': 'Galego'},
{ value: "he", label: "עברית" }, {'value': 'he', 'label': 'עברית'},
{ value: "hi", label: "हिन्दी" }, {'value': 'hi', 'label': 'हिन्दी'},
{ value: "hu", label: "Magyar" }, {'value': 'hu', 'label': 'Magyar'},
{ value: "id", label: "Bahasa Indonesia" }, {'value': 'id', 'label': 'Bahasa Indonesia'},
{ value: "is", label: "íslenska" }, {'value': 'is', 'label': 'íslenska'},
{ value: "it", label: "Italiano" }, {'value': 'it', 'label': 'Italiano'},
{ value: "ja", label: "日本語" }, {'value': 'ja', 'label': '日本語'},
{ value: "kab", label: "Taqbaylit" }, {'value': 'kab', 'label': 'Taqbaylit'},
{ value: "ko", label: "한국어" }, {'value': 'ko', 'label': '한국어'},
{ value: "lo", label: "ລາວ" }, {'value': 'lo', 'label': 'ລາວ'},
{ value: "lt", label: "Lietuvių" }, {'value': 'lt', 'label': 'Lietuvių'},
{ value: "lv", label: "Latviešu" }, {'value': 'lv', 'label': 'Latviešu'},
{ value: "nb_NO", label: "Norwegian Bokmål" }, {'value': 'nb_NO', 'label': 'Norwegian Bokmål'},
{ value: "nl", label: "Nederlands" }, {'value': 'nl', 'label': 'Nederlands'},
{ value: "nn", label: "Norsk Nynorsk" }, {'value': 'nn', 'label': 'Norsk Nynorsk'},
{ value: "pl", label: "Polski" }, {'value': 'pl', 'label': 'Polski'},
{ value: "pt", label: "Português" }, {'value': 'pt', 'label': 'Português'},
{ value: "pt_BR", label: "Português do Brasil" }, {'value': 'pt_BR', 'label': 'Português do Brasil'},
{ value: "ru", label: "Русский" }, {'value': 'ru', 'label': 'Русский'},
{ value: "sk", label: "Slovenčina" }, {'value': 'sk', 'label': 'Slovenčina'},
{ value: "sq", label: "Shqip" }, {'value': 'sq', 'label': 'Shqip'},
{ value: "sr", label: "српски" }, {'value': 'sr', 'label': 'српски'},
{ value: "sv", label: "Svenska" }, {'value': 'sv', 'label': 'Svenska'},
{ value: "te", label: "తెలుగు" }, {'value': 'te', 'label': 'తెలుగు'},
{ value: "th", label: "ไทย" }, {'value': 'th', 'label': 'ไทย'},
{ value: "tr", label: "Türkçe" }, {'value': 'tr', 'label': 'Türkçe'},
{ value: "uk", label: "українська мова" }, {'value': 'uk', 'label': 'українська мова'},
{ value: "vi", label: "Tiếng Việt" }, {'value': 'vi', 'label': 'Tiếng Việt'},
{ value: "vls", label: "West-Vlaams" }, {'value': 'vls', 'label': 'West-Vlaams'},
{ value: "zh_Hans", label: "简体中文" }, // simplified chinese {'value': 'zh_Hans', 'label': '简体中文'}, // simplified chinese
{ value: "zh_Hant", label: "繁體中文" }, // traditional chinese {'value': 'zh_Hant', 'label': '繁體中文'}, // traditional chinese
]; ];
// cpx includes globbed parts of the filename in the destination, but excludes // cpx includes globbed parts of the filename in the destination, but excludes
// common parents. Hence, "res/{a,b}/**": the output will be "dest/a/..." and // common parents. Hence, "res/{a,b}/**": the output will be "dest/a/..." and
// "dest/b/...". // "dest/b/...".
const COPY_LIST = [ const COPY_LIST = [
["res/apple-app-site-association", "webapp"],
["res/manifest.json", "webapp"], ["res/manifest.json", "webapp"],
["res/sw.js", "webapp"], ["res/sw.js", "webapp"],
["res/welcome.html", "webapp"], ["res/welcome.html", "webapp"],
@@ -77,12 +76,15 @@ const COPY_LIST = [
["contribute.json", "webapp"], ["contribute.json", "webapp"],
]; ];
const parseArgs = require("minimist"); const parseArgs = require('minimist');
const Cpx = require("cpx"); const Cpx = require('cpx');
const chokidar = require("chokidar"); const chokidar = require('chokidar');
const fs = require("fs"); const fs = require('fs');
const rimraf = require('rimraf');
const argv = parseArgs(process.argv.slice(2), {}); const argv = parseArgs(
process.argv.slice(2), {}
);
const watch = argv.w; const watch = argv.w;
const verbose = argv.v; const verbose = argv.v;
@@ -95,12 +97,12 @@ function errCheck(err) {
} }
// Check if webapp exists // Check if webapp exists
if (!fs.existsSync("webapp")) { if (!fs.existsSync('webapp')) {
fs.mkdirSync("webapp"); fs.mkdirSync('webapp');
} }
// Check if i18n exists // Check if i18n exists
if (!fs.existsSync("webapp/i18n/")) { if (!fs.existsSync('webapp/i18n/')) {
fs.mkdirSync("webapp/i18n/"); fs.mkdirSync('webapp/i18n/');
} }
function next(i, err) { function next(i, err) {
@@ -129,9 +131,7 @@ function next(i, err) {
}); });
} }
const cb = (err) => { const cb = (err) => { next(i + 1, err) };
next(i + 1, err);
};
if (watch) { if (watch) {
if (opts.directwatch) { if (opts.directwatch) {
@@ -139,12 +139,14 @@ function next(i, err) {
// which in the case of config.json is '.', which inevitably takes // which in the case of config.json is '.', which inevitably takes
// ages to crawl. So we create our own watcher on the files // ages to crawl. So we create our own watcher on the files
// instead. // instead.
const copy = () => { const copy = () => { cpx.copy(errCheck) };
cpx.copy(errCheck); chokidar.watch(source)
}; .on('add', copy)
chokidar.watch(source).on("add", copy).on("change", copy).on("ready", cb).on("error", errCheck); .on('change', copy)
.on('ready', cb)
.on('error', errCheck);
} else { } else {
cpx.on("watch-ready", cb); cpx.on('watch-ready', cb);
cpx.on("watch-error", cb); cpx.on("watch-error", cb);
cpx.watch(); cpx.watch();
} }
@@ -154,14 +156,17 @@ function next(i, err) {
} }
function genLangFile(lang, dest) { function genLangFile(lang, dest) {
const reactSdkFile = "node_modules/matrix-react-sdk/src/i18n/strings/" + lang + ".json"; const reactSdkFile = 'node_modules/matrix-react-sdk/src/i18n/strings/' + lang + '.json';
const riotWebFile = "src/i18n/strings/" + lang + ".json"; const riotWebFile = 'src/i18n/strings/' + lang + '.json';
const translations = {}; let translations = {};
[reactSdkFile, riotWebFile].forEach(function (f) { [reactSdkFile, riotWebFile].forEach(function(f) {
if (fs.existsSync(f)) { if (fs.existsSync(f)) {
try { try {
Object.assign(translations, JSON.parse(fs.readFileSync(f).toString())); Object.assign(
translations,
JSON.parse(fs.readFileSync(f).toString())
);
} catch (e) { } catch (e) {
console.error("Failed: " + f, e); console.error("Failed: " + f, e);
throw e; throw e;
@@ -169,6 +174,8 @@ function genLangFile(lang, dest) {
} }
}); });
translations = weblateToCounterpart(translations);
const json = JSON.stringify(translations, null, 4); const json = JSON.stringify(translations, null, 4);
const jsonBuffer = Buffer.from(json); const jsonBuffer = Buffer.from(json);
const digest = loaderUtils.getHashDigest(jsonBuffer, null, null, 7); const digest = loaderUtils.getHashDigest(jsonBuffer, null, null, 7);
@@ -184,16 +191,16 @@ function genLangFile(lang, dest) {
function genLangList(langFileMap) { function genLangList(langFileMap) {
const languages = {}; const languages = {};
INCLUDE_LANGS.forEach(function (lang) { INCLUDE_LANGS.forEach(function(lang) {
const normalizedLanguage = lang.value.toLowerCase().replace("_", "-"); const normalizedLanguage = lang.value.toLowerCase().replace("_", "-");
const languageParts = normalizedLanguage.split("-"); const languageParts = normalizedLanguage.split('-');
if (languageParts.length == 2 && languageParts[0] == languageParts[1]) { if (languageParts.length == 2 && languageParts[0] == languageParts[1]) {
languages[languageParts[0]] = { fileName: langFileMap[lang.value], label: lang.label }; languages[languageParts[0]] = {'fileName': langFileMap[lang.value], 'label': lang.label};
} else { } else {
languages[normalizedLanguage] = { fileName: langFileMap[lang.value], label: lang.label }; languages[normalizedLanguage] = {'fileName': langFileMap[lang.value], 'label': lang.label};
} }
}); });
fs.writeFile("webapp/i18n/languages.json", JSON.stringify(languages, null, 4), function (err) { fs.writeFile('webapp/i18n/languages.json', JSON.stringify(languages, null, 4), function(err) {
if (err) { if (err) {
console.error("Copy Error occured: " + err); console.error("Copy Error occured: " + err);
throw new Error("Failed to generate languages.json"); throw new Error("Failed to generate languages.json");
@@ -204,14 +211,54 @@ function genLangList(langFileMap) {
} }
} }
/**
* Convert translation key from weblate format
* (which only supports a single level) to counterpart
* which requires object values for 'count' translations.
*
* eg.
* "there are %(count)s badgers|one": "a badger",
* "there are %(count)s badgers|other": "%(count)s badgers"
* becomes
* "there are %(count)s badgers": {
* "one": "a badger",
* "other": "%(count)s badgers"
* }
*/
function weblateToCounterpart(inTrs) {
const outTrs = {};
for (const key of Object.keys(inTrs)) {
const keyParts = key.split('|', 2);
if (keyParts.length === 2) {
let obj = outTrs[keyParts[0]];
if (obj === undefined) {
obj = outTrs[keyParts[0]] = {};
} else if (typeof obj === "string") {
// This is a transitional edge case if a string went from singular to pluralised and both still remain
// in the translation json file. Use the singular translation as `other` and merge pluralisation atop.
obj = outTrs[keyParts[0]] = {
"other": inTrs[key],
};
console.warn("Found entry in i18n file in both singular and pluralised form", keyParts[0]);
}
obj[keyParts[1]] = inTrs[key];
} else {
outTrs[key] = inTrs[key];
}
}
return outTrs;
}
/** /**
watch the input files for a given language, watch the input files for a given language,
regenerate the file, adding its content-hashed filename to langFileMap regenerate the file, adding its content-hashed filename to langFileMap
and regenerating languages.json with the new filename and regenerating languages.json with the new filename
*/ */
function watchLanguage(lang, dest, langFileMap) { function watchLanguage(lang, dest, langFileMap) {
const reactSdkFile = "node_modules/matrix-react-sdk/src/i18n/strings/" + lang + ".json"; const reactSdkFile = 'node_modules/matrix-react-sdk/src/i18n/strings/' + lang + '.json';
const riotWebFile = "src/i18n/strings/" + lang + ".json"; const riotWebFile = 'src/i18n/strings/' + lang + '.json';
// XXX: Use a debounce because for some reason if we read the language // XXX: Use a debounce because for some reason if we read the language
// file immediately after the FS event is received, the file contents // file immediately after the FS event is received, the file contents
@@ -223,13 +270,16 @@ function watchLanguage(lang, dest, langFileMap) {
} }
makeLangDebouncer = setTimeout(() => { makeLangDebouncer = setTimeout(() => {
const filename = genLangFile(lang, dest); const filename = genLangFile(lang, dest);
langFileMap[lang] = filename; langFileMap[lang]=filename;
genLangList(langFileMap); genLangList(langFileMap);
}, 500); }, 500);
}; };
[reactSdkFile, riotWebFile].forEach(function (f) { [reactSdkFile, riotWebFile].forEach(function(f) {
chokidar.watch(f).on("add", makeLang).on("change", makeLang).on("error", errCheck); chokidar.watch(f)
.on('add', makeLang)
.on('change', makeLang)
.on('error', errCheck);
}); });
} }
@@ -243,7 +293,7 @@ const I18N_FILENAME_MAP = INCLUDE_LANGS.reduce((m, l) => {
genLangList(I18N_FILENAME_MAP); genLangList(I18N_FILENAME_MAP);
if (watch) { if (watch) {
INCLUDE_LANGS.forEach((l) => watchLanguage(l.value, I18N_DEST, I18N_FILENAME_MAP)); INCLUDE_LANGS.forEach(l => watchLanguage(l.value, I18N_DEST, I18N_FILENAME_MAP));
} }
// non-language resources // non-language resources

View File

@@ -98,24 +98,7 @@ class Deployer:
try: try:
with tarfile.open(tarball) as tar: with tarfile.open(tarball) as tar:
def is_within_directory(directory, target): tar.extractall(extract_path)
abs_directory = os.path.abspath(directory)
abs_target = os.path.abspath(target)
prefix = os.path.commonprefix([abs_directory, abs_target])
return prefix == abs_directory
def safe_extract(tar, path=".", members=None, *, numeric_owner=False):
for member in tar.getmembers():
member_path = os.path.join(path, member.name)
if not is_within_directory(path, member_path):
raise Exception("Attempted Path Traversal in Tar File")
tar.extractall(path, members, numeric_owner=numeric_owner)
safe_extract(tar, extract_path)
finally: finally:
if self.should_clean and downloaded: if self.should_clean and downloaded:
os.remove(tarball) os.remove(tarball)

View File

@@ -1,4 +1,4 @@
#!/usr/bin/env bash #!/bin/bash
set -ex set -ex

View File

@@ -1,4 +1,4 @@
#!/usr/bin/env bash #!/bin/bash
set -ex set -ex
@@ -7,10 +7,8 @@ DIST_VERSION=$(git describe --abbrev=0 --tags)
DIR=$(dirname "$0") DIR=$(dirname "$0")
# If the branch comes out as HEAD then we're probably checked out to a tag, so if the thing is *not* # If we're not using custom SDKs and on a branch other than master, generate a version akin go develop.element.io
# coming out as HEAD then we're on a branch. When we're on a branch, we want to resolve ourselves to if [[ $USE_CUSTOM_SDKS == false ]] && [[ $BRANCH != 'master' ]]
# a few SHAs rather than a version.
if [[ $BRANCH != HEAD && ! $BRANCH =~ heads/v.+ ]]
then then
DIST_VERSION=$("$DIR"/get-version-from-git.sh) DIST_VERSION=$("$DIR"/get-version-from-git.sh)
fi fi

View File

@@ -1,4 +1,4 @@
#!/usr/bin/env bash #!/bin/bash
# Fetches the js-sdk and matrix-react-sdk dependencies for development # Fetches the js-sdk and matrix-react-sdk dependencies for development
# or testing purposes # or testing purposes
@@ -6,7 +6,7 @@
# the branch the current checkout is on, use that branch. Otherwise, # the branch the current checkout is on, use that branch. Otherwise,
# use develop. # use develop.
set -x set -ex
GIT_CLONE_ARGS=("$@") GIT_CLONE_ARGS=("$@")
[ -z "$defbranch" ] && defbranch="develop" [ -z "$defbranch" ] && defbranch="develop"
@@ -77,7 +77,7 @@ dodep matrix-org matrix-js-sdk
pushd matrix-js-sdk pushd matrix-js-sdk
yarn link yarn link
yarn install --frozen-lockfile yarn install --pure-lockfile
popd popd
yarn link matrix-js-sdk yarn link matrix-js-sdk
@@ -91,7 +91,7 @@ dodep matrix-org matrix-react-sdk
pushd matrix-react-sdk pushd matrix-react-sdk
yarn link yarn link
yarn link matrix-js-sdk yarn link matrix-js-sdk
yarn install --frozen-lockfile yarn install --pure-lockfile
popd popd
yarn link matrix-react-sdk yarn link matrix-react-sdk

View File

@@ -25,8 +25,6 @@
# all phonenumber.js-supported country flags (as SVGs) into # all phonenumber.js-supported country flags (as SVGs) into
# PNGs that can be used by CountryDropdown.js. # PNGs that can be used by CountryDropdown.js.
set -e
# Allow CTRL+C to terminate the script # Allow CTRL+C to terminate the script
trap "echo Exited!; exit;" SIGINT SIGTERM trap "echo Exited!; exit;" SIGINT SIGTERM

View File

@@ -1,10 +1,8 @@
#!/usr/bin/env bash #!/bin/bash
# Echoes a version based on the git hashes of the element-web, react-sdk & js-sdk checkouts, for the case where # Echoes a version based on the git hashes of the element-web, react-sdk & js-sdk checkouts, for the case where
# these dependencies are git checkouts. # these dependencies are git checkouts.
set -e
# Since the deps are fetched from git, we can rev-parse # Since the deps are fetched from git, we can rev-parse
REACT_SHA=$(git -C node_modules/matrix-react-sdk rev-parse --short=12 HEAD) REACT_SHA=$(git -C node_modules/matrix-react-sdk rev-parse --short=12 HEAD)
JSSDK_SHA=$(git -C node_modules/matrix-js-sdk rev-parse --short=12 HEAD) JSSDK_SHA=$(git -C node_modules/matrix-js-sdk rev-parse --short=12 HEAD)

View File

@@ -1,6 +1,6 @@
#!/usr/bin/env bash #!/bin/bash
set -ex set -x
# Creates a layered environment with the full repo for the app and SDKs cloned # Creates a layered environment with the full repo for the app and SDKs cloned
# and linked. This gives an element-web dev environment ready to build with # and linked. This gives an element-web dev environment ready to build with
@@ -14,38 +14,35 @@ set -ex
# for the primary repo (element-web in this case). # for the primary repo (element-web in this case).
# Install dependencies, as we'll be using fetchdep.sh from matrix-react-sdk # Install dependencies, as we'll be using fetchdep.sh from matrix-react-sdk
yarn install --frozen-lockfile yarn install --pure-lockfile
# Pass appropriate repo to fetchdep.sh # Pass appropriate repo to fetchdep.sh
export PR_ORG=vector-im export PR_ORG=vector-im
export PR_REPO=element-web export PR_REPO=element-web
# Set up the js-sdk first # Set up the js-sdk first
node_modules/matrix-react-sdk/scripts/fetchdep.sh matrix-org matrix-js-sdk develop node_modules/matrix-react-sdk/scripts/fetchdep.sh matrix-org matrix-js-sdk
pushd matrix-js-sdk pushd matrix-js-sdk
yarn link yarn link
yarn install --frozen-lockfile yarn install --pure-lockfile
popd popd
# Also set up matrix-analytics-events for branch with matching name # Also set up matrix-analytics-events so we get the latest from
node_modules/matrix-react-sdk/scripts/fetchdep.sh matrix-org matrix-analytics-events # the main branch or a branch with matching name
# We don't pass a default branch so cloning may fail when we are not in a PR node_modules/matrix-react-sdk/scripts/fetchdep.sh matrix-org matrix-analytics-events main
# This is expected as this project does not share a release cycle but we still branch match it pushd matrix-analytics-events
if [ -d matrix-analytics-events ]; then yarn link
pushd matrix-analytics-events yarn install --pure-lockfile
yarn link yarn build:ts
yarn install --frozen-lockfile popd
yarn build:ts
popd
fi
# Now set up the react-sdk # Now set up the react-sdk
node_modules/matrix-react-sdk/scripts/fetchdep.sh matrix-org matrix-react-sdk develop node_modules/matrix-react-sdk/scripts/fetchdep.sh matrix-org matrix-react-sdk
pushd matrix-react-sdk pushd matrix-react-sdk
yarn link yarn link
yarn link matrix-js-sdk yarn link matrix-js-sdk
[ -d matrix-analytics-events ] && yarn link @matrix-org/analytics-events yarn link @matrix-org/analytics-events
yarn install --frozen-lockfile yarn install --pure-lockfile
popd popd
# Link the layers into element-web # Link the layers into element-web

117
scripts/make-icons.sh Executable file
View File

@@ -0,0 +1,117 @@
#!/bin/bash
#
# Converts an svg logo into the various image resources required by
# the various platforms deployments.
#
# On debian-based systems you need these deps:
# apt-get install xmlstarlet python3-cairosvg icnsutils
if [ $# != 1 ]
then
echo "Usage: $0 <svg file>"
exit
fi
set -e
set -x
tmpdir=`mktemp -d 2>/dev/null || mktemp -d -t 'icontmp'`
for i in 1024 512 310 256 192 180 152 150 144 128 120 114 96 76 72 70 64 60 57 48 36 32 24 16
do
#convert -background none -density 1000 -resize $i -extent $i -gravity center "$1" "$tmpdir/$i.png"
# Above is the imagemagick command to render an svg to png. Unfortunately, its support for SVGs
# with CSS isn't very good (with rsvg and even moreso the built in renderer) so we use cairosvg.
# This can be installed with:
# pip install cairosvg==1.0.22 # Version 2 doesn't support python 2
# pip install tinycss
# pip install cssselect # These are necessary for CSS support
# You'll also need xmlstarlet from your favourite package manager
#
# Cairosvg doesn't suport rendering at a specific size (https://github.com/Kozea/CairoSVG/issues/83#issuecomment-215720176)
# so we have to 'resize the svg' first (add width and height attributes to the svg element) to make it render at the
# size we need.
# XXX: This will break if the svg already has width and height attributes
cp "$1" "$tmpdir/tmp.svg"
xmlstarlet ed -N x="http://www.w3.org/2000/svg" --insert "/x:svg" --type attr -n width -v $i "$tmpdir/tmp.svg" > "$tmpdir/tmp2.svg"
xmlstarlet ed -N x="http://www.w3.org/2000/svg" --insert "/x:svg" --type attr -n height -v $i "$tmpdir/tmp2.svg" > "$tmpdir/tmp3.svg"
cairosvg -f png -o "$tmpdir/$i.png" "$tmpdir/tmp3.svg"
rm "$tmpdir/tmp.svg" "$tmpdir/tmp2.svg" "$tmpdir/tmp3.svg"
done
# one more for the non-square mstile
cp "$1" "$tmpdir/tmp.svg"
xmlstarlet ed -N x="http://www.w3.org/2000/svg" --insert "/x:svg" --type attr -n width -v 310 "$tmpdir/tmp.svg" > "$tmpdir/tmp2.svg"
xmlstarlet ed -N x="http://www.w3.org/2000/svg" --insert "/x:svg" --type attr -n height -v 150 "$tmpdir/tmp2.svg" > "$tmpdir/tmp3.svg"
cairosvg -f png -o "$tmpdir/310x150.png" "$tmpdir/tmp3.svg"
rm "$tmpdir/tmp.svg" "$tmpdir/tmp2.svg" "$tmpdir/tmp3.svg"
mkdir "$tmpdir/Riot.iconset"
cp "$tmpdir/16.png" "$tmpdir/Riot.iconset/icon_16x16.png"
cp "$tmpdir/32.png" "$tmpdir/Riot.iconset/icon_16x16@2x.png"
cp "$tmpdir/32.png" "$tmpdir/Riot.iconset/icon_32x32.png"
cp "$tmpdir/64.png" "$tmpdir/Riot.iconset/icon_32x32@2x.png"
cp "$tmpdir/128.png" "$tmpdir/Riot.iconset/icon_128x128.png"
cp "$tmpdir/256.png" "$tmpdir/Riot.iconset/icon_128x128@2x.png"
cp "$tmpdir/256.png" "$tmpdir/Riot.iconset/icon_256x256.png"
cp "$tmpdir/512.png" "$tmpdir/Riot.iconset/icon_256x256@2x.png"
cp "$tmpdir/512.png" "$tmpdir/Riot.iconset/icon_512x512.png"
cp "$tmpdir/1024.png" "$tmpdir/Riot.iconset/icon_512x512@2x.png"
if [ -x "$(command -v iconutil)" ]; then
# available on macos
iconutil -c icns -o electron_app/build/icon.icns "$tmpdir/Riot.iconset"
elif [ -x "$(command -v png2icns)" ]; then
# available on linux
# png2icns is more finicky about its input than iconutil
# 1. it doesn't support a 64x64 (aka 32x32@2x)
# 2. it doesn't like duplicates (128x128@2x == 256x256)
rm "$tmpdir/Riot.iconset/icon_128x128@2x.png"
rm "$tmpdir/Riot.iconset/icon_256x256@2x.png"
rm "$tmpdir/Riot.iconset/icon_16x16@2x.png"
rm "$tmpdir/Riot.iconset/icon_32x32@2x.png"
png2icns electron_app/build/icon.icns "$tmpdir"/Riot.iconset/*png
else
echo "WARNING: Unsupported platform. Skipping icns build"
fi
cp "$tmpdir/36.png" "res/vector-icons/android-chrome-36x36.png"
cp "$tmpdir/48.png" "res/vector-icons/android-chrome-48x48.png"
cp "$tmpdir/72.png" "res/vector-icons/android-chrome-72x72.png"
cp "$tmpdir/96.png" "res/vector-icons/android-chrome-96x96.png"
cp "$tmpdir/144.png" "res/vector-icons/android-chrome-144x144.png"
cp "$tmpdir/192.png" "res/vector-icons/android-chrome-192x192.png"
cp "$tmpdir/180.png" "res/vector-icons/apple-touch-icon.png"
cp "$tmpdir/180.png" "res/vector-icons/apple-touch-icon-precomposed.png"
cp "$tmpdir/57.png" "res/vector-icons/apple-touch-icon-57x57.png"
cp "$tmpdir/60.png" "res/vector-icons/apple-touch-icon-60x60.png"
cp "$tmpdir/72.png" "res/vector-icons/apple-touch-icon-72x72.png"
cp "$tmpdir/76.png" "res/vector-icons/apple-touch-icon-76x76.png"
cp "$tmpdir/114.png" "res/vector-icons/apple-touch-icon-114x114.png"
cp "$tmpdir/120.png" "res/vector-icons/apple-touch-icon-120x120.png"
cp "$tmpdir/144.png" "res/vector-icons/apple-touch-icon-144x144.png"
cp "$tmpdir/152.png" "res/vector-icons/apple-touch-icon-152x152.png"
cp "$tmpdir/180.png" "res/vector-icons/apple-touch-icon-180x180.png"
cp "$tmpdir/16.png" "res/vector-icons/favicon-16x16.png"
cp "$tmpdir/32.png" "res/vector-icons/favicon-32x32.png"
cp "$tmpdir/96.png" "res/vector-icons/favicon-96x96.png"
cp "$tmpdir/70.png" "res/vector-icons/mstile-70x70.png"
cp "$tmpdir/144.png" "res/vector-icons/mstile-144x144.png"
cp "$tmpdir/150.png" "res/vector-icons/mstile-150x150.png"
cp "$tmpdir/310.png" "res/vector-icons/mstile-310x310.png"
cp "$tmpdir/310x150.png" "res/vector-icons/mstile-310x150.png"
cp "$tmpdir/180.png" "electron_app/img/riot.png"
convert "$tmpdir/16.png" "$tmpdir/32.png" "$tmpdir/64.png" "$tmpdir/128.png" "$tmpdir/256.png" "res/vector-icons/favicon.ico"
cp "res/vector-icons/favicon.ico" "electron_app/build/icon.ico"
cp "res/vector-icons/favicon.ico" "electron_app/img/riot.ico"
# https://github.com/electron-userland/electron-builder/blob/3f97b86993d4ea5172e562b182230a194de0f621/src/targets/LinuxTargetHelper.ts#L127
for i in 24 96 16 48 64 128 256 512
do
cp "$tmpdir/$i.png" "electron_app/build/icons/${i}x${i}.png"
done
rm -r "$tmpdir"

View File

@@ -1,6 +1,4 @@
#!/usr/bin/env bash #!/bin/bash
set -e
# If $1 looks like v1.2.3 or v1.2.3-foo, strip the leading v, then print it to stdout # If $1 looks like v1.2.3 or v1.2.3-foo, strip the leading v, then print it to stdout
if [[ $1 =~ ^v[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+(-.+)?$ ]]; then if [[ $1 =~ ^v[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+(-.+)?$ ]]; then

View File

@@ -1,4 +1,4 @@
#!/usr/bin/env bash #!/bin/bash
set -e set -e

295
scripts/redeploy.py Executable file
View File

@@ -0,0 +1,295 @@
#!/usr/bin/env python
#
# auto-deploy script for https://develop.element.io
#
# Listens for buildkite webhook pokes (https://buildkite.com/docs/apis/webhooks)
# When it gets one, downloads the artifact from buildkite
# and deploys it as the new version.
#
# Requires the following python packages:
#
# - requests
# - flask
#
from __future__ import print_function
import requests, argparse, os, errno
import time
import traceback
import glob
import re
import shutil
import threading
from Queue import Queue
from flask import Flask, jsonify, request, abort
from deploy import Deployer, DeployException
app = Flask(__name__)
deployer = None
arg_extract_path = None
arg_webhook_token = None
arg_api_token = None
workQueue = Queue()
def req_headers():
return {
"Authorization": "Bearer %s" % (arg_api_token,),
}
# Buildkite considers a poke to have failed if it has to wait more than 10s for
# data (any data, not just the initial response) and it normally takes longer than
# that to download an artifact from buildkite. Apparently there is no way in flask
# to finish the response and then keep doing stuff, so instead this has to involve
# threading. Sigh.
def worker_thread():
while True:
toDeploy = workQueue.get()
deploy_buildkite_artifact(*toDeploy)
@app.route("/", methods=["POST"])
def on_receive_buildkite_poke():
got_webhook_token = request.headers.get('X-Buildkite-Token')
if got_webhook_token != arg_webbook_token:
print("Denying request with incorrect webhook token: %s" % (got_webhook_token,))
abort(400, "Incorrect webhook token")
return
required_api_prefix = None
if arg_buildkite_org is not None:
required_api_prefix = 'https://api.buildkite.com/v2/organizations/%s' % (arg_buildkite_org,)
incoming_json = request.get_json()
if not incoming_json:
abort(400, "No JSON provided!")
return
print("Incoming JSON: %s" % (incoming_json,))
event = incoming_json.get("event")
if event is None:
abort(400, "No 'event' specified")
return
if event == 'ping':
print("Got ping request - responding")
return jsonify({'response': 'pong!'})
if event != 'build.finished':
print("Rejecting '%s' event")
abort(400, "Unrecognised event")
return
build_obj = incoming_json.get("build")
if build_obj is None:
abort(400, "No 'build' object")
return
build_url = build_obj.get('url')
if build_url is None:
abort(400, "build has no url")
return
if required_api_prefix is not None and not build_url.startswith(required_api_prefix):
print("Denying poke for build url with incorrect prefix: %s" % (build_url,))
abort(400, "Invalid build url")
return
build_num = build_obj.get('number')
if build_num is None:
abort(400, "build has no number")
return
pipeline_obj = incoming_json.get("pipeline")
if pipeline_obj is None:
abort(400, "No 'pipeline' object")
return
pipeline_name = pipeline_obj.get('name')
if pipeline_name is None:
abort(400, "pipeline has no name")
return
artifacts_url = build_url + "/artifacts"
artifacts_resp = requests.get(artifacts_url, headers=req_headers())
artifacts_resp.raise_for_status()
artifacts_array = artifacts_resp.json()
artifact_to_deploy = None
for artifact in artifacts_array:
if re.match(r"dist/.*.tar.gz", artifact['path']):
artifact_to_deploy = artifact
if artifact_to_deploy is None:
print("No suitable artifacts found")
return jsonify({})
# double paranoia check: make sure the artifact is on the right org too
if required_api_prefix is not None and not artifact_to_deploy['url'].startswith(required_api_prefix):
print("Denying poke for build url with incorrect prefix: %s" % (artifact_to_deploy['url'],))
abort(400, "Refusing to deploy artifact from URL %s", artifact_to_deploy['url'])
return
# there's no point building up a queue of things to deploy, so if there are any pending jobs,
# remove them
while not workQueue.empty():
try:
workQueue.get(False)
except:
pass
workQueue.put([artifact_to_deploy, pipeline_name, build_num])
return jsonify({})
def deploy_buildkite_artifact(artifact, pipeline_name, build_num):
artifact_response = requests.get(artifact['url'], headers=req_headers())
artifact_response.raise_for_status()
artifact_obj = artifact_response.json()
# we extract into a directory based on the build number. This avoids the
# problem of multiple builds building the same git version and thus having
# the same tarball name. That would lead to two potential problems:
# (a) sometimes jenkins serves corrupted artifacts; we would replace
# a good deploy with a bad one
# (b) we'll be overwriting the live deployment, which means people might
# see half-written files.
build_dir = os.path.join(arg_extract_path, "%s-#%s" % (pipeline_name, build_num))
try:
extracted_dir = deploy_tarball(artifact_obj, build_dir)
except DeployException as e:
traceback.print_exc()
abort(400, e.message)
def deploy_tarball(artifact, build_dir):
"""Download a tarball from jenkins and unpack it
Returns:
(str) the path to the unpacked deployment
"""
if os.path.exists(build_dir):
raise DeployException(
"Not deploying. We have previously deployed this build."
)
os.mkdir(build_dir)
print("Fetching artifact %s -> %s..." % (artifact['download_url'], artifact['filename']))
# Download the tarball here as buildkite needs auth to do this
# we don't pgp-sign buildkite artifacts, relying on HTTPS and buildkite
# not being evil. If that's not good enough for you, don't use develop.element.io.
resp = requests.get(artifact['download_url'], stream=True, headers=req_headers())
resp.raise_for_status()
with open(artifact['filename'], 'wb') as ofp:
shutil.copyfileobj(resp.raw, ofp)
print("...download complete. Deploying...")
# we rely on the fact that flask only serves one request at a time to
# ensure that we do not overwrite a tarball from a concurrent request.
return deployer.deploy(artifact['filename'], build_dir)
if __name__ == "__main__":
parser = argparse.ArgumentParser("Runs a Vector redeployment server.")
parser.add_argument(
"-p", "--port", dest="port", default=4000, type=int, help=(
"The port to listen on for requests from Jenkins."
)
)
parser.add_argument(
"-e", "--extract", dest="extract", default="./extracted", help=(
"The location to extract .tar.gz files to."
)
)
parser.add_argument(
"-b", "--bundles-dir", dest="bundles_dir", help=(
"A directory to move the contents of the 'bundles' directory to. A \
symlink to the bundles directory will also be written inside the \
extracted tarball. Example: './bundles'."
)
)
parser.add_argument(
"-c", "--clean", dest="clean", action="store_true", default=False, help=(
"Remove .tar.gz files after they have been downloaded and extracted."
)
)
parser.add_argument(
"-s", "--symlink", dest="symlink", default="./latest", help=(
"Write a symlink to this location pointing to the extracted tarball. \
New builds will keep overwriting this symlink. The symlink will point \
to the /vector directory INSIDE the tarball."
)
)
# --include ../../config.json ./localhost.json homepages/*
parser.add_argument(
"--include", nargs='*', default='./config*.json', help=(
"Symlink these files into the root of the deployed tarball. \
Useful for config files and home pages. Supports glob syntax. \
(Default: '%(default)s')"
)
)
parser.add_argument(
"--test", dest="tarball_uri", help=(
"Don't start an HTTP listener. Instead download a build from Jenkins \
immediately."
),
)
parser.add_argument(
"--webhook-token", dest="webhook_token", help=(
"Only accept pokes with this buildkite token."
), required=True,
)
parser.add_argument(
"--api-token", dest="api_token", help=(
"API access token for buildkite. Require read_artifacts scope."
), required=True,
)
# We require a matching webhook token, but because we take everything else
# about what to deploy from the poke body, we can be a little more paranoid
# and only accept builds / artifacts from a specific buildkite org
parser.add_argument(
"--org", dest="buildkite_org", help=(
"Lock down to this buildkite org"
)
)
args = parser.parse_args()
arg_extract_path = args.extract
arg_webbook_token = args.webhook_token
arg_api_token = args.api_token
arg_buildkite_org = args.buildkite_org
if not os.path.isdir(arg_extract_path):
os.mkdir(arg_extract_path)
deployer = Deployer()
deployer.bundles_path = args.bundles_dir
deployer.should_clean = args.clean
deployer.symlink_latest = args.symlink
for include in args.include:
deployer.symlink_paths.update({ os.path.basename(pth): pth for pth in glob.iglob(include) })
if args.tarball_uri is not None:
build_dir = os.path.join(arg_extract_path, "test-%i" % (time.time()))
deploy_tarball(args.tarball_uri, build_dir)
else:
print(
"Listening on port %s. Extracting to %s%s. Symlinking to %s. Include files: %s" %
(args.port,
arg_extract_path,
" (clean after)" if deployer.should_clean else "",
args.symlink,
deployer.symlink_paths,
)
)
fred = threading.Thread(target=worker_thread)
fred.daemon = True
fred.start()
app.run(port=args.port, debug=False)

View File

@@ -11,4 +11,4 @@ sonar.exclusions=__mocks__,docs,element.io,nginx
sonar.typescript.tsconfigPath=./tsconfig.json sonar.typescript.tsconfigPath=./tsconfig.json
sonar.javascript.lcov.reportPaths=coverage/lcov.info sonar.javascript.lcov.reportPaths=coverage/lcov.info
sonar.coverage.exclusions=test/**/*,res/**/* sonar.coverage.exclusions=test/**/*,res/**/*
sonar.testExecutionReportPaths=coverage/jest-sonar-report.xml sonar.testExecutionReportPaths=coverage/test-report.xml

View File

@@ -19,21 +19,20 @@ import type { Renderer } from "react-dom";
import type { logger } from "matrix-js-sdk/src/logger"; import type { logger } from "matrix-js-sdk/src/logger";
type ElectronChannel = type ElectronChannel =
| "app_onAction" "app_onAction" |
| "before-quit" "before-quit" |
| "check_updates" "check_updates" |
| "install_update" "install_update" |
| "ipcCall" "ipcCall" |
| "ipcReply" "ipcReply" |
| "loudNotification" "loudNotification" |
| "preferences" "preferences" |
| "seshat" "seshat" |
| "seshatReply" "seshatReply" |
| "setBadgeCount" "setBadgeCount" |
| "update-downloaded" "update-downloaded" |
| "userDownloadCompleted" "userDownloadCompleted" |
| "userDownloadAction" "userDownloadAction";
| "openDesktopCapturerSourcePicker";
declare global { declare global {
interface Window { interface Window {
@@ -55,6 +54,12 @@ declare global {
on(channel: ElectronChannel, listener: (event: Event, ...args: any[]) => void): void; on(channel: ElectronChannel, listener: (event: Event, ...args: any[]) => void): void;
send(channel: ElectronChannel, ...args: any[]): void; send(channel: ElectronChannel, ...args: any[]): void;
} }
interface Navigator {
// PWA badging extensions https://w3c.github.io/badging/
setAppBadge?(count: number): Promise<void>;
clearAppBadge?(): Promise<void>;
}
} }
// add method which is missing from the node typing // add method which is missing from the node typing

View File

@@ -1,29 +0,0 @@
/*
Copyright 2023 The Matrix.org Foundation C.I.C.
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.
*/
import "jitsi-meet";
declare module "jitsi-meet" {
interface ExternalAPIEventCallbacks {
errorOccurred: (e: { error: Error & { isFatal?: boolean } }) => void;
}
interface JitsiMeetExternalAPI {
executeCommand(command: "setTileView", value: boolean): void;
}
}
export as namespace Jitsi;

View File

@@ -1,4 +1,4 @@
declare module "!!raw-loader!*" { declare module '!!raw-loader!*' {
const contents: string; const contents: string;
export default contents; export default contents;
} }

Some files were not shown because too many files have changed in this diff Show More