NuGet v6.3.0, server-sent events support, refactor

dotnet · Dec 13, 2024 · 999dbc3 · 999dbc3
1 parent 6c751d9
commit 999dbc3
Show file tree

Hide file tree

Showing 78 changed files with 1,506 additions and 1,190 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 ## Current Version
 
+v6.3.x
+
+- Minor change to chunked transfer, i.e. `SendChunk` now accepts `isFinal` as a `Boolean` property
+- Added support for server-sent events, included `Test.ServerSentEvents` project
+- Minor internal refactor
+
 v6.2.x
 
 - Support for specifying exception handler for static, content, parameter, and dynamic routes (thank you @nomadeon)

diff --git a/README.md b/README.md
@@ -16,9 +16,11 @@ Special thanks to @DamienDennehy for allowing us the use of the ```Watson.Core``
 
 This project is part of the [.NET Foundation](http://www.dotnetfoundation.org/projects) along with other projects like [the .NET Runtime](https://github.com/dotnet/runtime/).
 
-## New in v6.2.x
+## New in v6.3.x
 
-- Support for specifying exception handler for static, content, parameter, and dynamic routes (thank you @nomadeon)
+- Minor change to chunked transfer, i.e. `SendChunk` now accepts `isFinal` as a `Boolean` property
+- Added support for server-sent events, included `Test.ServerSentEvents` project
+- Minor internal refactor
 
 ## Special Thanks
 
@@ -232,13 +234,16 @@ static async Task DownloadChunkedFile(HttpContextBase ctx)
     while (true)
     {
       int bytesRead = await fs.ReadAsync(buffer, 0, buffer.Length);
+      byte[] data = new byte[bytesRead];
+      Buffer.BlockCopy(buffer, 0, bytesRead, data, 0); // only copy the read data
+
       if (bytesRead > 0)
       {
-        await ctx.Response.SendChunk(buffer, bytesRead);
+        await ctx.Response.SendChunk(data, false);
       }
       else
       {
-        await ctx.Response.SendFinalChunk(null, 0);
+        await ctx.Response.SendChunk(Array.Empty<byte>(), true);
         break;
       }
     }
@@ -248,6 +253,35 @@ static async Task DownloadChunkedFile(HttpContextBase ctx)
 }
 ```
 
+## Server-Sent Events
+
+Watson supports sending server-sent events.  Refer to `Test.ServerSentEvents` for a sample implementation.  The `SendEvent` method handles prepending `data: ` and the following `\n\n` to your message.
+
+### Sending Events
+
+```csharp
+static async Task SendEvents(HttpContextBase ctx)
+{
+  ctx.Response.StatusCode = 200;
+  ctx.Response.ServerSentEvents = true;
+
+  while (true)
+  {
+    string data = GetNextEvent(); // your implementation
+    if (!String.IsNullOrEmpty(data))
+    {
+      await ctx.Response.SendEvent(data);
+    }
+    else
+    {
+      break;
+    }
+  }
+
+  return;
+}
+```
+
 ## HostBuilder
 
 `HostBuilder` helps you set up your server much more easily by introducing a chain of settings and routes instead of using the server class directly.  Special thanks to @sapurtcomputer30 for producing this fine feature!

