Merge branch 'develop' into feature/obvious-data-change/16221

Author: SimonBrandner

.editorconfig

@@ -21,3 +21,6 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 trim_trailing_whitespace = true
+
+[*.{yml,yaml}]
+indent_size = 2

.eslintignore

@@ -1,5 +1,6 @@
-src/component-index.js
 test/end-to-end-tests/node_modules/
 test/end-to-end-tests/element/
 test/end-to-end-tests/synapse/
 test/end-to-end-tests/lib/
+# Legacy skinning file that some people might still have
+src/component-index.js

.eslintrc.js

@@ -1,8 +1,11 @@
 module.exports = {
-    plugins: ["matrix-org"],
+    plugins: [
+        "matrix-org",
+    ],
     extends: [
         "plugin:matrix-org/babel",
         "plugin:matrix-org/react",
+        "plugin:matrix-org/a11y",
     ],
     env: {
         browser: true,
@@ -36,33 +39,119 @@ module.exports = {
                 "Use Media helper instead to centralise access for customisation.",
             ),
         ],
+
+        // 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",
+            }],
+        }],
+
+        // There are too many a11y violations to fix at once
+        // Turn violated rules off until they are fixed
+        "jsx-a11y/alt-text": "off",
+        "jsx-a11y/aria-activedescendant-has-tabindex": "off",
+        "jsx-a11y/click-events-have-key-events": "off",
+        "jsx-a11y/interactive-supports-focus": "off",
+        "jsx-a11y/label-has-associated-control": "off",
+        "jsx-a11y/media-has-caption": "off",
+        "jsx-a11y/mouse-events-have-key-events": "off",
+        "jsx-a11y/no-autofocus": "off",
+        "jsx-a11y/no-noninteractive-element-interactions": "off",
+        "jsx-a11y/no-noninteractive-element-to-interactive-role": "off",
+        "jsx-a11y/no-noninteractive-tabindex": "off",
+        "jsx-a11y/no-static-element-interactions": "off",
+        "jsx-a11y/role-supports-aria-props": "off",
+        "jsx-a11y/tabindex-no-positive": "off",
     },
