Merge remote-tracking branch 'upstream/develop' into develop

.github/workflows/build.yml

@@ -54,6 +54,16 @@ jobs:
           path: |
             app/build/outputs/apk/gplay/debug/*-universal-debug.apk
             app/build/outputs/apk/fdroid/debug/*-universal-debug.apk
+      - 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

.github/workflows/maestro.yml → .github/workflows/maestro-local.yml

@@ -1,40 +1,39 @@
-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]
+  workflow_run:
+    workflows: [APK Build]
+    types:
+      - completed
 
 # 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'
+    if: github.event_name == 'workflow_dispatch'
     # 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 +43,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 +60,9 @@ 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]
+    # Only if the APKs were built successfully.
+    if: github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success'
     # Allow one per PR.
     concurrency:
       group: ${{ format('maestro-{0}', github.ref) }}
@@ -74,23 +73,52 @@ 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 'Build APKs' flow
+        uses: actions/download-artifact@v4
+        if: github.event.workflow_run.conclusion == 'success'
+        with:
+          name: elementx-apk-maestro
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Download APK artifact from previous job
         uses: actions/download-artifact@v4
+        if: github.event_name == 'workflow_dispatch'
         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
+        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-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:
-          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
+          name: test-results
+          path: |
+            ~/.maestro/tests/**
+          retention-days: 5
+          overwrite: true
+          if-no-files-found: error

.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,36 @@
+#!/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
+set -x
+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
 

.maestro/tests/account/changeServer.yaml

@@ -11,6 +11,9 @@ appId: ${MAESTRO_APP_ID}
     id: "change_server-server"
 - inputText: "element"
 - hideKeyboard
+- extendedWaitUntil:
+    visible: "element.io"
+    timeout: 10000
 - tapOn: "element.io"
 # Revert to matrix.org
 - tapOn:

.maestro/tests/roomList/createAndDeleteRoom.yaml

@@ -26,6 +26,10 @@ appId: ${MAESTRO_APP_ID}
 - tapOn: "Invite"
 - tapOn: "Back"
 - tapOn: "aRoomName"
+- scrollUntilVisible:
+    direction: DOWN
+    element:
+      text: "People"
 - tapOn: "People"
 # assert there's 1 member and 2 invitees
 - tapOn: "Back"

LICENSE-COMMERCIAL

@@ -0,0 +1,6 @@
+Licensees holding a valid commercial license with Element may use this
+software in accordance with the terms contained in a written agreement
+between you and Element.
+
+To purchase a commercial license please contact our sales team at 
+[email protected]

README.md

@@ -97,10 +97,12 @@ If after your research you still have a question, ask at [#element-x-android:mat
 
 ## Copyright and License
 
-Copyright New Vector Ltd.
+Copyright (c) 2022 - 2025 New Vector Ltd
 
-Licensed under the AGPL-3.0-only (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the [LICENSE](LICENSE) file, or at:
+This software is dual licensed by New Vector Ltd (Element). It can be used either:
 
-[https://www.gnu.org/licenses/agpl-3.0.txt](https://www.gnu.org/licenses/agpl-3.0.txt)
+(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
 
-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.
+(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).
+
+Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.

anvilannotations/build.gradle.kts

@@ -1,8 +1,8 @@
 /*
  * Copyright 2022-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.
  */
 plugins {
     alias(libs.plugins.kotlin.jvm)

anvilannotations/src/main/kotlin/io/element/android/anvilannotations/ContributesNode.kt

@@ -1,8 +1,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.
  */
 
 package io.element.android.anvilannotations

anvilcodegen/build.gradle.kts

@@ -1,8 +1,8 @@
 /*
  * Copyright 2022-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.
  */
 
 plugins {

anvilcodegen/src/main/kotlin/io/element/android/anvilcodegen/ContributesNodeProcessor.kt

@@ -1,8 +1,8 @@
 /*
  * Copyright 2022-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.
  */
 
 package io.element.android.anvilcodegen

anvilcodegen/src/main/kotlin/io/element/android/anvilcodegen/ContributesNodeProcessorProvider.kt

@@ -1,8 +1,8 @@
 /*
  * Copyright 2022-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.
  */
 
 package io.element.android.anvilcodegen

app/build.gradle.kts

@@ -1,8 +1,8 @@
 /*
  * Copyright 2022-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.
  */
 
 @file:Suppress("UnstableApiUsage")

app/src/main/AndroidManifest.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?><!--
   ~ Copyright 2022 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.
   -->
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:tools="http://schemas.android.com/tools">

app/src/main/kotlin/io/element/android/x/ElementXApplication.kt

@@ -1,8 +1,8 @@
 /*
  * Copyright 2022-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.
  */
 
 package io.element.android.x

app/src/main/kotlin/io/element/android/x/MainActivity.kt

@@ -1,8 +1,8 @@
 /*
  * Copyright 2022-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.
  */
 
 package io.element.android.x

app/src/main/kotlin/io/element/android/x/MainNode.kt

@@ -1,8 +1,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.
  */
 
 package io.element.android.x