Merge pull request Unity-Technologies#97 from jwtan-unity/odr-prefetch-tags

On-Demand Resources: Added functionality to apply prefetch categories to Addressables groups

Author: timt-unity3d

Advanced/On-Demand Resources/Assets/AddressableAssetsData/AssetGroups/Schemas/pack_d_AppleODRSchema.asset

@@ -13,5 +13,7 @@ MonoBehaviour:
   m_Name: pack_d_AppleODRSchema
   m_EditorClassIdentifier: 
   m_Group: {fileID: 11400000, guid: a9cbeb263f29246fcb5b9413cb69beb7, type: 2}
+  m_prefetchCategory: 0
+  m_order: 0
   m_BuildPath:
     m_Id: a7070c84fc67c4384b42419195dcee13

Advanced/On-Demand Resources/Assets/AddressableAssetsData/AssetGroups/Schemas/pack_e_AppleODRSchema.asset

@@ -13,5 +13,7 @@ MonoBehaviour:
   m_Name: pack_e_AppleODRSchema
   m_EditorClassIdentifier: 
   m_Group: {fileID: 11400000, guid: 27577b1f1eb80442aa0b36a2cb468bab, type: 2}
+  m_prefetchCategory: 0
+  m_order: 0
   m_BuildPath:
     m_Id: a7070c84fc67c4384b42419195dcee13

Advanced/On-Demand Resources/Assets/AddressableAssetsData/AssetGroups/Schemas/pack_f_AppleODRSchema.asset

@@ -13,5 +13,7 @@ MonoBehaviour:
   m_Name: pack_f_AppleODRSchema
   m_EditorClassIdentifier: 
   m_Group: {fileID: 11400000, guid: 367da7168bca646ffb7d98f87f2d872d, type: 2}
+  m_prefetchCategory: 0
+  m_order: 0
   m_BuildPath:
     m_Id: a7070c84fc67c4384b42419195dcee13

Advanced/On-Demand Resources/Assets/AddressableAssetsData/AssetGroups/Schemas/pack_g_AppleODRSchema.asset

@@ -13,5 +13,7 @@ MonoBehaviour:
   m_Name: pack_g_AppleODRSchema
   m_EditorClassIdentifier: 
   m_Group: {fileID: 11400000, guid: d927d0430d285434598a4c39f1c68931, type: 2}
+  m_prefetchCategory: 1
+  m_order: 3
   m_BuildPath:
     m_Id: a7070c84fc67c4384b42419195dcee13

Advanced/On-Demand Resources/Assets/AddressableAssetsData/AssetGroups/Schemas/pack_h_AppleODRSchema.asset

@@ -13,5 +13,7 @@ MonoBehaviour:
   m_Name: pack_h_AppleODRSchema
   m_EditorClassIdentifier: 
   m_Group: {fileID: 11400000, guid: c7fcc31dd72734b32ae7874a778246f4, type: 2}
+  m_prefetchCategory: 1
+  m_order: 2
   m_BuildPath:
     m_Id: a7070c84fc67c4384b42419195dcee13

Advanced/On-Demand Resources/Assets/AddressableAssetsData/AssetGroups/Schemas/pack_i_AppleODRSchema.asset

@@ -13,5 +13,7 @@ MonoBehaviour:
   m_Name: pack_i_AppleODRSchema
   m_EditorClassIdentifier: 
   m_Group: {fileID: 11400000, guid: 0ed893044bb394073875fa7eee1b3e70, type: 2}
+  m_prefetchCategory: 1
+  m_order: 1
   m_BuildPath:
     m_Id: a7070c84fc67c4384b42419195dcee13

Advanced/On-Demand Resources/Assets/AdrOdrExt/Editor/Build/DataBuilders/BuildScriptPackedModeODR.cs

@@ -1481,7 +1481,7 @@ void PostProcessBundles(AddressableAssetGroup assetGroup, IBundleBuildResults bu
                         Debug.LogWarning($"ODR Schema build path value is null");
                     }
                     targetPath = Path.Combine(schemaPath, Path.GetFileName(targetPath));
-                    AddBundleODR(outputBundleNames[i], targetPath, outputBundleNames[i]);
+                    AddBundleODR(outputBundleNames[i], targetPath, assetGroup.Name, (int)odrSchema.Category, odrSchema.Order);
                 }
 #endif
 
