fix: output buffering

Author: iRedds

system/CodeIgniter.php

@@ -36,6 +36,7 @@
 use Kint\Renderer\RichRenderer;
 use Locale;
 use LogicException;
+use Throwable;
 
 /**
  * This class is the core of the framework, and will analyse the
@@ -164,6 +165,11 @@ class CodeIgniter
      */
     protected bool $returnResponse = false;
 
+    /**
+     * Application output buffering level
+     */
+    protected int $bufferLevel;
+
     /**
      * Constructor.
      */
@@ -367,6 +373,7 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
         try {
             return $this->handleRequest($routes, $cacheConfig, $returnResponse);
         } catch (RedirectException $e) {
+            $this->outputBufferingEnd();
             $logger = Services::logger();
             $logger->info('REDIRECTED ROUTE at ' . $e->getMessage());
 
@@ -389,6 +396,10 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
             if ($return instanceof ResponseInterface) {
                 return $return;
             }
+        } catch (Throwable $e) {
+            $this->outputBufferingEnd();
+
+            throw $e;
         }
     }
 
@@ -810,7 +821,7 @@ protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
         $this->benchmark->stop('bootstrap');
         $this->benchmark->start('routing');
 
-        ob_start();
+        $this->outputBufferingStart();
 
         $this->controller = $this->router->handle($path);
         $this->method     = $this->router->methodName();
@@ -979,15 +990,8 @@ protected function display404errors(PageNotFoundException $e)
         // Display 404 Errors
         $this->response->setStatusCode($e->getCode());
 
-        if (ENVIRONMENT !== 'testing') {
-            if (ob_get_level() > 0) {
-                ob_end_flush(); // @codeCoverageIgnore
-            }
-        }
-        // When testing, one is for phpunit, another is for test case.
-        elseif (ob_get_level() > 2) {
-            ob_end_flush(); // @codeCoverageIgnore
-        }
+        echo $this->outputBufferingEnd();
+        flush();
 
         // Throws new PageNotFoundException and remove exception message on production.
         throw PageNotFoundException::forPageNotFound(
@@ -1006,21 +1010,9 @@ protected function display404errors(PageNotFoundException $e)
      */
     protected function gatherOutput(?Cache $cacheConfig = null, $returned = null)
     {
-        $this->output = ob_get_contents();
-        // If buffering is not null.
-        // Clean (erase) the output buffer and turn off output buffering
-        if (ob_get_length()) {
-            ob_end_clean();
-        }
+        $this->output = $this->outputBufferingEnd();
 
         if ($returned instanceof DownloadResponse) {
-            // Turn off output buffering completely, even if php.ini output_buffering is not off
-            if (ENVIRONMENT !== 'testing') {
-                while (ob_get_level() > 0) {
-                    ob_end_clean();
-                }
-            }
-
             $this->response = $returned;
 
             return;
@@ -1150,4 +1142,22 @@ public function setContext(string $context)
 
         return $this;
     }
+
+    protected function outputBufferingStart(): void
+    {
+        $this->bufferLevel = ob_get_level();
+        ob_start();
+    }
+
+    protected function outputBufferingEnd(): string
+    {
+        $buffer = '';
+
+        while (ob_get_level() > $this->bufferLevel) {
+            $buffer = ob_get_contents();
+            ob_end_clean();
+        }
+
+        return $buffer;
+    }
 }

system/Debug/BaseExceptionHandler.php

@@ -215,10 +215,6 @@ protected function render(Throwable $exception, int $statusCode, $viewFile = nul
             exit(1);
         }
 
-        if (ob_get_level() > $this->obLevel + 1) {
-            ob_end_clean();
-        }
-
         echo(function () use ($exception, $statusCode, $viewFile): string {
             $vars = $this->collectVars($exception, $statusCode);
             extract($vars, EXTR_SKIP);

system/Debug/Exceptions.php

@@ -296,10 +296,6 @@ protected function render(Throwable $exception, int $statusCode)
             exit(1);
         }
 
-        if (ob_get_level() > $this->ob_level + 1) {
-            ob_end_clean();
-        }
-
         echo(function () use ($exception, $statusCode, $viewFile): string {
             $vars = $this->collectVars($exception, $statusCode);
             extract($vars, EXTR_SKIP);

tests/system/CodeIgniterTest.php

@@ -54,10 +54,6 @@ protected function tearDown(): void
     {
         parent::tearDown();
 
-        if (ob_get_level() > 1) {
-            ob_end_clean();
-        }
-
         $this->resetServices();
     }
 
@@ -73,6 +69,16 @@ public function testRunEmptyDefaultRoute()
         $this->assertStringContainsString('Welcome to CodeIgniter', $output);
     }
 
+    public function testOutputBufferingControl()
+    {
+        ob_start();
+        $this->codeigniter->run();
+        ob_get_clean();
+
+        // 1 phpunit output buffering level
+        $this->assertSame(1, ob_get_level());
+    }
+
     public function testRunEmptyDefaultRouteReturnResponse()
     {
         $_SERVER['argv'] = ['index.php'];
@@ -828,10 +834,6 @@ public function testPageCacheWithCacheQueryString(
             $output = ob_get_clean();
 
             $this->assertSame($string, $output);
-
-            if (ob_get_level() > 1) {
-                ob_end_clean();
-            }
         }
 
         // Calculate how much cached items exist in the cache after the test requests

user_guide_src/source/changelogs/v4.4.0.rst

@@ -142,6 +142,8 @@ Deprecations
 Bugs Fixed
 **********
 
+- **Output Buffering:** Bug fix with output buffering.
+
 See the repo's
 `CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
 for a complete list of bugs fixed.