10000 [4] Include custom fatal page so that any post-processing, alerting, can happen as designed by PhilETaylor · Pull Request #35352 · joomla/joomla-cms · GitHub
[go: up one dir, main page]
Skip to content

[4] Include custom fatal page so that any post-processing, alerting, can happen as designed #35352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 24, 2021
Merged

[4] Include custom fatal page so that any post-processing, alerting, can happen as designed #35352

merged 1 commit into from
Aug 24, 2021

Conversation

PhilETaylor
Copy link
Contributor
@PhilETaylor PhilETaylor commented Aug 24, 2021 •
edited
Loading

My bad again. Sorry.

Summary of Changes

In Joomla 3 fatal errors (like cant connect to the db) are shows like this Error - yup thats it, one word in black on a white blank page.

In Joomla 4 we moved to handling fatal errors with the Symfony Error Handler (not my work), and more importantly we (I) implemented a custom template after changes were merged upstream in Symfony.

Joomla 4.0.0 was the first product to ever be published with a custom Symfony Error Page 🎉

This gave us the (now almost infamous) red page of death when a fatal error happens on the frontend of Joomla 4.

Screenshot 2021-08-24 at 21 31 56

(Many people are seeing this - when upgrading to Joomla 4 without reading, and with incompatible plugins - thats its job after all! )

One of the principles that was implemented was the introduction of a fatal-error.custom.php file that template designers could drop into templates/system/ which could be used instead of the red screen of death - for the purposes (as documented in fatal.php) of:

 * Allow overriding Joomla supplied page to prevent changes being wiped on Joomla upgrade.
 * We allow it to be a PHP file so that any post-processing, alerting etc can happen.

However, as implemented prior to this PR, any PHP code in the fatal-error.custom.php would not actually parse!!!! Doh! as 8000 the content of the file was loaded with file_get_contents and then echo to the response.

This PR fixes the invalid implementation by correctly including the file, allowing any PHP to parse (This allows the developer to use PHP to call a remote service, display dynamic data, send an email alerting apps, Sentry.io etc)

Testing Instructions

  1. Get a working Joomla 4 site
  2. Change your db username to be invalid
  3. Visit your home page - see red screen of death
  4. create a new /templates/system/fatal-error.custom.php file with <?php echo 'Hello World'; as its content.
  5. Visit your home page - see white screen of death, inspect the HTML response and see that <?php echo 'Hello World'; in unparsed and just output as the response
  6. APPLY PR
  7. Visit your home page - see Hello World

For bonus points, note you can do:

<?php
echo $statusCode;
echo $statusText;
?>

and get an output of HELLO WORLD500Whoops, looks like something went wrong. this proves that the original status are being passed through for custom template designers to style/place however they like.

For more bonus points in configuration.php set $debug = true; and see the Symfony Debug Trace - just to show you what the red page of death is actually "hiding" from your site visitors!

REMEMBER this "red page of death" is a FATAL ERROR page, its NOT MEANT to ever be shown in real life. ITS NOT THE ERROR PAGE, its a FATAL error page. The lowest of the low. Again this is the reason the custom template is NOT in the template/my_template/ folder but available to be placed in the templates/system/ folder - because at the FATAL ERROR state it cannot be assumed that any part of Joomla is available (Eg: a Factory or application or db connection)

Actual result BEFORE applying this Pull Request

The content of the fatal-error.custom.php would be rendered in the source of the response - even if it was PHP.

PHP would not be parsed, just outputted.

Expected result AFTER applying this Pull Request

The PHP in fatal-error.custom.php is now parsed, triggered, and runs as expected and as originally designed for this feature.

Custom template developers can go mad and replace the "Red Screen Of Death" with something else... and can include PHP which is parsed.

Screenshot 2021-08-24 at 21 38 23

Documentation Changes Required

None. Joomla 4 is so new I doubt anyone has noticed this is even possible yet :)

ref:
@Webdongle https://forum.joomla.org/viewtopic.php?f=810&t=987965&p=3637277#p3637277

@wilsonge wilsonge merged commit b06f7c3 into joomla:4.0-dev Aug 24, 2021
@wilsonge
Copy link
Contributor

Thanks!

@wilsonge wilsonge added this to the Joomla 4.0.3 milestone Aug 24, 2021
@PhilETaylor

This comment was marked as abuse.

Sign in to view
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Joomla 4.0.3
Development

Successfully merging this pull request may close these issues.
3 participants
@PhilETaylor @wilsonge @joomla-cms-bot
0