Measurement of UPMR package migration.

Added events to track package migration operations and any
potential failures.

Bug: 150471207
Change-Id: I70bb98d989971a7a7fbe06692c81fbf7e0758724

Author: Stewart Miles

source/UnityPackageManagerResolver/src/PackageMigrator.cs

@@ -753,14 +753,20 @@ private static void StartOrResumeMigration(
                         return;
                     }
                 } catch (IOException ioError) {
-                    complete(ioError.Message);
+                    UnityPackageManagerResolver.analytics.Report(
+                        "package_migrator/migration/failed/read_snapshot",
+                        "Migrate Packages: Read Snapshot Failed");
                     migrationJobQueue.Complete();
+                    complete(ioError.Message);
                     return;
                 }
                 // Fetch the list of installed packages before starting migration.
                 PackageMap.CacheInstalledPackageInfo(
                     false, (error) => {
                         if (!String.IsNullOrEmpty(error.Message)) {
+                            UnityPackageManagerResolver.analytics.Report(
+                                "package_migrator/migration/failed/find_packages",
+                                "Migrate Packages: Find Packages Failed");
                             migrationJobQueue.Complete();
                             complete(error.Message);
                             return;
@@ -778,6 +784,32 @@ static PackageMigrator() {
         ResumeMigration();
     }
 
+    /// <summary>
+    /// Report that package migration failed.
+    /// </summary>
+    private static void ReportPackageMigrationFailed() {
+        int numberOfSelectedPackages = -1;
+        int numberOfMigratedPackages = -1;
+        try {
+            ReadMigrationState();
+            numberOfSelectedPackages = inProgressPackageMaps.Count;
+            numberOfMigratedPackages = 0;
+            foreach (var packageMap in inProgressPackageMaps) {
+                if (packageMap.Migrated) numberOfMigratedPackages ++;
+            }
+        } catch (IOException) {
+            // Ignore the exception.
+        }
+        UnityPackageManagerResolver.analytics.Report(
+            "package_migrator/migration/failed",
+            new KeyValuePair<string, string>[] {
+                new KeyValuePair<string, string>("selected", numberOfSelectedPackages.ToString()),
+                new KeyValuePair<string, string>("migrated", numberOfMigratedPackages.ToString()),
+            },
+            "Migrate Packages: Failed");
+    }
+
+
     /// <summary>
     /// Resume migration after an app domain reload.
     /// </summary>
@@ -798,6 +830,7 @@ public static void ResumeMigration() {
                 } catch (IOException ioError) {
                     Logger.Log(String.Format("Failed to resume package migration: {0}", ioError),
                                level: LogLevel.Error);
+                    ReportPackageMigrationFailed();
                 }
             }, runNow: false);
     }
@@ -848,6 +881,15 @@ public static void TryMigration(Action<string> complete) {
 
         Action<string> clearProgressAndComplete = (error) => {
             EditorUtility.ClearProgressBar();
+            if (String.IsNullOrEmpty(error)) {
+                UnityPackageManagerResolver.analytics.Report(
+                    "package_migrator/migration/success",
+                    new KeyValuePair<string, string>[] {
+                        new KeyValuePair<string, string>(
+                            "migrated", inProgressPackageMaps.Count.ToString()),
+                    },
+                    "Migrate Packages: Success");
+            }
             ClearMigrationState();
             complete(error);
         };
@@ -860,6 +902,9 @@ public static void TryMigration(Action<string> complete) {
 
                 PackageMap.FindPackagesToMigrate((error, packageMaps) => {
                         if (!String.IsNullOrEmpty(error)) {
+                            UnityPackageManagerResolver.analytics.Report(
+                                "package_migrator/migration/failed/find_packages",
+                                "Migrate Packages: Find Packages Failed");
                            clearProgressAndComplete(error);
                            return;
                         }
@@ -940,13 +985,19 @@ public static void MigratePackages() {
 
                 // If an error occurs, display a dialog.
                 if (!String.IsNullOrEmpty(findError)) {
+                    UnityPackageManagerResolver.analytics.Report(
+                        "package_migrator/migration/failed/find_packages",
+                        "Migrate Packages: Find Packages Failed");
                     DisplayError(findError);
                     return;
                 }
 
                 // Show a package selection window and start migration if the user selects apply.
                 DisplaySelectionWindow(availablePackageMaps, (selectedPackageMaps) => {
                         if (selectedPackageMaps.Count == 0) {
+                            UnityPackageManagerResolver.analytics.Report(
+                                "package_migrator/migration/canceled",
+                                "Migrate Packages: Canceled");
                             ClearMigrationState();
                             return;
                         }
@@ -955,6 +1006,9 @@ public static void MigratePackages() {
                             PackageMap.WriteToFile(selectedPackageMaps);
                         } catch (IOException e) {
                             DisplayError(String.Format("Migration failed ({0})", e.Message));
+                            UnityPackageManagerResolver.analytics.Report(
+                                "package_migrator/migration/failed/write_snapshot",
+                                "Migrate Packages: Write Snapshot Failed");
                             return;
                         }
 

source/UnityPackageManagerResolver/src/SettingsDialog.cs

@@ -207,6 +207,9 @@ public void OnGUI() {
                     new KeyValuePair<string, string>(
                         "promptToAddRegistries",
                         UnityPackageManagerResolver.PromptToAddRegistries.ToString()),
+                    new KeyValuePair<string, string>(
+                        "promptToMigratePackages",
+                        UnityPackageManagerResolver.PromptToMigratePackages.ToString()),
                     new KeyValuePair<string, string>(
                         "verboseLoggingEnabled",
                         UnityPackageManagerResolver.VerboseLoggingEnabled.ToString()),