Browse Source

Resolve the virtual file provider outside of the localization locks

pull/26333/head
maliming 4 weeks ago
parent
commit
cde4fc795e
No known key found for this signature in database GPG Key ID: A646B9CB645ECEA4
  1. 17
      framework/src/Volo.Abp.Localization/Volo/Abp/Localization/VirtualFiles/VirtualFileLocalizationResourceContributorBase.cs
  2. 94
      framework/test/Volo.Abp.Localization.Tests/Volo/Abp/Localization/VirtualFileLocalizationResourceContributor_Tests.cs

17
framework/src/Volo.Abp.Localization/Volo/Abp/Localization/VirtualFiles/VirtualFileLocalizationResourceContributorBase.cs

@ -16,7 +16,8 @@ public abstract class VirtualFileLocalizationResourceContributorBase : ILocaliza
public bool IsDynamic => false;
private readonly string _virtualPath;
private IVirtualFileProvider _virtualFileProvider = default!;
private IServiceProvider _serviceProvider = default!;
private IVirtualFileProvider? _virtualFileProvider;
private Dictionary<string, ILocalizationDictionary>? _dictionaries;
private bool _subscribedForChanges;
private readonly object _syncObj = new object();
@ -28,9 +29,15 @@ public abstract class VirtualFileLocalizationResourceContributorBase : ILocaliza
public virtual void Initialize(LocalizationResourceInitializationContext context)
{
_virtualFileProvider = context.ServiceProvider.GetRequiredService<IVirtualFileProvider>();
// The provider is resolved on first use, outside any lock: Initialize runs while the localizer factory holds
// its lock, and resolving a singleton under a lock deadlocks with a thread that creates that singleton and
// reads localized texts.
_serviceProvider = context.ServiceProvider;
}
private IVirtualFileProvider VirtualFileProvider =>
_virtualFileProvider ??= _serviceProvider.GetRequiredService<IVirtualFileProvider>();
public virtual LocalizedString? GetOrNull(string cultureName, string name)
{
return GetDictionaries().GetOrDefault(cultureName)?.GetOrNull(name);
@ -60,6 +67,8 @@ public abstract class VirtualFileLocalizationResourceContributorBase : ILocaliza
return dictionaries;
}
var virtualFileProvider = VirtualFileProvider;
lock (_syncObj)
{
dictionaries = _dictionaries;
@ -70,7 +79,7 @@ public abstract class VirtualFileLocalizationResourceContributorBase : ILocaliza
if (!_subscribedForChanges)
{
ChangeToken.OnChange(() => _virtualFileProvider.Watch(_virtualPath.EnsureEndsWith('/') + "*.*"),
ChangeToken.OnChange(() => virtualFileProvider.Watch(_virtualPath.EnsureEndsWith('/') + "*.*"),
() =>
{
_dictionaries = null;
@ -89,7 +98,7 @@ public abstract class VirtualFileLocalizationResourceContributorBase : ILocaliza
{
var rawDictionaries = new Dictionary<string, Dictionary<string, LocalizedString>>();
foreach (var file in _virtualFileProvider.GetDirectoryContents(_virtualPath)
foreach (var file in VirtualFileProvider.GetDirectoryContents(_virtualPath)
.Where(f => !f.IsDirectory && CanParseFile(f))
.OrderBy(f => f.Name, StringComparer.Ordinal))
{

94
framework/test/Volo.Abp.Localization.Tests/Volo/Abp/Localization/VirtualFileLocalizationResourceContributor_Tests.cs

@ -0,0 +1,94 @@
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Options;
using Shouldly;
using Volo.Abp.Localization.VirtualFiles.Json;
using Volo.Abp.Testing;
using Volo.Abp.VirtualFileSystem;
using Xunit;
namespace Volo.Abp.Localization;
public class VirtualFileLocalizationResourceContributor_Tests : AbpIntegratedTest<AbpLocalizationTestModule>
{
[Fact]
public void Initialize_Should_Not_Resolve_Services()
{
var serviceProvider = new RecordingServiceProvider(ServiceProvider);
var resource = GetRequiredService<IOptions<AbpLocalizationOptions>>().Value.Resources.Get("LocalizationTestCountryNames");
var contributor = new JsonVirtualFileLocalizationResourceContributor("/Volo/Abp/Localization/TestResources/Base/CountryNames");
contributor.Initialize(new LocalizationResourceInitializationContext(resource, serviceProvider));
serviceProvider.RequestedTypes.ShouldBeEmpty();
contributor.GetOrNull("en", "USA").Value.ShouldBe("United States of America");
serviceProvider.RequestedTypes.ShouldBe(new[] { typeof(IVirtualFileProvider) });
}
[Fact]
public void The_First_Read_Should_Resolve_Services_Outside_Of_Its_Lock()
{
var resource = GetRequiredService<IOptions<AbpLocalizationOptions>>().Value.Resources.Get("LocalizationTestCountryNames");
var contributor = new JsonVirtualFileLocalizationResourceContributor("/Volo/Abp/Localization/TestResources/Base/CountryNames");
var serviceProvider = new ReadingWhileResolvingServiceProvider(ServiceProvider, contributor);
contributor.Initialize(new LocalizationResourceInitializationContext(resource, serviceProvider));
contributor.GetOrNull("en", "USA").Value.ShouldBe("United States of America");
serviceProvider.OtherReadCompletedWhileResolving.ShouldBeTrue();
serviceProvider.OtherRead.IsCompletedSuccessfully.ShouldBeTrue();
}
/* Reads the same resource from another thread while the first read resolves the virtual file provider, as a
* container does when it creates a singleton that reads localized texts while it holds its own lock. */
private class ReadingWhileResolvingServiceProvider : IServiceProvider
{
public Task OtherRead { get; private set; }
public bool OtherReadCompletedWhileResolving { get; private set; }
private readonly IServiceProvider _serviceProvider;
private readonly JsonVirtualFileLocalizationResourceContributor _contributor;
private int _otherReadStarted;
public ReadingWhileResolvingServiceProvider(IServiceProvider serviceProvider, JsonVirtualFileLocalizationResourceContributor contributor)
{
_serviceProvider = serviceProvider;
_contributor = contributor;
}
public object GetService(Type serviceType)
{
// The other read resolves the provider too, and may do so before OtherRead is assigned.
if (serviceType == typeof(IVirtualFileProvider) && Interlocked.CompareExchange(ref _otherReadStarted, 1, 0) == 0)
{
var otherRead = Task.Run(() => _contributor.GetOrNull("en", "Brazil"));
OtherRead = otherRead;
OtherReadCompletedWhileResolving = otherRead.Wait(TimeSpan.FromSeconds(5));
}
return _serviceProvider.GetService(serviceType);
}
}
private class RecordingServiceProvider : IServiceProvider
{
public List<Type> RequestedTypes { get; } = new();
private readonly IServiceProvider _serviceProvider;
public RecordingServiceProvider(IServiceProvider serviceProvider)
{
_serviceProvider = serviceProvider;
}
public object GetService(Type serviceType)
{
RequestedTypes.Add(serviceType);
return _serviceProvider.GetService(serviceType);
}
}
}
Loading…
Cancel
Save