-    overrides: [{
-        files: [
-            "src/**/*.{ts,tsx}",
-            "test/**/*.{ts,tsx}",
-        ],
-        extends: [
-            "plugin:matrix-org/typescript",
-            "plugin:matrix-org/react",
-        ],
-        rules: {
-            // Things we do that break the ideal style
-            "prefer-promise-reject-errors": "off",
-            "quotes": "off",
-            "no-extra-boolean-cast": "off",
+    overrides: [
+        {
+            files: [
+                "src/**/*.{ts,tsx}",
+                "test/**/*.{ts,tsx}",
+                "cypress/**/*.ts",
+            ],
+            extends: [
+                "plugin:matrix-org/typescript",
+                "plugin:matrix-org/react",
+            ],
+            rules: {
+                // Things we do that break the ideal style
+                "prefer-promise-reject-errors": "off",
+                "quotes": "off",
+                "no-extra-boolean-cast": "off",
 
-            // Remove Babel things manually due to override limitations
-            "@babel/no-invalid-this": ["off"],
+                // Remove Babel things manually due to override limitations
+                "@babel/no-invalid-this": ["off"],
 
-            // We're okay being explicit at the moment
-            "@typescript-eslint/no-empty-interface": "off",
-            // We disable this while we're transitioning
-            "@typescript-eslint/no-explicit-any": "off",
-            // We'd rather not do this but we do
-            "@typescript-eslint/ban-ts-comment": "off",
+                // We're okay being explicit at the moment
+                "@typescript-eslint/no-empty-interface": "off",
+                // We disable this while we're transitioning
+                "@typescript-eslint/no-explicit-any": "off",
+                // We'd rather not do this but we do
+                "@typescript-eslint/ban-ts-comment": "off",
+            },
         },
-    }],
+        // temporary override for offending icon require files
+        {
+            files: [
+                "src/SdkConfig.ts",
+                "src/components/structures/FileDropTarget.tsx",
+                "src/components/structures/RoomStatusBar.tsx",
+                "src/components/structures/UserMenu.tsx",
+                "src/components/views/avatars/WidgetAvatar.tsx",
+                "src/components/views/dialogs/AddExistingToSpaceDialog.tsx",
+                "src/components/views/dialogs/ForwardDialog.tsx",
+                "src/components/views/dialogs/InviteDialog.tsx",
+                "src/components/views/dialogs/ModalWidgetDialog.tsx",
+                "src/components/views/dialogs/UploadConfirmDialog.tsx",
+                "src/components/views/dialogs/security/SetupEncryptionDialog.tsx",
+                "src/components/views/elements/AddressTile.tsx",
+                "src/components/views/elements/AppWarning.tsx",
+                "src/components/views/elements/SSOButtons.tsx",
+                "src/components/views/messages/MAudioBody.tsx",
+                "src/components/views/messages/MImageBody.tsx",
+                "src/components/views/messages/MFileBody.tsx",
+                "src/components/views/messages/MStickerBody.tsx",
+                "src/components/views/messages/MVideoBody.tsx",
+                "src/components/views/messages/MVoiceMessageBody.tsx",
+                "src/components/views/right_panel/EncryptionPanel.tsx",
+                "src/components/views/rooms/EntityTile.tsx",
+                "src/components/views/rooms/LinkPreviewGroup.tsx",
+                "src/components/views/rooms/MemberList.tsx",
+                "src/components/views/rooms/MessageComposer.tsx",
+                "src/components/views/rooms/ReplyPreview.tsx",
+                "src/components/views/settings/tabs/room/SecurityRoomSettingsTab.tsx",
+                "src/components/views/settings/tabs/user/GeneralUserSettingsTab.tsx"
+            ],
+            rules: {
+                "@typescript-eslint/no-var-requires": "off",
+            },
+        }
+    ],
     settings: {
         react: {
             version: "detect",

.github/codecov.yml

@@ -0,0 +1,12 @@
+codecov:
+  allow_coverage_offsets: True
+coverage:
+  status:
+    project: off
+    patch: off
+comment:
+  layout: "diff, files"
+  behavior: default
+  require_changes: false
+  require_base: no
+  require_head: no

.github/workflows/develop.yml

@@ -0,0 +1,102 @@
+# Produce a build of element-web with this version of react-sdk
+# and any matching branches of element-web and js-sdk, output it
+# as an artifact and run integration tests.
+name: Element Web - Build and Test
+on:
+  pull_request: { }
+  push:
+    branches: [ develop, master ]
+  repository_dispatch:
+    types: [ upstream-sdk-notify ]
+env:
+  # These must be set for fetchdep.sh to get the right branch
+  REPOSITORY: ${{ github.repository }}
+  PR_NUMBER: ${{ github.event.pull_request.number }}
+jobs:
+  build:
+    name: "Build Element-Web"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      - name: Fetch layered build
+        id: layered_build
+        run: |
+          scripts/ci/layered.sh
+          JSSDK_SHA=$(git -C matrix-js-sdk rev-parse --short=12 HEAD)
+          REACT_SHA=$(git rev-parse --short=12 HEAD)
+          VECTOR_SHA=$(git -C element-web rev-parse --short=12 HEAD)
+          echo "::set-output name=VERSION::$VECTOR_SHA-react-$REACT_SHA-js-$JSSDK_SHA"
+
+      - name: Copy config
+        run: cp element.io/develop/config.json config.json
+        working-directory: ./element-web
+
+      - name: Build
+        env:
+          CI_PACKAGE: true
+          VERSION: "${{ steps.layered_build.outputs.VERSION }}"
+        run: yarn build
+        working-directory: ./element-web
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: previewbuild
+          path: element-web/webapp
+          # We'll only use this in a triggered job, then we're done with it
+          retention-days: 1
+
+  cypress:
+    name: "Cypress End to End Tests"
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Download build
+        uses: actions/download-artifact@v3
+        with:
+          name: previewbuild
+          path: webapp
+
+      - name: Run Cypress tests
+        uses: cypress-io/github-action@v2
+        with:
+          # The built in Electron runner seems to grind to a halt trying
+          # to run the tests, so use chrome.
+          browser: chrome
+          start: npx serve -p 8080 webapp
+          record: true
+        env:
+          # pass the Dashboard record key as an environment variable
+          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+          # pass GitHub token to allow accurately detecting a build vs a re-run build
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload Artifact
+        if: failure()
+        uses: actions/upload-artifact@v2
+        with:
+          name: cypress-results
+          path: |
+            cypress/screenshots
+            cypress/videos
+            cypress/synapselogs
+
+  app-tests:
+    name: Element Web Integration Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      - name: Run tests
+        run: "./scripts/ci/app-tests.sh"

.github/workflows/element-build-and-test.yaml

@@ -0,0 +1,59 @@
+name: End-to-end Tests
+on:
+  # These tests won't work for non-develop branches at the moment as they
+  # won't pull in the right versions of other repos, so they're only enabled
+  # on develop.
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+  repository_dispatch:
+    types: [ upstream-sdk-notify ]
+env:
+  # These must be set for fetchdep.sh to get the right branch
+  REPOSITORY: ${{ github.repository }}
+  PR_NUMBER: ${{ github.event.pull_request.number }}
+jobs:
+  end-to-end:
+    runs-on: ubuntu-latest
+    container: vectorim/element-web-ci-e2etests-env:latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      - name: Prepare End-to-End tests
+        run: ./scripts/ci/prepare-end-to-end-tests.sh
+
+      - name: Run End-to-End tests
+        run: ./scripts/ci/run-end-to-end-tests.sh
+
+      - name: Archive logs
+        uses: actions/upload-artifact@v2
+        if: ${{ always() }}
+        with:
+          path: |
+            test/end-to-end-tests/logs/**/*
+            test/end-to-end-tests/synapse/installations/consent/homeserver.log
+            retention-days: 14
+
+      - name: Download previous benchmark data
+        uses: actions/cache@v1
+        with:
+          path: ./cache
+          key: ${{ runner.os }}-benchmark
+
+      - name: Store benchmark result
+        uses: matrix-org/github-action-benchmark@jsperfentry-1
+        with:
+          tool: 'jsperformanceentry'
+          output-file-path: test/end-to-end-tests/performance-entries.json
+          fail-on-alert: false
+          comment-on-alert: false
+          # Only temporary to monitor where failures occur
+          alert-comment-cc-users: '@gsouquet'
+          github-token: ${{ secrets.DEPLOY_GH_PAGES }}
+          auto-push: ${{ github.ref == 'refs/heads/develop' }}