Bump version 0.20.2

Author: jjhartmann

Editor/BuildScripts/AssetExporter.cs

@@ -14,6 +14,7 @@
 using UnityEditor.AddressableAssets.Build;
 using UnityEditor.AddressableAssets.Settings;
 using UnityEditor.AddressableAssets.Settings.GroupSchemas;
+using UnityEditor.Compilation;
 using UnityEditor.SceneManagement;
 using UnityEngine;
 using System.Reflection;
@@ -48,11 +49,23 @@ private sealed class AddressablesBuildStateSnapshot
             public ScriptingImplementation StandaloneScriptingBackend;
         }
 
+        public sealed class ExportRequiresRecompileException : InvalidOperationException
+        {
+            public ExportRequiresRecompileException(string message)
+                : base(message)
+            {
+            }
+        }
+
         private static bool EditorCompiledWithJsonCatalog
         {
             get
             {
+#if ENABLE_JSON_CATALOG
                 return true;
+#else
+                return false;
+#endif
             }
         }
 
@@ -67,13 +80,21 @@ public AssetExporter(MTIONSDKAssetBase assetBase, ExportLocationOptions exportLo
             this.exportLocationOptions = exportLocationOptions;
         }
 
+        public static void EnsureProjectReadyForJsonCatalogExport()
+        {
+            AddressableAssetSettings settings = AddressableAssetSettingsDefaultObject.GetSettings(true);
+            EnsureJsonCatalogConfiguration(settings);
+        }
+
         public void ExportSDKAsset()
         {
             if (assetBase == null)
             {
                 throw new ArgumentNullException();
             }
 
+            EnsureProjectReadyForJsonCatalogExport();
+
             SDKServerManager.VerifyAssetGuid(assetBase);
 
 
@@ -406,20 +427,19 @@ public void RemoveAddressableGroup()
 
         public void ExportAsAddressableAssetBundle(Action onExportComplete)
         {
+            AddressableAssetSettings settings = AddressableAssetSettingsDefaultObject.GetSettings(true);
+
             var localUnityDirectory = SDKUtil.GetSDKLocalUnityBuildPath(assetBase, exportLocationOptions);
             if (Directory.Exists(localUnityDirectory))
             {
                 Directory.Delete(localUnityDirectory, true);
             }
             Directory.CreateDirectory(localUnityDirectory);
 
-            AddressableAssetSettings settings = AddressableAssetSettingsDefaultObject.GetSettings(true);
             AddressablesBuildStateSnapshot buildState = CaptureAddressablesBuildState(settings);
 
             try
             {
-                EnsureJsonCatalogConfiguration(settings);
-
                 settings.BuildRemoteCatalog = true;
                 settings.DisableCatalogUpdateOnStartup = true;
                 settings.ContiguousBundles = true;
@@ -440,13 +460,12 @@ public void ExportAsAddressableAssetBundle(Action onExportComplete)
 
                 foreach (Tuple<BuildTargetGroup, BuildTarget> target in targets)
                 {
-                    while (EditorApplication.isUpdating)
+                    if (EditorUserBuildSettings.activeBuildTarget != target.Item2)
                     {
-                        Thread.Sleep(10);
+                        throw new InvalidOperationException(
+                            $"The active build target must remain {target.Item2} during export. Wait for Unity to finish updating, then start the export again.");
                     }
 
-                    EditorUserBuildSettings.SwitchActiveBuildTarget(target.Item1, target.Item2);
-
                     AddressableAssetProfileSettings profile = settings.profileSettings;
                     string profileId = profile.GetProfileId(groupProfileName);
                     if (string.IsNullOrEmpty(profileId))
@@ -735,50 +754,128 @@ private static string FindBestCatalogCandidate(string targetPath, string extensi
                 .FirstOrDefault();
         }
 
+
         private static void EnsureJsonCatalogConfiguration(AddressableAssetSettings settings)
         {
             if (settings == null)
             {
                 throw new InvalidOperationException("Addressables settings are missing.");
             }
 
+            if (EditorApplication.isCompiling || EditorApplication.isUpdating)
+            {
+                throw new ExportRequiresRecompileException(
+                    "Unity is still compiling or updating scripts. Wait for Unity to finish, then start the export again.");
+            }
+
+            List<string> changes = new List<string>();
             bool changedSettings = false;
             if (!settings.EnableJsonCatalog)
             {
                 settings.EnableJsonCatalog = true;
                 changedSettings = true;
+                changes.Add("enabled Addressables 'Enable Json Catalog'");
             }
 
-            if (TryGetAddressablesBool(settings, "BundleLocalCatalog") != false)
+            bool? bundleLocalCatalog = TryGetAddressablesBool(settings, "BundleLocalCatalog");
+            if (bundleLocalCatalog.HasValue && bundleLocalCatalog.Value)
             {
-                TrySetAddressablesBool(settings, "BundleLocalCatalog", false);
-                changedSettings = true;
+                if (TrySetAddressablesBool(settings, "BundleLocalCatalog", false))
+                {
+                    changedSettings = true;
+                    changes.Add("disabled Addressables 'Bundle Local Catalog'");
+                }
             }
 
             if (changedSettings)
             {
+                EditorUtility.SetDirty(settings);
                 AssetDatabase.SaveAssets();
             }
 
-            string standaloneSymbols = PlayerSettings.GetScriptingDefineSymbolsForGroup(BuildTargetGroup.Standalone) ?? string.Empty;
+            string standaloneSymbols = GetStandaloneScriptingDefineSymbols() ?? string.Empty;
             if (!HasDefineSymbol(standaloneSymbols, EnableJsonCatalogDefine))
             {
                 string updatedSymbols = string.IsNullOrWhiteSpace(standaloneSymbols)
                     ? EnableJsonCatalogDefine
                     : $"{standaloneSymbols};{EnableJsonCatalogDefine}";
-                PlayerSettings.SetScriptingDefineSymbolsForGroup(BuildTargetGroup.Standalone, updatedSymbols);
-                AssetDatabase.SaveAssets();
-                throw new InvalidOperationException(
-                    $"Enabled the '{EnableJsonCatalogDefine}' scripting define for Standalone. Wait for Unity to finish recompiling scripts, then rerun export.");
+                SetStandaloneScriptingDefineSymbols(updatedSymbols);
+                changes.Add($"added Standalone scripting define '{EnableJsonCatalogDefine}'");
+            }
+
+            if (EnsureStandaloneWindows64Target())
+            {
+                changes.Add($"switched the active build target to {BuildTarget.StandaloneWindows64}");
+            }
+
+            if (changes.Count > 0)
+            {
+                RequestEditorScriptRecompile();
+                throw new ExportRequiresRecompileException(BuildRecompileRequiredMessage(changes));
             }
 
             if (!EditorCompiledWithJsonCatalog)
             {
-                throw new InvalidOperationException(
-                    $"The editor is currently compiled without '{EnableJsonCatalogDefine}'. Wait for Unity to finish recompiling scripts, then rerun export.");
+                RequestEditorScriptRecompile();
+                throw new ExportRequiresRecompileException(
+                    $"The SDK detected that Unity is still compiled without '{EnableJsonCatalogDefine}'. The SDK requested a script recompile. Wait for Unity to finish recompiling, then start the export again.");
             }
         }
 
+        private static bool EnsureStandaloneWindows64Target()
+        {
+            if (EditorUserBuildSettings.activeBuildTarget == BuildTarget.StandaloneWindows64)
+            {
+                EditorUserBuildSettings.selectedStandaloneTarget = BuildTarget.StandaloneWindows64;
+                return false;
+            }
+
+            EditorUserBuildSettings.selectedStandaloneTarget = BuildTarget.StandaloneWindows64;
+            if (!EditorUserBuildSettings.SwitchActiveBuildTarget(BuildTargetGroup.Standalone, BuildTarget.StandaloneWindows64))
+            {
+                throw new InvalidOperationException("The SDK could not switch the active build target to StandaloneWindows64.");
+            }
+
+            return true;
+        }
+
+        private static string BuildRecompileRequiredMessage(IEnumerable<string> changes)
+        {
+            string changeSummary = string.Join(", ", changes);
+            return $"The SDK updated the project for JSON catalog exports ({changeSummary}) and requested a script recompile. Wait for Unity to finish recompiling, then start the export again.";
+        }
+
+        private static void RequestEditorScriptRecompile()
+        {
+            AssetDatabase.SaveAssets();
+            AssetDatabase.Refresh();
+
+            if (EditorApplication.isCompiling || EditorApplication.isUpdating)
+            {
+                return;
+            }
+
+            CompilationPipeline.RequestScriptCompilation(RequestScriptCompilationOptions.CleanBuildCache);
+        }
+
+        private static string GetStandaloneScriptingDefineSymbols()
+        {
+#if UNITY_2021_2_OR_NEWER
+            return PlayerSettings.GetScriptingDefineSymbols(UnityEditor.Build.NamedBuildTarget.Standalone);
+#else
+            return PlayerSettings.GetScriptingDefineSymbolsForGroup(BuildTargetGroup.Standalone);
+#endif
+        }
+
+        private static void SetStandaloneScriptingDefineSymbols(string defineSymbols)
+        {
+#if UNITY_2021_2_OR_NEWER
+            PlayerSettings.SetScriptingDefineSymbols(UnityEditor.Build.NamedBuildTarget.Standalone, defineSymbols);
+#else
+            PlayerSettings.SetScriptingDefineSymbolsForGroup(BuildTargetGroup.Standalone, defineSymbols);
+#endif
+        }
+
         private static bool HasDefineSymbol(string defineSymbols, string symbol)
         {
             return defineSymbols.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries)

Editor/BuildScripts/BuildManager.cs

@@ -103,6 +103,8 @@ public float ExportPercentComplete
 
         private void BuildApplicationAssetBundle()
         {
+            AssetExporter.EnsureProjectReadyForJsonCatalogExport();
+
             var builder = AddressableAssetSettingsDefaultObject.Settings.ActivePlayerDataBuilder;
             AddressableAssetSettings.CleanPlayerContent(builder);
             AddressableAssetSettings.BuildPlayerContent();
@@ -136,6 +138,16 @@ private void BuildAndExportSdkScene()
                 roomObject.transform.rotation == Quaternion.identity &&
                 roomObject.transform.localScale == Vector3.one)
             {
+                try
+                {
+                    AssetExporter.EnsureProjectReadyForJsonCatalogExport();
+                }
+                catch (AssetExporter.ExportRequiresRecompileException ex)
+                {
+                    EditorUtility.DisplayDialog("SDK Export Recompile Required", ex.Message, "Close");
+                    return;
+                }
+
                 exportStartingScene = EditorSceneManager.GetActiveScene();
                 exportTaskRunning = true;
                 sceneExporter = new SceneExporter(sceneObjectDescriptor);
@@ -150,8 +162,16 @@ private void BuildAndExportSdkScene()
                     if (sceneExporter != null && !sceneExporter.IsCompleted)
                     {
                         sceneExporter.FailReport(ex);
-                        Debug.LogException(ex);
-                        EditorUtility.DisplayDialog("SDK Export Failed", ex.Message, "Close");
+
+                        if (ex is AssetExporter.ExportRequiresRecompileException)
+                        {
+                            EditorUtility.DisplayDialog("SDK Export Recompile Required", ex.Message, "Close");
+                        }
+                        else
+                        {
+                            Debug.LogException(ex);
+                            EditorUtility.DisplayDialog("SDK Export Failed", ex.Message, "Close");
+                        }
                     }
                 }
             }
@@ -167,8 +187,15 @@ private void OnExportFinished(SceneExporter exporter, Exception ex)
 
             if (ex != null)
             {
-                Debug.LogException(ex);
-                EditorUtility.DisplayDialog("SDK Export Failed", ex.Message, "Close");
+                if (ex is AssetExporter.ExportRequiresRecompileException)
+                {
+                    EditorUtility.DisplayDialog("SDK Export Recompile Required", ex.Message, "Close");
+                }
+                else
+                {
+                    Debug.LogException(ex);
+                    EditorUtility.DisplayDialog("SDK Export Failed", ex.Message, "Close");
+                }
             }
 
             if (exportStartingScene.IsValid() && exportStartingScene.isLoaded)

Editor/BuildScripts/SceneExporter.cs

@@ -625,6 +625,12 @@ private void ExportRoomSceneData(MTIONSDKDescriptorSceneBase sceneBase)
                 DeleteAssetExport(sceneBase, sceneBase.LocationOption);
                 RestoreAssetExportBackup(sceneBase, sceneBase.LocationOption);
                 DeleteAssetExportBackup(sceneBase, sceneBase.LocationOption);
+
+                if (ex is AssetExporter.ExportRequiresRecompileException)
+                {
+                    throw;
+                }
+
                 throw new Exception($"Error while exporting ROOM {internalId}, restored backup: {ex}");
             }
             finally
@@ -680,6 +686,12 @@ private void ExportEnvironmentSceneData(MTIONSDKDescriptorSceneBase sceneBase)
                 DeleteAssetExport(sceneBase, sceneBase.LocationOption);
                 RestoreAssetExportBackup(sceneBase, sceneBase.LocationOption);
                 DeleteAssetExportBackup(sceneBase, sceneBase.LocationOption);
+
+                if (ex is AssetExporter.ExportRequiresRecompileException)
+                {
+                    throw;
+                }
+
                 throw new Exception($"Error while exporting ENVIRONMENT {internalId}, restored backup: {ex}");
             }
             finally
@@ -747,6 +759,12 @@ private void ExportVirtualAssetData(MTIONSDKAssetBase assetBase)
                 DeleteAssetExport(backupTarget, LocationOptions);
                 RestoreAssetExportBackup(backupTarget, LocationOptions);
                 DeleteAssetExportBackup(backupTarget, LocationOptions);
+
+                if (ex is AssetExporter.ExportRequiresRecompileException)
+                {
+                    throw;
+                }
+
                 throw new Exception($"Error while exporting ASSET {internalId}, restored backup: {ex}");
             }
             finally