Understanding Ignition – Laravel’s new bug report (part 2)

Monday, 18/11/2019

Tram Ho

Introduce

Continuing Part 1, Part 2 is about learning more about Ignition – Laravel 6.x’s new bug report
See the original article link here
See the content of part 1 in the series.

content

Ignition tabs

Request tab

Next to the “Stack trace” tab, is the Request tab. It displays all the information of a request.

App tab

app-tab

App tab will display some pretty interesting information. It displays the information about your application. They will first show which route the exception is taking place, it will include controllers that execute if it is available, and the name of its route. Another great feature is its ability to display route parameters in your request.

Let’s come up with an example, to better understand. We have a route defined as follows:

Route <span class="token punctuation">:</span> <span class="token punctuation">:</span> <span class="token function">get</span> <span class="token punctuation">(</span> <span class="token single-quoted-string string">'/posts/{post}'</span> <span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span> Post <span class="token variable">$post</span> <span class="token punctuation">)</span> <span class="token punctuation">{</span>
	<span class="token comment">// do somethings</span>
<span class="token punctuation">}</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span>

Route : : get ( '/posts/{post}' , function ( Post $post ) {

// do somethings

} ) ;

If an exception appears on this route, we will display the components of the post model after converting it to an array type via the toArray () function. As well as the simple route parameters that will be displayed before the bindings, so we have an accurate view of what information Laravel has received as part of that route. After the route param, we will display the middleware information, which is used with the above request. Next we have the VIEW section, if the exception occurs in a certain view, we will display the name of the view, and also display all data thrown into the view.

I don’t know if there is a tool to manage the versions of Laravel, for example, I can use Laravel 5.5 and Laravel 5.6 in parallel on the same device. There must be some solution, right?

User Tab

The tab contains information about who is using the app, and what browser they use.

Context tab

In the context tab, will show your repo git information (including repo location, hash commit code) and environment information (such as php version and Laravel version) that you use.

Debug tab

In the Debug tab, we will display information where the exception occurred, everything like queries, logs, and dump will be displayed. Next, when displaying a dump, we will display the filename where you left the dump command. One click on the pencil icon, you will get to the exact line in that file with your favorite editor (default is phpStorm)

Suggest solutions

Take a look at an error example. Specifically, we forgot to import an class while using it. Here’s how Ignition will display the following error message:

Because Ignition nhìn an exception for a class not found, it will try searching by class name in other namespaces, if that class name exists in a certain namespace, it will suggest importing them.

Ignition will offer some suggestions on solutions to some common problems. For example, this is when the .blade file is not found.

You can add suggestions for solutions to your own exceptions. Please set your exception at FacedeIgnitionContractsProvidesSolution . It will ask you to add the getSolutions function. Here is an example of installing them.

<span class="token keyword">namespace</span> <span class="token package">App  Exceptions</span> <span class="token punctuation">;</span>

