Enable initial browser capabilities (#70)

twsouthwick · web-flow · commit 09bb0cf8ca92 · 2022-06-30T11:02:41.000-07:00
This implements just the built in capabilities and does not provide an ability at the moment of augmenting with one's own patterns. Derived from the pattern in System.Web with a few modifications for perf reasons and new APIs available.
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/Adapters/SystemWebAdaptersExtensions.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/Adapters/SystemWebAdaptersExtensions.cs
@@ -7,6 +7,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Web;
 using System.Web.Caching;
+using System.Web.Configuration;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http.Features;
 using Microsoft.AspNetCore.SystemWebAdapters.Internal;
@@ -20,6 +21,7 @@ public static ISystemWebAdapterBuilder AddSystemWebAdapters(this IServiceCollect
         {
             services.AddHttpContextAccessor();
             services.AddSingleton<Cache>();
+            services.AddSingleton<BrowserCapabilitiesFactory>();
 
             return new Builder(services);
         }
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/Configuration/BrowserCapabilitiesFactory.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/Configuration/BrowserCapabilitiesFactory.cs
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/Configuration/HttpCapabilitiesBase.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/Configuration/HttpCapabilitiesBase.cs
@@ -0,0 +1,26 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace System.Web.Configuration;
+
+public class HttpCapabilitiesBase
+{
+    private readonly ParsedBrowserResult _data;
+
+    private protected HttpCapabilitiesBase(BrowserCapabilitiesFactory factory, string userAgent)
+    {
+        _data = factory.Process(userAgent);
+    }
+
+    public string? Browser => _data["browser"];
+
+    public string? Version => _data["version"];
+
+    public int MajorVersion => _data.GetInt("majorversion");
+
+    public double MinorVersion => _data.GetDouble("minorversion");
+
+    public string? Platform => _data["platform"];
+
+    public bool Crawler => _data.GetBoolean("crawler");
+}
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/Configuration/ParsedBrowserResult.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/Configuration/ParsedBrowserResult.cs
@@ -0,0 +1,62 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Globalization;
+
+namespace System.Web.Configuration;
+
+internal class ParsedBrowserResult
+{
+    private readonly Dictionary<string, string?> _data = new(StringComparer.OrdinalIgnoreCase);
+
+    [Conditional("NotNeededYet")]
+    [Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "Retained in case we need the data later")]
+    public void AddBrowser(string browser)
+    {
+    }
+
+    public string? this[string key]
+    {
+        get => _data.TryGetValue(key, out var value) ? value : null;
+        set => _data[key] = value;
+    }
+
+    public int GetInt(string key) => int.TryParse(this[key], NumberStyles.Integer, CultureInfo.InvariantCulture, out var result) ? result : throw new HttpUnhandledException($"Invalid string from browser capabilities '{key}'");
+
+    public bool GetBoolean(string key) => bool.TryParse(this[key], out var result) && result;
+
+    public double GetDouble(string key)
+    {
+        const NumberStyles Style = NumberStyles.Float | NumberStyles.AllowDecimalPoint;
+
+        var value = this[key];
+
+        if (value is not null)
+        {
+            if (double.TryParse(value, Style, CultureInfo.InvariantCulture, out var result))
+            {
+                return result;
+            }
+
+            // Handle if there's more than one decimal i.e. .4.1 -> .4
+            var firstDecimal = value.IndexOf('.', StringComparison.Ordinal);
+
+            if (firstDecimal != -1)
+            {
+                var nextDecimal = value.IndexOf('.', firstDecimal + 1);
+
+                if (nextDecimal != -1)
+                {
+                    if (double.TryParse(value.AsSpan()[..nextDecimal], Style, CultureInfo.InvariantCulture, out var result2))
+                    {
+                        return result2;
+                    }
+                }
+            }
+        }
+
+        throw new HttpUnhandledException($"Invalid string from browser capabilities '{key}'");
+    }
+}
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/ExcludedApis.txt b/src/Microsoft.AspNetCore.SystemWebAdapters/ExcludedApis.txt
@@ -45,7 +45,7 @@ M:System.Web.Caching.Cache.#ctor(Microsoft.AspNetCore.Http.HttpContext)
 
 M:System.Web.Caching.Cache.#ctor(Microsoft.Extensions.Caching.Memory.IMemoryCache)
 
-# Remote app
+# Authentication
 T:Microsoft.AspNetCore.SystemWebAdapters.RemoteAppAuthenticationExtensions
 T:Microsoft.AspNetCore.SystemWebAdapters.RemoteServiceOptions
 T:Microsoft.AspNetCore.SystemWebAdapters.Authentication.IRemoteAppAuthenticationResultProcessor
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/HttpBrowserCapabilities.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/HttpBrowserCapabilities.cs
@@ -1,9 +1,15 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-namespace System.Web
+using System.Web.Configuration;
+
+namespace System.Web;
+
+public class HttpBrowserCapabilities : HttpCapabilitiesBase
 {
-    public class HttpBrowserCapabilities
+    internal HttpBrowserCapabilities(BrowserCapabilitiesFactory factory, string userAgent)
+        : base(factory, userAgent)
     {
+
     }
 }
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/HttpBrowserCapabilitiesBase.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/HttpBrowserCapabilitiesBase.cs
@@ -0,0 +1,20 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace System.Web;
+
+[Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1065:Do not raise exceptions in unexpected locations", Justification = Constants.ApiFromAspNet)]
+public class HttpBrowserCapabilitiesBase
+{
+    public virtual string? Browser => throw new NotImplementedException();
+
+    public virtual string? Version => throw new NotImplementedException();
+
+    public virtual int MajorVersion => throw new NotImplementedException();
+
+    public virtual double MinorVersion => throw new NotImplementedException();
+
+    public virtual string? Platform => throw new NotImplementedException();
+
+    public virtual bool Crawler => throw new NotImplementedException();
+}
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/HttpBrowserCapabilitiesWrapper.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/HttpBrowserCapabilitiesWrapper.cs
@@ -0,0 +1,26 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace System.Web;
+
+public class HttpBrowserCapabilitiesWrapper : HttpBrowserCapabilitiesBase
+{
+    private readonly HttpBrowserCapabilities _capabilities;
+
+    public HttpBrowserCapabilitiesWrapper(HttpBrowserCapabilities capabilities)
+    {
+        _capabilities = capabilities;
+    }
+
+    public override string? Browser => _capabilities.Browser;
+
+    public override int MajorVersion => _capabilities.MajorVersion;
+
+    public override double MinorVersion => _capabilities.MinorVersion;
+
+    public override string? Platform => _capabilities.Platform;
+
+    public override string? Version => _capabilities.Version;
+
+    public override bool Crawler => _capabilities.Crawler;
+}
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/HttpException.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/HttpException.cs
@@ -0,0 +1,20 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace System.Web;
+
+public class HttpException : SystemException
+{
+    public HttpException()
+    {
+    }
+
+    public HttpException(string message) : base(message)
+    {
+    }
+
+    public HttpException(string message, Exception innerException)
+        : base(message, innerException)
+    {
+    }
+}
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/HttpRequest.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/HttpRequest.cs
@@ -9,11 +9,13 @@
 using System.Net;
 using System.Security.Principal;
 using System.Text;
+using System.Web.Configuration;
 using Microsoft.AspNetCore.Http.Extensions;
 using Microsoft.AspNetCore.Http.Features;
 using Microsoft.AspNetCore.Http.Headers;
 using Microsoft.AspNetCore.SystemWebAdapters;
 using Microsoft.AspNetCore.SystemWebAdapters.Internal;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Net.Http.Headers;
 
 namespace System.Web
@@ -114,14 +116,7 @@ public NameValueCollection ServerVariables
             {
                 if (_serverVariables is null)
                 {
-                    if (_request.HttpContext.Features.Get<IServerVariablesFeature>() is IServerVariablesFeature feature)
-                    {
-                        _serverVariables = feature.ToNameValueCollection();
-                    }
-                    else
-                    {
-                        throw new PlatformNotSupportedException("IServerVariablesFeature is not available.");
-                    }
+                    _serverVariables = _request.HttpContext.Features.GetRequired<IServerVariablesFeature>().ToNameValueCollection();
                 }
 
                 return _serverVariables;
@@ -170,7 +165,25 @@ public bool IsLocal
 
         public string? UserHostName => _request.HttpContext.Connection.RemoteIpAddress?.ToString();
 
-        public HttpBrowserCapabilities Browser => _browser ??= new();
+        public HttpBrowserCapabilities Browser
+        {
+            get
+            {
+                if (_browser is null)
+                {
+                    var factory = _request.HttpContext.RequestServices.GetService<BrowserCapabilitiesFactory>();
+
+                    if (factory is null)
+                    {
+                        throw new InvalidOperationException("Browser capabilities requires AddSystemWebAdapters() to be called on service collection");
+                    }
+
+                    _browser = new(factory, _request.Headers.UserAgent);
+                }
+
+                return _browser;
+            }
+        }
 
         public byte[] BinaryRead(int count)
         {
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/HttpRequestBase.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/HttpRequestBase.cs
@@ -67,7 +67,7 @@ public virtual string? ContentType
 
         public virtual string? UserHostName => throw new NotImplementedException();
 
-        public HttpBrowserCapabilities Browser => throw new NotImplementedException();
+        public virtual HttpBrowserCapabilitiesBase Browser => throw new NotImplementedException();
 
         public virtual byte[] BinaryRead(int count) => throw new NotImplementedException();
 
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/HttpRequestWrapper.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/HttpRequestWrapper.cs
@@ -49,6 +49,8 @@ public override string? ContentType
 
         public override NameValueCollection QueryString => _request.QueryString;
 
+        public override HttpBrowserCapabilitiesBase Browser => new HttpBrowserCapabilitiesWrapper(_request.Browser);
+
         public override string? RawUrl => _request.RawUrl;
 
         public override string RequestType => _request.RequestType;
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/HttpUnhandledException.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/HttpUnhandledException.cs
@@ -0,0 +1,19 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace System.Web;
+
+public sealed class HttpUnhandledException : HttpException
+{
+    public HttpUnhandledException(string message) : base(message)
+    {
+    }
+
+    public HttpUnhandledException(string message, Exception innerException) : base(message, innerException)
+    {
+    }
+
+    public HttpUnhandledException()
+    {
+    }
+}
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/Ref.Standard.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/Ref.Standard.cs
@@ -15,9 +15,29 @@
 
 namespace System.Web
 {
-    public partial class HttpBrowserCapabilities
+    public partial class HttpBrowserCapabilities : System.Web.Configuration.HttpCapabilitiesBase
     {
-        public HttpBrowserCapabilities() { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+        internal HttpBrowserCapabilities() { }
+    }
+    public partial class HttpBrowserCapabilitiesBase
+    {
+        public HttpBrowserCapabilitiesBase() { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+        public virtual string Browser { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public virtual bool Crawler { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public virtual int MajorVersion { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public virtual double MinorVersion { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public virtual string Platform { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public virtual string Version { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+    }
+    public partial class HttpBrowserCapabilitiesWrapper : System.Web.HttpBrowserCapabilitiesBase
+    {
+        public HttpBrowserCapabilitiesWrapper(System.Web.HttpBrowserCapabilities capabilities) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+        public override string Browser { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public override bool Crawler { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public override int MajorVersion { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public override double MinorVersion { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public override string Platform { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public override string Version { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
     }
     public partial class HttpContext : System.IServiceProvider
     {
@@ -83,6 +103,12 @@ public sealed partial class HttpCookieCollection : System.Collections.Specialize
         public void Remove(string name) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
         public void Set(System.Web.HttpCookie cookie) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
     }
+    public partial class HttpException : System.SystemException
+    {
+        public HttpException() { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+        public HttpException(string message) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+        public HttpException(string message, System.Exception innerException) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+    }
     public partial class HttpRequest
     {
         internal HttpRequest() { }
@@ -121,7 +147,7 @@ public abstract partial class HttpRequestBase
         protected HttpRequestBase() { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
         public string ApplicationPath { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
         public string AppRelativeCurrentExecutionFilePath { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
-        public System.Web.HttpBrowserCapabilities Browser { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public virtual System.Web.HttpBrowserCapabilitiesBase Browser { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
         public virtual System.Text.Encoding ContentEncoding { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
         public virtual int ContentLength { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
         public virtual string ContentType { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} set { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
@@ -151,6 +177,7 @@ public abstract partial class HttpRequestBase
     public partial class HttpRequestWrapper : System.Web.HttpRequestBase
     {
         public HttpRequestWrapper(System.Web.HttpRequest request) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+        public override System.Web.HttpBrowserCapabilitiesBase Browser { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
         public override System.Text.Encoding ContentEncoding { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
         public override int ContentLength { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
         public override string ContentType { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} set { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
@@ -313,6 +340,12 @@ public partial class HttpSessionStateWrapper : System.Web.HttpSessionStateBase
         public override void Remove(string name) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
         public override void RemoveAll() { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
     }
+    public sealed partial class HttpUnhandledException : System.Web.HttpException
+    {
+        public HttpUnhandledException() { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+        public HttpUnhandledException(string message) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+        public HttpUnhandledException(string message, System.Exception innerException) { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");}
+    }
     public enum SameSiteMode
     {
         Lax = 1,
@@ -367,6 +400,19 @@ public enum CacheItemUpdateReason
         Expired = 1,
     }
 }
+namespace System.Web.Configuration
+{
+    public partial class HttpCapabilitiesBase
+    {
+        internal HttpCapabilitiesBase() { }
+        public string Browser { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public bool Crawler { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public int MajorVersion { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public double MinorVersion { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public string Platform { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+        public string Version { get { throw new System.PlatformNotSupportedException("Only support when running on ASP.NET Core or System.Web");} }
+    }
+}
 namespace System.Web.SessionState
 {
     public partial class HttpSessionState : System.Collections.ICollection, System.Collections.IEnumerable
diff --git a/src/Microsoft.AspNetCore.SystemWebAdapters/TypeForwards.Framework.cs b/src/Microsoft.AspNetCore.SystemWebAdapters/TypeForwards.Framework.cs
diff --git a/test/Microsoft.AspNetCore.SystemWebAdapters.Tests/Configuration/BrowserCapabilitiesFactoryTests.cs b/test/Microsoft.AspNetCore.SystemWebAdapters.Tests/Configuration/BrowserCapabilitiesFactoryTests.cs
diff --git a/test/Microsoft.AspNetCore.SystemWebAdapters.Tests/HttpRequestTests.cs b/test/Microsoft.AspNetCore.SystemWebAdapters.Tests/HttpRequestTests.cs

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`using System.Diagnostics.CodeAnalysis;`
`8`	`8`	`using System.Web;`
`9`	`9`	`using System.Web.Caching;`
	`10`	`+using System.Web.Configuration;`
`10`	`11`	`using Microsoft.AspNetCore.Builder;`
`11`	`12`	`using Microsoft.AspNetCore.Http.Features;`
`12`	`13`	`using Microsoft.AspNetCore.SystemWebAdapters.Internal;`
`@@ -20,6 +21,7 @@ public static ISystemWebAdapterBuilder AddSystemWebAdapters(this IServiceCollect`
`20`	`21`	`{`
`21`	`22`	`services.AddHttpContextAccessor();`
`22`	`23`	`services.AddSingleton<Cache>();`
	`24`	`+ services.AddSingleton<BrowserCapabilitiesFactory>();`
`23`	`25`
`24`	`26`	`return new Builder(services);`
`25`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,15 @@`
`1`	`1`	`// Licensed to the .NET Foundation under one or more agreements.`
`2`	`2`	`// The .NET Foundation licenses this file to you under the MIT license.`
`3`	`3`
`4`		`-namespace System.Web`
	`4`	`+using System.Web.Configuration;`
	`5`	`+`
	`6`	`+namespace System.Web;`
	`7`	`+`
	`8`	`+public class HttpBrowserCapabilities : HttpCapabilitiesBase`
`5`	`9`	`{`
`6`		`- public class HttpBrowserCapabilities`
	`10`	`+ internal HttpBrowserCapabilities(BrowserCapabilitiesFactory factory, string userAgent)`
	`11`	`+ : base(factory, userAgent)`
`7`	`12`	`{`
	`13`	`+`
`8`	`14`	`}`
`9`	`15`	`}`