Bug AddressableAssetSettingsDefaultObject.Settings sometimes null

We get random null reference exception caused by the following line when building our game on the build server:

foreach (var group in AddressableAssetSettingsDefaultObject.Settings.groups)

The surrounding code looks like:

Code (CSharp):

1. if (!UnityEditor.AddressableAssets.AddressableAssetSettingsDefaultObject.SettingsExists)
2. {
3.    Debug.LogWarning("Addressable Settings don't exist, creating new ones.");
4.  
5.    UnityEditor.AddressableAssets.AddressableAssetSettingsDefaultObject.Settings =
6.        UnityEditor.AddressableAssets.AddressableAssetSettingsDefaultObject.GetSettings(true);
7. }
8.  
9. if (UnityEditor.AddressableAssets.AddressableAssetSettingsDefaultObject.Settings == null)
10. {
11.    Debug.LogWarning("Addressable Settings is null.");
12. }
13. else if (UnityEditor.AddressableAssets.AddressableAssetSettingsDefaultObject.Settings.groups == null)
14. {
15.    Debug.LogWarning("Addressable Settings.groups is null.");
16. }
17.  
18. foreach (var group in UnityEditor.AddressableAssets.AddressableAssetSettingsDefaultObject.Settings.groups)
19. {
20. }
21.  
22.  

AddressableAssetSettingsDefaultObject.SettingsExists

