Merge changes from topic "catalyst" into main

* changes:
  [Catalyst] Update metrics logging for AirplaneModePreference
  [Catalyst] Setup metrics logger for preference ui action

src/com/android/settings/Metrics.kt

@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) 2025 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings
+
+import android.content.Context
+import com.android.settings.overlay.FeatureFactory
+import com.android.settingslib.core.instrumentation.MetricsFeatureProvider
+import com.android.settingslib.metadata.PreferenceUiActionMetricsLogger
+import com.android.settingslib.metadata.PreferenceMetadata
+import com.android.settingslib.metadata.PreferenceScreenMetadata
+
+/** Provides metrics for preference action. */
+interface PreferenceActionMetricsProvider {
+
+    /** Metrics action id for the preference. */
+    val preferenceActionMetrics: Int
+}
+
+/** [PreferenceUiActionMetricsLogger] of Settings app. */
+class SettingsMetricsLogger
+@JvmOverloads
+constructor(
+    private val context: Context,
+    private val metricsFeatureProvider: MetricsFeatureProvider =
+        FeatureFactory.featureFactory.metricsFeatureProvider,
+) : PreferenceUiActionMetricsLogger {
+
+    override fun logPreferenceValueChange(
+        screen: PreferenceScreenMetadata,
+        preference: PreferenceMetadata,
+        value: Any?,
+    ) {
+        if (preference !is PreferenceActionMetricsProvider) return
+        when (value) {
+            is Boolean ->
+                metricsFeatureProvider.action(context, preference.preferenceActionMetrics, value)
+            else -> {}
+        }
+    }
+}

src/com/android/settings/SettingsApplication.java

