Merge pull request #11 from webexpress-framework/copilot/update-readme-documentation

ReneSchwarzer · web-flow · commit a7d5c727843e · 2026-04-02T23:03:37.000+02:00
Fix PR #10 review comments: null safety, interface visibility, cookie parsing, WebSocket headers, typos
diff --git a/src/WebExpress.WebCore.Test/Html/UnitTestRandomId.cs b/src/WebExpress.WebCore.Test/Html/UnitTestRandomId.cs
@@ -59,7 +59,7 @@ public void HexCharacters()
             var id = RandomId.Create();
 
             // validation
-            var hex = id.Substring(4);
+            var hex = id.Substring("id_".Length);
             Assert.Matches("^[0-9A-F]+$", hex);
         }
 
diff --git a/src/WebExpress.WebCore.Test/Manager/UnitTestStatusPageManager.cs b/src/WebExpress.WebCore.Test/Manager/UnitTestStatusPageManager.cs
@@ -165,8 +165,8 @@ public void CreateAndCheckCode(Type applicationType, int statusCode, int? expect
         /// Test the CreateStatusResponse function of the status page.
         /// </summary>
         [Theory]
-        [InlineData(typeof(TestApplicationA), 400, "content", "content", 78)]
-        [InlineData(typeof(TestApplicationA), 500, "content", "content", 78)]
+        [InlineData(typeof(TestApplicationA), 400, "content", "content", 72)]
+        [InlineData(typeof(TestApplicationA), 500, "content", "content", 72)]
         public void CreateAndCheckMessage(Type applicationType, int statusCode, string content, string expected, int length)
         {
             // arrange
diff --git a/src/WebExpress.WebCore/WebAttribute/SegmentRegexAttribute.cs b/src/WebExpress.WebCore/WebAttribute/SegmentRegexAttribute.cs
@@ -20,19 +20,19 @@ public class SegmentRegexAttribute<TParameter> : Attribute, IEndpointAttribute,
         private string Expression { get; set; }
 
         /// <summary>
-        /// Returns or sets the display string.
+        /// Returns or sets the tag.
         /// </summary>
-        private string Display { get; set; }
+        private string Tag { get; set; }
 
         /// <summary>
         /// Initializes a new instance of the class.
         /// </summary>
         /// <param name="expression">The regular expression.</param>
-        /// <param name="display">The display string.</param>
-        public SegmentRegexAttribute(string expression, string display = null)
+        /// <param name="tag">The tag.</param>
+        public SegmentRegexAttribute(string expression, string tag = null)
         {
             Expression = expression;
-            Display = display;
+            Tag = tag;
         }
 
         /// <summary>
@@ -41,7 +41,7 @@ public SegmentRegexAttribute(string expression, string display = null)
         /// <returns>The path segment.</returns>
         public IUriPathSegment ToPathSegment()
         {
-            return new UriPathSegmentVariableRegex<TParameter>(Expression, Display);
+            return new UriPathSegmentVariableRegex<TParameter>(Expression, Tag);
         }
     }
 }
diff --git a/src/WebExpress.WebCore/WebAttribute/SegmentStringAttribute.cs b/src/WebExpress.WebCore/WebAttribute/SegmentStringAttribute.cs
@@ -15,17 +15,17 @@ public class SegmentStringAttribute<TParameter> : Attribute, IEndpointAttribute,
         where TParameter : IParameterStatic, new()
     {
         /// <summary>
-        /// Returns or sets the display string.
+        /// Returns or sets the tag.
         /// </summary>
-        private string Display { get; set; }
+        private string Tag { get; set; }
 
         /// <summary>
         /// Initializes a new instance of the class.
         /// </summary>
-        /// <param name="display">The display string.</param>
-        public SegmentStringAttribute(string display = null)
+        /// <param name="tag">The tag.</param>
+        public SegmentStringAttribute(string tag = null)
         {
-            Display = display;
+            Tag = tag;
         }
 
         /// <summary>
@@ -34,7 +34,7 @@ public SegmentStringAttribute(string display = null)
         /// <returns>The path segment.</returns>
         public IUriPathSegment ToPathSegment()
         {
-            return new UriPathSegmentVariableString<TParameter>(Display);
+            return new UriPathSegmentVariableString<TParameter>(Tag);
         }
     }
 }
