Skip to content

Commit 658ca68

Browse files
clueclue
committed
Optimize handling empty requst body
1 parent 16bd920 commit 658ca68

4 files changed

Lines changed: 315 additions & 8 deletions

File tree

‎src/Io/EmptyBodyStream.php‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
<?php
2+
3+
namespace React\Http\Io;
4+
5+
use Evenement\EventEmitter;
6+
use Psr\Http\Message\StreamInterface;
7+
use React\Stream\ReadableStreamInterface;
8+
use React\Stream\Util;
9+
use React\Stream\WritableStreamInterface;
10+
11+
/**
12+
* [Internal] Bridge between an empty StreamInterface from PSR-7 and ReadableStreamInterface from ReactPHP
13+
*
14+
* This class is used in the server to represent an empty body stream of an
15+
* incoming response from the client. This is similar to the `HttpBodyStream`,
16+
* but is specifically designed for the common case of having an empty message
17+
* body.
18+
*
19+
* Note that this is an internal class only and nothing you should usually care
20+
* about. See the `StreamInterface` and `ReadableStreamInterface` for more
21+
* details.
22+
*
23+
* @see HttpBodyStream
24+
* @see StreamInterface
25+
* @see ReadableStreamInterface
26+
* @internal
27+
*/
28+
class EmptyBodyStream extends EventEmitter implements StreamInterface, ReadableStreamInterface
29+
{
30+
private $closed = false;
31+
32+
public function isReadable()
33+
{
34+
return !$this->closed;
35+
}
36+
37+
public function pause()
38+
{
39+
// NOOP
40+
}
41+
42+
public function resume()
43+
{
44+
// NOOP
45+
}
46+
47+
public function pipe(WritableStreamInterface $dest, array $options = array())
48+
{
49+
Util::pipe($this, $dest, $options);
50+
51+
return $dest;
52+
}
53+
54+
public function close()
55+
{
56+
if ($this->closed) {
57+
return;
58+
}
59+
60+
$this->closed = true;
61+
62+
$this->emit('close');
63+
$this->removeAllListeners();
64+
}
65+
66+
public function getSize()
67+
{
68+
return 0;
69+
}
70+
71+
/** @ignore */
72+
public function __toString()
73+
{
74+
return '';
75+
}
76+
77+
/** @ignore */
78+
public function detach()
79+
{
80+
return null;
81+
}
82+
83+
/** @ignore */
84+
public function tell()
85+
{
86+
throw new \BadMethodCallException();
87+
}
88+
89+
/** @ignore */
90+
public function eof()
91+
{
92+
throw new \BadMethodCallException();
93+
}
94+
95+
/** @ignore */
96+
public function isSeekable()
97+
{
98+
return false;
99+
}
100+
101+
/** @ignore */
102+
public function seek($offset, $whence = SEEK_SET)
103+
{
104+
throw new \BadMethodCallException();
105+
}
106+
107+
/** @ignore */
108+
public function rewind()
109+
{
110+
throw new \BadMethodCallException();
111+
}
112+
113+
/** @ignore */
114+
public function isWritable()
115+
{
116+
return false;
117+
}
118+
119+
/** @ignore */
120+
public function write($string)
121+
{
122+
throw new \BadMethodCallException();
123+
}
124+
125+
/** @ignore */
126+
public function read($length)
127+
{
128+
throw new \BadMethodCallException();
129+
}
130+
131+
/** @ignore */
132+
public function getContents()
133+
{
134+
return '';
135+
}
136+
137+
/** @ignore */
138+
public function getMetadata($key = null)
139+
{
140+
return ($key === null) ? array() : null;
141+
}
142+
}

‎src/Io/RequestHeaderParser.php‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,28 @@ public function handle(ConnectionInterface $conn)
7070
}
7171

7272
$contentLength = 0;
73-
$stream = new CloseProtectionStream($conn);
7473
if ($request->hasHeader('Transfer-Encoding')) {
7574
$contentLength = null;
76-
$stream = new ChunkedDecoder($stream);
7775
} elseif ($request->hasHeader('Content-Length')) {
7876
$contentLength = (int)$request->getHeaderLine('Content-Length');
7977
}
8078

