Remove Unused parts of LauncherPrefs causing cyclical dependency.
This "migration" feature was planned as an effort to reduce latency upon
startup. That being said, now that there is a loading screen being added
to pixel startup time, it doesn't make sense to perform a risky data
migration just to save a 100ms or so of startup time. Therefore, I am
removing this code as a clean up effort to make LauncherPrefs simpler.
Also, there was a cyclical dependency introduced in b/324670265 that
makes this cleanup effort especially worthwhile, as it resolves a bug
for other developers.
Bug: 324670265
Test: Installed this on a device and tested that nothing was broken.
Flag: NA
Change-Id: I81df710057d80fbd071bc26a53cb191d453e7dee
diff --git a/src/com/android/launcher3/LauncherPrefs.kt b/src/com/android/launcher3/LauncherPrefs.kt
index b0a644b..d7e6387 100644
--- a/src/com/android/launcher3/LauncherPrefs.kt
+++ b/src/com/android/launcher3/LauncherPrefs.kt
@@ -19,7 +19,6 @@
import android.content.Context.MODE_PRIVATE
import android.content.SharedPreferences
import android.content.SharedPreferences.OnSharedPreferenceChangeListener
-import android.util.Log
import android.view.ViewConfiguration
import androidx.annotation.VisibleForTesting
import com.android.launcher3.BuildConfig.WIDGET_ON_FIRST_SCREEN
@@ -38,8 +37,6 @@
* Use same context for shared preferences, so that we use a single cached instance
*
* TODO(b/262721340): Replace all direct SharedPreference refs with LauncherPrefs / Item methods.
- * TODO(b/274501660): Fix ReorderWidgets#simpleReorder test before enabling
- * isBootAwareStartupDataEnabled
*/
class LauncherPrefs(private val encryptedContext: Context) {
private val deviceProtectedStorageContext =
@@ -52,22 +49,8 @@
private val Item.encryptedPrefs
get() = encryptedContext.getSharedPreferences(sharedPrefFile, MODE_PRIVATE)
- // This call to `SharedPreferences` needs to be explicit rather than using `get` since doing so
- // would result in a circular dependency between `isStartupDataMigrated` and `choosePreferences`
- val isStartupDataMigrated: Boolean
- get() =
- bootAwarePrefs.getBoolean(
- IS_STARTUP_DATA_MIGRATED.sharedPrefKey,
- IS_STARTUP_DATA_MIGRATED.defaultValue
- )
-
private fun chooseSharedPreferences(item: Item): SharedPreferences =
- if (
- (moveStartupDataToDeviceProtectedStorageIsEnabled &&
- item.encryptionType == EncryptionType.MOVE_TO_DEVICE_PROTECTED &&
- isStartupDataMigrated) || item.encryptionType == EncryptionType.DEVICE_PROTECTED
- )
- bootAwarePrefs
+ if (item.encryptionType == EncryptionType.DEVICE_PROTECTED) bootAwarePrefs
else item.encryptedPrefs
/** Wrapper around `getInner` for a `ContextualItem` */
@@ -147,11 +130,7 @@
.toMutableMap()
val bootAwareUpdates =
- updates.filter {
- (it.first.encryptionType == EncryptionType.MOVE_TO_DEVICE_PROTECTED &&
- moveStartupDataToDeviceProtectedStorageIsEnabled) ||
- it.first.encryptionType == EncryptionType.DEVICE_PROTECTED
- }
+ updates.filter { it.first.encryptionType == EncryptionType.DEVICE_PROTECTED }
if (bootAwareUpdates.isNotEmpty()) {
updatesPerPrefFile[bootAwarePrefs] = bootAwareUpdates
}
@@ -252,12 +231,7 @@
.groupBy { it.encryptedPrefs }
.toMutableMap()
- val bootAwareUpdates =
- items.filter {
- (it.encryptionType == EncryptionType.MOVE_TO_DEVICE_PROTECTED &&
- moveStartupDataToDeviceProtectedStorageIsEnabled) ||
- it.encryptionType == EncryptionType.DEVICE_PROTECTED
- }
+ val bootAwareUpdates = items.filter { it.encryptionType == EncryptionType.DEVICE_PROTECTED }
if (bootAwareUpdates.isNotEmpty()) {
itemsPerFile[bootAwarePrefs] = bootAwareUpdates
}
@@ -269,24 +243,7 @@
}
}
- fun migrateStartupDataToDeviceProtectedStorage() {
- if (!moveStartupDataToDeviceProtectedStorageIsEnabled) return
-
- Log.d(
- TAG,
- "Migrating data to unencrypted shared preferences to enable preloading " +
- "while the user is locked the next time the device reboots."
- )
-
- with(bootAwarePrefs.edit()) {
- ITEMS_TO_MOVE_TO_DEVICE_PROTECTED_STORAGE.forEach { putValue(it, get(it)) }
- putBoolean(IS_STARTUP_DATA_MIGRATED.sharedPrefKey, true)
- apply()
- }
- }
-
companion object {
- private const val TAG = "LauncherPrefs"
@VisibleForTesting const val BOOT_AWARE_PREFS_KEY = "boot_aware_prefs"
@JvmField var INSTANCE = MainThreadInitializedObject { LauncherPrefs(it) }
@@ -296,80 +253,50 @@
const val TASKBAR_PINNING_KEY = "TASKBAR_PINNING_KEY"
const val SHOULD_SHOW_SMARTSPACE_KEY = "SHOULD_SHOW_SMARTSPACE_KEY"
@JvmField
- val ICON_STATE =
- nonRestorableItem("pref_icon_shape_path", "", EncryptionType.MOVE_TO_DEVICE_PROTECTED)
+ val ICON_STATE = nonRestorableItem("pref_icon_shape_path", "", EncryptionType.ENCRYPTED)
@JvmField
val ALL_APPS_OVERVIEW_THRESHOLD =
- nonRestorableItem(
- "pref_all_apps_overview_threshold",
- 180,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
- )
+ nonRestorableItem("pref_all_apps_overview_threshold", 180, EncryptionType.ENCRYPTED)
@JvmField
val LONG_PRESS_NAV_HANDLE_SLOP_PERCENTAGE =
- nonRestorableItem("LPNH_SLOP_PERCENTAGE", 100, EncryptionType.MOVE_TO_DEVICE_PROTECTED)
+ nonRestorableItem("LPNH_SLOP_PERCENTAGE", 100, EncryptionType.ENCRYPTED)
@JvmField
val LONG_PRESS_NAV_HANDLE_TIMEOUT_MS =
nonRestorableItem(
"LPNH_TIMEOUT_MS",
ViewConfiguration.getLongPressTimeout(),
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
+ EncryptionType.ENCRYPTED
)
@JvmField
val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_START_SCALE_PERCENT =
- nonRestorableItem(
- "LPNH_HAPTIC_HINT_START_SCALE_PERCENT",
- 0,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
- )
+ nonRestorableItem("LPNH_HAPTIC_HINT_START_SCALE_PERCENT", 0, EncryptionType.ENCRYPTED)
@JvmField
val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_END_SCALE_PERCENT =
- nonRestorableItem(
- "LPNH_HAPTIC_HINT_END_SCALE_PERCENT",
- 100,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
- )
+ nonRestorableItem("LPNH_HAPTIC_HINT_END_SCALE_PERCENT", 100, EncryptionType.ENCRYPTED)
@JvmField
val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_SCALE_EXPONENT =
- nonRestorableItem(
- "LPNH_HAPTIC_HINT_SCALE_EXPONENT",
- 1,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
- )
+ nonRestorableItem("LPNH_HAPTIC_HINT_SCALE_EXPONENT", 1, EncryptionType.ENCRYPTED)
@JvmField
val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_ITERATIONS =
- nonRestorableItem(
- "LPNH_HAPTIC_HINT_ITERATIONS",
- 50,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
- )
+ nonRestorableItem("LPNH_HAPTIC_HINT_ITERATIONS", 50, EncryptionType.ENCRYPTED)
@JvmField
val LONG_PRESS_NAV_HANDLE_HAPTIC_HINT_DELAY =
- nonRestorableItem("LPNH_HAPTIC_HINT_DELAY", 0, EncryptionType.MOVE_TO_DEVICE_PROTECTED)
+ nonRestorableItem("LPNH_HAPTIC_HINT_DELAY", 0, EncryptionType.ENCRYPTED)
@JvmField
val PRIVATE_SPACE_APPS =
- nonRestorableItem("pref_private_space_apps", 0, EncryptionType.MOVE_TO_DEVICE_PROTECTED)
- @JvmField val ENABLE_TWOLINE_ALLAPPS_TOGGLE =
- backedUpItem("pref_enable_two_line_toggle", false)
+ nonRestorableItem("pref_private_space_apps", 0, EncryptionType.ENCRYPTED)
@JvmField
- val THEMED_ICONS =
- backedUpItem(Themes.KEY_THEMED_ICONS, false, EncryptionType.MOVE_TO_DEVICE_PROTECTED)
+ val ENABLE_TWOLINE_ALLAPPS_TOGGLE = backedUpItem("pref_enable_two_line_toggle", false)
+ @JvmField
+ val THEMED_ICONS = backedUpItem(Themes.KEY_THEMED_ICONS, false, EncryptionType.ENCRYPTED)
@JvmField val PROMISE_ICON_IDS = backedUpItem(InstallSessionHelper.PROMISE_ICON_IDS, "")
@JvmField val WORK_EDU_STEP = backedUpItem("showed_work_profile_edu", 0)
@JvmField
val WORKSPACE_SIZE =
- backedUpItem(
- DeviceGridState.KEY_WORKSPACE_SIZE,
- "",
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
- )
+ backedUpItem(DeviceGridState.KEY_WORKSPACE_SIZE, "", EncryptionType.ENCRYPTED)
@JvmField
val HOTSEAT_COUNT =
- backedUpItem(
- DeviceGridState.KEY_HOTSEAT_COUNT,
- -1,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
- )
+ backedUpItem(DeviceGridState.KEY_HOTSEAT_COUNT, -1, EncryptionType.ENCRYPTED)
@JvmField
val TASKBAR_PINNING =
backedUpItem(TASKBAR_PINNING_KEY, false, EncryptionType.DEVICE_PROTECTED)
@@ -379,11 +306,10 @@
backedUpItem(
DeviceGridState.KEY_DEVICE_TYPE,
InvariantDeviceProfile.TYPE_PHONE,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
+ EncryptionType.ENCRYPTED
)
@JvmField
- val DB_FILE =
- backedUpItem(DeviceGridState.KEY_DB_FILE, "", EncryptionType.MOVE_TO_DEVICE_PROTECTED)
+ val DB_FILE = backedUpItem(DeviceGridState.KEY_DB_FILE, "", EncryptionType.ENCRYPTED)
@JvmField
val SHOULD_SHOW_SMARTSPACE =
backedUpItem(
@@ -396,15 +322,11 @@
backedUpItem(
RestoreDbTask.RESTORED_DEVICE_TYPE,
InvariantDeviceProfile.TYPE_PHONE,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
+ EncryptionType.ENCRYPTED
)
@JvmField
val IS_FIRST_LOAD_AFTER_RESTORE =
- nonRestorableItem(
- FIRST_LOAD_AFTER_RESTORE_KEY,
- false,
- EncryptionType.MOVE_TO_DEVICE_PROTECTED
- )
+ nonRestorableItem(FIRST_LOAD_AFTER_RESTORE_KEY, false, EncryptionType.ENCRYPTED)
@JvmField val APP_WIDGET_IDS = backedUpItem(RestoreDbTask.APPWIDGET_IDS, "")
@JvmField val OLD_APP_WIDGET_IDS = backedUpItem(RestoreDbTask.APPWIDGET_OLD_IDS, "")
@JvmField
@@ -413,7 +335,7 @@
"idp_grid_name",
isBackedUp = true,
defaultValue = null,
- encryptionType = EncryptionType.MOVE_TO_DEVICE_PROTECTED,
+ encryptionType = EncryptionType.ENCRYPTED,
type = String::class.java
)
@JvmField
@@ -421,14 +343,6 @@
backedUpItem(RotationHelper.ALLOW_ROTATION_PREFERENCE_KEY, Boolean::class.java) {
RotationHelper.getAllowRotationDefaultValue(DisplayController.INSTANCE.get(it).info)
}
- @JvmField
- val IS_STARTUP_DATA_MIGRATED =
- ConstantItem(
- "is_startup_data_boot_aware",
- isBackedUp = false,
- defaultValue = false,
- encryptionType = EncryptionType.DEVICE_PROTECTED
- )
// Preferences for widget configurations
@JvmField
@@ -493,12 +407,6 @@
}
}
-// It is a var because the unit tests are setting this to true so they can run.
-var moveStartupDataToDeviceProtectedStorageIsEnabled: Boolean =
- com.android.launcher3.config.FeatureFlags.MOVE_STARTUP_DATA_TO_DEVICE_PROTECTED_STORAGE.get()
-
-private val ITEMS_TO_MOVE_TO_DEVICE_PROTECTED_STORAGE: MutableSet<ConstantItem<*>> = mutableSetOf()
-
abstract class Item {
abstract val sharedPrefKey: String
abstract val isBackedUp: Boolean
@@ -518,14 +426,6 @@
// The default value can be null. If so, the type needs to be explicitly stated, or else NPE
override val type: Class<out T> = defaultValue!!::class.java
) : Item() {
- init {
- if (
- encryptionType == EncryptionType.MOVE_TO_DEVICE_PROTECTED &&
- moveStartupDataToDeviceProtectedStorageIsEnabled
- ) {
- ITEMS_TO_MOVE_TO_DEVICE_PROTECTED_STORAGE.add(this)
- }
- }
fun get(c: Context): T = LauncherPrefs.get(c).get(this)
}
@@ -552,5 +452,4 @@
enum class EncryptionType {
ENCRYPTED,
DEVICE_PROTECTED,
- MOVE_TO_DEVICE_PROTECTED
}