Skip to content

[Platform] Respect SSE comments in streaming mode #1068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lochmueller wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[Platform] Respect SSE comments in streaming mode #1068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/platform/src/Result/RawHttpResult.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ public function getDataStream(): iterable
continue;
}

if (str_starts_with(trim($delta), ':')) {
// SEE comments via Spec https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation
continue;
}

yield json_decode($delta, true, flags: \JSON_THROW_ON_ERROR);
}
}
Expand Down
18 changes: 18 additions & 0 deletions src/platform/tests/Result/StreamResultTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,22 @@ public function testGetContent()
$this->assertSame('data1', $content[0]);
$this->assertSame('data2', $content[1]);
}

public function testGetContentInclSseComments()
{
$generator = (static function () {
yield 'data1';
yield ': this is just a comment';
yield 'data2';
})();

$result = new StreamResult($generator);
$this->assertInstanceOf(\Generator::class, $result->getContent());

$content = iterator_to_array($result->getContent());

$this->assertCount(2, $content);
$this->assertSame('data1', $content[0]);
$this->assertSame('data2', $content[1]);
}
}
Loading