Streaming body parsers foundation

README.md

@@ -35,3 +35,31 @@ $loop->run();
 ```
 
 See also the [examples](examples).
+
+## Request body parsing example
+
+As of `v0.5` `react/http` supports request body parsing and comes with a handy factory:
+
+```php
+$loop = React\EventLoop\Factory::create();
+$socket = new React\Socket\Server($loop);
+
+$http = new React\Http\Server($socket);
+$http->on('request', function ($request, $response) {
+    $parser = React\Http\StreamingBodyParser\Factory::create($request);
+    $parser->on('body', function ($bodyString) {});
+    $parser->on('post', function ($fieldName, $fileValue) {});
+    $parser->on('file', function ($fieldName, $fileObject) {});
+    $parser->on('end', function () use ($response) {
+        $response->writeHead(200, array('Content-Type' => 'text/plain'));
+        $response->end("Hello World!\n");
+    });
+});
+
+$socket->listen(1337);
+$loop->run();
+```
+
+### Current supported request body parsers
+
+* RawBodyParser - Emit raw body chunks as they come in, no parsing for `post` or `file`. This is the default parser.

src/StreamingBodyParser/Factory.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace React\Http\StreamingBodyParser;
+
+use React\Http\Request;
+
+class Factory
+{
+    /**
+     * Creates the most suitable streaming body parser for the given request.
+     * It can return the following parsers:
+     *   * RawBodyParser - Emit raw body chunks as they come in. This is the default parser.
+     *
+     * @param Request $request
+     * @return ParserInterface
+     */
+    public static function create(Request $request)
+    {
+        return new RawBodyParser($request);
+    }
+}

src/StreamingBodyParser/ParserInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace React\Http\StreamingBodyParser;
+
+use Evenement\EventEmitterInterface;
+use React\Http\Request;
+
+/**
+ * Parser can emit the following events:
+ *     end - When done or canceled (required)
+ *     body - Raw request body chunks as they come in, with $bodyString as argument (optional)
+ *     post - Post field, with $filedName, $fieldValue as arguments (optional)
+ *     file - Uploaded file with $filedName, $fileObject as arguments (optional)
+ */
+interface ParserInterface extends EventEmitterInterface
+{
+    /**
+     * Cancel parsing the request body stream.
+     * Parser will still emit end event to any listeners.
+     *
+     * @return void
+     */
+    public function cancel();
+}

src/StreamingBodyParser/RawBodyParser.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace React\Http\StreamingBodyParser;
+
+use Evenement\EventEmitterTrait;
+use InvalidArgumentException;
+use React\Http\Request;
+use React\Promise\ExtendedPromiseInterface;
+
+/**
+ * @internal
+ */
+final class RawBodyParser implements ParserInterface
+{
+    use EventEmitterTrait;
+
+    /**
+     * @var Request
+     */
+    private $request;
+
+    /**
+     * @param Request $request
+     */
+    public function __construct(Request $request)
+    {
+        $this->request = $request;
+        $this->request->on('data', [$this, 'body']);
+        $this->request->on('end', [$this, 'end']);
+    }
+
+    /**
+     * @param string $data
+     *
+     * @internal
+     */
+    public function body($data)
+    {
+        $this->emit('body', [$data]);
+    }
+
+    /**
+     * @internal
+     */
+    public function end()
+    {
+        $this->emit('end');
+    }
+
+    /**
+     * Cancel 'parsing' the request body
+     */
+    public function cancel()
+    {
+        $this->request->removeListener('data', [$this, 'body']);
+        $this->request->removeListener('end', [$this, 'end']);
+        $this->emit('end');
+    }
+}

tests/StreamingBodyParser/FactoryTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace React\Tests\Http\StreamingBodyParser;
+
+use React\Http\StreamingBodyParser\Factory;
+use React\Http\Request;
+use React\Tests\Http\TestCase;
+
+class FactoryTest extends TestCase
+{
+    public function testContentLength()
+    {
+        $request = new Request('POST', 'http://example.com/', [], 1.1, [
+            'content-length' => 123,
+        ]);
+        $parser = Factory::create($request);
+        $this->assertInstanceOf('React\Http\StreamingBodyParser\RawBodyParser', $parser);
+    }
+
+    public function testNoHeaders()
+    {
+        $request = new Request('POST', 'http://example.com/');
+        $parser = Factory::create($request);
+        $this->assertInstanceOf('React\Http\StreamingBodyParser\RawBodyParser', $parser);
+    }
+}

tests/StreamingBodyParser/RawBodyParserTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace React\Tests\Http\StreamingBodyParser;
+
+use React\Http\StreamingBodyParser\RawBodyParser;
+use React\Http\Request;
+use React\Tests\Http\TestCase;
+
+class RawBodyParserTest extends TestCase
+{
+    public function testNoBufferingLength()
+    {
+        $body = '';
+        $request = new Request('POST', 'http://example.com/', [], 1.1, [
+            'content-length' => 3,
+        ]);
+        $parser = new RawBodyParser($request);
+        $parser->on('end', $this->expectCallableNever());
+        $parser->on('body', function ($rawBody) use (&$body) {
+            $body = $rawBody;
+        });
+        $request->emit('data', ['abc']);
+        $this->assertSame('abc', $body);
+        $request->emit('data', ['def']);
+        $this->assertSame('def', $body);
+    }
+
+    public function testEndForward()
+    {
+        $request = new Request('POST', 'http://example.com/');
+        $parser = new RawBodyParser($request);
+        $parser->on('end', $this->expectCallableOnce());
+        $parser->on('body', $this->expectCallableNever());
+        $request->emit('end');
+    }
+
+    public function testEndOnCancel()
+    {
+        $request = new Request('POST', 'http://example.com/');
+        $parser = new RawBodyParser($request);
+        $parser->on('end', $this->expectCallableOnce());
+        $parser->on('body', $this->expectCallableNever());
+        $parser->cancel();
+    }
+}