Bug 1833638 - remove client ID duplication code
Bruno Rosa
1 year ago
committed by
mergify[bot]
parent
4291ce211e
commit
ef95f337f3
@ -1,43 +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.clientdeduplication
|
||||
|
||||
import android.content.Context
|
||||
import androidx.lifecycle.Lifecycle
|
||||
import androidx.lifecycle.LifecycleEventObserver
|
||||
import androidx.lifecycle.LifecycleOwner
|
||||
import org.mozilla.fenix.nimbus.FxNimbus
|
||||
|
||||
/**
|
||||
* This observer allows us to mimic roughly the same schedule as the Glean SDK baseline ping.
|
||||
* https://github.com/mozilla/glean/blob/main/glean-core/android/src/main/java/mozilla/telemetry/glean/scheduler/GleanLifecycleObserver.kt
|
||||
*/
|
||||
class ClientDeduplicationLifecycleObserver(context: Context) : LifecycleEventObserver {
|
||||
private val clientDeduplicationPing = ClientDeduplicationPing(context)
|
||||
|
||||
override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
|
||||
// The ping will only be sent whenever the Nimbus feature is enabled.
|
||||
if (FxNimbus.features.clientDeduplication.value().enabled) {
|
||||
when (event) {
|
||||
Lifecycle.Event.ON_STOP -> {
|
||||
clientDeduplicationPing.triggerPing(active = false)
|
||||
}
|
||||
Lifecycle.Event.ON_START -> {
|
||||
// We use ON_START here because we don't want to incorrectly count metrics in
|
||||
// ON_RESUME as pause/resume can happen when interacting with things like the
|
||||
// navigation shade which could lead to incorrectly recording the start of a
|
||||
// duration, etc.
|
||||
//
|
||||
// https://developer.android.com/reference/android/app/Activity.html#onStart()
|
||||
|
||||
clientDeduplicationPing.triggerPing(active = true)
|
||||
}
|
||||
else -> {
|
||||
// For other lifecycle events, do nothing
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,49 +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.clientdeduplication
|
||||
|
||||
import android.content.Context
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.launch
|
||||
import org.mozilla.fenix.GleanMetrics.ClientDeduplication
|
||||
import org.mozilla.fenix.GleanMetrics.Pings
|
||||
import org.mozilla.fenix.components.metrics.MetricsUtils.getHashedIdentifier
|
||||
|
||||
/**
|
||||
* Class to help construct and send the `clientDeduplication` ping.
|
||||
*/
|
||||
class ClientDeduplicationPing(private val context: Context) {
|
||||
private val customHashingSalt = "bug-1813195-02-2023"
|
||||
|
||||
/**
|
||||
* Fills the metrics and triggers the 'clientDeduplication' ping.
|
||||
*/
|
||||
internal fun triggerPing(active: Boolean) {
|
||||
CoroutineScope(Dispatchers.IO).launch {
|
||||
val hashedId = getHashedIdentifier(context, customHashingSalt)
|
||||
|
||||
// Record the metrics.
|
||||
if (hashedId != null) {
|
||||
// We have a valid, hashed Google Advertising ID.
|
||||
ClientDeduplication.hashedGaid.set(hashedId)
|
||||
ClientDeduplication.validAdvertisingId.set(true)
|
||||
} else {
|
||||
ClientDeduplication.validAdvertisingId.set(false)
|
||||
}
|
||||
ClientDeduplication.experimentTimeframe.set(customHashingSalt)
|
||||
|
||||
// Set the reason based on if the app is foregrounded or backgrounded.
|
||||
val reason = if (active) {
|
||||
Pings.clientDeduplicationReasonCodes.active
|
||||
} else {
|
||||
Pings.clientDeduplicationReasonCodes.inactive
|
||||
}
|
||||
|
||||
// Submit the ping.
|
||||
Pings.clientDeduplication.submit(reason)
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,41 +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.clientdeduplication
|
||||
|
||||
import mozilla.components.service.glean.testing.GleanTestRule
|
||||
import mozilla.components.support.test.robolectric.testContext
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Assert.assertTrue
|
||||
import org.junit.Rule
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import org.mozilla.fenix.GleanMetrics.ClientDeduplication
|
||||
import org.mozilla.fenix.GleanMetrics.Pings
|
||||
import org.mozilla.fenix.helpers.FenixRobolectricTestRunner
|
||||
|
||||
// For gleanTestRule
|
||||
@RunWith(FenixRobolectricTestRunner::class)
|
||||
internal class ClientDeduplicationPingTest {
|
||||
@get:Rule
|
||||
val gleanTestRule = GleanTestRule(testContext)
|
||||
|
||||
@Test
|
||||
fun `The clientDeduplication ping is sent`() {
|
||||
// Record test data.
|
||||
ClientDeduplication.validAdvertisingId.set(true)
|
||||
|
||||
// Instruct the ping API to validate the ping data.
|
||||
var validatorRun = false
|
||||
Pings.clientDeduplication.testBeforeNextSubmit { reason ->
|
||||
assertEquals(Pings.clientDeduplicationReasonCodes.active, reason)
|
||||
assertEquals(true, ClientDeduplication.validAdvertisingId.testGetValue())
|
||||
validatorRun = true
|
||||
}
|
||||
Pings.clientDeduplication.submit(Pings.clientDeduplicationReasonCodes.active)
|
||||
|
||||
// Verify that the validator ran.
|
||||
assertTrue(validatorRun)
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue