Download the PHP package jeytekdev/explain-lint-codeception without Composer

jeytekdev/explain-lint-codeception

Codeception bridge for jeytekdev/explain-lint — re-runs EXPLAIN against every query your test suite executes, and fails the build on full table scans, lost indexes, filesort and temporary tables.

This package only triggers analysis/reporting — it does not capture queries by itself. Without one of the capture adapters below installed and configured, every run reports "0 issues", indistinguishable from a clean pass.

Why this package exists

packages/core's reporting/analysis pipeline is a PHPUnit extension, registered via <extensions> in phpunit.xml and driven by PHPUnit's native Runner\Extension/Event system.

Codeception 5 never reads phpunit.xml and never bootstraps that mechanism. Codeception\Suite::initPHPUnitConfiguration() builds an in-memory DefaultConfiguration purely so PHPUnit\Framework\TestCase has something to consult, and every test runs through Codeception\Suite::run() / Codeception's own Symfony EventDispatcher — never through PHPUnit\TextUI\Application, the only thing that parses <extensions> and calls Extension::bootstrap(). Concretely: Codeception\Test\TestCaseWrapper::test() calls the wrapped TestCase::runBare() directly, bypassing the PHPUnit\Framework\TestRunner\TestRunner class that emits the Finished event the core PHPUnit extension listens for.

So if your project runs tests via vendor/bin/codecept run (the default for the Yii2 basic/advanced templates, and common with Laravel/Symfony too) — as opposed to vendor/bin/phpunit directly — installing jeytekdev/explain-lint's PHPUnit extension alone does nothing: query capture (via the Laravel/Doctrine/Yii2 bridge) still works, but no EXPLAIN ever runs and no report is ever produced, silently.

This package re-implements the same subscriber wiring as a Codeception\Extension, registered in codeception.yml instead of phpunit.xml, using Codeception's own event dispatcher. It reuses Jeytekdev\ExplainLint\PHPUnit\TestAnalysisRunner and Jeytekdev\ExplainLint\Report\* from core unchanged — only the event source differs.

Install (2 minutes)

You still need a capture adapter for your stack — this package only handles analysis/reporting:

• Laravel — jeytekdev/explain-lint-laravel
• Symfony / Doctrine DBAL — jeytekdev/explain-lint-doctrine
• Yii2 — jeytekdev/explain-lint-yii2
• Bare PDO — Jeytekdev\ExplainLint\Pdo\ExplainLintPdo

Register the extension in codeception.yml (or a per-suite <suite>.suite.yml if you only want it on one suite):

config is optional and defaults to explain-lint.php in the working directory codecept run is invoked from — same config file format as core, see the core README.

Create explain-lint.php with:

--config-only skips the phpunit.xml registration step from the plain explain-lint:install — running that step for a Codeception project would edit a file Codeception never reads (see above), so don't run it without the flag here.

Then run your suite as usual:

Known limitation: no setUp()/tearDown() split

The PHPUnit extension only analyzes queries executed inside the test method body itself — setUp()/migrations/fixture loading are excluded, via a PreparationStarted → Prepared phase transition PHPUnit dispatches around setUp().

Codeception has no equivalent signal: TestCaseWrapper::test() calls runBare() directly, which runs setUp(), the test body, and tearDown() as one opaque unit Codeception never sees the inside of. This extension therefore analyzes everything captured between test.before and test.end — including setUp()/fixture queries. In practice this mostly matters if your fixtures themselves contain a query bad enough to trip a rule; allowlist it by table/fingerprint the same way you would any other finding (see the allowlist/allowlist_fingerprints keys in the core README).

License

MIT