#267, #273, Move WebSocket APIs to their own object, fix context object.

aspnet · Apr 23, 2015 · 0ed2692 · 0ed2692
1 parent cc1a24b
commit 0ed2692
Show file tree

Hide file tree

Showing 12 changed files with 108 additions and 69 deletions.
diff --git a/src/Microsoft.AspNet.Http.Core/HttpContext.cs b/src/Microsoft.AspNet.Http.Core/HttpContext.cs
@@ -3,10 +3,8 @@
 
 using System;
 using System.Collections.Generic;
-using System.Net.WebSockets;
 using System.Security.Claims;
 using System.Threading;
-using System.Threading.Tasks;
 using Microsoft.AspNet.Http.Authentication;
 
 namespace Microsoft.AspNet.Http
@@ -33,9 +31,7 @@ public abstract class HttpContext : IDisposable
 
         public abstract ISessionCollection Session { get; }
 
-        public abstract bool IsWebSocketRequest { get; }
-
-        public abstract IList<string> WebSocketRequestedProtocols { get; }
+        public abstract WebSocketManager WebSockets { get; }
 
         public abstract void Abort();
 
@@ -54,12 +50,5 @@ public virtual void SetFeature<T>(T instance)
         {
             SetFeature(typeof(T), instance);
         }
-
-        public virtual Task<WebSocket> AcceptWebSocketAsync()
-        {
-            return AcceptWebSocketAsync(subProtocol: null);
-        }
-
-        public abstract Task<WebSocket> AcceptWebSocketAsync(string subProtocol);
     }
 }
diff --git a/src/Microsoft.AspNet.Http.Core/WebSocketManager.cs b/src/Microsoft.AspNet.Http.Core/WebSocketManager.cs
@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Collections.Generic;
+using System.Net.WebSockets;
+using System.Threading.Tasks;
+
+namespace Microsoft.AspNet.Http
+{
+    public abstract class WebSocketManager
+    {
+        public abstract bool IsWebSocketRequest { get; }
+
+        public abstract IList<string> WebSocketRequestedProtocols { get; }
+
+        public virtual Task<WebSocket> AcceptWebSocketAsync()
+        {
+            return AcceptWebSocketAsync(subProtocol: null);
+        }
+
+        public abstract Task<WebSocket> AcceptWebSocketAsync(string subProtocol);
+    }
+}
diff --git a/src/Microsoft.AspNet.Http.Interfaces/IHttpWebSocketFeature.cs b/src/Microsoft.AspNet.Http.Interfaces/IHttpWebSocketFeature.cs
@@ -10,6 +10,6 @@ public interface IHttpWebSocketFeature
     {
         bool IsWebSocketRequest { get; }
 
-        Task<WebSocket> AcceptAsync(IWebSocketAcceptContext context);
+        Task<WebSocket> AcceptAsync(WebSocketAcceptContext context);
     }
 }
diff --git a/src/Microsoft.AspNet.Http.Interfaces/IWebSocketAcceptContext.cs b/src/Microsoft.AspNet.Http.Interfaces/IWebSocketAcceptContext.cs
diff --git a/...oft.AspNet.Http/WebSocketAcceptContext.cs → ...Http.Interfaces/WebSocketAcceptContext.cs b/...oft.AspNet.Http/WebSocketAcceptContext.cs → ...Http.Interfaces/WebSocketAcceptContext.cs
@@ -3,7 +3,7 @@
 
 namespace Microsoft.AspNet.Http
 {
-    public class WebSocketAcceptContext : IWebSocketAcceptContext
+    public class WebSocketAcceptContext
     {
         public virtual string SubProtocol { get; set; }
     }

diff --git a/src/Microsoft.AspNet.Http/DefaultHttpContext.cs b/src/Microsoft.AspNet.Http/DefaultHttpContext.cs
@@ -3,22 +3,17 @@
 
 using System;
 using System.Collections.Generic;
-using System.Net.WebSockets;
 using System.Security.Claims;
 using System.Threading;
-using System.Threading.Tasks;
 using Microsoft.AspNet.FeatureModel;
 using Microsoft.AspNet.Http.Authentication;
 using Microsoft.AspNet.Http.Collections;
 using Microsoft.AspNet.Http.Infrastructure;
-using Microsoft.Net.Http.Headers;
 
 namespace Microsoft.AspNet.Http
 {
     public class DefaultHttpContext : HttpContext
     {
-        private static IList<string> EmptyList = new List<string>();
-
         private readonly HttpRequest _request;
         private readonly HttpResponse _response;
         private readonly ConnectionInfo _connection;
@@ -28,8 +23,8 @@ public class DefaultHttpContext : HttpContext
         private FeatureReference<IServiceProvidersFeature> _serviceProviders;
         private FeatureReference<IHttpAuthenticationFeature> _authentication;
         private FeatureReference<IHttpRequestLifetimeFeature> _lifetime;
-        private FeatureReference<IHttpWebSocketFeature> _webSockets;
         private FeatureReference<ISessionFeature> _session;
+        private WebSocketManager _websockets;
         private IFeatureCollection _features;
 
         public DefaultHttpContext()
@@ -51,7 +46,6 @@ public DefaultHttpContext(IFeatureCollection features)
             _serviceProviders = FeatureReference<IServiceProvidersFeature>.Default;
             _authentication = FeatureReference<IHttpAuthenticationFeature>.Default;
             _lifetime = FeatureReference<IHttpRequestLifetimeFeature>.Default;
-            _webSockets = FeatureReference<IHttpWebSocketFeature>.Default;
             _session = FeatureReference<ISessionFeature>.Default;
         }
 
@@ -75,11 +69,6 @@ private IHttpRequestLifetimeFeature LifetimeFeature
             get { return _lifetime.Fetch(_features); }
         }
 
-        private IHttpWebSocketFeature WebSocketFeature
-        {
-            get { return _webSockets.Fetch(_features); }
-        }
-
         private ISessionFeature SessionFeature
         {
             get { return _session.Fetch(_features); }
@@ -161,20 +150,15 @@ public override ISessionCollection Session
             }
         }
 
