test: mitmproxy + low bandwidth + automated QA using detox

.github/actions/bandwidth-throttling/action.yml

@@ -0,0 +1,71 @@
+name: bandwidth-throttling
+description: Action to throttle the bandwidth on MacOS runner
+
+inputs:
+  test_server_host:
+    description: The host of the test server, no protocol
+    required: true
+  download_speed:
+    description: The download speed limit (in Kbit/s)
+    required: false
+    default: "3300"
+  upload_speed:
+    description: The upload speed limit (in Kbit/s)
+    required: false
+    default: "3300"
+  latency:
+    description: The latency (in ms) each way
+    required: false
+    default: "500"
+  disable:
+    description: Disable throttling
+    required: false
+    default: "false"
+
+runs:
+  using: composite
+  steps:
+    - name: disable first
+      if: ${{ inputs.disable == 'true' }}
+      shell: bash
+      continue-on-error: true
+      run: |
+        sudo pfctl -d
+
+        sleep 2;
+
+    - name: throttle bandwidth down
+      shell: bash
+      run: |
+        # reset pf and dnctl
+        sudo dnctl -q flush
+        sudo dnctl -q pipe flush
+        sudo pfctl -f /etc/pf.conf
+        sudo pfctl -E
+
+        sleep 2;
+
+        sudo pfctl -d
+        sudo dnctl -q flush
+        sudo dnctl -q pipe flush
+
+
+        echo "dummynet in from ${{ inputs.test_server_host }} to ! 127.0.0.1 pipe 1
+        dummynet out from ! 127.0.0.1 to ${{ inputs.test_server_host }} pipe 2" | sudo pfctl -f -
+
+        # pipe 1 is download
+        sudo dnctl pipe 1 config bw ${{ inputs.download_speed }}Kbit/s delay ${{ inputs.latency }}ms
+
+        # pipe 2 is upload
+        sudo dnctl pipe 2 config bw ${{ inputs.upload_speed }}Kbit/s delay ${{ inputs.latency }}ms
+
+        sleep 5;
+
+        sudo pfctl -E
+
+        sleep 5;
+
+    - name: test curl after throttling
+      shell: bash
+      run: |
+        curl -o /dev/null -m 20 --retry 2 -s -w 'Total: %{time_total}s\n' 'https://${{ inputs.test_server_host }}/api/v4/system/ping?get_server_status=true'

.github/actions/prepare-low-bandwidth/action.yml

