Reapply "Merge branch 'release/5.218.0'"

This reverts commit 145d037.

Author: anikiki

.bundle/config

@@ -0,0 +1,4 @@
+---
+BUNDLE_PATH: "/Users/runner/work/Android/Android/vendor/bundle"
+BUNDLE_DEPLOYMENT: "true"
+BUNDLE_JOBS: "4"

.github/workflows/release_create_tag.yml

@@ -0,0 +1,50 @@
+name: Release - Create and Push Tag
+
+on:
+  workflow_dispatch:
+    inputs:
+      app-version:
+        description: 'App Version for Release'
+        required: true
+        default: 'PLACEHOLDER'
+
+env:
+  ASANA_PAT: ${{ secrets.GH_ASANA_SECRET }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  create-tag:
+    name: Create and Push git tag for version
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Set up ruby env
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+          bundler-cache: true
+
+      - name: Use fastlane lane to create and push tagged release
+        id: create_git_tag
+        run: |
+          bundle exec fastlane android tag_and_push_release_version app_version:${{ github.event.inputs.app-version }}
+
+      - name: Create Asana task when workflow failed
+        if: ${{ failure() }}
+        id: create-failure-task
+        uses: duckduckgo/[email protected]
+        with:
+          asana-pat: ${{ secrets.GH_ASANA_SECRET }}
+          asana-project: ${{ vars.GH_ANDROID_APP_PROJECT_ID }}
+          asana-section: ${{ vars.GH_ANDROID_APP_INCOMING_SECTION_ID }}
+          asana-task-name: GH Workflow Failure - Tag Android Release
+          asana-task-description: Tag Android Release has failed. See https://github.com/duckduckgo/Android/actions/runs/${{ github.run_id }}
+          action: 'create-asana-task'

.github/workflows/release_create_task.yml

@@ -1,4 +1,4 @@
-name: Create Android App Release Task
+name: Release - Create Release Task in Asana
 
 on:
   workflow_dispatch:

.github/workflows/release_production.yml

@@ -0,0 +1,38 @@
+name: Release - Android App Production Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      app-version:
+        description: 'App Version for Release'
+        required: true
+        default: 'PLACEHOLDER'
+
+env:
+  ASANA_PAT: ${{ secrets.GH_ASANA_SECRET }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+    create_release_task:
+      uses: ./.github/workflows/release_create_task.yml
+      with:
+        app-version: ${{ github.event.inputs.app-version }}
+
+    create_release_tag:
+      needs: create_release_task
+      uses: ./.github/workflows/release_create_tag.yml
+      with:
+        app-version: ${{ github.event.inputs.app-version }}
+
+    launch_release_tests:
+      needs: create_release_tag
+      uses: ./.github/workflows/release_tests.yml
+      with:
+        app-version: ${{ github.event.inputs.app-version }}
+
+    report_workflow_failed:
+      if: ${{ failure() }}
+      uses: ./.github/workflows/release_report_error.yml

.github/workflows/release_report_error.yml

@@ -0,0 +1,27 @@
+name: Report Workflow Failed
+
+on:
+  workflow_dispatch:
+
+env:
+  ASANA_PAT: ${{ secrets.GH_ASANA_SECRET }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  report-release-error:
+    name: Create Asana Task
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Create Asana task when workflow failed
+        uses: honeycombio/gha-create-asana-task@main
+        with:
+          asana-secret: ${{ secrets.GH_ASANA_SECRET }}
+          asana-workspace-id: ${{ secrets.GH_ASANA_WORKSPACE_ID }}
+          asana-project-id: ${{ secrets.GH_ASANA_AOR_PROJECT_ID }}
+          asana-section-id: ${{ secrets.GH_ASANA_INCOMING_ID }}
+          asana-task-name: GH Workflow Failure - Production Release
+          asana-task-description: The end to end workflow has failed. See https://github.com/duckduckgo/Android/actions/runs/${{ github.run_id }}

.github/workflows/release_tests.yml

@@ -0,0 +1,84 @@
+name: Run Release Tests in Maestro
+
+on:
+  workflow_dispatch:
+    inputs:
+      app-version:
+        description: 'App Version for Release'
+        required: true
+        default: 'PLACEHOLDER'
+
+env:
+  ASANA_PAT: ${{ secrets.GH_ASANA_SECRET }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  run-release-tests:
+    name: Run Release tests of tag version in Maestro
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          ref: ${{ github.event.inputs.app-version }}
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Create folder
+        if: always()
+        run: mkdir apk
+
+      - name: Decode keys
+        uses: davidSchuppa/base64Secret-toFile-action@v2
+        with:
+          secret: ${{ secrets.FAKE_RELEASE_PROPERTIES }}
+          fileName: ddg_android_build.properties
+          destination-path: $HOME/jenkins_static/com.duckduckgo.mobile.android/
+
+      - name: Decode key file
+        uses: davidSchuppa/base64Secret-toFile-action@v2
+        with:
+          secret: ${{ secrets.FAKE_RELEASE_KEY }}
+          fileName: android
+          destination-path: $HOME/jenkins_static/com.duckduckgo.mobile.android/
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+
+      - name: Assemble release APK
+        run: ./gradlew assemblePlayRelease -Pforce-default-variant
+
+      - name: Move APK to new folder
+        if: always()
+        run: find . -name "*.apk"  -exec mv '{}' apk/release.apk \;
+
+      - name: Release tests flows
+        uses: mobile-dev-inc/[email protected]
+        with:
+          api-key: ${{ secrets.MOBILE_DEV_API_KEY }}
+          name: ${{ github.sha }}
+          app-file: apk/release.apk
+          android-api-level: 30
+          workspace: .maestro
+          include-tags: releaseTest
+
+      - name: Create Asana task when workflow failed
+        if: ${{ failure() }}
+        id: create-failure-task
+        uses: duckduckgo/[email protected]
+        with:
+          asana-pat: ${{ secrets.GH_ASANA_SECRET }}
+          asana-project: ${{ vars.GH_ANDROID_APP_PROJECT_ID }}
+          asana-section: ${{ vars.GH_ANDROID_APP_INCOMING_SECTION_ID }}
+          asana-task-name: GH Workflow Failure - Tag Android Release
+          asana-task-description: Tag Android Release has failed. See https://github.com/duckduckgo/Android/actions/runs/${{ github.run_id }}
+          action: 'create-asana-task'

Gemfile.lock

@@ -106,6 +106,9 @@ GEM
       xcodeproj (>= 1.13.0, < 2.0.0)
       xcpretty (~> 0.3.0)
       xcpretty-travis-formatter (>= 0.0.3)
+    fastlane-plugin-firebase_app_distribution (0.9.1)
+      google-apis-firebaseappdistribution_v1 (~> 0.3.0)
+      google-apis-firebaseappdistribution_v1alpha (~> 0.2.0)
     fastlane-plugin-property_file_read (1.0.1)
     gh_inspector (1.1.3)
     google-apis-androidpublisher_v3 (0.53.0)
@@ -119,6 +122,10 @@ GEM
       retriable (>= 2.0, < 4.a)
       rexml
       webrick
+    google-apis-firebaseappdistribution_v1 (0.3.0)
+      google-apis-core (>= 0.11.0, < 2.a)
+    google-apis-firebaseappdistribution_v1alpha (0.2.0)
+      google-apis-core (>= 0.11.0, < 2.a)
     google-apis-iamcredentials_v1 (0.17.0)
       google-apis-core (>= 0.11.0, < 2.a)
     google-apis-playcustomapp_v1 (0.13.0)
@@ -213,6 +220,7 @@ PLATFORMS
 
 DEPENDENCIES
   fastlane
+  fastlane-plugin-firebase_app_distribution
   fastlane-plugin-property_file_read
 
 BUNDLED WITH

anvil/anvil-compiler/src/main/java/com/duckduckgo/anvil/compiler/ContributesRemoteFeatureCodeGenerator.kt

@@ -107,6 +107,7 @@ class ContributesRemoteFeatureCodeGenerator : CodeGenerator {
                                     )
                                     .build(),
                             )
+                            .addParameter("callback", featureTogglesCallback.asClassName(module))
                             .addParameter("appBuildConfig", appBuildConfig.asClassName(module))
                             .addParameter("variantManager", variantManager.asClassName(module))
                             .addCode(
@@ -118,6 +119,7 @@ class ContributesRemoteFeatureCodeGenerator : CodeGenerator {
                                 .featureName(%S)
                                 .appVariantProvider({ appBuildConfig.variantName })
                                 .localeProvider({ appBuildConfig.deviceLocale })
+                                .callback(callback)
                                 // save empty variants will force the default variant to be set
                                 .forceDefaultVariantProvider({ variantManager.updateVariants(emptyList()) })
                                 .build()
@@ -1151,6 +1153,7 @@ class ContributesRemoteFeatureCodeGenerator : CodeGenerator {
         private val context = FqName("android.content.Context")
         private val privacyFeaturePlugin = FqName("com.duckduckgo.privacy.config.api.PrivacyFeaturePlugin")
         private val appBuildConfig = FqName("com.duckduckgo.appbuildconfig.api.AppBuildConfig")
+        private val featureTogglesCallback = FqName("com.duckduckgo.feature.toggles.internal.api.FeatureTogglesCallback")
         private val variantManager = FqName("com.duckduckgo.experiments.api.VariantManager")
         private val buildFlavorInternal = FqName("com.duckduckgo.appbuildconfig.api.BuildFlavor.INTERNAL")
         private val moshi = FqName("com.squareup.moshi.Moshi")

app-tracking-protection/vpn-api/src/main/java/com/duckduckgo/mobile/android/vpn/Vpn.kt

@@ -26,7 +26,15 @@ interface Vpn {
     suspend fun start()
 
     /**
-     * Disable the device VPN by stopping the VPN service
+     * Pauses the VPN tunnel.
+     * All features that were registered to use the VPN tunnel (eg. AppTP, NetP) continue to be registered and so a subsequent
+     * [start] call will re-enable them all
+     */
+    suspend fun pause()
+
+    /**
+     * Stops the VPN tunnel AND all features registered to use the VPN tunnel (eg. AppTP, NetP). A subsequent call to [start]
+     * will not re-start the VPN because no feature would be registered.
      */
     suspend fun stop()
 

app-tracking-protection/vpn-impl/src/main/java/com/duckduckgo/mobile/android/vpn/VpnFeaturesRegistryImpl.kt

@@ -21,20 +21,33 @@ import android.content.SharedPreferences
 import androidx.core.content.edit
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.data.store.api.SharedPreferencesProvider
+import com.duckduckgo.di.scopes.AppScope
 import com.duckduckgo.mobile.android.vpn.service.TrackerBlockingVpnService
+import com.squareup.anvil.annotations.ContributesBinding
+import dagger.SingleInstanceIn
 import java.util.UUID
+import javax.inject.Inject
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.withContext
 import logcat.logcat
 
 private const val PREFS_FILENAME = "com.duckduckgo.mobile.android.vpn.feature.registry.v1"
 private const val IS_INITIALIZED = "IS_INITIALIZED"
 
-internal class VpnFeaturesRegistryImpl(
+@ContributesBinding(
+    scope = AppScope::class,
+    boundType = VpnFeaturesRegistry::class,
+)
+@ContributesBinding(
+    scope = AppScope::class,
+    boundType = Vpn::class,
+)
+@SingleInstanceIn(AppScope::class)
+class VpnFeaturesRegistryImpl @Inject constructor(
     private val vpnServiceWrapper: VpnServiceWrapper,
     private val sharedPreferencesProvider: SharedPreferencesProvider,
     private val dispatcherProvider: DispatcherProvider,
-) : VpnFeaturesRegistry {
+) : VpnFeaturesRegistry, Vpn {
 
     private val mutex = Mutex()
 
@@ -103,6 +116,34 @@ internal class VpnFeaturesRegistryImpl(
     private fun registeredFeatures(): Map<String, Any?> {
         return preferences.all.filter { it.key != IS_INITIALIZED }
     }
+
+    override suspend fun start() = withContext(dispatcherProvider.io()) {
+        vpnServiceWrapper.startService()
+    }
+
+    override suspend fun pause() {
+        vpnServiceWrapper.stopService()
+    }
+
+    override suspend fun stop() {
+        try {
+            mutex.lock()
+            // unregister all features
+            getRegisteredFeatures().onEach {
+                preferences.edit(commit = true) {
+                    remove(it.featureName)
+                }
+            }
+            // stop VPN
+            vpnServiceWrapper.stopService()
+        } finally {
+            mutex.unlock()
+        }
+    }
+
+    override suspend fun snooze(triggerAtMillis: Long) {
+        vpnServiceWrapper.snoozeService(triggerAtMillis)
+    }
 }
 
 /**
@@ -111,10 +152,9 @@ internal class VpnFeaturesRegistryImpl(
  *
  * The class is marked as open to be able to mock it in tests.
  */
-internal open class VpnServiceWrapper(
+open class VpnServiceWrapper @Inject constructor(
     private val context: Context,
-    private val dispatcherProvider: DispatcherProvider,
-) : Vpn {
+) {
     open fun restartVpnService(forceRestart: Boolean) {
         TrackerBlockingVpnService.restartVpnService(context, forceRestart = forceRestart)
     }
@@ -127,19 +167,11 @@ internal open class VpnServiceWrapper(
         TrackerBlockingVpnService.startService(context)
     }
 
-    open fun isServiceRunning(): Boolean {
-        return TrackerBlockingVpnService.isServiceRunning(context)
-    }
-
-    override suspend fun start() = withContext(dispatcherProvider.io()) {
-        startService()
-    }
-
-    override suspend fun stop() = withContext(dispatcherProvider.io()) {
-        stopService()
+    open fun snoozeService(triggerAtMillis: Long) {
+        TrackerBlockingVpnService.snoozeService(context, triggerAtMillis)
     }
 
-    override suspend fun snooze(triggerAtMillis: Long) {
-        TrackerBlockingVpnService.snoozeService(context, triggerAtMillis)
+    open fun isServiceRunning(): Boolean {
+        return TrackerBlockingVpnService.isServiceRunning(context)
     }
 }