Benchmarks #

Benchmarks can be taken on Craft actions which you can then assert against. For example you may want to load the homepage and ensure there are no duplicate queries that could have been lazy loaded. You would do this with,

it('checks for duplicate queries')
  ->beginBenchmark()
  ->get('/')
  ->endBenchmark()
  ->assertNoDuplicateQueries();

beginBenchmark() #

Benchmarks are started on your test case by calling ->beginBenchmark(). You are free to start as many benchmarks as needed, however, note that starting a new benchmark will clear out any existing benchmarks already in progress.

Warning In order to use a benchmark you must enable Craft's devMode (which will enable the Yii Debug Bar).

endBenchmark() #

Ending a benchmark returns a testable Benchmark class. You can end a benchmark by calling ->endBenchmark() on the test case or on a response. Either of the following will work,

it('ends on the test case', function () {
  $this->beginBenchmark();
  $this->get('/');
  $benchmark = $this->endBenchmark();
});

it('ends on the response', function () {
  $this->beginBenchmark()
     ->get('/')
     ->endBenchmark();
});

Note Unlike the traditional Craft request/response lifecycle you are free to make multiple requests in a single benchmark.

assertNoDuplicateQueries() #

Ensures there are no duplicate queries since the benchmark began.

$benchmark->assertNoDuplicateQueries();

assertLoadTimeLessThan(float $expectedLoadTime) #

Assert that the execution timing of the benchmark is less than the given timing in seconds.

Note Benchmarks must begin and end in your test. That allows you to do any necessary setup before the benchmark begins so your test preamble doesn't affect your assertion.

it('loads an article', function () {
  $entry = Entry::factory()->section('articles')->create();

  $this->beginBenchmark()
    ->get($entry->uri)
    ->endBenchmark()
    ->assertLoadTimeLessThan(2);
});

assertMemoryLoadLessThan(float $expectedMemoryLoad) #

Assert that the peak memory load of the benchmark is less than the given memory limit in megabytes.

it('loads the homepage')
  ->beginBenchmark()
  ->get('/');
  ->endBenchmark()
  ->assertMemoryLoadLessThan(128);
});

assertAllQueriesFasterThan(float $expectedQueryTime) #

Assert that every query is faster than the given threshold in seconds.

it('loads the homepage')
  ->beginBenchmark()
  ->get('/');
  ->endBenchmark()
  ->assertAllQueriesFasterThan(0.05);
});