-        public override bool IsWebSocketRequest
+        public override WebSocketManager WebSockets
         {
             get
             {
-                var webSocketFeature = WebSocketFeature;
-                return webSocketFeature != null && webSocketFeature.IsWebSocketRequest;
-            }
-        }
-
-        public override IList<string> WebSocketRequestedProtocols
-        {
-            get
-            {
-                return Request.Headers.GetValues(HeaderNames.WebSocketSubProtocols) ?? EmptyList;
+                if (_websockets == null)
+                {
+                    _websockets = new DefaultWebSocketManager(_features);
+                }
+                return _websockets;
             }
         }
 
@@ -203,15 +187,5 @@ public override void SetFeature(Type type, object instance)
         {
             _features[type] = instance;
         }
-
-        public override Task<WebSocket> AcceptWebSocketAsync(string subProtocol)
-        {
-            var webSocketFeature = WebSocketFeature;
-            if (WebSocketFeature == null)
-            {
-                throw new NotSupportedException("WebSockets are not supported");
-            }
-            return WebSocketFeature.AcceptAsync(new WebSocketAcceptContext() { SubProtocol = subProtocol } );
-        }
     }
 }
diff --git a/src/Microsoft.AspNet.Http/DefaultWebSocketManager.cs b/src/Microsoft.AspNet.Http/DefaultWebSocketManager.cs
@@ -0,0 +1,63 @@
+// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using System.Net.WebSockets;
+using System.Threading.Tasks;
+using Microsoft.AspNet.FeatureModel;
+using Microsoft.AspNet.Http.Infrastructure;
+using Microsoft.Net.Http.Headers;
+
+namespace Microsoft.AspNet.Http
+{
+    public class DefaultWebSocketManager : WebSocketManager
+    {
+        private static IList<string> EmptyList = new List<string>();
+
+        private IFeatureCollection _features;
+        private FeatureReference<IHttpRequestFeature> _request = FeatureReference<IHttpRequestFeature>.Default;
+        private FeatureReference<IHttpWebSocketFeature> _webSockets = FeatureReference<IHttpWebSocketFeature>.Default;
+
+        public DefaultWebSocketManager(IFeatureCollection features)
+        {
+            _features = features;
+        }
+
+        private IHttpRequestFeature HttpRequestFeature
+        {
+            get { return _request.Fetch(_features); }
+        }
+
+        private IHttpWebSocketFeature WebSocketFeature
+        {
+            get { return _webSockets.Fetch(_features); }
+        }
+
+        public override bool IsWebSocketRequest
+        {
+            get
+            {
+                return WebSocketFeature != null && WebSocketFeature.IsWebSocketRequest;
+            }
+        }
+
+        public override IList<string> WebSocketRequestedProtocols
+        {
+            get
+            {
+                return ParsingHelpers.GetHeaderUnmodified(HttpRequestFeature.Headers,
+                    HeaderNames.WebSocketSubProtocols) ?? EmptyList;
+            }
+        }
+
+        public override Task<WebSocket> AcceptWebSocketAsync(string subProtocol)
+        {
+            if (WebSocketFeature == null)
+            {
+                throw new NotSupportedException("WebSockets are not supported");
+            }
+            return WebSocketFeature.AcceptAsync(new WebSocketAcceptContext() { SubProtocol = subProtocol });
+        }
+    }
+}
diff --git a/src/Microsoft.AspNet.Owin/OwinEnvironment.cs b/src/Microsoft.AspNet.Owin/OwinEnvironment.cs
@@ -22,7 +22,7 @@ namespace Microsoft.AspNet.Owin
     using WebSocketAcceptAlt =
         Func
         <
