Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-visit
Quickly visit any route in your Laravel app
https://github.com/spatie/laravel-visit
debug laravel php route testing
Last synced: about 20 hours ago
JSON representation
Quickly visit any route in your Laravel app
- Host: GitHub
- URL: https://github.com/spatie/laravel-visit
- Owner: spatie
- License: mit
- Created: 2022-02-16T18:09:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T15:01:10.000Z (2 months ago)
- Last Synced: 2024-12-29T09:04:38.792Z (8 days ago)
- Topics: debug, laravel, php, route, testing
- Language: PHP
- Homepage: https://freek.dev/2216-introducing-visit-a-cli-tool-made-for-humans-to-make-networks-requests
- Size: 2.57 MB
- Stars: 149
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Quickly visit any route of your Laravel app
[](https://packagist.org/packages/spatie/laravel-visit)
[](https://github.com/spatie/laravel-visit/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/spatie/laravel-visit/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/spatie/laravel-visit)
This package contains an artisan command `visit` that allows you to visit any route of your Laravel app.
```bash
php artisan visit /my-page
```
The command display the colorized version of the HTML...
... followed by a results block.
The command can also colorize JSON output. It also has support for some Laravel niceties such as logging in users before making a request, using a route name instead of and URL, and much more.
## Want to use `visit` to visit any site
[The `spatie/visit` tool](https://github.com/spatie/visit) can be installed globally to visit any site.
## Support us
[
](https://spatie.be/github-ad-click/laravel-visit)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/laravel-visit
```
To colorize HTML, you should install `bat`.
```bash
brew install bat
```
To colorize JSON, you should install `jq`.
```bash
brew install jq
```
Optionally, you can publish the config file.
```bash
php artisan vendor:publish --tag="visit-config"
```
This is the content of the published config file:
```php
return [
/*
* These classes are responsible for colorizing the output.
*/
'colorizers' => [
Spatie\Visit\Colorizers\JsonColorizer::class,
Spatie\Visit\Colorizers\HtmlColorizer::class,
],
/*
* These stats will be displayed in the response block.
*/
'stats' => [
...Spatie\Visit\Stats\DefaultStatsClasses::all(),
]
];
```
## Usage
To visit a certain page, execute `php artisan` followed by a URL.
```bash
php artisan visit /your-page
```
Instead of passing an URL, you can pass a route name to the `route` option. Here's an example where we will visit the route named "contact".
```bash
php artisan visit --route=contact
```
### Using a different method
By default, the `visit` command will make GET request. To use a different HTTP verb, you can pass it to the `method` option.
```bash
php artisan visit /users/1 --method=delete
```
### Passing a payload
You can pass a payload to non-GET request by using the payload. The payload should be formatted as JSON.
```bash
php artisan visit /users --method=post --payload='{"testKey":"testValue"}'
```
When you pass a payload, we'll assume that you want to make a `POST` request. If you want to use another http verb, pass it explicitly.
```php
visit --method=patch --payload='{"testKey":"testValue"}'
```
### Logging in a user
To log in a user before making a request, add the `--user` and pass it a user id.
```php
php artisan visit /api/user/me --user=1
```
Alternatively, you can also pass an email address to the `user` option.
```php
php artisan visit /api/user/me [email protected]
```
### Showing the headers of the response
By default, the `visit` command will not show any headers. To display them, add the `--headers` option
```bash
php artisan visit /my-page --headers
```
### Following redirects
By default, the `visit` command will not follow redirects. To follow redirects and display the response of the redirection target, add the `--follow-redirects` option.
```bash
php artisan visit /my-page --follow-redirects
```
### Showing exception pages
When your application responds with an exception, the `visit` command will show the html of the error page.
To let the `visit` command display the actual exception, use the `--show-exception` option.
```bash
php artisan visit /page-with-exception --show-exception
```
### Only displaying the response
If you want the `visit` command to only display the response, omitting the response result block at the end, pass the `--only-response` option.
```bash
php artisan visit / --only-response
```
### Only displaying the response properties block
To avoid displaying the response, and only display the response result block, use the `--only-stats` option
```bash
php artisan visit / --only-stats
```
### Avoid colorizing the response
The `visit` command will automatically colorize any HTML and JSON output. To avoid the output being colorized, use the `--no-color` option.
```bash
php artisan visit / --no-color
```
### Displaying the result HTML as text
Usually an HTML response is quite lengthy. This can make it hard to quickly see what text will be displayed in the browser. To convert an HTML to a text variant, you can pass the `--text` option.
```bash
php artisan visit / --text
```
This is how the default Laravel homepage will look like.
### Filtering HTML output
If you only want to see a part of an HTML response you can use the `--filter` option. For HTML output, you can pass [a css selector](https://www.w3schools.com/cssref/css_selectors.asp).
Imagine that your app's full response is this HTML:
```html
First div
First paragraph
Second paragraph
```
This command ...
```bash
php artisan visit / --filter="p"
```
... will display:
```html
First paragraph
Second paragraph
```
### Filtering JSON output
If you only want to see a part of an JSON response you can use the `--filter` option. You may use dot-notation to reach nested parts.
Imagine that your app's full response is this JSON:
```json
{
"firstName": "firstValue",
"nested": {
"secondName": "secondValue"
}
}
```
This command ...
```bash
php artisan visit / --filter="nested.secondName"
```
... will display:
```html
secondValue
```
### Adding stats
In the results block underneath the response, you'll see a few interesting stats by default, such as the response time and queries executed.
You can add more stats there by creating your own `Stat` class. A valid `Stat` is any class that extends `Spatie\Visit\Stats\Stat`.
Here's how that base class looks like:
```php
namespace Spatie\Visit\Stats;
use Illuminate\Contracts\Foundation\Application;
abstract class Stat
{
public function beforeRequest(Application $app)
{
}
public function afterRequest(Application $app)
{
}
abstract public function getStatResult(): StatResult;
}
```
As an example implementation, take a look at the `RunTimeStat` that ships with the package.
```php
namespace Spatie\Visit\Stats;
use Illuminate\Contracts\Foundation\Application;
use Symfony\Component\Stopwatch\Stopwatch;
use Symfony\Component\Stopwatch\StopwatchEvent;
class RuntimeStat extends Stat
{
protected Stopwatch $stopwatch;
protected ?StopwatchEvent $stopwatchEvent = null;
public function __construct()
{
$this->stopwatch = new Stopwatch(true);
}
public function beforeRequest(Application $app)
{
$this->stopwatch->start('default');
}
public function afterRequest(Application $app)
{
$this->stopwatchEvent = $this->stopwatch->stop('default');
}
public function getStatResult(): StatResult
{
$duration = $this->stopwatchEvent->getDuration();
return StatResult::make('Duration')
->value($duration . 'ms');
}
}
```
To activate a `Stat`, you should add its class name to the `stats` key of the `visit` config file.
```php
// in config/stats.php
return [
// ...
'stats' => [
App\Support\YourCustomStat::class,
...Spatie\Visit\Stats\DefaultStatsClasses::all(),
]
]
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.