Merge branch 'hotfix/5.210.1'

Author: karlenDimla

anvil/anvil-annotations/src/main/java/com/duckduckgo/anvil/annotations/ContributesActivePlugin.kt

@@ -60,4 +60,16 @@ annotation class ContributesActivePlugin(
      * The [ContributesActivePlugin] coalesce both
      */
     val priority: Int = 0,
+
+    /**
+     * When `true` the backing feature flag supports experimentation. Otherwise it will be a regular feature flag.
+     *
+     * When `true` the (generated) backing feature flag is annotated with the [Experiment] annotation (read its JavaDoc)
+     */
+    val supportExperiments: Boolean = false,
+
+    /**
+     * When `true` the backing feature flag will ALWAYS be enabled for internal builds, regardless of remote config or default value.
+     */
+    val internalAlwaysEnabled: Boolean = false,
 )

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

@@ -23,6 +23,8 @@ import com.duckduckgo.anvil.annotations.ContributesRemoteFeature
 import com.duckduckgo.anvil.annotations.PriorityKey
 import com.duckduckgo.feature.toggles.api.RemoteFeatureStoreNamed
 import com.duckduckgo.feature.toggles.api.Toggle
+import com.duckduckgo.feature.toggles.api.Toggle.Experiment
+import com.duckduckgo.feature.toggles.api.Toggle.InternalAlwaysEnabled
 import com.google.auto.service.AutoService
 import com.squareup.anvil.annotations.ContributesBinding
 import com.squareup.anvil.annotations.ContributesMultibinding
@@ -314,6 +316,12 @@ class ContributesActivePluginPointCodeGenerator : CodeGenerator {
         val pluginRemoteFeatureClassName = "${vmClass.shortName}_ActivePlugin_RemoteFeature"
         val pluginRemoteFeatureStoreClassName = "${vmClass.shortName}_ActivePlugin_RemoteFeature_MultiProcessStore"
         val pluginPriority = vmClass.annotations.firstOrNull { it.fqName == ContributesActivePlugin::class.fqName }?.priorityOrNull()
+        val pluginSupportExperiments = vmClass.annotations.firstOrNull {
+            it.fqName == ContributesActivePlugin::class.fqName
+        }?.isExperimentOrNull() ?: false
+        val pluginInternalAlwaysEnabled = vmClass.annotations.firstOrNull {
+            it.fqName == ContributesActivePlugin::class.fqName
+        }?.internalAlwaysEnabledOrNull() ?: false
 
         // Check if there's another plugin class, in the same plugin point, that has the same class simplename
         // we can't allow that because the backing remote feature would be the same
@@ -403,14 +411,24 @@ class ContributesActivePluginPointCodeGenerator : CodeGenerator {
                             .build(),
                     )
                     addFunction(
-                        FunSpec.builder(featureName)
-                            .addModifiers(ABSTRACT)
-                            .addAnnotation(
+                        FunSpec.builder(featureName).apply {
+                            addModifiers(ABSTRACT)
+                            addAnnotation(
                                 AnnotationSpec.builder(Toggle.DefaultValue::class)
                                     .addMember("defaultValue = %L", featureDefaultValue)
                                     .build(),
                             )
-                            .returns(Toggle::class)
+                            // If the active plugin defines [supportExperiments = true] we mark it as Experiment
+                            if (pluginSupportExperiments) {
+                                addAnnotation(AnnotationSpec.builder(Experiment::class).build())
+                            }
+                            // If the active plugin defines [internalAlwaysEnabled = true] we mark it as InternalAlwaysEnabled
+                            if (pluginInternalAlwaysEnabled) {
+                                addAnnotation(AnnotationSpec.builder(InternalAlwaysEnabled::class).build())
+                            }
+
+                            returns(Toggle::class)
+                        }
                             .build(),
                     )
                 }.build(),
@@ -579,6 +597,12 @@ class ContributesActivePluginPointCodeGenerator : CodeGenerator {
     @OptIn(ExperimentalAnvilApi::class)
     private fun AnnotationReference.priorityOrNull(): Int? = argumentAt("priority", 3)?.value()
 
+    @OptIn(ExperimentalAnvilApi::class)
+    private fun AnnotationReference.isExperimentOrNull(): Boolean? = argumentAt("supportExperiments", 4)?.value()
+
+    @OptIn(ExperimentalAnvilApi::class)
+    private fun AnnotationReference.internalAlwaysEnabledOrNull(): Boolean? = argumentAt("internalAlwaysEnabled", 5)?.value()
+
     private fun ClassReference.Psi.pluginClassName(
         fqName: FqName,
     ): ClassName? {

app/src/main/java/com/duckduckgo/app/browser/BrowserTabFragment.kt

@@ -3551,13 +3551,15 @@ class BrowserTabFragment :
                 if (viewState.showSuggestions || viewState.showFavorites) {
                     if (viewState.favorites.isNotEmpty() && viewState.showFavorites) {
                         showFocusedView()
+                        viewModel.autoCompleteSuggestionsGone()
                         binding.autoCompleteSuggestionsList.gone()
                     } else {
                         binding.autoCompleteSuggestionsList.show()
                         autoCompleteSuggestionsAdapter.updateData(viewState.searchResults.query, viewState.searchResults.suggestions)
                         hideFocusedView()
                     }
                 } else {
+                    viewModel.autoCompleteSuggestionsGone()
                     binding.autoCompleteSuggestionsList.gone()
                     hideFocusedView()
                 }

app/src/main/java/com/duckduckgo/app/browser/newtab/FocusedViewProvider.kt

@@ -50,6 +50,7 @@ class RealFocusedViewProvider @Inject constructor(
     scope = ActivityScope::class,
     boundType = FocusedViewPlugin::class,
     priority = 100,
+    supportExperiments = true,
 )
 class FocusedLegacyPage @Inject constructor() : FocusedViewPlugin {
 
@@ -65,6 +66,8 @@ class FocusedLegacyPage @Inject constructor() : FocusedViewPlugin {
     boundType = FocusedViewPlugin::class,
     priority = 0,
     defaultActiveValue = false,
+    supportExperiments = true,
+    internalAlwaysEnabled = true,
 )
 class FocusedPage @Inject constructor() : FocusedViewPlugin {
 

app/src/main/java/com/duckduckgo/app/browser/tabpreview/TabEntityDiffCallback.kt

@@ -22,7 +22,7 @@ import com.duckduckgo.app.tabs.model.TabEntity
 
 class TabEntityDiffCallback(
     private val oldList: List<TabEntity>,
-    var newList: List<TabEntity>,
+    private val newList: List<TabEntity>,
 ) : DiffUtil.Callback() {
 
     private fun areItemsTheSame(

app/src/main/java/com/duckduckgo/app/global/api/PixelParamRemovalInterceptor.kt

@@ -83,6 +83,7 @@ object PixelInterceptorPixelsRequiringDataCleaning : PixelParamRemovalPlugin {
             StatisticsPixelName.BROWSER_DAILY_ACTIVE_FEATURE_STATE.pixelName to PixelParameter.removeAll(),
             WebViewPixelName.WEB_PAGE_LOADED.pixelName to PixelParameter.removeAll(),
             WebViewPixelName.WEB_PAGE_PAINTED.pixelName to PixelParameter.removeAll(),
+            AppPixelName.REFERRAL_INSTALL_UTM_CAMPAIGN.pixelName to PixelParameter.removeAtb(),
         )
     }
 }

app/src/main/java/com/duckduckgo/app/pixels/AppPixelName.kt

@@ -347,4 +347,6 @@ enum class AppPixelName(override val pixelName: String) : Pixel.PixelName {
     TAB_MANAGER_REARRANGE_BANNER_DISPLAYED("m_tab_manager_rearrange_banner_displayed"),
 
     ADD_BOOKMARK_CONFIRM_EDITED("m_add_bookmark_confirm_edit"),
+
+    REFERRAL_INSTALL_UTM_CAMPAIGN("m_android_install"),
 }

app/src/main/java/com/duckduckgo/app/referral/AppInstallationReferrerParser.kt

@@ -32,11 +32,18 @@ interface AppInstallationReferrerParser {
 
 @Suppress("SameParameterValue")
 @ContributesBinding(AppScope::class)
-class QueryParamReferrerParser @Inject constructor() : AppInstallationReferrerParser {
+class QueryParamReferrerParser @Inject constructor(
+    private val originAttributeHandler: ReferrerOriginAttributeHandler,
+) : AppInstallationReferrerParser {
 
     override fun parse(referrer: String): ParsedReferrerResult {
+        Timber.v("Full referrer string: %s", referrer)
+
         val referrerParts = splitIntoConstituentParts(referrer)
-        if (referrerParts.isNullOrEmpty()) return ReferrerNotFound(fromCache = false)
+        if (referrerParts.isEmpty()) return ReferrerNotFound(fromCache = false)
+
+        // processing this doesn't change anything with the ATB-based campaign referrer or EU search/ballot logic
+        originAttributeHandler.process(referrerParts)
 
         val auctionReferrer = extractEuAuctionReferrer(referrerParts)
         if (auctionReferrer is EuAuctionSearchChoiceReferrerFound || auctionReferrer is EuAuctionBrowserChoiceReferrerFound) {
@@ -60,7 +67,7 @@ class QueryParamReferrerParser @Inject constructor() : AppInstallationReferrerPa
             }
         }
 
-        Timber.d("App not installed as a result of EU auction")
+        Timber.d("No EU referrer data found; app not installed as a result of EU auction or choice screen")
         return ReferrerNotFound()
     }
 
@@ -101,8 +108,8 @@ class QueryParamReferrerParser @Inject constructor() : AppInstallationReferrerPa
         return fullCampaignName.substringAfter(prefix, "")
     }
 
-    private fun splitIntoConstituentParts(referrer: String?): List<String>? {
-        return referrer?.split("&")
+    private fun splitIntoConstituentParts(referrer: String?): List<String> {
+        return referrer?.split("&") ?: emptyList()
     }
 
     companion object {
@@ -124,7 +131,7 @@ sealed class ParsedReferrerResult(open val fromCache: Boolean = false) {
 
     data class ReferrerNotFound(override val fromCache: Boolean = false) : ParsedReferrerResult(fromCache)
     data class ParseFailure(val reason: ParseFailureReason) : ParsedReferrerResult()
-    object ReferrerInitialising : ParsedReferrerResult()
+    data object ReferrerInitialising : ParsedReferrerResult()
 }
 
 sealed class ParseFailureReason {

app/src/main/java/com/duckduckgo/app/referral/AppReferrerDataStore.kt

@@ -28,6 +28,7 @@ interface AppReferrerDataStore {
     var referrerCheckedPreviously: Boolean
     var campaignSuffix: String?
     var installedFromEuAuction: Boolean
+    var utmOriginAttributeCampaign: String?
 }
 
 @ContributesBinding(AppScope::class)
@@ -37,6 +38,10 @@ class AppReferenceSharePreferences @Inject constructor(private val context: Cont
         get() = preferences.getString(KEY_CAMPAIGN_SUFFIX, null)
         set(value) = preferences.edit(true) { putString(KEY_CAMPAIGN_SUFFIX, value) }
 
+    override var utmOriginAttributeCampaign: String?
+        get() = preferences.getString(KEY_ORIGIN_ATTRIBUTE_CAMPAIGN, null)
+        set(value) = preferences.edit(true) { putString(KEY_ORIGIN_ATTRIBUTE_CAMPAIGN, value) }
+
     override var referrerCheckedPreviously: Boolean
         get() = preferences.getBoolean(KEY_CHECKED_PREVIOUSLY, false)
         set(value) = preferences.edit(true) { putBoolean(KEY_CHECKED_PREVIOUSLY, value) }
@@ -50,6 +55,7 @@ class AppReferenceSharePreferences @Inject constructor(private val context: Cont
     companion object {
         const val FILENAME = "com.duckduckgo.app.referral"
         private const val KEY_CAMPAIGN_SUFFIX = "KEY_CAMPAIGN_SUFFIX"
+        private const val KEY_ORIGIN_ATTRIBUTE_CAMPAIGN = "KEY_ORIGIN_ATTRIBUTE_CAMPAIGN"
         private const val KEY_CHECKED_PREVIOUSLY = "KEY_CHECKED_PREVIOUSLY"
         private const val KEY_INSTALLED_FROM_EU_AUCTION = "KEY_INSTALLED_FROM_EU_AUCTION"
     }

app/src/main/java/com/duckduckgo/app/referral/ReferrerOriginAttributeHandler.kt

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2024 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+package com.duckduckgo.app.referral
+
+import com.duckduckgo.di.scopes.AppScope
+import com.duckduckgo.verifiedinstallation.installsource.VerificationCheckPlayStoreInstall
+import com.squareup.anvil.annotations.ContributesBinding
+import javax.inject.Inject
+import timber.log.Timber
+
+interface ReferrerOriginAttributeHandler {
+    fun process(referrerParts: List<String>)
+}
+
+@ContributesBinding(AppScope::class)
+class ReferrerOriginAttributeHandlerImpl @Inject constructor(
+    private val appReferrerDataStore: AppReferrerDataStore,
+    private val playStoreInstallChecker: VerificationCheckPlayStoreInstall,
+) : ReferrerOriginAttributeHandler {
+
+    override fun process(referrerParts: List<String>) {
+        runCatching {
+            Timber.v("Looking for origin attribute referrer data")
+            var originAttributePart = extractOriginAttribute(referrerParts)
+
+            if (originAttributePart == null && playStoreInstallChecker.installedFromPlayStore()) {
+                Timber.v("No origin attribute referrer data available; assigning one")
+                originAttributePart = DEFAULT_ATTRIBUTION_FOR_PLAY_STORE_INSTALLS
+            }
+
+            persistOriginAttribute(originAttributePart)
+        }
+    }
+
+    private fun extractOriginAttribute(referrerParts: List<String>): String? {
+        val originAttributePart = referrerParts.find { it.startsWith("$ORIGIN_ATTRIBUTE_KEY=") }
+        if (originAttributePart == null) {
+            Timber.v("Did not find referrer origin attribute key")
+            return null
+        }
+
+        Timber.v("Found referrer origin attribute: %s", originAttributePart)
+
+        return originAttributePart.removePrefix("$ORIGIN_ATTRIBUTE_KEY=").also {
+            Timber.i("Found referrer origin attribute value: %s", it)
+        }
+    }
+
+    private fun persistOriginAttribute(originAttributePart: String?) {
+        appReferrerDataStore.utmOriginAttributeCampaign = originAttributePart
+    }
+
+    companion object {
+        const val ORIGIN_ATTRIBUTE_KEY = "origin"
+        const val DEFAULT_ATTRIBUTION_FOR_PLAY_STORE_INSTALLS = "funnel_playstore"
+    }
+}