feat(IIpLocatorProvider): add LastError property (#7708)

* doc(Localization): remove NET5/6 tab item

* doc: 更新注释文档

* feat: 增加 LastError 参数

* refactor: 重构代码

* doc: 更新示例

* doc: 删除空行

* test: 提高代码覆盖率

* test: 增加单元测试

Author: ArgoZhang

src/BootstrapBlazor.Server/Components/Pages/Localization.razor

@@ -72,8 +72,6 @@
 
 <p><b>2. @Localizer["N24"]</b></p>
 
-<Tab>
-    <TabItem Text="NET6.0" Icon="fa-solid fa-code" Closable="false">
 <Pre>builder.Services.AddRazorPages();
 builder.Services.AddServerSideBlazor();
 
@@ -97,33 +95,6 @@ if (option != null)
     app.UseRequestLocalization(option.Value);
 }
 </Pre>
-    </TabItem>
-    <TabItem Text="NET5.0" Icon="fa-solid fa-code" Closable="false">
-<Pre class="mb-3">public class Startup
-{
-    public void ConfigureServices(IServiceCollection services)
-    {
-        // @Localizer["N28"]
-        services.AddBootstrapBlazor();
-
-        // @Localizer["N29"]
-        services.AddRequestLocalization&lt;IOptions&lt;BootstrapBlazorOptions&gt;&gt;((localizerOption, blazorOption) =>
-        {
-            var supportedCultures = blazorOption.Value.GetSupportedCultures();
-
-            localizerOption.SupportedCultures = supportedCultures;
-            localizerOption.SupportedUICultures = supportedCultures;
-        });
-    }
-
-    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
-    {
-        // @Localizer["N30"]
-        app.UseRequestLocalization(app.ApplicationServices.GetService&lt;IOptions&lt;RequestLocalizationOptions&gt;&gt;()!.Value);
-    }
-}</Pre>
-    </TabItem>
-</Tab>
 
 <p><b>3. @Localizer["N31"]</b></p>
 <Pre class="mb-3">[Route("[controller]/[action]")]

src/BootstrapBlazor.Server/Components/Samples/Locators.razor.cs

@@ -71,6 +71,11 @@ private async Task OnClick()
         {
             var provider = IpLocatorFactory.Create(ProviderName);
             Location = await provider.Locate(Ip);
+
+            if (!string.IsNullOrEmpty(provider.LastError))
+            {
+                Location = provider.LastError;
+            }
         }
     }
 

src/BootstrapBlazor.Server/Locales/en-US.json

@@ -621,10 +621,7 @@
     "N25": "Add Bootstrap Blazor components",
     "N26": "Add multi-language support configuration information",
     "N27": "Enable localization",
-    "N28": "Add BootstrapBlazor component",
-    "N29": "Add localization service configuration information",
     "N3": "Type key-value information as a resource file, which is parsed as",
-    "N30": "Enable localization middleware and set supported culture info",
     "N31": "Implement UI localization information storage (for example, cookies)",
     "N32": "Add UI that allows users to change localization",
     "N33": "Please select language",

src/BootstrapBlazor.Server/Locales/zh-CN.json

@@ -621,10 +621,7 @@
     "N25": "增加 Bootstrap Blazor 组件",
     "N26": "增加多语言支持配置信息",
     "N27": "启用本地化",
-    "N28": "增加 BootstrapBlazor 组件",
-    "N29": "增加本地化服务配置信息",
     "N3": "类型的键值信息作为资源文件，将其解析为",
-    "N30": "启用本地化中间件并设置支持的文化信息",
     "N31": "实现 UI 本地化信息存储（例如，cookie）",
     "N32": "添加允许用户更改本地化的 UI",
     "N33": "请选择语言",

src/BootstrapBlazor/Services/IPLocator/BaiduIpLocatorProvider.cs