@@ -77,6 +77,8 @@ public class SettingsApplication extends Application {
         if (Flags.catalyst()) {
             PreferenceScreenRegistry.INSTANCE.setPreferenceScreenMetadataFactories(
                     preferenceScreenFactories());
+            PreferenceScreenRegistry.INSTANCE.setPreferenceUiActionMetricsLogger(
+                    new SettingsMetricsLogger(this));
             PreferenceBindingFactory.setDefaultFactory(new SettingsPreferenceBindingFactory());
         }
 

src/com/android/settings/network/AirplaneModePreference.kt

@@ -30,11 +30,11 @@ import android.telephony.TelephonyManager
 import androidx.annotation.DrawableRes
 import androidx.preference.Preference
 import com.android.settings.AirplaneModeEnabler
+import com.android.settings.PreferenceActionMetricsProvider
 import com.android.settings.PreferenceRestrictionMixin
 import com.android.settings.R
 import com.android.settings.Utils
 import com.android.settings.network.SatelliteRepository.Companion.isSatelliteOn
-import com.android.settings.overlay.FeatureFactory.Companion.featureFactory
 import com.android.settingslib.RestrictedSwitchPreference
 import com.android.settingslib.datastore.AbstractKeyedDataObservable
 import com.android.settingslib.datastore.KeyValueStore
@@ -51,6 +51,7 @@ import com.android.settingslib.metadata.SwitchPreference
 // LINT.IfChange
 class AirplaneModePreference :
     SwitchPreference(KEY, R.string.airplane_mode),
+    PreferenceActionMetricsProvider,
     PreferenceAvailabilityProvider,
     PreferenceLifecycleProvider,
     PreferenceRestrictionMixin {
@@ -88,6 +89,9 @@ class AirplaneModePreference :
     override val sensitivityLevel
         get() = SensitivityLevel.HIGH_SENSITIVITY
 
+    override val preferenceActionMetrics: Int
+        get() = ACTION_AIRPLANE_TOGGLE
+
     override fun storage(context: Context): KeyValueStore =
         AirplaneModeStorage(context, SettingsGlobalStore.get(context))
 
@@ -109,16 +113,12 @@ class AirplaneModePreference :
             (settingsStore.getBoolean(key) ?: DEFAULT_VALUE) as T
 
         override fun <T : Any> setValue(key: String, valueType: Class<T>, value: T?) {
-            if (value is Boolean) {
+            if (value !is Boolean) return
             settingsStore.setBoolean(key, value)
 
             val intent = Intent(Intent.ACTION_AIRPLANE_MODE_CHANGED)
             intent.putExtra("state", value)
             context.sendBroadcastAsUser(intent, UserHandle.ALL)
-
-                val metricsFeature = featureFactory.metricsFeatureProvider
-                metricsFeature.action(context, ACTION_AIRPLANE_TOGGLE, value)
-            }
         }
 
         override fun onFirstObserverAdded() {

tests/robotests/Android.bp

@@ -58,7 +58,6 @@ android_robolectric_test {
         "Settings-robo-testutils",
         "Settings-testutils2",
         "SettingsLib-robo-testutils",
-        "SettingsLibPreference-testutils",
         "Settings_robolectric_meta_service_file",
         "aconfig_settings_flags_lib",
         "android.webkit.flags-aconfig-java",
@@ -73,6 +72,7 @@ android_robolectric_test {
         "kotlin-test",
         "mockito-robolectric-prebuilt", // mockito deps order matters!
         "mockito-kotlin2",
+        "SettingsLibPreference-testutils", // order matters because it depends on mockito-kotlin2
         "notification_flags_lib",
         "platform-test-annotations",
         "testables",
@@ -115,6 +115,7 @@ java_library {
     libs: [
         "Robolectric_all-target",
         "Settings-core",
+        "androidx.test.core",
         "mockito-robolectric-prebuilt",
         "truth",
     ],

tests/robotests/src/com/android/settings/network/AirplaneModePreferenceTest.kt

@@ -27,10 +27,11 @@ import android.telephony.TelephonyManager
 import androidx.preference.SwitchPreferenceCompat
 import androidx.test.core.app.ApplicationProvider
 import androidx.test.ext.junit.runners.AndroidJUnit4
-import com.android.settings.testutils.FakeFeatureFactory
+import com.android.settings.testutils.MetricsRule
 import com.android.settingslib.datastore.SettingsGlobalStore
 import com.android.settingslib.preference.createAndBindWidget
 import com.google.common.truth.Truth.assertThat
+import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.mockito.ArgumentMatchers.anyInt
@@ -41,6 +42,7 @@ import org.mockito.kotlin.stub
 
 @RunWith(AndroidJUnit4::class)
 class AirplaneModePreferenceTest {
+    @Rule(order = 0) @JvmField val metricsRule = MetricsRule()
 
     private val mockResources = mock<Resources>()
     private val mockPackageManager = mock<PackageManager>()
@@ -106,24 +108,6 @@ class AirplaneModePreferenceTest {
         assertThat(getValue).isFalse()
     }
 
-    @Test
-    fun setValue_valueTrue_metricsActionAirplaneToggleTrue() {
-        val metricsFeatureProvider = FakeFeatureFactory.setupForTest().metricsFeatureProvider
-
-        airplaneModePreference.storage(context).setBoolean(AirplaneModePreference.KEY, true)
-
-        verify(metricsFeatureProvider).action(context, ACTION_AIRPLANE_TOGGLE, true)
-    }
-
-    @Test
-    fun setValue_valueFalse_metricsActionAirplaneToggleFalse() {
-        val metricsFeatureProvider = FakeFeatureFactory.setupForTest().metricsFeatureProvider
-
-        airplaneModePreference.storage(context).setBoolean(AirplaneModePreference.KEY, false)
-
-        verify(metricsFeatureProvider).action(context, ACTION_AIRPLANE_TOGGLE, false)
-    }
-
     @Test
     fun performClick_defaultOn_checkedIsFalse() {
         SettingsGlobalStore.get(context).setInt(Settings.Global.AIRPLANE_MODE_ON, 1)
@@ -131,6 +115,7 @@ class AirplaneModePreferenceTest {
         val preference = getSwitchPreference().apply { performClick() }
 
         assertThat(preference.isChecked).isFalse()
+        verify(metricsRule.metricsFeatureProvider).action(context, ACTION_AIRPLANE_TOGGLE, false)
     }
 
     @Test
@@ -140,6 +125,7 @@ class AirplaneModePreferenceTest {
         val preference = getSwitchPreference().apply { performClick() }
 
         assertThat(preference.isChecked).isTrue()
+        verify(metricsRule.metricsFeatureProvider).action(context, ACTION_AIRPLANE_TOGGLE, true)
     }
 
     private fun getSwitchPreference(): SwitchPreferenceCompat =

tests/robotests/testutils/com/android/settings/testutils/MetricsRule.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2025 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.testutils
+
+import android.content.Context
+import androidx.test.core.app.ApplicationProvider
+import com.android.settings.SettingsMetricsLogger
+import com.android.settingslib.core.instrumentation.MetricsFeatureProvider
+import com.android.settingslib.metadata.PreferenceScreenRegistry
+import org.junit.rules.TestWatcher
+import org.junit.runner.Description
+
+/** Test rule for metrics. */
+class MetricsRule : TestWatcher() {
+    val metricsFeatureProvider: MetricsFeatureProvider =
+        FakeFeatureFactory.setupForTest().metricsFeatureProvider
+
+    override fun starting(description: Description) {
+        val context: Context = ApplicationProvider.getApplicationContext()
+        PreferenceScreenRegistry.preferenceUiActionMetricsLogger =
+            SettingsMetricsLogger(context, metricsFeatureProvider)
+    }
+
+    override fun finished(description: Description) {
+        PreferenceScreenRegistry.preferenceUiActionMetricsLogger = null
+    }
+}