From 146bcdd6a6314fef883a3569a9e95989f3857818 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Thu, 21 Apr 2022 12:55:32 +0100
Subject: [PATCH] Move more stuff from BK to GHA (#8372)

---
 .editorconfig                                 |   3 +
 .github/workflows/element-build-and-test.yaml | 126 +++++++++------
 .github/workflows/end-to-end-tests.yaml       |  99 ++++++------
 .github/workflows/netlify.yaml                | 145 +++++++++---------
 .github/workflows/notify-element-web.yml      |  27 ++--
 .github/workflows/preview_changelog.yaml      |  14 +-
 .github/workflows/static_analysis.yaml        |  88 +++++++++++
 .../{test_coverage.yml => tests.yml}          |  17 +-
 .github/workflows/typecheck.yaml              |  27 ----
 9 files changed, 336 insertions(+), 210 deletions(-)
 create mode 100644 .github/workflows/static_analysis.yaml
 rename .github/workflows/{test_coverage.yml => tests.yml} (78%)
 delete mode 100644 .github/workflows/typecheck.yaml

diff --git a/.editorconfig b/.editorconfig
index 880331a09e..56631484cd 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -21,3 +21,6 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 trim_trailing_whitespace = true
+
+[*.{yml,yaml}]
+indent_size = 2
diff --git a/.github/workflows/element-build-and-test.yaml b/.github/workflows/element-build-and-test.yaml
index 1633aae260..905dbedb06 100644
--- a/.github/workflows/element-build-and-test.yaml
+++ b/.github/workflows/element-build-and-test.yaml
@@ -3,47 +3,87 @@
 # as an artifact and run integration tests.
 name: Element Web - Build and Test
 on:
-    pull_request:
+  pull_request: { }
+  push:
+    branches: [ develop, master ]
+  repository_dispatch:
+    types: [ upstream-sdk-notify ]
 jobs:
-    build:
-        runs-on: ubuntu-latest
-        env:
-          # This must be set for fetchdep.sh to get the right branch
-          PR_NUMBER: ${{github.event.number}}
-        steps:
-            - uses: actions/checkout@v2
-            - name: Build
-              run: scripts/ci/layered.sh && cd element-web && cp element.io/develop/config.json config.json && CI_PACKAGE=true yarn build
-            - 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:
-        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
-            - name: Upload Artifact
-              if: failure()
-              uses: actions/upload-artifact@v2
-              with:
-                  name: cypress-results
-                  path: |
-                      cypress/screenshots
-                      cypress/videos
-                      cypress/synapselogs
+  build:
+    name: "Build Element-Web"
+    runs-on: ubuntu-latest
+    env:
+      # This must be set for fetchdep.sh to get the right branch
+      PR_NUMBER: ${{github.event.number}}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      - name: Fetch layered build
+        run: scripts/ci/layered.sh
+
+      - name: Copy config
+        run: cp element.io/develop/config.json config.json
+        working-directory: ./element-web
+
+      - name: Build
+        run: CI_PACKAGE=true 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
+
+      - 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
+    env:
+      # This must be set for fetchdep.sh to get the right branch
+      PR_NUMBER: ${{github.event.number}}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      - name: Run tests
+        run: "./scripts/ci/app-tests.sh"
diff --git a/.github/workflows/end-to-end-tests.yaml b/.github/workflows/end-to-end-tests.yaml
index 334af1772f..1feaf266e3 100644
--- a/.github/workflows/end-to-end-tests.yaml
+++ b/.github/workflows/end-to-end-tests.yaml
@@ -1,47 +1,58 @@
 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]
+  # 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 ]
 jobs:
-    end-to-end:
-        runs-on: ubuntu-latest
-        env:
-          # This must be set for fetchdep.sh to get the right branch
-          PR_NUMBER: ${{github.event.number}}
-        container: vectorim/element-web-ci-e2etests-env:latest
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v2
-            - 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' }}
+  end-to-end:
+    runs-on: ubuntu-latest
+    env:
+      # This must be set for fetchdep.sh to get the right branch
+      PR_NUMBER: ${{github.event.number}}
+    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' }}
diff --git a/.github/workflows/netlify.yaml b/.github/workflows/netlify.yaml
index ec09379b6e..1acb7e8fd1 100644
--- a/.github/workflows/netlify.yaml
+++ b/.github/workflows/netlify.yaml
@@ -2,76 +2,79 @@
 # and uploading it to netlify
 name: Upload Preview Build to Netlify
 on:
