Skip to content

Fix forward compatibility with upcoming EventLoop releases #121

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

Merged
merged 2 commits into from
Nov 10, 2017
Merged

Fix forward compatibility with upcoming EventLoop releases #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56f3100
Replace internal removeStream() with removeReadStream()
clue Nov 10, 2017
cf4ace0
Only remove stream from loop if it was actually added
clue Nov 10, 2017
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
23 changes: 11 additions & 12 deletions src/DuplexResourceStream.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ final class DuplexResourceStream extends EventEmitter implements DuplexStreamInt
private $readable = true;
private $writable = true;
private $closing = false;
private $listening = false;

public function __construct($stream, LoopInterface $loop, $readChunkSize = null, WritableStreamInterface $buffer = null)
{
Expand Down Expand Up @@ -100,13 +101,17 @@ public function isWritable()

public function pause()
{
$this->loop->removeReadStream($this->stream);
if ($this->listening) {
$this->loop->removeReadStream($this->stream);
$this->listening = false;
}
}

public function resume()
{
if ($this->readable) {
if (!$this->listening && $this->readable) {
$this->loop->addReadStream($this->stream, array($this, 'handleData'));
$this->listening = true;
}
}

Expand All @@ -131,11 +136,13 @@ public function close()
$this->writable = false;

$this->emit('close');
$this->loop->removeStream($this->stream);
$this->pause();
$this->buffer->close();
$this->removeAllListeners();

$this->handleClose();
if (is_resource($this->stream)) {
fclose($this->stream);
}
}

public function end($data = null)
Expand Down Expand Up @@ -191,14 +198,6 @@ public function handleData($stream)
}
}

/** @internal */
public function handleClose()
{
if (is_resource($this->stream)) {
fclose($this->stream);
}
}

/**
* Returns whether this is a pipe resource in a legacy environment
*
Expand Down
23 changes: 11 additions & 12 deletions src/ReadableResourceStream.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ final class ReadableResourceStream extends EventEmitter implements ReadableStrea
private $bufferSize;

private $closed = false;
private $listening = false;

public function __construct($stream, LoopInterface $loop, $readChunkSize = null)
{
Expand Down Expand Up @@ -81,13 +82,17 @@ public function isReadable()

public function pause()
{
$this->loop->removeReadStream($this->stream);
if ($this->listening) {
$this->loop->removeReadStream($this->stream);
$this->listening = false;
}
}

public function resume()
{
if (!$this->closed) {
if (!$this->listening && !$this->closed) {
$this->loop->addReadStream($this->stream, array($this, 'handleData'));
$this->listening = true;
}
}

Expand All @@ -105,10 +110,12 @@ public function close()
$this->closed = true;

$this->emit('close');
$this->loop->removeStream($this->stream);
$this->pause();
$this->removeAllListeners();

$this->handleClose();
if (is_resource($this->stream)) {
fclose($this->stream);
}
}

/** @internal */
Expand Down Expand Up @@ -144,14 +151,6 @@ public function handleData()
}
}

/** @internal */
public function handleClose()
{
if (is_resource($this->stream)) {
fclose($this->stream);
}
}

/**
* Returns whether this is a pipe resource in a legacy environment
*
Expand Down
75 changes: 74 additions & 1 deletion tests/DuplexResourceStreamTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,12 +242,85 @@ public function testEndRemovesReadStreamFromLoop()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('removeReadStream');
$loop->expects($this->once())->method('addReadStream')->with($stream);
$loop->expects($this->once())->method('removeReadStream')->with($stream);

$conn = new DuplexResourceStream($stream, $loop);
$conn->end('bye');
}

/**
* @covers React\Stream\DuplexResourceStream::pause
*/
public function testPauseRemovesReadStreamFromLoop()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);
$loop->expects($this->once())->method('removeReadStream')->with($stream);

$conn = new DuplexResourceStream($stream, $loop);
$conn->pause();
$conn->pause();
}

/**
* @covers React\Stream\DuplexResourceStream::pause
*/
public function testResumeDoesAddStreamToLoopOnlyOnce()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);

$conn = new DuplexResourceStream($stream, $loop);
$conn->resume();
$conn->resume();
}

/**
* @covers React\Stream\DuplexResourceStream::close
*/
public function testCloseRemovesReadStreamFromLoop()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);
$loop->expects($this->once())->method('removeReadStream')->with($stream);

$conn = new DuplexResourceStream($stream, $loop);
$conn->close();
}

/**
* @covers React\Stream\DuplexResourceStream::close
*/
public function testCloseAfterPauseRemovesReadStreamFromLoopOnlyOnce()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);
$loop->expects($this->once())->method('removeReadStream')->with($stream);

$conn = new DuplexResourceStream($stream, $loop);
$conn->pause();
$conn->close();
}

/**
* @covers React\Stream\DuplexResourceStream::close
*/
public function testResumeAfterCloseDoesAddReadStreamToLoopOnlyOnce()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);

$conn = new DuplexResourceStream($stream, $loop);
$conn->close();
$conn->resume();
}

public function testEndedStreamsShouldNotWrite()
{
$file = tempnam(sys_get_temp_dir(), 'reactphptest_');
Expand Down
72 changes: 72 additions & 0 deletions tests/ReadableResourceStreamTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,78 @@ public function testClosingStreamInDataEventShouldNotTriggerError()
$conn->handleData($stream);
}

/**
* @covers React\Stream\ReadableResourceStream::pause
*/
public function testPauseRemovesReadStreamFromLoop()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);
$loop->expects($this->once())->method('removeReadStream')->with($stream);

$conn = new ReadableResourceStream($stream, $loop);
$conn->pause();
$conn->pause();
}

/**
* @covers React\Stream\ReadableResourceStream::pause
*/
public function testResumeDoesAddStreamToLoopOnlyOnce()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);

$conn = new ReadableResourceStream($stream, $loop);
$conn->resume();
$conn->resume();
}

/**
* @covers React\Stream\ReadableResourceStream::close
*/
public function testCloseRemovesReadStreamFromLoop()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);
$loop->expects($this->once())->method('removeReadStream')->with($stream);

$conn = new ReadableResourceStream($stream, $loop);
$conn->close();
}

/**
* @covers React\Stream\ReadableResourceStream::close
*/
public function testCloseAfterPauseRemovesReadStreamFromLoopOnce()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);
$loop->expects($this->once())->method('removeReadStream')->with($stream);

$conn = new ReadableResourceStream($stream, $loop);
$conn->pause();
$conn->close();
}

/**
* @covers React\Stream\ReadableResourceStream::close
*/
public function testResumeAfterCloseDoesAddReadStreamToLoopOnlyOnce()
{
$stream = fopen('php://temp', 'r+');
$loop = $this->createLoopMock();
$loop->expects($this->once())->method('addReadStream')->with($stream);

$conn = new ReadableResourceStream($stream, $loop);
$conn->close();
$conn->resume();
}

/**
* @covers React\Stream\ReadableResourceStream::handleData
*/
Expand Down