Add a log middleware

Author: phpbg

composer.json

@@ -28,6 +28,7 @@
     }
   },
   "require-dev": {
-    "phpunit/phpunit": "^6.5"
+    "phpunit/phpunit": "^6.5",
+    "mockery/mockery": "^1.2"
   }
 }

composer.lock

@@ -41,6 +41,7 @@ This is almost the same example as the previous one, but with a more flexible an
 `phpbg/rtsp` comes with some handy middlewares that will help you build a rfc compliant application:
 * `AutoCseq`: automatically add cseq header to your responses
 * `AutoContentLength`: automatically add content-length to your responses
+* `Log`: Automatically log request and responses
 
 ```php
 require __DIR__ . '/../vendor/autoload.php';
@@ -51,22 +52,7 @@ $loop = React\EventLoop\Factory::create();
 $socket = new \React\Socket\TcpServer('tcp://0.0.0.0:5540', $loop);
 
 $middlewares = [
-    function (\PhpBg\Rtsp\Message\Request $request, \React\Socket\ConnectionInterface $connection, $next) {
-        // echo request middleware
-        echo $request;
-        return $next($request, $connection);
-    },
-    function (\PhpBg\Rtsp\Message\Request $request, \React\Socket\ConnectionInterface $connection, $next) {
-        // echo response middleware
-        $response = $next($request, $connection);
-        if (!($response instanceof \React\Promise\PromiseInterface)) {
-            $response = new \React\Promise\FulfilledPromise($response);
-        }
-        return $response->then(function($resolvedResponse) {
-            echo $resolvedResponse."\r\n";
-            return $resolvedResponse;
-        });
-    },
+    new \PhpBg\Rtsp\Middleware\Log(),
     new \PhpBg\Rtsp\Middleware\AutoCseq(),
     new \PhpBg\Rtsp\Middleware\AutoContentLength(),
     function (\PhpBg\Rtsp\Message\Request $request, \React\Socket\ConnectionInterface $connection) {

readme.md

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2018 Samuel CHEMLA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace PhpBg\Rtsp\Middleware;
+
+use PhpBg\Rtsp\Message\Request;
+use PhpBg\Rtsp\Message\Response;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+use React\Promise\FulfilledPromise;
+use React\Promise\PromiseInterface;
+use React\Socket\ConnectionInterface;
+
+/**
+ * Middleware that log requests and responses
+ */
+class Log
+{
+
+    private $logger;
+    private $level;
+
+    public function __construct(LoggerInterface $logger, $level = LogLevel::DEBUG)
+    {
+        $this->logger = $logger;
+        $this->level = $level;
+    }
+
+    /**
+     * This middleware just looks like a standard middleware: invokable, receive request and return response
+     *
+     * @param Request $request
+     * @param ConnectionInterface $connection
+     * @param callable $next
+     * @return Response|PromiseInterface
+     */
+    public function __invoke(Request $request, ConnectionInterface $connection, callable $next)
+    {
+        $this->logger->log($this->level, "Request:\r\n$request");
+        $response = $next($request, $connection);
+        if (!($response instanceof PromiseInterface)) {
+            $response = new FulfilledPromise($response);
+        }
+        return $response->then(function (Response $resolvedResponse) use ($request) {
+            $this->logger->log($this->level, "Response:\r\n$resolvedResponse");
+            return $resolvedResponse;
+        });
+    }
+}

src/Middleware/Log.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2018 Samuel CHEMLA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace PhpBg\Rtsp\Tests\Middleware;
+
+use Mockery\Adapter\Phpunit\MockeryTestCase;
+use PhpBg\Rtsp\Message\Request;
+use PhpBg\Rtsp\Message\Response;
+use PhpBg\Rtsp\Middleware\Log;
+use PhpBg\Rtsp\Tests\ConnectionStub;
+use PhpBg\Rtsp\Tests\Mock\EmptyResponseMiddleware;
+use PhpBg\Rtsp\Tests\Mock\ParametrizedResponseMiddleware;
+use Psr\Log\LoggerInterface;
+use React\Promise\PromiseInterface;
+
+class LogTest extends MockeryTestCase
+{
+    public function testAddHeader() {
+        $logger = \Mockery::spy(LoggerInterface::class);
+        $middleware = new Log($logger);
+
+        $request = new Request();
+
+        /** @var PromiseInterface $response */
+        $response = $middleware($request, new ConnectionStub(), new ParametrizedResponseMiddleware());
+        $extractedResponse = null;
+        $response->then(function(Response $response) use (&$extractedResponse) {
+            // We expect a FullFilledPromise that resolve instantly,
+            // so extracting response and making assertions outside of callback secure them
+            $extractedResponse = $response;
+        });
+        $this->assertTrue($extractedResponse instanceof Response);
+        $logger->shouldHaveReceived('log')->twice();
+    }
+}