Address feedback
This commit is contained in:
parent
9d0ad91f63
commit
8b03ee8c81
|
|
@ -6,7 +6,7 @@ using System.Collections.Generic;
|
||||||
using Microsoft.Extensions.Logging;
|
using Microsoft.Extensions.Logging;
|
||||||
using Microsoft.Extensions.Primitives;
|
using Microsoft.Extensions.Primitives;
|
||||||
|
|
||||||
namespace Microsoft.AspNetCore.Localization
|
namespace Microsoft.AspNetCore.Localization.Internal
|
||||||
{
|
{
|
||||||
internal static class RequestCultureProviderLoggerExtensions
|
internal static class RequestCultureProviderLoggerExtensions
|
||||||
{
|
{
|
||||||
|
|
@ -22,7 +22,7 @@ namespace Microsoft.AspNetCore.Localization
|
||||||
_unsupportedUICulture = LoggerMessage.Define<string, IList<StringSegment>>(
|
_unsupportedUICulture = LoggerMessage.Define<string, IList<StringSegment>>(
|
||||||
LogLevel.Warning,
|
LogLevel.Warning,
|
||||||
2,
|
2,
|
||||||
"{requestCultureProvider} returned the following unsupported cultures '{cultures}'.");
|
"{requestCultureProvider} returned the following unsupported UI Cultures '{uiCultures}'.");
|
||||||
}
|
}
|
||||||
|
|
||||||
public static void UnsupportedCultures(this ILogger logger, string requestCultureProvider, IList<StringSegment> cultures)
|
public static void UnsupportedCultures(this ILogger logger, string requestCultureProvider, IList<StringSegment> cultures)
|
||||||
|
|
@ -8,6 +8,7 @@ using System.Linq;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using Microsoft.AspNetCore.Builder;
|
using Microsoft.AspNetCore.Builder;
|
||||||
using Microsoft.AspNetCore.Http;
|
using Microsoft.AspNetCore.Http;
|
||||||
|
using Microsoft.AspNetCore.Localization.Internal;
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
using Microsoft.Extensions.DependencyInjection;
|
||||||
using Microsoft.Extensions.Logging;
|
using Microsoft.Extensions.Logging;
|
||||||
using Microsoft.Extensions.Options;
|
using Microsoft.Extensions.Options;
|
||||||
|
|
@ -98,7 +99,7 @@ namespace Microsoft.AspNetCore.Localization
|
||||||
if (uiCultureInfo == null)
|
if (uiCultureInfo == null)
|
||||||
{
|
{
|
||||||
EnsureLogger(context);
|
EnsureLogger(context);
|
||||||
_logger?.UnsupportedCultures(provider.GetType().Name, uiCultures);
|
_logger?.UnsupportedUICultures(provider.GetType().Name, uiCultures);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -146,14 +146,12 @@ namespace Microsoft.Extensions.Localization
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
[Theory]
|
[Fact]
|
||||||
[InlineData("??", "en-US", "CookieRequestCultureProvider returned the following unsupported cultures '??'.")]
|
public async Task RequestLocalizationMiddleware_LogsWarningsForUnsupportedCultures()
|
||||||
[InlineData("en-US", "??", "CookieRequestCultureProvider returned the following unsupported cultures '??'.")]
|
|
||||||
public async Task UnsupportedCulturesShouldLogWarning(string culture, string uiCulture, string expectedMessage)
|
|
||||||
{
|
{
|
||||||
var sink = new TestSink(
|
var sink = new TestSink(
|
||||||
TestSink.EnableWithTypeName<CookieRequestCultureProvider>,
|
TestSink.EnableWithTypeName<RequestLocalizationMiddleware>,
|
||||||
TestSink.EnableWithTypeName<CookieRequestCultureProvider>);
|
TestSink.EnableWithTypeName<RequestLocalizationMiddleware>);
|
||||||
var loggerFactory = new TestLoggerFactory(sink, enabled: true);
|
var loggerFactory = new TestLoggerFactory(sink, enabled: true);
|
||||||
var builder = new WebHostBuilder()
|
var builder = new WebHostBuilder()
|
||||||
.Configure(app =>
|
.Configure(app =>
|
||||||
|
|
@ -176,14 +174,7 @@ namespace Microsoft.Extensions.Localization
|
||||||
};
|
};
|
||||||
options.RequestCultureProviders.Insert(0, provider);
|
options.RequestCultureProviders.Insert(0, provider);
|
||||||
app.UseRequestLocalization(options);
|
app.UseRequestLocalization(options);
|
||||||
app.Run(context =>
|
app.Run(context => Task.CompletedTask);
|
||||||
{
|
|
||||||
var requestCultureFeature = context.Features.Get<IRequestCultureFeature>();
|
|
||||||
var requestCulture = requestCultureFeature.RequestCulture;
|
|
||||||
Assert.Equal("en-US", requestCulture.Culture.Name);
|
|
||||||
Assert.NotNull(context.RequestServices.GetService<ILogger<RequestLocalizationMiddleware>>());
|
|
||||||
return Task.FromResult(0);
|
|
||||||
});
|
|
||||||
})
|
})
|
||||||
.ConfigureServices(services =>
|
.ConfigureServices(services =>
|
||||||
{
|
{
|
||||||
|
|
@ -193,12 +184,70 @@ namespace Microsoft.Extensions.Localization
|
||||||
using (var server = new TestServer(builder))
|
using (var server = new TestServer(builder))
|
||||||
{
|
{
|
||||||
var client = server.CreateClient();
|
var client = server.CreateClient();
|
||||||
|
var culture = "??";
|
||||||
|
var uiCulture = "ar-YE";
|
||||||
client.DefaultRequestHeaders.Add("Cookie", new CookieHeaderValue("Preferences", $"c={culture}|uic={uiCulture}").ToString());
|
client.DefaultRequestHeaders.Add("Cookie", new CookieHeaderValue("Preferences", $"c={culture}|uic={uiCulture}").ToString());
|
||||||
|
|
||||||
var response = await client.GetAsync(string.Empty);
|
var response = await client.GetAsync(string.Empty);
|
||||||
response.EnsureSuccessStatusCode();
|
response.EnsureSuccessStatusCode();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var expectedMessage = $"{nameof(CookieRequestCultureProvider)} returned the following unsupported cultures '??'.";
|
||||||
|
var logMessages = sink.Writes;
|
||||||
|
var count = logMessages.Count;
|
||||||
|
|
||||||
|
Assert.Equal(1, count);
|
||||||
|
Assert.Equal(LogLevel.Warning, logMessages[0].LogLevel);
|
||||||
|
Assert.Equal(expectedMessage, logMessages[0].State.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task RequestLocalizationMiddleware_LogsWarningsForUnsupportedUICultures()
|
||||||
|
{
|
||||||
|
var sink = new TestSink(
|
||||||
|
TestSink.EnableWithTypeName<RequestLocalizationMiddleware>,
|
||||||
|
TestSink.EnableWithTypeName<RequestLocalizationMiddleware>);
|
||||||
|
var loggerFactory = new TestLoggerFactory(sink, enabled: true);
|
||||||
|
var builder = new WebHostBuilder()
|
||||||
|
.Configure(app =>
|
||||||
|
{
|
||||||
|
var options = new RequestLocalizationOptions
|
||||||
|
{
|
||||||
|
DefaultRequestCulture = new RequestCulture("en-US"),
|
||||||
|
SupportedCultures = new List<CultureInfo>
|
||||||
|
{
|
||||||
|
new CultureInfo("ar-YE")
|
||||||
|
},
|
||||||
|
SupportedUICultures = new List<CultureInfo>
|
||||||
|
{
|
||||||
|
new CultureInfo("ar-YE")
|
||||||
|
}
|
||||||
|
};
|
||||||
|
var provider = new CookieRequestCultureProvider
|
||||||
|
{
|
||||||
|
CookieName = "Preferences"
|
||||||
|
};
|
||||||
|
options.RequestCultureProviders.Insert(0, provider);
|
||||||
|
app.UseRequestLocalization(options);
|
||||||
|
app.Run(context => Task.CompletedTask);
|
||||||
|
})
|
||||||
|
.ConfigureServices(services =>
|
||||||
|
{
|
||||||
|
services.AddSingleton(typeof(ILoggerFactory), loggerFactory);
|
||||||
|
});
|
||||||
|
|
||||||
|
using (var server = new TestServer(builder))
|
||||||
|
{
|
||||||
|
var client = server.CreateClient();
|
||||||
|
var culture = "ar-YE";
|
||||||
|
var uiCulture = "??";
|
||||||
|
client.DefaultRequestHeaders.Add("Cookie", new CookieHeaderValue("Preferences", $"c={culture}|uic={uiCulture}").ToString());
|
||||||
|
|
||||||
|
var response = await client.GetAsync(string.Empty);
|
||||||
|
response.EnsureSuccessStatusCode();
|
||||||
|
}
|
||||||
|
|
||||||
|
var expectedMessage = $"{nameof(CookieRequestCultureProvider)} returned the following unsupported UI Cultures '??'.";
|
||||||
var logMessages = sink.Writes;
|
var logMessages = sink.Writes;
|
||||||
var count = logMessages.Count;
|
var count = logMessages.Count;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,9 +11,9 @@
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="Microsoft.AspNetCore.TestHost" />
|
<PackageReference Include="Microsoft.AspNetCore.TestHost" />
|
||||||
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="$(AspNetCoreVersion)" />
|
<PackageReference Include="Microsoft.Extensions.DependencyInjection" />
|
||||||
<PackageReference Include="Microsoft.Extensions.Logging" />
|
<PackageReference Include="Microsoft.Extensions.Logging" />
|
||||||
<PackageReference Include="Microsoft.Extensions.Logging.Testing" Version="$(AspNetCoreVersion)" />
|
<PackageReference Include="Microsoft.Extensions.Logging.Testing" />
|
||||||
<PackageReference Include="Microsoft.NET.Test.Sdk" />
|
<PackageReference Include="Microsoft.NET.Test.Sdk" />
|
||||||
<PackageReference Include="xunit" />
|
<PackageReference Include="xunit" />
|
||||||
<PackageReference Include="xunit.runner.visualstudio" />
|
<PackageReference Include="xunit.runner.visualstudio" />
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue