Integrate VH -> UPM package migration into UPMR

The Unity Package Manager Resolver will now prompt the user to
migrate packages if any Version Handler packages are found in
the project with equivalent UPM packages.

Bug: 150471207
Change-Id: Idfc35428b6dc70816dde8c5abbebaff7483ed9e3

Author: Stewart Miles

README.md

@@ -518,6 +518,35 @@ XML configuration files via the following menu options:
   Modify Registries` will prompt the user with a window which allows them to
   add or remove registries discovered in the project.
 
+## Migration
+
+UPMR can migrate Version Handler packages installed in the `Assets` folder
+to UPM packages. This requires the plugins to implement the following:
+
+* `.unitypackage` must include a Version Handler manifests that describes
+   the components of the plugin. If the plugin has no dependencies
+   the manifest would just include the files in the plugin.
+* The UPM package JSON provided by the registry must include a keyword
+  (in the `versions.VERSION.keyword` list) that maps the UPM package
+  to a Version Handler package using the format
+  `vh-name:VERSION_HANDLER_MANIFEST_NAME` where `VERSION_HANDLER_MANIFEST_NAME`
+  is the name of the manifest defined in the `.unitypackage`.  For
+  more information see the description of the `gvhp_manifestname` asset label
+  in the *Version Handler Usage* section.
+
+When using the `Assets > External Dependency Manager >
+Unity Package Manager Resolver > Migrate Packages` menu option, UPMR then
+will:
+
+* List all Version Handler manager packages in the project.
+* Search all available packages in the UPM registries and fetch keywords
+  associated with each package parsing the Version Handler manifest names
+  for each package.
+* Map each installed Version Handler package to a UPM package.
+* Prompt the user to migrate the discovered packages.
+* Perform package migration for all selected packages if the user clicks
+  the `Apply` button.
+
 ## Configuration
 
 UPMR can be configured via the `Assets > External Dependency Manager >
