Server addresses configuration enhancements

Add PreferHostingUrls to IServerAdressesFeature Add extension to IWebHostBuilder to set this flag
aspnet · Mar 30, 2017 · 4cdc970 · 4cdc970
1 parent f15c99c
commit 4cdc970
Show file tree

Hide file tree

Showing 11 changed files with 299 additions and 190 deletions.
diff --git a/src/Microsoft.AspNetCore.Hosting.Abstractions/HostingAbstractionsWebHostBuilderExtensions.cs b/src/Microsoft.AspNetCore.Hosting.Abstractions/HostingAbstractionsWebHostBuilderExtensions.cs
@@ -145,6 +145,18 @@ public static IWebHostBuilder UseUrls(this IWebHostBuilder hostBuilder, params s
             return hostBuilder.UseSetting(WebHostDefaults.ServerUrlsKey, string.Join(ServerUrlsSeparator, urls));
         }
 
+        /// <summary>
+        /// Indicate whether the host should listen on the URLs configured on the <see cref="IWebHostBuilder"/>
+        /// instead of those configured on the <see cref="IServer"/>.
+        /// </summary>
+        /// <param name="hostBuilder">The <see cref="IWebHostBuilder"/> to configure.</param>
+        /// <param name="preferHostingUrls"><c>true</c> to prefer URLs configured on the <see cref="IWebHostBuilder"/>; otherwise <c>false</c>.</param>
+        /// <returns>The <see cref="IWebHostBuilder"/>.</returns>
+        public static IWebHostBuilder PreferHostingUrls(this IWebHostBuilder hostBuilder, bool preferHostingUrls)
+        {
+            return hostBuilder.UseSetting(WebHostDefaults.PreferHostingUrls, preferHostingUrls ? "true" : "false");
+        }
+
         /// <summary>
         /// Start the web host and listen on the specified urls.
         /// </summary>

diff --git a/src/Microsoft.AspNetCore.Hosting.Abstractions/WebHostDefaults.cs b/src/Microsoft.AspNetCore.Hosting.Abstractions/WebHostDefaults.cs
@@ -15,5 +15,6 @@ public static class WebHostDefaults
         public static readonly string CaptureStartupErrorsKey = "captureStartupErrors";
         public static readonly string ServerUrlsKey = "urls";
         public static readonly string ContentRootKey = "contentRoot";
+        public static readonly string PreferHostingUrls = "preferHostingUrls";
     }
 }
diff --git a/src/Microsoft.AspNetCore.Hosting.Server.Abstractions/Features/IServerAddressesFeature.cs b/src/Microsoft.AspNetCore.Hosting.Server.Abstractions/Features/IServerAddressesFeature.cs
@@ -8,5 +8,7 @@ namespace Microsoft.AspNetCore.Hosting.Server.Features
     public interface IServerAddressesFeature
     {
         ICollection<string> Addresses { get; }
+
+        bool PreferHostingUrls { get; set; }
     }
 }