<span class="token keyword">use</span> <span class="token package">Exception</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Facade  IgnitionContracts  Solution</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Facade  IgnitionContracts  BaseSolution</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Facade  IgnitionContracts  ProvidesSolution</span> <span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">CustomException</span> <span class="token keyword">extends</span> <span class="token class-name">Exception</span> <span class="token keyword">implements</span> <span class="token class-name">ProvidesSolution</span>
<span class="token punctuation">{</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getSolution</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> Solution
    <span class="token punctuation">{</span>
          <span class="token keyword">return</span> BaseSolution <span class="token punctuation">:</span> <span class="token punctuation">:</span> <span class="token function">create</span> <span class="token punctuation">(</span> <span class="token double-quoted-string string">"You're doing it wrong"</span> <span class="token punctuation">)</span>
            <span class="token operator">-</span> <span class="token operator">&gt;</span> <span class="token function">setSolutionDescription</span> <span class="token punctuation">(</span> <span class="token single-quoted-string string">'You are obviously doing something wrong. Check your code and try again.'</span> <span class="token punctuation">)</span>
            <span class="token operator">-</span> <span class="token operator">&gt;</span> <span class="token function">setDocumentationLinks</span> <span class="token punctuation">(</span> <span class="token punctuation">[</span>
                'Laracasts <span class="token single-quoted-string string">' =&gt; '</span> https <span class="token punctuation">:</span> <span class="token comment">//laracasts.com',</span>
                <span class="token single-quoted-string string">'Use Flare'</span> <span class="token operator">=</span> <span class="token operator">&gt;</span> <span class="token single-quoted-string string">'https://flareapp.io'</span> <span class="token punctuation">,</span>
            <span class="token punctuation">]</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

namespace App Exceptions ;

use Exception ;

use Facade IgnitionContracts Solution ;

use Facade IgnitionContracts BaseSolution ;

use Facade IgnitionContracts ProvidesSolution ;

class CustomException extends Exception implements ProvidesSolution

{

public function getSolution ( ) : Solution

{

return BaseSolution : : create ( "You're doing it wrong" )

- > setSolutionDescription ( 'You are obviously doing something wrong. Check your code and try again.' )

- > setDocumentationLinks ( [

'Laracasts ' => ' https : //laracasts.com',

'Use Flare' = > 'https://flareapp.io' ,

] ) ;

}

The following is the Ignition when this error occurs

Looking ham vc.

Running solutions

More than just suggesting solutions, Ignition can also implement these solutions. Imagine, in case you forgot to set the app key, this is the image that Ignition will display.

If you click on Generate app key button, Ignition will generate and set them to app key And Ignition it will look like this:

If no other exceptions exist, the application will run without problems.

Here is a youtube link introducing Runable solution in Ignition .

Its specific installation structure might be as follows.

<span class="token keyword">namespace</span> <span class="token package">App  Exceptions</span> <span class="token punctuation">;</span>

<span class="token keyword">use</span> <span class="token package">Exception</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Facade  IgnitionContracts  ProvidesSolution</span> <span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">CustomException</span> <span class="token keyword">extends</span> <span class="token class-name">Exception</span> <span class="token keyword">implements</span> <span class="token class-name">ProvidesSolution</span>
<span class="token punctuation">{</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getSolution</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> Solution
    <span class="token punctuation">{</span>
          <span class="token keyword">return</span> <span class="token keyword">new</span> <span class="token class-name">MyRunnableSolution</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

namespace App Exceptions ;

use Exception ;

use Facade IgnitionContracts ProvidesSolution ;

{

return new MyRunnableSolution ( ) ;

}

And this is the code for MyRunableSolution

<span class="token keyword">namespace</span> <span class="token package">App  Solutions</span> <span class="token punctuation">;</span>

<span class="token keyword">use</span> <span class="token package">Facade  IgnitionContracts  RunnableSolution</span> <span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">MyRunnableSolution</span> <span class="token keyword">implements</span> <span class="token class-name">RunnableSolution</span>
<span class="token punctuation">{</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getSolutionTitle</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> string
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token single-quoted-string string">'You are doing it wrong'</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getSolutionDescription</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> string
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token single-quoted-string string">'You are doing something wrong, but we can fix it for you.'</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getDocumentationLinks</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> <span class="token keyword">array</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token punctuation">[</span> <span class="token punctuation">]</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getSolutionActionDescription</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> string
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token single-quoted-string string">'To fix this issue, all you need to do is press the button below.'</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getRunButtonText</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> string
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token single-quoted-string string">'Fix this for me'</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">run</span> <span class="token punctuation">(</span> <span class="token keyword">array</span> <span class="token variable">$parameters</span> <span class="token operator">=</span> <span class="token punctuation">[</span> <span class="token punctuation">]</span> <span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token comment">// Your solution implementation</span>
    <span class="token punctuation">}</span>

    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getRunParameters</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> <span class="token keyword">array</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token punctuation">[</span> <span class="token punctuation">]</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

namespace App Solutions ;

use Facade IgnitionContracts RunnableSolution ;

class MyRunnableSolution implements RunnableSolution

{

public function getSolutionTitle ( ) : string

{

return 'You are doing it wrong' ;

}

public function getSolutionDescription ( ) : string

{

return 'You are doing something wrong, but we can fix it for you.' ;

}

public function getDocumentationLinks ( ) : array

{

return [ ] ;

}

public function getSolutionActionDescription ( ) : string

{

return 'To fix this issue, all you need to do is press the button below.' ;

}

public function getRunButtonText ( ) : string

{

return 'Fix this for me' ;

}

public function run ( array $parameters = [ ] )

{

// Your solution implementation

}

public function getRunParameters ( ) : array

{

return [ ] ;

}

And this is how the CustomException displayed on Ignition will be

The run function will be executed if the user clicksed on Fix this for me button. You may pass additional parameters from the request when this exception occurs to resolve them at runtime. It is simply getRunParameters returns an array, and it will be passed to the run function.

It looks like a falcon, but I don’t know if the getRunParameters function might be like this

   <span class="token comment">// code.....</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getRunParameters</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> <span class="token keyword">array</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token function">request</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token operator">-</span> <span class="token operator">&gt;</span> <span class="token function">all</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
    <span class="token comment">// code ...</span>

// code.....

{

return request ( ) - > all ( ) ;

}

// code ...

Make Ignition smarter.

You can enhance exception handling by using written suggestions or runable solutions . However, sometimes you will encounter php exceptions or 3rd party software exceptions, which you cannot control. As such, Ignition provides the Solution Provider . Solution providers are classes that hook a solution process to Ignition. When the exception is fired, Ignition will receive it, and your custom solution provider will be called one time, or many solutions will be able to be called with this exception.

You can create a Stack Overflow solution provider, where you can find answers to exceptions, and treat that as a solution.

Here are some example code. This idea of me too.

<span class="token keyword">use</span> <span class="token package">Throwable</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">RuntimeException</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Facade  IgnitionContracts  Solution</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Facade  Ignition  Solutions  GenerateAppKeySolution</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Facade  IgnitionContracts  HasSolutionForThrowable</span> <span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">MissingAppKeySolutionProvider</span> <span class="token keyword">implements</span> <span class="token class-name">HasSolutionForThrowable</span>
<span class="token punctuation">{</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">canSolve</span> <span class="token punctuation">(</span> Throwable <span class="token variable">$throwable</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> bool
    <span class="token punctuation">{</span>
        <span class="token keyword">if</span> <span class="token punctuation">(</span> <span class="token operator">!</span> <span class="token variable">$throwable</span> <span class="token keyword">instanceof</span> <span class="token class-name">RuntimeException</span> <span class="token punctuation">)</span> <span class="token punctuation">{</span>
            <span class="token keyword">return</span> <span class="token boolean">false</span> <span class="token punctuation">;</span>
        <span class="token punctuation">}</span>

        <span class="token keyword">return</span> <span class="token variable">$throwable</span> <span class="token operator">-</span> <span class="token operator">&gt;</span> <span class="token function">getMessage</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span> <span class="token operator">===</span> <span class="token single-quoted-string string">'No application encryption key has been specified.'</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getSolutions</span> <span class="token punctuation">(</span> Throwable <span class="token variable">$throwable</span> <span class="token punctuation">)</span> <span class="token punctuation">:</span> <span class="token keyword">array</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token punctuation">[</span>
            <span class="token keyword">new</span> <span class="token class-name">GenerateAppKeySolution</span> <span class="token punctuation">(</span> <span class="token punctuation">)</span>
        <span class="token punctuation">]</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

use Throwable ;

use RuntimeException ;

use Facade IgnitionContracts Solution ;

use Facade Ignition Solutions GenerateAppKeySolution ;

use Facade IgnitionContracts HasSolutionForThrowable ;

class MissingAppKeySolutionProvider implements HasSolutionForThrowable

{

public function canSolve ( Throwable $throwable ) : bool

{

if ( ! $throwable instanceof RuntimeException ) {

return false ;

}

return $throwable - > getMessage ( ) === 'No application encryption key has been specified.' ;

}

public function getSolutions ( Throwable $throwable ) : array

{

return [

new GenerateAppKeySolution ( )

] ;

}

<span class="token keyword">namespace</span> <span class="token package">App  Providers</span> <span class="token punctuation">;</span>

<span class="token keyword">use</span> <span class="token package">App  Solutions  GenerateAppKeySolution</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Facade  IgnitionContracts  SolutionProviderRepository</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Support  ServiceProvider</span> <span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">YourServiceProvider</span> <span class="token keyword">extends</span> <span class="token class-name">ServiceProvider</span>
<span class="token punctuation">{</span>
    <span class="token comment">/**
     * Register services.
     *
     * @return void
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">register</span> <span class="token punctuation">(</span> SolutionProviderRepository <span class="token variable">$solutionProviderRepository</span> <span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token variable">$solutionProviderRepository</span> <span class="token operator">-</span> <span class="token operator">&gt;</span> <span class="token function">registerSolutionProvider</span> <span class="token punctuation">(</span> GenerateAppKeySolution <span class="token punctuation">:</span> <span class="token punctuation">:</span> <span class="token keyword">class</span> <span class="token punctuation">)</span> <span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

namespace App Providers ;

use App Solutions GenerateAppKeySolution ;

use Facade IgnitionContracts SolutionProviderRepository ;

use Illuminate Support ServiceProvider ;

class YourServiceProvider extends ServiceProvider

{

/**

* Register services.

* @return void

*/

public function register ( SolutionProviderRepository $solutionProviderRepository )

{

$solutionProviderRepository - > registerSolutionProvider ( GenerateAppKeySolution : : class ) ;

}

After a bit of research, I felt very satisfied, but the suffering version of Laravel being used, was smaller than 6.0. I asked the question, is there a way to use it in the lower version? So I researched and found this link, guys. It’s easy to crack: https://flareapp.io/docs/ignition-for-laravel/installation Support from Laravel 5.5. upwards, I tried and succeeded brothers. Each project is private, so it can’t be shown to you guys, but I think it is also delicious.

Share the news now

Source : Viblo