README

This package provides a simple way to check how many queries a test suite has performed.

It is important to keep in mind that merely controlling how many queries you perform on the database is not enough to ensure your application has a good performance. This package does not intend to do it, instead, it is thought to help you prevent common mistakes (like N+1 queries).

Installation

You can install the package via composer:

composer require lucasdotvin/laravel-database-queries-counter --dev

You can publish the traits if you want to extend them:

php artisan vendor:publish --tag="laravel-database-queries-counter-traits"

Usage

Add the CountsQueries trait to your test suite class to access the package methods, like startCountingQueries, stopCountingQueries, and assertDatabaseQueriesCount, as demonstrated below, where we assert that an index route does not perform N+1 queries to load the posts from a blog:

<?php

namespace Tests\Feature;

use App\Models\Post;
use App\Models\User;
use LucasDotVin\DBQueriesCounter\Traits\CountsQueries;
use Tests\TestCase;

class PostTest extends TestCase
{
    use CountsQueries;

    public function testIndexPageDoesNotPerfomNPlusOneQueries()
    {
        Post::factory()->times(10)->create();

        $user = User::factory()->create();
        $this->actingAs($user);

        $this->startCountingQueries();

        $response = $this->get(route('posts.index'));

        $this->stopCountingQueries();

        $response->assertSuccessful();
        $this->assertDatabaseQueriesCount(1);
    }
}

You can also use the method whileCountingQueries to avoid having to control when to start and stop counting queries, as below, where we refactor the example above:

    public function testIndexPageDoesNotPerfomNPlusOneQueries()
    {
        Post::factory()->times(10)->create();

        $user = User::factory()->create();
        $this->actingAs($user);

        $response = $this->whileCountingQueries(fn () => $this->get(route('posts.index')));

        $response->assertSuccessful();
        $this->assertDatabaseQueriesCount(1);
    }

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

lucasdotvin / laravel-database-queries-counter

Maintainers

Details