WIP

Author: mikescamell

app/build.gradle

@@ -405,6 +405,8 @@ dependencies {
     implementation project(':dax-prompts-api')
     implementation project(':dax-prompts-impl')
 
+    implementation project(':serp-logos-api')
+
     // Deprecated. TODO: Stop using this artifact.
     implementation "androidx.legacy:legacy-support-v4:_"
     debugImplementation Square.leakCanary.android

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

@@ -78,6 +78,7 @@ import androidx.core.net.toUri
 import androidx.core.text.HtmlCompat
 import androidx.core.text.HtmlCompat.FROM_HTML_MODE_LEGACY
 import androidx.core.text.toSpannable
+import androidx.core.view.ViewCompat
 import androidx.core.view.isGone
 import androidx.core.view.isVisible
 import androidx.core.view.postDelayed
@@ -440,6 +441,9 @@ class BrowserTabFragment :
     @Inject
     lateinit var browserAutofill: BrowserAutofill
 
+    @Inject
+    lateinit var serpLogoHandler:
+
     @Inject
     lateinit var faviconManager: FaviconManager
 
@@ -1097,6 +1101,17 @@ class BrowserTabFragment :
         configureCustomTab()
         configureEditModeChangeDetection()
         configureInputScreenLauncher()
+        configureLogoClickListener()
+    }
+
+    private fun configureLogoClickListener() {
+        omnibar.configureLogoClickListener(
+            object : Omnibar.LogoClickListener {
+                override fun onClick(url: String) {
+                    viewModel.onDynamicLogoClicked(url)
+                }
+            },
+        )
     }
 
     private fun configureInputScreenLauncher() {
@@ -2204,7 +2219,6 @@ class BrowserTabFragment :
             is Command.LaunchBookmarksActivity -> {
                 browserActivity?.launchBookmarks()
             }
-
             is Command.StartTrackersExperimentShieldPopAnimation -> showTrackersExperimentShieldPopAnimation()
             is Command.RefreshOmnibar -> renderer.refreshOmnibar()
             is Command.LaunchInputScreen -> {
@@ -2213,7 +2227,18 @@ class BrowserTabFragment :
                     launchInputScreen(query = "")
                 }
             }
-            else -> {
+            is Command.ExtractDDGLogo -> {
+                webView?.let {
+                    serpLogoHandler.evaluate(
+                        webView = it,
+                        onSerpLogoEvaluated = { serpLogo ->
+                            viewModel.onLogoReceived(serpLogo)
+                        },
+                    )
+                }
+            }
+            is Command.ShowEnlargedLogo -> launchEnlargedEasterEggLogoActivity(it.url)
+            null -> {
                 // NO OP
             }
         }
@@ -4828,6 +4853,18 @@ class BrowserTabFragment :
     fun launchTabSwitcherAfterTabsUndeleted() {
         viewModel.onLaunchTabSwitcherAfterTabsUndeletedRequest()
     }
+
+    private fun launchEnlargedEasterEggLogoActivity(logoUrl: String) {
+        ViewCompat.setTransitionName(omnibar.daxIcon, logoUrl)
+
+        val intent = EnlargedEasterEggLogoActivity.intent(requireContext(), logoUrl, logoUrl)
+        val activityOptions = ActivityOptionsCompat.makeSceneTransitionAnimation(
+            requireActivity(),
+            omnibar.daxIcon,
+            logoUrl,
+        )
+        startActivity(intent, activityOptions.toBundle())
+    }
 }
 
 private class JsOrientationHandler {

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

@@ -88,6 +88,7 @@ import com.duckduckgo.app.browser.commands.Command.DownloadImage
 import com.duckduckgo.app.browser.commands.Command.EditWithSelectedQuery
 import com.duckduckgo.app.browser.commands.Command.EmailSignEvent
 import com.duckduckgo.app.browser.commands.Command.EscapeMaliciousSite
+import com.duckduckgo.app.browser.commands.Command.ExtractDDGLogo
 import com.duckduckgo.app.browser.commands.Command.ExtractUrlFromCloakedAmpLink
 import com.duckduckgo.app.browser.commands.Command.FindInPageCommand
 import com.duckduckgo.app.browser.commands.Command.GenerateWebViewPreviewImage
@@ -169,6 +170,8 @@ import com.duckduckgo.app.browser.defaultbrowsing.prompts.AdditionalDefaultBrows
 import com.duckduckgo.app.browser.duckplayer.DUCK_PLAYER_FEATURE_NAME
 import com.duckduckgo.app.browser.duckplayer.DUCK_PLAYER_PAGE_FEATURE_NAME
 import com.duckduckgo.app.browser.duckplayer.DuckPlayerJSHelper
+import com.duckduckgo.app.browser.easteregglogos.EasterEggLogosToggles
+import com.duckduckgo.app.browser.easteregglogos.SerpLogo
 import com.duckduckgo.app.browser.favicon.FaviconManager
 import com.duckduckgo.app.browser.favicon.FaviconSource.ImageFavicon
 import com.duckduckgo.app.browser.favicon.FaviconSource.UrlFavicon
@@ -476,6 +479,7 @@ class BrowserTabViewModel @Inject constructor(
     private val tabManager: TabManager,
     private val addressDisplayFormatter: AddressDisplayFormatter,
     private val onboardingDesignExperimentManager: OnboardingDesignExperimentManager,
+    private val easterEggLogosToggles: EasterEggLogosToggles,
 ) : WebViewClientListener,
     EditSavedSiteListener,
     DeleteBookmarkListener,
@@ -1912,6 +1916,18 @@ class BrowserTabViewModel @Inject constructor(
             viewModelScope.launch {
                 onboardingDesignExperimentManager.onWebPageFinishedLoading(url)
             }
+
+            evaluateSerpLogoState(url)
+        }
+    }
+
+    private fun evaluateSerpLogoState(url: String?) {
+        if (easterEggLogosToggles.feature().isEnabled()) {
+            if (url != null && duckDuckGoUrlDetector.isDuckDuckGoQueryUrl(url)) {
+                command.value = ExtractDDGLogo
+            } else {
+                omnibarViewState.value = currentOmnibarViewState().copy(serpLogo = null)
+            }
         }
     }
 
