Bug 1824869 - Add PrivateBrowsing[Interactor|Controller] for handling private browsing mode
Gabriel Luong
1 year ago
committed by
mergify[bot]
parent
55805562d6
commit
f49e45e802
@ -0,0 +1,74 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package org.mozilla.fenix.home.privatebrowsing.controller
|
||||
|
||||
import androidx.navigation.NavController
|
||||
import org.mozilla.fenix.BrowserDirection
|
||||
import org.mozilla.fenix.HomeActivity
|
||||
import org.mozilla.fenix.R
|
||||
import org.mozilla.fenix.browser.BrowserFragmentDirections
|
||||
import org.mozilla.fenix.browser.browsingmode.BrowsingMode
|
||||
import org.mozilla.fenix.components.AppStore
|
||||
import org.mozilla.fenix.components.appstate.AppAction
|
||||
import org.mozilla.fenix.ext.settings
|
||||
import org.mozilla.fenix.home.Mode
|
||||
import org.mozilla.fenix.home.privatebrowsing.interactor.PrivateBrowsingInteractor
|
||||
import org.mozilla.fenix.settings.SupportUtils
|
||||
|
||||
/**
|
||||
* An interface that handles the view manipulation of the private browsing mode.
|
||||
*/
|
||||
interface PrivateBrowsingController {
|
||||
/**
|
||||
* @see [PrivateBrowsingInteractor.onLearnMoreClicked]
|
||||
*/
|
||||
fun handleLearnMoreClicked()
|
||||
|
||||
/**
|
||||
* @see [PrivateBrowsingInteractor.onPrivateModeButtonClicked]
|
||||
*/
|
||||
fun handlePrivateModeButtonClicked(newMode: BrowsingMode, userHasBeenOnboarded: Boolean)
|
||||
}
|
||||
|
||||
/**
|
||||
* The default implementation of [PrivateBrowsingController].
|
||||
*/
|
||||
class DefaultPrivateBrowsingController(
|
||||
private val activity: HomeActivity,
|
||||
private val appStore: AppStore,
|
||||
private val navController: NavController,
|
||||
) : PrivateBrowsingController {
|
||||
|
||||
override fun handleLearnMoreClicked() {
|
||||
activity.openToBrowserAndLoad(
|
||||
searchTermOrURL = SupportUtils.getGenericSumoURLForTopic(SupportUtils.SumoTopic.PRIVATE_BROWSING_MYTHS),
|
||||
newTab = true,
|
||||
from = BrowserDirection.FromHome,
|
||||
)
|
||||
}
|
||||
|
||||
override fun handlePrivateModeButtonClicked(
|
||||
newMode: BrowsingMode,
|
||||
userHasBeenOnboarded: Boolean,
|
||||
) {
|
||||
if (newMode == BrowsingMode.Private) {
|
||||
activity.settings().incrementNumTimesPrivateModeOpened()
|
||||
}
|
||||
|
||||
if (userHasBeenOnboarded) {
|
||||
appStore.dispatch(
|
||||
AppAction.ModeChange(Mode.fromBrowsingMode(newMode)),
|
||||
)
|
||||
|
||||
if (navController.currentDestination?.id == R.id.searchDialogFragment) {
|
||||
navController.navigate(
|
||||
BrowserFragmentDirections.actionGlobalSearchDialog(
|
||||
sessionId = null,
|
||||
),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,23 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package org.mozilla.fenix.home.privatebrowsing.interactor
|
||||
|
||||
import org.mozilla.fenix.browser.browsingmode.BrowsingMode
|
||||
|
||||
/**
|
||||
* Interface for private browsing mode related actions.
|
||||
*/
|
||||
interface PrivateBrowsingInteractor {
|
||||
/**
|
||||
* Shows the Private Browsing Learn More page in a new tab. Called when a user clicks on the
|
||||
* "Common myths about private browsing" link in private mode.
|
||||
*/
|
||||
fun onLearnMoreClicked()
|
||||
|
||||
/**
|
||||
* Called when a user clicks on the Private Mode button on the homescreen.
|
||||
*/
|
||||
fun onPrivateModeButtonClicked(newMode: BrowsingMode, userHasBeenOnboarded: Boolean)
|
||||
}
|
||||
@ -0,0 +1,162 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package org.mozilla.fenix.home.privatebrowsing
|
||||
|
||||
import androidx.navigation.NavController
|
||||
import io.mockk.Runs
|
||||
import io.mockk.every
|
||||
import io.mockk.just
|
||||
import io.mockk.mockk
|
||||
import io.mockk.verify
|
||||
import mozilla.components.browser.state.action.TabListAction
|
||||
import mozilla.components.browser.state.state.createTab
|
||||
import mozilla.components.browser.state.store.BrowserStore
|
||||
import mozilla.components.support.test.ext.joinBlocking
|
||||
import org.junit.Before
|
||||
import org.junit.Test
|
||||
import org.mozilla.fenix.BrowserDirection
|
||||
import org.mozilla.fenix.HomeActivity
|
||||
import org.mozilla.fenix.R
|
||||
import org.mozilla.fenix.browser.BrowserFragmentDirections
|
||||
import org.mozilla.fenix.browser.browsingmode.BrowsingMode
|
||||
import org.mozilla.fenix.components.AppStore
|
||||
import org.mozilla.fenix.components.appstate.AppAction
|
||||
import org.mozilla.fenix.components.appstate.AppState
|
||||
import org.mozilla.fenix.ext.components
|
||||
import org.mozilla.fenix.ext.settings
|
||||
import org.mozilla.fenix.home.Mode
|
||||
import org.mozilla.fenix.home.privatebrowsing.controller.DefaultPrivateBrowsingController
|
||||
import org.mozilla.fenix.settings.SupportUtils
|
||||
import org.mozilla.fenix.utils.Settings
|
||||
|
||||
class DefaultPrivateBrowsingControllerTest {
|
||||
|
||||
private val activity: HomeActivity = mockk(relaxed = true)
|
||||
private val appStore: AppStore = mockk(relaxed = true)
|
||||
private val navController: NavController = mockk(relaxed = true)
|
||||
private val settings: Settings = mockk(relaxed = true)
|
||||
|
||||
private lateinit var store: BrowserStore
|
||||
private lateinit var controller: DefaultPrivateBrowsingController
|
||||
|
||||
@Before
|
||||
fun setup() {
|
||||
store = BrowserStore()
|
||||
controller = DefaultPrivateBrowsingController(
|
||||
activity = activity,
|
||||
appStore = appStore,
|
||||
navController = navController,
|
||||
)
|
||||
|
||||
every { appStore.state } returns AppState()
|
||||
|
||||
every { navController.currentDestination } returns mockk {
|
||||
every { id } returns R.id.homeFragment
|
||||
}
|
||||
every { activity.components.settings } returns settings
|
||||
every { activity.settings() } returns settings
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN private browsing learn more link is clicked THEN open support page in browser`() {
|
||||
controller.handleLearnMoreClicked()
|
||||
|
||||
verify {
|
||||
activity.openToBrowserAndLoad(
|
||||
searchTermOrURL = SupportUtils.getGenericSumoURLForTopic
|
||||
(SupportUtils.SumoTopic.PRIVATE_BROWSING_MYTHS),
|
||||
newTab = true,
|
||||
from = BrowserDirection.FromHome,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN private mode button is selected from home THEN handle mode change`() {
|
||||
every { navController.currentDestination } returns mockk {
|
||||
every { id } returns R.id.homeFragment
|
||||
}
|
||||
|
||||
every { settings.incrementNumTimesPrivateModeOpened() } just Runs
|
||||
|
||||
val newMode = BrowsingMode.Private
|
||||
val hasBeenOnboarded = true
|
||||
|
||||
controller.handlePrivateModeButtonClicked(newMode, hasBeenOnboarded)
|
||||
|
||||
verify {
|
||||
settings.incrementNumTimesPrivateModeOpened()
|
||||
AppAction.ModeChange(Mode.fromBrowsingMode(newMode))
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN private mode is selected on home from behind search THEN handle mode change`() {
|
||||
every { navController.currentDestination } returns mockk {
|
||||
every { id } returns R.id.searchDialogFragment
|
||||
}
|
||||
|
||||
every { settings.incrementNumTimesPrivateModeOpened() } just Runs
|
||||
|
||||
val url = "https://mozilla.org"
|
||||
val tab = createTab(
|
||||
id = "otherTab",
|
||||
url = url,
|
||||
private = false,
|
||||
engineSession = mockk(relaxed = true),
|
||||
)
|
||||
store.dispatch(TabListAction.AddTabAction(tab, select = true)).joinBlocking()
|
||||
|
||||
val newMode = BrowsingMode.Private
|
||||
val hasBeenOnboarded = true
|
||||
|
||||
controller.handlePrivateModeButtonClicked(newMode, hasBeenOnboarded)
|
||||
|
||||
verify {
|
||||
settings.incrementNumTimesPrivateModeOpened()
|
||||
AppAction.ModeChange(Mode.fromBrowsingMode(newMode))
|
||||
navController.navigate(
|
||||
BrowserFragmentDirections.actionGlobalSearchDialog(
|
||||
sessionId = null,
|
||||
),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN private mode is deselected on home from behind search THEN handle mode change`() {
|
||||
every { navController.currentDestination } returns mockk {
|
||||
every { id } returns R.id.searchDialogFragment
|
||||
}
|
||||
|
||||
val url = "https://mozilla.org"
|
||||
val tab = createTab(
|
||||
id = "otherTab",
|
||||
url = url,
|
||||
private = true,
|
||||
engineSession = mockk(relaxed = true),
|
||||
)
|
||||
store.dispatch(TabListAction.AddTabAction(tab, select = true)).joinBlocking()
|
||||
|
||||
val newMode = BrowsingMode.Normal
|
||||
val hasBeenOnboarded = true
|
||||
|
||||
controller.handlePrivateModeButtonClicked(newMode, hasBeenOnboarded)
|
||||
|
||||
verify(exactly = 0) {
|
||||
settings.incrementNumTimesPrivateModeOpened()
|
||||
}
|
||||
verify {
|
||||
appStore.dispatch(
|
||||
AppAction.ModeChange(Mode.fromBrowsingMode(newMode)),
|
||||
)
|
||||
navController.navigate(
|
||||
BrowserFragmentDirections.actionGlobalSearchDialog(
|
||||
sessionId = null,
|
||||
),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue