Add Server-Sent Events Sample

README.md

@@ -45,6 +45,8 @@ Repo features in more detail:
       manager from being continually polled.
 * Configuration is based on environment variables.
 * File upload and tracking examples.
+* Server-sent events over MQTT.
+    * For more information, see [`docs/patterns/server-sent-events.md`](docs/patterns/server-sent-events.md)
 * Documentation on common data handling practices:
     * [Event Sourcing](docs/patterns/event-sourcing.md)
 
@@ -100,7 +102,21 @@ Below are the recommended steps for using this as a template:
 
 2. Write database accessors and/or service connectors based on your application's needs.
 3. Prune database accessors and/or service connectors that your application does not need.
-4. Consider revising/pruning the Markdown files such as this README or those located in the `docs/` directory. They
+4. The example of Server-Sent Events needed a bespoke handler, the standard NSwag clients did not know how to support
+   event streams. This handler can be found in the `RedShirt.Example.Api.Interop` project, defined in
+   `EventStreamListener.cs`.
+    * The `EventStreamListener.cs` contains the abstract `EventStreamListener` and the applied
+      `MessagesEventStreamListener`, which sets some defaults.
+    * If you are implementing Server-Sent Events but not as `/messages` as this example does, then I would recommend
+      adjusting the comments described in `MessagesEventStreamListener`.
+    * If you are not implementing Server-Side Events in your applied application, then I would recommend deleting
+      `EventStreamListener.cs` outright.
+        * The pattern of emulating the generated swagger clients by throwing a `SwaggerException` required the manual
+          declaration of `SwaggerException` and `ProblemDetails` to avoid a chicken-and-egg problem on build where a
+          cold build without generated code failed because the manual code was expecting it. If you are removing
+          `EventStreamListener`, then you might also want to consider removing these manual classes and adjusting
+          `nswag.json` to generate them again.
+5. Consider revising/pruning the Markdown files such as this README or those located in the `docs/` directory. They
    heavily assume that they are speaking for a general template and not for an applied application.
 
 ## Secret Manager

RedShirt.Example.Api.slnx

@@ -7,6 +7,7 @@
     <Folder Name="/Solution Items/docs/patterns/">
         <File Path="docs\patterns\event-sourcing.md"/>
         <File Path="docs\patterns\rosalyn-source-generation.md"/>
+        <File Path="docs\patterns\server-sent-events.md"/>
         <File Path="docs\patterns\uploads.md"/>
     </Folder>
     <Folder Name="/src/">
@@ -76,8 +77,21 @@
                 Path="src\RedShirt.Example.Api.DataStores.Common.DapperMySql\RedShirt.Example.Api.DataStores.Common.DapperMySql.csproj"/>
         <Project Path="src\RedShirt.Example.Api.DataStores.Common\RedShirt.Example.Api.DataStores.Common.csproj"/>
     </Folder>
+    <Folder Name="/src/events/">
+        <Project
+                Path="src/RedShirt.Example.Api.ClientEvents.Domains.Example/RedShirt.Example.Api.ClientEvents.Domains.Example.csproj"/>
+    </Folder>
+    <Folder Name="/src/events/common/">
+        <Project
+                Path="src/RedShirt.Example.Api.ClientEvents.Library.Core/RedShirt.Example.Api.ClientEvents.Library.Core.csproj"/>
+        <Project
+                Path="src\RedShirt.Example.Api.ClientEvents.Library.Mqtt\RedShirt.Example.Api.ClientEvents.Library.Mqtt.csproj"/>
+        <Project
+                Path="src\RedShirt.Example.Api.ClientEvents.Library.Mqtt.Aws\RedShirt.Example.Api.ClientEvents.Library.Mqtt.Aws.csproj"/>
+    </Folder>
     <Folder Name="/swagger/">
         <Project Path="swagger/RedShirt.Example.Api.Interop/RedShirt.Example.Api.Interop.csproj"/>
+        <Project Path="test/RedShirt.Example.Api.Interop.UnitTests/RedShirt.Example.Api.Interop.UnitTests.csproj"/>
     </Folder>
     <Folder Name="/test/">
         <Project Path="test/RedShirt.Example.Api.Core.UnitTests/RedShirt.Example.Api.Core.UnitTests.csproj"/>
@@ -143,4 +157,10 @@
         <Project
                 Path="test\RedShirt.Example.Api.DataStores.Common.DapperMySql.UnitTests\RedShirt.Example.Api.DataStores.Common.DapperMySql.UnitTests.csproj"/>
     </Folder>
+    <Folder Name="/test/events/">
+        <Project
+                Path="test\RedShirt.Example.Api.ClientEvents.Library.Mqtt.UnitTests\RedShirt.Example.Api.ClientEvents.Library.Mqtt.UnitTests.csproj"/>
+        <Project
+                Path="test\RedShirt.Example.Api.ClientEvents.Library.Mqtt.Aws.UnitTests\RedShirt.Example.Api.ClientEvents.Library.Mqtt.Aws.UnitTests.csproj"/>
+    </Folder>
 </Solution>