feat: Import bootaware changes from t (acc9725c) · Commits · e / os / BlissLauncher3

quickstep/src/com/android/quickstep/BootAwarePreloader.kt

0 → 100644

+51 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2023 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.quickstep

		import android.content.Context
		import android.util.Log
		import com.android.launcher3.LauncherAppState
		import com.android.launcher3.LauncherPrefs
		import com.android.launcher3.isBootAwareStartupDataEnabled
		import com.android.launcher3.util.LockedUserState

		/**
		* Loads expensive objects in memory before the user is unlocked. This decreases experienced latency
		* when starting the launcher for the first time after a reboot.
		*/
		object BootAwarePreloader {
		private const val TAG = "BootAwarePreloader"

		@JvmStatic
		fun start(context: Context) {
		val lp = LauncherPrefs.get(context)
		when {
		LockedUserState.get(context).isUserUnlocked \|\| !isBootAwareStartupDataEnabled -> {
		/* No-Op */
		}
		lp.isStartupDataMigrated -> {
		Log.d(TAG, "preloading start up data")
		LauncherAppState.INSTANCE.get(context)
		}
		else -> {
		Log.d(TAG, "queuing start up data migration to boot aware prefs")
		LockedUserState.get(context).runOnUserUnlocked {
		lp.migrateStartupDataToDeviceProtectedStorage()
		}
		}
		}
		}
		}
		No newline at end of file

quickstep/src/com/android/quickstep/TouchInteractionService.java

+1 −0

Original line number	Diff line number	Diff line
		@@ -373,6 +373,7 @@ public class TouchInteractionService extends Service
		mDisplayManager = getSystemService(DisplayManager.class);
		mTaskbarManager = new TaskbarManager(this);
		mRotationTouchHelper = mDeviceState.getRotationTouchHelper();
		BootAwarePreloader.start(this);
		mLauncherAppMonitor = LauncherAppMonitor.getInstance(this);

		// Call runOnUserUnlocked() before any other callbacks to ensure everything is initialized.

src/com/android/launcher3/LauncherPrefs.kt

+354 −11

