Hatch: Refactor NtpAfterIdleManager to classify per-render correctly and fix hatch pixels on later NTPs

Author: YoussefKeyrouz

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

@@ -3525,7 +3525,7 @@ class BrowserTabFragment :
         newTabReturnHatchView.setHatchListener(
             object : NewTabReturnHatchView.HatchListener {
                 override fun onHatchPressed() {
-                    ntpAfterIdleManager.fireReturnToPageTapped()
+                    ntpAfterIdleManager.onReturnToPageTapped()
                     browserActivity?.openExistingTab(newTabReturnHatchView.tabId)
                 }
 

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

@@ -345,6 +345,7 @@ import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed.MALWARE
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed.PHISHING
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed.SCAM
+import com.duckduckgo.newtabpage.api.NtpAfterIdleManager
 import com.duckduckgo.newtabpage.impl.pixels.NewTabPixels
 import com.duckduckgo.privacy.config.api.AmpLinkInfo
 import com.duckduckgo.privacy.config.api.AmpLinks
@@ -516,6 +517,7 @@ class BrowserTabViewModel @Inject constructor(
     private val browserUiLockFeature: BrowserUiLockFeature,
     private val progressBarUpgradeFeature: ProgressBarUpgradeFeature,
     private val faviconFetchingFixFeature: FaviconFetchingFixFeature,
+    private val ntpAfterIdleManager: NtpAfterIdleManager,
 ) : ViewModel(),
     WebViewClientListener,
     EditSavedSiteListener,
@@ -1274,11 +1276,16 @@ class BrowserTabViewModel @Inject constructor(
             return
         }
 
-        if (currentGlobalLayoutState() is Invalidated) {
+        val layoutState = currentGlobalLayoutState()
+        if (layoutState is Invalidated) {
             recoverTabWithQuery(query)
             return
         }
 
+        if (androidBrowserConfig.showNTPAfterIdleReturn().isEnabled() && layoutState is Browser && layoutState.isNewTabState) {
+            ntpAfterIdleManager.onNtpSearchSubmitted()
+        }
+
         val cta = currentCtaViewState().cta
 
         if (cta is OnboardingDaxDialogCta) {

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

@@ -55,6 +55,7 @@ import com.duckduckgo.app.pixels.AppPixelName.APP_RATING_DIALOG_SHOWN
 import com.duckduckgo.app.pixels.AppPixelName.APP_RATING_DIALOG_USER_CANCELLED
 import com.duckduckgo.app.pixels.AppPixelName.APP_RATING_DIALOG_USER_DECLINED_RATING
 import com.duckduckgo.app.pixels.AppPixelName.APP_RATING_DIALOG_USER_GAVE_RATING
+import com.duckduckgo.app.pixels.remoteconfig.AndroidBrowserConfigFeature
 import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.app.statistics.pixels.Pixel.PixelParameter
 import com.duckduckgo.app.statistics.pixels.Pixel.PixelType.Daily
@@ -67,6 +68,7 @@ import com.duckduckgo.di.scopes.AppScope
 import com.duckduckgo.duckchat.api.DuckAiFeatureState
 import com.duckduckgo.feature.toggles.api.Toggle
 import com.duckduckgo.feature.toggles.api.Toggle.DefaultFeatureValue
+import com.duckduckgo.newtabpage.api.NtpAfterIdleManager
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.channels.BufferOverflow.DROP_OLDEST
@@ -77,9 +79,12 @@ import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.debounce
 import kotlinx.coroutines.flow.distinctUntilChanged
+import kotlinx.coroutines.flow.filter
 import kotlinx.coroutines.flow.filterNot
 import kotlinx.coroutines.flow.filterNotNull
+import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.receiveAsFlow
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.flow.update
@@ -104,8 +109,21 @@ class BrowserViewModel @Inject constructor(
     private val additionalDefaultBrowserPrompts: AdditionalDefaultBrowserPrompts,
     private val swipingTabsFeature: SwipingTabsFeatureProvider,
     private val duckAiFeatureState: DuckAiFeatureState,
+    private val ntpAfterIdleManager: NtpAfterIdleManager,
+    private val androidBrowserConfigFeature: AndroidBrowserConfigFeature,
 ) : ViewModel(), CoroutineScope {
 
+    init {
+        if (androidBrowserConfigFeature.showNTPAfterIdleReturn().isEnabled()) {
+            tabRepository.flowSelectedTab
+                .map { tab -> tab?.let { it.tabId to it.url.isNullOrBlank() } }
+                .distinctUntilChanged()
+                .filter { it?.second == true }
+                .onEach { ntpAfterIdleManager.onNtpShown() }
+                .launchIn(viewModelScope)
+        }
+    }
+
     override val coroutineContext: CoroutineContext
         get() = dispatchers.main()
 

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

@@ -67,7 +67,6 @@ import com.duckduckgo.duckchat.api.DuckAiFeatureState
 import com.duckduckgo.duckchat.api.DuckChat
 import com.duckduckgo.duckchat.impl.pixel.DuckChatPixelName
 import com.duckduckgo.duckplayer.api.DuckPlayer.DuckPlayerState.ENABLED
-import com.duckduckgo.newtabpage.api.NtpAfterIdleManager
 import com.duckduckgo.privacy.dashboard.impl.pixels.PrivacyDashboardPixels
 import com.duckduckgo.serp.logos.api.SerpEasterEggLogosToggles
 import com.duckduckgo.serp.logos.api.SerpLogo
@@ -114,7 +113,6 @@ class OmnibarLayoutViewModel @Inject constructor(
     private val addressBarTrackersAnimationManager: AddressBarTrackersAnimationManager,
     private val standardizedLeadingIconToggle: StandardizedLeadingIconFeatureToggle,
     private val progressBarUpgradeFeature: ProgressBarUpgradeFeature,
-    private val ntpAfterIdleRepository: NtpAfterIdleManager,
 ) : ViewModel() {
 
     private val isSplitOmnibarEnabled = settingsDataStore.omnibarType == OmnibarType.SPLIT
@@ -965,9 +963,6 @@ class OmnibarLayoutViewModel @Inject constructor(
             AppPixelName.KEYBOARD_GO_SERP_CLICKED,
             AppPixelName.KEYBOARD_GO_WEBSITE_CLICKED,
         )
-        if (_viewState.value.url.isEmpty()) {
-            ntpAfterIdleRepository.fireBarUsedFromNtp()
-        }
     }
 
     fun onAnimationStarted(decoration: Decoration) {

app/src/main/java/com/duckduckgo/app/generalsettings/showonapplaunch/FirstScreenHandler.kt

@@ -22,7 +22,6 @@ import com.duckduckgo.app.settings.db.SettingsDataStore
 import com.duckduckgo.browser.api.BrowserLifecycleObserver
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.di.scopes.AppScope
-import com.duckduckgo.newtabpage.api.NtpAfterIdleManager
 import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.SingleInstanceIn
 import kotlinx.coroutines.CoroutineScope
@@ -41,7 +40,6 @@ class FirstScreenHandlerImpl @Inject constructor(
     private val settingsDataStore: SettingsDataStore,
     private val showOnAppLaunchOptionHandler: ShowOnAppLaunchOptionHandler,
     private val dispatcherProvider: DispatcherProvider,
-    private val ntpAfterIdleManager: NtpAfterIdleManager,
     @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
 ) : BrowserLifecycleObserver {
 
@@ -57,12 +55,10 @@ class FirstScreenHandlerImpl @Inject constructor(
             val lastBackgrounded = settingsDataStore.lastSessionBackgroundTimestamp
             val elapsed = System.currentTimeMillis() - lastBackgrounded
             if (lastBackgrounded == 0L || elapsed >= timeoutMs) {
-                ntpAfterIdleManager.onNtpShownAfterIdle()
                 showOnAppLaunchOptionHandler.handleAfterInactivityOption()
                 return
             }
         } else if (isFreshLaunch && showOnAppLaunchFeature.self().isEnabled()) {
-            ntpAfterIdleManager.onNtpShownUserInitiated()
             showOnAppLaunchOptionHandler.handleAppLaunchOption()
         }
     }

app/src/main/java/com/duckduckgo/app/generalsettings/showonapplaunch/ShowOnAppLaunchOptionHandler.kt

@@ -28,6 +28,7 @@ import com.duckduckgo.appbuildconfig.api.AppBuildConfig
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.common.utils.isHttpOrHttps
 import com.duckduckgo.di.scopes.AppScope
+import com.duckduckgo.newtabpage.api.NtpAfterIdleManager
 import com.squareup.anvil.annotations.ContributesBinding
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.withContext
@@ -50,6 +51,7 @@ class ShowOnAppLaunchOptionHandlerImpl @Inject constructor(
     private val showOnAppLaunchOptionDataStore: ShowOnAppLaunchOptionDataStore,
     private val tabRepository: TabRepository,
     private val appBuildConfig: AppBuildConfig,
+    private val ntpAfterIdleManager: NtpAfterIdleManager,
 ) : ShowOnAppLaunchOptionHandler {
 
     override suspend fun handleAfterInactivityOption() {
@@ -60,17 +62,24 @@ class ShowOnAppLaunchOptionHandlerImpl @Inject constructor(
             showOnAppLaunchOptionDataStore.setShowOnAppLaunchOption(NewTabPage)
         }
         // existing users see whatever they had selected
-        handleAppLaunchOption()
+        applyShowOnAppLaunchOption(fromInactivity = true)
     }
 
     override suspend fun handleAppLaunchOption() {
+        applyShowOnAppLaunchOption(fromInactivity = false)
+    }
+
+    private suspend fun applyShowOnAppLaunchOption(fromInactivity: Boolean) {
         val option = showOnAppLaunchOptionDataStore.optionFlow.first()
         logcat { "FirstScreen: showing $option on app launch" }
         when (option) {
             LastOpenedTab -> Unit
             NewTabPage -> {
                 val selectedTab = tabRepository.getSelectedTab()
                 if (selectedTab == null || !selectedTab.url.isNullOrBlank()) {
+                    if (fromInactivity) {
+                        ntpAfterIdleManager.onIdleReturnTriggered()
+                    }
                     tabRepository.add()
                 }
             }

app/src/main/java/com/duckduckgo/app/generalsettings/showonapplaunch/ShowOnAppLaunchViewModel.kt

@@ -121,7 +121,7 @@ class ShowOnAppLaunchViewModel @Inject constructor(
             settingsDataStore.userSelectedIdleThresholdSeconds = seconds
             userSelectedThreshold.value = seconds
             pixel.fire(SETTINGS_AFTER_INACTIVITY_TIMEOUT_CHANGED, mapOf("selectedSeconds" to seconds.toString()))
-            ntpAfterIdleManager.fireTimeoutSelected(seconds)
+            ntpAfterIdleManager.onIdleTimeoutSelected(seconds)
         }
     }
 }

app/src/test/java/com/duckduckgo/app/browser/BrowserTabViewModelTest.kt

@@ -278,6 +278,7 @@ import com.duckduckgo.js.messaging.api.JsCallbackData
 import com.duckduckgo.js.messaging.api.SubscriptionEventData
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed
 import com.duckduckgo.malicioussiteprotection.api.MaliciousSiteProtection.Feed.MALWARE
+import com.duckduckgo.newtabpage.api.NtpAfterIdleManager
 import com.duckduckgo.newtabpage.impl.pixels.NewTabPixels
 import com.duckduckgo.privacy.config.api.AmpLinkInfo
 import com.duckduckgo.privacy.config.api.AmpLinks
@@ -575,6 +576,7 @@ class BrowserTabViewModelTest {
     private val mockToggleReports: ToggleReports = mock()
     private val mockBrokenSitePrompt: BrokenSitePrompt = mock()
     private val mockTabStatsBucketing: TabStatsBucketing = mock()
+    private val mockNtpAfterIdleManager: NtpAfterIdleManager = mock()
     private val mockDuckChatJSHelper: DuckChatJSHelper = mock()
     private val swipingTabsFeature = FakeFeatureToggleFactory.create(SwipingTabsFeature::class.java)
     private val swipingTabsFeatureProvider = SwipingTabsFeatureProvider(swipingTabsFeature)
@@ -925,6 +927,7 @@ class BrowserTabViewModelTest {
                 browserUiLockFeature = fakeBrowserUiLockFeature,
                 progressBarUpgradeFeature = fakeProgressBarUpgradeFeature,
                 faviconFetchingFixFeature = fakeFaviconFetchingFixFeature,
+                ntpAfterIdleManager = mockNtpAfterIdleManager,
             )
 
         testee.loadData("abc", null, false, false)
@@ -1187,6 +1190,49 @@ class BrowserTabViewModelTest {
         assertEquals("nytimes.com", omnibarViewState().omnibarText)
     }
 
+    @Test
+    fun whenQuerySubmittedWhileOnNtpAndFeatureEnabledThenNtpSearchSubmittedNotified() {
+        fakeAndroidConfigBrowserFeature.showNTPAfterIdleReturn().setRawStoredState(State(enable = true))
+        whenever(mockOmnibarConverter.convertQueryToUrl("cats", null)).thenReturn("https://duckduckgo.com/?q=cats")
+        testee.globalLayoutState.value = GlobalLayoutViewState.Browser(isNewTabState = true)
+
+        testee.onUserSubmittedQuery("cats")
+
+        verify(mockNtpAfterIdleManager).onNtpSearchSubmitted()
+    }
+
+    @Test
+    fun whenQuerySubmittedWhileOnLoadedPageThenNtpSearchSubmittedNotNotified() {
+        fakeAndroidConfigBrowserFeature.showNTPAfterIdleReturn().setRawStoredState(State(enable = true))
+        whenever(mockOmnibarConverter.convertQueryToUrl("cats", null)).thenReturn("https://duckduckgo.com/?q=cats")
+        testee.globalLayoutState.value = GlobalLayoutViewState.Browser(isNewTabState = false)
+
+        testee.onUserSubmittedQuery("cats")
+
+        verify(mockNtpAfterIdleManager, never()).onNtpSearchSubmitted()
+    }
+
+    @Test
+    fun whenBlankQuerySubmittedWhileOnNtpThenNtpSearchSubmittedNotNotified() {
+        fakeAndroidConfigBrowserFeature.showNTPAfterIdleReturn().setRawStoredState(State(enable = true))
+        testee.globalLayoutState.value = GlobalLayoutViewState.Browser(isNewTabState = true)
+
+        testee.onUserSubmittedQuery("   ")
+
+        verify(mockNtpAfterIdleManager, never()).onNtpSearchSubmitted()
+    }
+
+    @Test
+    fun whenQuerySubmittedWhileOnNtpAndFeatureDisabledThenNtpSearchSubmittedNotNotified() {
+        fakeAndroidConfigBrowserFeature.showNTPAfterIdleReturn().setRawStoredState(State(enable = false))
+        whenever(mockOmnibarConverter.convertQueryToUrl("cats", null)).thenReturn("https://duckduckgo.com/?q=cats")
+        testee.globalLayoutState.value = GlobalLayoutViewState.Browser(isNewTabState = true)
+
+        testee.onUserSubmittedQuery("cats")
+
+        verify(mockNtpAfterIdleManager, never()).onNtpSearchSubmitted()
+    }
+
     @Test
     fun whenBrowsingAndUrlPresentThenAddBookmarkButtonEnabled() {
         loadUrl("https://www.example.com", isBrowserShowing = true)