Spatie Ignition for Debugging #256
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
darylldoyle
force-pushed
the
feature/ignition
branch
from
572ba89 to
2b85d73
Compare
tobeycodes
approved these changes
Dec 2, 2024
mu-plugins/wp-ignition/composer.json
Outdated
There was a problem hiding this comment.
question: why not include this is a dev dependency in the root composer.json so it's one less composer.json file. When running --production it won't be loaded and then the plugin code would never run
There was a problem hiding this comment.
I played with that idea a bunch. Unfortunately we'd need to load our autoloader in WP-config.php or something, otherwise it doesn't load early enough.
Our current MU plugin loads the autoloader late in the WP boot process and we want it to load as the first plugin, to ensure all errors are handled by Ignition
There was a problem hiding this comment.
I think wp-config.php is the best place to load this to be honest. The repo could have a wp-config-sample.php
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change
This PR adds a new plugin to the scaffold. The plugin adds
spatie/ignitionas a debugging tool. Ignition is the default error page for Laravel Projects, and for good reason. It includes great stack traces as well as other helpful information that can be used to debug the issue. There's an example of an issue page below:It lets engineers quickly jump to the problem code, reducing debugging time (see video below).
Tower.-.wp-scaffold.2024-11-28.at.12.33.01.PM.1.mp4
We load it using the
000-wp-ignition-loader.phpfile as it needs to run as soon as possible in order to catch errors in MU plugins.Whilst this should be ignored from deployments to production environments, since we should be handling errors transparently there, it does have some protections in place to ensure it doesn't run, as long as the
wp_get_environment_type()returns correctly.Note
This update doesn't handle Fatal Errors, like Abstract Class extension issues because they happen at compile-time and therefore are handled by PHP's and WordPress's
register_shutdown_function()before this package has time to process them.How to test the Change
Clone locally. Change something in the plugins/theme to cause a PHP error. See Ignition.
Changelog Entry
Credits
Props @darylldoyle
Checklist:
I have updated the documentation accordingly.I have added Critical Flows, Test Cases, and/or End-to-End Tests to cover my change.