-    workflow_run:
-        workflows: ["Element Web - Build and Test"]
-        types:
-            - completed
+  workflow_run:
+    workflows: [ "Element Web - Build and Test" ]
+    types:
+      - completed
 jobs:
-    build:
-        runs-on: ubuntu-latest
-        if: >
-            ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request' }}
-        steps:
-            - name: "🔍 Read PR number"
-              id: readctx
-              # we need to find the PR number that corresponds to the branch, which we do by
-              # searching the GH API
-              # The workflow_run event includes a list of pull requests, but it doesn't get populated for
-              # forked PRs: https://docs.github.com/en/rest/reference/checks#create-a-check-run
-              run: |
-                head_branch='${{github.event.workflow_run.head_repository.owner.login}}:${{github.event.workflow_run.head_branch}}'
-                echo "head branch: $head_branch"
-                pulls_uri="https://api.github.com/repos/${{ github.repository }}/pulls?head=$(jq -Rr '@uri' <<<$head_branch)"
-                pr_number=$(curl -s -H 'Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' "$pulls_uri" |
-                     jq -r '.[] | .number')
-                echo "PR number: $pr_number"
-                echo "::set-output name=prnumber::$pr_number"
-            # There's a 'download artifact' action but it hasn't been updated for the
-            # workflow_run action (https://github.com/actions/download-artifact/issues/60)
-            # so instead we get this mess:
-            - name: 'Download artifact'
-              uses: actions/github-script@v3.1.0
-              with:
-                script: |
-                  var artifacts = await github.actions.listWorkflowRunArtifacts({
-                     owner: context.repo.owner,
-                     repo: context.repo.repo,
-                     run_id: ${{github.event.workflow_run.id }},
-                  });
-                  var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
-                    return artifact.name == "previewbuild"
-                  })[0];
-                  var download = await github.actions.downloadArtifact({
-                     owner: context.repo.owner,
-                     repo: context.repo.repo,
-                     artifact_id: matchArtifact.id,
-                     archive_format: 'zip',
-                  });
-                  var fs = require('fs');
-                  fs.writeFileSync('${{github.workspace}}/previewbuild.zip', Buffer.from(download.data));
-            - name: Extract Artifacts
-              run: unzip -d webapp previewbuild.zip && rm previewbuild.zip
-            - name: Deploy to Netlify
-              id: netlify
-              uses: nwtgck/actions-netlify@v1.2
-              with:
-                  publish-dir: webapp
-                  deploy-message: "Deploy from GitHub Actions"
-                  # These don't work because we're in workflow_run
-                  enable-pull-request-comment: false
-                  enable-commit-comment: false
-                  alias: pr${{ steps.readctx.outputs.prnumber }}
-              env:
-                  NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
-                  NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
-              timeout-minutes: 1
-            - name: Edit PR Description
-              uses: Beakyn/gha-comment-pull-request@2167a7aee24f9e61ce76a23039f322e49a990409
-              env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-              with:
-                  pull-request-number: ${{ steps.readctx.outputs.prnumber }}
-                  description-message: |
-                      Preview: ${{ steps.netlify.outputs.deploy-url }}
-                      ⚠️ Do you trust the author of this PR? Maybe this build will steal your keys or give you malware. Exercise caution. Use test accounts.
+  build:
+    runs-on: ubuntu-latest
+    if: >
+      ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request' }}
+    steps:
+      - name: "🔍 Read PR number"
+        id: readctx
+        # we need to find the PR number that corresponds to the branch, which we do by
+        # searching the GH API
+        # The workflow_run event includes a list of pull requests, but it doesn't get populated for
+        # forked PRs: https://docs.github.com/en/rest/reference/checks#create-a-check-run
+        run: |
+          head_branch='${{github.event.workflow_run.head_repository.owner.login}}:${{github.event.workflow_run.head_branch}}'
+          echo "head branch: $head_branch"
+          pulls_uri="https://api.github.com/repos/${{ github.repository }}/pulls?head=$(jq -Rr '@uri' <<<$head_branch)"
+          pr_number=$(curl -s -H 'Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' "$pulls_uri" |
+               jq -r '.[] | .number')
+          echo "PR number: $pr_number"
+          echo "::set-output name=prnumber::$pr_number"
 