Original line number	Diff line number	Diff line
		package com.android.launcher3

		import android.content.Context
		import android.content.Context.MODE_PRIVATE
		import android.content.SharedPreferences
		import android.content.SharedPreferences.OnSharedPreferenceChangeListener
		import android.util.Log
		import androidx.annotation.VisibleForTesting
		import com.android.launcher3.LauncherFiles.DEVICE_PREFERENCES_KEY
		import com.android.launcher3.LauncherFiles.SHARED_PREFERENCES_KEY
		import com.android.launcher3.util.MainThreadInitializedObject

		object LauncherPrefs {
		/**
		* 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 =
		encryptedContext.createDeviceProtectedStorageContext()

		private val bootAwarePrefs
		get() =
		deviceProtectedStorageContext.getSharedPreferences(BOOT_AWARE_PREFS_KEY, MODE_PRIVATE)

		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 (isBootAwareStartupDataEnabled && item.isBootAware && isStartupDataMigrated)
		bootAwarePrefs
		else item.encryptedPrefs

		/** Wrapper around `getInner` for a `ContextualItem` */
		fun <T> get(item: ContextualItem<T>): T =
		getInner(item, item.defaultValueFromContext(encryptedContext))

		/** Wrapper around `getInner` for an `Item` */
		fun <T> get(item: ConstantItem<T>): T = getInner(item, item.defaultValue)

		/**
		* Retrieves the value for an [Item] from [SharedPreferences]. It handles method typing via the
		* default value type, and will throw an error if the type of the item provided is not a
		* `String`, `Boolean`, `Float`, `Int`, `Long`, or `Set<String>`.
		*/
		@Suppress("IMPLICIT_CAST_TO_ANY", "UNCHECKED_CAST")
		private fun <T> getInner(item: Item, default: T): T {
		val sp = chooseSharedPreferences(item)

		return when (item.type) {
		String::class.java -> sp.getString(item.sharedPrefKey, default as? String)
		Boolean::class.java,
		java.lang.Boolean::class.java -> sp.getBoolean(item.sharedPrefKey, default as Boolean)
		Int::class.java,
		java.lang.Integer::class.java -> sp.getInt(item.sharedPrefKey, default as Int)
		Float::class.java,
		java.lang.Float::class.java -> sp.getFloat(item.sharedPrefKey, default as Float)
		Long::class.java,
		java.lang.Long::class.java -> sp.getLong(item.sharedPrefKey, default as Long)
		Set::class.java -> sp.getStringSet(item.sharedPrefKey, default as? Set<String>)
		else ->
		throw IllegalArgumentException(
		"item type: ${item.type}" + " is not compatible with sharedPref methods"
		)
		}
		as T
		}

		/**
		* Stores each of the values provided in `SharedPreferences` according to the configuration
		* contained within the associated items provided. Internally, it uses apply, so the caller
		* cannot assume that the values that have been put are immediately available for use.
		*
		* The forEach loop is necessary here since there is 1 `SharedPreference.Editor` returned from
		* prepareToPutValue(itemsToValues) for every distinct `SharedPreferences` file present in the
		* provided item configurations.
		*/
		fun put(vararg itemsToValues: Pair<Item, Any>): Unit =
		prepareToPutValues(itemsToValues).forEach { it.apply() }

		/** See referenced `put` method above. */
		fun <T : Any> put(item: Item, value: T): Unit = put(item.to(value))

		/**
		* Synchronously stores all the values provided according to their associated Item
		* configuration.
		*/
		fun putSync(vararg itemsToValues: Pair<Item, Any>): Unit =
		prepareToPutValues(itemsToValues).forEach { it.commit() }

		/**
		* Updates the values stored in `SharedPreferences` for each corresponding Item-value pair. If
		* the item is boot aware, this method updates both the boot aware and the encrypted files. This
		* is done because: 1) It allows for easy roll-back if the data is already in encrypted prefs
		* and we need to turn off the boot aware data feature & 2) It simplifies Backup/Restore, which
		* already points to encrypted storage.
		*
		* Returns a list of editors with all transactions added so that the caller can determine to use
		* .apply() or .commit()
		*/
		private fun prepareToPutValues(
		updates: Array<out Pair<Item, Any>>
		): List<SharedPreferences.Editor> {
		val updatesPerPrefFile = updates.groupBy { it.first.encryptedPrefs }.toMutableMap()

		if (isBootAwareStartupDataEnabled) {
		val bootAwareUpdates = updates.filter { it.first.isBootAware }
		if (bootAwareUpdates.isNotEmpty()) {
		updatesPerPrefFile[bootAwarePrefs] = bootAwareUpdates
		}
		}

		return updatesPerPrefFile.map { prefToItemValueList ->
		prefToItemValueList.key.edit().apply {
		prefToItemValueList.value.forEach { itemToValue: Pair<Item, Any> ->
		putValue(itemToValue.first, itemToValue.second)
		}
		}
		}
		}

		/**
		* Handles adding values to `SharedPreferences` regardless of type. This method is especially
		* helpful for updating `SharedPreferences` values for `List<<Item>Any>` that have multiple
		* types of Item values.
		*/
		@Suppress("UNCHECKED_CAST")
		private fun SharedPreferences.Editor.putValue(
		item: Item,
		value: Any?
		): SharedPreferences.Editor =
		when (item.type) {
		String::class.java -> putString(item.sharedPrefKey, value as? String)
		Boolean::class.java,
		java.lang.Boolean::class.java -> putBoolean(item.sharedPrefKey, value as Boolean)
		Int::class.java,
		java.lang.Integer::class.java -> putInt(item.sharedPrefKey, value as Int)
		Float::class.java,
		java.lang.Float::class.java -> putFloat(item.sharedPrefKey, value as Float)
		Long::class.java,
		java.lang.Long::class.java -> putLong(item.sharedPrefKey, value as Long)
		Set::class.java -> putStringSet(item.sharedPrefKey, value as? Set<String>)
		else ->
		throw IllegalArgumentException(
		"item type: ${item.type} is not compatible with sharedPref methods"
		)
		}

		/**
		* After calling this method, the listener will be notified of any future updates to the
		* `SharedPreferences` files associated with the provided list of items. The listener will need
		* to filter update notifications so they don't activate for non-relevant updates.
		*/
		fun addListener(listener: OnSharedPreferenceChangeListener, vararg items: Item) {
		items
		.map { chooseSharedPreferences(it) }
		.distinct()
		.forEach { it.registerOnSharedPreferenceChangeListener(listener) }
		}

		/**
		* Stops the listener from getting notified of any more updates to any of the
		* `SharedPreferences` files associated with any of the provided list of [Item].
		*/
		fun removeListener(listener: OnSharedPreferenceChangeListener, vararg items: Item) {
		// If a listener is not registered to a SharedPreference, unregistering it does nothing
		items
		.map { chooseSharedPreferences(it) }
		.distinct()
		.forEach { it.unregisterOnSharedPreferenceChangeListener(listener) }
		}

		/**
		* Checks if all the provided [Item] have values stored in their corresponding
		* `SharedPreferences` files.
		*/
		fun has(vararg items: Item): Boolean {
		items
		.groupBy { chooseSharedPreferences(it) }
		.forEach { (prefs, itemsSublist) ->
		if (!itemsSublist.none { !prefs.contains(it.sharedPrefKey) }) return false
		}
		return true
		}

		/**
		* Asynchronously removes the [Item]'s value from its corresponding `SharedPreferences` file.
		*/
		fun remove(vararg items: Item) = prepareToRemove(items).forEach { it.apply() }

		/** Synchronously removes the [Item]'s value from its corresponding `SharedPreferences` file. */
		fun removeSync(vararg items: Item) = prepareToRemove(items).forEach { it.commit() }

		/**
		* Removes the key value pairs stored in `SharedPreferences` for each corresponding Item. If the
		* item is boot aware, this method removes the data from both the boot aware and encrypted
		* files.
		*
		* @return a list of editors with all transactions added so that the caller can determine to use
		* .apply() or .commit()
		*/
		private fun prepareToRemove(items: Array<out Item>): List<SharedPreferences.Editor> {
		val itemsPerFile = items.groupBy { it.encryptedPrefs }.toMutableMap()

		if (isBootAwareStartupDataEnabled) {
		val bootAwareUpdates = items.filter { it.isBootAware }
		if (bootAwareUpdates.isNotEmpty()) {
		itemsPerFile[bootAwarePrefs] = bootAwareUpdates
		}
		}

		return itemsPerFile.map { (prefs, items) ->
		prefs.edit().also { editor ->
		items.forEach { item -> editor.remove(item.sharedPrefKey) }
		}
		}
		}

		fun migrateStartupDataToDeviceProtectedStorage() {
		if (!isBootAwareStartupDataEnabled) 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()) {
		BOOT_AWARE_ITEMS.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) }

		@JvmStatic fun get(context: Context): LauncherPrefs = INSTANCE.get(context)

		@JvmField
		val IS_STARTUP_DATA_MIGRATED =
		ConstantItem(
		"is_startup_data_boot_aware",
		isBackedUp = false,
		defaultValue = false,
		isBootAware = true
		)

		@VisibleForTesting
		@JvmStatic
		fun <T> backedUpItem(
		sharedPrefKey: String,
		defaultValue: T,
		isBootAware: Boolean = false
		): ConstantItem<T> =
		ConstantItem(sharedPrefKey, isBackedUp = true, defaultValue, isBootAware)

		@JvmStatic
		fun <T> backedUpItem(
		sharedPrefKey: String,
		type: Class<out T>,
		isBootAware: Boolean = false,
		defaultValueFromContext: (c: Context) -> T
		): ContextualItem<T> =
		ContextualItem(
		sharedPrefKey,
		isBackedUp = true,
		defaultValueFromContext,
		isBootAware,
		type
		)

		@VisibleForTesting
		@JvmStatic
		fun <T> nonRestorableItem(
		sharedPrefKey: String,
		defaultValue: T,
		isBootAware: Boolean = false
		): ConstantItem<T> =
		ConstantItem(sharedPrefKey, isBackedUp = false, defaultValue, isBootAware)

		@Deprecated("Don't use shared preferences directly. Use other LauncherPref methods.")
		@JvmStatic
		fun getPrefs(context: Context): SharedPreferences {
		// Use application context for shared preferences, so that we use a single cached instance
		// Use application context for shared preferences, so we use single cached instance
		return context.applicationContext.getSharedPreferences(
		LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE
		SHARED_PREFERENCES_KEY,
		MODE_PRIVATE
		)
		}

		@Deprecated("Don't use shared preferences directly. Use other LauncherPref methods.")
		@JvmStatic
		fun getDevicePrefs(context: Context): SharedPreferences {
		// Use application context for shared preferences, so that we use a single cached instance
		// Use application context for shared preferences, so we use a single cached instance
		return context.applicationContext.getSharedPreferences(
		LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE)
		DEVICE_PREFERENCES_KEY,
		MODE_PRIVATE
		)
		}
		}
		}

		// This is hard-coded to false for now until it is time to release this optimization. It is only
		// a var because the unit tests are setting this to true so they can run.
		@VisibleForTesting var isBootAwareStartupDataEnabled: Boolean = false

		private val BOOT_AWARE_ITEMS: MutableSet<ConstantItem<*>> = mutableSetOf()

		abstract class Item {
		abstract val sharedPrefKey: String
		abstract val isBackedUp: Boolean
		abstract val type: Class<*>
		abstract val isBootAware: Boolean
		val sharedPrefFile: String
		get() = if (isBackedUp) SHARED_PREFERENCES_KEY else DEVICE_PREFERENCES_KEY

		fun <T> to(value: T): Pair<Item, T> = Pair(this, value)
		}

		data class ConstantItem<T>(
		override val sharedPrefKey: String,
		override val isBackedUp: Boolean,
		val defaultValue: T,
		override val isBootAware: Boolean,
		// 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 (isBootAware && isBootAwareStartupDataEnabled) {
		BOOT_AWARE_ITEMS.add(this)
		}
		}
		}

		data class ContextualItem<T>(
		override val sharedPrefKey: String,
		override val isBackedUp: Boolean,
		private val defaultSupplier: (c: Context) -> T,
		override val isBootAware: Boolean,
		override val type: Class<out T>
		) : Item() {
		private var default: T? = null

		fun defaultValueFromContext(context: Context): T {
		if (default == null) {
		default = defaultSupplier(context)
		}
		return default!!
		}
		}

