public IEnumerator CheckForUpdates_Returns_OnlyModifiedResults()
{
var remoteHashLoc = new ResourceLocationBase("RemoteHash1", "Remote", kRemoteHashProviderId + 1, typeof(string));
var localHashLoc = new ResourceLocationBase("LocalHash1", "Local", kLocalHashProviderId + 1, typeof(string));
var catalogLoc = new ResourceLocationBase("cat1", "cat_id", nameof(TestCatalogProvider), typeof(IResourceLocator), remoteHashLoc, localHashLoc);
var remoteHashLoc2 = new ResourceLocationBase("RemoteHash2", "Remote", kRemoteHashProviderId + 2, typeof(string));
var localHashLoc2 = new ResourceLocationBase("LocalHash2", "Local", kLocalHashProviderId + 2, typeof(string));
var catalogLoc2 = new ResourceLocationBase("cat2", "cat_id", nameof(TestCatalogProvider), typeof(IResourceLocator), remoteHashLoc2, localHashLoc2);
var aa = new AddressablesImpl(null);
aa.ResourceManager.ResourceProviders.Add(new TestHashProvider(kRemoteHashProviderId + 1, "same"));
aa.ResourceManager.ResourceProviders.Add(new TestHashProvider(kLocalHashProviderId + 1, "same"));
aa.ResourceManager.ResourceProviders.Add(new TestHashProvider(kRemoteHashProviderId + 2, "different"));
aa.ResourceManager.ResourceProviders.Add(new TestHashProvider(kLocalHashProviderId + 2, "same"));
aa.ResourceManager.ResourceProviders.Add(new TestCatalogProvider(kNewLocatorId));
aa.AddResourceLocator(new TestLocator(kLocatorId), "same", catalogLoc);
aa.AddResourceLocator(new TestLocator(kLocatorId + 2), "same", catalogLoc2);
var op = aa.CheckForCatalogUpdates(false);
yield return(op);
Assert.IsNotNull(op.Result);
Assert.AreEqual(1, op.Result.Count);
Assert.AreEqual(kLocatorId + 2, op.Result[0]);
Assert.AreEqual(1, aa.CatalogsWithAvailableUpdates.Count());
Assert.AreEqual(kLocatorId + 2, aa.CatalogsWithAvailableUpdates.First());
aa.Release(op);
}
protected override void Execute()
{
var db = GetBuilderOfType <BuildScriptFastMode>(m_settings);
if (db == null)
{
UnityEngine.Debug.Log($"Unable to find {nameof(BuildScriptFastMode)} builder in settings assets. Using default Instance and Scene Providers.");
}
var locator = new AddressableAssetSettingsLocator(m_settings);
m_addressables.AddResourceLocator(locator);
m_addressables.AddResourceLocator(new DynamicResourceLocator(m_addressables));
m_addressables.ResourceManager.postProfilerEvents = ProjectConfigData.PostProfilerEvents;
if (!m_addressables.ResourceManager.postProfilerEvents)
{
m_Diagnostics.Dispose();
m_Diagnostics = null;
m_addressables.ResourceManager.ClearDiagnosticCallbacks();
}
//NOTE: for some reason, the data builders can get lost from the settings asset during a domain reload - this only happens in tests and custom instance and scene providers are not needed
m_addressables.InstanceProvider = db == null ? new InstanceProvider() : ObjectInitializationData.CreateSerializedInitializationData(db.instanceProviderType.Value).CreateInstance <IInstanceProvider>();
m_addressables.SceneProvider = db == null ? new SceneProvider() : ObjectInitializationData.CreateSerializedInitializationData(db.sceneProviderType.Value).CreateInstance <ISceneProvider>();
m_addressables.ResourceManager.ResourceProviders.Add(new AssetDatabaseProvider());
m_addressables.ResourceManager.ResourceProviders.Add(new TextDataProvider());
m_addressables.ResourceManager.ResourceProviders.Add(new JsonAssetProvider());
m_addressables.ResourceManager.ResourceProviders.Add(new LegacyResourcesProvider());
m_addressables.ResourceManager.ResourceProviders.Add(new AtlasSpriteProvider());
m_addressables.ResourceManager.ResourceProviders.Add(new ContentCatalogProvider(m_addressables.ResourceManager));
WebRequestQueue.SetMaxConcurrentRequests(m_settings.MaxConcurrentWebRequests);
if (m_settings.InitializationObjects.Count == 0)
{
Complete(locator, true, null);
}
else
{
List <AsyncOperationHandle> initOperations = new List <AsyncOperationHandle>();
foreach (var io in m_settings.InitializationObjects)
{
if (io is IObjectInitializationDataProvider)
{
var ioData = (io as IObjectInitializationDataProvider).CreateObjectInitializationData();
var h = ioData.GetAsyncInitHandle(m_addressables.ResourceManager);
initOperations.Add(h);
}
}
groupOp = m_addressables.ResourceManager.CreateGenericGroupOperation(initOperations, true);
groupOp.Completed += op =>
{
bool success = op.Status == AsyncOperationStatus.Succeeded;
Complete(locator, success, success ? "" : $"{op.DebugName}, status={op.Status}, result={op.Result} failed initialization.");
m_addressables.Release(op);
};
}
}
public IEnumerator Locator_KeysProperty_Contains_Expected_Keys_ForAllBuildScripts()
{
using (new HideResourceFoldersScope())
{
SetupLocatorAssets();
AddressablesDataBuilderInput input = new AddressablesDataBuilderInput(m_Settings);
input.Logger = new BuildLog();
var fastMode = ScriptableObject.CreateInstance <BuildScriptFastMode>();
var virtualMode = ScriptableObject.CreateInstance <BuildScriptVirtualMode>();
var packedMode = ScriptableObject.CreateInstance <BuildScriptPackedMode>();
var packedPlayMode = ScriptableObject.CreateInstance <BuildScriptPackedPlayMode>();
AddressablesImpl fastModeImpl = new AddressablesImpl(new DefaultAllocationStrategy());
fastModeImpl.AddResourceLocator(new AddressableAssetSettingsLocator(m_Settings));
var fastModeSettingsPath = fastMode.BuildData <AddressableAssetBuildResult>(input).OutputPath;
var virtualModeSettingsPath = virtualMode.BuildData <AddressableAssetBuildResult>(input).OutputPath;
var packedModeSettingsPath = packedMode.BuildData <AddressableAssetBuildResult>(input).OutputPath;
var packedPlayModeSettingsPath = packedPlayMode.BuildData <AddressableAssetBuildResult>(input).OutputPath;
AddressablesImpl fmImpl = new AddressablesImpl(new DefaultAllocationStrategy());
AddressablesImpl virtualImpl = new AddressablesImpl(new DefaultAllocationStrategy());
AddressablesImpl packedImpl = new AddressablesImpl(new DefaultAllocationStrategy());
AddressablesImpl packedPlayImpl = new AddressablesImpl(new DefaultAllocationStrategy());
fmImpl.AddResourceLocator(new AddressableAssetSettingsLocator(m_Settings));
virtualImpl.AddResourceLocator(new AddressableAssetSettingsLocator(m_Settings));
packedImpl.AddResourceLocator(new AddressableAssetSettingsLocator(m_Settings));
packedPlayImpl.AddResourceLocator(new AddressableAssetSettingsLocator(m_Settings));
var fastModeHandle = fmImpl.ResourceManager.StartOperation(new FastModeInitializationOperation(fmImpl, m_Settings), default(AsyncOperationHandle));
var virtualHandle = virtualImpl.InitializeAsync(virtualModeSettingsPath);
var packedHandle = packedImpl.InitializeAsync(packedModeSettingsPath);
var packedPlayHandle = packedPlayImpl.InitializeAsync(packedPlayModeSettingsPath);
while (!fastModeHandle.IsDone && !virtualHandle.IsDone && !packedHandle.IsDone &&
!packedPlayHandle.IsDone)
{
yield return(null);
}
var fastModeKeys = fmImpl.ResourceLocators.First(l => l.GetType() == typeof(AddressableAssetSettingsLocator)).Keys;
var virtualModeKeys = virtualImpl.ResourceLocators.First(l => l.GetType() == typeof(AddressableAssetSettingsLocator)).Keys;
var packedModeKeys = packedImpl.ResourceLocators.First(l => l.GetType() == typeof(AddressableAssetSettingsLocator)).Keys;
var packedPlayKeys = packedPlayImpl.ResourceLocators.First(l => l.GetType() == typeof(AddressableAssetSettingsLocator)).Keys;
//Get our baseline
Assert.AreEqual(ExpectedKeys.Count, fastModeKeys.Count());
foreach (var key in fastModeKeys)
{
Assert.IsTrue(ExpectedKeys.Contains(key));
}
//Transitive property to check other build scripts
CollectionAssert.AreEqual(fastModeKeys, virtualModeKeys);
CollectionAssert.AreEqual(fastModeKeys, packedPlayKeys);
CollectionAssert.AreEqual(fastModeKeys, packedModeKeys);
}
}
public IEnumerator UpdateContent_UpdatesCatalogs_Returns_ListOfLocators()
{
var remoteHashLoc = new ResourceLocationBase("RemoteHash", "Remote", kRemoteHashProviderId, typeof(string));
var localHashLoc = new ResourceLocationBase("LocalHash", "Local", kLocalHashProviderId, typeof(string));
var catalogLoc = new ResourceLocationBase("cat", "cat_id", typeof(TestCatalogProvider).FullName, typeof(object), remoteHashLoc, localHashLoc);
var aa = new AddressablesImpl(null);
aa.ResourceManager.ResourceProviders.Add(new TestHashProvider(kRemoteHashProviderId, "different"));
aa.ResourceManager.ResourceProviders.Add(new TestHashProvider(kLocalHashProviderId, "same"));
aa.ResourceManager.ResourceProviders.Add(new TestCatalogProvider(kNewLocatorId));
aa.AddResourceLocator(new TestLocator(kLocatorId, remoteHashLoc, localHashLoc, catalogLoc), "same", catalogLoc);
var op = aa.CheckForCatalogUpdates(false);
yield return(op);
Assert.IsNotNull(op.Result);
Assert.AreEqual(1, op.Result.Count);
var updateOp = aa.UpdateCatalogs(op.Result, false);
aa.Release(op);
yield return(updateOp);
Assert.IsNotNull(updateOp.Result);
Assert.AreEqual(1, updateOp.Result.Count);
Assert.AreEqual(kNewLocatorId, updateOp.Result[0].LocatorId);
aa.Release(updateOp);
}
IEnumerator InitWithoutInitializeAsync()
{
if (!initializationComplete || TypeName != currentInitType)
{
if (m_Addressables == null)
{
m_Addressables = new AddressablesImpl(new LRUCacheAllocationStrategy(1000, 1000, 100, 10));
}
currentInitType = TypeName;
yield return(this);
for (int i = 0; i < 3; i++)
{
var locator = new DynamicResourceLocator(m_Addressables);
m_Addressables.AddResourceLocator(locator);
}
initializationComplete = true;
m_PrevHandler = ResourceManager.ExceptionHandler;
ResourceManager.ExceptionHandler = null;
}
m_Addressables.ResourceManager.ClearDiagnosticCallbacks();
m_StartingOpCount = m_Addressables.ResourceManager.OperationCacheCount;
m_StartingTrackedHandleCount = m_Addressables.TrackedHandleCount;
m_StartingInstanceCount = m_Addressables.ResourceManager.InstanceOperationCount;
}
protected override void Execute()
{
Addressables.LogFormat("Addressables - runtime data operation completed with status = {0}, result = {1}.", m_rtdOp.Status, m_rtdOp.Result);
if (m_rtdOp.Result == null)
{
Addressables.LogWarningFormat("Addressables - Unable to load runtime data at location {0}.", m_rtdOp);
Complete(Result, false, string.Format("Addressables - Unable to load runtime data at location {0}.", m_rtdOp));
return;
}
var rtd = m_rtdOp.Result;
m_Addressables.Release(m_rtdOp);
if (rtd.CertificateHandlerType != null)
{
m_Addressables.ResourceManager.CertificateHandlerInstance = Activator.CreateInstance(rtd.CertificateHandlerType) as CertificateHandler;
}
#if UNITY_EDITOR
if (UnityEditor.EditorUserBuildSettings.activeBuildTarget.ToString() != rtd.BuildTarget)
{
Addressables.LogErrorFormat("Addressables - runtime data was built with a different build target. Expected {0}, but data was built with {1}. Certain assets may not load correctly including shaders. You can rebuild player content via the Addressables window.", UnityEditor.EditorUserBuildSettings.activeBuildTarget, rtd.BuildTarget);
}
#endif
if (!rtd.LogResourceManagerExceptions)
{
ResourceManager.ExceptionHandler = null;
}
if (!rtd.ProfileEvents)
{
m_Diagnostics.Dispose();
m_Diagnostics = null;
}
// DiagnosticEventCollector.ResourceManagerProfilerEventsEnabled = rtd.ProfileEvents;
Addressables.Log("Addressables - loading initialization objects.");
ContentCatalogProvider ccp = m_Addressables.ResourceManager.ResourceProviders
.FirstOrDefault(rp => rp.GetType() == typeof(ContentCatalogProvider)) as ContentCatalogProvider;
if (ccp != null)
{
ccp.DisableCatalogUpdateOnStart = rtd.DisableCatalogUpdateOnStartup;
}
var locMap = new ResourceLocationMap("CatalogLocator", rtd.CatalogLocations);
m_Addressables.AddResourceLocator(locMap);
IList <IResourceLocation> catalogs;
if (!locMap.Locate(ResourceManagerRuntimeData.kCatalogAddress, typeof(ContentCatalogData), out catalogs))
{
Addressables.LogWarningFormat(
"Addressables - Unable to find any catalog locations in the runtime data.");
m_Addressables.RemoveResourceLocator(locMap);
Complete(Result, false, "Addressables - Unable to find any catalog locations in the runtime data.");
}
else
{
Addressables.LogFormat("Addressables - loading content catalogs, {0} found.", catalogs.Count);
LoadContentCatalogInternal(catalogs, 0, locMap);
}
}
static AsyncOperationHandle <IResourceLocator> OnCatalogDataLoaded(AddressablesImpl addressables, AsyncOperationHandle <ContentCatalogData> op, string providerSuffix, IResourceLocation remoteHashLocation)
{
var data = op.Result;
addressables.Release(op);
if (data == null)
{
var opException = op.OperationException != null ? new Exception("Failed to load content catalog.", op.OperationException) : new Exception("Failed to load content catalog.");
return(addressables.ResourceManager.CreateCompletedOperationWithException <IResourceLocator>(null, opException));
}
else
{
if (data.ResourceProviderData != null)
{
foreach (var providerData in data.ResourceProviderData)
{
LoadProvider(addressables, providerData, providerSuffix);
}
}
if (addressables.InstanceProvider == null)
{
var prov = data.InstanceProviderData.CreateInstance <IInstanceProvider>();
if (prov != null)
{
addressables.InstanceProvider = prov;
}
}
if (addressables.SceneProvider == null)
{
var prov = data.SceneProviderData.CreateInstance <ISceneProvider>();
if (prov != null)
{
addressables.SceneProvider = prov;
}
}
if (remoteHashLocation != null)
{
data.location.Dependencies[(int)ContentCatalogProvider.DependencyHashIndex.Remote] = remoteHashLocation;
}
ResourceLocationMap locMap = data.CreateCustomLocator(data.location.PrimaryKey, providerSuffix);
addressables.AddResourceLocator(locMap, data.localHash, data.location);
addressables.AddResourceLocator(new DynamicResourceLocator(addressables));
return(addressables.ResourceManager.CreateCompletedOperation <IResourceLocator>(locMap, string.Empty));
}
}
static AsyncOperationHandle <IResourceLocator> OnCatalogDataLoaded(AddressablesImpl addressables, AsyncOperationHandle <ContentCatalogData> op, string providerSuffix)
{
var data = op.Result;
addressables.Release(op);
if (data == null)
{
return(addressables.ResourceManager.CreateCompletedOperation <IResourceLocator>(null, new Exception("Failed to load content catalog.").Message));
}
else
{
if (data.ResourceProviderData != null)
{
foreach (var providerData in data.ResourceProviderData)
{
LoadProvider(addressables, providerData, providerSuffix);
}
}
if (addressables.InstanceProvider == null)
{
var prov = data.InstanceProviderData.CreateInstance <IInstanceProvider>();
if (prov != null)
{
addressables.InstanceProvider = prov;
}
}
if (addressables.SceneProvider == null)
{
var prov = data.SceneProviderData.CreateInstance <ISceneProvider>();
if (prov != null)
{
addressables.SceneProvider = prov;
}
}
ResourceLocationMap locMap = data.CreateCustomLocator(data.location.PrimaryKey, providerSuffix);
addressables.AddResourceLocator(locMap, data.localHash, data.location);
addressables.AddResourceLocator(new DynamicResourceLocator(addressables));
return(addressables.ResourceManager.CreateCompletedOperation <IResourceLocator>(locMap, string.Empty));
}
}
public IEnumerator CheckForUpdates_Returns_NonEmptyList_When_HashesDontMatch()
{
var remoteHashLoc = new ResourceLocationBase("RemoteHash", "Remote", kRemoteHashProviderId, typeof(string));
var localHashLoc = new ResourceLocationBase("LocalHash", "Local", kLocalHashProviderId, typeof(string));
var catalogLoc = new ResourceLocationBase("cat", "cat_id", nameof(TestCatalogProvider), typeof(IResourceLocator), remoteHashLoc, localHashLoc);
var aa = new AddressablesImpl(null);
aa.ResourceManager.ResourceProviders.Add(new TestHashProvider(kRemoteHashProviderId, "different"));
aa.ResourceManager.ResourceProviders.Add(new TestHashProvider(kLocalHashProviderId, "same"));
aa.ResourceManager.ResourceProviders.Add(new TestCatalogProvider(kNewLocatorId));
aa.AddResourceLocator(new TestLocator(kLocatorId), "same", catalogLoc);
var op = aa.CheckForCatalogUpdates(false);
yield return(op);
Assert.IsNotNull(op.Result);
Assert.AreEqual(1, op.Result.Count);
Assert.AreEqual(1, aa.CatalogsWithAvailableUpdates.Count());
aa.Release(op);
}
protected override void Execute()
{
Addressables.LogFormat("Addressables - runtime data operation completed with status = {0}, result = {1}.", m_rtdOp.Status, m_rtdOp.Result);
if (m_rtdOp.Result == null)
{
Addressables.LogWarningFormat("Addressables - Unable to load runtime data at location {0}.", m_rtdOp);
Complete(Result, false, string.Format("Addressables - Unable to load runtime data at location {0}.", m_rtdOp));
return;
}
Addressables.LogFormat("Initializing Addressables version {0}.", m_rtdOp.Result.AddressablesVersion);
var rtd = m_rtdOp.Result;
m_Addressables.ResourceManager.postProfilerEvents = rtd.ProfileEvents;
WebRequestQueue.SetMaxConcurrentRequests(rtd.MaxConcurrentWebRequests);
m_Addressables.CatalogRequestsTimeout = rtd.CatalogRequestsTimeout;
foreach (var catalogLocation in rtd.CatalogLocations)
{
if (catalogLocation.Data != null && catalogLocation.Data is ProviderLoadRequestOptions loadData)
{
loadData.WebRequestTimeout = rtd.CatalogRequestsTimeout;
}
}
m_Addressables.Release(m_rtdOp);
if (rtd.CertificateHandlerType != null)
{
m_Addressables.ResourceManager.CertificateHandlerInstance = Activator.CreateInstance(rtd.CertificateHandlerType) as CertificateHandler;
}
#if UNITY_EDITOR
if (UnityEditor.EditorUserBuildSettings.activeBuildTarget.ToString() != rtd.BuildTarget)
{
Addressables.LogErrorFormat("Addressables - runtime data was built with a different build target. Expected {0}, but data was built with {1}. Certain assets may not load correctly including shaders. You can rebuild player content via the Addressables window.", UnityEditor.EditorUserBuildSettings.activeBuildTarget, rtd.BuildTarget);
}
#endif
if (!rtd.LogResourceManagerExceptions)
{
ResourceManager.ExceptionHandler = null;
}
if (!rtd.ProfileEvents)
{
m_Diagnostics.Dispose();
m_Diagnostics = null;
m_Addressables.ResourceManager.ClearDiagnosticCallbacks();
}
Addressables.Log("Addressables - loading initialization objects.");
ContentCatalogProvider ccp = m_Addressables.ResourceManager.ResourceProviders
.FirstOrDefault(rp => rp.GetType() == typeof(ContentCatalogProvider)) as ContentCatalogProvider;
if (ccp != null)
{
ccp.DisableCatalogUpdateOnStart = rtd.DisableCatalogUpdateOnStartup;
ccp.IsLocalCatalogInBundle = rtd.IsLocalCatalogInBundle;
}
var locMap = new ResourceLocationMap("CatalogLocator", rtd.CatalogLocations);
m_Addressables.AddResourceLocator(locMap);
IList <IResourceLocation> catalogs;
if (!locMap.Locate(ResourceManagerRuntimeData.kCatalogAddress, typeof(ContentCatalogData), out catalogs))
{
Addressables.LogWarningFormat(
"Addressables - Unable to find any catalog locations in the runtime data.");
m_Addressables.RemoveResourceLocator(locMap);
Complete(Result, false, "Addressables - Unable to find any catalog locations in the runtime data.");
}
else
{
Addressables.LogFormat("Addressables - loading content catalogs, {0} found.", catalogs.Count);
IResourceLocation remoteHashLocation = null;
if (catalogs[0].Dependencies.Count == 2 && rtd.DisableCatalogUpdateOnStartup)
{
remoteHashLocation = catalogs[0].Dependencies[(int)ContentCatalogProvider.DependencyHashIndex.Remote];
catalogs[0].Dependencies[(int)ContentCatalogProvider.DependencyHashIndex.Remote] = catalogs[0].Dependencies[(int)ContentCatalogProvider.DependencyHashIndex.Cache];
}
m_loadCatalogOp = LoadContentCatalogInternal(catalogs, 0, locMap, remoteHashLocation);
}
}