@@ -0,0 +1,106 @@
+name: Prepare Low Bandwidth Environment (MacOS & iOS Simulators only)
+description: prepare any workflow for low bandwidth testing
+
+inputs:
+  test_server_url:
+    description: The URL of the test server
+    required: true
+  device_name:
+    description: The iOS simulator name
+    required: true
+  download_speed:
+    description: The download speed limit (in Kbit/s)
+    required: false
+    default: "3300"
+  upload_speed:
+    description: The upload speed limit (in Kbit/s)
+    required: false
+    default: "3300"
+  latency:
+    description: The latency (in ms) each way
+    required: false
+    default: "500"
+
+
+runs:
+  using: composite
+  steps:
+      - name: delete the zip file and trash (to free up space)
+        shell: bash
+        run: |
+          rm -rf mobile-artifacts/*.zip
+          sudo rm -rf ~/.Trash/*
+
+      - name: check disk space
+        shell: bash
+        run: df -h
+
+      - name: remove protocol from SITE_1_URL
+        id: remove-protocol
+        shell: bash
+        run: |
+          echo "SITE_1_HOST=${{ inputs.test_server_url }}" | sed -e 's/http:\/\///g' -e 's/https:\/\///g' >> ${GITHUB_OUTPUT}
+
+      - name: Throttle Bandwidth 1
+        id: throttle-bandwidth-1
+        continue-on-error: true
+        uses: ./.github/actions/bandwidth-throttling
+        with: 
+          test_server_host: ${{ steps.remove-protocol.outputs.SITE_1_HOST }}
+          download_speed: ${{ inputs.download_speed }}
+          upload_speed: ${{ inputs.upload_speed }}
+          latency: ${{ inputs.latency }}
+
+      - name: Throttle Bandwidth 2
+        if: steps.throttle-bandwidth-1.outcome != 'success'
+        id: throttle-bandwidth-2
+        uses: ./.github/actions/bandwidth-throttling
+        with: 
+          test_server_host: ${{ steps.remove-protocol.outputs.SITE_1_HOST }}
+          download_speed: ${{ inputs.download_speed}}
+          upload_speed: ${{ inputs.upload_speed }}
+          latency: ${{ inputs.latency }}
+          disable: "true"
+
+      - name: Install mitmproxy & pm2 (process manager)
+        id: install-mitmproxy-pm2
+        shell: bash
+        run: |
+          brew install mitmproxy
+
+          npm i -g pm2
+
+      - name: Start mitmproxy via mitmdump and stop it (to get .mitmproxy folder)
+        shell: bash
+        run: |
+          pm2 start mitmdump --log /Users/runner/work/mattermost-mobile/mattermost-mobile/mitmdump.log -- --allow-hosts '${{ steps.remove-protocol.outputs.SITE_1_HOST }}' --ignore-hosts 'localhost' -s /Users/runner/work/mattermost-mobile/mattermost-mobile/scripts/mitmdump-flow-parsing.py
+
+          sleep 5;
+
+          pm2 stop mitmdump
+
+          # we need to wait for mitmdump to stop so it'll produce the .mitmproxy folder  
+          sleep 5;
+
+      - name: Get simulator UDID
+        id: get-simulator-udid
+        shell: bash
+        run: |
+          simulator_udid=$(xcrun simctl list devices "${{ inputs.device_name }}" -j | jq '.devices' | jq '."com.apple.CoreSimulator.SimRuntime.iOS-17-4"[0]["udid"]')
+          echo "simulator_udid="$(echo $simulator_udid) >> ${GITHUB_OUTPUT}
+
+      - name: install certificate
+        shell: bash
+        run: |
+          sudo security add-trusted-cert -d -p ssl -p basic -k /Library/Keychains/System.keychain ~/.mitmproxy/mitmproxy-ca-cert.pem
+
+          # must boot first before adding root cert
+          xcrun simctl boot ${{ steps.get-simulator-udid.outputs.simulator_udid }}
+
+          xcrun simctl keychain booted add-root-cert ~/.mitmproxy/mitmproxy-ca-cert.pem
+
+          sleep 5;
+
+      - name: show me booted simulators
+        shell: bash
+        run: xcrun simctl list devices booted | grep Booted

.github/actions/start-proxy/action.yml

@@ -0,0 +1,36 @@
+name: Start Proxy
+description: Action to throttle the bandwidth on MacOS runner
+
+inputs:
+  test_server_url:
+    description: The host of the test server, no protocol
+    required: true
+
+runs:
+  using: composite
+  steps:
+
+    - name: restart mitmdump
+      shell: bash
+      run: |
+        pm2 restart mitmdump
+
+        sleep 5;
+
+    - name: start proxy
+      shell: bash
+      run: |
+        networksetup -setwebproxy Ethernet "127.0.0.1" "8080"
+        networksetup -setsecurewebproxy Ethernet "127.0.0.1" "8080"
+
+        sleep 5;
+
+        networksetup -getwebproxy Ethernet
+        networksetup -getsecurewebproxy Ethernet
+
+    - name: test curl and direct it into proxy
+      shell: bash
+      run: |
+        curl -o /dev/null -m 20 -s -w 'Total: %{time_total}s\n' '${{ inputs.test_server_url }}/api/v4/system/ping?get_server_status=true'
+
+        curl --proxy "127.0.0.1:8080" -o /dev/null -m 20 -s -w 'Total: %{time_total}s\n' '${{ inputs.test_server_url }}/api/v4/system/ping?get_server_status=true'

.github/workflows/e2e-detox-pr.yml

@@ -1,3 +1,5 @@
+# Can be used to run Detox E2E tests on pull requests for the Mattermost mobile app with low bandwidth
+# by using 'E2E iOS tests for PR (LBW 1)' instead.
 name: Detox E2E Tests PR
 
 on:
@@ -7,10 +9,14 @@ on:
     types:
       - labeled
 
+concurrency:
+  group: "${{ github.workflow }}-${{ github.event.pull_request.number }}"
+  cancel-in-progress: true
+
 jobs:
   update-initial-status:
     runs-on: ubuntu-22.04
-    if: contains(github.event.pull_request.labels.*.name, 'E2E iOS tests for PR')
+    if: contains(github.event.label.name, 'E2E iOS tests for PR')
     steps:
       - uses: mattermost/actions/delivery/update-commit-status@main
         env:
@@ -57,6 +63,7 @@ jobs:
       run-ios-tests: true
       run-type: "PR"
       MOBILE_VERSION: ${{ github.event.pull_request.head.sha }}
+      low_bandwidth_mode: ${{ contains(github.event.label.name,'LBW') && true || false }}
     secrets: inherit
 
   update-final-status:
@@ -87,14 +94,13 @@ jobs:
           script: |
             const iosLabel = 'E2E iOS tests for PR';
             const androidLabel = 'E2E Android tests for PR';
-            const labels = context.payload.pull_request.labels.map(label => label.name);
-
-            if (labels.includes(iosLabel)) {
-              github.rest.issues.removeLabel({
-                issue_number: context.issue.number,
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                name: iosLabel,
-              });
-            }
-
+            context.payload.pull_request.labels.forEach(label => {
+              if (label.name.includes(iosLabel)) {
+                github.rest.issues.removeLabel({
+                  issue_number: context.issue.number,
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  name: label.name,
+                });
+              }
+            });

.github/workflows/e2e-detox-template.yml

@@ -48,6 +48,11 @@ on:
         required: false
         type: string
         default: "iOS 17.0"
+      low_bandwidth_mode:
+        description: "Enable low bandwidth mode"
+        required: false
+        type: boolean
+        default: false
     outputs:
       STATUS:
         value: ${{ jobs.generate-report.outputs.STATUS }}
@@ -123,7 +128,7 @@ jobs:
     if: ${{ inputs.run-ios-tests }}
     runs-on: macos-14
     continue-on-error: true
-    timeout-minutes: 40
+    timeout-minutes: ${{ inputs.low_bandwidth_mode && 80 || 40 }} 
     env:
       IOS: true
     needs:
@@ -154,12 +159,31 @@ jobs:
       - name: Unzip iOS Simulator Build
         run: unzip -o mobile-artifacts/*.zip -d mobile-artifacts/
 
+      - name: Prepare Low Bandwidth Environment
+        id: prepare-low-bandwidth
+        uses: ./.github/actions/prepare-low-bandwidth
+        if: ${{ inputs.low_bandwidth_mode }}
+        with:
+          test_server_url: ${{ env.SITE_1_URL }}
+          device_name: ${{ env.DEVICE_NAME }}
+          # all these value should be configurable
+          download_speed: "3300"
+          upload_speed: "3300"
+          latency: "500"
+
       - name: Start React Native Metro Server
         run: npm run start &
 
       - name: Install Detox Dependencies
         run: cd detox && npm i
 
+      - name: Start Proxy
+        if: ${{ inputs.low_bandwidth_mode }}
+        id: start-proxy
+        uses: ./.github/actions/start-proxy
+        with:
+          test_server_url: ${{ env.SITE_1_URL }}
+
       - name: Run Detox E2E Tests
         continue-on-error: true # Label might have been removed manually
         run: |
@@ -169,6 +193,28 @@ jobs:
         env:
           DETOX_DEVICE_TYPE: ${{ env.DEVICE_NAME }}
           DETOX_OS_VERSION: ${{ env.DEVICE_OS_VERSION }}
+          LOW_BANDWIDTH_MODE: ${{ inputs.low_bandwidth_mode }}
+
+
+      - name: reset network settings
+        if: ${{ inputs.low_bandwidth_mode || failure() }}
+        run: |
+          networksetup -setwebproxystate Ethernet "off"
+          networksetup -setsecurewebproxystate Ethernet "off"
+
+          if (sudo pfctl -q -sa | grep 'Status: Enabled') then sudo pfctl -d; fi 
+          if (command  -v pm2 &> /dev/null) then pm2 stop mitmdump; fi 
+
+          sleep 5;
+
+      - name: Upload mitmdump Flow Output
+        if: ${{ inputs.low_bandwidth_mode }}
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
+        with:
+          name: ios-mitmdump-flow-output-${{ needs.generate-specs.outputs.workflow_hash }}-${{ matrix.runId }}
+          path: |
+            /Users/runner/work/mattermost-mobile/mattermost-mobile/flow-output.csv
+            /Users/runner/work/mattermost-mobile/mattermost-mobile/mitmdump.log
 
       - name: Upload iOS Test Report
         if: always()

detox/e2e/support/utils/index.ts

@@ -62,7 +62,7 @@ export const getAdminAccount = () => {
     };
 };
 
-const SECOND = 1000;
+const SECOND = 1000 * (process.env.LOW_BANDWIDTH_MODE === 'true' ? 5 : 1);
 const MINUTE = 60 * 1000;
 
 export const timeouts = {
@@ -76,3 +76,4 @@ export const timeouts = {
     TWO_MIN: MINUTE * 2,
     FOUR_MIN: MINUTE * 4,
 };
+