diff --git a/src/WebExpress.WebCore/WebAttribute/SegmentUIntAttribute.cs b/src/WebExpress.WebCore/WebAttribute/SegmentUIntAttribute.cs
@@ -18,17 +18,17 @@ public class SegmentUIntAttribute<TParameter> : Attribute, IEndpointAttribute, I
         where TParameter : IParameterStatic, new()
     {
         /// <summary>
-        /// Returns or sets the display string.
+        /// Returns or sets the tag.
         /// </summary>
-        private string Display { get; set; }
+        private string Tag { get; set; }
 
         /// <summary>
         /// Initializes a new instance of the class.
         /// </summary>
-        /// <param name="display">The display string.</param>
-        public SegmentUIntAttribute(string display = null)
+        /// <param name="tag">The tag.</param>
+        public SegmentUIntAttribute(string tag = null)
         {
-            Display = display;
+            Tag = tag;
         }
 
         /// <summary>
@@ -37,7 +37,7 @@ public SegmentUIntAttribute(string display = null)
         /// <returns>The path segment.</returns>
         public IUriPathSegment ToPathSegment()
         {
-            return new UriPathSegmentVariableUInt<TParameter>(Display);
+            return new UriPathSegmentVariableUInt<TParameter>(Tag);
         }
     }
 }
diff --git a/src/WebExpress.WebCore/WebMessage/RequestHeaderFields.cs b/src/WebExpress.WebCore/WebMessage/RequestHeaderFields.cs
@@ -124,11 +124,14 @@ internal RequestHeaderFields(IFeatureCollection contextFeatures)
             SecWebSocketVersion = requestFeature.Headers.SecWebSocketVersion;
             
             Cookies = requestFeature.Headers.Cookie
+                .SelectMany(c => c.Split(';', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries))
                 .Select(c =>
                 {
-                    var split = c.Split('=');
-                    return new Cookie(split[0], split[1]);
-                });
+                    var eqIndex = c.IndexOf('=');
+                    if (eqIndex < 0) { return null; }
+                    return new Cookie(c[..eqIndex].Trim(), c[(eqIndex + 1)..].Trim());
+                })
+                .Where(c => c != null);
 
             Authorization = RequestAuthorization.Parse(requestFeature.Headers.Authorization);
         }
diff --git a/src/WebExpress.WebCore/WebMessage/ResponseHeaderFields.cs b/src/WebExpress.WebCore/WebMessage/ResponseHeaderFields.cs
@@ -142,6 +142,11 @@ public override string ToString()
                 sb.AppendLine("Connection: Upgrade");
             }
 