diff --git a/src/Microsoft.AspNetCore.Hosting.Server.Abstractions/exceptions.net45.json b/src/Microsoft.AspNetCore.Hosting.Server.Abstractions/exceptions.net45.json
@@ -0,0 +1,14 @@
+[
+  {
+    "OldTypeId": "public interface Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature",
+    "NewTypeId": "public interface Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature",
+    "NewMemberId": "System.Boolean get_PreferHostingUrls()",
+    "Kind": "Addition"
+  },
+  {
+    "OldTypeId": "public interface Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature",
+    "NewTypeId": "public interface Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature",
+    "NewMemberId": "System.Void set_PreferHostingUrls(System.Boolean value)",
+    "Kind": "Addition"
+  }
+]
diff --git a/src/Microsoft.AspNetCore.Hosting.Server.Abstractions/exceptions.netcore.json b/src/Microsoft.AspNetCore.Hosting.Server.Abstractions/exceptions.netcore.json
@@ -0,0 +1,14 @@
+[
+  {
+    "OldTypeId": "public interface Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature",
+    "NewTypeId": "public interface Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature",
+    "NewMemberId": "System.Boolean get_PreferHostingUrls()",
+    "Kind": "Addition"
+  },
+  {
+    "OldTypeId": "public interface Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature",
+    "NewTypeId": "public interface Microsoft.AspNetCore.Hosting.Server.Features.IServerAddressesFeature",
+    "NewMemberId": "System.Void set_PreferHostingUrls(System.Boolean value)",
+    "Kind": "Addition"
+  }
+]
diff --git a/src/Microsoft.AspNetCore.Hosting/Internal/HostingEnvironmentExtensions.cs b/src/Microsoft.AspNetCore.Hosting/Internal/HostingEnvironmentExtensions.cs
@@ -60,7 +60,7 @@ public static void Initialize(this IHostingEnvironment hostingEnvironment, strin
             {
                 hostingEnvironment.WebRootFileProvider = new NullFileProvider();
             }
-            
+
             hostingEnvironment.EnvironmentName =
                 options.Environment ??
                 hostingEnvironment.EnvironmentName;

diff --git a/src/Microsoft.AspNetCore.Hosting/Internal/WebHost.cs b/src/Microsoft.AspNetCore.Hosting/Internal/WebHost.cs
@@ -249,12 +249,15 @@ private void EnsureServer()
             {
                 Server = _applicationServices.GetRequiredService<IServer>();
 
-                var addresses = Server.Features?.Get<IServerAddressesFeature>()?.Addresses;
+                var serverAddressesFeature = Server.Features?.Get<IServerAddressesFeature>();
+                var addresses = serverAddressesFeature?.Addresses;
                 if (addresses != null && !addresses.IsReadOnly && addresses.Count == 0)
                 {
                     var urls = _config[WebHostDefaults.ServerUrlsKey] ?? _config[DeprecatedServerUrlsKey];
                     if (!string.IsNullOrEmpty(urls))
                     {
+                        serverAddressesFeature.PreferHostingUrls = _options.PreferHostingUrls;
+
                         foreach (var value in urls.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries))
                         {
                             addresses.Add(value);

diff --git a/src/Microsoft.AspNetCore.Hosting/Internal/WebHostOptions.cs b/src/Microsoft.AspNetCore.Hosting/Internal/WebHostOptions.cs
@@ -9,9 +9,7 @@ namespace Microsoft.AspNetCore.Hosting.Internal
 {
     public class WebHostOptions
     {
-        public WebHostOptions()
-        {
-        }
+        public WebHostOptions() { }
 
         public WebHostOptions(IConfiguration configuration)
         {
@@ -28,6 +26,7 @@ public WebHostOptions(IConfiguration configuration)
             WebRoot = configuration[WebHostDefaults.WebRootKey];
             ContentRootPath = configuration[WebHostDefaults.ContentRootKey];
             HostingStartupAssemblies = configuration[WebHostDefaults.HostingStartupAssembliesKey]?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries) ?? new string[0];
+            PreferHostingUrls = ParseBool(configuration, WebHostDefaults.PreferHostingUrls);
         }
 
         public string ApplicationName { get; set; }
@@ -39,13 +38,15 @@ public WebHostOptions(IConfiguration configuration)
         public bool CaptureStartupErrors { get; set; }
 
         public string Environment { get; set; }
-        
+
         public string StartupAssembly { get; set; }
 
         public string WebRoot { get; set; }
 
         public string ContentRootPath { get; set; }
 
+        public bool PreferHostingUrls { get; set; }
+
         private static bool ParseBool(IConfiguration configuration, string key)
         {
             return string.Equals("true", configuration[key], StringComparison.OrdinalIgnoreCase)

diff --git a/src/Microsoft.AspNetCore.Hosting/Server/Features/ServerAddressesFeature.cs b/src/Microsoft.AspNetCore.Hosting/Server/Features/ServerAddressesFeature.cs
@@ -8,5 +8,7 @@ namespace Microsoft.AspNetCore.Hosting.Server.Features
     public class ServerAddressesFeature : IServerAddressesFeature
     {
         public ICollection<string> Addresses { get; } = new List<string>();
+
+        public bool PreferHostingUrls { get; set; }
     }
 }
diff --git a/test/Microsoft.AspNetCore.Hosting.Tests/WebHostConfigurationsTests.cs b/test/Microsoft.AspNetCore.Hosting.Tests/WebHostConfigurationsTests.cs
@@ -20,7 +20,8 @@ public void ReadsParametersCorrectly()
                 { "startupAssembly", "MyProjectReference" },
                 { "environment", "Development"},
                 { "detailederrors", "true"},
-                { "captureStartupErrors", "true" }
+                { "captureStartupErrors", "true" },
+                { "preferHostingUrls", "true" }
             };
 
             var config = new WebHostOptions(new ConfigurationBuilder().AddInMemoryCollection(parameters).Build());
@@ -31,6 +32,7 @@ public void ReadsParametersCorrectly()
             Assert.Equal("Development", config.Environment);
             Assert.True(config.CaptureStartupErrors);
             Assert.True(config.DetailedErrors);
+            Assert.True(config.PreferHostingUrls);
         }
 
         [Fact]