Skip to content

[Server] Flush output buffers on stateless SSE streams #520

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

Open
SammyTourani wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Server] Flush output buffers on stateless SSE streams #520

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
1 change: 1 addition & 0 deletions src/Server/Transport/Http/StatelessResponder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ private function sse(\Closure $frames): ResponseInterface
echo null === $frame
? ": keep-alive\n\n"
: 'data: '.json_encode($frame, \JSON_THROW_ON_ERROR | \JSON_UNESCAPED_SLASHES)."\n\n";
@ob_flush();
flush();
}
} catch (\Throwable $e) {
Expand Down
35 changes: 34 additions & 1 deletion tests/Integration/StatelessLifecycleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ protected function setUp(): void
{
$this->port = 8600 + (getmypid() % 300);

$this->server = new Process(['php', '-S', \sprintf('127.0.0.1:%d', $this->port), self::SERVER]);
// Buffer output as php.ini-production and php.ini-development do,
// whatever php.ini is loaded here, so an unflushed stream shows up.
$this->server = new Process(['php', '-d', 'output_buffering=4096', '-S', \sprintf('127.0.0.1:%d', $this->port), self::SERVER]);
$this->server->start();

$deadline = microtime(true) + 5;
Expand Down Expand Up @@ -186,6 +188,37 @@ public function testLoggingIsSilentWithoutALevel(): void
$this->assertContains('notifications/progress', $methods);
}

#[TestDox('a listen stream is acknowledged at once, not when it closes')]
public function testListenIsAcknowledgedAtOnce(): void
{
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => implode("\r\n", $this->headers('subscriptions/listen', null, null)),
'content' => $this->body('subscriptions/listen', ['notifications' => ['toolsListChanged' => true]], null),
'ignore_errors' => true,
// Well inside the example's 20 s lifetime: a frame held back in an
// output buffer would only arrive when the stream closes.
'timeout' => 5,
]]);

$handle = fopen($this->url(), 'r', false, $context);
$this->assertIsResource($handle);

$first = null;
while (false !== $line = fgets($handle)) {
$line = trim($line);

if (str_starts_with($line, 'data: ')) {
$first = json_decode(substr($line, 6), true, flags: \JSON_THROW_ON_ERROR);
break;
}
}

fclose($handle);

$this->assertSame('notifications/subscriptions/acknowledged', $first['method'] ?? null);
}

/**
* @param array<string, mixed> $params
* @param array<string, mixed> $capabilities
Expand Down
Loading