+            if (!string.IsNullOrWhiteSpace(SecWebSocketAccept))
+            {
+                sb.AppendLine("Sec-WebSocket-Accept: " + SecWebSocketAccept);
+            }
+
             foreach (var c in CustomHeader)
             {
                 sb.AppendLine(c.Key + ": " + c.Value);
diff --git a/src/WebExpress.WebCore/WebSocket/ISocket.cs b/src/WebExpress.WebCore/WebSocket/ISocket.cs
@@ -11,8 +11,6 @@ public interface ISocket : IEndpoint, IDisposable
     {
         /// <summary>
         /// Invoked after the websocket handshake has been accepted.
-        /// Implementers may use the optional cancellation token to abort long-running startup tasks.
-        /// the optional connectMessage provides initial metadata from the client (may be null).
         /// </summary>
         /// <param name="socketConnection">The socket connection.</param>
         /// <returns>An asynchronous task.</returns>
diff --git a/src/WebExpress.WebCore/WebSocket/ISocketContext.cs b/src/WebExpress.WebCore/WebSocket/ISocketContext.cs
@@ -25,7 +25,7 @@ public interface ISocketContext : IEndpointContext
         /// Returns the maximum allowed message size in bytes, or null when the endpoint imposes no limit.
         /// servers and hosts may use this to protect against excessively large frames.
         /// </summary>
-        ulong MaxMessageSize { get; }
+        ulong? MaxMessageSize { get; }
 
         /// <summary>
         /// Indicates whether this websocket endpoint requires an authenticated client.
diff --git a/src/WebExpress.WebCore/WebSocket/Model/SocketItem.cs b/src/WebExpress.WebCore/WebSocket/Model/SocketItem.cs
@@ -50,7 +50,7 @@ internal class SocketItem : IDisposable
         /// Returns the maximum allowed message size in bytes, or null when the endpoint imposes no limit.
         /// servers and hosts may use this to protect against excessively large frames.
         /// </summary>
-        public ulong MaxMessageSize { get; set; }
+        public ulong? MaxMessageSize { get; set; }
 
         /// <summary>
         /// Returns the conditions that must be met for the resource to be active.
diff --git a/src/WebExpress.WebCore/WebSocket/SocketContext.cs b/src/WebExpress.WebCore/WebSocket/SocketContext.cs
@@ -50,7 +50,7 @@ public class SocketContext : ISocketContext
         /// <summary>
         /// Maximum allowed message size in bytes, or null when no limit is imposed.
         /// </summary>
-        public ulong MaxMessageSize { get; set; }
+        public ulong? MaxMessageSize { get; set; }
 
         /// <summary>
         /// Indicates whether this websocket endpoint requires an authenticated client.
diff --git a/src/WebExpress.WebCore/WebSocket/SocketManager.cs b/src/WebExpress.WebCore/WebSocket/SocketManager.cs
@@ -308,7 +308,7 @@ private void Register(IPluginContext pluginContext, IEnumerable<IApplicationCont
                 var cache = false;
                 var subProtocol = "";
                 var messageType = SocketMessageType.Text;
-                var maxMessageSize = ulong.MinValue;
+                var maxMessageSize = (ulong?)null;
                 var attributes = socketType.CustomAttributes
                     .Where(x => !x.AttributeType.GetInterfaces().Contains(typeof(IEndpointAttribute)));
 
@@ -376,7 +376,7 @@ var attribute in socketType
                     // MAX MESSAGE SIZE
                     if (attributeType == typeof(MaxMessageSizeAttribute))
                     {
-                        maxMessageSize = (attribute as MaxMessageSizeAttribute)?.MaxMessageSize ?? 0;
+                        maxMessageSize = (attribute as MaxMessageSizeAttribute)?.MaxMessageSize;
                         continue;
                     }
                 }
diff --git a/src/WebExpress.WebCore/WebTask/TaskManager.cs b/src/WebExpress.WebCore/WebTask/TaskManager.cs
@@ -78,7 +78,7 @@ public ITask CreateTask(string id, params object[] args)
         {
             var key = id?.ToLower();
 
-            if (_dictionary.TryGetValue(id, out var value))
+            if (_dictionary.TryGetValue(key, out var value))
             {
                 return value;
             }
@@ -118,7 +118,7 @@ public ITask CreateTask<TTask>(string id, EventHandler<TaskEventArgs> handler, p
         {
             var key = id?.ToLower();
 
-            if (_dictionary.TryGetValue(id, out var value))
+            if (_dictionary.TryGetValue(key, out var value))
             {
                 return value;
             }
@@ -141,7 +141,12 @@ public ITask CreateTask<TTask>(string id, EventHandler<TaskEventArgs> handler, p
         /// <param name="task">The task.</param>
         public void RemoveTask(ITask task)
         {
-            var key = task?.Id.ToLower();
+            if (task?.Id is null)
+            {
+                return;
+            }
+
+            var key = task.Id.ToLower();
 
             if (_dictionary.TryGetValue(key, out var storedTask) && storedTask is Task t)
             {
diff --git a/src/WebExpress.WebCore/WebUri/IUriPathSegment.cs b/src/WebExpress.WebCore/WebUri/IUriPathSegment.cs
@@ -8,7 +8,7 @@ public interface IUriPathSegment
         /// <summary>
         /// Returns or sets the id.
         /// </summary>
-        internal string Id { get; }
+        string Id { get; }
 
         /// <summary>
         /// Returns the value.
@@ -32,12 +32,12 @@ public interface IUriPathSegment
         /// This property can be used to determine if the item should be displayed in user
         /// interfaces or lists.
         /// </remarks>
-        bool IsHidden { get; internal set; }
+        bool IsHidden { get; set; }
 
         /// <summary>
         /// Returns the URI to which the user is redirected.
         /// </summary>
-        IUri Uri { get; internal set; }
+        IUri Uri { get; set; }
 
         /// <summary>
         /// Checks whether the node matches the path element.
diff --git a/src/WebExpress.WebCore/WebUri/UriQuery.cs b/src/WebExpress.WebCore/WebUri/UriQuery.cs
@@ -41,12 +41,12 @@ public override string ToString()
     /// <summary>
     /// Represents a key-value pair used as a query parameter in a URI.
     /// </summary>
-    /// <typeparam name="TParamerer">
+    /// <typeparam name="TParameter">
     /// The type that implements the IParameterStatic interface and defines the structure 
     /// of the query parameter.
     /// </typeparam>
-    public class UriQuery<TParamerer> : IUriQuery
-        where TParamerer : IParameterStatic
+    public class UriQuery<TParameter> : IUriQuery
+        where TParameter : IParameterStatic
     {
         /// <summary>
         /// Returns the key.
@@ -64,7 +64,7 @@ public class UriQuery<TParamerer> : IUriQuery
         /// <param name="value">The value.</param>
         public UriQuery(string value = null)
         {
-            Key = TParamerer.Key;
+            Key = TParameter.Key;
             Value = value;
         }
 

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public void HexCharacters()`
`59`	`59`	`var id = RandomId.Create();`
`60`	`60`
`61`	`61`	`// validation`
`62`		`- var hex = id.Substring(4);`
	`62`	`+ var hex = id.Substring("id_".Length);`
`63`	`63`	`Assert.Matches("^[0-9A-F]+$", hex);`
`64`	`64`	`}`
`65`	`65`
Original file line number	Diff line number	Diff line change
`@@ -20,19 +20,19 @@ public class SegmentRegexAttribute<TParameter> : Attribute, IEndpointAttribute,`
`20`	`20`	`private string Expression { get; set; }`
`21`	`21`
`22`	`22`	`/// <summary>`
`23`		`- /// Returns or sets the display string.`
	`23`	`+ /// Returns or sets the tag.`
`24`	`24`	`/// </summary>`
`25`		`- private string Display { get; set; }`
	`25`	`+ private string Tag { get; set; }`
`26`	`26`
`27`	`27`	`/// <summary>`
`28`	`28`	`/// Initializes a new instance of the class.`
`29`	`29`	`/// </summary>`
`30`	`30`	`/// <param name="expression">The regular expression.</param>`
`31`		`- /// <param name="display">The display string.</param>`
`32`		`- public SegmentRegexAttribute(string expression, string display = null)`
	`31`	`+ /// <param name="tag">The tag.</param>`
	`32`	`+ public SegmentRegexAttribute(string expression, string tag = null)`
`33`	`33`	`{`
`34`	`34`	`Expression = expression;`
`35`		`- Display = display;`
	`35`	`+ Tag = tag;`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`/// <summary>`
`@@ -41,7 +41,7 @@ public SegmentRegexAttribute(string expression, string display = null)`
`41`	`41`	`/// <returns>The path segment.</returns>`
`42`	`42`	`public IUriPathSegment ToPathSegment()`
`43`	`43`	`{`
`44`		`- return new UriPathSegmentVariableRegex<TParameter>(Expression, Display);`
	`44`	`+ return new UriPathSegmentVariableRegex<TParameter>(Expression, Tag);`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,17 +15,17 @@ public class SegmentStringAttribute<TParameter> : Attribute, IEndpointAttribute,`
`15`	`15`	`where TParameter : IParameterStatic, new()`
`16`	`16`	`{`
`17`	`17`	`/// <summary>`
`18`		`- /// Returns or sets the display string.`
	`18`	`+ /// Returns or sets the tag.`
`19`	`19`	`/// </summary>`
`20`		`- private string Display { get; set; }`
	`20`	`+ private string Tag { get; set; }`
`21`	`21`
`22`	`22`	`/// <summary>`
`23`	`23`	`/// Initializes a new instance of the class.`
`24`	`24`	`/// </summary>`
`25`		`- /// <param name="display">The display string.</param>`
`26`		`- public SegmentStringAttribute(string display = null)`
	`25`	`+ /// <param name="tag">The tag.</param>`
	`26`	`+ public SegmentStringAttribute(string tag = null)`
`27`	`27`	`{`
`28`		`- Display = display;`
	`28`	`+ Tag = tag;`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`/// <summary>`
`@@ -34,7 +34,7 @@ public SegmentStringAttribute(string display = null)`
`34`	`34`	`/// <returns>The path segment.</returns>`
`35`	`35`	`public IUriPathSegment ToPathSegment()`
`36`	`36`	`{`
`37`		`- return new UriPathSegmentVariableString<TParameter>(Display);`
	`37`	`+ return new UriPathSegmentVariableString<TParameter>(Tag);`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,17 +18,17 @@ public class SegmentUIntAttribute<TParameter> : Attribute, IEndpointAttribute, I`
`18`	`18`	`where TParameter : IParameterStatic, new()`
`19`	`19`	`{`
`20`	`20`	`/// <summary>`
`21`		`- /// Returns or sets the display string.`
	`21`	`+ /// Returns or sets the tag.`
`22`	`22`	`/// </summary>`
`23`		`- private string Display { get; set; }`
	`23`	`+ private string Tag { get; set; }`
`24`	`24`
`25`	`25`	`/// <summary>`
`26`	`26`	`/// Initializes a new instance of the class.`
`27`	`27`	`/// </summary>`
`28`		`- /// <param name="display">The display string.</param>`
`29`		`- public SegmentUIntAttribute(string display = null)`
	`28`	`+ /// <param name="tag">The tag.</param>`
	`29`	`+ public SegmentUIntAttribute(string tag = null)`
`30`	`30`	`{`
`31`		`- Display = display;`
	`31`	`+ Tag = tag;`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/// <summary>`
`@@ -37,7 +37,7 @@ public SegmentUIntAttribute(string display = null)`
`37`	`37`	`/// <returns>The path segment.</returns>`
`38`	`38`	`public IUriPathSegment ToPathSegment()`
`39`	`39`	`{`
`40`		`- return new UriPathSegmentVariableUInt<TParameter>(Display);`
	`40`	`+ return new UriPathSegmentVariableUInt<TParameter>(Tag);`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,11 @@ public override string ToString()`
`142`	`142`	`sb.AppendLine("Connection: Upgrade");`
`143`	`143`	`}`
`144`	`144`
	`145`	`+ if (!string.IsNullOrWhiteSpace(SecWebSocketAccept))`
	`146`	`+ {`
	`147`	`+ sb.AppendLine("Sec-WebSocket-Accept: " + SecWebSocketAccept);`
	`148`	`+ }`
	`149`	`+`
`145`	`150`	`foreach (var c in CustomHeader)`
`146`	`151`	`{`
`147`	`152`	`sb.AppendLine(c.Key + ": " + c.Value);`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@ public interface ISocket : IEndpoint, IDisposable`
`11`	`11`	`{`
`12`	`12`	`/// <summary>`
`13`	`13`	`/// Invoked after the websocket handshake has been accepted.`
`14`		`- /// Implementers may use the optional cancellation token to abort long-running startup tasks.`
`15`		`- /// the optional connectMessage provides initial metadata from the client (may be null).`
`16`	`14`	`/// </summary>`
`17`	`15`	`/// <param name="socketConnection">The socket connection.</param>`
`18`	`16`	`/// <returns>An asynchronous task.</returns>`