Merge "Revert "Move Settings backup and restore metric logging from... (3b4c42ff) · Commits · e / os / android_frameworks_base

packages/SettingsProvider/src/com/android/providers/settings/SettingsBackupAgent.java

+5 −1

Original line number	Diff line number	Diff line
		@@ -1058,10 +1058,14 @@ public class SettingsBackupAgent extends BackupAgentHelper {
		Log.d(TAG, "Restored font scale from: " + toRestore + " to " + value);
		}

		// TODO(b/379861078): Log metrics inside this method.
		settingsHelper.restoreValue(this, cr, contentValues, destination, key, value,
		mRestoredFromSdkInt, mBackupRestoreEventLogger, finalSettingsKey);
		mRestoredFromSdkInt);

		Log.d(TAG, "Restored setting: " + destination + " : " + key + "=" + value);
		if (areAgentMetricsEnabled) {
		mBackupRestoreEventLogger.logItemsRestored(finalSettingsKey, /* count= */ 1);
		}
		}

		}

packages/SettingsProvider/src/com/android/providers/settings/SettingsHelper.java

+1 −13

Original line number	Diff line number	Diff line
		@@ -80,7 +80,6 @@ public class SettingsHelper {
		// Error messages for logging metrics.
		private static final String ERROR_REMOTE_EXCEPTION_SETTING_LOCALE_DATA =
		"remote_exception_setting_locale_data";
		private static final String ERROR_FAILED_TO_RESTORE_SETTING = "failed_to_restore_setting";

		private Context mContext;
		private AudioManager mAudioManager;
		@@ -180,15 +179,12 @@ public class SettingsHelper {
		* whether or not the setting should be saved to the database as well.
		* @param name the name of the setting
		* @param value the string value of the setting
		* @param backupRestoreEventLogger the logger to log metrics for backup and restore.
		* @param datatype the datatype for logging purposes.
		* @return whether to continue with writing the value to the database. In
		* some cases the data will be written by the call to the appropriate API,
		* and in some cases the property value needs to be modified before setting.
		*/
		public void restoreValue(Context context, ContentResolver cr, ContentValues contentValues,
		Uri destination, String name, String value, int restoredFromSdkInt,
		BackupRestoreEventLogger backupRestoreEventLogger, String datatype) {
		Uri destination, String name, String value, int restoredFromSdkInt) {
		if (isReplacedSystemSetting(name)) {
		return;
		}
		@@ -227,7 +223,6 @@ public class SettingsHelper {
		}

		try {
		// TODO(b/379861078): Log metrics for cases that fall in the if-else block.
		if (Settings.System.SOUND_EFFECTS_ENABLED.equals(name)) {
		setSoundEffects(Integer.parseInt(value) == 1);
		// fall through to the ordinary write to settings
		@@ -295,19 +290,12 @@ public class SettingsHelper {
		contentValues.put(Settings.NameValueTable.NAME, name);
		contentValues.put(Settings.NameValueTable.VALUE, value);
		cr.insert(destination, contentValues);
		if (Flags.enableMetricsSettingsBackupAgents()) {
		backupRestoreEventLogger.logItemsRestored(datatype, /* count= */ 1);
		}
		} catch (Exception e) {
		// If we fail to apply the setting, by definition nothing happened
		sendBroadcast = false;
		sendBroadcastSystemUI = false;
		sendBroadcastAccessibility = false;
		Log.e(TAG, "Failed to restore setting name: " + name + " + value: " + value, e);
		if (Flags.enableMetricsSettingsBackupAgents()) {
		backupRestoreEventLogger.logItemsRestoreFailed(
		datatype, /* count= */ 1, ERROR_FAILED_TO_RESTORE_SETTING);
		}
		} finally {
		// If this was an element of interest, send the "we just restored it"
		// broadcast with the historical value now that the new value has

packages/SettingsProvider/test/src/com/android/providers/settings/SettingsBackupAgentTest.java

+109 −69

Original line number	Diff line number	Diff line
		@@ -420,6 +420,75 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		assertNull(getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest));
		}

		@Test
		@EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreEnabled_agentMetricsAreLogged() {
		mAgentUnderTest.onCreate(
		UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);
		SettingsBackupAgent.SettingsBackupAllowlist allowlist =
		new SettingsBackupAgent.SettingsBackupAllowlist(
		new String[] {OVERRIDDEN_TEST_SETTING},
		TEST_VALUES_VALIDATORS);
		mAgentUnderTest.setSettingsAllowlist(allowlist);
		mAgentUnderTest.setBlockedSettings();
		TestSettingsHelper settingsHelper = new TestSettingsHelper(mContext);
		mAgentUnderTest.mSettingsHelper = settingsHelper;

		byte[] backupData = generateBackupData(TEST_VALUES);
		mAgentUnderTest
		.restoreSettings(
		backupData,
		/* pos= */ 0,
		backupData.length,
		TEST_URI,
		/* movedToGlobal= */ null,
		/* movedToSecure= */ null,
		/* movedToSystem= */ null,
		/* blockedSettingsArrayId= */ 0,
		/* dynamicBlockList= */ Collections.emptySet(),
		/* settingsToPreserve= */ Collections.emptySet(),
		TEST_KEY);

		DataTypeResult loggingResult =
		getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest);
		assertNotNull(loggingResult);
		assertEquals(loggingResult.getSuccessCount(), 1);
		}

		@Test
		@DisableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreDisabled_agentMetricsAreNotLogged() {
		mAgentUnderTest.onCreate(
		UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);
		SettingsBackupAgent.SettingsBackupAllowlist allowlist =
		new SettingsBackupAgent.SettingsBackupAllowlist(
		new String[] {OVERRIDDEN_TEST_SETTING},
		TEST_VALUES_VALIDATORS);
		mAgentUnderTest.setSettingsAllowlist(allowlist);
		mAgentUnderTest.setBlockedSettings();
		TestSettingsHelper settingsHelper = new TestSettingsHelper(mContext);
		mAgentUnderTest.mSettingsHelper = settingsHelper;

		byte[] backupData = generateBackupData(TEST_VALUES);
		mAgentUnderTest
		.restoreSettings(
		backupData,
		/* pos= */ 0,
		backupData.length,
		TEST_URI,
		/* movedToGlobal= */ null,
		/* movedToSecure= */ null,
		/* movedToSystem= */ null,
		/* blockedSettingsArrayId= */ 0,
		/* dynamicBlockList= */ Collections.emptySet(),
		/* settingsToPreserve= */ Collections.emptySet(),
		TEST_KEY);

		DataTypeResult loggingResult =
		getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest);
		assertNull(loggingResult);
		}

		@Test
		@EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreEnabled_readEntityDataFails_failureIsLogged()
		@@ -507,40 +576,6 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		assertTrue(loggingResult.getErrors().containsKey(ERROR_SKIPPED_BY_SYSTEM));
		}

		@Test
		@DisableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void
		restoreSettings_agentMetricsAreDisabled_settingIsSkippedBySystem_failureIsNotLogged() {
		mAgentUnderTest.onCreate(
		UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);
		String[] settingBlockedBySystem = new String[] {OVERRIDDEN_TEST_SETTING};
		SettingsBackupAgent.SettingsBackupAllowlist allowlist =
		new SettingsBackupAgent.SettingsBackupAllowlist(
		settingBlockedBySystem,
		TEST_VALUES_VALIDATORS);
		mAgentUnderTest.setSettingsAllowlist(allowlist);
		mAgentUnderTest.setBlockedSettings(settingBlockedBySystem);
		TestSettingsHelper settingsHelper = new TestSettingsHelper(mContext);
		mAgentUnderTest.mSettingsHelper = settingsHelper;

		byte[] backupData = generateBackupData(TEST_VALUES);
		mAgentUnderTest
		.restoreSettings(
		backupData,
		/* pos= */ 0,
		backupData.length,
		TEST_URI,
		/* movedToGlobal= */ null,
		/* movedToSecure= */ null,
		/* movedToSystem= */ null,
		/* blockedSettingsArrayId= */ 0,
		/* dynamicBlockList= */ Collections.emptySet(),
		/* settingsToPreserve= */ Collections.emptySet(),
		TEST_KEY);

		assertNull(getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest));
		}

		@Test
		@EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreEnabled_settingIsSkippedByBlockList_failureIsLogged() {
		@@ -580,9 +615,8 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		}

		@Test
		@DisableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void
		restoreSettings_agentMetricsAreDisabled_settingIsSkippedByBlockList_failureIsNotLogged() {
		@EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreEnabled_settingIsPreserved_failureIsLogged() {
		mAgentUnderTest.onCreate(
		UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);
		SettingsBackupAgent.SettingsBackupAllowlist allowlist =
		@@ -593,7 +627,7 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		mAgentUnderTest.setBlockedSettings();
		TestSettingsHelper settingsHelper = new TestSettingsHelper(mContext);
		mAgentUnderTest.mSettingsHelper = settingsHelper;
		Set<String> dynamicBlockList =
		Set<String> preservedSettings =
		Set.of(Uri.withAppendedPath(TEST_URI, OVERRIDDEN_TEST_SETTING).toString());

		byte[] backupData = generateBackupData(TEST_VALUES);
		@@ -607,28 +641,30 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		/* movedToSecure= */ null,
		/* movedToSystem= */ null,
		/* blockedSettingsArrayId= */ 0,
		dynamicBlockList,
		/* settingsToPreserve= */ Collections.emptySet(),
		/* dynamicBlockList = */ Collections.emptySet(),
		preservedSettings,
		TEST_KEY);

		assertNull(getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest));
		DataTypeResult loggingResult =
		getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest);
		assertNotNull(loggingResult);
		assertEquals(loggingResult.getFailCount(), 1);
		assertTrue(loggingResult.getErrors().containsKey(ERROR_SKIPPED_PRESERVED));
		}

		@Test
		@EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreEnabled_settingIsPreserved_failureIsLogged() {
		public void restoreSettings_agentMetricsAreEnabled_settingIsNotValid_failureIsLogged() {
		mAgentUnderTest.onCreate(
		UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);
		SettingsBackupAgent.SettingsBackupAllowlist allowlist =
		new SettingsBackupAgent.SettingsBackupAllowlist(
		new String[] {OVERRIDDEN_TEST_SETTING},
		TEST_VALUES_VALIDATORS);
		/* settingsValidators= */ null);
		mAgentUnderTest.setSettingsAllowlist(allowlist);
		mAgentUnderTest.setBlockedSettings();
		TestSettingsHelper settingsHelper = new TestSettingsHelper(mContext);
		mAgentUnderTest.mSettingsHelper = settingsHelper;
		Set<String> preservedSettings =
		Set.of(Uri.withAppendedPath(TEST_URI, OVERRIDDEN_TEST_SETTING).toString());

		byte[] backupData = generateBackupData(TEST_VALUES);
		mAgentUnderTest
		@@ -642,19 +678,19 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		/* movedToSystem= */ null,
		/* blockedSettingsArrayId= */ 0,
		/* dynamicBlockList = */ Collections.emptySet(),
		preservedSettings,
		/* settingsToPreserve= */ Collections.emptySet(),
		TEST_KEY);

		DataTypeResult loggingResult =
		getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest);
		assertNotNull(loggingResult);
		assertEquals(loggingResult.getFailCount(), 1);
		assertTrue(loggingResult.getErrors().containsKey(ERROR_SKIPPED_PRESERVED));
		assertTrue(loggingResult.getErrors().containsKey(ERROR_DID_NOT_PASS_VALIDATION));
		}

		@Test
		@DisableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreDisabled_settingIsPreserved_failureIsNotLogged() {
		@EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreEnabled_settingIsMarkedAsMovedToGlobal_agentMetricsAreLoggedWithGlobalKey() {
		mAgentUnderTest.onCreate(
		UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);
		SettingsBackupAgent.SettingsBackupAllowlist allowlist =
		@@ -665,8 +701,6 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		mAgentUnderTest.setBlockedSettings();
		TestSettingsHelper settingsHelper = new TestSettingsHelper(mContext);
		mAgentUnderTest.mSettingsHelper = settingsHelper;
		Set<String> preservedSettings =
		Set.of(Uri.withAppendedPath(TEST_URI, OVERRIDDEN_TEST_SETTING).toString());

		byte[] backupData = generateBackupData(TEST_VALUES);
		mAgentUnderTest
		@@ -675,26 +709,30 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		/* pos= */ 0,
		backupData.length,
		TEST_URI,
		/* movedToGlobal= */ null,
		/* movedToGlobal= */ Set.of(OVERRIDDEN_TEST_SETTING),
		/* movedToSecure= */ null,
		/* movedToSystem= */ null,
		/* blockedSettingsArrayId= */ 0,
		/* dynamicBlockList= */ Collections.emptySet(),
		preservedSettings,
		/* settingsToPreserve= */ Collections.emptySet(),
		TEST_KEY);

		DataTypeResult loggingResult =
		getLoggingResultForDatatype(KEY_GLOBAL, mAgentUnderTest);
		assertNotNull(loggingResult);
		assertEquals(loggingResult.getSuccessCount(), 1);
		assertNull(getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest));
		}

		@Test
		@EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreEnabled_settingIsNotValid_failureIsLogged() {
		public void restoreSettings_agentMetricsAreEnabled_settingIsMarkedAsMovedToSecure_agentMetricsAreLoggedWithSecureKey() {
		mAgentUnderTest.onCreate(
		UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);
		SettingsBackupAgent.SettingsBackupAllowlist allowlist =
		new SettingsBackupAgent.SettingsBackupAllowlist(
		new String[] {OVERRIDDEN_TEST_SETTING},
		/* settingsValidators= */ null);
		TEST_VALUES_VALIDATORS);
		mAgentUnderTest.setSettingsAllowlist(allowlist);
		mAgentUnderTest.setBlockedSettings();
		TestSettingsHelper settingsHelper = new TestSettingsHelper(mContext);
		@@ -708,7 +746,7 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		backupData.length,
		TEST_URI,
		/* movedToGlobal= */ null,
		/* movedToSecure= */ null,
		/* movedToSecure= */ Set.of(OVERRIDDEN_TEST_SETTING),
		/* movedToSystem= */ null,
		/* blockedSettingsArrayId= */ 0,
		/* dynamicBlockList= */ Collections.emptySet(),
		@@ -716,21 +754,21 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		TEST_KEY);

		DataTypeResult loggingResult =
		getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest);
		getLoggingResultForDatatype(KEY_SECURE, mAgentUnderTest);
		assertNotNull(loggingResult);
		assertEquals(loggingResult.getFailCount(), 1);
		assertTrue(loggingResult.getErrors().containsKey(ERROR_DID_NOT_PASS_VALIDATION));
		assertEquals(loggingResult.getSuccessCount(), 1);
		assertNull(getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest));
		}

		@Test
		@DisableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreDisabled_settingIsNotValid_failureIsNotLogged() {
		@EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)
		public void restoreSettings_agentMetricsAreEnabled_settingIsMarkedAsMovedToSystem_agentMetricsAreLoggedWithSystemKey() {
		mAgentUnderTest.onCreate(
		UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);
		SettingsBackupAgent.SettingsBackupAllowlist allowlist =
		new SettingsBackupAgent.SettingsBackupAllowlist(
		new String[] {OVERRIDDEN_TEST_SETTING},
		/* settingsValidators= */ null);
		TEST_VALUES_VALIDATORS);
		mAgentUnderTest.setSettingsAllowlist(allowlist);
		mAgentUnderTest.setBlockedSettings();
		TestSettingsHelper settingsHelper = new TestSettingsHelper(mContext);
		@@ -745,12 +783,16 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		TEST_URI,
		/* movedToGlobal= */ null,
		/* movedToSecure= */ null,
		/* movedToSystem= */ null,
		/* movedToSystem= */ Set.of(OVERRIDDEN_TEST_SETTING),
		/* blockedSettingsArrayId= */ 0,
		/* dynamicBlockList= */ Collections.emptySet(),
		/* settingsToPreserve= */ Collections.emptySet(),
		TEST_KEY);

		DataTypeResult loggingResult =
		getLoggingResultForDatatype(KEY_SYSTEM, mAgentUnderTest);
		assertNotNull(loggingResult);
		assertEquals(loggingResult.getSuccessCount(), 1);
		assertNull(getLoggingResultForDatatype(TEST_KEY, mAgentUnderTest));
		}

		@@ -919,9 +961,7 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest {
		Uri destination,
		String name,
		String value,
		int restoredFromSdkInt,
		BackupRestoreEventLogger backupRestoreEventLogger,
		String datatype) {
		int restoredFromSdkInt) {
		mWrittenValues.put(name, value);
		}
		}

