Platform consistency issue when using addressable binary catalog

afirdausi · April 9, 2024, 4:47am

I have been trying to enabling binary catalog in my project to improve load time, but I got some issues until I finally managed to properly load my app with some dirty hacks. I got “Invalid header data!!!” exception when loading the catalog on runtime platform, which according to source code, it’s due to different value of ContentCatalogData.kMagic when the catalog is serialized on build pipeline, with the value when the catalog gets deserialized on runtime platform. I managed to resolve this by forcing this number to be deterministic and platform agnostic by using reflection. I’m not sure if this is the best way to resolve that, but it seems this header check is still present even in the latest version:

github.com

needle-mirror/com.unity.addressables/blob/1.21.20/Runtime/ResourceLocators/ContentCatalogData.cs#L77


      
              }
          }
          
          /// <summary>
          /// Container for ContentCatalogEntries.
          /// </summary>
          [Serializable]
          public class ContentCatalogData
          {
              //used to verify that this is a valid catalog data file
              static int kMagic = nameof(ContentCatalogData).GetHashCode();
              //used to check the version of the data in case the format needs to change in the future
              const int kVersion = 1;
          
              [NonSerialized]
              internal string localHash;
          
              [NonSerialized]
              internal IResourceLocation location;
          
              [SerializeField]

I believe we should not rely on string.GetHashCode to check the header because it’s not guaranteed to be deterministic and platform agnostic. String.GetHashCode Method (System) | Microsoft Learn

But since the load time improved quite significantly, I would like to continue exploring to use this feature in my project. Please let me know if there’s better solution for this!

davidla_unity · May 10, 2024, 6:23pm

Hey, so this is definitely something we’d like to fix. Would you mind filing a bug with the explanation you have here? Also, what platforms are you building and running on that have this issue? That’d go a long way to helping us solve the issue.
Thanks!

McTomas · November 17, 2024, 5:31pm

Is there a fix for this?

I’m having this issue in a recently made project I made for Crazy Games Jam.
I notice that this only happens when trying to run the game from GitHub Pages.

What can I do to fix?

Code Repo and page running:
https://codergamester.github.io/CrazyGames-Jam/

McTomas · November 24, 2024, 12:26pm

bump for feedback