Add websocket template

Kaliumhexacyanoferrat · Kaliumhexacyanoferrat · commit 291aab20ac5b · 2024-10-23T16:58:43.000+02:00
diff --git a/README.md b/README.md
@@ -17,13 +17,14 @@ dotnet new install GenHTTP.Templates
 
 To use one of the templates below, create a new folder and run `dotnet new <template>` in your terminal.
 
-| Template      | Description                                                                                                                                             | 
-| ------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------| 
-| `genhttp-webservice` | A project that will host a new [REST web service](https://genhttp.org/documentation/content/frameworks/webservices/).                                   |
-| `genhttp-webservice-minimal` | A project that will host a new [REST web service](https://genhttp.org/documentation/content/frameworks/functional/) in a single file.                   |
+| Template                         | Description                                                                                                                                             | 
+|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| 
+| `genhttp-webservice`             | A project that will host a new [REST web service](https://genhttp.org/documentation/content/frameworks/webservices/).                                   |
+| `genhttp-webservice-minimal`     | A project that will host a new [REST web service](https://genhttp.org/documentation/content/frameworks/functional/) in a single file.                   |
 | `genhttp-webservice-controllers` | A project that will host a new REST web service using [controllers](https://genhttp.org/documentation/content/frameworks/controllers/).                 |
-| `genhttp-website-static` | Project to serve a [static website](https://genhttp.org/documentation/content/frameworks/static-websites/) from the file system.                        |
-| `genhttp-spa` | Project to serve the distribution files of a [Single Page Application](https://genhttp.org/documentation/content/frameworks/single-page-applications/). |
+| `genhttp-websocket`              | A project providing a web socket endpoint using the [websocket](https://genhttp.org/documentation/content/frameworks/websockets/) framework.            |
+| `genhttp-website-static`         | Project to serve a [static website](https://genhttp.org/documentation/content/frameworks/static-websites/) from the file system.                        |
+| `genhttp-spa`                    | Project to serve the distribution files of a [Single Page Application](https://genhttp.org/documentation/content/frameworks/single-page-applications/). |
 
 ## Template Development
 
diff --git a/Templates/SinglePageApplication/README.md b/Templates/SinglePageApplication/README.md
@@ -30,4 +30,4 @@ docker run -p 8080:8080 $safeprojectname$
 ## About
 
 This project uses the [GenHTTP webserver](https://genhttp.org/) to
-implement it's functionality.
+implement its functionality.
diff --git a/Templates/Webservice-Controllers/README.md b/Templates/Webservice-Controllers/README.md
@@ -30,4 +30,4 @@ docker run -p 8080:8080 $safeprojectname$
 ## About
 
 This project uses the [GenHTTP webserver](https://genhttp.org/) to
-implement it's functionality.
+implement its functionality.
diff --git a/Templates/Webservice-Minimal/README.md b/Templates/Webservice-Minimal/README.md
@@ -30,4 +30,4 @@ docker run -p 8080:8080 $safeprojectname$
 ## About
 
 This project uses the [GenHTTP webserver](https://genhttp.org/) to
-implement it's functionality.
+implement its functionality.
diff --git a/Templates/Webservice/README.md b/Templates/Webservice/README.md
@@ -30,4 +30,4 @@ docker run -p 8080:8080 $safeprojectname$
 ## About
 
 This project uses the [GenHTTP webserver](https://genhttp.org/) to
-implement it's functionality.
+implement its functionality.
diff --git a/Templates/Website-Static/README.md b/Templates/Website-Static/README.md
@@ -30,4 +30,4 @@ docker run -p 8080:8080 $safeprojectname$
 ## About
 
 This project uses the [GenHTTP webserver](https://genhttp.org/) to
-implement it's functionality.
+implement its functionality.
diff --git a/Templates/Websocket/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj b/Templates/Websocket/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj
@@ -0,0 +1,28 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+
+    <TargetFramework>net9.0</TargetFramework>
+
+    <Nullable>enable</Nullable>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <ImplicitUsings>true</ImplicitUsings>
+
+    <IsPackable>false</IsPackable>
+
+  </PropertyGroup>
+
+  <ItemGroup>
+
+	<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+
+	<PackageReference Include="MSTest.TestAdapter" Version="3.6.1" />
+	<PackageReference Include="MSTest.TestFramework" Version="3.6.1" />
+
+    <PackageReference Include="GenHTTP.Testing" Version="9.0.0" />
+
+    <ProjectReference Include="..\$safeprojectname$\$safeprojectname$.csproj" />
+
+  </ItemGroup>
+
+</Project>
diff --git a/Templates/Websocket/$safeprojectname$.Tests/SocketTests.cs b/Templates/Websocket/$safeprojectname$.Tests/SocketTests.cs
@@ -0,0 +1,21 @@
+﻿using System.Net;
+
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+using GenHTTP.Testing;
+
+namespace $safeprojectname$.Tests;
+
+[TestClass]
+public class SocketTests
+{
+
+    [TestMethod]
+    public async Task TestSocket()
+    {
+        using var runner = TestHost.Run(Project.Setup());
+
+        // add your test code here, e.g. using Websocket.Client
+    }
+
+}
diff --git a/Templates/Websocket/$safeprojectname$/$safeprojectname$.csproj b/Templates/Websocket/$safeprojectname$/$safeprojectname$.csproj
@@ -0,0 +1,32 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+
+    <Nullable>enable</Nullable>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <ImplicitUsings>true</ImplicitUsings>
+
+    <AssemblyVersion>0.1.0.0</AssemblyVersion>
+    <FileVersion>0.1.0.0</FileVersion>
+    <Version>0.1.0</Version>
+
+  </PropertyGroup>
+
+  <ItemGroup>
+
+    <PackageReference Include="GenHTTP.Core" Version="9.0.0" />
+
+    <PackageReference Include="GenHTTP.Modules.Websockets" Version="9.0.0" />
+
+  </ItemGroup>
+
+  <ItemGroup>
+
+    <EmbeddedResource Include="Resources\client.html" />
+
+  </ItemGroup>
+
+</Project>
diff --git a/Templates/Websocket/$safeprojectname$/Program.cs b/Templates/Websocket/$safeprojectname$/Program.cs
@@ -0,0 +1,20 @@
+﻿using GenHTTP.Engine;
+
+using GenHTTP.Modules.Practices;
+
+using $safeprojectname$;
+
+// run this sample and open http://localhost:8080 in your browser
+
+var project = Project.Setup();
+
+return Host.Create()
+           .Handler(project)
+           .Defaults()
+           .Console()
+//-:cnd:noEmit
+#if DEBUG
+           .Development()
+#endif
+//+:cnd:noEmit
+           .Run();
diff --git a/Templates/Websocket/$safeprojectname$/Project.cs b/Templates/Websocket/$safeprojectname$/Project.cs
@@ -0,0 +1,40 @@
+﻿using GenHTTP.Api.Content;
+
+using GenHTTP.Modules.IO;
+using GenHTTP.Modules.Layouting;
+using GenHTTP.Modules.Websockets;
+
+namespace $safeprojectname$;
+
+public static class Project
+{
+    private static List<IWebsocketConnection> _AllSockets = [];
+
+    public static IHandlerBuilder Setup()
+    {
+        var client = Content.From(Resource.FromAssembly("client.html"));
+
+        // see https://genhttp.org/documentation/content/frameworks/websockets/
+        var socket = Websocket.Create()
+                              .OnOpen((socket) =>
+                              {
+                                  Console.WriteLine("Open!");
+                                  _AllSockets.Add(socket);
+                              })
+                              .OnClose((socket) =>
+                              {
+                                  Console.WriteLine("Close!");
+                                  _AllSockets.Remove(socket);
+                              })
+                              .OnMessage((socket, message) =>
+                              {
+                                  Console.WriteLine(message);
+                                  _AllSockets.ForEach(s => s.Send("Echo: " + message));
+                              });
+
+        return Layout.Create()
+                     .Add("socket", socket) // ws://localhost:8080/socket/
+                     .Add(client);
+    }
+
+}
diff --git a/Templates/Websocket/$safeprojectname$/Resources/client.html b/Templates/Websocket/$safeprojectname$/Resources/client.html
@@ -0,0 +1,49 @@
+﻿<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+    <title>websocket client</title>
+    <script type="text/javascript">
+        var start = function () {
+            var inc = document.getElementById('incomming');
+            var wsImpl = window.WebSocket || window.MozWebSocket;
+            var form = document.getElementById('sendForm');
+            var input = document.getElementById('sendText');
+
+            inc.innerHTML += "connecting to server ..<br/>";
+
+            // create a new websocket and connect
+            window.ws = new wsImpl('ws://localhost:8080/socket');
+
+            // when data is comming from the server, this metod is called
+            ws.onmessage = function (evt) {
+                inc.innerHTML += evt.data + '<br/>';
+            };
+
+            // when the connection is established, this method is called
+            ws.onopen = function () {
+                inc.innerHTML += '.. connection open<br/>';
+            };
+
+            // when the connection is closed, this method is called
+            ws.onclose = function () {
+                inc.innerHTML += '.. connection closed<br/>';
+            }
+
+            form.addEventListener('submit', function(e){
+                e.preventDefault();
+                var val = input.value;
+                ws.send(val);
+                input.value = "";
+            });
+
+        }
+        window.onload = start;
+    </script>
+</head>
+<body>
+<form id="sendForm">
+    <input id="sendText" placeholder="Text to send" />
+</form>
+<pre id="incomming"></pre>
+</body>
+</html>
diff --git a/Templates/Websocket/.template.config/template.json b/Templates/Websocket/.template.config/template.json
@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json.schemastore.org/template",
+  "author": "genhttp.org",
+  "classifications": [ "GenHTTP", "Websocket" ],
+  "identity": "GenHTTP.Templates.Websocket",
+  "name": "GenHTTP: Websocket",
+  "shortName": "genhttp-websocket",
+  "sourceName": "$safeprojectname$",
+  "description": "A project template to host a websocket service using the GenHTTP webserver",
+  "tags": {
+    "language": "C#",
+    "type": "project"
+  }
+}
diff --git a/Templates/Websocket/Dockerfile.linux-arm32 b/Templates/Websocket/Dockerfile.linux-arm32
@@ -0,0 +1,19 @@
+FROM mcr.microsoft.com/dotnet/sdk:9.0 AS build
+WORKDIR /source
+
+# copy csproj and restore as distinct layers
+COPY $safeprojectname$/*.csproj .
+RUN dotnet restore -r linux-arm
+
+# copy and publish app and libraries
+COPY $safeprojectname$/ .
+RUN dotnet publish -c release -o /app -r linux-arm --no-restore /p:PublishTrimmed=true /p:TrimMode=Link
+
+# final stage/image
+FROM mcr.microsoft.com/dotnet/runtime-deps:9.0-alpine-arm32v7
+WORKDIR /app
+COPY --from=build /app .
+
+ENTRYPOINT ["./$safeprojectname$"]
+
+EXPOSE 8080
diff --git a/Templates/Websocket/Dockerfile.linux-arm64 b/Templates/Websocket/Dockerfile.linux-arm64
@@ -0,0 +1,19 @@
+FROM mcr.microsoft.com/dotnet/sdk:9.0 AS build
+WORKDIR /source
+
+# copy csproj and restore as distinct layers
+COPY $safeprojectname$/*.csproj .
+RUN dotnet restore -r linux-arm64
+
+# copy and publish app and libraries
+COPY $safeprojectname$/ .
+RUN dotnet publish -c release -o /app -r linux-arm64 --no-restore /p:PublishTrimmed=true /p:TrimMode=Link
+
+# final stage/image
+FROM mcr.microsoft.com/dotnet/runtime-deps:9.0-alpine-arm64v8
+WORKDIR /app
+COPY --from=build /app .
+
+ENTRYPOINT ["./$safeprojectname$"]
+
+EXPOSE 8080
diff --git a/Templates/Websocket/Dockerfile.linux-x64 b/Templates/Websocket/Dockerfile.linux-x64
@@ -0,0 +1,19 @@
+FROM mcr.microsoft.com/dotnet/sdk:9.0-alpine AS build
+WORKDIR /source
+
+# copy csproj and restore as distinct layers
+COPY $safeprojectname$/*.csproj .
+RUN dotnet restore -r linux-musl-x64
+
+# copy and publish app and libraries
+COPY $safeprojectname$/ .
+RUN dotnet publish -c release -o /app -r linux-musl-x64 --no-restore /p:PublishTrimmed=true /p:TrimMode=Link
+
+# final stage/image
+FROM mcr.microsoft.com/dotnet/runtime-deps:9.0-alpine
+WORKDIR /app
+COPY --from=build /app .
+
+ENTRYPOINT ["./$safeprojectname$"]
+
+EXPOSE 8080
diff --git a/Templates/Websocket/README.md b/Templates/Websocket/README.md
@@ -0,0 +1,33 @@
+# $safeprojectname$
+
+*Add your project description here.*
+
+## Development
+
+To build this project from source, checkout this repository and execute
+the following commands in your terminal. This requires the
+[.NET SDK](https://dotnet.microsoft.com/download) to be installed.
+
+```
+cd $safeprojectname$
+dotnet run
+```
+
+This will make the service available at http://localhost:8080/.
+
+## Deployment
+
+To run this project with [Docker](https://www.docker.com/), run the 
+following commands in your terminal (and adjust the first line
+depending on your platform).
+
+```
+docker build -f Dockerfile.linux-x64 -t $safeprojectname$ .
+
+docker run -p 8080:8080 $safeprojectname$
+```
+
+## About
+
+This project uses the [GenHTTP webserver](https://genhttp.org/) to
+implement its functionality.