81-
if ($contentLength !== null) {
82-
$stream = new LengthLimitedStream($stream, $contentLength);
79+
if ($contentLength === 0) {
80+
// happy path: request body is known to be empty
81+
$stream = new EmptyBodyStream();
82+
$request = $request->withBody($stream);
83+
} else {
84+
// otherwise body is present => delimit using Content-Length or ChunkedDecoder
85+
$stream = new CloseProtectionStream($conn);
86+
if ($contentLength !== null) {
87+
$stream = new LengthLimitedStream($stream, $contentLength);
88+
} else {
89+
$stream = new ChunkedDecoder($stream);
90+
}
91+
92+
$request = $request->withBody(new HttpBodyStream($stream, $contentLength));
8393
}
8494

85-
$request = $request->withBody(new HttpBodyStream($stream, $contentLength));
86-
8795
$bodyBuffer = isset($buffer[$endOfHeader + 4]) ? \substr($buffer, $endOfHeader + 4) : '';
8896
$buffer = '';
8997
$that->emit('headers', array($request, $conn));
@@ -160,7 +168,7 @@ public function parseRequest($headers, $remoteSocketUri, $localSocketUri)
160168

161169
// apply SERVER_ADDR and SERVER_PORT if server address is known
162170
// address should always be known, even for Unix domain sockets (UDS)
163-
// but skip UDS as it doesn't have a concept of host/port.s
171+
// but skip UDS as it doesn't have a concept of host/port.
164172
if ($localSocketUri !== null) {
165173
$localAddress = \parse_url($localSocketUri);
166174
if (isset($localAddress['host'], $localAddress['port'])) {

‎tests/Io/EmptyBodyStreamTest.php‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
<?php
2+
3+
namespace React\Tests\Http\Io;
4+
5+
use React\Http\Io\EmptyBodyStream;
6+
use React\Tests\Http\TestCase;
7+
8+
class EmptyBodyStreamTest extends TestCase
9+
{
10+
private $input;
11+
private $bodyStream;
12+
13+
public function setUp()
14+
{
15+
$this->bodyStream = new EmptyBodyStream();
16+
}
17+
18+
/**
19+
* @doesNotPerformAssertions
20+
*/
21+
public function testPauseIsNoop()
22+
{
23+
$this->bodyStream->pause();
24+
}
25+
26+
/**
27+
* @doesNotPerformAssertions
28+
*/
29+
public function testResumeIsNoop()
30+
{
31+
$this->bodyStream->resume();
32+
}
33+
34+
public function testPipeStreamReturnsDestinationStream()
35+
{
36+
$dest = $this->getMockBuilder('React\Stream\WritableStreamInterface')->getMock();
37+
38+
$ret = $this->bodyStream->pipe($dest);
39+
40+
$this->assertSame($dest, $ret);
41+
}
42+
43+
public function testToStringReturnsEmptyString()
44+
{
45+
$this->assertEquals('', $this->bodyStream->__toString());
46+
}
47+
48+
public function testDetachReturnsNull()
49+
{
50+
$this->assertNull($this->bodyStream->detach());
51+
}
52+
53+
public function testGetSizeReturnsZero()
54+
{
55+
$this->assertSame(0, $this->bodyStream->getSize());
56+
}
57+
58+
public function testCloseTwiceEmitsCloseEventAndClearsListeners()
59+
{
60+
$this->bodyStream->on('close', $this->expectCallableOnce());
61+
62+
$this->bodyStream->close();
63+
$this->bodyStream->close();
64+
65+
$this->assertEquals(array(), $this->bodyStream->listeners('close'));
66+
}
67+
68+
/**
69+
* @expectedException BadMethodCallException
70+
*/
71+
public function testTell()
72+
{
73+
$this->bodyStream->tell();
74+
}
75+
76+
/**
77+
* @expectedException BadMethodCallException
78+
*/
79+
public function testEof()
80+
{
81+
$this->bodyStream->eof();
82+
}
83+
84+
public function testIsSeekable()
85+
{
86+
$this->assertFalse($this->bodyStream->isSeekable());
87+
}
88+
89+
/**
90+
* @expectedException BadMethodCallException
91+
*/
92+
public function testWrite()
93+
{
94+
$this->bodyStream->write('');
95+
}
96+
97+
/**
98+
* @expectedException BadMethodCallException
99+
*/
100+
public function testRead()
101+
{
102+
$this->bodyStream->read(1);
103+
}
104+
105+
public function testGetContentsReturnsEmpy()
106+
{
107+
$this->assertEquals('', $this->bodyStream->getContents());
108+
}
109+
110+
public function testGetMetaDataWithoutKeyReturnsEmptyArray()
111+
{
112+
$this->assertSame(array(), $this->bodyStream->getMetadata());
113+
}
114+
115+
public function testGetMetaDataWithKeyReturnsNull()
116+
{
117+
$this->assertNull($this->bodyStream->getMetadata('anything'));
118+
}
119+
120+
public function testIsReadableReturnsTrueWhenNotClosed()
121+
{
122+
$this->assertTrue($this->bodyStream->isReadable());
123+
}
124+
125+
public function testIsReadableReturnsFalseWhenAlreadyClosed()
126+
{
127+
$this->bodyStream->close();
128+
129+
$this->assertFalse($this->bodyStream->isReadable());
130+
}
131+
132+
/**
133+
* @expectedException BadMethodCallException
134+
*/
135+
public function testSeek()
136+
{
137+
$this->bodyStream->seek('');
138+
}
139+
140+
/**
141+
* @expectedException BadMethodCallException
142+
*/
143+
public function testRewind()
144+
{
145+
$this->bodyStream->rewind();
146+
}
147+
148+
public function testIsWriteable()
149+
{
150+
$this->assertFalse($this->bodyStream->isWritable());
151+
}
152+
}

‎tests/StreamingServerTest.php‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,12 @@ public function testRequestResumeWillBeForwardedToConnection()
528528
$server->listen($this->socket);
529529
$this->socket->emit('connection', array($this->connection));
530530

531-
$data = $this->createGetRequest();
531+
$data = "GET / HTTP/1.1\r\n";
532+
$data .= "Host: example.com:80\r\n";
533+
$data .= "Connection: close\r\n";
534+
$data .= "Content-Length: 5\r\n";
535+
$data .= "\r\n";
536+
532537
$this->connection->emit('data', array($data));
533538
}
534539

0 commit comments

Comments
 (0)