element-web/.github/workflows/tests.yml

name: Tests
on:
    pull_request: {}
    merge_group:
        types: [checks_requested]
    push:
        branches: [develop, master]
    workflow_call:
        inputs:
            disable_coverage:
                type: boolean
                required: false
                description: "Specify true to skip generating and uploading coverage for tests"
            matrix-js-sdk-sha:
                type: string
                required: false
                description: "The matrix-js-sdk SHA to use"
concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
    cancel-in-progress: true

env:
    ENABLE_COVERAGE: ${{ github.event_name != 'merge_group' && inputs.disable_coverage != 'true' }}
    # fetchdep.sh needs to know our PR number
    PR_NUMBER: ${{ github.event.pull_request.number }}
    NX_DEFAULT_OUTPUT_STYLE: stream-without-prefixes

permissions: {}

jobs:
    jest_ew:
        name: Jest (Element Web)
        runs-on: ubuntu-24.04
        strategy:
            fail-fast: false
            matrix:
                # Run multiple instances in parallel to speed up the tests
                runner: [1, 2]
        steps:
            - name: Checkout code
              uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
              with:
                  repository: ${{ inputs.matrix-js-sdk-sha && 'element-hq/element-web' || github.repository }}
                  persist-credentials: false

            - uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 # v6.0.8
            - name: pnpm cache
              uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
              with:
                  node-version: "lts/*"
                  cache: "pnpm"

            - name: Install Deps
              run: "./scripts/layered.sh"
              env:
                  JS_SDK_GITHUB_BASE_REF: ${{ inputs.matrix-js-sdk-sha }}

            - name: Jest Cache
              uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
              with:
                  path: /tmp/jest_cache
                  key: ${{ hashFiles('**/pnpm-lock.yaml') }}

            - name: Get number of CPU cores
              id: cpu-cores
              uses: SimenB/github-actions-cpu-cores@97330871fe1b7d3529392ea000e3d2c4b357e403 # v3

            - name: Run tests
              working-directory: apps/web
              run: |
                  pnpm test \
                      --coverage=$ENABLE_COVERAGE \
                      --ci \
                      --max-workers $MAX_WORKERS \
                      --shard "$SHARD" \
                      --cacheDirectory /tmp/jest_cache
              env:
                  # tell jest to use coloured output
                  FORCE_COLOR: true
                  MAX_WORKERS: ${{ steps.cpu-cores.outputs.count }}
                  SHARD: ${{ format('{0}/{1}', matrix.runner, strategy.job-total) }}

            - name: Move coverage files into place
              if: env.ENABLE_COVERAGE == 'true'
              working-directory: apps/web
              run: mv coverage/lcov.info coverage/$NODE_VERSION-${{ matrix.runner }}.lcov.info
              env:
                  NODE_VERSION: ${{ steps.setupNode.outputs.node-version }}

            - name: Upload Artifact
              if: env.ENABLE_COVERAGE == 'true'
              uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
              with:
                  name: coverage-jest-${{ matrix.runner }}
                  path: |
                      apps/web/coverage
                      !apps/web/coverage/lcov-report

    vitest:
        name: Vitest
        strategy:
            matrix:
                path:
                    - apps/desktop
                    - packages/shared-components
                    - packages/module-api
        runs-on: ubuntu-24.04
        steps:
            # Dump the disk usage before we start: this job frequently flakes with "No space left on device"
            # so, with the one at the end too, this will let us work out how much disk has been used.
            - name: dfbefore
              run: df -h && df -i

            - name: Checkout code
              uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
              with:
                  repository: ${{ inputs.matrix-js-sdk-sha && 'element-hq/element-web' || github.repository }}
                  persist-credentials: false

            - uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 # v6.0.8
            - name: pnpm cache
              uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
              with:
                  node-version: "lts/*"
                  cache: "pnpm"

            - name: Install Deps
              run: "pnpm install"

            - name: Cache storybook & vitest
              uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
              with:
                  path: |
                      ${{ matrix.path }}/node_modules/.cache
                      ${{ matrix.path }}/node_modules/.vite/vitest
                  key: ${{ matrix.path }}-${{ hashFiles('pnpm-lock.yaml') }}

            - name: Setup playwright
              uses: ./.github/actions/setup-playwright
              if: matrix.path == 'packages/shared-components'
              with:
                  write-cache: ${{ github.event_name != 'merge_group' }}

            - name: Run tests
              working-directory: ${{ matrix.path }}
              run: pnpm test:unit --coverage=$ENABLE_COVERAGE

            # Dump the disk usage on failure, because this job seems to fail with disk fills sometimes
            - name: df
              run: df -h && df -i
              if: ${{ failure() }}

            - name: Calculate artifact name
              if: env.ENABLE_COVERAGE == 'true'
              id: artifact
              run: |
                  NAME=$(basename "$MATRIX_PATH")
                  echo "name=$NAME" >> $GITHUB_OUTPUT
              env:
                  MATRIX_PATH: ${{ matrix.path }}

            - name: Upload Artifact
              if: env.ENABLE_COVERAGE == 'true'
              uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
              with:
                  name: coverage-${{ steps.artifact.outputs.name }}
                  path: |
                      ${{ matrix.path }}/coverage
                      !${{ matrix.path }}/coverage/lcov-report

    complete:
        name: Tests
        needs:
            - jest_ew
            - vitest
        if: always()
        runs-on: ubuntu-24.04
        permissions:
            contents: read
            pull-requests: read
            checks: write
            statuses: write
        steps:
            - name: Skip SonarCloud in merge queue
              if: github.event_name == 'merge_group' || inputs.disable_coverage == 'true'
              uses: guibranco/github-status-action-v2@9bfa8773cdbdc6c185747fd43cd7faa9d7c32f09
              with:
                  authToken: ${{ secrets.GITHUB_TOKEN }}
                  state: success
                  description: SonarCloud skipped
                  context: SonarCloud Code Analysis
                  sha: ${{ github.sha }}
                  target_url: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}

            - name: Checkout code
              uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
              if: needs.jest_ew.result == 'success' && needs.vitest.result == 'success' && env.ENABLE_COVERAGE == 'true'
              with:
                  persist-credentials: false
                  fetch-depth: 0 # Full history, fastest for diff-cover

            - name: Download coverage artifacts
              uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
              if: needs.jest_ew.result == 'success' && needs.vitest.result == 'success' && env.ENABLE_COVERAGE == 'true'
              with:
                  pattern: coverage-*
                  path: coverage

            - name: Diff Coverage
              id: coverage
              if: needs.jest_ew.result == 'success' && needs.vitest.result == 'success' && env.ENABLE_COVERAGE == 'true'
              uses: Affanmir/diff-cover-action@0d8c98f613bbd2428df50b3109b1e3b1d5ab59d3 # v2.1.0
              with:
                  compare-branch: origin/${{ github.base_ref || 'develop' }}
                  mode: coverage
                  coverage-files: coverage/*/*lcov.info
                  ignore-whitespace: true
                  show-uncovered: true
                  post-comment: false
                  create-annotations: true
                  annotation-type: warning
                  fail-on-threshold: ${{ contains(github.event.pull_request.labels.*.name, 'Z-Skip-Coverage') && 'false' || 'true' }}
                  fail-under: 80

            - name: Check status of tests
              if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
              run: exit 1