src/com/android/launcher3/util/LockedUserState.kt

0 → 100644

+59 −0

Original line number	Diff line number	Diff line
		package com.android.launcher3.util

		import android.content.Context
		import android.content.Intent
		import android.os.Process
		import android.os.UserManager
		import androidx.annotation.VisibleForTesting

		class LockedUserState(private val mContext: Context) : SafeCloseable {
		var isUserUnlocked: Boolean
		private set
		private val mUserUnlockedActions: RunnableList = RunnableList()

		@VisibleForTesting
		val mUserUnlockedReceiver = SimpleBroadcastReceiver {
		if (Intent.ACTION_USER_UNLOCKED == it.action) {
		isUserUnlocked = true
		notifyUserUnlocked()
		}
		}

		init {
		isUserUnlocked =
		mContext
		.getSystemService(UserManager::class.java)!!
		.isUserUnlocked(Process.myUserHandle())
		if (isUserUnlocked) {
		notifyUserUnlocked()
		} else {
		mUserUnlockedReceiver.register(mContext, Intent.ACTION_USER_UNLOCKED)
		}
		}

		private fun notifyUserUnlocked() {
		mUserUnlockedActions.executeAllAndDestroy()
		mUserUnlockedReceiver.unregisterReceiverSafely(mContext)
		}

		/** Stops the receiver from listening for ACTION_USER_UNLOCK broadcasts. */
		override fun close() {
		mUserUnlockedReceiver.unregisterReceiverSafely(mContext)
		}

		/**
		* Adds a `Runnable` to be executed when a user is unlocked. If the user is already unlocked,
		* this runnable will run immediately because RunnableList will already have been destroyed.
		*/
		fun runOnUserUnlocked(action: Runnable) {
		mUserUnlockedActions.add(action)
		}

		companion object {
		@VisibleForTesting
		@JvmField
		val INSTANCE = MainThreadInitializedObject { LockedUserState(it) }

		@JvmStatic fun get(context: Context): LockedUserState = INSTANCE.get(context)
		}
		}

src/com/android/launcher3/util/SimpleBroadcastReceiver.java

+11 −0

Original line number	Diff line number	Diff line
		@@ -45,4 +45,15 @@ public class SimpleBroadcastReceiver extends BroadcastReceiver {
		}
		context.registerReceiver(this, filter);
		}

		/**
		* Unregisters the receiver ignoring any errors
		*/
		public void unregisterReceiverSafely(Context context) {
		try {
		context.unregisterReceiver(this);
		} catch (IllegalArgumentException e) {
		// It was probably never registered or already unregistered. Ignore.
		}
		}
		}