|
|
|
/* 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 androidx.annotation.VisibleForTesting
|
|
|
|
import com.leanplum.Leanplum
|
|
|
|
import mozilla.components.browser.awesomebar.facts.BrowserAwesomeBarFacts
|
|
|
|
import mozilla.components.browser.menu.facts.BrowserMenuFacts
|
|
|
|
import mozilla.components.browser.toolbar.facts.ToolbarFacts
|
|
|
|
import mozilla.components.concept.awesomebar.AwesomeBar
|
|
|
|
import mozilla.components.feature.awesomebar.facts.AwesomeBarFacts
|
|
|
|
import mozilla.components.feature.awesomebar.provider.BookmarksStorageSuggestionProvider
|
|
|
|
import mozilla.components.feature.awesomebar.provider.ClipboardSuggestionProvider
|
|
|
|
import mozilla.components.feature.awesomebar.provider.HistoryStorageSuggestionProvider
|
|
|
|
import mozilla.components.feature.awesomebar.provider.SearchSuggestionProvider
|
|
|
|
import mozilla.components.feature.awesomebar.provider.SessionSuggestionProvider
|
|
|
|
import mozilla.components.feature.contextmenu.facts.ContextMenuFacts
|
|
|
|
import mozilla.components.feature.customtabs.CustomTabsFacts
|
|
|
|
import mozilla.components.feature.downloads.facts.DownloadsFacts
|
|
|
|
import mozilla.components.feature.findinpage.facts.FindInPageFacts
|
|
|
|
import mozilla.components.feature.media.facts.MediaFacts
|
|
|
|
import mozilla.components.feature.prompts.dialog.LoginDialogFacts
|
|
|
|
import mozilla.components.feature.pwa.ProgressiveWebAppFacts
|
|
|
|
import mozilla.components.feature.syncedtabs.facts.SyncedTabsFacts
|
|
|
|
import mozilla.components.feature.top.sites.facts.TopSitesFacts
|
|
|
|
import mozilla.components.lib.dataprotect.SecurePrefsReliabilityExperiment
|
|
|
|
import mozilla.components.support.base.Component
|
|
|
|
import mozilla.components.support.base.facts.Action
|
|
|
|
import mozilla.components.support.base.facts.Fact
|
|
|
|
import mozilla.components.support.base.facts.FactProcessor
|
|
|
|
import mozilla.components.support.base.facts.Facts
|
|
|
|
import mozilla.components.support.base.log.logger.Logger
|
|
|
|
import mozilla.components.support.webextensions.facts.WebExtensionFacts
|
|
|
|
import org.mozilla.fenix.BuildConfig
|
|
|
|
import org.mozilla.fenix.GleanMetrics.PerfAwesomebar
|
|
|
|
import org.mozilla.fenix.search.awesomebar.ShortcutsSuggestionProvider
|
|
|
|
import org.mozilla.fenix.utils.Settings
|
|
|
|
|
|
|
|
interface MetricController {
|
|
|
|
fun start(type: MetricServiceType)
|
|
|
|
fun stop(type: MetricServiceType)
|
|
|
|
fun track(event: Event)
|
|
|
|
|
|
|
|
companion object {
|
|
|
|
fun create(
|
|
|
|
services: List<MetricsService>,
|
|
|
|
isDataTelemetryEnabled: () -> Boolean,
|
|
|
|
isMarketingDataTelemetryEnabled: () -> Boolean,
|
|
|
|
settings: Settings
|
|
|
|
): MetricController {
|
|
|
|
return if (BuildConfig.TELEMETRY) {
|
|
|
|
ReleaseMetricController(
|
|
|
|
services,
|
|
|
|
isDataTelemetryEnabled,
|
|
|
|
isMarketingDataTelemetryEnabled,
|
|
|
|
settings
|
|
|
|
)
|
|
|
|
} else DebugMetricController()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
@VisibleForTesting
|
|
|
|
internal class DebugMetricController(
|
|
|
|
private val logger: Logger = Logger()
|
|
|
|
) : MetricController {
|
|
|
|
|
|
|
|
override fun start(type: MetricServiceType) {
|
|
|
|
logger.debug("DebugMetricController: start")
|
|
|
|
}
|
|
|
|
|
|
|
|
override fun stop(type: MetricServiceType) {
|
|
|
|
logger.debug("DebugMetricController: stop")
|
|
|
|
}
|
|
|
|
|
|
|
|
override fun track(event: Event) {
|
|
|
|
logger.debug("DebugMetricController: track event: $event")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
@VisibleForTesting
|
|
|
|
@Suppress("LargeClass")
|
|
|
|
internal class ReleaseMetricController(
|
|
|
|
private val services: List<MetricsService>,
|
|
|
|
private val isDataTelemetryEnabled: () -> Boolean,
|
|
|
|
private val isMarketingDataTelemetryEnabled: () -> Boolean,
|
|
|
|
private val settings: Settings
|
|
|
|
) : MetricController {
|
|
|
|
private var initialized = mutableSetOf<MetricServiceType>()
|
|
|
|
|
|
|
|
init {
|
|
|
|
Facts.registerProcessor(object : FactProcessor {
|
|
|
|
override fun process(fact: Fact) {
|
|
|
|
fact.toEvent()?.also {
|
|
|
|
track(it)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
override fun start(type: MetricServiceType) {
|
|
|
|
val isEnabled = isTelemetryEnabled(type)
|
|
|
|
val isInitialized = isInitialized(type)
|
|
|
|
if (!isEnabled || isInitialized) {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
services
|
|
|
|
.filter { it.type == type }
|
|
|
|
.forEach { it.start() }
|
|
|
|
|
|
|
|
initialized.add(type)
|
|
|
|
}
|
|
|
|
|
|
|
|
override fun stop(type: MetricServiceType) {
|
|
|
|
val isEnabled = isTelemetryEnabled(type)
|
|
|
|
val isInitialized = isInitialized(type)
|
|
|
|
if (isEnabled || !isInitialized) {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
services
|
|
|
|
.filter { it.type == type }
|
|
|
|
.forEach { it.stop() }
|
|
|
|
|
|
|
|
initialized.remove(type)
|
|
|
|
}
|
|
|
|
|
|
|
|
override fun track(event: Event) {
|
|
|
|
services
|
|
|
|
.filter { it.shouldTrack(event) }
|
|
|
|
.forEach {
|
|
|
|
val isEnabled = isTelemetryEnabled(it.type)
|
|
|
|
val isInitialized = isInitialized(it.type)
|
|
|
|
if (!isEnabled || !isInitialized) {
|
|
|
|
return@forEach
|
|
|
|
}
|
|
|
|
|
|
|
|
it.track(event)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
@VisibleForTesting
|
|
|
|
internal fun factToEvent(
|
|
|
|
fact: Fact
|
|
|
|
): Event? {
|
|
|
|
return fact.toEvent()
|
|
|
|
}
|
|
|
|
|
|
|
|
private fun isInitialized(type: MetricServiceType): Boolean = initialized.contains(type)
|
|
|
|
|
|
|
|
private fun isTelemetryEnabled(type: MetricServiceType): Boolean = when (type) {
|
|
|
|
MetricServiceType.Data -> isDataTelemetryEnabled()
|
|
|
|
MetricServiceType.Marketing -> isMarketingDataTelemetryEnabled()
|
|
|
|
}
|
|
|
|
|
|
|
|
@Suppress("LongMethod")
|
|
|
|
private fun Fact.toEvent(): Event? = when (Pair(component, item)) {
|
|
|
|
Component.FEATURE_PROMPTS to LoginDialogFacts.Items.DISPLAY -> Event.LoginDialogPromptDisplayed
|
|
|
|
Component.FEATURE_PROMPTS to LoginDialogFacts.Items.CANCEL -> Event.LoginDialogPromptCancelled
|
|
|
|
Component.FEATURE_PROMPTS to LoginDialogFacts.Items.NEVER_SAVE -> Event.LoginDialogPromptNeverSave
|
|
|
|
Component.FEATURE_PROMPTS to LoginDialogFacts.Items.SAVE -> Event.LoginDialogPromptSave
|
|
|
|
|
|
|
|
Component.FEATURE_FINDINPAGE to FindInPageFacts.Items.CLOSE -> Event.FindInPageClosed
|
|
|
|
Component.FEATURE_FINDINPAGE to FindInPageFacts.Items.INPUT -> Event.FindInPageSearchCommitted
|
|
|
|
Component.FEATURE_CONTEXTMENU to ContextMenuFacts.Items.ITEM -> {
|
|
|
|
metadata?.get("item")?.let { Event.ContextMenuItemTapped.create(it.toString()) }
|
|
|
|
}
|
|
|
|
Component.FEATURE_CONTEXTMENU to ContextMenuFacts.Items.TEXT_SELECTION_OPTION -> {
|
|
|
|
when (metadata?.get("textSelectionOption")?.toString()) {
|
|
|
|
CONTEXT_MENU_COPY -> Event.ContextMenuCopyTapped
|
|
|
|
CONTEXT_MENU_SEARCH, CONTEXT_MENU_SEARCH_PRIVATELY -> Event.ContextMenuSearchTapped
|
|
|
|
CONTEXT_MENU_SELECT_ALL -> Event.ContextMenuSelectAllTapped
|
|
|
|
CONTEXT_MENU_SHARE -> Event.ContextMenuShareTapped
|
|
|
|
else -> null
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Component.BROWSER_TOOLBAR to ToolbarFacts.Items.MENU -> {
|
|
|
|
metadata?.get("customTab")?.let { Event.CustomTabsMenuOpened }
|
|
|
|
}
|
|
|
|
Component.BROWSER_MENU to BrowserMenuFacts.Items.WEB_EXTENSION_MENU_ITEM -> {
|
|
|
|
metadata?.get("id")?.let { Event.AddonsOpenInToolbarMenu(it.toString()) }
|
|
|
|
}
|
|
|
|
Component.FEATURE_CUSTOMTABS to CustomTabsFacts.Items.CLOSE -> Event.CustomTabsClosed
|
|
|
|
Component.FEATURE_CUSTOMTABS to CustomTabsFacts.Items.ACTION_BUTTON -> Event.CustomTabsActionTapped
|
|
|
|
|
|
|
|
Component.FEATURE_DOWNLOADS to DownloadsFacts.Items.NOTIFICATION -> {
|
|
|
|
when (action) {
|
|
|
|
Action.CANCEL -> Event.NotificationDownloadCancel
|
|
|
|
Action.OPEN -> Event.NotificationDownloadOpen
|
|
|
|
Action.PAUSE -> Event.NotificationDownloadPause
|
|
|
|
Action.RESUME -> Event.NotificationDownloadResume
|
|
|
|
Action.TRY_AGAIN -> Event.NotificationDownloadTryAgain
|
|
|
|
else -> null
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Component.FEATURE_MEDIA to MediaFacts.Items.NOTIFICATION -> {
|
|
|
|
when (action) {
|
|
|
|
Action.PLAY -> Event.NotificationMediaPlay
|
|
|
|
Action.PAUSE -> Event.NotificationMediaPause
|
|
|
|
else -> null
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Component.FEATURE_MEDIA to MediaFacts.Items.STATE -> {
|
|
|
|
when (action) {
|
|
|
|
Action.PLAY -> Event.MediaPlayState
|
|
|
|
Action.PAUSE -> Event.MediaPauseState
|
|
|
|
Action.STOP -> Event.MediaStopState
|
|
|
|
else -> null
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Component.SUPPORT_WEBEXTENSIONS to WebExtensionFacts.Items.WEB_EXTENSIONS_INITIALIZED -> {
|
|
|
|
metadata?.get("installed")?.let { installedAddons ->
|
|
|
|
if (installedAddons is List<*>) {
|
|
|
|
settings.installedAddonsCount = installedAddons.size
|
|
|
|
settings.installedAddonsList = installedAddons.joinToString(",")
|
|
|
|
Leanplum.setUserAttributes(mapOf("installed_addons" to installedAddons.size))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
metadata?.get("enabled")?.let { enabledAddons ->
|
|
|
|
if (enabledAddons is List<*>) {
|
|
|
|
settings.enabledAddonsCount = enabledAddons.size
|
|
|
|
settings.enabledAddonsList = enabledAddons.joinToString()
|
|
|
|
Leanplum.setUserAttributes(mapOf("enabled_addons" to enabledAddons.size))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
null
|
|
|
|
}
|
|
|
|
Component.BROWSER_AWESOMEBAR to BrowserAwesomeBarFacts.Items.PROVIDER_DURATION -> {
|
|
|
|
metadata?.get(BrowserAwesomeBarFacts.MetadataKeys.DURATION_PAIR)?.let { providerTiming ->
|
|
|
|
require(providerTiming is Pair<*, *>) { "Expected providerTiming to be a Pair" }
|
|
|
|
when (val provider = providerTiming.first as AwesomeBar.SuggestionProvider) {
|
|
|
|
is HistoryStorageSuggestionProvider -> PerfAwesomebar.historySuggestions
|
|
|
|
is BookmarksStorageSuggestionProvider -> PerfAwesomebar.bookmarkSuggestions
|
|
|
|
is SessionSuggestionProvider -> PerfAwesomebar.sessionSuggestions
|
|
|
|
is SearchSuggestionProvider -> PerfAwesomebar.searchEngineSuggestions
|
|
|
|
is ClipboardSuggestionProvider -> PerfAwesomebar.clipboardSuggestions
|
|
|
|
is ShortcutsSuggestionProvider -> PerfAwesomebar.shortcutsSuggestions
|
|
|
|
// NB: add PerfAwesomebar.syncedTabsSuggestions once we're using SyncedTabsSuggestionProvider
|
|
|
|
else -> {
|
|
|
|
Logger("Metrics").error("Unknown suggestion provider: $provider")
|
|
|
|
null
|
|
|
|
}
|
|
|
|
}?.accumulateSamples(longArrayOf(providerTiming.second as Long))
|
|
|
|
}
|
|
|
|
null
|
|
|
|
}
|
|
|
|
Component.FEATURE_PWA to ProgressiveWebAppFacts.Items.HOMESCREEN_ICON_TAP -> {
|
|
|
|
Event.ProgressiveWebAppOpenFromHomescreenTap
|
|
|
|
}
|
|
|
|
Component.FEATURE_PWA to ProgressiveWebAppFacts.Items.INSTALL_SHORTCUT -> {
|
|
|
|
Event.ProgressiveWebAppInstallAsShortcut
|
|
|
|
}
|
|
|
|
Component.FEATURE_TOP_SITES to TopSitesFacts.Items.COUNT -> {
|
|
|
|
value?.let {
|
|
|
|
var count = 0
|
|
|
|
try {
|
|
|
|
count = it.toInt()
|
|
|
|
} catch (e: NumberFormatException) {
|
|
|
|
// Do nothing
|
|
|
|
}
|
|
|
|
|
|
|
|
settings.topSitesSize = count
|
|
|
|
}
|
|
|
|
null
|
|
|
|
}
|
|
|
|
Component.FEATURE_SYNCEDTABS to SyncedTabsFacts.Items.SYNCED_TABS_SUGGESTION_CLICKED -> {
|
|
|
|
Event.SyncedTabSuggestionClicked
|
|
|
|
}
|
|
|
|
Component.FEATURE_AWESOMEBAR to AwesomeBarFacts.Items.BOOKMARK_SUGGESTION_CLICKED -> {
|
|
|
|
Event.BookmarkSuggestionClicked
|
|
|
|
}
|
|
|
|
Component.FEATURE_AWESOMEBAR to AwesomeBarFacts.Items.CLIPBOARD_SUGGESTION_CLICKED -> {
|
|
|
|
Event.ClipboardSuggestionClicked
|
|
|
|
}
|
|
|
|
Component.FEATURE_AWESOMEBAR to AwesomeBarFacts.Items.HISTORY_SUGGESTION_CLICKED -> {
|
|
|
|
Event.HistorySuggestionClicked
|
|
|
|
}
|
|
|
|
Component.FEATURE_AWESOMEBAR to AwesomeBarFacts.Items.SEARCH_ACTION_CLICKED -> {
|
|
|
|
Event.SearchActionClicked
|
|
|
|
}
|
|
|
|
Component.FEATURE_AWESOMEBAR to AwesomeBarFacts.Items.SEARCH_SUGGESTION_CLICKED -> {
|
|
|
|
Event.SearchSuggestionClicked
|
|
|
|
}
|
|
|
|
Component.FEATURE_AWESOMEBAR to AwesomeBarFacts.Items.OPENED_TAB_SUGGESTION_CLICKED -> {
|
|
|
|
Event.OpenedTabSuggestionClicked
|
|
|
|
}
|
|
|
|
|
|
|
|
Component.LIB_DATAPROTECT to SecurePrefsReliabilityExperiment.Companion.Actions.EXPERIMENT -> {
|
|
|
|
Event.SecurePrefsExperimentFailure(metadata?.get("javaClass") as String? ?: "null")
|
|
|
|
}
|
|
|
|
Component.LIB_DATAPROTECT to SecurePrefsReliabilityExperiment.Companion.Actions.GET -> {
|
|
|
|
if (SecurePrefsReliabilityExperiment.Companion.Values.FAIL.v == value?.toInt()) {
|
|
|
|
Event.SecurePrefsGetFailure(metadata?.get("javaClass") as String? ?: "null")
|
|
|
|
} else {
|
|
|
|
Event.SecurePrefsGetSuccess(value ?: "")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Component.LIB_DATAPROTECT to SecurePrefsReliabilityExperiment.Companion.Actions.WRITE -> {
|
|
|
|
if (SecurePrefsReliabilityExperiment.Companion.Values.FAIL.v == value?.toInt()) {
|
|
|
|
Event.SecurePrefsWriteFailure(metadata?.get("javaClass") as String? ?: "null")
|
|
|
|
} else {
|
|
|
|
Event.SecurePrefsWriteSuccess
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Component.LIB_DATAPROTECT to SecurePrefsReliabilityExperiment.Companion.Actions.RESET -> {
|
|
|
|
Event.SecurePrefsReset
|
|
|
|
}
|
|
|
|
|
|
|
|
else -> null
|
|
|
|
}
|
|
|
|
|
|
|
|
companion object {
|
|
|
|
/**
|
|
|
|
* Text selection long press context items to be tracked.
|
|
|
|
*/
|
|
|
|
const val CONTEXT_MENU_COPY = "org.mozilla.geckoview.COPY"
|
|
|
|
const val CONTEXT_MENU_SEARCH = "CUSTOM_CONTEXT_MENU_SEARCH"
|
|
|
|
const val CONTEXT_MENU_SEARCH_PRIVATELY = "CUSTOM_CONTEXT_MENU_SEARCH_PRIVATELY"
|
|
|
|
const val CONTEXT_MENU_SELECT_ALL = "org.mozilla.geckoview.SELECT_ALL"
|
|
|
|
const val CONTEXT_MENU_SHARE = "CUSTOM_CONTEXT_MENU_SHARE"
|
|
|
|
}
|
|
|
|
}
|