diff --git a/src/com/android/settings/core/SettingsUIDeviceConfig.java b/src/com/android/settings/core/SettingsUIDeviceConfig.java index b7aa281408d..8c85c82340c 100644 --- a/src/com/android/settings/core/SettingsUIDeviceConfig.java +++ b/src/com/android/settings/core/SettingsUIDeviceConfig.java @@ -33,4 +33,9 @@ public class SettingsUIDeviceConfig { * {@code true} if near by device suggestion is enabled in connected device page */ public static final String BT_NEAR_BY_SUGGESTION_ENABLED = "bt_near_by_suggestion_enabled"; + + /** + * {@code true} whether or not event_log for generic actions is enabled. Default is true. + */ + public static final String GENERIC_EVENT_LOGGING_ENABLED = "event_logging_enabled"; } diff --git a/src/com/android/settings/core/instrumentation/SettingsEventLogWriter.java b/src/com/android/settings/core/instrumentation/SettingsEventLogWriter.java new file mode 100644 index 00000000000..a58555fe11f --- /dev/null +++ b/src/com/android/settings/core/instrumentation/SettingsEventLogWriter.java @@ -0,0 +1,71 @@ +/* + * Copyright (C) 2019 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.core.instrumentation; + +import android.content.Context; +import android.provider.DeviceConfig; + +import com.android.settings.core.SettingsUIDeviceConfig; +import com.android.settingslib.core.instrumentation.EventLogWriter; + +public class SettingsEventLogWriter extends EventLogWriter { + + @Override + public void visible(Context context, int source, int category) { + if (shouldDisableGenericEventLogging()) { + return; + } + super.visible(context, source, category); + } + + @Override + public void hidden(Context context, int category) { + if (shouldDisableGenericEventLogging()) { + return; + } + super.hidden(context, category); + } + + @Override + public void action(Context context, int category, String pkg) { + if (shouldDisableGenericEventLogging()) { + return; + } + super.action(context, category, pkg); + } + + @Override + public void action(Context context, int category, int value) { + if (shouldDisableGenericEventLogging()) { + return; + } + super.action(context, category, value); + } + + @Override + public void action(Context context, int category, boolean value) { + if (shouldDisableGenericEventLogging()) { + return; + } + super.action(context, category, value); + } + + private static boolean shouldDisableGenericEventLogging() { + return !DeviceConfig.getBoolean(DeviceConfig.NAMESPACE_SETTINGS_UI, + SettingsUIDeviceConfig.GENERIC_EVENT_LOGGING_ENABLED, true /* default */); + } +} diff --git a/src/com/android/settings/core/instrumentation/SettingsMetricsFeatureProvider.java b/src/com/android/settings/core/instrumentation/SettingsMetricsFeatureProvider.java index ec057572053..01927fd2d53 100644 --- a/src/com/android/settings/core/instrumentation/SettingsMetricsFeatureProvider.java +++ b/src/com/android/settings/core/instrumentation/SettingsMetricsFeatureProvider.java @@ -17,14 +17,29 @@ package com.android.settings.core.instrumentation; import android.content.Context; +import android.util.Log; +import android.util.Pair; import com.android.settingslib.core.instrumentation.MetricsFeatureProvider; public class SettingsMetricsFeatureProvider extends MetricsFeatureProvider { + private static final String TAG = "SettingsMetricsFeature"; + @Override protected void installLogWriters() { - super.installLogWriters(); mLoggerWriters.add(new StatsLogWriter()); + mLoggerWriters.add(new SettingsEventLogWriter()); mLoggerWriters.add(new SettingsIntelligenceLogWriter()); } + + /** + * @deprecated Use {@link #action(int, int, int, String, int)} instead. + */ + @Deprecated + @Override + public void action(Context context, int category, Pair... taggedData) { + Log.w(TAG, "action(Pair... taggedData) is deprecated, " + + "Use action(int, int, int, String, int) instead."); + super.action(context, category, taggedData); + } } diff --git a/tests/robotests/src/com/android/settings/core/instrumentation/SettingsEventLogWriterTest.java b/tests/robotests/src/com/android/settings/core/instrumentation/SettingsEventLogWriterTest.java new file mode 100644 index 00000000000..ba2553de517 --- /dev/null +++ b/tests/robotests/src/com/android/settings/core/instrumentation/SettingsEventLogWriterTest.java @@ -0,0 +1,122 @@ +/* + * Copyright (C) 2019 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.core.instrumentation; + + +import static com.google.common.truth.Truth.assertThat; + +import android.app.settings.SettingsEnums; +import android.content.Context; +import android.metrics.LogMaker; +import android.provider.DeviceConfig; + +import com.android.internal.logging.MetricsLogger; +import com.android.settings.core.SettingsUIDeviceConfig; +import com.android.settings.testutils.shadow.ShadowDeviceConfig; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.robolectric.RobolectricTestRunner; +import org.robolectric.RuntimeEnvironment; +import org.robolectric.annotation.Config; +import org.robolectric.annotation.Implementation; +import org.robolectric.annotation.Implements; +import org.robolectric.annotation.Resetter; + +@RunWith(RobolectricTestRunner.class) +@Config(shadows = {ShadowDeviceConfig.class, SettingsEventLogWriterTest.ShadowMetricsLogger.class}) +public class SettingsEventLogWriterTest { + + private SettingsEventLogWriter mWriter; + + @Before + public void setUp() { + mWriter = new SettingsEventLogWriter(); + } + + @After + public void tearDown() { + ShadowDeviceConfig.reset(); + ShadowMetricsLogger.reset(); + } + + @Test + public void visible_eventLogEnabled_shouldLog() { + DeviceConfig.setProperty(DeviceConfig.NAMESPACE_SETTINGS_UI, + SettingsUIDeviceConfig.GENERIC_EVENT_LOGGING_ENABLED, "true", true); + + mWriter.visible(RuntimeEnvironment.application, SettingsEnums.PAGE_UNKNOWN, + SettingsEnums.SETTINGS_HOMEPAGE); + + assertThat(ShadowMetricsLogger.sActionLoggedCount).isEqualTo(1); + } + + @Test + public void hidden_eventLogEnabled_shouldLog() { + DeviceConfig.setProperty(DeviceConfig.NAMESPACE_SETTINGS_UI, + SettingsUIDeviceConfig.GENERIC_EVENT_LOGGING_ENABLED, "true", true); + + mWriter.hidden(RuntimeEnvironment.application, SettingsEnums.SETTINGS_HOMEPAGE); + + assertThat(ShadowMetricsLogger.sActionLoggedCount).isEqualTo(1); + } + + @Test + public void visible_eventLogDisabled_shouldNotLog() { + DeviceConfig.setProperty(DeviceConfig.NAMESPACE_SETTINGS_UI, + SettingsUIDeviceConfig.GENERIC_EVENT_LOGGING_ENABLED, "false", true); + + mWriter.visible(RuntimeEnvironment.application, SettingsEnums.PAGE_UNKNOWN, + SettingsEnums.SETTINGS_HOMEPAGE); + + assertThat(ShadowMetricsLogger.sActionLoggedCount).isEqualTo(0); + } + + @Test + public void hidden_eventLogDisabled_shouldNotLog() { + DeviceConfig.setProperty(DeviceConfig.NAMESPACE_SETTINGS_UI, + SettingsUIDeviceConfig.GENERIC_EVENT_LOGGING_ENABLED, "false", true); + + mWriter.hidden(RuntimeEnvironment.application, SettingsEnums.SETTINGS_HOMEPAGE); + + assertThat(ShadowMetricsLogger.sActionLoggedCount).isEqualTo(0); + } + + @Implements(MetricsLogger.class) + public static class ShadowMetricsLogger { + + public static int sActionLoggedCount = 0; + + @Resetter + public static void reset() { + sActionLoggedCount = 0; + } + + @Implementation + protected static void action(LogMaker content) { + sActionLoggedCount++; + } + + @Implementation + public static void hidden(Context context, int category) throws IllegalArgumentException { + sActionLoggedCount++; + } + } + +}