atk4 · mvorisek · Nov 27, 2021 · Nov 27, 2021 · Nov 27, 2021 · Nov 27, 2021
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -2056,9 +2056,6 @@ parameters:
         -
             path: 'src/Wizard.php'
             message: '~^Method Atk4\\Ui\\Wizard::addFinish\(\) has no return type specified\.$~'
-        -
-            path: 'tests/AppTest.php'
-            message: '~^Method Atk4\\Ui\\Tests\\AppTest::getApp\(\) has no return type specified\.$~'
         -
             path: 'tests/CallbackTest.php'
             message: '~^Property Atk4\\Ui\\Tests\\CallbackTest::\$var has no type specified\.$~'
@@ -2080,9 +2077,6 @@ parameters:
         -
             path: 'tests/DemosTest.php'
             message: '~^Strict comparison using \!\=\= between bool and null will always evaluate to true\.$~'
-        -
-            path: 'tests/ExecutorFactoryTest.php'
-            message: '~^Method Atk4\\Ui\\Tests\\ExecutorFactoryTest::getApp\(\) has no return type specified\.$~'
         -
             path: 'tests/PaginatorTest.php'
             message: '~^Property Atk4\\Ui\\Tests\\PaginatorTest::\$p has no type specified\.$~'

diff --git a/src/App.php b/src/App.php
@@ -14,6 +14,7 @@
 use Atk4\Core\WarnDynamicPropertyTrait;
 use Atk4\Data\Persistence;
 use Atk4\Ui\Exception\ExitApplicationError;
+use Atk4\Ui\Exception\LateOutputError;
 use Atk4\Ui\Exception\UnhandledCallbackExceptionError;
 use Atk4\Ui\Panel\Right;
 use Atk4\Ui\Persistence\Ui as UiPersistence;