@@ -529,6 +558,9 @@ Unity Package Manager Resolver > Settings` menu option:
 * `Prompt to add package registries` will cause a developer to be prompted
   with a window that will ask for confirmation before adding registries.
   When this is disabled registries are added silently to the project.
+* `Prompt to migrate packages` will cause a developer to be prompted
+  with a window that will ask for confirmation before migrating packages
+  installed in the `Assets` directory to UPM packages.
 * `Enable Analytics Reporting` when enabled, reports the use of the plugin
   to the developers so they can make imrpovements.
 * `Verbose logging` when enabled prints debug information to the console

source/UnityPackageManagerResolver/src/SettingsDialog.cs

@@ -40,6 +40,13 @@ private class Settings {
         /// </summary>
         internal bool promptToAddRegistries;
 
+
+        /// <summary>
+        /// Whether to prompt the user to migrate Version Handler to UPM packages after a
+        /// registry has been added.
+        /// </summary>
+        internal bool promptToMigratePackages;
+
         /// <summary>
         /// Whether to enable / disable verbose logging.
         /// </summary>
@@ -61,6 +68,7 @@ private class Settings {
         internal Settings() {
             enable = UnityPackageManagerResolver.Enable;
             promptToAddRegistries = UnityPackageManagerResolver.PromptToAddRegistries;
+            promptToMigratePackages = UnityPackageManagerResolver.PromptToMigratePackages;
             verboseLoggingEnabled = UnityPackageManagerResolver.VerboseLoggingEnabled;
             useProjectSettings = UnityPackageManagerResolver.UseProjectSettings;
             analyticsSettings =
@@ -73,6 +81,7 @@ internal Settings() {
         internal void Save() {
             UnityPackageManagerResolver.Enable = enable;
             UnityPackageManagerResolver.PromptToAddRegistries = promptToAddRegistries;
+            UnityPackageManagerResolver.PromptToMigratePackages = promptToMigratePackages;
             UnityPackageManagerResolver.VerboseLoggingEnabled = verboseLoggingEnabled;
             UnityPackageManagerResolver.UseProjectSettings = useProjectSettings;
             analyticsSettings.Save();
@@ -81,6 +90,8 @@ internal void Save() {
 
     private Settings settings;
 
+    private Vector2 scrollPosition = new Vector2(0, 0);
+
     /// <summary>
     /// Load settings for this dialog.
     /// </summary>
@@ -92,7 +103,7 @@ private void LoadSettings() {
     /// Setup the window's initial position and size.
     /// </summary>
     public void Initialize() {
-        minSize = new Vector2(350, 400);
+        minSize = new Vector2(350, 430);
         position = new Rect(UnityEngine.Screen.width / 3,
                             UnityEngine.Screen.height / 3,
                             minSize.x, minSize.y);
@@ -120,6 +131,8 @@ public void OnGUI() {
                                       UnityPackageManagerResolverVersionNumber.Value.Minor,
                                       UnityPackageManagerResolverVersionNumber.Value.Build));
 
+        scrollPosition = EditorGUILayout.BeginScrollView(scrollPosition);
+
         if (!UnityPackageManagerResolver.ScopedRegistriesSupported) {
             GUILayout.Label(
                 String.Format("Only supported from Unity {0} and above.",
@@ -146,6 +159,15 @@ public void OnGUI() {
                         "before adding Unity Package Manager registries to the project's " +
                         "manifest.");
 
+        GUILayout.BeginHorizontal();
+        GUILayout.Label("Prompt to migrate packages", EditorStyles.boldLabel);
+        settings.promptToMigratePackages = EditorGUILayout.Toggle(settings.promptToMigratePackages);
+        GUILayout.EndHorizontal();
+        GUILayout.Label("When this option is enabled, this plugin will search the Unity Package " +
+                        "Manager (UPM) for available packages that are currently installed in " +
+                        "the project in the `Assets` directory that have equivalent or newer " +
+                        "versions available on UPM and prompt to migrate these packages.");
+
         settings.analyticsSettings.RenderGui();
 
         GUILayout.BeginHorizontal();
@@ -196,6 +218,8 @@ public void OnGUI() {
             UnityPackageManagerResolver.CheckRegistries();
         }
         GUILayout.EndHorizontal();
+
+        EditorGUILayout.EndScrollView();
         GUILayout.EndVertical();
 
         // Re-enable GUI

source/UnityPackageManagerResolver/src/UnityPackageManagerResolver.cs

@@ -230,6 +230,8 @@ private static Dictionary<string, UnityPackageManagerRegistry> ReadRegistriesFro
     /// <param name="invertSelection">If false, adds the selected registries and removes the
     /// unselected registries.  If true, removes the selected registries and adds the unselected
     /// registries.</param>
+    /// <param name="addedRegistries">If specified, is extended with the list of registries added
+    /// to the manifest.<param>
     /// <returns>true if successful, false otherwise.</returns>
     private static bool SyncRegistriesToManifest(
             PackageManifestModifier manifestModifier,
@@ -238,7 +240,8 @@ private static bool SyncRegistriesToManifest(
             HashSet<string> selectedRegistryUrls,
             bool addRegistries = true,
             bool removeRegistries = true,
-            bool invertSelection = false) {
+            bool invertSelection = false,
+            List<UnityPackageManagerRegistry> addedRegistries = null) {
         // Build a list of registries to add to and remove from the manifest.
         var registriesToAdd = new List<UnityPackageManagerRegistry>();
         var registriesToRemove = new List<UnityPackageManagerRegistry>();
@@ -280,6 +283,7 @@ private static bool SyncRegistriesToManifest(
                         "Added registries to {0}:\n{1}",
                         PackageManifestModifier.MANIFEST_FILE_PATH,
                         UnityPackageManagerRegistry.ToString(registriesToAdd)));
+                    if (addedRegistries != null) addedRegistries.AddRange(registriesToAdd);
                 }
                 if (registriesToRemove.Count > 0) {
                     logger.Log(String.Format(
@@ -379,13 +383,19 @@ internal static void UpdateManifest(ManifestModificationMode mode,
 
         // Applies the manifest modification based upon the modification mode.
         Action<HashSet<string>> syncRegistriesToManifest = (urlSelectionToApply) => {
+            var addedRegistries = new List<UnityPackageManagerRegistry>();
             SyncRegistriesToManifest(modifier, xmlRegistries, manifestRegistries,
                                      urlSelectionToApply,
                                      addRegistries: (mode == ManifestModificationMode.Add ||
                                                      mode == ManifestModificationMode.Modify),
                                      removeRegistries: (mode == ManifestModificationMode.Remove ||
                                                         mode == ManifestModificationMode.Modify),
-                                     invertSelection: mode == ManifestModificationMode.Remove);
+                                     invertSelection: mode == ManifestModificationMode.Remove,
+                                     addedRegistries: addedRegistries);
+            // If any registries were added try migration if enabled.
+            if (addedRegistries.Count > 0 && PromptToMigratePackages) {
+                PackageMigrator.MigratePackages();
+            }
         };
 
         if (xmlRegistries.Count > 0) {
@@ -470,12 +480,15 @@ internal static void RestoreDefaultSettings() {
         "Google.UnityPackageManagerResolver.Enable";
     private const string PreferencePromptToAddRegistries =
         "Google.UnityPackageManagerResolver.PromptToAddRegistries";
+    private const string PreferencePromptToMigratePackages =
+        "Google.UnityPackageManagerResolver.PromptToMigratePackages";
     private const string PreferenceVerboseLoggingEnabled =
         "Google.UnityPackageManagerResolver.VerboseLoggingEnabled";
     // List of preference keys, used to restore default settings.
     private static string[] PreferenceKeys = new[] {
         PreferenceEnable,
         PreferencePromptToAddRegistries,
+        PreferencePromptToMigratePackages,
         PreferenceVerboseLoggingEnabled
     };
 
@@ -531,6 +544,15 @@ public static bool PromptToAddRegistries {
         set { settings.SetBool(PreferencePromptToAddRegistries, value); }
     }
 
+    /// <summary>
+    /// Enable / disable prompting the user to migrate Version Handler to UPM packages after a
+    /// registry has been added.
+    /// </summary>
+    public static bool PromptToMigratePackages {
+        get { return settings.GetBool(PreferencePromptToMigratePackages, defaultValue: true); }
+        set { settings.SetBool(PreferencePromptToMigratePackages, value); }
+    }
+
     /// <summary>
     /// Enable / disable verbose logging.
     /// </summary>