Merge branch 'release/25.02.0' into main

Author: bmarty

.github/pull_request_template.md

@@ -44,11 +44,10 @@ Uncomment this markdown table below and edit the last line `|||`:
 
 <!-- Depending on the Pull Request content, it can be acceptable if some of the following checkboxes stay unchecked. -->
 
-- [ ] Changes have been tested on an Android device or Android emulator with API 23
+- [ ] Changes have been tested on an Android device or Android emulator with API 24
 - [ ] UI change has been tested on both light and dark themes
 - [ ] Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
 - [ ] Pull request is based on the develop branch
 - [ ] Pull request title will be used in the release note, it clearly define what will change for the user
 - [ ] Pull request includes screenshots or videos if containing UI changes
-- [ ] Pull request includes a [sign off](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#sign-off)
 - [ ] You've made a self review of your PR

.github/workflows/build.yml

@@ -13,7 +13,7 @@ env:
   CI_GRADLE_ARG_PROPERTIES: --stacktrace -Dsonar.gradle.skipCompile=true --no-configuration-cache
 
 jobs:
-  debug:
+  build:
     name: Build APKs
     runs-on: ubuntu-latest
     strategy:
@@ -45,6 +45,7 @@ jobs:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
           ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
           ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
+          ELEMENT_ANDROID_SENTRY_DSN: ${{ secrets.ELEMENT_ANDROID_SENTRY_DSN }}
         run: ./gradlew :app:assembleGplayDebug app:assembleFDroidDebug -PallWarningsAsErrors=true $CI_GRADLE_ARG_PROPERTIES
       - name: Upload debug APKs
         if: ${{ matrix.variant == 'debug' }}
@@ -54,7 +55,17 @@ jobs:
           path: |
             app/build/outputs/apk/gplay/debug/*-universal-debug.apk
             app/build/outputs/apk/fdroid/debug/*-universal-debug.apk
-      - uses: rnkdsh/[email protected]
+      - name: Upload x86_64 APK for Maestro
+        if: ${{ matrix.variant == 'debug' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: elementx-apk-maestro
+          path: |
+            app/build/outputs/apk/gplay/debug/app-gplay-x86_64-debug.apk
+          retention-days: 5
+          overwrite: true
+          if-no-files-found: error
+      - uses: rnkdsh/[email protected]
         id: diawi
         # Do not fail the whole build if Diawi upload fails
         continue-on-error: true

.github/workflows/build_enterprise.yml

@@ -53,6 +53,7 @@ jobs:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
           ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
           ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
+          ELEMENT_ANDROID_SENTRY_DSN: ${{ secrets.ELEMENT_ANDROID_SENTRY_DSN }}
         run: ./gradlew :app:assembleGplayDebug -PallWarningsAsErrors=true $CI_GRADLE_ARG_PROPERTIES
       - name: Upload debug Enterprise APKs
         if: ${{ matrix.variant == 'debug' }}

.github/workflows/maestro.yml renamed to .github/workflows/maestro-local.yml

@@ -1,40 +1,35 @@
-name: Maestro
+name: Maestro (local)
 
-# Run this flow only on pull request, and only when the pull request has the Run-Maestro label, to limit our usage of maestro cloud.
+# Run this flow only when APK Build workflow completes
 on:
   workflow_dispatch:
   pull_request:
-    types: [labeled]
 
 # Enrich gradle.properties for CI/CD
 env:
   GRADLE_OPTS: -Dorg.gradle.jvmargs=-Xmx9g -XX:MaxMetaspaceSize=512m -Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError -XX:+UseG1GC -Dkotlin.daemon.jvm.options=-Xmx4g
   CI_GRADLE_ARG_PROPERTIES: --stacktrace --no-daemon -Dsonar.gradle.skipCompile=true --no-configuration-cache
+  ARCH: x86_64
+  DEVICE: pixel_7_pro
+  API_LEVEL: 35
+  TARGET: google_apis
 
 jobs:
   build-apk:
     name: Build APK
     runs-on: ubuntu-latest
-    if: github.event_name == 'workflow_dispatch' || github.event.label.name == 'Run-Maestro'
     # Allow one per PR.
     concurrency:
       group: ${{ format('maestro-{0}', github.ref) }}
       cancel-in-progress: true
     steps:
-      - name: Remove Run-Maestro label
-        if: ${{ github.event_name == 'pull_request' && github.event.label.name == 'Run-Maestro' }}
-        uses: actions-ecosystem/action-remove-labels@v1
-        with:
-          labels: Run-Maestro
       - uses: actions/checkout@v4
-        if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch'
         with:
           # Ensure we are building the branch and not the branch after being merged on develop
           # https://github.com/actions/checkout/issues/881
-          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}
+          ref: ${{ github.ref }}
       - uses: actions/setup-java@v4
         name: Use JDK 21
-        if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch'
         with:
           distribution: 'temurin' # See 'Supported distributions' for available options
           java-version: '21'
@@ -44,7 +39,6 @@ jobs:
           cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
       - name: Assemble debug APK
         run: ./gradlew :app:assembleGplayDebug $CI_GRADLE_ARG_PROPERTIES
-        if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch'
         env:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
           ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
@@ -62,8 +56,7 @@ jobs:
   maestro-cloud:
     name: Maestro test suite
     runs-on: ubuntu-latest
-    needs: build-apk
-    if: github.event_name == 'workflow_dispatch' || github.event.label.name == 'Run-Maestro'
+    needs: [build-apk]
     # Allow one per PR.
     concurrency:
       group: ${{ format('maestro-{0}', github.ref) }}
@@ -74,23 +67,45 @@ jobs:
         with:
           # Ensure we are building the branch and not the branch after being merged on develop
           # https://github.com/actions/checkout/issues/881
-          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}
+          ref: ${{ github.ref }}
       - name: Download APK artifact from previous job
         uses: actions/download-artifact@v4
         with:
           name: elementx-apk-maestro
-      - uses: mobile-dev-inc/[email protected]
-        if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch'
+      - name: Enable KVM group perms
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+      - name: Install maestro
+        run: curl -fsSL "https://get.maestro.mobile.dev" | bash
+      - name: Run Maestro tests in emulator
+        uses: reactivecircus/android-emulator-runner@v2
+        continue-on-error: true
+        env:
+          MAESTRO_USERNAME: maestroelement
+          MAESTRO_PASSWORD: ${{ secrets.MATRIX_MAESTRO_ACCOUNT_PASSWORD }}
+          MAESTRO_RECOVERY_KEY: ${{ secrets.MATRIX_MAESTRO_ACCOUNT_RECOVERY_KEY }}
+          MAESTRO_ROOM_NAME: MyRoom
+          MAESTRO_INVITEE1_MXID: "@maestroelement2:matrix.org"
+          MAESTRO_INVITEE2_MXID: "@maestroelement3:matrix.org"
+          MAESTRO_APP_ID: io.element.android.x.debug
         with:
-          api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
-          # Doc says (https://github.com/mobile-dev-inc/action-maestro-cloud#android):
-          # app-file should point to an x86 compatible APK file, so upload the x86_64 one (much smaller than the universal APK).
-          app-file: app-gplay-x86_64-debug.apk
-          env: |
-            MAESTRO_USERNAME=maestroelement
-            MAESTRO_PASSWORD=${{ secrets.MATRIX_MAESTRO_ACCOUNT_PASSWORD }}
-            MAESTRO_RECOVERY_KEY=${{ secrets.MATRIX_MAESTRO_ACCOUNT_RECOVERY_KEY }}
-            MAESTRO_ROOM_NAME=MyRoom
-            MAESTRO_INVITEE1_MXID=@maestroelement2:matrix.org
-            MAESTRO_INVITEE2_MXID=@maestroelement3:matrix.org
-            MAESTRO_APP_ID=io.element.android.x.debug
+          api-level: ${{ env.API_LEVEL }}
+          arch: ${{ env.ARCH }}
+          profile: ${{ env.DEVICE }}
+          target: ${{ env.TARGET }}
+          emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          disable-animations: true
+          disk-size: 3G
+          script: |
+            .github/workflows/scripts/maestro/maestro-local-with-screen-recording.sh app-gplay-x86_64-debug.apk
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: |
+            ~/.maestro/tests/**
+          retention-days: 5
+          overwrite: true
+          if-no-files-found: error

.github/workflows/nightly.yml

@@ -29,6 +29,7 @@ jobs:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
           ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
           ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
+          ELEMENT_ANDROID_SENTRY_DSN: ${{ secrets.ELEMENT_ANDROID_SENTRY_DSN }}
           ELEMENT_ANDROID_NIGHTLY_KEYID: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_KEYID }}
           ELEMENT_ANDROID_NIGHTLY_KEYPASSWORD: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_KEYPASSWORD }}
           ELEMENT_ANDROID_NIGHTLY_STOREPASSWORD: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_STOREPASSWORD }}

.github/workflows/nightly_enterprise.yml

@@ -35,6 +35,7 @@ jobs:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
           ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
           ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
+          ELEMENT_ANDROID_SENTRY_DSN: ${{ secrets.ELEMENT_ANDROID_SENTRY_DSN }}
           ELEMENT_ANDROID_NIGHTLY_KEYID: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_KEYID }}
           ELEMENT_ANDROID_NIGHTLY_KEYPASSWORD: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_KEYPASSWORD }}
           ELEMENT_ANDROID_NIGHTLY_STOREPASSWORD: ${{ secrets.ELEMENT_ANDROID_NIGHTLY_STOREPASSWORD }}

.github/workflows/release.yml

@@ -31,6 +31,7 @@ jobs:
           ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }}
           ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }}
           ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }}
+          ELEMENT_ANDROID_SENTRY_DSN: ${{ secrets.ELEMENT_ANDROID_SENTRY_DSN }}
         run: ./gradlew bundleGplayRelease $CI_GRADLE_ARG_PROPERTIES
       - name: Upload bundle as artifact
         uses: actions/upload-artifact@v4

.github/workflows/scripts/maestro/local-recording.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+#
+# Copyright 2024 New Vector Ltd.
+#
+# SPDX-License-Identifier: AGPL-3.0-only
+# Please see LICENSE in the repository root for full details.
+#
+
+COUNT=0
+mkdir -p /data/local/tmp/recordings;
+FILENAME=/data/local/tmp/recordings/testRecording$COUNT.mp4
+while true
+ do
+   ((COUNT++))
+   FILENAME=/data/local/tmp/recordings/testRecording$COUNT.mp4
+   echo "\nRecording video file #$COUNT"
+   screenrecord --bugreport --bit-rate=16m --size 720x1280 $FILENAME
+ done

.github/workflows/scripts/maestro/maestro-local-with-screen-recording.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+#
+# Copyright 2024 New Vector Ltd.
+#
+# SPDX-License-Identifier: AGPL-3.0-only
+# Please see LICENSE in the repository root for full details.
+#
+
+adb install -r $1
+echo "Starting the screen recording..."
+adb push .github/workflows/scripts/maestro/local-recording.sh /data/local/tmp/
+adb shell "chmod +x /data/local/tmp/local-recording.sh"
+adb shell "/data/local/tmp/local-recording.sh & echo \$! > /data/local/tmp/screenrecord_pid.txt" &
+set +e
+~/.maestro/bin/maestro test .maestro/allTests.yaml
+TEST_STATUS=$?
+echo "Test run completed with status $TEST_STATUS"
+
+# Stop the screen recording loop
+SCRIPT_PID=$(adb shell "cat /data/local/tmp/screenrecord_pid.txt")
+adb shell "kill -2 $SCRIPT_PID"
+
+# Get the PID of the screen recording process
+SCREENRECORD_PID=$(adb shell ps | grep screenrecord | awk '{print $2}')
+# Wait for the screen recording process to exit
+while [ ! -z $SCREENRECORD_PID ]; do
+  echo "Waiting for screen recording ($SCREENRECORD_PID) to finish..."
+  adb shell "kill -2 $SCREENRECORD_PID"
+  sleep 1
+  SCREENRECORD_PID=$(adb shell ps | grep screenrecord | awk '{print $2}')
+done
+
+adb pull /data/local/tmp/recordings/ ~/.maestro/tests/
+exit $TEST_STATUS

.github/workflows/scripts/recordScreenshots.sh

@@ -2,8 +2,8 @@
 
 # Copyright 2023-2024 New Vector Ltd.
 #
-# SPDX-License-Identifier: AGPL-3.0-only
-# Please see LICENSE in the repository root for full details.
+# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+# Please see LICENSE files in the repository root for full details.
 
 set -e