@@ -4308,6 +4324,15 @@ class BrowserTabViewModel @Inject constructor(
         }
     }
 
+    fun onLogoReceived(serpLogo: SerpLogo) {
+        logcat { "BrowserTabFragment: Received Serp Logo: $serpLogo" }
+        omnibarViewState.postValue(currentOmnibarViewState().copy(serpLogo = serpLogo))
+    }
+
+    fun onDynamicLogoClicked(url: String) {
+        command.value = Command.ShowEnlargedLogo(url)
+    }
+
     companion object {
         private const val FIXED_PROGRESS = 50
 

app/src/main/java/com/duckduckgo/app/browser/commands/Command.kt

@@ -280,4 +280,6 @@ sealed class Command {
     data object StartTrackersExperimentShieldPopAnimation : Command()
     data object RefreshOmnibar : Command()
     data object LaunchInputScreen : Command()
+    data object ExtractDDGLogo : Command()
+    data class ShowEnlargedLogo(val url: String) : Command()
 }

app/src/main/java/com/duckduckgo/app/browser/omnibar/Omnibar.kt

@@ -20,6 +20,7 @@ import android.annotation.SuppressLint
 import android.text.Editable
 import android.view.MotionEvent
 import android.view.View
+import android.widget.ImageView
 import androidx.appcompat.widget.Toolbar
 import androidx.coordinatorlayout.widget.CoordinatorLayout
 import androidx.core.view.postDelayed
@@ -164,6 +165,10 @@ class Omnibar(
         )
     }
 