@@ -60,8 +60,25 @@ public class BaiduIpLocatorProvider(IHttpClientFactory httpClientFactory, IOptio
     /// <param name="token"></param>
     protected virtual async Task<string?> Fetch(string url, HttpClient client, CancellationToken token)
     {
-        var result = await client.GetFromJsonAsync<LocationResult>(url, token);
-        return result?.ToString();
+        string? ret = null;
+        try
+        {
+            var result = await client.GetFromJsonAsync<LocationResult>(url, token);
+            if (result is { Status: "0" })
+            {
+                var location = result.Data.FirstOrDefault();
+                if (location != null)
+                {
+                    ret = location.Location;
+                }
+            }
+        }
+        catch (Exception ex)
+        {
+            LastError = ex.Message;
+        }
+
+        return ret;
     }
 
     /// <summary>
@@ -81,22 +98,7 @@ class LocationResult
         /// <para lang="zh">获得/设置 定位信息</para>
         /// <para lang="en">Gets or sets Location Info</para>
         /// </summary>
-        public List<LocationData>? Data { get; set; }
-
-        /// <summary>
-        /// <inheritdoc/>
-        /// <para lang="en"><inheritdoc/></para>
-        /// </summary>
-        /// <returns></returns>
-        public override string? ToString()
-        {
-            string? ret = null;
-            if (Status == "0")
-            {
-                ret = Data?.FirstOrDefault()?.Location;
-            }
-            return ret;
-        }
+        public List<LocationData> Data { get; set; } = [];
     }
 
     [ExcludeFromCodeCoverage]

src/BootstrapBlazor/Services/IPLocator/DefaultIPLocatorProvider.cs

@@ -42,17 +42,23 @@ protected DefaultIpLocatorProvider(IOptions<BootstrapBlazorOptions> options)
     private readonly List<string> _localhostList = [.. new[] { "::1", "127.0.0.1" }];
 
     /// <summary>
-    /// <inheritdoc/>
+    /// <inheritdoc cref="IIpLocatorProvider.Key"/>
     /// </summary>
     public string? Key { get; set; }
 
+    /// <summary>
+    /// <inheritdoc cref="IIpLocatorProvider.LastError"/>
+    /// </summary>
+    public string? LastError { get; protected set; }
+
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
     /// <param name="ip"></param>
     public async Task<string?> Locate(string? ip)
     {
         string? ret = null;
+        LastError = null;
 
         // 解析本机地址
         if (string.IsNullOrEmpty(ip) || _localhostList.Any(p => p == ip))

src/BootstrapBlazor/Services/IPLocator/IIpLocatorProvider.cs

@@ -23,4 +23,10 @@ public interface IIpLocatorProvider
     /// </summary>
     /// <param name="ip"></param>
     Task<string?> Locate(string? ip);
+
+    /// <summary>
+    /// <para lang="zh">获得 上次错误描述信息</para>
+    /// <para lang="en">Get the previous error detail</para>
+    /// </summary>
+    string? LastError { get; }
 }

test/UnitTest/Services/IpLocatorTest.cs

@@ -39,6 +39,7 @@ public async Task BaiduIpLocatorProvider_Ok()
         option.Value.IpLocatorOptions.ProviderName = nameof(BaiduIpLocatorProvider);
         await provider.Locate("223.91.188.112");
         Assert.Equal("美国", result);
+        Assert.Null(provider.LastError);
     }
 
     [Fact]
@@ -85,6 +86,19 @@ public async Task Fetch_Result_Fail()
         Assert.Null(result);
     }
 
+    [Fact]
+    public async Task Fetch_Exception()
+    {
+        var factory = Context.Services.GetRequiredService<IHttpClientFactory>();
+        var option = Context.Services.GetRequiredService<IOptions<BootstrapBlazorOptions>>();
+        option.Value.IpLocatorOptions.EnableCache = false;
+        var logger = Context.Services.GetRequiredService<ILogger<MockErrorProvider>>();
+        var provider = new MockErrorProvider(factory, option, logger);
+        var result = await provider.Locate("223.91.188.112");
+        Assert.Null(result);
+        Assert.NotNull(provider.LastError);
+    }
+
     class MockProviderFetchError(IHttpClientFactory httpClientFactory, IOptions<BootstrapBlazorOptions> option, ILogger<MockProviderFetchError> logger) : BaiduIpLocatorProvider(httpClientFactory, option, logger)
     {
         protected override Task<string?> Fetch(string url, HttpClient client, CancellationToken token) => throw new InvalidOperationException();
@@ -113,57 +127,41 @@ class MockProvider(IHttpClientFactory httpClientFactory, IOptions<BootstrapBlazo
         }
     }
 
