diff --git a/src/com/android/launcher3/LauncherBackupAgent.java b/src/com/android/launcher3/LauncherBackupAgent.java index 2617b9337d..a96495de83 100644 --- a/src/com/android/launcher3/LauncherBackupAgent.java +++ b/src/com/android/launcher3/LauncherBackupAgent.java @@ -1,5 +1,7 @@ package com.android.launcher3; +import static com.android.launcher3.LauncherPrefs.NO_DB_FILES_RESTORED; + import android.app.backup.BackupAgent; import android.app.backup.BackupDataInput; import android.app.backup.BackupDataOutput; @@ -10,10 +12,13 @@ import com.android.launcher3.provider.RestoreDbTask; import java.io.File; import java.io.IOException; +import java.util.Arrays; +import java.util.stream.Collectors; public class LauncherBackupAgent extends BackupAgent { - private static final String TAG = "LauncherBackupAgent"; + private static final String DB_FILE_PREFIX = "launcher"; + private static final String DB_FILE_SUFFIX = ".db"; @Override public void onCreate() { @@ -47,7 +52,34 @@ public class LauncherBackupAgent extends BackupAgent { @Override public void onRestoreFinished() { - FileLog.d(TAG, "onRestoreFinished: set pending for RestoreDbTask"); RestoreDbTask.setPending(this); + FileLog.d(TAG, "onRestoreFinished: set pending for RestoreDbTask"); + markIfFilesWereNotActuallyRestored(); + } + + /** + * When restore is finished, we check to see if any db files were successfully restored. If not, + * our restore will fail later, but will report a different cause. This is important to split + * out the metric failures that are launcher's fault, and those that are due to bugs in the + * backup/restore code itself. + */ + private void markIfFilesWereNotActuallyRestored() { + File directory = new File(getDatabasePath(InvariantDeviceProfile.INSTANCE.get(this).dbFile) + .getParent()); + if (!directory.exists()) { + FileLog.e(TAG, "restore failed as target database directory doesn't exist"); + } else { + // Check for any db file that was restored, and collect as list + String fileNames = Arrays.stream(directory.listFiles()) + .map(File::getName) + .filter(n -> n.startsWith(DB_FILE_PREFIX) && n.endsWith(DB_FILE_SUFFIX)) + .collect(Collectors.joining(", ")); + if (fileNames.isBlank()) { + FileLog.e(TAG, "no database files were successfully restored"); + LauncherPrefs.get(this).putSync(NO_DB_FILES_RESTORED.to(true)); + } else { + FileLog.d(TAG, "database files successfully restored: " + fileNames); + } + } } } diff --git a/src/com/android/launcher3/LauncherPrefs.kt b/src/com/android/launcher3/LauncherPrefs.kt index 7ebfc1818a..5c03644c28 100644 --- a/src/com/android/launcher3/LauncherPrefs.kt +++ b/src/com/android/launcher3/LauncherPrefs.kt @@ -126,6 +126,9 @@ abstract class LauncherPrefs : SafeCloseable { EncryptionType.ENCRYPTED, ) @JvmField + val NO_DB_FILES_RESTORED = + nonRestorableItem("no_db_files_restored", false, EncryptionType.DEVICE_PROTECTED) + @JvmField val IS_FIRST_LOAD_AFTER_RESTORE = nonRestorableItem(FIRST_LOAD_AFTER_RESTORE_KEY, false, EncryptionType.ENCRYPTED) @JvmField val APP_WIDGET_IDS = backedUpItem(RestoreDbTask.APPWIDGET_IDS, "") diff --git a/src/com/android/launcher3/backuprestore/LauncherRestoreEventLogger.kt b/src/com/android/launcher3/backuprestore/LauncherRestoreEventLogger.kt index e6654b1547..b05539ad0f 100644 --- a/src/com/android/launcher3/backuprestore/LauncherRestoreEventLogger.kt +++ b/src/com/android/launcher3/backuprestore/LauncherRestoreEventLogger.kt @@ -24,9 +24,10 @@ open class LauncherRestoreEventLogger : ResourceBasedOverride { RestoreError.WIDGETS_DISABLED, RestoreError.PROFILE_NOT_RESTORED, RestoreError.WIDGET_REMOVED, + RestoreError.DATABASE_FILE_NOT_RESTORED, RestoreError.GRID_MIGRATION_FAILURE, RestoreError.NO_SEARCH_WIDGET, - RestoreError.INVALID_WIDGET_ID + RestoreError.INVALID_WIDGET_ID, ) annotation class RestoreError { companion object { @@ -38,6 +39,7 @@ open class LauncherRestoreEventLogger : ResourceBasedOverride { const val APP_NOT_INSTALLED = "app_not_installed" const val WIDGETS_DISABLED = "widgets_disabled" const val PROFILE_NOT_RESTORED = "profile_not_restored" + const val DATABASE_FILE_NOT_RESTORED = "db_file_not_restored" const val WIDGET_REMOVED = "widget_not_found" const val GRID_MIGRATION_FAILURE = "grid_migration_failed" const val NO_SEARCH_WIDGET = "no_search_widget" @@ -52,7 +54,7 @@ open class LauncherRestoreEventLogger : ResourceBasedOverride { return ResourceBasedOverride.Overrides.getObject( LauncherRestoreEventLogger::class.java, context, - R.string.launcher_restore_event_logger_class + R.string.launcher_restore_event_logger_class, ) } } @@ -117,7 +119,7 @@ open class LauncherRestoreEventLogger : ResourceBasedOverride { open fun logFavoritesItemsRestoreFailed( favoritesId: Int, count: Int, - @RestoreError error: String? + @RestoreError error: String?, ) { // no-op } diff --git a/src/com/android/launcher3/model/ModelDbController.java b/src/com/android/launcher3/model/ModelDbController.java index 5d66d16ad8..787aef4da5 100644 --- a/src/com/android/launcher3/model/ModelDbController.java +++ b/src/com/android/launcher3/model/ModelDbController.java @@ -20,15 +20,16 @@ import static android.util.Base64.NO_PADDING; import static android.util.Base64.NO_WRAP; import static com.android.launcher3.DefaultLayoutParser.RES_PARTNER_DEFAULT_LAYOUT; +import static com.android.launcher3.LauncherPrefs.NO_DB_FILES_RESTORED; import static com.android.launcher3.LauncherSettings.Favorites.CONTAINER; import static com.android.launcher3.LauncherSettings.Favorites.ITEM_TYPE; import static com.android.launcher3.LauncherSettings.Favorites.ITEM_TYPE_APP_PAIR; import static com.android.launcher3.LauncherSettings.Favorites.TABLE_NAME; import static com.android.launcher3.LauncherSettings.Favorites.addTableToDb; import static com.android.launcher3.LauncherSettings.Settings.BLOB_KEY_PREFIX; -import static com.android.launcher3.LauncherSettings.Settings.LAYOUT_PROVIDER_KEY; import static com.android.launcher3.LauncherSettings.Settings.LAYOUT_DIGEST_LABEL; import static com.android.launcher3.LauncherSettings.Settings.LAYOUT_DIGEST_TAG; +import static com.android.launcher3.LauncherSettings.Settings.LAYOUT_PROVIDER_KEY; import static com.android.launcher3.provider.LauncherDbUtils.tableExists; import android.app.blob.BlobHandle; @@ -97,6 +98,7 @@ public class ModelDbController { private static final String EMPTY_DATABASE_CREATED = "EMPTY_DATABASE_CREATED"; public static final String EXTRA_DB_NAME = "db_name"; + public static final String DATA_TYPE_DB_FILE = "database_file"; protected DatabaseHelper mOpenHelper; @@ -295,7 +297,15 @@ public class ModelDbController { if (!migrateGridIfNeeded()) { if (restoreEventLogger != null) { - sendMetricsForFailedMigration(restoreEventLogger, getDb()); + if (LauncherPrefs.get(mContext).get(NO_DB_FILES_RESTORED)) { + restoreEventLogger.logLauncherItemsRestoreFailed(DATA_TYPE_DB_FILE, 1, + RestoreError.DATABASE_FILE_NOT_RESTORED); + LauncherPrefs.get(mContext).put(NO_DB_FILES_RESTORED, false); + FileLog.d(TAG, "There is no data to migrate: resetting launcher database"); + } else { + restoreEventLogger.logLauncherItemsRestored(DATA_TYPE_DB_FILE, 1); + sendMetricsForFailedMigration(restoreEventLogger, getDb()); + } } FileLog.d(TAG, "Migration failed: resetting launcher database"); createEmptyDB(); @@ -304,6 +314,8 @@ public class ModelDbController { // Write the grid state to avoid another migration new DeviceGridState(LauncherAppState.getIDP(mContext)).writeToPrefs(mContext); + } else if (restoreEventLogger != null) { + restoreEventLogger.logLauncherItemsRestored(DATA_TYPE_DB_FILE, 1); } } @@ -317,17 +329,17 @@ public class ModelDbController { createDbIfNotExists(); if (LauncherPrefs.get(mContext).get(getEmptyDbCreatedKey())) { // If we have already create a new DB, ignore migration - Log.d(TAG, "migrateGridIfNeeded: new DB already created, skipping migration"); + FileLog.d(TAG, "migrateGridIfNeeded: new DB already created, skipping migration"); return false; } InvariantDeviceProfile idp = LauncherAppState.getIDP(mContext); if (!GridSizeMigrationUtil.needsToMigrate(mContext, idp)) { - Log.d(TAG, "migrateGridIfNeeded: no grid migration needed"); + FileLog.d(TAG, "migrateGridIfNeeded: no grid migration needed"); return true; } String targetDbName = new DeviceGridState(idp).getDbFile(); if (TextUtils.equals(targetDbName, mOpenHelper.getDatabaseName())) { - Log.e(TAG, "migrateGridIfNeeded: target db is same as current: " + targetDbName); + FileLog.e(TAG, "migrateGridIfNeeded: target db is same as current: " + targetDbName); return false; } DatabaseHelper oldHelper = mOpenHelper;