lawnchair/src/com/android/launcher3/backuprestore/LauncherRestoreEventLogger.kt

package com.android.launcher3.backuprestore

import android.content.Context
import androidx.annotation.StringDef
import com.android.launcher3.LauncherSettings.Favorites
import com.android.launcher3.R
import com.android.launcher3.util.ResourceBasedOverride

/**
 * Wrapper for logging Restore event metrics for both success and failure to restore the Launcher
 * workspace from a backup.
 */
open class LauncherRestoreEventLogger : ResourceBasedOverride {

    /** Enumeration of potential errors returned to calls of pause/resume app updates. */
    @Retention(AnnotationRetention.SOURCE)
    @StringDef(
        RestoreError.PROFILE_DELETED,
        RestoreError.MISSING_INFO,
        RestoreError.MISSING_WIDGET_PROVIDER,
        RestoreError.INVALID_LOCATION,
        RestoreError.SHORTCUT_NOT_FOUND,
        RestoreError.APP_NOT_INSTALLED,
        RestoreError.WIDGETS_DISABLED,
        RestoreError.PROFILE_NOT_RESTORED,
        RestoreError.WIDGET_REMOVED,
        RestoreError.GRID_MIGRATION_FAILURE,
        RestoreError.NO_SEARCH_WIDGET,
        RestoreError.INVALID_WIDGET_ID
    )
    annotation class RestoreError {
        companion object {
            const val PROFILE_DELETED = "user_profile_deleted"
            const val MISSING_INFO = "missing_information_when_loading"
            const val MISSING_WIDGET_PROVIDER = "missing_widget_provider"
            const val INVALID_LOCATION = "invalid_size_or_location"
            const val SHORTCUT_NOT_FOUND = "shortcut_not_found"
            const val APP_NOT_INSTALLED = "app_not_installed"
            const val WIDGETS_DISABLED = "widgets_disabled"
            const val PROFILE_NOT_RESTORED = "profile_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"
            const val INVALID_WIDGET_ID = "invalid_widget_id"
        }
    }

    companion object {
        const val TAG = "LauncherRestoreEventLogger"

        fun newInstance(context: Context?): LauncherRestoreEventLogger {
            return ResourceBasedOverride.Overrides.getObject(
                LauncherRestoreEventLogger::class.java,
                context,
                R.string.launcher_restore_event_logger_class
            )
        }
    }

    /**
     * For logging when multiple items of a given data type failed to restore.
     *
     * @param dataType The data type that was not restored.
     * @param count the number of data items that were not restored.
     * @param error error type for why the data was not restored.
     */
    open fun logLauncherItemsRestoreFailed(dataType: String, count: Int, error: String?) {
        // no-op
    }

    /**
     * For logging when multiple items of a given data type were successfully restored.
     *
     * @param dataType The data type that was restored.
     * @param count the number of data items restored.
     */
    open fun logLauncherItemsRestored(dataType: String, count: Int) {
        // no-op
    }

    /**
     * Helper to log successfully restoring a single item from the Favorites table.
     *
     * @param favoritesId The id of the item type from [Favorites] that was restored.
     */
    open fun logSingleFavoritesItemRestored(favoritesId: Int) {
        // no-op
    }

    /**
     * Helper to log successfully restoring multiple items from the Favorites table.
     *
     * @param favoritesId The id of the item type from [Favorites] that was restored.
     * @param count number of items that restored.
     */
    open fun logFavoritesItemsRestored(favoritesId: Int, count: Int) {
        // no-op
    }

    /**
     * Helper to log a failure to restore a single item from the Favorites table.
     *
     * @param favoritesId The id of the item type from [Favorites] that was not restored.
     * @param error error type for why the data was not restored.
     */
    open fun logSingleFavoritesItemRestoreFailed(favoritesId: Int, @RestoreError error: String?) {
        // no-op
    }

    /**
     * Helper to log a failure to restore items from the Favorites table.
     *
     * @param favoritesId The id of the item type from [Favorites] that was not restored.
     * @param count number of items that failed to restore.
     * @param error error type for why the data was not restored.
     */
    open fun logFavoritesItemsRestoreFailed(
        favoritesId: Int,
        count: Int,
        @RestoreError error: String?
    ) {
        // no-op
    }

    /**
     * Uses the current [restoreEventLogger] to report its results to the [backupManager]. Use when
     * done restoring items for Launcher.
     */
    open fun reportLauncherRestoreResults() {
        // no-op
    }
}