@@ -298,6 +299,10 @@ public function callExit(): void
      */
     public function caughtException(\Throwable $exception): void
     {
+        if ($exception instanceof LateOutputError) {
+            $this->outputLateOutputError($exception);
+        }
+
         while ($exception instanceof UnhandledCallbackExceptionError) {
             $exception = $exception->getPrevious();
         }
@@ -1051,40 +1056,16 @@ function () {
 
     // RESPONSES
 
-    /** @var string[] */
-    private static $_sentHeaders = [];
-
     /**
-     * Output Response to the client.
+     * This can be overridden for future PSR-7 implementation.
      *
-     * This can be overridden for future PSR-7 implementation
+     * @internal should be called only from self::outputResponse()
      */
-    protected function outputResponse(string $data, array $headers): void
+    protected function outputResponseUnsafe(string $data, array $headersNew): void
     {
-        $this->response_headers = $this->normalizeHeaders($this->response_headers);
-        $headersAll = array_merge($this->response_headers, $this->normalizeHeaders($headers));
-        $headersNew = array_diff_assoc($headersAll, self::$_sentHeaders);
-
         $isCli = \PHP_SAPI === 'cli'; // for phpunit
 
-        $lateError = null;
-        foreach (ob_get_status(true) as $status) {
-            if ($status['buffer_used'] !== 0 && !$isCli) {
-                $lateError = 'Unexpected output detected.';
-
-                break;
-            }
-        }
-
-        if ($lateError === null && count($headersNew) > 0 && headers_sent() && !$isCli) {
-            $lateError = 'Headers already sent, more headers cannot be set at this stage.';
-        }
-
         if (!headers_sent() || $isCli) {
-            if ($lateError !== null) {
-                $headersNew = ['content-type' => 'text/plain', self::HEADER_STATUS_CODE => '500'];
-            }
-
             foreach ($headersNew as $k => $v) {
                 if (!$isCli) {
                     if ($k === self::HEADER_STATUS_CODE) {
@@ -1097,18 +1078,63 @@ protected function outputResponse(string $data, array $headers): void
                         header($kCamelCase . ': ' . $v);
                     }
                }
+            }
+        }
+
+        echo $data;
+    }
+
+    /** @var string[] */
+    private static $_sentHeaders = [];
+
+    /**
+     * Output Response to the client.
+     */
+    protected function outputResponse(string $data, array $headers): void
+    {
+        $this->response_headers = $this->normalizeHeaders($this->response_headers);
+        $headersAll = array_merge($this->response_headers, $this->normalizeHeaders($headers));
+        unset($headers);
+        $headersNew = array_diff_assoc($headersAll, self::$_sentHeaders);
+        unset($headersAll);
 
-                self::$_sentHeaders[$k] = $v;
+        foreach (ob_get_status(true) as $status) {
+            if ($status['buffer_used'] !== 0) {
+                throw new LateOutputError('Unexpected output detected');
             }
         }
 
-        if ($lateError !== null) {
-            echo "\n" . '!! FATAL UI ERROR: ' . $lateError . ' !!' . "\n";
+        $isCli = \PHP_SAPI === 'cli'; // for phpunit
 
-            exit(1);
+        if (count($headersNew) > 0 && headers_sent() && !$isCli) {
+            throw new LateOutputError('Headers already sent, more headers cannot be set at this stage');
         }
 
-        echo $data;
+        foreach ($headersNew as $k => $v) {
+            self::$_sentHeaders[$k] = $v;
+        }
+
+        $this->outputResponseUnsafe($data, $headersNew);
+    }
+
+    /**
+     * @return never
+     */
+    protected function outputLateOutputError(LateOutputError $exception): void
+    {
+        $plainTextMessage = "\n" . '!! FATAL UI ERROR: ' . $exception->getMessage() . ' !!' . "\n";
+
+        $headersAll = $this->normalizeHeaders(['content-type' => 'text/plain', self::HEADER_STATUS_CODE => '500']);
+        $headersNew = array_diff_assoc($headersAll, self::$_sentHeaders);
+        unset($headersAll);
+
+        foreach ($headersNew as $k => $v) {
+            self::$_sentHeaders[$k] = $v;
+        }
+
+        $this->outputResponseUnsafe($plainTextMessage, $headersNew);
+
+        exit(1); // should be never reached from phpunit because we set catch_exceptions = false
     }
 
     /**

diff --git a/src/Exception/LateOutputError.php b/src/Exception/LateOutputError.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atk4\Ui\Exception;
+
+/**
+ * @internal
+ */
+final class LateOutputError extends \Error
+{
+}
diff --git a/tests/AppTest.php b/tests/AppTest.php
@@ -6,11 +6,12 @@
 
 use Atk4\Core\Phpunit\TestCase;
 use Atk4\Ui\App;
+use Atk4\Ui\Exception\LateOutputError;
 use Atk4\Ui\HtmlTemplate;
 
 class AppTest extends TestCase
 {
-    protected function getApp()
+    protected function getApp(): App
     {
         return new App([
             'catch_exceptions' => false,
@@ -41,4 +42,22 @@ public function testTemplateClassCustom(): void
             $app->loadTemplate('html.html')
         );
     }
+
+    public function testUnexpectedOutputLateError(): void
+    {
+        $app = $this->getApp();
+
+        ob_start();
+        $testStr = 'direct output test';
+        try {
+            echo $testStr;
+
+            $this->expectException(LateOutputError::class);
+            $this->expectExceptionMessage('Unexpected output detected');
+            $app->terminateHtml('');
+        } finally {
+            $this->assertSame($testStr, ob_get_contents());
+            ob_end_clean();
+        }
+    }
 }
diff --git a/tests/ExecutorFactoryTest.php b/tests/ExecutorFactoryTest.php
@@ -51,7 +51,7 @@ protected function setUp(): void
         $this->app->initLayout([\Atk4\Ui\Layout\Admin::class]);
     }
 
-    protected function getApp()
+    protected function getApp(): App
     {
         return new App([
             'catch_exceptions' => false,