-            IWebSocketAcceptContext, // WebSocket Accept parameters
+            WebSocketAcceptContext, // WebSocket Accept parameters
             Task<WebSocket>
         >;
 
@@ -105,7 +105,7 @@ public OwinEnvironment(HttpContext context)
                     feature => new Func<Task>(() => feature.GetClientCertificateAsync(CancellationToken.None))));
             }
 
-            if (context.IsWebSocketRequest)
+            if (context.WebSockets.IsWebSocketRequest)
             {
                 _entries.Add(OwinConstants.WebSocket.AcceptAlt, new FeatureMap<IHttpWebSocketFeature>(feature => new WebSocketAcceptAlt(feature.AcceptAsync)));
             }

diff --git a/src/Microsoft.AspNet.Owin/OwinFeatureCollection.cs b/src/Microsoft.AspNet.Owin/OwinFeatureCollection.cs
@@ -277,14 +277,14 @@ bool IHttpWebSocketFeature.IsWebSocketRequest
             }
         }
 
-        Task<WebSocket> IHttpWebSocketFeature.AcceptAsync(IWebSocketAcceptContext context)
+        Task<WebSocket> IHttpWebSocketFeature.AcceptAsync(WebSocketAcceptContext context)
         {
             object obj;
             if (!Environment.TryGetValue(OwinConstants.WebSocket.AcceptAlt, out obj))
             {
                 throw new NotSupportedException("WebSockets are not supported"); // TODO: LOC
             }
-            var accept = (Func<IWebSocketAcceptContext, Task<WebSocket>>)obj;
+            var accept = (Func<WebSocketAcceptContext, Task<WebSocket>>)obj;
             return accept(context);
         }
 

diff --git a/src/Microsoft.AspNet.Owin/WebSockets/OwinWebSocketAcceptAdapter.cs b/src/Microsoft.AspNet.Owin/WebSockets/OwinWebSocketAcceptAdapter.cs
@@ -23,7 +23,7 @@ namespace Microsoft.AspNet.Owin
     using WebSocketAcceptAlt =
         Func
         <
-            IWebSocketAcceptContext, // WebSocket Accept parameters
+            WebSocketAcceptContext, // WebSocket Accept parameters
             Task<WebSocket>
         >;
 
@@ -48,7 +48,7 @@ private OwinWebSocketAcceptAdapter(WebSocketAccept owinWebSocketAccept)
         private Task UpstreamTask { get; set; }
         private TaskCompletionSource<int> UpstreamWentAsyncTcs { get { return _upstreamWentAsync; } }
 
-        private async Task<WebSocket> AcceptWebSocketAsync(IWebSocketAcceptContext context)
+        private async Task<WebSocket> AcceptWebSocketAsync(WebSocketAcceptContext context)
         {
             IDictionary<string, object> options = null;
             if (context is OwinWebSocketAcceptContext)

diff --git a/src/Microsoft.AspNet.Owin/WebSockets/OwinWebSocketAcceptContext.cs b/src/Microsoft.AspNet.Owin/WebSockets/OwinWebSocketAcceptContext.cs
@@ -6,7 +6,7 @@
 
 namespace Microsoft.AspNet.Owin
 {
-    public class OwinWebSocketAcceptContext : IWebSocketAcceptContext
+    public class OwinWebSocketAcceptContext : WebSocketAcceptContext
     {
         private IDictionary<string, object> _options;
 
@@ -19,7 +19,7 @@ public OwinWebSocketAcceptContext(IDictionary<string, object> options)
             _options = options;
         }
 
-        public string SubProtocol
+        public override string SubProtocol
         {
             get
             {

diff --git a/src/Microsoft.AspNet.Owin/WebSockets/WebSocketAcceptAdapter.cs b/src/Microsoft.AspNet.Owin/WebSockets/WebSocketAcceptAdapter.cs
@@ -24,7 +24,7 @@ namespace Microsoft.AspNet.Owin
     using WebSocketAcceptAlt =
         Func
         <
-            IWebSocketAcceptContext, // WebSocket Accept parameters
+            WebSocketAcceptContext, // WebSocket Accept parameters
             Task<WebSocket>
         >;
 
@@ -65,11 +65,11 @@ public static AppFunc AdaptWebSockets(AppFunc next)
                     await next(environment);
                     if ((int)environment[OwinConstants.ResponseStatusCode] == 101 && adapter._callback != null)
                     {
-                        IWebSocketAcceptContext acceptContext = null;
+                        WebSocketAcceptContext acceptContext = null;
                         object obj;
-                        if (adapter._options != null && adapter._options.TryGetValue(typeof(IWebSocketAcceptContext).FullName, out obj))
+                        if (adapter._options != null && adapter._options.TryGetValue(typeof(WebSocketAcceptContext).FullName, out obj))
                         {
-                            acceptContext = obj as IWebSocketAcceptContext;
+                            acceptContext = obj as WebSocketAcceptContext;
                         }
                         else if (adapter._options != null)
                         {