topshelfcraft / canary Goto Github PK

For errors in Twig templates, it'd be dope if the dev can open a code editor right from the error page, and Cmd-S to save, which writes the change to disk and reloads the page.

• For front-end templates (i.e. not CP/Craft/plugin templates)
• if the user is logged in Admin
• only in Dev Mode.

For classes/methods in Craft app files, link to the docs where appropriate.

• For called methods that Craft owns
• In classes that Craft owns

From @Mosnar:

exception message gets cut off if it's too long and it can be difficult to view

(/admin/utilities/system-report)

Projects that use the Canary package can add "Chirps" throughout their code, which are displayed in the Debug tab in chronological order, serving as "waypoints" in the code execution.

Canary::chirp("This is a message!", $someExtraInfo, $someOtherInfo)

For doDisplay frames in compiled Twig template classes, display the source template path rather than the compiled template class path.

(Code snippet will still show the doDisplay call from Template.php.)

Maybe still show the compiled class name, in the meta pane? (Would anybody ever need it?)

Exceptions that implement CanaryException contract can register Suggestions individually.

Additional SuggestionProvider classes can be registered on the system via config.

Each SuggestionProvider has a chance to visit a caught exception, and optionally register Suggestions on it at runtime.

• In the vein of Laravel Flare
• Whoops supports "replaying" via serialized Exceptions

Shows only error & suggestion(s).

(Not stack frames, context, system vars, etc.)

• Can be triggered as a default via system config, or when instantiating an individual Exception
• Analogous to Error vs Exception display mode in Craft's ErrorHandler

Open questions:

• Should it show a code snippet? (Is that a potential security risk for non-admins / non-dev-mode?

Rather than just a dumb string, a Solution can also be an object, which encapsulates:

• Heading
• Solution text (Markdown-parsed)
• Array of invokable Solutions, keyed by caption/label

https://symfony.com/doc/current/components/var_dumper/advanced.html

We had an issue with our 404 template not showing in production and on a whim I disabled Canary and the 404 template showed up again.

This is the behavior in production mode when a 404 fires:

I've added ./craft plugin/disable canary to my production deploy script so I can keep it on in dev and test environments, but it would be great if it didn't do that!

(/admin/utilities/php-info)

https://github.com/filp/whoops/blob/master/docs/Open%20Files%20In%20An%20Editor.md

Inspiration from Laravel Ignition:
https://github.com/facade/ignition/tree/master/src/SolutionProviders

Global function to "dump, die, and debug" —

Will require a DumpDieDebug Exception. We should give special treatment to that Exception class in the handler, whereby instead of showing the typical error/code frame for the actual ddd() call, we show the dump instead (using Symfony VarDumper?).

Should take variable number of args — ddd($thing1, $thing2, ...)

Suggestions can register an invokable Solution class.

Only admins, in dev mode, can invoke Solutions.

The Solution accepts the Exception and invoking Suggestion as dependencies for context.

If a frame is from a Twig template (i.e. the file is in storage/runtime/compiled_templates):

• Display the source template path rather than the compiled class path
• (Maybe still make the compiled class path available, in the meta pane?)
• Show code snippet from source template, mapped back to original Twig line numbers.
• Show a nice dump of the Twig context

• By default, toggles based on user's system preference.
• Dev can force light or dark mode all the time via config.

Exceptions can:

• triggers full/abbreviated mode
• adds metadata
• add Suggestions (either dumb strings, or Suggestion instances, c.f. #11)

If Canary encounters an exception that implements FriendlyExceptionInterface it should add the result of getSolution as a Suggestion.

https://github.com/yiisoft/friendly-exception

Your plugin is such a nice way to handle errors. Can we get a Craft 4 version?