diff --git a/src/Test.Authentication/Program.cs b/src/Test.Authentication/Program.cs
@@ -1,16 +1,16 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Text.RegularExpressions;
-using System.Threading.Tasks;
-using RestWrapper;
-using WatsonWebserver;
-using WatsonWebserver.Core;
-using WatsonWebserver.Lite;
-
-namespace Test.Authentication
+namespace Test.Authentication
 {
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Text;
+    using System.Text.RegularExpressions;
+    using System.Threading.Tasks;
+    using RestWrapper;
+    using WatsonWebserver;
+    using WatsonWebserver.Core;
+    using WatsonWebserver.Lite;
+
     static class Program
     {
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously

diff --git a/src/Test.ChunkServer/Program.cs b/src/Test.ChunkServer/Program.cs
@@ -1,25 +1,27 @@
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Text;
-using System.Threading;
-using System.Threading.Tasks;
-using WatsonWebserver;
-using WatsonWebserver.Core;
-using WatsonWebserver.Lite;
-
-namespace Test
+namespace Test
 {
-    static class Program
+    using System;
+    using System.Collections.Generic;
+    using System.IO;
+    using System.Linq;
+    using System.Text;
+    using System.Threading;
+    using System.Threading.Tasks;
+    using WatsonWebserver;
+    using WatsonWebserver.Core;
+    using WatsonWebserver.Lite;
+
+    public static class Program
     {
+#pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
+
         static bool _UsingLite = false;
         static string _Hostname = "localhost";
         static int _Port = 8080;
         static WebserverSettings _Settings = null;
         static WebserverBase _Server = null;
 
-        static void Main(string[] args)
+        static async Task Main(string[] args)
         {
             if (args != null && args.Length > 0)
             {
@@ -117,13 +119,13 @@ static async Task DefaultRoute(HttpContextBase ctx)
 
                                         if (bytesRead == buffer.Length)
                                         {
-                                            await ctx.Response.SendChunk(buffer);
+                                            await ctx.Response.SendChunk(buffer, false);
                                         }
                                         else
                                         {
                                             byte[] temp = new byte[bytesRead];
                                             Buffer.BlockCopy(buffer, 0, temp, 0, bytesRead);
-                                            await ctx.Response.SendChunk(temp);
+                                            await ctx.Response.SendChunk(temp, false);
                                         }
                                     }
                                     else
@@ -132,13 +134,13 @@ static async Task DefaultRoute(HttpContextBase ctx)
 
                                         if (bytesRead == buffer.Length)
                                         {
-                                            await ctx.Response.SendFinalChunk(buffer);
+                                            await ctx.Response.SendChunk(buffer, true);
                                         }
                                         else
                                         {
                                             byte[] temp = new byte[bytesRead];
                                             Buffer.BlockCopy(buffer, 0, temp, 0, bytesRead);
-                                            await ctx.Response.SendFinalChunk(temp);
+                                            await ctx.Response.SendChunk(temp, true);
                                         }
                                     }
 
@@ -183,13 +185,13 @@ static async Task DefaultRoute(HttpContextBase ctx)
 
                                         if (bytesRead == buffer.Length)
                                         {
-                                            await ctx.Response.SendChunk(buffer);
+                                            await ctx.Response.SendChunk(buffer, false);
                                         }
                                         else
                                         {
                                             byte[] temp = new byte[bytesRead];
                                             Buffer.BlockCopy(buffer, 0, temp, 0, bytesRead);
-                                            await ctx.Response.SendChunk(temp);
+                                            await ctx.Response.SendChunk(temp, false);
                                         }
                                     }
                                     else
@@ -198,16 +200,14 @@ static async Task DefaultRoute(HttpContextBase ctx)
 
                                         if (bytesRead == buffer.Length)
                                         {
-                                            await ctx.Response.SendFinalChunk(buffer);
+                                            await ctx.Response.SendChunk(buffer, true);
                                         }
                                         else
                                         {
                                             byte[] temp = new byte[bytesRead];
                                             Buffer.BlockCopy(buffer, 0, temp, 0, bytesRead);
-                                            await ctx.Response.SendFinalChunk(temp);
+                                            await ctx.Response.SendChunk(temp, true);
                                         }
-
-                                        await ctx.Response.SendFinalChunk(buffer);
                                     }
 
                                     bytesSent += bytesRead;
@@ -230,6 +230,8 @@ static async Task DefaultRoute(HttpContextBase ctx)
             {
                 Console.WriteLine(e.ToString());
             }
-        } 
+        }
+
+#pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously
     }
 }
diff --git a/src/Test.ChunkServer/Test.ChunkServer.csproj b/src/Test.ChunkServer/Test.ChunkServer.csproj
@@ -2,7 +2,7 @@
 
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
-		<TargetFrameworks>net462;net48;net6.0;net7.0;net8.0</TargetFrameworks>
+		<TargetFrameworks>net462;net48;net6.0;net8.0</TargetFrameworks>
 	</PropertyGroup>
 
 	<ItemGroup>
@@ -16,6 +16,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
+		<ProjectReference Include="..\WatsonWebserver.Core\WatsonWebserver.Core.csproj" />
 		<ProjectReference Include="..\WatsonWebserver.Lite\WatsonWebserver.Lite.csproj" />
 		<ProjectReference Include="..\WatsonWebserver\WatsonWebserver.csproj" />
 	</ItemGroup>

