Bump sttp version and beautify WebsocketEcho

pbernet · pbernet · commit 9ba5b4d475c6 · 2024-12-14T09:22:05.000+01:00
diff --git a/build.sbt b/build.sbt
@@ -16,7 +16,7 @@ val activemqVersion = "5.18.5" // We are stuck with 5.x
 val artemisVersion = "2.37.0"
 val testContainersVersion = "1.20.4"
 val keycloakVersion = "26.0.1"
-val sttpVersion = "3.9.0"
+val sttpVersion = "3.10.1"
 val influxdbVersion = "7.1.0"
 val awsClientVersion = "2.25.32"
 val gatlingVersion = "3.12.0"
diff --git a/src/main/resources/WebsocketEcho.html b/src/main/resources/WebsocketEcho.html
@@ -4,7 +4,7 @@
 <head>
     <meta charset="utf-8">
     <title>Simple websocket Client</title>
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js"></script>
 </head>
 <body>
 <input type="button" onclick="connectToWS()" value="Connect to:"/>
@@ -19,17 +19,17 @@
 <ul id="messages"></ul>
 
 <script type="text/javascript">
-    var $messages = $("#messages");
-    var echoWebSocket;
+    let $messages = $("#messages");
+    let echoWebSocket;
 
     function connectToWS() {
-        var endpoint_echo = document.getElementById("endpoint_echo").value;
+        let endpoint_echo = document.getElementById("endpoint_echo").value;
         if (echoWebSocket !== undefined) {
             echoWebSocket.close()
         }
         echoWebSocket = new WebSocket(endpoint_echo);
         echoWebSocket.onmessage = function (event) {
-            var leng;
+            let leng;
             if (event.data.size === undefined) {
                 leng = event.data.length
             } else {
@@ -38,7 +38,7 @@
             $messages.prepend($("<li>" + event.data + "</li>"))
             console.log("onmessage. size: " + leng + ", content: " + event.data);
         };
-        echoWebSocket.onopen = function (evt) {
+        echoWebSocket.onopen = function () {
             $messages.prepend($("<li>OPEN</li>"))
             console.log("onopen state client: " + echoWebSocket.readyState);
         };
@@ -48,21 +48,21 @@
             // If the server closes correctly, we get a 1000 (= Normal Closure) code
             console.log("onclose - state client: " + echoWebSocket.readyState + " Reason server: " + evt.code);
         };
-        echoWebSocket.onerror = function (evt) {
+        echoWebSocket.onerror = function () {
             console.log("Error!");
         };
     }
 
-    var heartbeatWebSocket;
+    let heartbeatWebSocket;
 
     function connectToWSHeartbeat() {
-        var endpoint_heartbeat = document.getElementById("endpoint_heartbeat").value;
+        let endpoint_heartbeat = document.getElementById("endpoint_heartbeat").value;
         if (heartbeatWebSocket !== undefined) {
             heartbeatWebSocket.close()
         }
         heartbeatWebSocket = new WebSocket(endpoint_heartbeat);
         heartbeatWebSocket.onmessage = function (event) {
-            var leng;
+            let leng;
             if (event.data.size === undefined) {
                 leng = event.data.length
             } else {
@@ -71,7 +71,7 @@
             $messages.prepend($("<li>" + event.data + "</li>"))
             console.log("onmessage. size: " + leng + ", content: " + event.data);
         };
-        heartbeatWebSocket.onopen = function (evt) {
+        heartbeatWebSocket.onopen = function () {
             $messages.prepend($("<li>OPEN</li>"))
             console.log("onopen state client: " + heartbeatWebSocket.readyState);
             console.log("Requesting heartbeat stream...");
@@ -80,7 +80,7 @@
         heartbeatWebSocket.onclose = function (evt) {
             $messages.prepend($("<li>CLOSED</li>"))
             // https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent#status_codes
-            // If the server does not close, we would get a 1006 (= Abnormal Closure) code
+            // If the server does not close explicitly, we get a 1006 (= Abnormal Closure) code
             console.log("onclose - state client: " + heartbeatWebSocket.readyState + " Reason server: " + evt.code);
         };
         heartbeatWebSocket.onerror = function (evt) {
@@ -90,7 +90,7 @@
 
 
     function sendMsg() {
-        var message = document.getElementById("myMessage").value;
+        let message = document.getElementById("myMessage").value;
         echoWebSocket.send("Browser-" + message);
     }
 
diff --git a/src/main/scala/akkahttp/WebsocketEcho.scala b/src/main/scala/akkahttp/WebsocketEcho.scala
@@ -59,16 +59,16 @@ trait ClientCommon {
 
 /**
   * Websocket echo example with different client types
-  * Each client instance produces it's own `echoFlow` on the server
+  * Each client instance produces its own `echoFlow` on the server
   *
   * Clients do not close (implicitly) due to config:
   * `http.server.websocket.periodic-keep-alive-max-idle`
   * see file `application.conf` for details
   *
-  * Currently akka http has no user API for websocket close
+  * Like akka-http, pekko-http has no built-in API for websocket close
   * see: https://github.com/akka/akka-http/issues/2458
   *
-  * Already possible explicit client closing scenarios:
+  * Already implemented explicit client closing patterns:
   *  - [[akkahttp.WebsocketEcho.serverHeartbeatStreamClient]] shows an explicit client closing scenario (also from Browser)
   *    Inspired by: https://discuss.lightbend.com/t/websocket-connection-does-not-terminate-even-when-client-tries-to-close-it/8285
   *  - [[akkahttp.WebsocketEcho.singleWebSocketRequestSourceQueueClient]]
@@ -287,11 +287,17 @@ object WebsocketEcho extends App with WebSocketDirectives with ClientCommon {
     def useWebSocket(ws: WebSocket[Future]): Future[Unit] = {
       def send(payload: String) = ws.sendText(payload)
       def receive() = ws.receiveText().map(t => logger.info(s"sttpClient $id received: $t"))
-      for {
-        _ <- send(s"$id-1 sttpClient")
-        _ <- send(s"$id-2 sttpClient")
-        _ <- receive()
-      } yield ()
+
+      val messages = (1 to 5).map(i => s"$id-$i sttpClient")
+
+      messages.foldLeft(Future.successful(())) { (prev, msg) =>
+        prev.flatMap { _ =>
+          for {
+            _ <- send(msg)
+            _ <- receive()
+          } yield ()
+        }
+      }
     }
 
     val backend = PekkoHttpBackend()