-    class MockHttpNullMessageHandler : HttpMessageHandler
+    class MockErrorProvider(IHttpClientFactory httpClientFactory, IOptions<BootstrapBlazorOptions> option, ILogger<MockErrorProvider> logger) : BaiduIpLocatorProvider(httpClientFactory, option, logger)
     {
-        protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
-        {
-            return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK)
-            {
-                Content = new StringContent("null")
-            });
-        }
-    }
-
-    class MockHttpSuccessMessageHandler : HttpMessageHandler
-    {
-        protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+        protected override Task<string?> Fetch(string url, HttpClient client, CancellationToken token)
         {
-            return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK)
-            {
-                Content = new StringContent("{\"status\":\"0\",\"t\":\"\",\"set_cache_time\":\"\",\"data\":[{\"ExtendedLocation\":\"\",\"OriginQuery\":\"20.205.243.166\",\"appinfo\":\"\",\"disp_type\":0,\"fetchkey\":\"20.205.243.166\",\"location\":\"美国\",\"origip\":\"20.205.243.166\",\"origipquery\":\"20.205.243.166\",\"resourceid\":\"6006\",\"role_id\":0,\"shareImage\":1,\"showLikeShare\":1,\"showlamp\":\"1\",\"titlecont\":\"IP地址查询\",\"tplt\":\"ip\"}]}")
-            });
+            client = new HttpClient(new MockHttpExceptionMessageHandler(), true);
+            return base.Fetch(url, client, token);
         }
     }
 
-    class MockHttpSuccessMessageHandlerV2 : HttpMessageHandler
+    class MockHttpExceptionMessageHandler : HttpMessageHandler
     {
         protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
         {
-            return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK)
-            {
-                Content = new StringContent("{\"code\":\"Success\",\"data\": {\"country\": \"中国\", \"prov\":\"省份\", \"city\":\"城市\", \"district\":\"区县\", \"isp\": \"测试\"}}")
-            });
+            throw new Exception("error test");
         }
     }
 
-    class MockHttpSuccessMessageHandlerJuHe : HttpMessageHandler
+    class MockHttpNullMessageHandler : HttpMessageHandler
     {
         protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
         {
             return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK)
             {
-                Content = new StringContent("{\"reason\": \"查询成功\", \"error_code\": 0, \"result\": {\"country\": \"中国\", \"prov\":\"省份\", \"city\":\"城市\", \"district\":\"区县\", \"isp\": \"测试\"}}")
+                Content = new StringContent("null")
             });
         }
     }
 
-    class MockHttpFailedMessageHandlerJuHe : HttpMessageHandler
+    class MockHttpSuccessMessageHandler : HttpMessageHandler
     {
         protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
         {
             return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK)
             {
-                Content = new StringContent("{\"reason\": \"错误的请求KEY\", \"error_code\": 10001, \"result\": null}")
+                Content = new StringContent("{\"status\":\"0\",\"t\":\"\",\"set_cache_time\":\"\",\"data\":[{\"ExtendedLocation\":\"\",\"OriginQuery\":\"20.205.243.166\",\"appinfo\":\"\",\"disp_type\":0,\"fetchkey\":\"20.205.243.166\",\"location\":\"美国\",\"origip\":\"20.205.243.166\",\"origipquery\":\"20.205.243.166\",\"resourceid\":\"6006\",\"role_id\":0,\"shareImage\":1,\"showLikeShare\":1,\"showlamp\":\"1\",\"titlecont\":\"IP地址查询\",\"tplt\":\"ip\"}]}")
             });
         }
     }