+    interface LogoClickListener {
+        fun onClick(url: String)
+    }
+
     data class OmnibarTextState(
         val text: String,
         val hasFocus: Boolean,
@@ -249,6 +254,10 @@ class Omnibar(
         newOmnibar.shieldIconExperiment
     }
 
+    val daxIcon: ImageView by lazy {
+        newOmnibar.daxIcon
+    }
+
     val textInputRootView: View by lazy {
         newOmnibar.omnibarTextInput.rootView
     }
@@ -299,6 +308,10 @@ class Omnibar(
         newOmnibar.setOmnibarItemPressedListener(listener)
     }
 
+    fun configureLogoClickListener(logoClickListener: LogoClickListener) {
+        newOmnibar.setLogoClickListener(logoClickListener)
+    }
+
     fun configureOmnibarItemPressedListeners(listener: OmnibarItemPressedListener) {
         val omnibar = newOmnibar
         if (omnibar is FadeOmnibarLayout) {

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayout.kt

@@ -48,12 +48,15 @@ import androidx.lifecycle.findViewTreeViewModelStoreOwner
 import androidx.lifecycle.flowWithLifecycle
 import androidx.lifecycle.lifecycleScope
 import com.airbnb.lottie.LottieAnimationView
+import com.bumptech.glide.Glide
+import com.bumptech.glide.load.resource.drawable.DrawableTransitionOptions.withCrossFade
 import com.duckduckgo.anvil.annotations.InjectWith
 import com.duckduckgo.app.browser.PulseAnimation
 import com.duckduckgo.app.browser.R
 import com.duckduckgo.app.browser.SmoothProgressAnimator
 import com.duckduckgo.app.browser.databinding.IncludeCustomTabToolbarBinding
 import com.duckduckgo.app.browser.databinding.IncludeFindInPageBinding
+import com.duckduckgo.app.browser.easteregglogos.EasterEggLogosToggles
 import com.duckduckgo.app.browser.omnibar.Omnibar.OmnibarTextState
 import com.duckduckgo.app.browser.omnibar.Omnibar.ViewMode
 import com.duckduckgo.app.browser.omnibar.Omnibar.ViewMode.CustomTab
@@ -74,6 +77,7 @@ import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.Command.StartEx
 import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.Command.StartExperimentVariant2OrVariant3Animation
 import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.Command.StartTrackersAnimation
 import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.Command.StartVisualDesignTrackersAnimation
+import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.LeadingIconState.EasterEggLogo
 import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.LeadingIconState.PrivacyShield
 import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.ViewState
 import com.duckduckgo.app.browser.omnibar.animations.BrowserTrackersAnimatorHelper
@@ -105,6 +109,7 @@ import com.duckduckgo.common.utils.text.TextChangedWatcher
 import com.duckduckgo.di.scopes.FragmentScope
 import com.duckduckgo.duckchat.api.DuckAiFeatureState
 import com.duckduckgo.duckchat.api.DuckChat
+import com.duckduckgo.mobile.android.R as CommonR
 import com.google.android.material.appbar.AppBarLayout
 import javax.inject.Inject
 import kotlinx.coroutines.flow.collectLatest
@@ -192,6 +197,9 @@ open class OmnibarLayout @JvmOverloads constructor(
     @Inject
     lateinit var onboardingDesignExperimentManager: OnboardingDesignExperimentManager
 
+    @Inject
+    lateinit var easterEggLogosToggles: EasterEggLogosToggles
+
     private var previousTransitionState: TransitionState? = null
 
     private val lifecycleOwner: LifecycleOwner by lazy {
@@ -205,6 +213,7 @@ open class OmnibarLayout @JvmOverloads constructor(
     private var omnibarTextListener: Omnibar.TextListener? = null
     private var omnibarItemPressedListener: Omnibar.ItemPressedListener? = null
     private var omnibarInputScreenLaunchListener: Omnibar.InputScreenLaunchListener? = null
+    private var omnibarLogoClickedListener: Omnibar.LogoClickListener? = null
 
     private var decoration: Decoration? = null
     private var lastViewMode: Mode? = null
@@ -503,6 +512,10 @@ open class OmnibarLayout @JvmOverloads constructor(
         }
     }
 
+    fun setLogoClickListener(logoClickListener: Omnibar.LogoClickListener) {
+        omnibarLogoClickedListener = logoClickListener
+    }
+
     open fun render(viewState: ViewState) {
         when (viewState.viewMode) {
             is CustomTab -> {
@@ -560,6 +573,10 @@ open class OmnibarLayout @JvmOverloads constructor(
             is LaunchInputScreen -> {
                 omnibarInputScreenLaunchListener?.launchInputScreen(query = command.query)
             }
+
+            is Command.LogoClicked -> {
+                onLogoClicked(command.url)
+            }
         }
     }
 
@@ -577,7 +594,7 @@ open class OmnibarLayout @JvmOverloads constructor(
     }
 
     private fun renderLeadingIconState(viewState: ViewState) {
-        when (viewState.leadingIconState) {
+        when (val leadingIconState = viewState.leadingIconState) {
             OmnibarLayoutViewModel.LeadingIconState.Search -> {
                 searchIcon.show()
                 shieldIcon.gone()
@@ -602,7 +619,19 @@ open class OmnibarLayout @JvmOverloads constructor(
             }
 
             OmnibarLayoutViewModel.LeadingIconState.Dax -> {
-                daxIcon.show()
+                if (easterEggLogosToggles.feature().isEnabled()) {
+                    with(daxIcon) {
+                        setOnClickListener(null)
+                        show()
+                        Glide.with(this)
+                            .load(CommonR.drawable.ic_ddg_logo)
+                            .transition(withCrossFade())
+                            .placeholder(daxIcon.drawable)
+                            .into(this)
+                    }
+                } else {
+                    daxIcon.show()
+                }
                 shieldIcon.gone()
                 shieldIconExperiment.gone()
                 searchIcon.gone()
@@ -627,6 +656,23 @@ open class OmnibarLayout @JvmOverloads constructor(
                 searchIcon.gone()
                 duckPlayerIcon.show()
             }
+
+            is EasterEggLogo -> {
+                daxIcon.show()
+                Glide.with(daxIcon)
+                    .load(leadingIconState.logoUrl)
+                    .placeholder(daxIcon.drawable)
+                    .transition(withCrossFade())
+                    .into(daxIcon)
+                daxIcon.setOnClickListener {
+                    viewModel.onDynamicLogoClicked()
+                }
+                globeIcon.gone()
+                shieldIcon.gone()
+                shieldIconExperiment.gone()
+                searchIcon.gone()
+                duckPlayerIcon.gone()
+            }
         }
     }
 
@@ -986,6 +1032,10 @@ open class OmnibarLayout @JvmOverloads constructor(
         }
     }
 
+    private fun onLogoClicked(url: String) {
+        omnibarLogoClickedListener?.onClick(url)
+    }
+
     override fun measuredHeight(): Int {
         return measuredHeight
     }