[3.10] Clear buffered output at all levels

[zero-24]

Pull Request for Issue #18088

Summary of Changes

Add back the check to clear the buffered output. cc @SharkyKZ

Testing Instructions

Enter non-existing url in browser to trigger 404 page.

Actual result BEFORE applying this Pull Request

Default template error page should be displayed, as usual.

Expected result AFTER applying this Pull Request

Default template error page should be displayed, as usual.

Documentation Changes Required

None

[ethernidee]

The following code:

// Clear buffered output at all levels
$callerFunction = static::getCallerFunctionName();

if ($callerFunction === false)
{
  while (ob_get_level())
  {
    ob_end_clean();
  }
}

should be replaced with:

// Clear buffered output at all levels
while (ob_get_level())
{
  ob_end_clean();
}

[zero-24]

Ok will do when i'm back at my PC.

[zero-24]

Thanks @ethernidee this has just been commited to this PR.

[particthistle]

I have tested this item ✅ successfully on 0fda10a

Default template error page should be displayed, as expected.

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30786.}

[SharkyKZ]

Tests are failing.

[ethernidee]

1. JErrorPageTest::testEnsureTheErrorPageIsCorrectlyRendered
   Failed asserting that false matches expected '<title>500 - Testing JErrorPage::render() with RuntimeException</title>Testing JErrorPage::render() with RuntimeException'.

/drone/src/tests/unit/suites/libraries/cms/error/JErrorPageTest.php:79

2. JErrorPageTest::testEnsureTheErrorPageIsCorrectlyRenderedWithThrowables
   Failed asserting that false matches expected '<title>500 - Testing JErrorPage::render() with PHP 7 Error</title>Testing JErrorPage::render() with PHP 7 Error'.

/drone/src/tests/unit/suites/libraries/cms/error/JErrorPageTest.php:123

---

Such things cannot be tested if buffer is cleared properly. The tests are invalid, imho.

[zero-24]

Such things cannot be tested if buffer is cleared properly. The tests are invalid, imho.

What is the point of clearing the buffer there anyway?

[ethernidee]

Imagine you render Joomla module. First level of buffer capturing is on. Then in module template you write ob_start() for internal subwidget. If any error happens, Joomla will clear second level buffer and leave top of the default template rendered + will add error page html. This is totally wrong. All buffer levels should be cleared before rewriting the whole response, whether it's json or html response.

I faced such situations on working sites and was really surprised.

[zero-24]

Makes sense, thanks

[zero-24]

The latest commits make sure the test suite passes as it starts the output buffer right after we cleaded it again. Else that thing will fail as the output puffes is clreandend but not restarted.

[ethernidee]

Excellent solution!

[richard67]

Thanks!

[wilsonge]

@zero-24 I think this function can be removed now - it's not longer being called

[zero-24]

it could be used as its part of the API right? It can be removed with 4 i guess right?

[wilsonge]

It's a protected function and introduced in 3.10 - its only been in alpha's so far?

[zero-24]

Ah ok will do a PR to get rid of it.

[zero-24]

PR done: #32175