Issue #19040: Remove Leanplum (Beta)
Sebastian Kaspari
3 years ago
parent
03c4a159d4
commit
5d500a1d66
@ -1,247 +0,0 @@
|
||||
/* 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.components.metrics
|
||||
|
||||
import android.app.Application
|
||||
import android.net.Uri
|
||||
import android.util.Log
|
||||
import com.leanplum.Leanplum
|
||||
import com.leanplum.LeanplumActivityHelper
|
||||
import com.leanplum.annotations.Parser
|
||||
import com.leanplum.internal.LeanplumInternal
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.Dispatchers.Main
|
||||
import kotlinx.coroutines.Job
|
||||
import kotlinx.coroutines.launch
|
||||
import kotlinx.coroutines.withContext
|
||||
import mozilla.components.support.locale.LocaleManager
|
||||
import org.mozilla.fenix.BuildConfig
|
||||
import org.mozilla.fenix.components.metrics.MozillaProductDetector.MozillaProducts
|
||||
import org.mozilla.fenix.ext.settings
|
||||
import org.mozilla.fenix.home.intent.DeepLinkIntentProcessor
|
||||
import java.util.Locale
|
||||
import java.util.MissingResourceException
|
||||
import java.util.UUID.randomUUID
|
||||
|
||||
private val Event.name: String?
|
||||
get() = when (this) {
|
||||
is Event.AddBookmark -> "E_Add_Bookmark"
|
||||
is Event.RemoveBookmark -> "E_Remove_Bookmark"
|
||||
is Event.OpenedBookmark -> "E_Opened_Bookmark"
|
||||
is Event.OpenedApp -> "E_Opened_App"
|
||||
is Event.OpenedAppFirstRun -> "E_Opened_App_FirstRun"
|
||||
is Event.InteractWithSearchURLArea -> "E_Interact_With_Search_URL_Area"
|
||||
is Event.CollectionSaved -> "E_Collection_Created"
|
||||
is Event.CollectionTabRestored -> "E_Collection_Tab_Opened"
|
||||
is Event.SyncAuthSignUp -> "E_FxA_New_Signup"
|
||||
is Event.SyncAuthSignIn, Event.SyncAuthPaired, Event.SyncAuthOtherExternal -> "E_Sign_In_FxA"
|
||||
is Event.SyncAuthFromSharedCopy, Event.SyncAuthFromSharedReuse -> "E_Sign_In_FxA_Fennec_to_Fenix"
|
||||
is Event.SyncAuthSignOut -> "E_Sign_Out_FxA"
|
||||
is Event.ClearedPrivateData -> "E_Cleared_Private_Data"
|
||||
is Event.DismissedOnboarding -> "E_Dismissed_Onboarding"
|
||||
is Event.FennecToFenixMigrated -> "E_Fennec_To_Fenix_Migrated"
|
||||
is Event.AddonInstalled -> "E_Addon_Installed"
|
||||
is Event.SearchWidgetInstalled -> "E_Search_Widget_Added"
|
||||
is Event.ChangedToDefaultBrowser -> "E_Changed_Default_To_Fenix"
|
||||
is Event.TrackingProtectionSettingChanged -> "E_Changed_ETP"
|
||||
|
||||
// Do not track other events in Leanplum
|
||||
else -> null
|
||||
}
|
||||
|
||||
class LeanplumMetricsService(
|
||||
private val application: Application
|
||||
) : MetricsService, DeepLinkIntentProcessor.DeepLinkVerifier {
|
||||
val scope = CoroutineScope(Dispatchers.IO)
|
||||
var leanplumJob: Job? = null
|
||||
|
||||
data class Token(val id: String, val token: String) {
|
||||
enum class Type { Development, Production, Invalid }
|
||||
|
||||
val type by lazy {
|
||||
when {
|
||||
token.take(ProdPrefix.length) == ProdPrefix -> Type.Production
|
||||
token.take(DevPrefix.length) == DevPrefix -> Type.Development
|
||||
else -> Type.Invalid
|
||||
}
|
||||
}
|
||||
|
||||
companion object {
|
||||
private const val ProdPrefix = "prod"
|
||||
private const val DevPrefix = "dev"
|
||||
}
|
||||
}
|
||||
|
||||
override val type = MetricServiceType.Marketing
|
||||
private val token = Token(LeanplumId, LeanplumToken)
|
||||
|
||||
@Suppress("ComplexMethod")
|
||||
override fun start() {
|
||||
|
||||
if (!application.settings().isMarketingTelemetryEnabled) return
|
||||
|
||||
Leanplum.setIsTestModeEnabled(false)
|
||||
Leanplum.setApplicationContext(application)
|
||||
Leanplum.setDeviceId(randomUUID().toString())
|
||||
Parser.parseVariables(application)
|
||||
|
||||
leanplumJob = scope.launch {
|
||||
|
||||
val applicationSetLocale = LocaleManager.getCurrentLocale(application)
|
||||
val currentLocale = applicationSetLocale ?: Locale.getDefault()
|
||||
val languageCode =
|
||||
currentLocale.iso3LanguageOrNull
|
||||
?: currentLocale.language.let {
|
||||
if (it.isNotBlank()) {
|
||||
it
|
||||
} else {
|
||||
currentLocale.toString()
|
||||
}
|
||||
}
|
||||
|
||||
if (!isLeanplumEnabled(languageCode)) {
|
||||
Log.i(LOGTAG, "Leanplum is not available for this locale: $languageCode")
|
||||
return@launch
|
||||
}
|
||||
|
||||
when (token.type) {
|
||||
Token.Type.Production -> Leanplum.setAppIdForProductionMode(token.id, token.token)
|
||||
Token.Type.Development -> Leanplum.setAppIdForDevelopmentMode(token.id, token.token)
|
||||
Token.Type.Invalid -> {
|
||||
Log.i(LOGTAG, "Invalid or missing Leanplum token")
|
||||
return@launch
|
||||
}
|
||||
}
|
||||
|
||||
LeanplumActivityHelper.enableLifecycleCallbacks(application)
|
||||
|
||||
val installedApps = MozillaProductDetector.getInstalledMozillaProducts(application)
|
||||
|
||||
val trackingProtection = application.settings().run {
|
||||
when {
|
||||
!shouldUseTrackingProtection -> "none"
|
||||
useStandardTrackingProtection -> "standard"
|
||||
useStrictTrackingProtection -> "strict"
|
||||
else -> "custom"
|
||||
}
|
||||
}
|
||||
|
||||
Leanplum.start(
|
||||
application, hashMapOf(
|
||||
"default_browser" to MozillaProductDetector.getMozillaBrowserDefault(application)
|
||||
.orEmpty(),
|
||||
"fennec_installed" to installedApps.contains(MozillaProducts.FIREFOX.productName),
|
||||
"focus_installed" to installedApps.contains(MozillaProducts.FOCUS.productName),
|
||||
"klar_installed" to installedApps.contains(MozillaProducts.KLAR.productName),
|
||||
"fxa_signed_in" to application.settings().fxaSignedIn,
|
||||
"fxa_has_synced_items" to application.settings().fxaHasSyncedItems,
|
||||
"search_widget_installed" to application.settings().searchWidgetInstalled,
|
||||
"tracking_protection_enabled" to application.settings().shouldUseTrackingProtection,
|
||||
"tracking_protection_setting" to trackingProtection,
|
||||
"fenix" to true
|
||||
)
|
||||
)
|
||||
|
||||
withContext(Main) {
|
||||
LeanplumInternal.setCalledStart(true)
|
||||
LeanplumInternal.setHasStarted(true)
|
||||
LeanplumInternal.setStartedInBackground(true)
|
||||
Log.i(LOGTAG, "Started Leanplum with deviceId ${Leanplum.getDeviceId()}" +
|
||||
" and userId ${Leanplum.getUserId()}")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifies a deep link and returns `true` for deep links that should be handled and `false` if
|
||||
* a deep link should be rejected.
|
||||
*
|
||||
* @See DeepLinkIntentProcessor.verifier
|
||||
*/
|
||||
override fun verifyDeepLink(deepLink: Uri): Boolean {
|
||||
// We compare the local Leanplum device ID against the "uid" query parameter and only
|
||||
// accept deep links where both values match.
|
||||
val uid = deepLink.getQueryParameter("uid")
|
||||
return uid == Leanplum.getDeviceId()
|
||||
}
|
||||
|
||||
override fun stop() {
|
||||
if (application.settings().isMarketingTelemetryEnabled) return
|
||||
// As written in LeanPlum SDK documentation, "This prevents Leanplum from communicating with the server."
|
||||
// as this "isTestMode" flag is checked before LeanPlum SDK does anything.
|
||||
// Also has the benefit effect of blocking the display of already downloaded messages.
|
||||
// The reverse of this - setIsTestModeEnabled(false) must be called before trying to init
|
||||
// LP in the same session.
|
||||
Leanplum.setIsTestModeEnabled(true)
|
||||
|
||||
// This is just to allow restarting LP and it's functionality in the same app session
|
||||
// as LP stores it's state internally and check against it
|
||||
LeanplumInternal.setCalledStart(false)
|
||||
LeanplumInternal.setHasStarted(false)
|
||||
leanplumJob?.cancel()
|
||||
}
|
||||
|
||||
override fun track(event: Event) {
|
||||
val leanplumExtras = event.extras
|
||||
?.map { (key, value) -> key.toString() to value }
|
||||
?.toMap()
|
||||
|
||||
event.name?.also {
|
||||
Leanplum.track(it, leanplumExtras)
|
||||
}
|
||||
}
|
||||
|
||||
override fun shouldTrack(event: Event): Boolean {
|
||||
return application.settings().isTelemetryEnabled &&
|
||||
token.type != Token.Type.Invalid && !event.name.isNullOrEmpty()
|
||||
}
|
||||
|
||||
private fun isLeanplumEnabled(locale: String): Boolean {
|
||||
return LEANPLUM_ENABLED_LOCALES.contains(locale)
|
||||
}
|
||||
|
||||
private val Locale.iso3LanguageOrNull: String?
|
||||
get() =
|
||||
try {
|
||||
this.isO3Language
|
||||
} catch (_: MissingResourceException) {
|
||||
null
|
||||
}
|
||||
|
||||
companion object {
|
||||
private const val LOGTAG = "LeanplumMetricsService"
|
||||
|
||||
private val LeanplumId: String
|
||||
// Debug builds have a null (nullable) LEANPLUM_ID
|
||||
get() = BuildConfig.LEANPLUM_ID.orEmpty()
|
||||
private val LeanplumToken: String
|
||||
// Debug builds have a null (nullable) LEANPLUM_TOKEN
|
||||
get() = BuildConfig.LEANPLUM_TOKEN.orEmpty()
|
||||
|
||||
// Leanplum needs to be enabled for the following locales.
|
||||
// Irrespective of the actual device location.
|
||||
private val LEANPLUM_ENABLED_LOCALES = setOf(
|
||||
"eng", // English
|
||||
"zho", // Chinese
|
||||
"deu", // German
|
||||
"fra", // French
|
||||
"ita", // Italian
|
||||
"ind", // Indonesian
|
||||
"por", // Portuguese
|
||||
"spa", // Spanish; Castilian
|
||||
"pol", // Polish
|
||||
"rus", // Russian
|
||||
"hin", // Hindi
|
||||
"per", // Persian
|
||||
"fas", // Persian
|
||||
"ara", // Arabic
|
||||
"jpn" // Japanese
|
||||
)
|
||||
|
||||
private const val PREFERENCE_NAME = "LEANPLUM_PREFERENCES"
|
||||
private const val DEVICE_ID_KEY = "LP_DEVICE_ID"
|
||||
}
|
||||
}
|
||||
@ -1,176 +0,0 @@
|
||||
/* 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.intent
|
||||
|
||||
import android.content.Context
|
||||
import android.content.Intent
|
||||
import android.net.Uri
|
||||
import android.os.Build
|
||||
import android.os.Build.VERSION.SDK_INT
|
||||
import android.provider.Settings
|
||||
import androidx.core.os.bundleOf
|
||||
import androidx.navigation.NavController
|
||||
import mozilla.components.concept.engine.EngineSession
|
||||
import mozilla.components.support.base.log.logger.Logger
|
||||
import org.mozilla.fenix.BrowserDirection
|
||||
import org.mozilla.fenix.BuildConfig
|
||||
import org.mozilla.fenix.GlobalDirections
|
||||
import org.mozilla.fenix.HomeActivity
|
||||
import org.mozilla.fenix.browser.browsingmode.BrowsingMode
|
||||
import org.mozilla.fenix.components.SearchWidgetCreator
|
||||
import org.mozilla.fenix.ext.alreadyOnDestination
|
||||
import org.mozilla.fenix.ext.navigateBlockingForAsyncNavGraph
|
||||
import org.mozilla.fenix.home.intent.DeepLinkIntentProcessor.DeepLinkVerifier
|
||||
import org.mozilla.fenix.settings.SupportUtils
|
||||
|
||||
/**
|
||||
* Deep links in the form of `fenix://host` open different parts of the app.
|
||||
*
|
||||
* @param verifier [DeepLinkVerifier] that will be used to verify deep links before handling them.
|
||||
*/
|
||||
class DeepLinkIntentProcessor(
|
||||
private val activity: HomeActivity,
|
||||
private val verifier: DeepLinkVerifier
|
||||
) : HomeIntentProcessor {
|
||||
private val logger = Logger("DeepLinkIntentProcessor")
|
||||
|
||||
override fun process(intent: Intent, navController: NavController, out: Intent): Boolean {
|
||||
val scheme = intent.scheme?.equals(BuildConfig.DEEP_LINK_SCHEME, ignoreCase = true) ?: return false
|
||||
return if (scheme) {
|
||||
intent.data?.let { handleDeepLink(it, navController) }
|
||||
true
|
||||
} else {
|
||||
false
|
||||
}
|
||||
}
|
||||
|
||||
@Suppress("ComplexMethod")
|
||||
private fun handleDeepLink(deepLink: Uri, navController: NavController) {
|
||||
if (!verifier.verifyDeepLink(deepLink)) {
|
||||
logger.warn("Invalid deep link: $deepLink")
|
||||
return
|
||||
}
|
||||
|
||||
handleDeepLinkSideEffects(deepLink)
|
||||
|
||||
val globalDirections = when (deepLink.host) {
|
||||
"home", "enable_private_browsing" -> GlobalDirections.Home
|
||||
"urls_bookmarks" -> GlobalDirections.Bookmarks
|
||||
"urls_history" -> GlobalDirections.History
|
||||
"settings" -> GlobalDirections.Settings
|
||||
"turn_on_sync" -> GlobalDirections.Sync
|
||||
"settings_search_engine" -> GlobalDirections.SearchEngine
|
||||
"settings_accessibility" -> GlobalDirections.Accessibility
|
||||
"settings_delete_browsing_data" -> GlobalDirections.DeleteData
|
||||
"settings_addon_manager" -> GlobalDirections.SettingsAddonManager
|
||||
"settings_logins" -> GlobalDirections.SettingsLogins
|
||||
"settings_tracking_protection" -> GlobalDirections.SettingsTrackingProtection
|
||||
// We'd like to highlight views within the fragment
|
||||
// https://github.com/mozilla-mobile/fenix/issues/11856
|
||||
// The current version of UI has these features in more complex screens.
|
||||
"settings_privacy" -> GlobalDirections.Settings
|
||||
"home_collections" -> GlobalDirections.Home
|
||||
|
||||
else -> return
|
||||
}
|
||||
|
||||
if (!navController.alreadyOnDestination(globalDirections.destinationId)) {
|
||||
navController.navigateBlockingForAsyncNavGraph(globalDirections.navDirections)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle links that require more than just simple navigation.
|
||||
*/
|
||||
private fun handleDeepLinkSideEffects(deepLink: Uri) {
|
||||
when (deepLink.host) {
|
||||
"enable_private_browsing" -> {
|
||||
activity.browsingModeManager.mode = BrowsingMode.Private
|
||||
}
|
||||
"make_default_browser" -> {
|
||||
if (SDK_INT >= Build.VERSION_CODES.N) {
|
||||
val settingsIntent = Intent(Settings.ACTION_MANAGE_DEFAULT_APPS_SETTINGS)
|
||||
settingsIntent.putExtra(SETTINGS_SELECT_OPTION_KEY, DEFAULT_BROWSER_APP_OPTION)
|
||||
settingsIntent.putExtra(SETTINGS_SHOW_FRAGMENT_ARGS,
|
||||
bundleOf(SETTINGS_SELECT_OPTION_KEY to DEFAULT_BROWSER_APP_OPTION))
|
||||
activity.startActivity(settingsIntent)
|
||||
} else {
|
||||
activity.openToBrowserAndLoad(
|
||||
searchTermOrURL = SupportUtils.getSumoURLForTopic(
|
||||
activity,
|
||||
SupportUtils.SumoTopic.SET_AS_DEFAULT_BROWSER
|
||||
),
|
||||
newTab = true,
|
||||
from = BrowserDirection.FromGlobal,
|
||||
flags = EngineSession.LoadUrlFlags.external()
|
||||
)
|
||||
}
|
||||
}
|
||||
"open" -> {
|
||||
val url = deepLink.getQueryParameter("url")
|
||||
if (url == null || !url.startsWith("https://")) {
|
||||
logger.info("Not opening deep link: $url")
|
||||
return
|
||||
}
|
||||
|
||||
activity.openToBrowserAndLoad(
|
||||
url,
|
||||
newTab = true,
|
||||
from = BrowserDirection.FromGlobal,
|
||||
flags = EngineSession.LoadUrlFlags.external()
|
||||
)
|
||||
}
|
||||
"settings_notifications" -> {
|
||||
val intent = notificationSettings(activity)
|
||||
activity.startActivity(intent)
|
||||
}
|
||||
"install_search_widget" -> {
|
||||
if (SDK_INT >= Build.VERSION_CODES.O) {
|
||||
SearchWidgetCreator.createSearchWidget(activity)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun notificationSettings(context: Context, channel: String? = null) =
|
||||
Intent().apply {
|
||||
when {
|
||||
SDK_INT >= Build.VERSION_CODES.O -> {
|
||||
action = channel?.let {
|
||||
putExtra(Settings.EXTRA_CHANNEL_ID, it)
|
||||
Settings.ACTION_CHANNEL_NOTIFICATION_SETTINGS
|
||||
} ?: Settings.ACTION_APP_NOTIFICATION_SETTINGS
|
||||
putExtra(Settings.EXTRA_APP_PACKAGE, context.packageName)
|
||||
}
|
||||
SDK_INT >= Build.VERSION_CODES.LOLLIPOP -> {
|
||||
action = "android.settings.APP_NOTIFICATION_SETTINGS"
|
||||
putExtra("app_package", context.packageName)
|
||||
putExtra("app_uid", context.applicationInfo.uid)
|
||||
}
|
||||
else -> {
|
||||
action = Settings.ACTION_APPLICATION_DETAILS_SETTINGS
|
||||
addCategory(Intent.CATEGORY_DEFAULT)
|
||||
data = Uri.parse("package:" + context.packageName)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Interface for a class that verifies deep links before they get handled.
|
||||
*/
|
||||
interface DeepLinkVerifier {
|
||||
/**
|
||||
* Verifies the given deep link and returns `true` for verified deep links or `false` for
|
||||
* rejected deep links.
|
||||
*/
|
||||
fun verifyDeepLink(deepLink: Uri): Boolean
|
||||
}
|
||||
|
||||
companion object {
|
||||
private const val SETTINGS_SELECT_OPTION_KEY = ":settings:fragment_args_key"
|
||||
private const val SETTINGS_SHOW_FRAGMENT_ARGS = ":settings:show_fragment_args"
|
||||
private const val DEFAULT_BROWSER_APP_OPTION = "default_browser"
|
||||
}
|
||||
}
|
||||
@ -1,31 +0,0 @@
|
||||
/* 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.push
|
||||
|
||||
import android.app.Notification
|
||||
import android.os.Bundle
|
||||
import androidx.core.app.NotificationCompat
|
||||
import com.leanplum.LeanplumPushNotificationCustomizer
|
||||
import org.mozilla.fenix.R
|
||||
|
||||
/**
|
||||
* Notification customizer for incoming Leanplum push messages.
|
||||
*/
|
||||
class LeanplumNotificationCustomizer : LeanplumPushNotificationCustomizer {
|
||||
override fun customize(
|
||||
builder: NotificationCompat.Builder,
|
||||
notificationPayload: Bundle?
|
||||
) {
|
||||
builder.setSmallIcon(R.drawable.ic_status_logo)
|
||||
}
|
||||
|
||||
// Do not implement if unless we want to support 2 lines of text in the BigPicture style.
|
||||
// See: https://docs.leanplum.com/docs/customize-your-push-notifications-sample-android
|
||||
override fun customize(
|
||||
builder: Notification.Builder?,
|
||||
notificationPayload: Bundle?,
|
||||
notificationStyle: Notification.Style?
|
||||
) = Unit // no-op
|
||||
}
|
||||
@ -1,302 +0,0 @@
|
||||
/* 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.intent
|
||||
|
||||
import android.content.Intent
|
||||
import android.net.Uri
|
||||
import android.os.Build.VERSION_CODES.M
|
||||
import android.os.Build.VERSION_CODES.N
|
||||
import android.os.Build.VERSION_CODES.P
|
||||
import androidx.core.net.toUri
|
||||
import androidx.navigation.NavController
|
||||
import io.mockk.Called
|
||||
import io.mockk.every
|
||||
import io.mockk.mockk
|
||||
import io.mockk.mockkObject
|
||||
import io.mockk.verify
|
||||
import mozilla.appservices.places.BookmarkRoot
|
||||
import mozilla.components.concept.engine.EngineSession
|
||||
import org.junit.Assert.assertFalse
|
||||
import org.junit.Assert.assertTrue
|
||||
import org.junit.Before
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import org.mozilla.fenix.BrowserDirection
|
||||
import org.mozilla.fenix.BuildConfig.DEEP_LINK_SCHEME
|
||||
import org.mozilla.fenix.HomeActivity
|
||||
import org.mozilla.fenix.NavGraphDirections
|
||||
import org.mozilla.fenix.browser.browsingmode.BrowsingMode
|
||||
import org.mozilla.fenix.components.SearchWidgetCreator
|
||||
import org.mozilla.fenix.helpers.FenixRobolectricTestRunner
|
||||
import org.mozilla.fenix.settings.SupportUtils
|
||||
import org.robolectric.annotation.Config
|
||||
|
||||
@RunWith(FenixRobolectricTestRunner::class)
|
||||
class DeepLinkIntentProcessorTest {
|
||||
|
||||
private lateinit var activity: HomeActivity
|
||||
private lateinit var navController: NavController
|
||||
private lateinit var out: Intent
|
||||
private lateinit var processor: DeepLinkIntentProcessor
|
||||
|
||||
@Before
|
||||
fun setup() {
|
||||
activity = mockk(relaxed = true)
|
||||
navController = mockk(relaxed = true)
|
||||
out = mockk()
|
||||
processor = DeepLinkIntentProcessor(activity, object : DeepLinkIntentProcessor.DeepLinkVerifier {
|
||||
override fun verifyDeepLink(deepLink: Uri): Boolean {
|
||||
return true
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `do not process blank intents`() {
|
||||
assertFalse(processor.process(Intent(), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `return true if scheme is fenix`() {
|
||||
assertTrue(processor.process(testIntent("test"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `return true if scheme is a fenix variant`() {
|
||||
assertTrue(processor.process(testIntent("fenix-beta://test"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process home deep link`() {
|
||||
assertTrue(processor.process(testIntent("home"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalHome()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process urls_bookmarks deep link`() {
|
||||
assertTrue(processor.process(testIntent("urls_bookmarks"), navController, out))
|
||||
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalBookmarkFragment(BookmarkRoot.Root.id)) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process urls_history deep link`() {
|
||||
assertTrue(processor.process(testIntent("urls_history"), navController, out))
|
||||
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalHistoryFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process home_collections deep link`() {
|
||||
assertTrue(processor.process(testIntent("home_collections"), navController, out))
|
||||
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalHome()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalSettingsFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process turn_on_sync deep link`() {
|
||||
assertTrue(processor.process(testIntent("turn_on_sync"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalTurnOnSync()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings_search_engine deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings_search_engine"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalSearchEngineFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings_accessibility deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings_accessibility"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalAccessibilityFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings_delete_browsing_data deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings_delete_browsing_data"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalDeleteBrowsingDataFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings_addon_manager deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings_addon_manager"), navController, out))
|
||||
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalAddonsManagementFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings_logins deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings_logins"), navController, out))
|
||||
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalSavedLoginsAuthFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings_tracking_protection deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings_tracking_protection"), navController, out))
|
||||
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalTrackingProtectionFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings_privacy deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings_privacy"), navController, out))
|
||||
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalSettingsFragment()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process enable_private_browsing deep link`() {
|
||||
assertTrue(processor.process(testIntent("enable_private_browsing"), navController, out))
|
||||
|
||||
verify { activity.browsingModeManager.mode = BrowsingMode.Private }
|
||||
verify { navController.navigate(NavGraphDirections.actionGlobalHome()) }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process open deep link`() {
|
||||
assertTrue(processor.process(testIntent("open"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
|
||||
assertTrue(processor.process(testIntent("open?url=test"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
|
||||
assertTrue(processor.process(testIntent("open?url=https%3A%2F%2Fwww.example.org%2F"), navController, out))
|
||||
|
||||
verify {
|
||||
activity.openToBrowserAndLoad(
|
||||
"https://www.example.org/",
|
||||
newTab = true,
|
||||
from = BrowserDirection.FromGlobal,
|
||||
flags = EngineSession.LoadUrlFlags.external()
|
||||
)
|
||||
}
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process invalid open deep link`() {
|
||||
val invalidProcessor = DeepLinkIntentProcessor(activity, object : DeepLinkIntentProcessor.DeepLinkVerifier {
|
||||
override fun verifyDeepLink(deepLink: Uri): Boolean {
|
||||
return false
|
||||
}
|
||||
})
|
||||
|
||||
assertTrue(invalidProcessor.process(testIntent("open"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
|
||||
assertTrue(invalidProcessor.process(testIntent("open?url=open?url=https%3A%2F%2Fwww.example.org%2F"), navController, out))
|
||||
|
||||
verify { activity wasNot Called }
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
@Config(minSdk = N, maxSdk = P)
|
||||
fun `process make_default_browser deep link for above API 23`() {
|
||||
assertTrue(processor.process(testIntent("make_default_browser"), navController, out))
|
||||
|
||||
verify { activity.startActivity(any()) }
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
@Config(maxSdk = M)
|
||||
fun `process make_default_browser deep link for API 23 and below`() {
|
||||
assertTrue(processor.process(testIntent("make_default_browser"), navController, out))
|
||||
|
||||
verify {
|
||||
activity.openToBrowserAndLoad(
|
||||
searchTermOrURL = SupportUtils.getSumoURLForTopic(
|
||||
activity,
|
||||
SupportUtils.SumoTopic.SET_AS_DEFAULT_BROWSER
|
||||
),
|
||||
newTab = true,
|
||||
from = BrowserDirection.FromGlobal,
|
||||
flags = EngineSession.LoadUrlFlags.external()
|
||||
)
|
||||
}
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process settings_notifications deep link`() {
|
||||
assertTrue(processor.process(testIntent("settings_notifications"), navController, out))
|
||||
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
verify { activity.startActivity(any()) }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `process install_search_widget deep link`() {
|
||||
mockkObject(SearchWidgetCreator)
|
||||
every { SearchWidgetCreator.createSearchWidget(any()) } returns true
|
||||
assertTrue(processor.process(testIntent("install_search_widget"), navController, out))
|
||||
|
||||
verify { navController wasNot Called }
|
||||
verify { out wasNot Called }
|
||||
verify { activity wasNot Called }
|
||||
}
|
||||
|
||||
private fun testIntent(uri: String) = Intent("", "$DEEP_LINK_SCHEME://$uri".toUri())
|
||||
}
|
||||
@ -1,34 +0,0 @@
|
||||
/* 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.push
|
||||
|
||||
import android.app.Notification
|
||||
import androidx.core.app.NotificationCompat
|
||||
import io.mockk.Called
|
||||
import io.mockk.mockk
|
||||
import io.mockk.verify
|
||||
import org.junit.Test
|
||||
import org.mozilla.fenix.R
|
||||
|
||||
class LeanplumNotificationCustomizerTest {
|
||||
|
||||
private val customizer = LeanplumNotificationCustomizer()
|
||||
|
||||
@Test
|
||||
fun `customize adds icon`() {
|
||||
val builder = mockk<NotificationCompat.Builder>(relaxed = true)
|
||||
customizer.customize(builder, mockk())
|
||||
|
||||
verify { builder.setSmallIcon(R.drawable.ic_status_logo) }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `customize for BigPictureStyle does nothing`() {
|
||||
val builder = mockk<Notification.Builder>()
|
||||
customizer.customize(builder, mockk(), mockk())
|
||||
|
||||
verify { builder wasNot Called }
|
||||
}
|
||||
}
|
||||
@ -1,376 +0,0 @@
|
||||
MMA (Mobile Marketing Automation)
|
||||
================================
|
||||
|
||||
Mozilla wants to engage with users more. MMA is the project for this purpose. When a user performs a certain UI action (or set of UI actions), she will see a prompt and have a chance to interact with it. For example, if a user uses Firefox 10 times a week, but Firefox is not her default browser, we'll prompt the user the next time when she launches our app, and guide her to set us as default browser.
|
||||
|
||||
Mozilla is using a third party framework called "Leanplum" in order to achieve this. Leanplum is a San Francisco company, founded in 2012. We put their SDK in our codebase via Carthage.
|
||||
|
||||
The SDK is documented at https://www.leanplum.com/docs/android
|
||||
|
||||
There are four major components in Leanplum SDK.
|
||||
1. Events : Events are fired when users perform certain actions.
|
||||
2. User Attributes: User Attributes are set on a per-user basis, and inform us about an aspect of the user.
|
||||
3. Deep Links: Actions that users can perform to interact with the Message.
|
||||
4. Messages: User Interaction points that we want to engage with users that help them use Firefox better.
|
||||
|
||||
An Event or a series of Events plus some User Attributes may trigger a Message, and when the user acts on the Message, a Deep Link may be processed.
|
||||
|
||||
|
||||
Data collection
|
||||
=====================================================
|
||||
|
||||
|
||||
Who will have Leanplum enabled?
|
||||
======================================================
|
||||
|
||||
Everyone with Telemetry enabled.
|
||||
|
||||
|
||||
Where does data sent to the Leanplum backend go?
|
||||
==============================================
|
||||
|
||||
The Leanplum SDK is hard-coded to send data to the endpoint https://www.leanplum.com. The endpoint is
|
||||
defined by ``com.leanplum.internal.Constants.API_HOST_NAME`` at https://github.com/Leanplum/Leanplum-Android-SDK/blob/master/AndroidSDKCore/src/main/java/com/leanplum/internal/Constants.java#L32
|
||||
|
||||
The user is identified by Leanplum using a random UUID generated by us when Leanplum is initialized for the first time. See: https://github.com/mozilla-mobile/fenix/blob/master/app/src/main/java/org/mozilla/fenix/components/metrics/LeanplumMetricsService.kt
|
||||
This unique identifier is only used by Leanplum and can't be tracked back to any Firefox users.
|
||||
|
||||
|
||||
What data is collected and sent to the Leanplum backend?
|
||||
======================================================
|
||||
|
||||
The Leanplum SDK collects and sends the following information at various times while the SDK is in use.
|
||||
|
||||
Sent every time when an event is triggered:
|
||||
~~~~~~~~~~~~~~~
|
||||
"action" -> "track" // track: an event is tracked.
|
||||
"event" -> "Launch" // Used when an event is triggered. e.g. E_Saved_Bookmark.
|
||||
"info" -> "" // Used when an event is triggered. Basic context associated with the event.
|
||||
"value" -> 0.0 // Used when an event is triggered. Value of that event.
|
||||
"messageId" -> 5111602214338560 // Used when an event is triggered. The ID of the message.
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Sent when the app starts:
|
||||
~~~~~~~~~~~~~~~
|
||||
"action" -> "start" // start: Leanplum SDK starts. heartbeat
|
||||
"userAttributes" -> "{ // A set of key-value pairs used to describe the user.
|
||||
"Focus Installed" -> true // If Focus for Android is installed.
|
||||
"Klar Installed" -> true // If Klar for Android is installed.
|
||||
"Fennec Installed" -> true // If Fennec for Android is installed.
|
||||
}"
|
||||
"appId" -> "app_6Ao...." // Leanplum App ID.
|
||||
"clientKey" -> "dev_srwDUNZR...." // Leanplum client access key.
|
||||
"systemName" -> "Android" // Fixed String in SDK.
|
||||
"locale" -> "zh_TW" // System Locale.
|
||||
"timezone" -> "Asia/Taipei" // System Timezone.
|
||||
"versionName" -> "55.0a1" // Fennec version.
|
||||
"systemVersion" -> "10.3.1" // System version.
|
||||
"deviceModel" -> "Galaxy" // System device model.
|
||||
"timezoneOffsetSeconds" -> "28800" // User timezone offset with PST.
|
||||
"deviceName" -> "sdaswani-31710" // System device name.
|
||||
"region" -> "(detect)" // Not used. We strip location so this is will be the default stub value in Leanplum SDK.
|
||||
"city" -> "(detect)" // Same as above.
|
||||
"country" -> "(detect)" // Same as above.
|
||||
"location" -> "(detect)" // Same as above.
|
||||
"newsfeedMessages" -> " size = 0" // Not used. New Leanplum Inbox message(Leanplum feature) count.
|
||||
"includeDefaults" -> "false" // Not used. Always false.
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Sent every time a session is renewed or has a state change:
|
||||
~~~~~~~~~~~~~~~
|
||||
"action" -> "heartbeat" // heartbeat: every 15 minutes when app is in the foreground
|
||||
// pauseSession: when app goes to background
|
||||
// resumeSession: when app goes to foreground
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
Sent for every Message:
|
||||
~~~~~~~~~~~~~~~
|
||||
"userId" -> "b13b3c239d01aa7c" // Set by Fennec, we use random uuid so users are anonymous to Leanplum.
|
||||
"deviceId" -> "b13b3c239d01aa7c" // Same as above.
|
||||
"sdkVersion" -> "2.2.2-SNAPSHOT" // Leanplum SDK version.
|
||||
"devMode" -> "true" // If the SDK is in developer mode. For official builds, it's false.
|
||||
"time" -> "1.497595093902E9" // System time in second.
|
||||
"token" -> "nksZ5pa0R5iegC7wj...." // Token come from Leanplum backend.
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Notes on what data is collected
|
||||
===============================
|
||||
User Identifier
|
||||
---------------
|
||||
Since Device ID is a random UUID, Leanplum can't map the device to any know Client ID in Fennec nor Advertising ID.
|
||||
|
||||
User Attributes
|
||||
---------------
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Key</th>
|
||||
<th>Description</th>
|
||||
<th>Data Review</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`default_browser`</td>
|
||||
<td>A string containing the name of the default browser if property of Mozilla or an empty string</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3459#issuecomment-502252010">#3459</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`focus_installed`</td>
|
||||
<td>A boolean indicating that Firefox Focus is installed</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3459#issuecomment-502252010">#3459</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`klar_installed`</td>
|
||||
<td>A boolean indicating that Firefox Klar is installed</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3459#issuecomment-502252010">#3459</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fennec_installed`</td>
|
||||
<td>A boolean indicating that Fennec is installed</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3459#issuecomment-502252010">#3459</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fxa_signed_in`</td>
|
||||
<td>A boolean indicating that the user is signed in to FxA</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4568#issuecomment-519159545">#4568</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fxa_has_synced_items`</td>
|
||||
<td>A boolean indicating that the user has opted to sync at least one category of items with FxA</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4568#issuecomment-519159545">#4568</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`search_widget_installed`</td>
|
||||
<td>A boolean indicating that the user has at least one search widget placed on the home screen</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4694#issuecomment-520591275">#4694</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`tracking_protection_enabled`</td>
|
||||
<td>A boolean indicating that the user has enabled tracking protection</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/11965#issuecomment-649731798">#11965</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`tracking_protection_setting`</td>
|
||||
<td>A string indicating the level at which the user has set tracking protection. Possible values are `none`, `standard`, `strict` and `custom`</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/11965#issuecomment-649731798">#11965</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix`</td>
|
||||
<td>A boolean indicating that this is a Fenix installation</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/8208">#8208</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`installed_addons`</td>
|
||||
<td>A boolean indicating that there are addons installed</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/13233">#13233</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`enabled_addons`</td>
|
||||
<td>A boolean indicating that there are addons enabled</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/13233">#13233</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Events
|
||||
-------
|
||||
Most of the Leanplum events can be mapped to a single combination of Telemetry event (Event+Method+Extra).
|
||||
Some events are not collected in Mozilla Telemetry. This will be addressed separately in each campaign review.
|
||||
There are three elements that are used for each event. They are: event name, value(default: 0.0), and info(default: "").
|
||||
Default value for event value is 0.0. Default value for event info is empty string.
|
||||
|
||||
Here is the list of current Events sent, which can be found here in the code base: https://github.com/mozilla-mobile/fenix/blob/master/app/src/main/java/org/mozilla/fenix/components/metrics/LeanplumMetricsService.kt
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Event</th>
|
||||
<th>Description</th>
|
||||
<th>Data Review</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Opened_App_FirstRun`</td>
|
||||
<td>The first launch after install</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3459#issuecomment-502252010">#3459</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Opened_App`</td>
|
||||
<td>Whenever the App is launched.</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3459#issuecomment-502252010">#3459</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Interact_With_Search_URL_Area`</td>
|
||||
<td>The user interacts with search url area.</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3459#issuecomment-502252010">#3459</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Opened_Bookmark`</td>
|
||||
<td>The user opened a bookmark</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3632#issuecomment-505135753">#3632</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Add_Bookmark`</td>
|
||||
<td>The user added a bookmark</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3632#issuecomment-505135753">#3632</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Remove_Bookmark`</td>
|
||||
<td>The user removed a bookmark</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3632#issuecomment-505135753">#3632</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Collection_Created`</td>
|
||||
<td>The user created a new collection</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4626#issuecomment-519691332">#4626</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Collection_Tab_Opened`</td>
|
||||
<td>The user opened a tab from a previously created collection</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4626#issuecomment-519691332">#4626</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_FxA_New_Signup`</td>
|
||||
<td>The user completed the signup process to new FxA account</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4626#issuecomment-519691332">#4626</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Sign_In_FxA`</td>
|
||||
<td>The user successfully signed in to FxA</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4626#issuecomment-519691332">#4626</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Sign_In_FxA_Fennec_to_Fenix`</td>
|
||||
<td>The user successfully signed in to FxA using previously signed in Fennec account</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4626#issuecomment-519691332">#4626</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Sign_Out_FxA`</td>
|
||||
<td>The user successfully signed out of FxA</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4626#issuecomment-519691332">#4626</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Cleared_Private_Data`</td>
|
||||
<td>The user cleared one or many types of private data</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/4626#issuecomment-519691332">#4626</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Dismissed_Onboarding`</td>
|
||||
<td>The user finished onboarding. Could be triggered by pressing "start browsing," opening settings, or invoking a search.</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/3459#issuecomment-502191109">#3459</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Fennec_To_Fenix_Migrated`</td>
|
||||
<td>The user has just migrated from Fennec to Fenix.</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/8208#issuecomment-584040440">#8208</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Addon_Installed`</td>
|
||||
<td>The user has installed an addon from the addon management page.</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/12136#issuecomment-651922547">#12136</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Search_Widget_Added`</td>
|
||||
<td>The user has installed the search widget to their homescreen.</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/13003">#13003</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Changed_Default_To_Fenix`</td>
|
||||
<td>The user has changed their default browser to Fenix while Fenix was in the background and then resumed the app.</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/13003">#13003</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`E_Changed_ETP`</td>
|
||||
<td>The user has changed their enhanched tracking protection setting.</td>
|
||||
<td><a href="https://github.com/mozilla-mobile/fenix/pull/13003">#13003</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Deep links
|
||||
-------
|
||||
Deep links are hooks utilized by marketing to direct users to certain portions of the application through a link. They can also be invoked by other applications or even users
|
||||
directly to access specific screens quickly.
|
||||
|
||||
Here is the list of current deep links available, which can be found here in the code base: https://github.com/mozilla-mobile/fenix/blob/master/app/src/main/AndroidManifest.xml
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Deep link</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://home`</td>
|
||||
<td>Opens to the Fenix home screen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://urls_bookmarks`</td>
|
||||
<td>Opens to the list of the user's bookmarks at its root</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://urls_history`</td>
|
||||
<td>Opens to the list of pages the user has visited</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://home_collections`</td>
|
||||
<td>Opens to the list of collections the user has saved. It is implemented as `fenix://home`</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings`</td>
|
||||
<td>Opens to the top level settings screen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://turn_on_sync`</td>
|
||||
<td>Opens to the turn on sync screen. **Only valid if the user is not signed in to FxA**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings_search_engine`</td>
|
||||
<td>Opens to the search engine settings screen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings_accessibility`</td>
|
||||
<td>Opens to the accessibility settings screen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings_delete_browsing_data`</td>
|
||||
<td>Opens to the delete browsing data settings screen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings_addon_manager`</td>
|
||||
<td>Opens to the settings page to install and manage addons</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings_logins`</td>
|
||||
<td>Opens to the Logins and passwords settings page configure how logins are treated. This is *not* the list of actual logins</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings_tracking_protection`</td>
|
||||
<td>Opens to the Enhanced Tracking Protection settings page</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings_privacy`</td>
|
||||
<td>Opens to the settings page which contains the privacy settings. Currently, this is the same as `fenix://settings`</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://enable_private_browsing`</td>
|
||||
<td>Opens to the Fenix home screen and enables private browsing</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://open?url={DESIRED_URL}`</td>
|
||||
<td>Creates a new tab, opens to the browser screen and loads the {DESIRED_URL}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://make_default_browser`</td>
|
||||
<td>Opens to the Android default apps settings screen. If Android API <= 23 opens tab to support page defined in SupportUtils.SumoTopic.SET_AS_DEFAULT_BROWSER</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://settings_notifications`</td>
|
||||
<td>Opens to the Android notification settings screen for Fenix. **Only works on Android API >=24**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>`fenix://install_search_widget`</td>
|
||||
<td>Adds the search widget to the users launcher homescreen. **Only works on Android API >=26**</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Messages
|
||||
-----------
|
||||
Messages are in-app prompts to the user from Leanplum. The user interaction of that prompt will be sent to the Leanplum backend (such as "Accept" or "Show") to track overall engagement with the Message. The Message is downloaded from Leanplum when the Leanplum SDK is initialized at App start, assuming the fulfillment criteria for the Message is met. As mentioned before, the fulfillment criteria is a set of required Events and User Attributes. The fulfillment criteria are set in the Leanplum backend.
|
||||
|
||||
We currently don't have any messages planned for Firefox Preview
|
||||
@ -1,14 +1,11 @@
|
||||
# Telemetry
|
||||
|
||||
Fenix uses Mozilla's telemetry service (Glean) and LeanPlum to measure feature performance and engagement.
|
||||
Fenix uses Mozilla's telemetry service (Glean) to measure feature performance and engagement.
|
||||
|
||||
## Glean pings and metrics
|
||||
By using the Glean SDK, Fenix can send the pings the SDK owns and defines, as documented [in the Glean SDK docs](https://mozilla.github.io/glean/book/user/pings/index.html).
|
||||
|
||||
Additional metrics or pings defined by Fenix are documented in the [Glean SDK autogenerated docs](metrics.md).
|
||||
|
||||
## Leanplum
|
||||
See [here](https://github.com/mozilla-mobile/fenix/blob/master/docs/mma.md) for details on Leanplum usage in Firefox for Android.
|
||||
|
||||
## Crash reporting
|
||||
See [here](https://github.com/mozilla-mobile/fenix/blob/master/docs/crash-reporting.md) for details on crash reporting in Firefox for Android.
|
||||
|
||||
Loading…
Reference in New Issue