Let the stream event control the datastructure itself to make custom protocolls possibale

Author: thoresuenert

packages/http/src/ServerSentEvent.php

@@ -2,13 +2,9 @@
 
 namespace Tempest\Http;
 
-/**
- * Represents a message streamed through server-sent events.
- */
-final class ServerSentEvent
+interface ServerSentEvent
 {
-    public function __construct(
-        public mixed $data,
-        public string $event = 'message',
-    ) {}
+    public array $datalines {
+        get;
+    }
 }

packages/http/src/ServerSentMessage.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Tempest\Http;
+
+use Tempest\Support\Json;
+
+/**
+ * Represents a message streamed through server-sent events.
+ */
+final class ServerSentMessage implements ServerSentEvent
+{
+    public function __construct(
+        public mixed $data,
+        public string $event = 'message',
+    ) {}
+
+    public array $datalines {
+        get {
+            return [
+                "event: {$this->event}\n",
+                "data: " . Json\encode($this->data),
+                "\n\n",
+            ];
+        }
+    }
+}

packages/router/src/GenericResponseSender.php

@@ -16,6 +16,7 @@
 use Tempest\Http\Responses\EventStream;
 use Tempest\Http\Responses\File;
 use Tempest\Http\ServerSentEvent;
+use Tempest\Http\ServerSentMessage;
 use Tempest\Support\Json;
 use Tempest\View\View;
 use Tempest\View\ViewRenderer;
@@ -119,17 +120,13 @@ private function sendEventStream(EventStream $response): void
                 break;
             }
 
-            $event = 'message';
-            $data = Json\encode($message);
-
-            if ($message instanceof ServerSentEvent) {
-                $event = $message->event;
-                $data = Json\encode($message->data);
+            if (! ($message instanceof ServerSentEvent)) {
+                $message = new ServerSentMessage(data: $message);
             }
 
-            echo "event: {$event}\n";
-            echo "data: {$data}";
-            echo "\n\n";
+            foreach ($message->datalines as $dataline) {
+                echo $dataline;
+            }
 
             if (ob_get_level() > 0) {
                 ob_flush();

tests/Integration/Http/GenericResponseSenderTest.php

@@ -13,7 +13,7 @@
 use Tempest\Http\Responses\EventStream;
 use Tempest\Http\Responses\File;
 use Tempest\Http\Responses\Ok;
-use Tempest\Http\ServerSentEvent;
+use Tempest\Http\ServerSentMessage;
 use Tempest\Http\Status;
 use Tempest\Router\GenericResponseSender;
 use Tempest\View\ViewRenderer;
@@ -190,8 +190,8 @@ public function test_stream_with_custom_event(): void
     {
         ob_start();
         $response = new EventStream(function () {
-            yield new ServerSentEvent(data: 'hello', event: 'first');
-            yield new ServerSentEvent(data: 'goodbye', event: 'last');
+            yield new ServerSentMessage(data: 'hello', event: 'first');
+            yield new ServerSentMessage(data: 'goodbye', event: 'last');
         });
         $responseSender = $this->container->get(GenericResponseSender::class);
         $responseSender->send($response);