+      # There's a 'download artifact' action but it hasn't been updated for the
+      # workflow_run action (https://github.com/actions/download-artifact/issues/60)
+      # so instead we get this mess:
+      - name: 'Download artifact'
+        uses: actions/github-script@v3.1.0
+        with:
+          script: |
+            var artifacts = await github.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: ${{github.event.workflow_run.id }},
+            });
+            var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "previewbuild"
+            })[0];
+            var download = await github.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            var fs = require('fs');
+            fs.writeFileSync('${{github.workspace}}/previewbuild.zip', Buffer.from(download.data));
+
+      - name: Extract Artifacts
+        run: unzip -d webapp previewbuild.zip && rm previewbuild.zip
+
+      - name: Deploy to Netlify
+        id: netlify
+        uses: nwtgck/actions-netlify@v1.2
+        with:
+          publish-dir: webapp
+          deploy-message: "Deploy from GitHub Actions"
+          # These don't work because we're in workflow_run
+          enable-pull-request-comment: false
+          enable-commit-comment: false
+          alias: pr${{ steps.readctx.outputs.prnumber }}
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 1
+
+      - name: Edit PR Description
+        uses: Beakyn/gha-comment-pull-request@2167a7aee24f9e61ce76a23039f322e49a990409
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          pull-request-number: ${{ steps.readctx.outputs.prnumber }}
+          description-message: |
+            Preview: ${{ steps.netlify.outputs.deploy-url }}
+            ⚠️ Do you trust the author of this PR? Maybe this build will steal your keys or give you malware. Exercise caution. Use test accounts.
diff --git a/.github/workflows/notify-element-web.yml b/.github/workflows/notify-element-web.yml
index ef463784f3..c5c89905ce 100644
--- a/.github/workflows/notify-element-web.yml
+++ b/.github/workflows/notify-element-web.yml
@@ -1,15 +1,18 @@
 name: Notify element-web
 on:
-    push:
-        branches: [develop]
+  push:
+    branches: [ develop ]
+  repository_dispatch:
+    types: [ upstream-sdk-notify ]
 jobs:
-    notify-element-web:
-        runs-on: ubuntu-latest
-        environment: develop
-        steps:
-            -   name: Notify element-web repo that a new SDK build is on develop
-                uses: peter-evans/repository-dispatch@v1
-                with:
-                    token: ${{ secrets.ELEMENT_WEB_NOTIFY_TOKEN }}
-                    repository: vector-im/element-web
-                    event-type: element-web-notify
+  notify-element-web:
+    name: "Notify Element Web"
+    runs-on: ubuntu-latest
+    environment: develop
+    steps:
+      - name: Notify element-web repo that a new SDK build is on develop
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.ELEMENT_BOT_TOKEN }}
+          repository: vector-im/element-web
+          event-type: element-web-notify
diff --git a/.github/workflows/preview_changelog.yaml b/.github/workflows/preview_changelog.yaml
index d68d19361d..786d828d41 100644
--- a/.github/workflows/preview_changelog.yaml
+++ b/.github/workflows/preview_changelog.yaml
@@ -3,10 +3,10 @@ on:
   pull_request_target:
     types: [ opened, edited, labeled ]
 jobs:
