danog/byte-stream
1
0
Fork 0
mirror of https://github.com/danog/byte-stream.git synced 2024-11-30 04:19:23 +01:00
Code Issues Projects Releases Wiki Activity

Proper fix for remote closed streams

Browse Source 
Fixes #40. Streams on MacOS (and possibly FreeBSD) that are closed by the remote still allow writing, returning a non-zero from fwrite(). EOF then is false, since data was written to the buffer. EOF needed to be checked before calling fwrite().
This commit is contained in:
Aaron Piotrowski 2018-04-03 18:51:02 -05:00
parent 5403767515
commit da357d1579
No known key found for this signature in database
GPG Key ID: ADD1EF783EDE9EEB
2 changed files with 32 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
lib/ResourceOutputStream.php
View File

@ -68,6 +68,10 @@ final class ResourceOutputStream implements OutputStream {
continue;
}
if (!\is_resource($stream) || @\feof($stream)) {
throw new StreamException("The stream was closed by the peer");
}
// Error reporting suppressed since fwrite() emits E_WARNING if the pipe is broken or the buffer is full.
// Use conditional, because PHP doesn't like getting null passed
if ($chunkSize) {
@ -77,28 +81,18 @@ final class ResourceOutputStream implements OutputStream {
}
\assert($written !== false, "Trying to write on a previously fclose()'d resource. Do NOT manually fclose() resources the loop still has a reference to.");
// Broken pipes between processes on macOS/FreeBSD do not detect EOF properly.
if ($written === 0) {
// fwrite will also return 0 if the buffer is already full.
if ($emptyWrites++ < self::MAX_CONSECUTIVE_EMPTY_WRITES && \is_resource($stream) && !@\feof($stream)) {
$writes->unshift([$data, $previous, $deferred]);
return;
if ($emptyWrites++ > self::MAX_CONSECUTIVE_EMPTY_WRITES) {
$message = "Failed to write to stream";
if ($error = \error_get_last()) {
$message .= \sprintf("; %s", $error["message"]);
}
throw new StreamException($message);
}
$resource = null;
$writable = false;
$message = "Failed to write to stream";
if ($error = \error_get_last()) {
$message .= \sprintf("; %s", $error["message"]);
}
$exception = new StreamException($message);
$deferred->fail($exception);
while (!$writes->isEmpty()) {
list(, , $deferred) = $writes->shift();
$deferred->fail($exception);
}
Loop::cancel($watcher);
$writes->unshift([$data, $previous, $deferred]);
return;
}
@ -112,6 +106,18 @@ final class ResourceOutputStream implements OutputStream {
$deferred->resolve($written + $previous);
}
} catch (\Throwable $exception) {
$resource = null;
$writable = false;
$exception = new StreamException("The stream was closed by the peer");
$deferred->fail($exception);
while (!$writes->isEmpty()) {
list(, , $deferred) = $writes->shift();
$deferred->fail($exception);
}
Loop::cancel($watcher);
} finally {
if ($writes->isEmpty()) {
Loop::disable($watcher);
@ -168,6 +174,10 @@ final class ResourceOutputStream implements OutputStream {
return new Success(0);
}
if (!\is_resource($this->resource) || @\feof($this->resource)) {
return new Failure(new StreamException("The stream was closed by the peer"));
}
// Error reporting suppressed since fwrite() emits E_WARNING if the pipe is broken or the buffer is full.
// Use conditional, because PHP doesn't like getting null passed.
if ($this->chunkSize) {

6
test/ResourceOutputStreamTest.php
View File

@ -39,7 +39,7 @@ class ResourceOutputStreamTest extends TestCase {
\fclose($b);
$this->expectException(StreamException::class);
$this->expectExceptionMessage("Failed to write to stream; fwrite():");
$this->expectExceptionMessage("The stream was closed by the peer");
wait($stream->write("foobar"));
}
@ -54,7 +54,7 @@ class ResourceOutputStreamTest extends TestCase {
\fclose($b);
$this->expectException(StreamException::class);
$this->expectExceptionMessage("Failed to write to stream; fwrite():");
$this->expectExceptionMessage("The stream was closed by the peer");
// The first write still succeeds somehow...
wait($stream->write("foobar"));
@ -81,7 +81,7 @@ class ResourceOutputStreamTest extends TestCase {
\fclose($b);
$this->expectException(StreamException::class);
$this->expectExceptionMessage("Failed to write to stream; fwrite():");
$this->expectExceptionMessage("The stream was closed by the peer");
try {
// The first write still succeeds somehow...