packages/SettingsProvider/test/src/com/android/providers/settings/SettingsHelperRestoreTest.java

+6 −18

Original line number	Diff line number	Diff line
		@@ -168,9 +168,7 @@ public class SettingsHelperRestoreTest {
		Settings.Secure.getUriFor(settingName),
		settingName,
		String.valueOf(restoreSettingValue),
		Build.VERSION.SDK_INT,
		null,
		"");
		Build.VERSION.SDK_INT);

		assertEquals(
		configuredSettingValue,
		@@ -193,9 +191,7 @@ public class SettingsHelperRestoreTest {
		Settings.Secure.getUriFor(settingName),
		settingName,
		String.valueOf(restoreSettingValue),
		Build.VERSION.SDK_INT,
		null,
		"");
		Build.VERSION.SDK_INT);

		assertEquals(
		restoreSettingValue,
		@@ -238,9 +234,7 @@ public class SettingsHelperRestoreTest {
		Settings.Secure.getUriFor(settingName),
		settingName,
		String.valueOf(0),
		Build.VERSION.SDK_INT,
		null,
		"");
		Build.VERSION.SDK_INT);

		assertEquals(configuredSettingValue, Settings.Secure.getInt(mContentResolver, settingName));
		}
		@@ -262,9 +256,7 @@ public class SettingsHelperRestoreTest {
		Settings.Secure.getUriFor(settingName),
		settingName,
		String.valueOf(restoreSettingValue),
		Build.VERSION.SDK_INT,
		null,
		"");
		Build.VERSION.SDK_INT);

		assertEquals(restoreSettingValue, Settings.Secure.getInt(mContentResolver, settingName));
		}
		@@ -286,9 +278,7 @@ public class SettingsHelperRestoreTest {
		Settings.Secure.getUriFor(settingName),
		settingName,
		restoreSettingValue,
		Build.VERSION.SDK_INT,
		null,
		"");
		Build.VERSION.SDK_INT);

		Intent intentReceived = futureIntent.get();
		assertThat(intentReceived.getStringExtra(Intent.EXTRA_SETTING_NEW_VALUE))
		@@ -313,9 +303,7 @@ public class SettingsHelperRestoreTest {
		Settings.Secure.getUriFor(settingName),
		settingName,
		restoredValue,
		Build.VERSION.SDK_INT,
		null,
		"");
		Build.VERSION.SDK_INT);

		Intent intentReceived = futureIntent.get();
		assertThat(intentReceived.getStringExtra(Intent.EXTRA_SETTING_NEW_VALUE))

packages/SettingsProvider/test/src/com/android/providers/settings/SettingsHelperTest.java

+14 −115

File changed.

Preview size limit exceeded, changes collapsed.