-    changelog:
-        runs-on: ubuntu-latest
-        steps:
-            - name: Preview Changelog
-              uses: matrix-org/allchange@main
-              with:
-                  ghToken: ${{ secrets.GITHUB_TOKEN }}
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Preview Changelog
+        uses: matrix-org/allchange@main
+        with:
+          ghToken: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/static_analysis.yaml b/.github/workflows/static_analysis.yaml
new file mode 100644
index 0000000000..8e320d9992
--- /dev/null
+++ b/.github/workflows/static_analysis.yaml
@@ -0,0 +1,88 @@
+name: Static Analysis
+on:
+  pull_request: { }
+  push:
+    branches: [ develop, master ]
+  repository_dispatch:
+    types: [ upstream-sdk-notify ]
+jobs:
+  ts_lint:
+    name: "Typescript Syntax Check"
+    runs-on: ubuntu-latest
+    env:
+      # This must be set for fetchdep.sh to get the right branch
+      PR_NUMBER: ${{github.event.number}}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      - name: Install Deps
+        run: "./scripts/ci/install-deps.sh --ignore-scripts"
+
+      - name: Typecheck
+        run: "yarn run lint:types"
+
+      - name: Switch js-sdk to release mode
+        run: |
+          scripts/ci/js-sdk-to-release.js
+          cd node_modules/matrix-js-sdk
+          yarn install
+          yarn run build:compile
+          yarn run build:types
+
+      - name: Typecheck (release mode)
+        run: "yarn run lint:types"
+
+  i18n_lint:
+    name: "i18n Diff Check"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      # Does not need branch matching as only analyses this layer
+      - name: Install Deps
+        run: "yarn install"
+
+      - name: i18n Check
+        run: "yarn run diff-i18n"
+
+  js_lint:
+    name: "ESLint"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      # Does not need branch matching as only analyses this layer
+      - name: Install Deps
+        run: "yarn install"
+
+      - name: Run Linter
+        run: "yarn run lint:js"
+
+  style_lint:
+    name: "Style Lint"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+
+      # Does not need branch matching as only analyses this layer
+      - name: Install Deps
+        run: "yarn install"
+
+      - name: Run Linter
+        run: "yarn run lint:style"
diff --git a/.github/workflows/test_coverage.yml b/.github/workflows/tests.yml
similarity index 78%
rename from .github/workflows/test_coverage.yml
rename to .github/workflows/tests.yml
index 4cd9f6d2f0..dc11981b7c 100644
--- a/.github/workflows/test_coverage.yml
+++ b/.github/workflows/tests.yml
@@ -1,10 +1,13 @@
-name: Test coverage
+name: Tests
 on:
-  pull_request: {}
+  pull_request: { }
   push:
-    branches: [develop, main, master]
+    branches: [ develop, master ]
+  repository_dispatch:
+    types: [ upstream-sdk-notify ]
 jobs:
-  test-coverage:
+  jest:
+    name: Jest with Codecov
     runs-on: ubuntu-latest
     env:
       # This must be set for fetchdep.sh to get the right branch
@@ -19,13 +22,15 @@ jobs:
           ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || '' }}
 
       - name: Yarn cache
-        uses: c-hive/gha-yarn-cache@v2
+        uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
 
       - name: Install Deps
         run: "./scripts/ci/install-deps.sh --ignore-scripts"
 
       - name: Run tests with coverage
-        run: "yarn install && yarn coverage"
+        run: "yarn coverage"
 
       - name: Upload coverage
         uses: codecov/codecov-action@v2
diff --git a/.github/workflows/typecheck.yaml b/.github/workflows/typecheck.yaml
deleted file mode 100644
index 60cabb3cab..0000000000
--- a/.github/workflows/typecheck.yaml
+++ /dev/null
@@ -1,27 +0,0 @@
-name: Type Check
-on:
-    pull_request:
-        branches: [develop]
-jobs:
-    build:
-        runs-on: ubuntu-latest
-        env:
-          # This must be set for fetchdep.sh to get the right branch
-          PR_NUMBER: ${{github.event.number}}
-        steps:
-            - uses: actions/checkout@v2
-            - uses: c-hive/gha-yarn-cache@v2
-            - name: Install Deps
-              run: "./scripts/ci/install-deps.sh --ignore-scripts"
-            - name: Typecheck
-              run: "yarn run lint:types"
-            - name: Switch js-sdk to release mode
-              run: |
-                  scripts/ci/js-sdk-to-release.js
-                  cd node_modules/matrix-js-sdk
-                  yarn install
-                  yarn run build:compile
-                  yarn run build:types
-            - name: Typecheck (release mode)
-              run: "yarn run lint:types"
-