Making various model objects injectable

Bug: 361850561
Test: Updated tests
Flag: EXEMPT dagger
Change-Id: Ibb45b72c186e6aeeed7a37b0ae3f8083472019d7
This commit is contained in:
Sunny Goyal committed 2025-03-10 14:37:43 -07:00
1 parent 24645d732c
commit 42975c39db
39 files changed
+601 -505

No files matched your search

+101 -71
View File
@@ -53,7 +53,6 @@ import android.os.Trace;
import android.os.UserHandle;
import android.os.UserManager;
import android.provider.Settings;
import android.util.ArrayMap;
import android.util.Log;
import android.util.LongSparseArray;
@@ -63,13 +62,14 @@ import androidx.annotation.VisibleForTesting;
import androidx.annotation.WorkerThread;
import com.android.launcher3.Flags;
import com.android.launcher3.LauncherAppState;
import com.android.launcher3.InvariantDeviceProfile;
import com.android.launcher3.LauncherModel;
import com.android.launcher3.LauncherPrefs;
import com.android.launcher3.LauncherSettings.Favorites;
import com.android.launcher3.Utilities;
import com.android.launcher3.backuprestore.LauncherRestoreEventLogger;
import com.android.launcher3.config.FeatureFlags;
import com.android.launcher3.dagger.ApplicationContext;
import com.android.launcher3.folder.Folder;
import com.android.launcher3.folder.FolderGridOrganizer;
import com.android.launcher3.folder.FolderNameInfos;
@@ -82,6 +82,7 @@ import com.android.launcher3.icons.cache.CachedObjectCachingLogic;
import com.android.launcher3.icons.cache.IconCacheUpdateHandler;
import com.android.launcher3.icons.cache.LauncherActivityCachingLogic;
import com.android.launcher3.logging.FileLog;
import com.android.launcher3.model.LoaderCursor.LoaderCursorFactory;
import com.android.launcher3.model.data.AppInfo;
import com.android.launcher3.model.data.AppPairInfo;
import com.android.launcher3.model.data.FolderInfo;
@@ -106,6 +107,10 @@ import com.android.launcher3.util.PackageUserKey;
import com.android.launcher3.util.TraceHelper;
import com.android.launcher3.widget.WidgetInflater;
import dagger.assisted.Assisted;
import dagger.assisted.AssistedFactory;
import dagger.assisted.AssistedInject;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
@@ -117,6 +122,8 @@ import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CancellationException;
import javax.inject.Named;
/**
* Runnable for the thread that loads the contents of the launcher:
* - workspace icons
@@ -131,10 +138,14 @@ public class LoaderTask implements Runnable {
private static final boolean DEBUG = true;
@NonNull
protected final LauncherAppState mApp;
private final Context mContext;
private final LauncherModel mModel;
private final InvariantDeviceProfile mIDP;
private final boolean mIsSafeModeEnabled;
private final AllAppsList mBgAllAppsList;
protected final BgDataModel mBgDataModel;
private final LoaderCursorFactory mLoaderCursorFactory;
private final ModelDelegate mModelDelegate;
private boolean mIsRestoreFromBackup;
@@ -152,7 +163,6 @@ public class LoaderTask implements Runnable {
private final IconCache mIconCache;
private final UserManagerState mUserManagerState;
protected final Map<ComponentKey, AppWidgetProviderInfo> mWidgetProvidersMap = new ArrayMap<>();
private Map<ShortcutKey, ShortcutInfo> mShortcutKeyToPinnedShortcuts;
private HashMap<PackageUserKey, SessionInfo> mInstallingPkgsCached;
@@ -164,26 +174,36 @@ public class LoaderTask implements Runnable {
private boolean mItemsDeleted = false;
private String mDbName;
public LoaderTask(@NonNull LauncherAppState app, AllAppsList bgAllAppsList, BgDataModel bgModel,
ModelDelegate modelDelegate, @NonNull BaseLauncherBinder launcherBinder) {
this(app, bgAllAppsList, bgModel, modelDelegate, launcherBinder, new UserManagerState());
}
@VisibleForTesting
LoaderTask(@NonNull LauncherAppState app, AllAppsList bgAllAppsList, BgDataModel bgModel,
ModelDelegate modelDelegate, @NonNull BaseLauncherBinder launcherBinder,
UserManagerState userManagerState) {
mApp = app;
@AssistedInject
LoaderTask(
@ApplicationContext Context context,
InvariantDeviceProfile idp,
LauncherModel model,
UserCache userCache,
PackageManagerHelper pmHelper,
InstallSessionHelper sessionHelper,
IconCache iconCache,
AllAppsList bgAllAppsList,
BgDataModel bgModel,
LoaderCursorFactory loaderCursorFactory,
@Named("SAFE_MODE") boolean isSafeModeEnabled,
@Assisted @NonNull BaseLauncherBinder launcherBinder,
@Assisted UserManagerState userManagerState) {
mContext = context;
mIDP = idp;
mModel = model;
mIsSafeModeEnabled = isSafeModeEnabled;
mBgAllAppsList = bgAllAppsList;
mBgDataModel = bgModel;
mModelDelegate = modelDelegate;
mModelDelegate = model.getModelDelegate();
mLauncherBinder = launcherBinder;
mLauncherApps = mApp.getContext().getSystemService(LauncherApps.class);
mUserManager = mApp.getContext().getSystemService(UserManager.class);
mUserCache = UserCache.INSTANCE.get(mApp.getContext());
mPmHelper = PackageManagerHelper.INSTANCE.get(mApp.getContext());
mSessionHelper = InstallSessionHelper.INSTANCE.get(mApp.getContext());
mIconCache = mApp.getIconCache();
mLoaderCursorFactory = loaderCursorFactory;
mLauncherApps = mContext.getSystemService(LauncherApps.class);
mUserManager = mContext.getSystemService(UserManager.class);
mUserCache = userCache;
mPmHelper = pmHelper;
mSessionHelper = sessionHelper;
mIconCache = iconCache;
mUserManagerState = userManagerState;
mInstallingPkgsCached = null;
}
@@ -215,7 +235,7 @@ public class LoaderTask implements Runnable {
.filter(currentScreenContentFilter(firstScreens))
.toList();
final int disableArchivingLauncherBroadcast = Settings.Secure.getInt(
mApp.getContext().getContentResolver(),
mContext.getContentResolver(),
"disable_launcher_broadcast_installed_apps",
/* default */ 0);
boolean shouldAttachArchivingExtras = mIsRestoreFromBackup
@@ -230,10 +250,10 @@ public class LoaderTask implements Runnable {
mBgDataModel.itemsIdMap.stream().filter(WIDGET_FILTER).toList()
);
logASplit("Sending first screen broadcast with additional archiving Extras");
FirstScreenBroadcastHelper.sendBroadcastsForModels(mApp.getContext(), broadcastModels);
FirstScreenBroadcastHelper.sendBroadcastsForModels(mContext, broadcastModels);
} else {
logASplit("Sending first screen broadcast");
mFirstScreenBroadcast.sendBroadcasts(mApp.getContext(), firstScreenItems);
mFirstScreenBroadcast.sendBroadcasts(mContext, firstScreenItems);
}
}
@@ -249,16 +269,14 @@ public class LoaderTask implements Runnable {
MODEL_EXECUTOR.elevatePriority(CALLER_LOADER_TASK);
LoaderMemoryLogger memoryLogger = new LoaderMemoryLogger();
mIsRestoreFromBackup =
LauncherPrefs.get(mApp.getContext()).get(IS_FIRST_LOAD_AFTER_RESTORE);
LauncherPrefs.get(mContext).get(IS_FIRST_LOAD_AFTER_RESTORE);
LauncherRestoreEventLogger restoreEventLogger = null;
if (enableLauncherBrMetricsFixed()) {
restoreEventLogger = LauncherRestoreEventLogger.Companion
.newInstance(mApp.getContext());
restoreEventLogger = LauncherRestoreEventLogger.Companion.newInstance(mContext);
}
try (LauncherModel.LoaderTransaction transaction = mApp.getModel().beginLoader(this)) {
try (LauncherModel.LoaderTransaction transaction = mModel.beginLoader(this)) {
List<CacheableShortcutInfo> allShortcuts = new ArrayList<>();
loadWorkspace(allShortcuts, "", memoryLogger, restoreEventLogger);
loadWorkspace(allShortcuts, "", new HashMap<>(), memoryLogger, restoreEventLogger);
// Sanitize data re-syncs widgets/shortcuts based on the workspace loaded from db.
// sanitizeData should not be invoked if the workspace is loaded from a db different
@@ -267,7 +285,7 @@ public class LoaderTask implements Runnable {
// TODO(b/384731096): Write Unit Test to make sure sanitizeWidgetsShortcutsAndPackages
// actually re-pins shortcuts that are in model but not in ShortcutManager, if possible
// after a simulated restore.
if (Objects.equals(mApp.getInvariantDeviceProfile().dbFile, mDbName)) {
if (Objects.equals(mIDP.dbFile, mDbName)) {
verifyNotStopped();
sanitizeFolders(mItemsDeleted);
sanitizeAppPairs();
@@ -307,13 +325,13 @@ public class LoaderTask implements Runnable {
setIgnorePackages(updateHandler);
updateHandler.updateIcons(allActivityList,
LauncherActivityCachingLogic.INSTANCE,
mApp.getModel()::onPackageIconsUpdated);
mModel::onPackageIconsUpdated);
logASplit("update AllApps icon cache finished");
verifyNotStopped();
logASplit("saving all shortcuts in icon cache");
updateHandler.updateIcons(allShortcuts, CacheableShortcutCachingLogic.INSTANCE,
mApp.getModel()::onPackageIconsUpdated);
mModel::onPackageIconsUpdated);
// Take a break
waitForIdle();
@@ -342,14 +360,14 @@ public class LoaderTask implements Runnable {
// fourth step
WidgetsModel widgetsModel = mBgDataModel.widgetsModel;
List<CachedObject> allWidgetsList = widgetsModel.update(mApp, /*packageUser=*/null);
List<CachedObject> allWidgetsList = widgetsModel.update(/*packageUser=*/null);
logASplit("load widgets finished");
verifyNotStopped();
mLauncherBinder.bindWidgets();
logASplit("bindWidgets finished");
verifyNotStopped();
LauncherPrefs prefs = LauncherPrefs.get(mApp.getContext());
LauncherPrefs prefs = LauncherPrefs.get(mContext);
if (enableSmartspaceAsAWidget() && prefs.get(SHOULD_SHOW_SMARTSPACE)) {
mLauncherBinder.bindSmartspaceWidget();
@@ -366,7 +384,7 @@ public class LoaderTask implements Runnable {
logASplit("saving all widgets in icon cache");
updateHandler.updateIcons(allWidgetsList,
CachedObjectCachingLogic.INSTANCE,
mApp.getModel()::onWidgetLabelsUpdated);
mModel::onWidgetLabelsUpdated);
// fifth step
loadFolderNames();
@@ -380,7 +398,7 @@ public class LoaderTask implements Runnable {
memoryLogger.clearLogs();
if (mIsRestoreFromBackup) {
mIsRestoreFromBackup = false;
LauncherPrefs.get(mApp.getContext()).putSync(IS_FIRST_LOAD_AFTER_RESTORE.to(false));
LauncherPrefs.get(mContext).putSync(IS_FIRST_LOAD_AFTER_RESTORE.to(false));
if (restoreEventLogger != null) {
restoreEventLogger.reportLauncherRestoreResults();
}
@@ -402,35 +420,42 @@ public class LoaderTask implements Runnable {
this.notify();
}
protected void loadWorkspace(
public void loadWorkspaceForPreview(String selection,
Map<ComponentKey, AppWidgetProviderInfo> widgetProviderInfoMap) {
loadWorkspace(new ArrayList<>(), selection, widgetProviderInfoMap, null, null);
}
private void loadWorkspace(
List<CacheableShortcutInfo> allDeepShortcuts,
String selection,
Map<ComponentKey, AppWidgetProviderInfo> widgetProviderInfoMap,
@Nullable LoaderMemoryLogger memoryLogger,
@Nullable LauncherRestoreEventLogger restoreEventLogger
) {
Trace.beginSection("LoadWorkspace");
try {
loadWorkspaceImpl(allDeepShortcuts, selection, memoryLogger, restoreEventLogger);
loadWorkspaceImpl(allDeepShortcuts, selection, widgetProviderInfoMap,
memoryLogger, restoreEventLogger);
} finally {
Trace.endSection();
}
logASplit("loadWorkspace finished");
mBgDataModel.isFirstPagePinnedItemEnabled = FeatureFlags.QSB_ON_FIRST_SCREEN
&& (!enableSmartspaceRemovalToggle() || LauncherPrefs.getPrefs(
mApp.getContext()).getBoolean(SMARTSPACE_ON_HOME_SCREEN, true));
&& (!enableSmartspaceRemovalToggle()
|| LauncherPrefs.getPrefs(mContext).getBoolean(SMARTSPACE_ON_HOME_SCREEN, true));
}
private void loadWorkspaceImpl(
List<CacheableShortcutInfo> allDeepShortcuts,
String selection,
Map<ComponentKey, AppWidgetProviderInfo> widgetProviderInfoMap,
@Nullable LoaderMemoryLogger memoryLogger,
@Nullable LauncherRestoreEventLogger restoreEventLogger) {
final Context context = mApp.getContext();
final boolean isSdCardReady = Utilities.isBootCompleted();
final WidgetInflater widgetInflater = new WidgetInflater(context);
final WidgetInflater widgetInflater = new WidgetInflater(mContext, mIsSafeModeEnabled);
ModelDbController dbController = mApp.getModel().getModelDbController();
ModelDbController dbController = mModel.getModelDbController();
if (Flags.gridMigrationRefactor()) {
try {
dbController.attemptMigrateDb(restoreEventLogger, mModelDelegate);
@@ -452,28 +477,29 @@ public class LoaderTask implements Runnable {
if (Flags.enableSupportForArchiving()) {
mInstallingPkgsCached = installingPkgs;
}
installingPkgs.forEach(mApp.getIconCache()::updateSessionCache);
installingPkgs.forEach(mIconCache::updateSessionCache);
FileLog.d(TAG, "loadWorkspace: Packages with active install/update sessions: "
+ installingPkgs.keySet().stream().map(info -> info.mPackageName).toList());
mFirstScreenBroadcast = new FirstScreenBroadcast(installingPkgs);
mShortcutKeyToPinnedShortcuts = new HashMap<>();
final LoaderCursor c = new LoaderCursor(
final LoaderCursor c = mLoaderCursorFactory.createLoaderCursor(
dbController.query(TABLE_NAME, null, selection, null, null),
mApp, mUserManagerState, mPmHelper,
mUserManagerState,
mIsRestoreFromBackup ? restoreEventLogger : null);
final Bundle extras = c.getExtras();
mDbName = extras == null ? null : extras.getString(ModelDbController.EXTRA_DB_NAME);
try {
final LongSparseArray<Boolean> unlockedUsers = new LongSparseArray<>();
queryPinnedShortcutsForUnlockedUsers(context, unlockedUsers);
queryPinnedShortcutsForUnlockedUsers(mContext, unlockedUsers);
mWorkspaceIconRequestInfos = new ArrayList<>();
WorkspaceItemProcessor itemProcessor = new WorkspaceItemProcessor(c, memoryLogger,
mUserCache, mUserManagerState, mLauncherApps, mPendingPackages,
mShortcutKeyToPinnedShortcuts, mApp, mBgDataModel,
mWidgetProvidersMap, installingPkgs, isSdCardReady,
mShortcutKeyToPinnedShortcuts, mContext, mIDP, mIconCache,
mIsSafeModeEnabled, mBgDataModel,
widgetProviderInfoMap, installingPkgs, isSdCardReady,
widgetInflater, mPmHelper, mWorkspaceIconRequestInfos, unlockedUsers,
allDeepShortcuts);
@@ -577,7 +603,7 @@ public class LoaderTask implements Runnable {
@WorkerThread
private void processFolderItems() {
// Sort the folder items, update ranks, and make sure all preview items are high res.
List<FolderGridOrganizer> verifiers = mApp.getInvariantDeviceProfile().supportedProfiles
List<FolderGridOrganizer> verifiers = mIDP.supportedProfiles
.stream().map(FolderGridOrganizer::createFolderGridOrganizer).toList();
for (ItemInfo itemInfo : mBgDataModel.itemsIdMap) {
if (!(itemInfo instanceof FolderInfo folder)) {
@@ -617,7 +643,7 @@ public class LoaderTask implements Runnable {
if (mIconCache.isDefaultIcon(wai.bitmap, wai.user)) {
logASplit("tryLoadWorkspaceIconsInBulk: default icon found for "
+ wai.getTargetComponent() + ", will attempt to load from iconBlob");
iconRequestInfo.loadIconFromDbBlob(mApp.getContext());
iconRequestInfo.loadIconFromDbBlob(mContext);
}
}
} finally {
@@ -649,7 +675,7 @@ public class LoaderTask implements Runnable {
private void sanitizeFolders(boolean itemsDeleted) {
if (itemsDeleted) {
// Remove any empty folder
IntArray deletedFolderIds = mApp.getModel().getModelDbController().deleteEmptyFolders();
IntArray deletedFolderIds = mModel.getModelDbController().deleteEmptyFolders();
synchronized (mBgDataModel) {
for (int folderId : deletedFolderIds) {
mBgDataModel.itemsIdMap.remove(folderId);
@@ -660,8 +686,8 @@ public class LoaderTask implements Runnable {
/** Cleans up app pairs if they don't have the right number of member apps (2). */
private void sanitizeAppPairs() {
IntArray deletedAppPairIds = mApp.getModel().getModelDbController().deleteBadAppPairs();
IntArray deletedAppIds = mApp.getModel().getModelDbController().deleteUnparentedApps();
IntArray deletedAppPairIds = mModel.getModelDbController().deleteBadAppPairs();
IntArray deletedAppIds = mModel.getModelDbController().deleteUnparentedApps();
IntArray deleted = new IntArray();
deleted.addAll(deletedAppPairIds);
@@ -675,17 +701,15 @@ public class LoaderTask implements Runnable {
}
private void sanitizeWidgetsShortcutsAndPackages() {
Context context = mApp.getContext();
// Remove any ghost widgets
mApp.getModel().getModelDbController().removeGhostWidgets();
mModel.getModelDbController().removeGhostWidgets();
// Update pinned state of model shortcuts
mBgDataModel.updateShortcutPinnedState(context);
mBgDataModel.updateShortcutPinnedState(mContext);
if (!Utilities.isBootCompleted() && !mPendingPackages.isEmpty()) {
context.registerReceiver(
new SdCardAvailableReceiver(mApp, mPendingPackages),
mContext.registerReceiver(
new SdCardAvailableReceiver(mContext, mModel, mPendingPackages),
new IntentFilter(Intent.ACTION_BOOT_COMPLETED),
null,
MODEL_EXECUTOR.getHandler());
@@ -722,7 +746,7 @@ public class LoaderTask implements Runnable {
for (int i = 0; i < apps.size(); i++) {
LauncherActivityInfo app = apps.get(i);
AppInfo appInfo = new AppInfo(app, mUserCache.getUserInfo(user),
ApiWrapper.INSTANCE.get(mApp.getContext()), mPmHelper, quietMode);
ApiWrapper.INSTANCE.get(mContext), mPmHelper, quietMode);
if (Flags.enableSupportForArchiving() && app.getApplicationInfo().isArchived) {
// For archived apps, include progress info in case there is a pending
// install session post restart of device.
@@ -751,7 +775,7 @@ public class LoaderTask implements Runnable {
for (PackageInstaller.SessionInfo info :
mSessionHelper.getAllVerifiedSessions()) {
AppInfo promiseAppInfo = mBgAllAppsList.addPromiseApp(
mApp.getContext(),
mContext,
PackageInstallInfo.fromInstallingState(info),
false);
@@ -776,7 +800,7 @@ public class LoaderTask implements Runnable {
+ appInfo.getTargetComponent()
+ ", will attempt to load from iconBlob: "
+ Arrays.toString(iconRequestInfo.iconBlob));
iconRequestInfo.loadIconFromDbBlob(mApp.getContext());
iconRequestInfo.loadIconFromDbBlob(mContext);
}
}
}
@@ -794,9 +818,9 @@ public class LoaderTask implements Runnable {
mUserManagerState.isAnyProfileQuietModeEnabled());
}
mBgAllAppsList.setFlags(FLAG_HAS_SHORTCUT_PERMISSION,
hasShortcutsPermission(mApp.getContext()));
hasShortcutsPermission(mContext));
mBgAllAppsList.setFlags(FLAG_QUIET_MODE_CHANGE_PERMISSION,
mApp.getContext().checkSelfPermission("android.permission.MODIFY_QUIET_MODE")
mContext.checkSelfPermission("android.permission.MODIFY_QUIET_MODE")
== PackageManager.PERMISSION_GRANTED);
mBgAllAppsList.getAndResetChangeFlag();
@@ -827,7 +851,7 @@ public class LoaderTask implements Runnable {
workspaceIconRequest.get().iconBlob,
false /* useLowResIcon= */
);
if (!iconRequestInfo.loadIconFromDbBlob(mApp.getContext())) {
if (!iconRequestInfo.loadIconFromDbBlob(mContext)) {
Log.d(TAG, "AppInfo Icon failed to load from blob, using cache.");
mIconCache.getTitleAndIcon(
appInfo,
@@ -853,7 +877,7 @@ public class LoaderTask implements Runnable {
if (mBgAllAppsList.hasShortcutHostPermission()) {
for (UserHandle user : mUserCache.getUserProfiles()) {
if (mUserManager.isUserUnlocked(user)) {
List<ShortcutInfo> shortcuts = new ShortcutRequest(mApp.getContext(), user)
List<ShortcutInfo> shortcuts = new ShortcutRequest(mContext, user)
.query(ShortcutRequest.ALL);
allShortcuts.addAll(shortcuts);
mBgDataModel.updateDeepShortcutCounts(null, user, shortcuts);
@@ -864,7 +888,7 @@ public class LoaderTask implements Runnable {
}
private void loadFolderNames() {
FolderNameProvider provider = FolderNameProvider.newInstance(mApp.getContext(),
FolderNameProvider provider = FolderNameProvider.newInstance(mContext,
mBgAllAppsList.data, FolderNameProvider.getCollectionForSuggestions(mBgDataModel));
synchronized (mBgDataModel) {
@@ -874,7 +898,7 @@ public class LoaderTask implements Runnable {
.forEach(info -> {
FolderInfo fi = (FolderInfo) info;
FolderNameInfos suggestionInfos = new FolderNameInfos();
provider.getSuggestedFolderName(mApp.getContext(), fi.getAppContents(),
provider.getSuggestedFolderName(mContext, fi.getAppContents(),
suggestionInfos);
fi.suggestedFolderNames = suggestionInfos;
});
@@ -891,4 +915,10 @@ public class LoaderTask implements Runnable {
Log.d(TAG, label);
}
}
@AssistedFactory
public interface LoaderTaskFactory {
LoaderTask newLoaderTask(BaseLauncherBinder binder, UserManagerState userState);
}
}