returns true (I don't see the warning in the log), but

Settings

is null. Just triggering the build again magically causes this exception to disappear.

Why is

Settings

sometimes

null

and how can I fix/workaround this problem?

Using Unity 2018.4.26f1 and Addressables 1.13.1

 

A bug-report isn't going to help, since the reproduce chance is bad. It occurs randomly. Sometimes several times in a row, sometimes not at all for multiple days. It not only occurs on our build server, but also locally.

I just ran in the issue locally, occurred several times in a row, so I was able to attach a debugger. But after debugging, the issue went away magically.

However, as you can see below, the "Settings" reference is null, yet "SettingsExists" is true. Please ask your team to take a look at it. It's probably some of the if statements in the Settings property that is causing it.

 

bump, see my post above.

 

Hey @DavidUnity3d thank you for the reply.

I added more debug log's and it turns out

EditorApplication.isUpdating

is

true

. The code that sometimes causes

AddressableAssetSettingsDefaultObject.Settings

to return

null

basically looks like this:

Code (CSharp):

1. AssetDatabase.StartAssetEditing();
2. try
3. {
4.     EditorUtility.SaveFolderPanel("Save level to...", "Assets/Scenes", "");
5.  
6.     // https://forum.unity.com/threads/addressableassetsettingsdefaultobject-settings-groups-sometimes-null.964103/
7.     if (AddressableAssetSettingsDefaultObject.Settings == null)
8.     {
9.         Dbg.Error(null, "AddressableAssetSettings could not be loaded. isUpdating: {0}, isCompiling: {1}", EditorApplication.isUpdating, EditorApplication.isCompiling);
10.         return;
11.     }
12.  
13.     // Generate assets
14. }
15. finally
16. {
17.     AssetDatabase.StopAssetEditing();
18. }
19.  

The description of EditorApplication.isUpdating reads like StartAssetEditing/StopAssetEditing could be related to it? But I don't understand why it only occurs randomly when that's the case.

I changed the code (see below) and will continue to observe if the error keeps coming up:

Code (CSharp):

1. EditorUtility.SaveFolderPanel("Save level to...", "Assets/Scenes", "");
2.  
3. // https://forum.unity.com/threads/addressableassetsettingsdefaultobject-settings-groups-sometimes-null.964103/
4. if (AddressableAssetSettingsDefaultObject.Settings == null)
5. {
6.    Dbg.Error(null, "AddressableAssetSettings could not be loaded. isUpdating: {0}, isCompiling: {1}", EditorApplication.isUpdating, EditorApplication.isCompiling);
7.    return;
8. }
9.  
10. AssetDatabase.StartAssetEditing();
11. try
12. {
13.    // Generate assets
14. }
15. finally
16. {
17.    AssetDatabase.StopAssetEditing();
18. }

 

I was able to reproduce this on MacOS with a simple project setup with Addressables and the following build script:

Code (CSharp):

1. using UnityEditor;
2. using UnityEditor.AddressableAssets;
3. using UnityEditor.AddressableAssets.Settings;
4. using UnityEngine;
5.  
6. public static class AutoBuilder
7. {
8.     [MenuItem("Test/Build")]
9.     private static void BuildStuff()
10.     {
11.         RecompileScripts();
12.         BuildAddressables();
13.     }
14.  
15.     private static void RecompileScripts()
16.     {
17.         var guids = AssetDatabase.FindAssets("t:script", new[] {"Assets/Scripts"});
18.  
19.         if (guids.Length > 0)
20.         {
21.             var path = AssetDatabase.GUIDToAssetPath(guids[0]);
22.             AssetDatabase.ImportAsset(path, ImportAssetOptions.ForceUpdate);
23.         }
24.     }
25.  
26.     private static void BuildAddressables()
27.     {
28.         Debug.Log("");
29.         Debug.Log($"STATUS:  isUpdating: {EditorApplication.isUpdating}   isCompiling: {EditorApplication.isUpdating}  settingsExist: {AddressableAssetSettingsDefaultObject.SettingsExists}  isNull: {AddressableAssetSettingsDefaultObject.Settings == null}");
30.         AddressableAssetSettingsDefaultObject.Settings.ActivePlayerDataBuilderIndex = AddressableAssetSettingsDefaultObject.Settings.DataBuilders.Count - 1;
31.         AddressableAssetSettings.CleanPlayerContent();
32.         AddressableAssetSettings.BuildPlayerContent();
33.     }
34. }

Executing batch mode from the command line via:

Code (JavaScript):

1. #!/bin/bash
2.  
3. UNITY="/Applications/Unity/2019.4.17f1/Unity.app/Contents/MacOS/Unity"
4.  
5. $UNITY -batchMode -executeMethod AutoBuilder.BuildStuff -logFile -

I submitted a bug report on this with my sample project for 2019.4.17f1.

I suspect it is some sort of timing issue as it is dumping:

 

Can you post the bug-report case number, so Unity staff participating in this thread can quickly find it?

 

I was waiting on this, but found it in my junk mail: Case 1305730

 

I was able to load the settings file via your suggestion. However, it now throws this error in the log and still does not build the bundles:

Code (CSharp):

1. Addressable Asset Settings does not exist.  EditorApplication.isCompiling was true.
2. UnityEngine.DebugLogHandler:Internal_Log(LogType, LogOption, String, Object)
3. UnityEngine.DebugLogHandler:LogFormat(LogType, Object, String, Object[])
4. UnityEngine.Logger:Log(LogType, Object)
5. UnityEngine.Debug:LogError(Object)
6. UnityEditor.AddressableAssets.Settings.AddressableAssetSettings:BuildPlayerContent() (at Library/PackageCache/com.unity.addressables@1.16.15/Editor/Settings/AddressableAssetSettings.cs:1878)
7. AutoBuilder:BuildAddressables() (at Assets/Scripts/Editor/AutoBuilder.cs:45)
8. AutoBuilder:BuildStuff() (at Assets/Scripts/Editor/AutoBuilder.cs:12)

 

Just got an email update saying it's been entered into your system. Looks like Jira IN-949

 

This problem still occurs on our build server randomly. I run this code before we do anything else:

Code (CSharp):

1. // Another desperate attempt to workaround Addressables returning null
2. // https://forum.unity.com/threads/addressableassetsettingsdefaultobject-settings-groups-sometimes-null.964103/
3. // The idea with this workaround is that we access Addressables before any lock occurs (LockReloadAssemblies, StartAssetEditing, etc)
4. if (UnityEditor.AddressableAssets.AddressableAssetSettingsDefaultObject.Settings == null)
5.     Dbg.Warning(null, $"Addressable Settings is null.\nisUpdating: {EditorApplication.isUpdating}   isCompiling: {EditorApplication.isUpdating}  settingsExist: {UnityEditor.AddressableAssets.AddressableAssetSettingsDefaultObject.SettingsExists}");
6.  

... yet it sometimes returns null and will then later on cause a NullReferenceException. The output of above code is this:

Code (CSharp):

1. Addressable Settings is null.
2. isUpdating: False   isCompiling: False  settingsExist: True

 

Is there any update on this? We are hitting this issue as well but only on a Windows bulid

 

I'm hitting this issue too, on Addressables version 1.16.16. We recompile scripts, then attempt to access the
AddressableAssetSettingsDefaultObject.Settings, which is of course null.

 

We get this too on our build server - it's very likely to happen when doing a full clean build (which involves deleting the entire Library directory) - but that's the only time it happens. We're on AssetDatabase v2. Interestingly, it'll usually happen once for each platform (PC, Mac, XB1, PS4, Switch), but then once it has failed for each platform, each subsequent build is fine.

 

Also experiencing this issue in Unity 2021.1.14f1 (Addressables 1.16.19)

 

Hey guys, which version of Addressables fixes this issue? It seems already fixed here https://issuetracker.unity3d.com/is...script-recompile-when-editor-is-in-batch-mode but I can't see in which version was fixed.

 

Any news in this thread? How to fixed this problem？