Replace addContentLengthHeader with ContentLength Middleware

CHANGELOG.md

@@ -5,6 +5,7 @@
 
 ### Added
 
+- [#2254](https://github.com/slimphp/Slim/pull/2254) Added Middleware\ContentLengthMiddleware
 - [#2166](https://github.com/slimphp/Slim/pull/2166) Added Middleware\OutputBufferingMiddleware
 
 ### Deprecated
@@ -13,6 +14,8 @@
 
 ### Removed
 
+- [#2254](https://github.com/slimphp/Slim/pull/2254) `addContentLengthHeader` setting is removed
+- [#2166](https://github.com/slimphp/Slim/pull/2166) `outputBuffering` setting is removed
 - [#2067](https://github.com/slimphp/Slim/pull/2067) Remove App::VERSION
 - [#2078](https://github.com/slimphp/Slim/pull/2078) Remove App::subRequest()
 - [#2098](https://github.com/slimphp/Slim/pull/2098) Remove CallableResolverTrait

Slim/App.php

@@ -82,7 +82,6 @@ class App
         'responseChunkSize' => 4096,
         'determineRouteBeforeAppMiddleware' => false,
         'displayErrorDetails' => false,
-        'addContentLengthHeader' => true,
         'routerCacheFile' => false,
     ];
 
@@ -808,18 +807,6 @@ protected function finalize(ResponseInterface $response)
             return $response->withoutHeader('Content-Type')->withoutHeader('Content-Length');
         }
 
-        // Add Content-Length header if `addContentLengthHeader` setting is set
-        if ($this->getSetting('addContentLengthHeader') == true) {
-            if (ob_get_length() > 0) {
-                throw new \RuntimeException("Unexpected data in output buffer. " .
-                    "Maybe you have characters before an opening <?php tag?");
-            }
-            $size = $response->getBody()->getSize();
-            if ($size !== null && !$response->hasHeader('Content-Length')) {
-                $response = $response->withHeader('Content-Length', (string) $size);
-            }
-        }
-
         return $response;
     }
 

Slim/Container.php

@@ -53,7 +53,6 @@ class Container extends PimpleContainer implements ContainerInterface
         'outputBuffering' => 'append',
         'determineRouteBeforeAppMiddleware' => false,
         'displayErrorDetails' => false,
-        'addContentLengthHeader' => true,
         'routerCacheFile' => false,
     ];
 

Slim/Middleware/ContentLengthMiddleware.php

@@ -0,0 +1,30 @@
+<?php
+namespace Slim\Middleware;
+
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Slim\Http\Body;
+
+class ContentLengthMiddleware
+{
+    /**
+     * Invoke
+     *
+     * @param  ServerRequestInterface $request   PSR7 server request
+     * @param  ResponseInterface      $response  PSR7 response
+     * @param  callable               $next      Middleware callable
+     * @return ResponseInterface                 PSR7 response
+     */
+    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
+    {
+        $response = $next($request, $response);
+
+        // Add Content-Length header if not already added
+        $size = $response->getBody()->getSize();
+        if ($size !== null && !$response->hasHeader('Content-Length')) {
+            $response = $response->withHeader('Content-Length', (string) $size);
+        }
+
+        return $response;
+    }
+}

UPGRADING.md

@@ -1,9 +1,11 @@
 # How to upgrade
 
+* [2254] - You need to add the `Middleware\ContentLengthMiddleware` middleware if you want Slim to add the Content-Length header this automatically.
 * [2166] - You need to add the `Middleware\OutputBufferingMiddleware` middleware to capture echo'd or var_dump'd output from your code.
 * [2098] - You need to add the App's router to the container for a straight upgrade. If you've created your own router factory in the container though, then you need to set it into the $app.
 * [2102] - You must inject custom route invocation strategy with `$app->getRouter()->setDefaultInvocationStrategy($myStrategy)`
 
+[2254]: https://github.com/slimphp/Slim/pull/2254
 [2166]: https://github.com/slimphp/Slim/pull/2166
 [2098]: https://github.com/slimphp/Slim/pull/2098
 [2102]: https://github.com/slimphp/Slim/pull/2102

tests/AppTest.php

@@ -79,14 +79,14 @@ public function testAddSettings()
     {
         $app = new App();
         $app->addSettings(['foo' => 'bar']);
-        $this->assertAttributeContains('foo', 'settings', $app);
+        $this->assertAttributeContains('bar', 'settings', $app);
     }
 
     public function testAddSetting()
     {
         $app = new App();
         $app->addSetting('foo', 'bar');
-        $this->assertAttributeContains('foo', 'settings', $app);
+        $this->assertAttributeContains('bar', 'settings', $app);
     }
 
     /********************************************************************************
@@ -1953,11 +1953,11 @@ public function testFinalize()
 
         $response = new Response();
         $response->getBody()->write('foo');
+        $response = $response->withHeader('Content-Type', 'text/plain');
 
         $response = $method->invoke(new App(), $response);
 
-        $this->assertTrue($response->hasHeader('Content-Length'));
-        $this->assertEquals('3', $response->getHeaderLine('Content-Length'));
+        $this->assertTrue($response->hasHeader('Content-Type'));
     }
 
     public function testFinalizeWithoutBody()
@@ -2027,41 +2027,6 @@ public function testCallingAnUncallableContainerKeyThrows()
         $app->foo('bar');
     }
 
-    public function testOmittingContentLength()
-    {
-        $method = new \ReflectionMethod('Slim\App', 'finalize');
-        $method->setAccessible(true);
-
-        $response = new Response();
-        $response->getBody()->write('foo');
-
-        $app = new App();
-        $app->addSetting('addContentLengthHeader', false);
-        $response = $method->invoke($app, $response);
-
-        $this->assertFalse($response->hasHeader('Content-Length'));
-    }
-
-    /**
-     * @expectedException \RuntimeException
-     * @expectedExceptionMessage Unexpected data in output buffer
-     */
-    public function testForUnexpectedDataInOutputBuffer()
-    {
-        $this->expectOutputString('test'); // needed to avoid risky test warning
-        echo "test";
-        $method = new \ReflectionMethod('Slim\App', 'finalize');
-        $method->setAccessible(true);
-
-        $response = new Response();
-        $response->getBody()->write('foo');
-
-        $app = new App();
-        $container = $app->getContainer();
-        $container['settings']['addContentLengthHeader'] = true;
-        $response = $method->invoke($app, $response);
-    }
-
     public function testUnsupportedMethodWithoutRoute()
     {
         $app = new App();

tests/Middleware/ContentLengthMiddlewareTest.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Slim Framework (https://slimframework.com)
+ *
+ * @link      https://github.com/slimphp/Slim
+ * @copyright Copyright (c) 2011-2017 Josh Lockhart
+ * @license   https://github.com/slimphp/Slim/blob/3.x/LICENSE.md (MIT License)
+ */
+namespace Slim\Tests\Middleware;
+
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Slim\Http\Body;
+use Slim\Http\Headers;
+use Slim\Http\Request;
+use Slim\Http\Response;
+use Slim\Http\Uri;
+use Slim\Middleware\ContentLengthMiddleware;
+
+class ContentLengthMiddlewareTest extends TestCase
+{
+    public function testAddsContentLenght()
+    {
+        $mw = new ContentLengthMiddleware('append');
+
+        $uri = Uri::createFromString('https://example.com:443/foo/bar?abc=123');
+        $headers = new Headers();
+        $cookies = [];
+        $serverParams = [];
+        $body = new Body(fopen('php://temp', 'r+'));
+        $request = new Request('GET', $uri, $headers, $cookies, $serverParams, $body);
+        $response = new Response();
+
+        $next = function (ServerRequestInterface $req, ResponseInterface $res) {
+            $res->write('Body');
+            return $res;
+        };
+
+        $newResponse = $mw($request, $response, $next);
+
+        $this->assertEquals(4, $newResponse->getHeaderLine('Content-Length'));
+    }
+}