diff --git a/src/Test.DataReader/Program.cs b/src/Test.DataReader/Program.cs
@@ -1,15 +1,15 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using GetSomeInput;
-using WatsonWebserver;
-using WatsonWebserver.Core;
-using WatsonWebserver.Lite;
-
-namespace Test
+namespace Test
 {
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Text;
+    using System.Threading.Tasks;
+    using GetSomeInput;
+    using WatsonWebserver;
+    using WatsonWebserver.Core;
+    using WatsonWebserver.Lite;
+
     static class Program
     {
         static bool _UsingLite = false;

diff --git a/src/Test.DataReader/Test.DataReader.csproj b/src/Test.DataReader/Test.DataReader.csproj
@@ -2,7 +2,7 @@
 
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
-		<TargetFrameworks>net462;net48;net6.0;net7.0;net8.0</TargetFrameworks>
+		<TargetFrameworks>net462;net48;net6.0;net8.0</TargetFrameworks>
 	</PropertyGroup>
 
 	<ItemGroup>

diff --git a/src/Test.Default/Program.cs b/src/Test.Default/Program.cs
@@ -1,12 +1,12 @@
-using GetSomeInput;
-namespace Test
+namespace Test
 {
     using System;
     using System.Collections.Generic;
     using System.Linq;
     using System.Text;
     using System.Text.RegularExpressions;
     using System.Threading.Tasks;
+    using GetSomeInput;
     using WatsonWebserver;
     using WatsonWebserver.Core;
     using WatsonWebserver.Lite;

diff --git a/src/Test.Default/Test.Default.csproj b/src/Test.Default/Test.Default.csproj
@@ -2,7 +2,7 @@
 
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
-		<TargetFrameworks>net462;net48;net6.0;net7.0;net8.0</TargetFrameworks>
+		<TargetFrameworks>net462;net48;net6.0;net8.0</TargetFrameworks>
 	</PropertyGroup>
 
 	<ItemGroup>

diff --git a/src/Test.Docker/Test.Docker.csproj b/src/Test.Docker/Test.Docker.csproj
@@ -2,7 +2,7 @@
 
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
-		<TargetFrameworks>net462;net48;net6.0;net7.0;net8.0</TargetFrameworks>
+		<TargetFrameworks>net462;net48;net6.0;net8.0</TargetFrameworks>
 	</PropertyGroup>
 
 	<ItemGroup>

diff --git a/src/Test.HostBuilder/Program.cs b/src/Test.HostBuilder/Program.cs
@@ -1,14 +1,14 @@
-using RestWrapper;
-using System;
-using System.Collections.Generic;
-using System.Text.RegularExpressions;
-using System.Threading.Tasks;
-using WatsonWebserver;
-using WatsonWebserver.Core;
-using WatsonWebserver.Lite;
-
-namespace Test.HostBuilder
+namespace Test.HostBuilder
 {
+    using System;
+    using System.Collections.Generic;
+    using System.Text.RegularExpressions;
+    using System.Threading.Tasks;
+    using RestWrapper;
+    using WatsonWebserver;
+    using WatsonWebserver.Core;
+    using WatsonWebserver.Lite;
+
     public static class Program
     {
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
@@ -20,7 +20,7 @@ public static class Program
         static WebserverSettings _Settings = null;
         static WebserverBase _Server = null;
 
-        public static void Main(string[] args)
+        public static async Task Main(string[] args)
         {
             if (args != null && args.Length > 0)
             {
@@ -156,7 +156,7 @@ public static void Main(string[] args)
 
                 using (RestRequest req = new RestRequest(url))
                 {
-                    using (RestResponse resp = req.Send())
+                    using (RestResponse resp = await req.SendAsync())
                     {
                         Console.WriteLine("Received response: " + resp.StatusCode);
                         Task.Delay(1000).Wait();

diff --git a/src/Test.HostBuilder/Test.HostBuilder.csproj b/src/Test.HostBuilder/Test.HostBuilder.csproj
@@ -2,14 +2,15 @@
 
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
-		<TargetFrameworks>net462;net48;net6.0;net7.0;net8.0</TargetFrameworks>
+		<TargetFrameworks>net462;net48;net6.0;net8.0</TargetFrameworks>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="RestWrapper" Version="3.0.14" />
+		<PackageReference Include="RestWrapper" Version="3.1.2" />
 	</ItemGroup>
 
 	<ItemGroup>
+		<ProjectReference Include="..\WatsonWebserver.Core\WatsonWebserver.Core.csproj" />
 		<ProjectReference Include="..\WatsonWebserver.Lite\WatsonWebserver.Lite.csproj" />
 		<ProjectReference Include="..\WatsonWebserver\WatsonWebserver.csproj" />
 	</ItemGroup>