@@ -1664,6 +1664,8 @@ public class Bundle
                 public string name;
                 public string path;
                 public string tag;
+                public int category;
+                public int order;
             }
 
             public List<Bundle> m_bundles = new List<Bundle>();
@@ -1677,9 +1679,9 @@ public void CleanBundleInfoODR()
             DeleteFile(odrSettingsPath);
             m_Resources = new BundleInfoODR();
         }
-        public void AddBundleODR(string odr_name, string odr_path, string odr_tag)
+        public void AddBundleODR(string odr_name, string odr_path, string odr_tag, int odr_category, int odr_order)
         {
-            m_Resources.m_bundles.Add(new BundleInfoODR.Bundle() { name = odr_name, path = odr_path, tag = odr_tag });
+            m_Resources.m_bundles.Add(new BundleInfoODR.Bundle() { name = odr_name, path = odr_path, tag = odr_tag, category = odr_category, order = odr_order });
         }
 
         public void PreserveODRSettings(FileRegistry registry)
@@ -1722,6 +1724,32 @@ private static UnityEditor.iOS.Resource[] BuildPipeline_collectResources()
 
             return m_CollectedResources.ToArray();
         }
+
+        public static Dictionary<int, List<string>> CollectPrefetchCategories()
+        {
+            CollectODR();
+            
+            var results = new Dictionary<int, List<string>>();
+            
+            var initialTags = m_Resources.m_bundles
+                .Where(b=> b.category == (int)AppleODRSchema.PrefetchCategory.InitialInstallTags)
+                .Select(b=>b.tag)
+                .Distinct()
+                .ToList();
+            
+            results.Add((int)AppleODRSchema.PrefetchCategory.InitialInstallTags, initialTags);
+            
+            var prefetchedTags = m_Resources.m_bundles
+                .Where(b=> b.category == (int)AppleODRSchema.PrefetchCategory.PrefetchedTagOrder)
+                .OrderBy(b=>b.order)
+                .Select(b=>b.tag)
+                .Distinct()
+                .ToList();
+            
+            results.Add((int)AppleODRSchema.PrefetchCategory.PrefetchedTagOrder, prefetchedTags);
+            
+            return results;
+        }
 #endif        
     }
 }

Advanced/On-Demand Resources/Assets/AdrOdrExt/Editor/Build/PostProcess.meta

@@ -0,0 +1,43 @@
+#if UNITY_IOS
+using System;
+using UnityEditor;
+using UnityEditor.AddressableAssets.Build.DataBuilders;
+using UnityEditor.Build;
+using UnityEditor.Build.Reporting;
+using UnityEditor.iOS.Xcode;
+using UnityEngine;
+
+public class PostProcessODRBundles : IPostprocessBuildWithReport
+{
+    public int callbackOrder { get { return 10; } }
+
+    private const string InitialInstallTagsKey = "ON_DEMAND_RESOURCES_INITIAL_INSTALL_TAGS";
+    private const string PrefetchedTagOrderKey = "ON_DEMAND_RESOURCES_PREFETCH_ORDER";
+
+    public void OnPostprocessBuild(BuildReport report)
+    {
+        // Initialize PBXProject
+        var pathToBuiltProject = report.summary.outputPath;
+        string projectPath = PBXProject.GetPBXProjectPath(pathToBuiltProject);
+        PBXProject pbxProject = new PBXProject();
+        pbxProject.ReadFromFile(projectPath);
+        
+        // Set Prefetch Categories
+        string mainTargetGuid = pbxProject.GetUnityMainTargetGuid();
+        var categories = BuildScriptPackedModeODR.CollectPrefetchCategories();
+        
+        // Initial Install Tags
+        var initialTags = categories[(int)AppleODRSchema.PrefetchCategory.InitialInstallTags];
+        var initialTagsValue = string.Join(" ", initialTags);
+        pbxProject.SetBuildProperty(mainTargetGuid, InitialInstallTagsKey, initialTagsValue);
+        
+        // Prefetched Tag Order
+        var prefetchedTags = categories[(int)AppleODRSchema.PrefetchCategory.PrefetchedTagOrder];
+        var prefetchedTagsValue = string.Join(" ", prefetchedTags);
+        pbxProject.SetBuildProperty(mainTargetGuid, PrefetchedTagOrderKey, prefetchedTagsValue);
+        
+        // Apply changes to the PBXProject
+        pbxProject.WriteToFile(projectPath);
+    }
+}
+#endif