https://github.com/timacdonald/pulse-validation-errors

Validation errors card for Laravel Pulse
https://github.com/timacdonald/pulse-validation-errors

Last synced: about 3 hours ago
JSON representation

Validation errors card for Laravel Pulse

• Host: GitHub
• URL: https://github.com/timacdonald/pulse-validation-errors
• Owner: timacdonald
• Created: 2024-05-10T08:35:26.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T00:39:40.000Z (4 months ago)
• Last Synced: 2024-05-23T01:06:21.246Z (4 months ago)
• Language: PHP
• Size: 259 KB
• Stars: 60
• Watchers: 2
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Validation errors card for Laravel Pulse

A card for Laravel Pulse to show validation errors impacting users.



## Installation

First, install the package via composer:

```sh

composer require timacdonald/pulse-validation-errors

```

Next, add the recorder to your `config/pulse.php`:

```php

return [

    // ...

    'recorders' => [

        TiMacDonald\Pulse\Recorders\ValidationErrors::class => [

            'enabled' => env('PULSE_VALIDATION_ERRORS_ENABLED', true),

            'sample_rate' => env('PULSE_VALIDATION_ERRORS_SAMPLE_RATE', 1),

            'capture_messages' => true,

            'ignore' => [

                // '#^/login$#',

                // '#^/register$#',

                // '#^/forgot-password$#',

            ],

            'groups' => [

                // '#^/products/.*$#' => '/products/{user}',

            ],

        ],

        // ...

    ],

];

```

Next, add the card to your `resources/views/vendor/pulse/dashboard.php`:

```blade

    

    

```

Finally, get to improving your user experience. At LaraconUS I gave a [talk on how much our validation sucks](https://youtu.be/MMc2TzBY6l4?si=UEu8dLuRK4XT30yK). If you are here, you likely also care about how your users experience validation errors on your app, so I'd love you to give it a watch.

## Features

- Supports session based validation errors

- Supports API validation errors

- Support Inertia validation errors

- Support Livewire validation errors

- Supports multiple error bags

- Fallback for undetectable validation errors (based on 422 response status)

- Capture generic validation exceptions for custom response types

## Ignore specific error messages

You may ignore specific endpoints via the recorders `ignore` key, however in some situations you may need more complex ignore rules. You can use [Pulse's built in `Pulse::filter` method](https://laravel.com/docs/11.x/pulse#filtering) to achieve this.

Here is an example where we are ignore a specific error message:

```php

use Laravel\Pulse\Entry;

use Laravel\Pulse\Facades\Pulse;

use Laravel\Pulse\Value;

/**

 * Bootstrap any application services.

 */

public function boot(): void

{

    Pulse::filter(fn ($entry): bool => match ($entry->type) {

        'validation_error' => ! Str::contains($entry->key, [

            'The password is incorrect.',

            'Your password has appeared in a data leak.',

            // ...

        ]),

        // ...

        default => true,

    });

}

```

## Capture validation errors for custom response formats

If you are returning custom response formats, you may see `__laravel_unknown` in the dashboard instead of the input names and error messages. This is because the package parses the response body to determine the validation errors. When the body is in an unrecognised format it is unable to parse the keys and messages from the response.

You should instead dispatch the `ValidationExceptionOccurred` event to pass the validation messages to the card's recorder. You may do this wherever you are converting your exceptions into responses. This usually happens in the `app/Exceptions/Handler`:

```php

 Event::dispatch(new ValidationExceptionOccurred($request, $e)));

        }

        // custom exception rendering logic...

    }

}

```