mirror of
https://github.com/pestphp/pest.git
synced 2026-04-23 23:47:30 +02:00
Compare commits
22 Commits
0d99c33c4e
...
feat/tia
| Author | SHA1 | Date | |
|---|---|---|---|
| 3d3c5d41ac | |||
| caabebf2a1 | |||
| 470a5833d4 | |||
| c1feefbb9e | |||
| e876dba8ba | |||
| d9c18f9c02 | |||
| 660b57b365 | |||
| 68527c996f | |||
| c6a42a2b28 | |||
| 856a370032 | |||
| e24882c486 | |||
| 51fc380789 | |||
| f6609f4039 | |||
| 2941f9821f | |||
| ed399af43e | |||
| 0d66dc4322 | |||
| 7e4280bf83 | |||
| a5915b16ab | |||
| 1476b529a1 | |||
| 2892341c28 | |||
| 59e781e77b | |||
| 55a3394f8c |
18
.github/workflows/tests.yml
vendored
18
.github/workflows/tests.yml
vendored
@ -76,3 +76,21 @@ jobs:
|
||||
|
||||
- name: Integration Tests
|
||||
run: composer test:integration
|
||||
|
||||
# tests-tia records coverage inside its sandbox, which requires
|
||||
# pcov (or xdebug) in the process PHP. The main setup-php step is
|
||||
# `coverage: none` for speed — re-enable pcov here just for the
|
||||
# TIA step. Cheap: pcov startup is near-zero.
|
||||
- name: Enable pcov for TIA
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: ${{ matrix.php }}
|
||||
tools: composer:v2
|
||||
coverage: pcov
|
||||
extensions: sockets
|
||||
|
||||
- name: TIA End-to-End Tests
|
||||
# Black-box tests drive Pest `--tia` against a throw-away sandbox.
|
||||
# First scenario takes ~60s (composer-installs the host Pest into a
|
||||
# cached template); subsequent clones are cheap.
|
||||
run: composer test:tia
|
||||
|
||||
9
bin/pest
9
bin/pest
@ -142,6 +142,15 @@ use Symfony\Component\Console\Output\ConsoleOutput;
|
||||
|
||||
// Get $rootPath based on $autoloadPath
|
||||
$rootPath = dirname($autoloadPath, 2);
|
||||
|
||||
// Re-execs PHP without Xdebug on TIA replay runs so repeat `--tia`
|
||||
// invocations aren't slowed by a coverage driver they don't use. Plain
|
||||
// `pest` runs are left alone — users may rely on Xdebug for IDE
|
||||
// breakpoints, step-through debugging, or custom tooling. See
|
||||
// XdebugGuard for the full decision (coverage / tia-rebuild / Xdebug
|
||||
// mode gates).
|
||||
\Pest\Support\XdebugGuard::maybeDrop($rootPath);
|
||||
|
||||
$input = new ArgvInput;
|
||||
|
||||
$testSuite = TestSuite::getInstance(
|
||||
|
||||
181
bin/pest-tia-vite-deps.mjs
Normal file
181
bin/pest-tia-vite-deps.mjs
Normal file
@ -0,0 +1,181 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* TIA Vite dependency resolver.
|
||||
*
|
||||
* Spins up a throwaway headless Vite dev server using the project's
|
||||
* `vite.config.*`, walks every `resources/js/Pages/**` entry to warm
|
||||
* up the module graph, then serializes the graph as a reverse map:
|
||||
*
|
||||
* { "<abs source path>": ["<page component name>", ...], ... }
|
||||
*
|
||||
* The resulting JSON is written to stdout. Stderr is silent on
|
||||
* success so Pest can parse stdout without stripping.
|
||||
*
|
||||
* Why this exists: at TIA record time we need to know which Inertia
|
||||
* page components depend on each shared source file (Button.vue,
|
||||
* Layouts/*.vue, etc.) so a later edit to one of those files can
|
||||
* invalidate only the tests that rendered an affected page. Vite
|
||||
* already knows this via its module graph — we borrow it.
|
||||
*
|
||||
* Called from `Pest\Plugins\Tia\JsModuleGraph::build()` as:
|
||||
*
|
||||
* node bin/pest-tia-vite-deps.mjs <absoluteProjectRoot>
|
||||
*
|
||||
* Environment:
|
||||
* TIA_VITE_PAGES_DIR override the `resources/js/Pages` default.
|
||||
* TIA_VITE_TIMEOUT_MS override the 20s internal watchdog.
|
||||
*/
|
||||
|
||||
import { readdir } from 'node:fs/promises'
|
||||
import { existsSync } from 'node:fs'
|
||||
import { createRequire } from 'node:module'
|
||||
import { resolve, relative, extname, posix, sep, join } from 'node:path'
|
||||
import { pathToFileURL } from 'node:url'
|
||||
|
||||
const PAGE_EXTENSIONS = new Set(['.vue', '.tsx', '.jsx', '.svelte'])
|
||||
const PROJECT_ROOT = resolve(process.argv[2] ?? process.cwd())
|
||||
const PAGES_REL = (process.env.TIA_VITE_PAGES_DIR ?? 'resources/js/Pages').replace(/\\/g, '/')
|
||||
const TIMEOUT_MS = Number.parseInt(process.env.TIA_VITE_TIMEOUT_MS ?? '20000', 10)
|
||||
|
||||
// Resolve Vite from the project's own `node_modules`, not from this
|
||||
// helper's location (which lives under `vendor/pestphp/pest/bin/` and
|
||||
// has no `node_modules`). `createRequire` anchored at the project
|
||||
// root walks up from there, matching the resolution behaviour any
|
||||
// project-local script would see.
|
||||
async function loadVite() {
|
||||
const projectRequire = createRequire(join(PROJECT_ROOT, 'package.json'))
|
||||
const vitePath = projectRequire.resolve('vite')
|
||||
return await import(pathToFileURL(vitePath).href)
|
||||
}
|
||||
|
||||
const { createServer } = await loadVite()
|
||||
|
||||
async function listPageFiles(pagesDir) {
|
||||
if (!existsSync(pagesDir)) return []
|
||||
|
||||
const out = []
|
||||
const walk = async (dir) => {
|
||||
let entries
|
||||
try { entries = await readdir(dir, { withFileTypes: true }) } catch { return }
|
||||
for (const entry of entries) {
|
||||
const full = resolve(dir, entry.name)
|
||||
if (entry.isDirectory()) { await walk(full); continue }
|
||||
if (PAGE_EXTENSIONS.has(extname(entry.name))) out.push(full)
|
||||
}
|
||||
}
|
||||
|
||||
await walk(pagesDir)
|
||||
return out
|
||||
}
|
||||
|
||||
function componentNameFor(pageAbs, pagesDir) {
|
||||
const rel = relative(pagesDir, pageAbs).split(sep).join('/')
|
||||
const ext = extname(rel)
|
||||
return rel.slice(0, rel.length - ext.length)
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const pagesDir = resolve(PROJECT_ROOT, PAGES_REL)
|
||||
const pages = await listPageFiles(pagesDir)
|
||||
|
||||
if (pages.length === 0) {
|
||||
process.stdout.write('{}')
|
||||
return
|
||||
}
|
||||
|
||||
// Boot Vite in middleware mode (no port binding, no HMR server).
|
||||
// We only need the module graph; transformRequest per page warms
|
||||
// it without running a bundle.
|
||||
const server = await createServer({
|
||||
configFile: undefined, // auto-detect vite.config.*
|
||||
root: PROJECT_ROOT,
|
||||
logLevel: 'silent',
|
||||
clearScreen: false,
|
||||
server: {
|
||||
middlewareMode: true,
|
||||
hmr: false,
|
||||
watch: null,
|
||||
},
|
||||
appType: 'custom',
|
||||
optimizeDeps: { disabled: true },
|
||||
})
|
||||
|
||||
// Watchdog — don't let a pathological config hang the record run.
|
||||
const killer = setTimeout(() => {
|
||||
server.close().catch(() => {}).finally(() => process.exit(2))
|
||||
}, TIMEOUT_MS)
|
||||
|
||||
// Reverse map: depSourcePath → Set<component name>.
|
||||
const reverse = new Map()
|
||||
|
||||
const pageComponentCache = new Map()
|
||||
for (const page of pages) {
|
||||
pageComponentCache.set(page, componentNameFor(page, pagesDir))
|
||||
}
|
||||
|
||||
try {
|
||||
for (const pagePath of pages) {
|
||||
const pageComponent = pageComponentCache.get(pagePath)
|
||||
const pageUrl = '/' + posix.relative(
|
||||
PROJECT_ROOT.split(sep).join('/'),
|
||||
pagePath.split(sep).join('/'),
|
||||
)
|
||||
|
||||
try {
|
||||
await server.transformRequest(pageUrl, { ssr: false })
|
||||
} catch {
|
||||
// Transform errors (missing deps, syntax issues) shouldn't
|
||||
// poison the whole graph — skip this page and continue.
|
||||
continue
|
||||
}
|
||||
|
||||
const pageModule = await server.moduleGraph.getModuleByUrl(pageUrl, false)
|
||||
if (!pageModule) continue
|
||||
|
||||
// BFS over importedModules, scoped to files inside the project.
|
||||
const visited = new Set()
|
||||
const queue = [pageModule]
|
||||
while (queue.length) {
|
||||
const mod = queue.shift()
|
||||
for (const imported of mod.importedModules) {
|
||||
const id = imported.file ?? imported.id
|
||||
if (!id || visited.has(id)) continue
|
||||
visited.add(id)
|
||||
|
||||
// Skip files outside the project root (node_modules, etc.)
|
||||
// and virtual modules (`\0`-prefixed ids from plugins).
|
||||
if (id.startsWith('\0')) continue
|
||||
if (!id.startsWith(PROJECT_ROOT)) continue
|
||||
|
||||
const rel = relative(PROJECT_ROOT, id).split(sep).join('/')
|
||||
const bucket = reverse.get(rel) ?? new Set()
|
||||
bucket.add(pageComponent)
|
||||
reverse.set(rel, bucket)
|
||||
|
||||
queue.push(imported)
|
||||
}
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
clearTimeout(killer)
|
||||
await server.close()
|
||||
}
|
||||
|
||||
const payload = Object.create(null)
|
||||
const keys = [...reverse.keys()].sort()
|
||||
for (const key of keys) {
|
||||
payload[key] = [...reverse.get(key)].sort()
|
||||
}
|
||||
|
||||
process.stdout.write(JSON.stringify(payload))
|
||||
}
|
||||
|
||||
try {
|
||||
// Node 20 dynamic-import path — some environments are pickier than others.
|
||||
void pathToFileURL // retained to silence tree-shakers referencing the import
|
||||
await main()
|
||||
} catch (err) {
|
||||
process.stderr.write(String(err?.stack ?? err ?? 'unknown error'))
|
||||
process.exit(1)
|
||||
}
|
||||
@ -19,7 +19,8 @@
|
||||
"require": {
|
||||
"php": "^8.3.0",
|
||||
"brianium/paratest": "^7.20.0",
|
||||
"nunomaduro/collision": "^8.9.3",
|
||||
"composer/xdebug-handler": "^3.0.5",
|
||||
"nunomaduro/collision": "^8.9.4",
|
||||
"nunomaduro/termwind": "^2.4.0",
|
||||
"pestphp/pest-plugin": "^4.0.0",
|
||||
"pestphp/pest-plugin-arch": "^4.0.2",
|
||||
@ -92,6 +93,7 @@
|
||||
"test:inline": "php bin/pest --configuration=phpunit.inline.xml",
|
||||
"test:parallel": "php bin/pest --exclude-group=integration --parallel --processes=3",
|
||||
"test:integration": "php bin/pest --group=integration -v",
|
||||
"test:tia": "php bin/pest --configuration=tests-tia/phpunit.xml",
|
||||
"update:snapshots": "REBUILD_SNAPSHOTS=true php bin/pest --update-snapshots",
|
||||
"test": [
|
||||
"@test:lint",
|
||||
@ -99,7 +101,8 @@
|
||||
"@test:type:coverage",
|
||||
"@test:unit",
|
||||
"@test:parallel",
|
||||
"@test:integration"
|
||||
"@test:integration",
|
||||
"@test:tia"
|
||||
]
|
||||
},
|
||||
"extra": {
|
||||
|
||||
@ -8,9 +8,13 @@ use Closure;
|
||||
use Pest\Exceptions\DatasetArgumentsMismatch;
|
||||
use Pest\Panic;
|
||||
use Pest\Plugins\Tia;
|
||||
use Pest\Plugins\Tia\BladeEdges;
|
||||
use Pest\Plugins\Tia\InertiaEdges;
|
||||
use Pest\Plugins\Tia\Recorder;
|
||||
use Pest\Plugins\Tia\TableTracker;
|
||||
use Pest\Preset;
|
||||
use Pest\Support\Container;
|
||||
use Pest\Support\ChainableClosure;
|
||||
use Pest\Support\Container;
|
||||
use Pest\Support\ExceptionTrace;
|
||||
use Pest\Support\Reflection;
|
||||
use Pest\Support\Shell;
|
||||
@ -238,32 +242,6 @@ trait Testable
|
||||
|
||||
$this->__cachedPass = false;
|
||||
|
||||
/** @var Tia $tia */
|
||||
$tia = Container::getInstance()->get(Tia::class);
|
||||
$cached = $tia->getCachedResult(self::$__filename, $this::class.'::'.$this->name());
|
||||
|
||||
if ($cached !== null) {
|
||||
if ($cached->isSuccess()) {
|
||||
$this->__cachedPass = true;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Non-success: throw the matching PHPUnit exception. Runner
|
||||
// catches it and marks the test with the correct status so
|
||||
// skips, failures, incompletes and todos appear in output
|
||||
// exactly as they did in the cached run.
|
||||
if ($cached->isSkipped()) {
|
||||
$this->markTestSkipped($cached->message());
|
||||
}
|
||||
|
||||
if ($cached->isIncomplete()) {
|
||||
$this->markTestIncomplete($cached->message());
|
||||
}
|
||||
|
||||
throw new AssertionFailedError($cached->message() ?: 'Cached failure');
|
||||
}
|
||||
|
||||
$method = TestSuite::getInstance()->tests->get(self::$__filename)->getMethod($this->name());
|
||||
|
||||
$description = $method->description;
|
||||
@ -296,8 +274,64 @@ trait Testable
|
||||
self::$__latestIssues = $method->issues;
|
||||
self::$__latestPrs = $method->prs;
|
||||
|
||||
// TIA replay short-circuit. Runs AFTER dataset/description/
|
||||
// assignee metadata is populated so output and filtering still
|
||||
// see the correct test name + tags on a cache hit, but BEFORE
|
||||
// `parent::setUp()` and `beforeEach` so we skip the user's
|
||||
// fixture setup (which is the whole point of replay — avoid
|
||||
// paying for work whose outcome we already know).
|
||||
/** @var Tia $tia */
|
||||
$tia = Container::getInstance()->get(Tia::class);
|
||||
$cached = $tia->getCachedResult(self::$__filename, $this::class.'::'.$this->name());
|
||||
|
||||
if ($cached !== null) {
|
||||
if ($cached->isSuccess()) {
|
||||
$this->__cachedPass = true;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Risky tests have no public PHPUnit hook to replay as-risky.
|
||||
// Best available: short-circuit as a pass so the test doesn't
|
||||
// misreport as a failure. Aggregate risky totals won't
|
||||
// survive replay — accepted trade-off until PHPUnit grows a
|
||||
// programmatic risky-marker API.
|
||||
if ($cached->isRisky()) {
|
||||
$this->__cachedPass = true;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Non-success: throw the matching PHPUnit exception. Runner
|
||||
// catches it and marks the test with the correct status so
|
||||
// skips, failures, incompletes and todos appear in output
|
||||
// exactly as they did in the cached run.
|
||||
if ($cached->isSkipped()) {
|
||||
$this->markTestSkipped($cached->message());
|
||||
}
|
||||
|
||||
if ($cached->isIncomplete()) {
|
||||
$this->markTestIncomplete($cached->message());
|
||||
}
|
||||
|
||||
throw new AssertionFailedError($cached->message() ?: 'Cached failure');
|
||||
}
|
||||
|
||||
parent::setUp();
|
||||
|
||||
// TIA blade-edge + table-edge recording (Laravel-only). Runs
|
||||
// right after `parent::setUp()` so the Laravel app exists and
|
||||
// the View / DB facades are bound; each arm call is
|
||||
// idempotent against the current app instance so the 774-test
|
||||
// suite doesn't stack 774 composers / listeners when Laravel
|
||||
// keeps the same app across tests.
|
||||
$recorder = Container::getInstance()->get(Recorder::class);
|
||||
if ($recorder instanceof Recorder) {
|
||||
BladeEdges::arm($recorder);
|
||||
TableTracker::arm($recorder);
|
||||
InertiaEdges::arm($recorder);
|
||||
}
|
||||
|
||||
$beforeEach = TestSuite::getInstance()->beforeEach->get(self::$__filename)[1];
|
||||
|
||||
if ($this->__beforeEach instanceof Closure) {
|
||||
@ -371,7 +405,14 @@ trait Testable
|
||||
private function __runTest(Closure $closure, ...$args): mixed
|
||||
{
|
||||
if ($this->__cachedPass) {
|
||||
$this->addToAssertionCount(1);
|
||||
// Feed the exact assertion count captured during the recorded
|
||||
// run so Pest's "Tests: N passed (M assertions)" banner stays
|
||||
// accurate on replay instead of collapsing to 1-per-test.
|
||||
/** @var Tia $tia */
|
||||
$tia = Container::getInstance()->get(Tia::class);
|
||||
$assertions = $tia->getCachedAssertions($this::class.'::'.$this->name());
|
||||
|
||||
$this->addToAssertionCount($assertions);
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
@ -13,7 +13,6 @@ use Pest\Plugins\Actions\CallsBoot;
|
||||
use Pest\Plugins\Actions\CallsHandleArguments;
|
||||
use Pest\Plugins\Actions\CallsHandleOriginalArguments;
|
||||
use Pest\Plugins\Actions\CallsTerminable;
|
||||
use Pest\Plugins\Tia;
|
||||
use Pest\Support\Container;
|
||||
use Pest\Support\Reflection;
|
||||
use Pest\Support\View;
|
||||
@ -37,6 +36,7 @@ final readonly class Kernel
|
||||
*/
|
||||
private const array BOOTSTRAPPERS = [
|
||||
Bootstrappers\BootOverrides::class,
|
||||
Plugins\Tia\Bootstrapper::class,
|
||||
Bootstrappers\BootSubscribers::class,
|
||||
Bootstrappers\BootFiles::class,
|
||||
Bootstrappers\BootView::class,
|
||||
@ -65,11 +65,7 @@ final readonly class Kernel
|
||||
->add(TestSuite::class, $testSuite)
|
||||
->add(InputInterface::class, $input)
|
||||
->add(OutputInterface::class, $output)
|
||||
->add(Container::class, $container)
|
||||
->add(Tia\Recorder::class, new Tia\Recorder)
|
||||
->add(Tia\CoverageCollector::class, new Tia\CoverageCollector)
|
||||
->add(Tia\WatchPatterns::class, new Tia\WatchPatterns)
|
||||
->add(Tia\ResultCollector::class, new Tia\ResultCollector);
|
||||
->add(Container::class, $container);
|
||||
|
||||
$kernel = new self(
|
||||
new Application,
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
510
src/Plugins/Tia/BaselineSync.php
Normal file
510
src/Plugins/Tia/BaselineSync.php
Normal file
@ -0,0 +1,510 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
use Composer\InstalledVersions;
|
||||
use Pest\Plugins\Tia;
|
||||
use Pest\Plugins\Tia\Contracts\State;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Process\Process;
|
||||
|
||||
/**
|
||||
* Pulls a team-shared TIA baseline on the first `--tia` run so new
|
||||
* contributors and fresh CI workspaces start in replay mode instead of
|
||||
* paying the ~30s record cost.
|
||||
*
|
||||
* Storage: **workflow artifacts**, not releases. A dedicated CI workflow
|
||||
* (conventionally `.github/workflows/tia-baseline.yml`) runs the full
|
||||
* suite under `--tia` and uploads the `.pest/tia/` directory as a named
|
||||
* artifact (`pest-tia-baseline`) containing `graph.json` +
|
||||
* `coverage.bin`. On dev
|
||||
* machines, this class finds the latest successful run of that workflow
|
||||
* and downloads the artifact via `gh`.
|
||||
*
|
||||
* Why artifacts, not releases:
|
||||
* - No tag is created → no `push` event cascade into CI workflows.
|
||||
* - No release event → no deploy workflows tied to `release:published`.
|
||||
* - Retention is run-scoped and tunable (1-90 days) instead of clobbering
|
||||
* a single floating tag.
|
||||
* - Publishing is strictly CI-only: artifacts can't be produced from a
|
||||
* developer's laptop. This enforces the "CI is the authoritative
|
||||
* publisher" policy that local-publish paths would otherwise erode.
|
||||
*
|
||||
* Fingerprint validation happens back in `Tia::handleParent` after the
|
||||
* blobs are written: a mismatched environment (different PHP version,
|
||||
* composer.lock, etc.) discards the pulled baseline and falls through to
|
||||
* the regular record path.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final readonly class BaselineSync
|
||||
{
|
||||
/**
|
||||
* Conventional workflow filename teams publish from. Not configurable
|
||||
* for MVP — teams that outgrow the default can set
|
||||
* `PEST_TIA_BASELINE_WORKFLOW` later.
|
||||
*/
|
||||
private const string WORKFLOW_FILE = 'tia-baseline.yml';
|
||||
|
||||
/**
|
||||
* Artifact name the workflow uploads under. The artifact is a zip
|
||||
* containing `graph.json` (always) + `coverage.bin` (optional).
|
||||
*/
|
||||
private const string ARTIFACT_NAME = 'pest-tia-baseline';
|
||||
|
||||
/**
|
||||
* Asset filenames inside the artifact — mirror the state keys so the
|
||||
* CI publisher and the sync consumer stay in lock-step.
|
||||
*/
|
||||
private const string GRAPH_ASSET = Tia::KEY_GRAPH;
|
||||
|
||||
private const string COVERAGE_ASSET = Tia::KEY_COVERAGE_CACHE;
|
||||
|
||||
/**
|
||||
* Cooldown (in seconds) applied after a failed baseline fetch.
|
||||
* Rationale: when the remote workflow hasn't published yet, every
|
||||
* `pest --tia` invocation would otherwise re-hit `gh run list` and
|
||||
* re-print the publish instructions — noisy + slow. Back off for a
|
||||
* day, let the user override with `--tia-refetch`.
|
||||
*/
|
||||
private const int FETCH_COOLDOWN_SECONDS = 86400;
|
||||
|
||||
public function __construct(
|
||||
private State $state,
|
||||
private OutputInterface $output,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Detects the repo, fetches the latest baseline artifact, writes its
|
||||
* contents into the TIA state store. Returns true when the graph blob
|
||||
* landed; coverage is best-effort since plain `--tia` (no `--coverage`)
|
||||
* never reads it.
|
||||
*
|
||||
* `$force = true` (driven by `--tia-refetch`) ignores the post-failure
|
||||
* cooldown so the user can retry on demand without waiting out the
|
||||
* 24h window.
|
||||
*/
|
||||
public function fetchIfAvailable(string $projectRoot, bool $force = false): bool
|
||||
{
|
||||
$repo = $this->detectGitHubRepo($projectRoot);
|
||||
|
||||
if ($repo === null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (! $force && ($remaining = $this->cooldownRemaining()) !== null) {
|
||||
$this->output->writeln(sprintf(
|
||||
' <fg=yellow>TIA</> last fetch found no baseline — next auto-retry in %s. '
|
||||
.'Override with <fg=cyan>--tia-refetch</>.',
|
||||
$this->formatDuration($remaining),
|
||||
));
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->output->writeln(sprintf(
|
||||
' <fg=cyan>TIA</> fetching baseline from <fg=white>%s</>…',
|
||||
$repo,
|
||||
));
|
||||
|
||||
$payload = $this->download($repo);
|
||||
|
||||
if ($payload === null) {
|
||||
$this->startCooldown();
|
||||
$this->emitPublishInstructions($repo);
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
if (! $this->state->write(Tia::KEY_GRAPH, $payload['graph'])) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($payload['coverage'] !== null) {
|
||||
$this->state->write(Tia::KEY_COVERAGE_CACHE, $payload['coverage']);
|
||||
}
|
||||
|
||||
// Successful fetch wipes any stale cooldown so the next failure
|
||||
// (say, weeks later) starts a fresh 24h timer rather than inheriting
|
||||
// one from the deep past.
|
||||
$this->clearCooldown();
|
||||
|
||||
$this->output->writeln(sprintf(
|
||||
' <fg=green>TIA</> baseline ready (%s).',
|
||||
$this->formatSize(strlen($payload['graph']) + strlen($payload['coverage'] ?? '')),
|
||||
));
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Seconds left on the cooldown, or `null` when the cooldown is cleared
|
||||
* / expired / unreadable.
|
||||
*/
|
||||
private function cooldownRemaining(): ?int
|
||||
{
|
||||
$raw = $this->state->read(Tia::KEY_FETCH_COOLDOWN);
|
||||
|
||||
if ($raw === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$decoded = json_decode($raw, true);
|
||||
|
||||
if (! is_array($decoded) || ! isset($decoded['until']) || ! is_int($decoded['until'])) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$remaining = $decoded['until'] - time();
|
||||
|
||||
return $remaining > 0 ? $remaining : null;
|
||||
}
|
||||
|
||||
private function startCooldown(): void
|
||||
{
|
||||
$this->state->write(Tia::KEY_FETCH_COOLDOWN, (string) json_encode([
|
||||
'until' => time() + self::FETCH_COOLDOWN_SECONDS,
|
||||
]));
|
||||
}
|
||||
|
||||
private function clearCooldown(): void
|
||||
{
|
||||
$this->state->delete(Tia::KEY_FETCH_COOLDOWN);
|
||||
}
|
||||
|
||||
private function formatDuration(int $seconds): string
|
||||
{
|
||||
if ($seconds >= 3600) {
|
||||
return (int) round($seconds / 3600).'h';
|
||||
}
|
||||
|
||||
if ($seconds >= 60) {
|
||||
return (int) round($seconds / 60).'m';
|
||||
}
|
||||
|
||||
return $seconds.'s';
|
||||
}
|
||||
|
||||
/**
|
||||
* Prints actionable instructions for publishing a first baseline when
|
||||
* the consumer-side fetch finds nothing.
|
||||
*
|
||||
* Behaviour splits on environment:
|
||||
* - **CI:** a single line. The current run is almost certainly *the*
|
||||
* publisher (it's what this workflow does by definition), so
|
||||
* printing the whole recipe again is redundant and noisy.
|
||||
* - **Local:** the full recipe, adapted to Laravel's pre-test steps
|
||||
* (`.env.example` copy + `artisan key:generate`) when the framework
|
||||
* is present. Generic PHP projects get a slimmer skeleton.
|
||||
*/
|
||||
private function emitPublishInstructions(string $repo): void
|
||||
{
|
||||
if ($this->isCi()) {
|
||||
$this->output->writeln(
|
||||
' <fg=yellow>TIA</> no baseline yet — this run will produce one.',
|
||||
);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$yaml = $this->isLaravel()
|
||||
? $this->laravelWorkflowYaml()
|
||||
: $this->genericWorkflowYaml();
|
||||
|
||||
$preamble = [
|
||||
' <fg=yellow>TIA</> no baseline published yet — recording locally.',
|
||||
'',
|
||||
' To share the baseline with your team, add this workflow to the repo:',
|
||||
'',
|
||||
' <fg=cyan>.github/workflows/tia-baseline.yml</>',
|
||||
'',
|
||||
];
|
||||
|
||||
$indentedYaml = array_map(
|
||||
static fn (string $line): string => ' '.$line,
|
||||
explode("\n", $yaml),
|
||||
);
|
||||
|
||||
$trailer = [
|
||||
'',
|
||||
sprintf(' Commit, push, then run once: <fg=cyan>gh workflow run tia-baseline.yml -R %s</>', $repo),
|
||||
' Details: <fg=gray>https://pestphp.com/docs/tia/ci</>',
|
||||
'',
|
||||
];
|
||||
|
||||
$this->output->writeln([...$preamble, ...$indentedYaml, ...$trailer]);
|
||||
}
|
||||
|
||||
/**
|
||||
* True when running inside a CI provider. Conservative list — only the
|
||||
* three providers Pest formally supports / sees in the wild. `CI=true`
|
||||
* alone is ambiguous (users set it locally too) so we require a
|
||||
* provider-specific flag.
|
||||
*/
|
||||
private function isCi(): bool
|
||||
{
|
||||
return getenv('GITHUB_ACTIONS') === 'true'
|
||||
|| getenv('GITLAB_CI') === 'true'
|
||||
|| getenv('CIRCLECI') === 'true';
|
||||
}
|
||||
|
||||
private function isLaravel(): bool
|
||||
{
|
||||
return class_exists(InstalledVersions::class)
|
||||
&& InstalledVersions::isInstalled('laravel/framework');
|
||||
}
|
||||
|
||||
/**
|
||||
* Laravel projects need a populated `.env` and a generated `APP_KEY`
|
||||
* before the first boot, otherwise `Illuminate\Encryption\MissingAppKeyException`
|
||||
* fires during `setUp`. Include the standard pre-test dance plus the
|
||||
* extension set typical Laravel apps rely on.
|
||||
*/
|
||||
private function laravelWorkflowYaml(): string
|
||||
{
|
||||
return <<<'YAML'
|
||||
name: TIA Baseline
|
||||
on:
|
||||
push: { branches: [main] }
|
||||
schedule: [{ cron: '0 3 * * *' }]
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
baseline:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with: { fetch-depth: 0 }
|
||||
- uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: '8.4'
|
||||
coverage: xdebug
|
||||
extensions: json, dom, curl, libxml, mbstring, zip, pdo, pdo_sqlite, sqlite3, bcmath, intl
|
||||
- run: cp .env.example .env
|
||||
- run: composer install --no-interaction --prefer-dist
|
||||
- run: php artisan key:generate
|
||||
- run: ./vendor/bin/pest --parallel --tia --coverage
|
||||
- name: Stage baseline for upload
|
||||
shell: bash
|
||||
run: |
|
||||
mkdir -p .pest-tia-baseline
|
||||
cp -R "$HOME/.pest/tia"/*/. .pest-tia-baseline/
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: pest-tia-baseline
|
||||
path: .pest-tia-baseline/
|
||||
retention-days: 30
|
||||
YAML;
|
||||
}
|
||||
|
||||
private function genericWorkflowYaml(): string
|
||||
{
|
||||
return <<<'YAML'
|
||||
name: TIA Baseline
|
||||
on:
|
||||
push: { branches: [main] }
|
||||
schedule: [{ cron: '0 3 * * *' }]
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
baseline:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with: { fetch-depth: 0 }
|
||||
- uses: shivammathur/setup-php@v2
|
||||
with: { php-version: '8.4', coverage: xdebug }
|
||||
- run: composer install --no-interaction --prefer-dist
|
||||
- run: ./vendor/bin/pest --parallel --tia --coverage
|
||||
- name: Stage baseline for upload
|
||||
shell: bash
|
||||
run: |
|
||||
mkdir -p .pest-tia-baseline
|
||||
cp -R "$HOME/.pest/tia"/*/. .pest-tia-baseline/
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: pest-tia-baseline
|
||||
path: .pest-tia-baseline/
|
||||
retention-days: 30
|
||||
YAML;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses `.git/config` for the `origin` remote and extracts
|
||||
* `org/repo`. Supports the two URL flavours git emits out of the box.
|
||||
* Non-GitHub remotes (GitLab, Bitbucket, self-hosted) → null, which
|
||||
* silently opts the repo out of auto-sync.
|
||||
*/
|
||||
private function detectGitHubRepo(string $projectRoot): ?string
|
||||
{
|
||||
$gitConfig = $projectRoot.DIRECTORY_SEPARATOR.'.git'.DIRECTORY_SEPARATOR.'config';
|
||||
|
||||
if (! is_file($gitConfig)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$content = @file_get_contents($gitConfig);
|
||||
|
||||
if ($content === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Find the `[remote "origin"]` section and the first `url` line
|
||||
// inside it. Tolerates INI whitespace quirks (tabs, CRLF).
|
||||
if (preg_match('/\[remote "origin"\][^\[]*?url\s*=\s*(\S+)/s', $content, $match) !== 1) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$url = $match[1];
|
||||
|
||||
// SSH: git@github.com:org/repo(.git)
|
||||
if (preg_match('#^git@github\.com:([\w.-]+/[\w.-]+?)(?:\.git)?$#', $url, $m) === 1) {
|
||||
return $m[1];
|
||||
}
|
||||
|
||||
// HTTPS: https://github.com/org/repo(.git) (optional trailing slash)
|
||||
if (preg_match('#^https?://github\.com/([\w.-]+/[\w.-]+?)(?:\.git)?/?$#', $url, $m) === 1) {
|
||||
return $m[1];
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Two-step fetch: find the latest successful run of the baseline
|
||||
* workflow, then download the named artifact from it. Returns
|
||||
* `['graph' => bytes, 'coverage' => bytes|null]` on success, or null
|
||||
* if `gh` is unavailable, the workflow hasn't run yet, the artifact
|
||||
* is missing, or any shell step fails.
|
||||
*
|
||||
* @return array{graph: string, coverage: ?string}|null
|
||||
*/
|
||||
private function download(string $repo): ?array
|
||||
{
|
||||
if (! $this->commandExists('gh')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$runId = $this->latestSuccessfulRunId($repo);
|
||||
|
||||
if ($runId === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$tmpDir = sys_get_temp_dir().DIRECTORY_SEPARATOR.'pest-tia-'.bin2hex(random_bytes(4));
|
||||
|
||||
if (! @mkdir($tmpDir, 0755, true) && ! is_dir($tmpDir)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$process = new Process([
|
||||
'gh', 'run', 'download', $runId,
|
||||
'-R', $repo,
|
||||
'-n', self::ARTIFACT_NAME,
|
||||
'-D', $tmpDir,
|
||||
]);
|
||||
$process->setTimeout(120.0);
|
||||
$process->run();
|
||||
|
||||
if (! $process->isSuccessful()) {
|
||||
$this->cleanup($tmpDir);
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
$graphPath = $tmpDir.DIRECTORY_SEPARATOR.self::GRAPH_ASSET;
|
||||
$coveragePath = $tmpDir.DIRECTORY_SEPARATOR.self::COVERAGE_ASSET;
|
||||
|
||||
$graph = is_file($graphPath) ? @file_get_contents($graphPath) : false;
|
||||
|
||||
if ($graph === false) {
|
||||
$this->cleanup($tmpDir);
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
$coverage = is_file($coveragePath) ? @file_get_contents($coveragePath) : false;
|
||||
|
||||
$this->cleanup($tmpDir);
|
||||
|
||||
return [
|
||||
'graph' => $graph,
|
||||
'coverage' => $coverage === false ? null : $coverage,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Queries GitHub for the most recent successful run of the baseline
|
||||
* workflow. `--jq '.[0].databaseId // empty'` coerces "no runs found"
|
||||
* into an empty string, which we map to null.
|
||||
*/
|
||||
private function latestSuccessfulRunId(string $repo): ?string
|
||||
{
|
||||
$process = new Process([
|
||||
'gh', 'run', 'list',
|
||||
'-R', $repo,
|
||||
'--workflow', self::WORKFLOW_FILE,
|
||||
'--status', 'success',
|
||||
'--limit', '1',
|
||||
'--json', 'databaseId',
|
||||
'--jq', '.[0].databaseId // empty',
|
||||
]);
|
||||
$process->setTimeout(30.0);
|
||||
$process->run();
|
||||
|
||||
if (! $process->isSuccessful()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$runId = trim($process->getOutput());
|
||||
|
||||
return $runId === '' ? null : $runId;
|
||||
}
|
||||
|
||||
private function commandExists(string $cmd): bool
|
||||
{
|
||||
$probe = new Process(['command', '-v', $cmd]);
|
||||
$probe->run();
|
||||
|
||||
if ($probe->isSuccessful()) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$which = new Process(['which', $cmd]);
|
||||
$which->run();
|
||||
|
||||
return $which->isSuccessful();
|
||||
}
|
||||
|
||||
private function cleanup(string $dir): void
|
||||
{
|
||||
if (! is_dir($dir)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$entries = glob($dir.DIRECTORY_SEPARATOR.'*');
|
||||
|
||||
if ($entries !== false) {
|
||||
foreach ($entries as $entry) {
|
||||
if (is_file($entry)) {
|
||||
@unlink($entry);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@rmdir($dir);
|
||||
}
|
||||
|
||||
private function formatSize(int $bytes): string
|
||||
{
|
||||
if ($bytes >= 1024 * 1024) {
|
||||
return sprintf('%.1f MB', $bytes / 1024 / 1024);
|
||||
}
|
||||
|
||||
if ($bytes >= 1024) {
|
||||
return sprintf('%.1f KB', $bytes / 1024);
|
||||
}
|
||||
|
||||
return $bytes.' B';
|
||||
}
|
||||
}
|
||||
92
src/Plugins/Tia/BladeEdges.php
Normal file
92
src/Plugins/Tia/BladeEdges.php
Normal file
@ -0,0 +1,92 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
/**
|
||||
* Laravel-only collaborator: during record mode, attributes every
|
||||
* rendered Blade view to the currently-running test.
|
||||
*
|
||||
* Why this exists: the coverage driver only sees compiled view files
|
||||
* under `storage/framework/views/<hash>.php`, not the `.blade.php`
|
||||
* source. Without a dedicated hook TIA has no edges for blade files,
|
||||
* so it leans on the Laravel WatchDefault's broad "any .blade.php
|
||||
* change → every feature test" fallback. Safe but noisy — editing a
|
||||
* single partial re-runs the whole suite.
|
||||
*
|
||||
* With this armed at record time, each test's edge set grows to
|
||||
* include the precise `.blade.php` files it rendered (directly or
|
||||
* through `@include`, layouts, components, Livewire, Inertia root
|
||||
* views — anything that goes through Laravel's view factory fires
|
||||
* `View::composer('*')`). Replay then invalidates exactly the tests
|
||||
* that rendered the changed template.
|
||||
*
|
||||
* Implementation note: everything Laravel-touching goes through
|
||||
* string class names, `class_exists`, and `method_exists` so Pest
|
||||
* core doesn't pull `illuminate/container` into its `require`.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class BladeEdges
|
||||
{
|
||||
private const string CONTAINER_CLASS = '\\Illuminate\\Container\\Container';
|
||||
|
||||
/**
|
||||
* App-scoped marker that makes `arm()` idempotent. Tests call it
|
||||
* from every `setUp()`, and Laravel reuses the same app instance
|
||||
* across tests in most configurations — without this guard we'd
|
||||
* stack one composer per test and replay every one of them on
|
||||
* every view render.
|
||||
*/
|
||||
private const string MARKER = 'pest.tia.blade-edges-armed';
|
||||
|
||||
public static function arm(Recorder $recorder): void
|
||||
{
|
||||
if (! $recorder->isActive()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$containerClass = self::CONTAINER_CLASS;
|
||||
|
||||
if (! class_exists($containerClass)) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var object $app */
|
||||
$app = $containerClass::getInstance();
|
||||
|
||||
if (! method_exists($app, 'bound') || ! method_exists($app, 'make') || ! method_exists($app, 'instance')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($app->bound(self::MARKER)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (! $app->bound('view')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$app->instance(self::MARKER, true);
|
||||
|
||||
$factory = $app->make('view');
|
||||
|
||||
if (! is_object($factory) || ! method_exists($factory, 'composer')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$factory->composer('*', static function (object $view) use ($recorder): void {
|
||||
if (! method_exists($view, 'getPath')) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var mixed $path */
|
||||
$path = $view->getPath();
|
||||
|
||||
if (is_string($path) && $path !== '') {
|
||||
$recorder->linkSource($path);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
49
src/Plugins/Tia/Bootstrapper.php
Normal file
49
src/Plugins/Tia/Bootstrapper.php
Normal file
@ -0,0 +1,49 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
use Pest\Contracts\Bootstrapper as BootstrapperContract;
|
||||
use Pest\Plugins\Tia\Contracts\State;
|
||||
use Pest\Support\Container;
|
||||
use Pest\TestSuite;
|
||||
|
||||
/**
|
||||
* Plugin-level container registrations for TIA. Runs as part of Kernel's
|
||||
* bootstrapper chain so Tia's own service graph is set up without Kernel
|
||||
* having to know about any of its internals.
|
||||
*
|
||||
* Most Tia services (`Recorder`, `CoverageCollector`, `WatchPatterns`,
|
||||
* `ResultCollector`, `BaselineSync`) are auto-buildable — Pest's container
|
||||
* resolves them lazily via constructor reflection. The only service that
|
||||
* requires an explicit binding is the `State` contract, because the
|
||||
* filesystem implementation needs a root-directory string that reflection
|
||||
* can't infer.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final readonly class Bootstrapper implements BootstrapperContract
|
||||
{
|
||||
public function __construct(private Container $container) {}
|
||||
|
||||
public function boot(): void
|
||||
{
|
||||
$this->container->add(State::class, new FileState($this->tempDir()));
|
||||
}
|
||||
|
||||
/**
|
||||
* TIA's per-project state directory. Default layout is
|
||||
* `~/.pest/tia/<project-key>/` so the graph survives `composer
|
||||
* install`, stays out of the project tree, and is naturally shared
|
||||
* across worktrees of the same repo. See {@see Storage} for the key
|
||||
* derivation and the home-dir-missing fallback.
|
||||
*/
|
||||
private function tempDir(): string
|
||||
{
|
||||
$testSuite = $this->container->get(TestSuite::class);
|
||||
assert($testSuite instanceof TestSuite);
|
||||
|
||||
return Storage::tempDir($testSuite->rootPath);
|
||||
}
|
||||
}
|
||||
@ -38,11 +38,11 @@ final readonly class ChangedFiles
|
||||
* that git still reports as modified but whose content is bit-identical
|
||||
* to the previous TIA invocation.
|
||||
*
|
||||
* @param array<int, string> $files project-relative paths.
|
||||
* @param array<int, string> $files project-relative paths.
|
||||
* @param array<string, string> $lastRunTree path → content hash from last run.
|
||||
* @return array<int, string>
|
||||
*/
|
||||
public function filterUnchangedSinceLastRun(array $files, array $lastRunTree): array
|
||||
public function filterUnchangedSinceLastRun(array $files, array $lastRunTree, ?string $sha = null): array
|
||||
{
|
||||
if ($lastRunTree === []) {
|
||||
return $files;
|
||||
@ -85,11 +85,38 @@ final readonly class ChangedFiles
|
||||
continue;
|
||||
}
|
||||
|
||||
$hash = @hash_file('xxh128', $absolute);
|
||||
$hash = ContentHash::of($absolute);
|
||||
|
||||
if ($hash === false || $hash !== $snapshot) {
|
||||
if ($hash === false) {
|
||||
$remaining[] = $file;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($hash === $snapshot) {
|
||||
// Same state as the last TIA invocation — unchanged.
|
||||
continue;
|
||||
}
|
||||
|
||||
// Differs from the snapshot, but may still be a revert back
|
||||
// to the committed version (scenario: last run had an edit,
|
||||
// this run reverted it). Skipping this check causes stale
|
||||
// snapshots from previous scenarios to cascade into the
|
||||
// current run's invalidation set. Cheap to verify via
|
||||
// `git show <sha>:<path>`.
|
||||
if ($sha !== null && $sha !== '') {
|
||||
$baselineContent = $this->contentAtSha($sha, $file);
|
||||
|
||||
if ($baselineContent !== null) {
|
||||
$baselineHash = ContentHash::ofContent($file, $baselineContent);
|
||||
|
||||
if ($hash === $baselineHash) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$remaining[] = $file;
|
||||
}
|
||||
|
||||
return $remaining;
|
||||
@ -101,7 +128,7 @@ final readonly class ChangedFiles
|
||||
* detect which files are actually different.
|
||||
*
|
||||
* @param array<int, string> $files
|
||||
* @return array<string, string> path → xxh128 content hash
|
||||
* @return array<string, string> path → xxh128 content hash
|
||||
*/
|
||||
public function snapshotTree(array $files): array
|
||||
{
|
||||
@ -119,7 +146,7 @@ final readonly class ChangedFiles
|
||||
continue;
|
||||
}
|
||||
|
||||
$hash = @hash_file('xxh128', $absolute);
|
||||
$hash = ContentHash::of($absolute);
|
||||
|
||||
if ($hash !== false) {
|
||||
$out[$file] = $hash;
|
||||
@ -167,7 +194,85 @@ final readonly class ChangedFiles
|
||||
$unique[$file] = true;
|
||||
}
|
||||
|
||||
return array_keys($unique);
|
||||
$candidates = array_keys($unique);
|
||||
|
||||
// Behavioural de-noising: for every file git calls "changed", hash
|
||||
// the current content and the content at `$sha` through
|
||||
// `ContentHash::of()`. A change that only touched comments /
|
||||
// whitespace / blade `{{-- --}}` blocks produces the same hash on
|
||||
// both sides and gets dropped before it can invalidate any test.
|
||||
// Without this, a single-comment edit on a migration re-runs the
|
||||
// entire DB-touching suite.
|
||||
if ($sha !== null && $sha !== '') {
|
||||
return $this->filterBehaviourallyUnchanged($candidates, $sha);
|
||||
}
|
||||
|
||||
return $candidates;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, string> $files
|
||||
* @return array<int, string>
|
||||
*/
|
||||
private function filterBehaviourallyUnchanged(array $files, string $sha): array
|
||||
{
|
||||
$remaining = [];
|
||||
|
||||
foreach ($files as $file) {
|
||||
$absolute = $this->projectRoot.DIRECTORY_SEPARATOR.$file;
|
||||
|
||||
if (! is_file($absolute)) {
|
||||
// Deleted on disk — a genuine change, keep it.
|
||||
$remaining[] = $file;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
$currentHash = ContentHash::of($absolute);
|
||||
|
||||
if ($currentHash === false) {
|
||||
$remaining[] = $file;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
$baselineContent = $this->contentAtSha($sha, $file);
|
||||
|
||||
if ($baselineContent === null) {
|
||||
// Couldn't read the baseline (new file, binary, `git show`
|
||||
// failed). Err on the side of re-running.
|
||||
$remaining[] = $file;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
$baselineHash = ContentHash::ofContent($file, $baselineContent);
|
||||
|
||||
if ($currentHash !== $baselineHash) {
|
||||
$remaining[] = $file;
|
||||
}
|
||||
}
|
||||
|
||||
return $remaining;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads `$path` at `$sha` via `git show`. Returns null when the file
|
||||
* didn't exist at that SHA, when git errors, or when the content
|
||||
* isn't valid UTF-8-safe bytes (rare — binary files that happen to
|
||||
* be tracked).
|
||||
*/
|
||||
private function contentAtSha(string $sha, string $path): ?string
|
||||
{
|
||||
$process = new Process(['git', 'show', $sha.':'.$path], $this->projectRoot);
|
||||
$process->setTimeout(5.0);
|
||||
$process->run();
|
||||
|
||||
if (! $process->isSuccessful()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $process->getOutput();
|
||||
}
|
||||
|
||||
private function shouldIgnore(string $path): bool
|
||||
|
||||
118
src/Plugins/Tia/ContentHash.php
Normal file
118
src/Plugins/Tia/ContentHash.php
Normal file
@ -0,0 +1,118 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
/**
|
||||
* Per-file hashing that ignores changes which can't alter behaviour —
|
||||
* comments and whitespace for PHP, `{{-- … --}}` comments and whitespace
|
||||
* runs for Blade templates. Every other file type falls back to a plain
|
||||
* xxh128 of the raw bytes.
|
||||
*
|
||||
* Why it matters: TIA's file diff signals drive which tests re-run. A
|
||||
* one-line comment tweak on a migration is a behavioural no-op, but the
|
||||
* raw-bytes hash still differs, so every test that talks to the DB would
|
||||
* currently re-execute. Normalising to the parsed-token / compiled-shape
|
||||
* keeps the drift signal honest: edits that can't change runtime
|
||||
* behaviour don't invalidate the replay cache.
|
||||
*
|
||||
* Important: this hash is stored in the graph's last-run tree, so any
|
||||
* format change here must be paired with a `Fingerprint::SCHEMA_VERSION`
|
||||
* bump — otherwise stale hashes from older graphs would be compared
|
||||
* against normalised hashes from the new code and everything would
|
||||
* appear changed.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class ContentHash
|
||||
{
|
||||
/**
|
||||
* xxh128 hex of the file's "behavioural" shape, or `false` when the
|
||||
* file can't be read. Callers should treat `false` the same way they
|
||||
* treated a failed `hash_file()` previously.
|
||||
*/
|
||||
public static function of(string $absolute): string|false
|
||||
{
|
||||
$raw = @file_get_contents($absolute);
|
||||
|
||||
if ($raw === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return self::ofContent($absolute, $raw);
|
||||
}
|
||||
|
||||
/**
|
||||
* Same as `of()` but accepts the file contents in memory. Used when
|
||||
* we already have the bytes (e.g. from `git show <sha>:<path>`) and
|
||||
* want to avoid a disk round-trip.
|
||||
*/
|
||||
public static function ofContent(string $path, string $raw): string
|
||||
{
|
||||
$lower = strtolower($path);
|
||||
|
||||
if (str_ends_with($lower, '.blade.php')) {
|
||||
return self::hashBladeContent($raw);
|
||||
}
|
||||
|
||||
if (str_ends_with($lower, '.php')) {
|
||||
return self::hashPhpContent($raw);
|
||||
}
|
||||
|
||||
return hash('xxh128', $raw);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tokenise the content and hash the concatenated values of every
|
||||
* token except whitespace / comment / docblock. `token_get_all()`
|
||||
* is built-in, fast, and enough to collapse any formatting-only
|
||||
* edit. If tokenisation fails (rare syntax error), fall back to
|
||||
* the raw hash so the caller still gets a deterministic signal.
|
||||
*/
|
||||
private static function hashPhpContent(string $raw): string
|
||||
{
|
||||
$tokens = @token_get_all($raw);
|
||||
|
||||
if ($tokens === []) {
|
||||
return hash('xxh128', $raw);
|
||||
}
|
||||
|
||||
$normalised = '';
|
||||
|
||||
foreach ($tokens as $token) {
|
||||
if (is_array($token)) {
|
||||
if ($token[0] === T_WHITESPACE) {
|
||||
continue;
|
||||
}
|
||||
if ($token[0] === T_COMMENT) {
|
||||
continue;
|
||||
}
|
||||
if ($token[0] === T_DOC_COMMENT) {
|
||||
continue;
|
||||
}
|
||||
$normalised .= $token[1];
|
||||
} else {
|
||||
$normalised .= $token;
|
||||
}
|
||||
}
|
||||
|
||||
return hash('xxh128', $normalised);
|
||||
}
|
||||
|
||||
/**
|
||||
* Blade templates aren't PHP syntactically, so `token_get_all()`
|
||||
* doesn't help. Strip `{{-- … --}}` comments (the only Blade-native
|
||||
* comment form) and collapse whitespace runs. Output differences
|
||||
* that would survive the Blade compiler (markup reordering, new
|
||||
* directives, changed interpolation) still flip the hash; pure
|
||||
* reformatting does not.
|
||||
*/
|
||||
private static function hashBladeContent(string $raw): string
|
||||
{
|
||||
$stripped = preg_replace('/\{\{--.*?--\}\}/s', '', $raw) ?? $raw;
|
||||
$stripped = preg_replace('/\s+/', ' ', $stripped) ?? $stripped;
|
||||
|
||||
return hash('xxh128', trim($stripped));
|
||||
}
|
||||
}
|
||||
48
src/Plugins/Tia/Contracts/State.php
Normal file
48
src/Plugins/Tia/Contracts/State.php
Normal file
@ -0,0 +1,48 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia\Contracts;
|
||||
|
||||
/**
|
||||
* Storage contract for TIA's persistent state (graph, baselines, affected
|
||||
* set, worker partials, coverage snapshots). Modelled as a flat key/value
|
||||
* store of raw byte blobs so implementations can sit on top of whatever
|
||||
* backend fits — a directory, a shared cache, a remote object store — and
|
||||
* TIA's logic stays identical.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
interface State
|
||||
{
|
||||
/**
|
||||
* Returns the stored blob for `$key`, or `null` when the key is unset
|
||||
* or cannot be read.
|
||||
*/
|
||||
public function read(string $key): ?string;
|
||||
|
||||
/**
|
||||
* Atomically stores `$content` under `$key`. Existing value (if any) is
|
||||
* replaced. Implementations SHOULD guarantee that concurrent readers
|
||||
* never observe partial writes.
|
||||
*/
|
||||
public function write(string $key, string $content): bool;
|
||||
|
||||
/**
|
||||
* Removes `$key`. Returns true whether or not the key existed beforehand
|
||||
* — callers should treat a `true` result as "the key is now absent",
|
||||
* not "the key was present and has been removed."
|
||||
*/
|
||||
public function delete(string $key): bool;
|
||||
|
||||
public function exists(string $key): bool;
|
||||
|
||||
/**
|
||||
* Returns every key whose name starts with `$prefix`. Used to collect
|
||||
* paratest worker partials (`worker-edges-<token>.json`, etc.) without
|
||||
* exposing backend-specific glob semantics.
|
||||
*
|
||||
* @return list<string>
|
||||
*/
|
||||
public function keysWithPrefix(string $prefix): array;
|
||||
}
|
||||
@ -5,6 +5,8 @@ declare(strict_types=1);
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
use Pest\Plugins\Tia;
|
||||
use Pest\Plugins\Tia\Contracts\State;
|
||||
use Pest\Support\Container;
|
||||
use SebastianBergmann\CodeCoverage\CodeCoverage;
|
||||
use Throwable;
|
||||
|
||||
@ -14,7 +16,7 @@ use Throwable;
|
||||
* executing only the affected tests.
|
||||
*
|
||||
* Invoked from `Pest\Support\Coverage::report()` right before the coverage
|
||||
* file is consumed. A marker file dropped by the `Tia` plugin gates the
|
||||
* file is consumed. A marker dropped by the `Tia` plugin gates the
|
||||
* behaviour — plain `--coverage` runs (no `--tia`) leave the marker absent
|
||||
* and therefore keep their existing semantics.
|
||||
*
|
||||
@ -24,19 +26,17 @@ use Throwable;
|
||||
* Its `ProcessedCodeCoverageData` stores, per source file, per line, the
|
||||
* list of test IDs that covered that line. We:
|
||||
*
|
||||
* 1. Load the cached snapshot (from a previous `--tia --coverage` run).
|
||||
* 1. Load the cached snapshot from `State` (serialised bytes).
|
||||
* 2. Strip every test id that re-ran this time from the cached map —
|
||||
* the tests that ran now are the ones whose attribution is fresh.
|
||||
* 3. Merge the current run into the stripped cached snapshot via
|
||||
* `CodeCoverage::merge()`.
|
||||
* 4. Write the merged result back to the report path (so Pest's report
|
||||
* generator sees the full suite) and to the cache path (for the
|
||||
* generator sees the full suite) and back into `State` (for the
|
||||
* next invocation).
|
||||
* 5. Remove the marker so subsequent plain `--coverage` runs are
|
||||
* untouched.
|
||||
*
|
||||
* If no cache exists yet (first `--tia --coverage` run on this machine)
|
||||
* we simply save the current file as the cache — nothing to merge yet.
|
||||
* we serialise the current object and save it — nothing to merge yet.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
@ -44,35 +44,33 @@ final class CoverageMerger
|
||||
{
|
||||
public static function applyIfMarked(string $reportPath): void
|
||||
{
|
||||
$markerPath = Tia::coverageMarkerPath();
|
||||
$state = self::state();
|
||||
|
||||
if (! is_file($markerPath)) {
|
||||
if (! $state instanceof State || ! $state->exists(Tia::KEY_COVERAGE_MARKER)) {
|
||||
return;
|
||||
}
|
||||
|
||||
@unlink($markerPath);
|
||||
$state->delete(Tia::KEY_COVERAGE_MARKER);
|
||||
|
||||
$cachePath = Tia::coverageCachePath();
|
||||
$cachedBytes = $state->read(Tia::KEY_COVERAGE_CACHE);
|
||||
|
||||
if (! is_file($cachePath)) {
|
||||
// First `--tia --coverage` run: nothing cached yet, the current
|
||||
// report is the full suite itself. Save it verbatim so the next
|
||||
// run has a snapshot to merge against.
|
||||
@copy($reportPath, $cachePath);
|
||||
if ($cachedBytes === null) {
|
||||
// First `--tia --coverage` run: nothing cached yet, so the
|
||||
// current file already represents the full suite. Capture it
|
||||
// verbatim (as serialised bytes) for next time.
|
||||
$current = self::requireCoverage($reportPath);
|
||||
|
||||
if ($current instanceof CodeCoverage) {
|
||||
$state->write(Tia::KEY_COVERAGE_CACHE, serialize($current));
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
/** @var CodeCoverage $cached */
|
||||
$cached = require $cachePath;
|
||||
$cached = self::unserializeCoverage($cachedBytes);
|
||||
$current = self::requireCoverage($reportPath);
|
||||
|
||||
/** @var CodeCoverage $current */
|
||||
$current = require $reportPath;
|
||||
} catch (Throwable) {
|
||||
// Corrupt cache or unreadable report — fall back to the plain
|
||||
// PHPUnit behaviour (the existing `require $reportPath` in the
|
||||
// caller still runs against the untouched file).
|
||||
if (! $cached instanceof CodeCoverage || ! $current instanceof CodeCoverage) {
|
||||
return;
|
||||
}
|
||||
|
||||
@ -80,15 +78,15 @@ final class CoverageMerger
|
||||
|
||||
$cached->merge($current);
|
||||
|
||||
// Serialise the merged object back using PHPUnit's own "return
|
||||
// expression" PHP format. Using `var_export` on the serialised
|
||||
// payload keeps the file self-contained and independent of
|
||||
// PHPUnit's internal exporter — the reader only needs to
|
||||
// `require` it back.
|
||||
$serialised = "<?php return unserialize(".var_export(serialize($cached), true).");\n";
|
||||
$serialised = serialize($cached);
|
||||
|
||||
@file_put_contents($reportPath, $serialised);
|
||||
@file_put_contents($cachePath, $serialised);
|
||||
// Write back to the PHPUnit-style `.cov` path so the report reader
|
||||
// can `require` it, and to the state cache for the next run.
|
||||
@file_put_contents(
|
||||
$reportPath,
|
||||
'<?php return unserialize('.var_export($serialised, true).");\n",
|
||||
);
|
||||
$state->write(Tia::KEY_COVERAGE_CACHE, $serialised);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -110,10 +108,12 @@ final class CoverageMerger
|
||||
|
||||
foreach ($lineCoverage as $file => $lines) {
|
||||
foreach ($lines as $line => $ids) {
|
||||
if ($ids === null || $ids === []) {
|
||||
if ($ids === null) {
|
||||
continue;
|
||||
}
|
||||
if ($ids === []) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$filtered = array_values(array_diff($ids, $currentIds));
|
||||
|
||||
if ($filtered !== $ids) {
|
||||
@ -146,4 +146,42 @@ final class CoverageMerger
|
||||
|
||||
return array_keys($ids);
|
||||
}
|
||||
|
||||
private static function state(): ?State
|
||||
{
|
||||
try {
|
||||
$state = Container::getInstance()->get(State::class);
|
||||
} catch (Throwable) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $state instanceof State ? $state : null;
|
||||
}
|
||||
|
||||
private static function requireCoverage(string $reportPath): ?CodeCoverage
|
||||
{
|
||||
if (! is_file($reportPath)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
try {
|
||||
/** @var mixed $value */
|
||||
$value = require $reportPath;
|
||||
} catch (Throwable) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $value instanceof CodeCoverage ? $value : null;
|
||||
}
|
||||
|
||||
private static function unserializeCoverage(string $bytes): ?CodeCoverage
|
||||
{
|
||||
try {
|
||||
$value = @unserialize($bytes);
|
||||
} catch (Throwable) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $value instanceof CodeCoverage ? $value : null;
|
||||
}
|
||||
}
|
||||
|
||||
150
src/Plugins/Tia/FileState.php
Normal file
150
src/Plugins/Tia/FileState.php
Normal file
@ -0,0 +1,150 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
use Pest\Plugins\Tia\Contracts\State;
|
||||
|
||||
/**
|
||||
* Filesystem-backed implementation of the TIA `State` contract. Each key
|
||||
* maps verbatim to a file name under `$rootDir`, so existing `.temp/*.json`
|
||||
* layouts are preserved exactly.
|
||||
*
|
||||
* The root directory is created lazily on first write — callers don't have
|
||||
* to pre-provision it, and reads against a missing directory simply return
|
||||
* `null` rather than throwing.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final readonly class FileState implements State
|
||||
{
|
||||
/**
|
||||
* Configured root. May not exist on disk yet; resolved + created on
|
||||
* the first write. Keeping the raw string lets the instance be built
|
||||
* before Pest's temp dir has been materialised.
|
||||
*/
|
||||
private string $rootDir;
|
||||
|
||||
public function __construct(string $rootDir)
|
||||
{
|
||||
$this->rootDir = rtrim($rootDir, DIRECTORY_SEPARATOR);
|
||||
}
|
||||
|
||||
public function read(string $key): ?string
|
||||
{
|
||||
$path = $this->pathFor($key);
|
||||
|
||||
if (! is_file($path)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$bytes = @file_get_contents($path);
|
||||
|
||||
return $bytes === false ? null : $bytes;
|
||||
}
|
||||
|
||||
public function write(string $key, string $content): bool
|
||||
{
|
||||
if (! $this->ensureRoot()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$path = $this->pathFor($key);
|
||||
$tmp = $path.'.'.bin2hex(random_bytes(4)).'.tmp';
|
||||
|
||||
if (@file_put_contents($tmp, $content) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Atomic rename — on POSIX filesystems this is a single-step
|
||||
// replacement, so concurrent readers never see a half-written file.
|
||||
if (! @rename($tmp, $path)) {
|
||||
@unlink($tmp);
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public function delete(string $key): bool
|
||||
{
|
||||
$path = $this->pathFor($key);
|
||||
|
||||
if (! is_file($path)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return @unlink($path);
|
||||
}
|
||||
|
||||
public function exists(string $key): bool
|
||||
{
|
||||
return is_file($this->pathFor($key));
|
||||
}
|
||||
|
||||
public function keysWithPrefix(string $prefix): array
|
||||
{
|
||||
$root = $this->resolvedRoot();
|
||||
|
||||
if ($root === null) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$pattern = $root.DIRECTORY_SEPARATOR.$prefix.'*';
|
||||
$matches = glob($pattern);
|
||||
|
||||
if ($matches === false) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$keys = [];
|
||||
|
||||
foreach ($matches as $path) {
|
||||
$keys[] = basename($path);
|
||||
}
|
||||
|
||||
return $keys;
|
||||
}
|
||||
|
||||
/**
|
||||
* Absolute path for `$key`. Not part of the interface — used by the
|
||||
* coverage merger and similar callers that need direct filesystem
|
||||
* access (e.g. `require` on a cached PHP file). Consumers that only
|
||||
* deal in bytes should go through `read()` / `write()`.
|
||||
*/
|
||||
public function pathFor(string $key): string
|
||||
{
|
||||
return $this->rootDir.DIRECTORY_SEPARATOR.$key;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the resolved root if it exists already, otherwise `null`.
|
||||
* Used by read-side helpers so they don't eagerly create the directory
|
||||
* just to find nothing inside.
|
||||
*/
|
||||
private function resolvedRoot(): ?string
|
||||
{
|
||||
$resolved = @realpath($this->rootDir);
|
||||
|
||||
return $resolved === false ? null : $resolved;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates the root dir on demand. Returns false only when creation
|
||||
* fails and the directory still isn't there afterwards.
|
||||
*/
|
||||
private function ensureRoot(): bool
|
||||
{
|
||||
if (is_dir($this->rootDir)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (@mkdir($this->rootDir, 0755, true)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return is_dir($this->rootDir);
|
||||
}
|
||||
}
|
||||
@ -5,52 +5,184 @@ declare(strict_types=1);
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
/**
|
||||
* Captures environmental inputs that, when changed, make the TIA graph stale.
|
||||
* Captures environmental inputs that, when changed, may make the TIA graph
|
||||
* or its recorded results stale. The fingerprint is split into two buckets:
|
||||
*
|
||||
* Any drift in PHP version, Composer lock, or Pest/PHPUnit config can change
|
||||
* what a test actually exercises, so the graph must be rebuilt in those cases.
|
||||
* - **structural** — describes what the graph's *edges* were recorded
|
||||
* against. If any of these drift (`composer.lock`, `tests/Pest.php`,
|
||||
* Pest's factory codegen, etc.) the edges themselves are potentially
|
||||
* wrong and the graph must rebuild from scratch.
|
||||
* - **environmental** — describes the *runtime* the results were captured
|
||||
* on (PHP minor, extension set, Pest version). Drift here means the
|
||||
* edges are still trustworthy, but the cached per-test results (pass/
|
||||
* fail/time) may not reproduce on this machine. Tia's handler drops the
|
||||
* branch's results + coverage cache and re-runs to freshen them, rather
|
||||
* than re-recording from scratch.
|
||||
*
|
||||
* Legacy flat-shape graphs (schema ≤ 3) are read as structurally stale and
|
||||
* rebuilt on first load; the schema bump in the structural bucket takes
|
||||
* care of that automatically.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final readonly class Fingerprint
|
||||
{
|
||||
// Bump this whenever the set of inputs or the hash algorithm changes, so
|
||||
// older graphs are invalidated automatically.
|
||||
private const int SCHEMA_VERSION = 2;
|
||||
// Bump this whenever the set of inputs or the hash algorithm changes,
|
||||
// so older graphs are invalidated automatically.
|
||||
//
|
||||
// v5: ChangedFiles now hashes via `ContentHash` (normalises PHP
|
||||
// tokens + Blade whitespace/comments) instead of raw bytes.
|
||||
// Old graphs' run-tree hashes are incompatible and must be
|
||||
// rebuilt.
|
||||
// v6: Graph gained per-test table edges (`$testTables`) powering
|
||||
// surgical migration invalidation. Worker partial shape
|
||||
// changed to `{files, tables}`. Old graphs have no table
|
||||
// coverage, which would leave every DB test invalidated by
|
||||
// any migration change — force a rebuild so the new edges
|
||||
// are populated.
|
||||
// v7: Graph gained per-test Inertia page-component edges
|
||||
// (`$testInertiaComponents`) for surgical page-file
|
||||
// invalidation. Worker partial now includes an `inertia`
|
||||
// section. Old graphs have no component edges; without a
|
||||
// rebuild Vue/React page edits would fall through to the
|
||||
// broad watch pattern even when precise matching could have
|
||||
// worked.
|
||||
// v8: Graph gained `$jsFileToComponents` — reverse dependency
|
||||
// map computed at record time from Vite's module graph (or
|
||||
// the PHP fallback) so shared components / layouts /
|
||||
// composables invalidate the specific pages they're used
|
||||
// by, not every browser test.
|
||||
private const int SCHEMA_VERSION = 8;
|
||||
|
||||
/**
|
||||
* @return array<string, int|string|null>
|
||||
* @return array{
|
||||
* structural: array<string, int|string|null>,
|
||||
* environmental: array<string, string|null>,
|
||||
* }
|
||||
*/
|
||||
public static function compute(string $projectRoot): array
|
||||
{
|
||||
return [
|
||||
'schema' => self::SCHEMA_VERSION,
|
||||
'php' => PHP_VERSION,
|
||||
'pest' => self::readPestVersion($projectRoot),
|
||||
'composer_lock' => self::hashIfExists($projectRoot.'/composer.lock'),
|
||||
'phpunit_xml' => self::hashIfExists($projectRoot.'/phpunit.xml'),
|
||||
'phpunit_xml_dist' => self::hashIfExists($projectRoot.'/phpunit.xml.dist'),
|
||||
'pest_php' => self::hashIfExists($projectRoot.'/tests/Pest.php'),
|
||||
// Pest's generated classes bake the code-generation logic in — if
|
||||
// TestCaseFactory changes (new attribute, different method
|
||||
// signature, etc.) every previously-recorded edge is stale.
|
||||
// Hashing the factory sources makes path-repo / dev-main installs
|
||||
// automatically rebuild their graphs when Pest itself is edited.
|
||||
'pest_factory' => self::hashIfExists(__DIR__.'/../../Factories/TestCaseFactory.php'),
|
||||
'pest_method_factory' => self::hashIfExists(__DIR__.'/../../Factories/TestCaseMethodFactory.php'),
|
||||
'structural' => [
|
||||
'schema' => self::SCHEMA_VERSION,
|
||||
'composer_lock' => self::hashIfExists($projectRoot.'/composer.lock'),
|
||||
'phpunit_xml' => self::hashIfExists($projectRoot.'/phpunit.xml'),
|
||||
'phpunit_xml_dist' => self::hashIfExists($projectRoot.'/phpunit.xml.dist'),
|
||||
'pest_php' => self::hashIfExists($projectRoot.'/tests/Pest.php'),
|
||||
// Pest's generated classes bake the code-generation logic
|
||||
// in — if TestCaseFactory changes (new attribute, different
|
||||
// method signature, etc.) every previously-recorded edge is
|
||||
// stale. Hashing the factory sources makes path-repo /
|
||||
// dev-main installs automatically rebuild their graphs when
|
||||
// Pest itself is edited.
|
||||
'pest_factory' => self::hashIfExists(__DIR__.'/../../Factories/TestCaseFactory.php'),
|
||||
'pest_method_factory' => self::hashIfExists(__DIR__.'/../../Factories/TestCaseMethodFactory.php'),
|
||||
],
|
||||
'environmental' => [
|
||||
// PHP **minor** only (8.4, not 8.4.19) — CI's resolved patch
|
||||
// almost never matches a dev's Herd/Homebrew install, and
|
||||
// the patch rarely changes anything test-visible.
|
||||
'php_minor' => PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION,
|
||||
'extensions' => self::extensionsFingerprint($projectRoot),
|
||||
'pest' => self::readPestVersion($projectRoot),
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* True when the structural buckets match. Drift here means the edges
|
||||
* are potentially wrong; caller should discard the graph and rebuild.
|
||||
*
|
||||
* @param array<string, mixed> $a
|
||||
* @param array<string, mixed> $b
|
||||
*/
|
||||
public static function matches(array $a, array $b): bool
|
||||
public static function structuralMatches(array $a, array $b): bool
|
||||
{
|
||||
ksort($a);
|
||||
ksort($b);
|
||||
$aStructural = self::structuralOnly($a);
|
||||
$bStructural = self::structuralOnly($b);
|
||||
|
||||
return $a === $b;
|
||||
ksort($aStructural);
|
||||
ksort($bStructural);
|
||||
|
||||
return $aStructural === $bStructural;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of field names that drifted between the stored and
|
||||
* current environmental fingerprints. Empty list = no drift. Caller
|
||||
* uses this to print a human-readable warning and to decide whether
|
||||
* per-test results should be dropped (any drift → yes).
|
||||
*
|
||||
* @param array<string, mixed> $stored
|
||||
* @param array<string, mixed> $current
|
||||
* @return list<string>
|
||||
*/
|
||||
public static function environmentalDrift(array $stored, array $current): array
|
||||
{
|
||||
$a = self::environmentalOnly($stored);
|
||||
$b = self::environmentalOnly($current);
|
||||
|
||||
$drifts = [];
|
||||
|
||||
foreach ($a as $key => $value) {
|
||||
if (($b[$key] ?? null) !== $value) {
|
||||
$drifts[] = $key;
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($b as $key => $value) {
|
||||
if (! array_key_exists($key, $a) && $value !== null) {
|
||||
$drifts[] = $key;
|
||||
}
|
||||
}
|
||||
|
||||
return array_values(array_unique($drifts));
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $fingerprint
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private static function structuralOnly(array $fingerprint): array
|
||||
{
|
||||
return self::bucket($fingerprint, 'structural');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $fingerprint
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private static function environmentalOnly(array $fingerprint): array
|
||||
{
|
||||
return self::bucket($fingerprint, 'environmental');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns `$fingerprint[$key]` as an `array<string, mixed>` if it exists
|
||||
* and is an array, otherwise empty. Legacy flat-shape fingerprints
|
||||
* (schema ≤ 3) return empty here, which makes `structuralMatches` fail
|
||||
* and the caller rebuild — the clean migration path.
|
||||
*
|
||||
* @param array<string, mixed> $fingerprint
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private static function bucket(array $fingerprint, string $key): array
|
||||
{
|
||||
$raw = $fingerprint[$key] ?? null;
|
||||
|
||||
if (! is_array($raw)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$normalised = [];
|
||||
|
||||
foreach ($raw as $k => $v) {
|
||||
if (is_string($k)) {
|
||||
$normalised[$k] = $v;
|
||||
}
|
||||
}
|
||||
|
||||
return $normalised;
|
||||
}
|
||||
|
||||
private static function hashIfExists(string $path): ?string
|
||||
@ -64,6 +196,84 @@ final readonly class Fingerprint
|
||||
return $hash === false ? null : $hash;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deterministic hash of the extensions the project actually depends on —
|
||||
* the `ext-*` entries in composer.json's `require` / `require-dev`. An
|
||||
* incidental extension loaded on the developer's machine (or on CI) but
|
||||
* not declared as a dependency can't affect correctness of the test
|
||||
* suite, so we ignore it here to keep the drift signal quiet.
|
||||
*
|
||||
* Declared extensions that aren't currently loaded record as `missing`,
|
||||
* which is itself a drift signal worth surfacing.
|
||||
*/
|
||||
private static function extensionsFingerprint(string $projectRoot): string
|
||||
{
|
||||
$extensions = self::declaredExtensions($projectRoot);
|
||||
|
||||
if ($extensions === []) {
|
||||
return hash('xxh128', '');
|
||||
}
|
||||
|
||||
sort($extensions);
|
||||
|
||||
$parts = [];
|
||||
|
||||
foreach ($extensions as $name) {
|
||||
$version = phpversion($name);
|
||||
$parts[] = $name.'@'.($version === false ? 'missing' : $version);
|
||||
}
|
||||
|
||||
return hash('xxh128', implode("\n", $parts));
|
||||
}
|
||||
|
||||
/**
|
||||
* Extension names (without the `ext-` prefix) that appear as keys under
|
||||
* `require` or `require-dev` in the project's composer.json. Returns
|
||||
* an empty list when composer.json is missing / unreadable / malformed,
|
||||
* so the environmental fingerprint stays stable in those cases rather
|
||||
* than flapping.
|
||||
*
|
||||
* @return list<string>
|
||||
*/
|
||||
private static function declaredExtensions(string $projectRoot): array
|
||||
{
|
||||
$path = $projectRoot.'/composer.json';
|
||||
|
||||
if (! is_file($path)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$raw = @file_get_contents($path);
|
||||
|
||||
if ($raw === false) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$data = json_decode($raw, true);
|
||||
|
||||
if (! is_array($data)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$extensions = [];
|
||||
|
||||
foreach (['require', 'require-dev'] as $section) {
|
||||
$packages = $data[$section] ?? null;
|
||||
|
||||
if (! is_array($packages)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach (array_keys($packages) as $package) {
|
||||
if (is_string($package) && str_starts_with($package, 'ext-')) {
|
||||
$extensions[] = substr($package, 4);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return array_values(array_unique($extensions));
|
||||
}
|
||||
|
||||
private static function readPestVersion(string $projectRoot): string
|
||||
{
|
||||
$installed = $projectRoot.'/vendor/composer/installed.json';
|
||||
|
||||
@ -40,6 +40,51 @@ final class Graph
|
||||
*/
|
||||
private array $edges = [];
|
||||
|
||||
/**
|
||||
* Table edges: test file (relative) → list of lowercase SQL table
|
||||
* names the test queried during record. Populated from the
|
||||
* Recorder's `perTestTables()` snapshot; consumed at replay time
|
||||
* to do surgical invalidation when a migration changes — the
|
||||
* test only re-runs if its set intersects the tables the changed
|
||||
* migration touches. Empty for tests that never hit the DB, which
|
||||
* is exactly why those tests stay unaffected by migration edits.
|
||||
*
|
||||
* Unlike `$edges`, we store names rather than ids: the table
|
||||
* universe is small (hundreds at most on a giant app), storing
|
||||
* strings keeps the on-disk graph diff-readable, and the lookup
|
||||
* cost is negligible compared to the per-file ids used above.
|
||||
*
|
||||
* @var array<string, array<int, string>>
|
||||
*/
|
||||
private array $testTables = [];
|
||||
|
||||
/**
|
||||
* Inertia page component edges: test file (relative) → list of
|
||||
* component names the test server-side rendered (whatever was
|
||||
* passed to `Inertia::render($component, …)`). Populated from
|
||||
* `Recorder::perTestInertiaComponents()`; consumed at replay time
|
||||
* so an edit to `resources/js/Pages/Users/Show.vue` only invalidates
|
||||
* tests that rendered `Users/Show`. Same string-keyed shape as
|
||||
* `$testTables` for the same diff-readable reasons.
|
||||
*
|
||||
* @var array<string, array<int, string>>
|
||||
*/
|
||||
private array $testInertiaComponents = [];
|
||||
|
||||
/**
|
||||
* Inverted JS dependency map: project-relative source path under
|
||||
* `resources/js/**` → list of Inertia page components that
|
||||
* transitively import it. Populated at record time by
|
||||
* `JsModuleGraph::build()` (Vite module graph via Node helper,
|
||||
* with a PHP fallback). Replay uses this to route a
|
||||
* `Components/Button.vue` edit directly to the pages that depend
|
||||
* on it, intersecting against `$testInertiaComponents` for
|
||||
* surgical invalidation.
|
||||
*
|
||||
* @var array<string, array<int, string>>
|
||||
*/
|
||||
private array $jsFileToComponents = [];
|
||||
|
||||
/**
|
||||
* Environment fingerprint captured at record time.
|
||||
*
|
||||
@ -60,7 +105,7 @@ final class Graph
|
||||
* @var array<string, array{
|
||||
* sha: ?string,
|
||||
* tree: array<string, string>,
|
||||
* results: array<string, array{status: int, message: string, time: float}>
|
||||
* results: array<string, array{status: int, message: string, time: float, assertions?: int}>
|
||||
* }>
|
||||
*/
|
||||
private array $baselines = [];
|
||||
@ -126,11 +171,155 @@ final class Graph
|
||||
}
|
||||
}
|
||||
|
||||
// 1. Coverage-edge lookup (PHP → PHP).
|
||||
$affectedSet = [];
|
||||
|
||||
// Migration changes don't flow through the coverage-edge path —
|
||||
// `RefreshDatabase` in every test's `setUp()` means every test
|
||||
// has an edge to every migration, so step 1 would re-run the
|
||||
// whole DB-touching suite on any migration edit. Route them
|
||||
// separately: static-parse the migration source, union the
|
||||
// referenced tables, and match tests whose recorded query
|
||||
// footprint intersects that set. Missed files (rare: migrations
|
||||
// with pure raw SQL or dynamic names) fall back to the watch
|
||||
// pattern below.
|
||||
$migrationPaths = [];
|
||||
$nonMigrationPaths = [];
|
||||
|
||||
foreach ($normalised as $rel) {
|
||||
if ($this->isMigrationPath($rel)) {
|
||||
$migrationPaths[] = $rel;
|
||||
} else {
|
||||
$nonMigrationPaths[] = $rel;
|
||||
}
|
||||
}
|
||||
|
||||
$changedTables = [];
|
||||
$unparseableMigrations = [];
|
||||
|
||||
foreach ($migrationPaths as $rel) {
|
||||
$tables = $this->tablesForMigration($rel);
|
||||
|
||||
if ($tables === []) {
|
||||
$unparseableMigrations[] = $rel;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ($tables as $table) {
|
||||
$changedTables[$table] = true;
|
||||
}
|
||||
}
|
||||
|
||||
if ($changedTables !== []) {
|
||||
foreach ($this->testTables as $testFile => $tables) {
|
||||
if (isset($affectedSet[$testFile])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ($tables as $table) {
|
||||
if (isset($changedTables[$table])) {
|
||||
$affectedSet[$testFile] = true;
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Inertia page-component routing. When a Vue/React/Svelte page
|
||||
// under `resources/js/Pages/` changes, map it to the component
|
||||
// name Inertia would use (the path relative to `Pages/`, with
|
||||
// the extension stripped) and intersect with the captured
|
||||
// component edges. Only invalidates tests that actually
|
||||
// rendered the page. Pages with no captured edges (never
|
||||
// rendered during record, brand-new on this branch) fall
|
||||
// through to the watch-pattern fallback via
|
||||
// `$unknownPageComponents` — safe over-run.
|
||||
$changedComponents = [];
|
||||
$unknownPageComponents = [];
|
||||
|
||||
foreach ($nonMigrationPaths as $rel) {
|
||||
$component = $this->componentForInertiaPage($rel);
|
||||
|
||||
if ($component === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($this->anyTestUses($this->testInertiaComponents, $component)) {
|
||||
$changedComponents[$component] = true;
|
||||
} else {
|
||||
$unknownPageComponents[] = $rel;
|
||||
}
|
||||
}
|
||||
|
||||
// Pages whose component already resolved precisely via the
|
||||
// direct Inertia edges path must not leak back through any
|
||||
// broader mechanism (either the JS-dep lookup below, or the
|
||||
// watch pattern further down).
|
||||
$preciselyHandledPages = [];
|
||||
foreach ($nonMigrationPaths as $rel) {
|
||||
$component = $this->componentForInertiaPage($rel);
|
||||
|
||||
if ($component !== null && isset($changedComponents[$component])) {
|
||||
$preciselyHandledPages[$rel] = true;
|
||||
}
|
||||
}
|
||||
|
||||
// Shared JS files (Components, Layouts, composables, etc.)
|
||||
// aren't Inertia pages but pages depend on them transitively.
|
||||
// `$jsFileToComponents` was computed at record time by walking
|
||||
// Vite's module graph, so a change to
|
||||
// `resources/js/Components/Button.vue` resolves directly to
|
||||
// the set of page components that import it. Union those into
|
||||
// `$changedComponents`. Files that aren't in the JS dep map
|
||||
// fall through to the watch pattern below — same safety-net
|
||||
// path the Inertia block above uses for unresolved pages.
|
||||
$sharedFilesResolved = [];
|
||||
foreach ($nonMigrationPaths as $rel) {
|
||||
if (isset($preciselyHandledPages[$rel])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (! isset($this->jsFileToComponents[$rel])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$touchedAny = false;
|
||||
foreach ($this->jsFileToComponents[$rel] as $pageComponent) {
|
||||
if ($this->anyTestUses($this->testInertiaComponents, $pageComponent)) {
|
||||
$changedComponents[$pageComponent] = true;
|
||||
$touchedAny = true;
|
||||
}
|
||||
}
|
||||
|
||||
if ($touchedAny) {
|
||||
$sharedFilesResolved[$rel] = true;
|
||||
}
|
||||
}
|
||||
|
||||
if ($changedComponents !== []) {
|
||||
foreach ($this->testInertiaComponents as $testFile => $components) {
|
||||
if (isset($affectedSet[$testFile])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ($components as $component) {
|
||||
if (isset($changedComponents[$component])) {
|
||||
$affectedSet[$testFile] = true;
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 1. Coverage-edge lookup (PHP → PHP). Migrations are already
|
||||
// handled above; skipping them here prevents their always-on
|
||||
// coverage edges from invalidating the whole DB suite.
|
||||
$changedIds = [];
|
||||
$unknownSourceDirs = [];
|
||||
|
||||
foreach ($normalised as $rel) {
|
||||
foreach ($nonMigrationPaths as $rel) {
|
||||
if (isset($this->fileIds[$rel])) {
|
||||
$changedIds[$this->fileIds[$rel]] = true;
|
||||
} elseif (str_ends_with($rel, '.php') && ! str_starts_with($rel, 'tests/')) {
|
||||
@ -141,9 +330,11 @@ final class Graph
|
||||
}
|
||||
}
|
||||
|
||||
$affectedSet = [];
|
||||
|
||||
foreach ($this->edges as $testFile => $ids) {
|
||||
if (isset($affectedSet[$testFile])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ($ids as $id) {
|
||||
if (isset($changedIds[$id])) {
|
||||
$affectedSet[$testFile] = true;
|
||||
@ -153,11 +344,39 @@ final class Graph
|
||||
}
|
||||
}
|
||||
|
||||
// 2. Watch-pattern lookup (non-PHP assets → test directories).
|
||||
// 2. Watch-pattern lookup — fallback for files we don't have
|
||||
// precise edges for. When a file is already in `$fileIds` step
|
||||
// 1 resolved it surgically; broadcasting it again through the
|
||||
// watch pattern would re-add every test the pattern maps to,
|
||||
// defeating the point of recording the edge in the first place.
|
||||
// Blade templates captured via Laravel's view composer are the
|
||||
// motivating case — we want their specific tests, not every
|
||||
// feature test. Migrations whose static parse yielded nothing
|
||||
// (exotic syntax, raw SQL) are funneled back in here too so
|
||||
// broad invalidation still kicks in for edge cases we can't
|
||||
// parse.
|
||||
// Exclude paths that were already routed precisely through
|
||||
// either the Inertia page-component path or the shared-JS
|
||||
// dependency path. Broadcasting them again via the watch
|
||||
// pattern would re-add every test the pattern maps to,
|
||||
// defeating the surgical match.
|
||||
$unknownToGraph = $unparseableMigrations;
|
||||
foreach ($nonMigrationPaths as $rel) {
|
||||
if (isset($preciselyHandledPages[$rel])) {
|
||||
continue;
|
||||
}
|
||||
if (isset($sharedFilesResolved[$rel])) {
|
||||
continue;
|
||||
}
|
||||
if (! isset($this->fileIds[$rel])) {
|
||||
$unknownToGraph[] = $rel;
|
||||
}
|
||||
}
|
||||
|
||||
/** @var WatchPatterns $watchPatterns */
|
||||
$watchPatterns = Container::getInstance()->get(WatchPatterns::class);
|
||||
|
||||
$dirs = $watchPatterns->matchedDirectories($this->projectRoot, $normalised);
|
||||
$dirs = $watchPatterns->matchedDirectories($this->projectRoot, $unknownToGraph);
|
||||
$allTestFiles = array_keys($this->edges);
|
||||
|
||||
foreach ($watchPatterns->testsUnderDirectories($dirs, $allTestFiles) as $testFile) {
|
||||
@ -223,7 +442,7 @@ final class Graph
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, int|string|null> $fingerprint
|
||||
* @param array<string, mixed> $fingerprint
|
||||
*/
|
||||
public function setFingerprint(array $fingerprint): void
|
||||
{
|
||||
@ -231,7 +450,7 @@ final class Graph
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, int|string|null>
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
public function fingerprint(): array
|
||||
{
|
||||
@ -257,14 +476,34 @@ final class Graph
|
||||
$this->baselines[$branch]['sha'] = $sha;
|
||||
}
|
||||
|
||||
public function setResult(string $branch, string $testId, int $status, string $message, float $time): void
|
||||
public function setResult(string $branch, string $testId, int $status, string $message, float $time, int $assertions = 0): void
|
||||
{
|
||||
$this->ensureBaseline($branch);
|
||||
$this->baselines[$branch]['results'][$testId] = [
|
||||
'status' => $status, 'message' => $message, 'time' => $time,
|
||||
'status' => $status,
|
||||
'message' => $message,
|
||||
'time' => $time,
|
||||
'assertions' => $assertions,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the cached assertion count for a test, or `null` if unknown.
|
||||
* Callers use this to feed `addToAssertionCount()` at replay time so
|
||||
* the "Tests: N passed (M assertions)" banner matches the recorded run
|
||||
* instead of defaulting to 1 assertion per test.
|
||||
*/
|
||||
public function getAssertions(string $branch, string $testId, string $fallbackBranch = 'main'): ?int
|
||||
{
|
||||
$baseline = $this->baselineFor($branch, $fallbackBranch);
|
||||
|
||||
if (! isset($baseline['results'][$testId]['assertions'])) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $baseline['results'][$testId]['assertions'];
|
||||
}
|
||||
|
||||
public function getResult(string $branch, string $testId, string $fallbackBranch = 'main'): ?TestStatus
|
||||
{
|
||||
$baseline = $this->baselineFor($branch, $fallbackBranch);
|
||||
@ -301,6 +540,20 @@ final class Graph
|
||||
$this->baselines[$branch]['tree'] = $tree;
|
||||
}
|
||||
|
||||
/**
|
||||
* Wipes cached per-test results for the given branch. Edges and tree
|
||||
* snapshot stay intact — the graph still describes the code correctly,
|
||||
* only the "what happened last time" data is reset. Used on
|
||||
* environmental fingerprint drift: the edges were recorded elsewhere
|
||||
* (e.g. CI) so they're still valid, but the results aren't trustworthy
|
||||
* on this machine until the tests re-run here.
|
||||
*/
|
||||
public function clearResults(string $branch): void
|
||||
{
|
||||
$this->ensureBaseline($branch);
|
||||
$this->baselines[$branch]['results'] = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, string>
|
||||
*/
|
||||
@ -310,7 +563,7 @@ final class Graph
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array{sha: ?string, tree: array<string, string>, results: array<string, array{status: int, message: string, time: float}>}
|
||||
* @return array{sha: ?string, tree: array<string, string>, results: array<string, array{status: int, message: string, time: float, assertions?: int}>}
|
||||
*/
|
||||
private function baselineFor(string $branch, string $fallbackBranch): array
|
||||
{
|
||||
@ -358,6 +611,201 @@ final class Graph
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces table edges for the given test files. Table names are
|
||||
* lowercased + deduplicated; the input comes straight from the
|
||||
* Recorder's `perTestTables()` snapshot. Tests absent from the
|
||||
* input keep their existing table set (same partial-update policy
|
||||
* as `replaceEdges`).
|
||||
*
|
||||
* @param array<string, array<int, string>> $testToTables
|
||||
*/
|
||||
public function replaceTestTables(array $testToTables): void
|
||||
{
|
||||
foreach ($testToTables as $testFile => $tables) {
|
||||
$testRel = $this->relative($testFile);
|
||||
|
||||
if ($testRel === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$normalised = [];
|
||||
|
||||
foreach ($tables as $table) {
|
||||
$lower = strtolower($table);
|
||||
|
||||
if ($lower !== '') {
|
||||
$normalised[$lower] = true;
|
||||
}
|
||||
}
|
||||
|
||||
$names = array_keys($normalised);
|
||||
sort($names);
|
||||
|
||||
$this->testTables[$testRel] = $names;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces Inertia component edges for the given test files. Names
|
||||
* preserve case (they're identifiers like `Users/Show`, not
|
||||
* user-supplied strings) but duplicates are collapsed. Same
|
||||
* partial-update policy as `replaceTestTables`.
|
||||
*
|
||||
* @param array<string, array<int, string>> $testToComponents
|
||||
*/
|
||||
public function replaceTestInertiaComponents(array $testToComponents): void
|
||||
{
|
||||
foreach ($testToComponents as $testFile => $components) {
|
||||
$testRel = $this->relative($testFile);
|
||||
|
||||
if ($testRel === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$normalised = [];
|
||||
|
||||
foreach ($components as $component) {
|
||||
if ($component !== '') {
|
||||
$normalised[$component] = true;
|
||||
}
|
||||
}
|
||||
|
||||
$names = array_keys($normalised);
|
||||
sort($names);
|
||||
|
||||
$this->testInertiaComponents[$testRel] = $names;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces the whole JS dep map. Called at record time with the
|
||||
* output of `JsModuleGraph::build()`. Unlike the test-level
|
||||
* replacements above this is a wholesale overwrite — the
|
||||
* resolver produces the full graph on every run.
|
||||
*
|
||||
* @param array<string, array<int, string>> $fileToComponents
|
||||
*/
|
||||
public function replaceJsFileToComponents(array $fileToComponents): void
|
||||
{
|
||||
$out = [];
|
||||
|
||||
foreach ($fileToComponents as $path => $components) {
|
||||
if ($path === '') {
|
||||
continue;
|
||||
}
|
||||
$names = [];
|
||||
|
||||
foreach ($components as $component) {
|
||||
if ($component !== '') {
|
||||
$names[$component] = true;
|
||||
}
|
||||
}
|
||||
|
||||
if ($names === []) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$keys = array_keys($names);
|
||||
sort($keys);
|
||||
$out[$path] = $keys;
|
||||
}
|
||||
|
||||
ksort($out);
|
||||
|
||||
$this->jsFileToComponents = $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Projects under Laravel conventionally keep migrations at
|
||||
* `database/migrations/`. We recognise the directory as a prefix
|
||||
* so nested subdirectories (a pattern some teams use for grouping
|
||||
* — `database/migrations/tenant/`, `database/migrations/archived/`)
|
||||
* are still routed through the table-intersection path.
|
||||
*/
|
||||
private function isMigrationPath(string $rel): bool
|
||||
{
|
||||
return str_starts_with($rel, 'database/migrations/') && str_ends_with($rel, '.php');
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads `$rel` relative to the project root and extracts the
|
||||
* tables it declares via `Schema::create/table/drop/rename`.
|
||||
* Empty on missing/unreadable files or when the parser finds
|
||||
* nothing — the caller escalates those cases to the watch
|
||||
* pattern safety net.
|
||||
*
|
||||
* @return list<string>
|
||||
*/
|
||||
private function tablesForMigration(string $rel): array
|
||||
{
|
||||
$absolute = rtrim($this->projectRoot, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$rel;
|
||||
|
||||
if (! is_file($absolute)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$content = @file_get_contents($absolute);
|
||||
|
||||
if ($content === false) {
|
||||
return [];
|
||||
}
|
||||
|
||||
return TableExtractor::fromMigrationSource($content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Maps a project-relative path to its Inertia component name if it
|
||||
* lives under `resources/js/Pages/` with a recognised framework
|
||||
* extension. Returns null otherwise so callers can cheaply ignore
|
||||
* non-page files. Matches Inertia's resolver convention: strip the
|
||||
* `resources/js/Pages/` prefix, strip the extension, preserve the
|
||||
* remaining slashes (`Users/Show.vue` → `Users/Show`).
|
||||
*/
|
||||
private function componentForInertiaPage(string $rel): ?string
|
||||
{
|
||||
$prefix = 'resources/js/Pages/';
|
||||
|
||||
if (! str_starts_with($rel, $prefix)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$tail = substr($rel, strlen($prefix));
|
||||
$dot = strrpos($tail, '.');
|
||||
|
||||
if ($dot === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$extension = substr($tail, $dot + 1);
|
||||
|
||||
if (! in_array($extension, ['vue', 'tsx', 'jsx', 'svelte'], true)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$name = substr($tail, 0, $dot);
|
||||
|
||||
return $name === '' ? null : $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether any test's component set contains `$component`. Used to
|
||||
* decide between precise edge matching and watch-pattern fallback
|
||||
* for a changed Inertia page file.
|
||||
*
|
||||
* @param array<string, array<int, string>> $edges
|
||||
*/
|
||||
private function anyTestUses(array $edges, string $component): bool
|
||||
{
|
||||
foreach ($edges as $components) {
|
||||
if (in_array($component, $components, true)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Drops edges whose test file no longer exists on disk. Prevents the graph
|
||||
* from keeping stale entries for deleted / renamed tests that would later
|
||||
@ -372,21 +820,29 @@ final class Graph
|
||||
unset($this->edges[$testRel]);
|
||||
}
|
||||
}
|
||||
|
||||
foreach (array_keys($this->testInertiaComponents) as $testRel) {
|
||||
if (! is_file($root.$testRel)) {
|
||||
unset($this->testInertiaComponents[$testRel]);
|
||||
}
|
||||
}
|
||||
|
||||
foreach (array_keys($this->testTables) as $testRel) {
|
||||
if (! is_file($root.$testRel)) {
|
||||
unset($this->testTables[$testRel]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public static function load(string $projectRoot, string $path): ?self
|
||||
/**
|
||||
* Rebuilds a graph from its JSON representation. Returns `null` when
|
||||
* the payload is missing, unreadable, or schema-incompatible. Separated
|
||||
* from transport (state backend, file, etc.) so tests can feed bytes
|
||||
* directly without touching disk.
|
||||
*/
|
||||
public static function decode(string $json, string $projectRoot): ?self
|
||||
{
|
||||
if (! is_file($path)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$raw = @file_get_contents($path);
|
||||
|
||||
if ($raw === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$data = json_decode($raw, true);
|
||||
$data = json_decode($json, true);
|
||||
|
||||
if (! is_array($data) || ($data['schema'] ?? null) !== 1) {
|
||||
return null;
|
||||
@ -399,44 +855,100 @@ final class Graph
|
||||
$graph->edges = is_array($data['edges'] ?? null) ? $data['edges'] : [];
|
||||
$graph->baselines = is_array($data['baselines'] ?? null) ? $data['baselines'] : [];
|
||||
|
||||
if (isset($data['test_tables']) && is_array($data['test_tables'])) {
|
||||
foreach ($data['test_tables'] as $testRel => $tables) {
|
||||
if (! is_string($testRel)) {
|
||||
continue;
|
||||
}
|
||||
if (! is_array($tables)) {
|
||||
continue;
|
||||
}
|
||||
$names = [];
|
||||
|
||||
foreach ($tables as $table) {
|
||||
if (is_string($table) && $table !== '') {
|
||||
$names[] = $table;
|
||||
}
|
||||
}
|
||||
|
||||
if ($names !== []) {
|
||||
$graph->testTables[$testRel] = $names;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($data['test_inertia_components']) && is_array($data['test_inertia_components'])) {
|
||||
foreach ($data['test_inertia_components'] as $testRel => $components) {
|
||||
if (! is_string($testRel)) {
|
||||
continue;
|
||||
}
|
||||
if (! is_array($components)) {
|
||||
continue;
|
||||
}
|
||||
$names = [];
|
||||
|
||||
foreach ($components as $component) {
|
||||
if (is_string($component) && $component !== '') {
|
||||
$names[] = $component;
|
||||
}
|
||||
}
|
||||
|
||||
if ($names !== []) {
|
||||
$graph->testInertiaComponents[$testRel] = $names;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($data['js_file_to_components']) && is_array($data['js_file_to_components'])) {
|
||||
foreach ($data['js_file_to_components'] as $path => $components) {
|
||||
if (! is_string($path)) {
|
||||
continue;
|
||||
}
|
||||
if ($path === '') {
|
||||
continue;
|
||||
}
|
||||
if (! is_array($components)) {
|
||||
continue;
|
||||
}
|
||||
$names = [];
|
||||
|
||||
foreach ($components as $component) {
|
||||
if (is_string($component) && $component !== '') {
|
||||
$names[] = $component;
|
||||
}
|
||||
}
|
||||
|
||||
if ($names !== []) {
|
||||
$graph->jsFileToComponents[$path] = $names;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $graph;
|
||||
}
|
||||
|
||||
public function save(string $path): bool
|
||||
/**
|
||||
* Serialises the graph to its JSON on-disk form. Returns `null` if the
|
||||
* payload can't be encoded (extremely rare — pathological UTF-8 only).
|
||||
* Persistence is the caller's responsibility: write the returned bytes
|
||||
* through whatever `State` implementation is in play.
|
||||
*/
|
||||
public function encode(): ?string
|
||||
{
|
||||
$dir = dirname($path);
|
||||
|
||||
if (! is_dir($dir) && ! @mkdir($dir, 0755, true) && ! is_dir($dir)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$payload = [
|
||||
'schema' => 1,
|
||||
'fingerprint' => $this->fingerprint,
|
||||
'files' => $this->files,
|
||||
'edges' => $this->edges,
|
||||
'baselines' => $this->baselines,
|
||||
'test_tables' => $this->testTables,
|
||||
'test_inertia_components' => $this->testInertiaComponents,
|
||||
'js_file_to_components' => $this->jsFileToComponents,
|
||||
];
|
||||
|
||||
$tmp = $path.'.'.bin2hex(random_bytes(4)).'.tmp';
|
||||
|
||||
$json = json_encode($payload, JSON_UNESCAPED_SLASHES);
|
||||
|
||||
if ($json === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (@file_put_contents($tmp, $json) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (! @rename($tmp, $path)) {
|
||||
@unlink($tmp);
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
return $json === false ? null : $json;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
170
src/Plugins/Tia/InertiaEdges.php
Normal file
170
src/Plugins/Tia/InertiaEdges.php
Normal file
@ -0,0 +1,170 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
/**
|
||||
* Inertia-aware collaborator: during record mode, attributes every
|
||||
* Inertia component the test server-side renders to the currently-
|
||||
* running test file.
|
||||
*
|
||||
* Why this exists: a change to `resources/js/Pages/Users/Show.vue`
|
||||
* should only invalidate tests that actually rendered `Users/Show`.
|
||||
* The Laravel `WatchDefaults\Inertia` glob is a broad fallback — fine
|
||||
* for brand-new pages, but noisy once the graph has real data. With
|
||||
* this armed, each test's recorded edge set grows to include the
|
||||
* component names it returned through `Inertia::render()`, and
|
||||
* subsequent replay intersects page-file changes against that set.
|
||||
*
|
||||
* Mechanism: listen for `Illuminate\Foundation\Http\Events\RequestHandled`
|
||||
* on Laravel's event dispatcher. Inertia responses are identifiable by
|
||||
* either an `X-Inertia` header (XHR / JSON shape) or a `data-page`
|
||||
* attribute on the root `<div id="app">` (full HTML shape). Both carry
|
||||
* the component name in a structured payload we can parse cheaply.
|
||||
*
|
||||
* Same dep-free handshake as `BladeEdges` / `TableTracker`: string
|
||||
* class lookup + method-capability probes so Pest's `require` stays
|
||||
* Laravel-free.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class InertiaEdges
|
||||
{
|
||||
private const string CONTAINER_CLASS = '\\Illuminate\\Container\\Container';
|
||||
|
||||
private const string REQUEST_HANDLED_EVENT = '\\Illuminate\\Foundation\\Http\\Events\\RequestHandled';
|
||||
|
||||
/**
|
||||
* App-scoped marker that makes `arm()` idempotent across per-test
|
||||
* `setUp()` calls. Laravel reuses the same app across tests in
|
||||
* most configurations — without this guard we'd stack one
|
||||
* listener per test.
|
||||
*/
|
||||
private const string MARKER = 'pest.tia.inertia-edges-armed';
|
||||
|
||||
public static function arm(Recorder $recorder): void
|
||||
{
|
||||
if (! $recorder->isActive()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$containerClass = self::CONTAINER_CLASS;
|
||||
|
||||
if (! class_exists($containerClass)) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var object $app */
|
||||
$app = $containerClass::getInstance();
|
||||
|
||||
if (! method_exists($app, 'bound') || ! method_exists($app, 'make') || ! method_exists($app, 'instance')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($app->bound(self::MARKER)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (! $app->bound('events')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$app->instance(self::MARKER, true);
|
||||
|
||||
/** @var object $events */
|
||||
$events = $app->make('events');
|
||||
|
||||
if (! method_exists($events, 'listen')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$events->listen(self::REQUEST_HANDLED_EVENT, static function (object $event) use ($recorder): void {
|
||||
if (! property_exists($event, 'response')) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var mixed $response */
|
||||
$response = $event->response;
|
||||
|
||||
if (! is_object($response)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$component = self::extractComponent($response);
|
||||
|
||||
if ($component !== null) {
|
||||
$recorder->linkInertiaComponent($component);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Pulls the Inertia component name out of a Laravel response,
|
||||
* handling both XHR (`X-Inertia` + JSON body) and full HTML
|
||||
* (`<div id="app" data-page="…">`) shapes. Returns null for any
|
||||
* non-Inertia response so the caller can ignore it cheaply.
|
||||
*/
|
||||
private static function extractComponent(object $response): ?string
|
||||
{
|
||||
// XHR path: Inertia sets an `X-Inertia: true` header and the
|
||||
// body is JSON with a `component` key.
|
||||
if (property_exists($response, 'headers') && is_object($response->headers)) {
|
||||
$headers = $response->headers;
|
||||
|
||||
if (method_exists($headers, 'has') && $headers->has('X-Inertia')) {
|
||||
$content = self::readContent($response);
|
||||
|
||||
if ($content !== null) {
|
||||
/** @var mixed $decoded */
|
||||
$decoded = json_decode($content, true);
|
||||
|
||||
if (is_array($decoded)
|
||||
&& isset($decoded['component'])
|
||||
&& is_string($decoded['component'])
|
||||
&& $decoded['component'] !== '') {
|
||||
return $decoded['component'];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Initial-load HTML path: Inertia embeds the page payload in a
|
||||
// `data-page` attribute on the root `<div id="app">`. We only
|
||||
// pay the regex cost when the body actually contains the
|
||||
// attribute, so non-Inertia HTML responses are effectively a
|
||||
// no-op.
|
||||
$content = self::readContent($response);
|
||||
|
||||
if ($content === null || ! str_contains($content, 'data-page=')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (preg_match('/\sdata-page="([^"]+)"/', $content, $match) !== 1) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$decoded = json_decode(html_entity_decode($match[1]), true);
|
||||
|
||||
if (is_array($decoded)
|
||||
&& isset($decoded['component'])
|
||||
&& is_string($decoded['component'])
|
||||
&& $decoded['component'] !== '') {
|
||||
return $decoded['component'];
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private static function readContent(object $response): ?string
|
||||
{
|
||||
if (! method_exists($response, 'getContent')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
/** @var mixed $content */
|
||||
$content = $response->getContent();
|
||||
|
||||
return is_string($content) ? $content : null;
|
||||
}
|
||||
}
|
||||
270
src/Plugins/Tia/JsImportParser.php
Normal file
270
src/Plugins/Tia/JsImportParser.php
Normal file
@ -0,0 +1,270 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
/**
|
||||
* Fallback parser for ES module imports under `resources/js/`.
|
||||
*
|
||||
* Used only when the Node helper (`bin/pest-tia-vite-deps.mjs`) is
|
||||
* unavailable — typically when Node isn't on `PATH` or the user's
|
||||
* `vite.config.*` can't be loaded. Pure PHP, so it degrades
|
||||
* gracefully on locked-down environments but cannot match the
|
||||
* full-fidelity Vite resolver.
|
||||
*
|
||||
* Known limits (intentional — preserving correctness over precision):
|
||||
* - Only `@/` and `~/` aliases recognised (both resolve to
|
||||
* `resources/js/`, the community default). Custom aliases from
|
||||
* `vite.config.ts` are ignored; anything we can't resolve is
|
||||
* simply skipped and falls through to the watch-pattern safety
|
||||
* net.
|
||||
* - Dynamic imports with variable expressions
|
||||
* (`import(`./${name}`.vue)`) can't be resolved; the literal
|
||||
* prefix is ignored and the caller over-runs. Safe.
|
||||
* - Vue SFC `<script>` blocks parsed whole; imports inside
|
||||
* `<template>` blocks (rare but legal) are not scanned.
|
||||
*
|
||||
* Output shape mirrors the Node helper: project-relative source path
|
||||
* → sorted list of component names of pages that depend on it.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class JsImportParser
|
||||
{
|
||||
private const array PAGE_EXTENSIONS = ['vue', 'tsx', 'jsx', 'svelte'];
|
||||
|
||||
private const array RESOLVABLE_EXTENSIONS = ['vue', 'tsx', 'jsx', 'svelte', 'ts', 'js', 'mjs', 'mts'];
|
||||
|
||||
private const string PAGES_DIR = 'resources/js/Pages';
|
||||
|
||||
private const string JS_DIR = 'resources/js';
|
||||
|
||||
/**
|
||||
* Walks `resources/js/Pages` and, for each page, collects its
|
||||
* transitive file imports. Returns the inverted graph so callers
|
||||
* can look up "what pages depend on this shared file".
|
||||
*
|
||||
* @return array<string, list<string>>
|
||||
*/
|
||||
public static function parse(string $projectRoot): array
|
||||
{
|
||||
$jsRoot = $projectRoot.DIRECTORY_SEPARATOR.self::JS_DIR;
|
||||
$pagesRoot = $projectRoot.DIRECTORY_SEPARATOR.self::PAGES_DIR;
|
||||
|
||||
if (! is_dir($pagesRoot)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$reverse = [];
|
||||
|
||||
foreach (self::collectPages($pagesRoot) as $pageAbs) {
|
||||
$component = self::componentName($pagesRoot, $pageAbs);
|
||||
|
||||
if ($component === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$visited = [];
|
||||
self::collectTransitive($pageAbs, $projectRoot, $jsRoot, $visited);
|
||||
|
||||
foreach (array_keys($visited) as $depAbs) {
|
||||
if ($depAbs === $pageAbs) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$rel = str_replace(DIRECTORY_SEPARATOR, '/', substr($depAbs, strlen($projectRoot) + 1));
|
||||
$reverse[$rel][$component] = true;
|
||||
}
|
||||
}
|
||||
|
||||
$out = [];
|
||||
foreach ($reverse as $path => $components) {
|
||||
$names = array_keys($components);
|
||||
sort($names);
|
||||
$out[$path] = $names;
|
||||
}
|
||||
|
||||
ksort($out);
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return list<string>
|
||||
*/
|
||||
private static function collectPages(string $pagesRoot): array
|
||||
{
|
||||
$out = [];
|
||||
$iterator = new \RecursiveIteratorIterator(
|
||||
new \RecursiveDirectoryIterator($pagesRoot, \FilesystemIterator::SKIP_DOTS),
|
||||
);
|
||||
|
||||
foreach ($iterator as $fileInfo) {
|
||||
if (! $fileInfo->isFile()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$ext = strtolower((string) $fileInfo->getExtension());
|
||||
if (in_array($ext, self::PAGE_EXTENSIONS, true)) {
|
||||
$out[] = $fileInfo->getPathname();
|
||||
}
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
private static function componentName(string $pagesRoot, string $pageAbs): ?string
|
||||
{
|
||||
$rel = str_replace(DIRECTORY_SEPARATOR, '/', substr($pageAbs, strlen($pagesRoot) + 1));
|
||||
$dot = strrpos($rel, '.');
|
||||
|
||||
if ($dot === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$name = substr($rel, 0, $dot);
|
||||
|
||||
return $name === '' ? null : $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, true> $visited
|
||||
*/
|
||||
private static function collectTransitive(string $fileAbs, string $projectRoot, string $jsRoot, array &$visited): void
|
||||
{
|
||||
if (isset($visited[$fileAbs])) {
|
||||
return;
|
||||
}
|
||||
$visited[$fileAbs] = true;
|
||||
|
||||
$source = self::loadSource($fileAbs);
|
||||
if ($source === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (self::extractImports($source) as $spec) {
|
||||
$resolved = self::resolveImport($spec, $fileAbs, $jsRoot);
|
||||
if ($resolved === null) {
|
||||
continue;
|
||||
}
|
||||
if (! is_file($resolved)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
self::collectTransitive($resolved, $projectRoot, $jsRoot, $visited);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the importable region of a file. For Vue SFCs, only the
|
||||
* `<script>` block is relevant for imports; ignoring the rest
|
||||
* avoids false-positive matches inside `<template>` attributes.
|
||||
*/
|
||||
private static function loadSource(string $fileAbs): ?string
|
||||
{
|
||||
$content = @file_get_contents($fileAbs);
|
||||
if ($content === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (str_ends_with(strtolower($fileAbs), '.vue')) {
|
||||
$scripts = [];
|
||||
if (preg_match_all('/<script[^>]*>(.*?)<\/script>/si', $content, $m) !== false) {
|
||||
foreach ($m[1] as $block) {
|
||||
$scripts[] = $block;
|
||||
}
|
||||
}
|
||||
|
||||
return implode("\n", $scripts);
|
||||
}
|
||||
|
||||
return $content;
|
||||
}
|
||||
|
||||
/**
|
||||
* Picks out every `import … from '…'` / `import '…'` / `import('…')`
|
||||
* target. We strip line comments first so a commented-out import
|
||||
* doesn't bloat the dep set.
|
||||
*
|
||||
* @return list<string>
|
||||
*/
|
||||
private static function extractImports(string $source): array
|
||||
{
|
||||
$stripped = preg_replace('#//[^\n]*#', '', $source) ?? $source;
|
||||
$stripped = preg_replace('#/\*.*?\*/#s', '', $stripped) ?? $stripped;
|
||||
|
||||
$specs = [];
|
||||
|
||||
if (preg_match_all('/\bimport\s+(?:[^\'"()]*?\s+from\s+)?[\'"]([^\'"]+)[\'"]/', $stripped, $matches) !== false) {
|
||||
foreach ($matches[1] as $spec) {
|
||||
$specs[] = $spec;
|
||||
}
|
||||
}
|
||||
|
||||
if (preg_match_all('/\bimport\(\s*[\'"]([^\'"]+)[\'"]\s*\)/', $stripped, $matches) !== false) {
|
||||
foreach ($matches[1] as $spec) {
|
||||
$specs[] = $spec;
|
||||
}
|
||||
}
|
||||
|
||||
return $specs;
|
||||
}
|
||||
|
||||
private static function resolveImport(string $spec, string $importerAbs, string $jsRoot): ?string
|
||||
{
|
||||
if ($spec === '' || $spec[0] === '.' || $spec[0] === '/') {
|
||||
return self::resolveRelative($spec, $importerAbs);
|
||||
}
|
||||
|
||||
if (str_starts_with($spec, '@/') || str_starts_with($spec, '~/')) {
|
||||
$tail = substr($spec, 2);
|
||||
|
||||
return self::withExtension($jsRoot.DIRECTORY_SEPARATOR.str_replace('/', DIRECTORY_SEPARATOR, $tail));
|
||||
}
|
||||
|
||||
// Anything else is either a node_modules package or an
|
||||
// unrecognised alias — skip. The watch-pattern fallback
|
||||
// handles the safety-net case for non-matched paths.
|
||||
return null;
|
||||
}
|
||||
|
||||
private static function resolveRelative(string $spec, string $importerAbs): ?string
|
||||
{
|
||||
if ($spec === '' || $spec[0] === '/') {
|
||||
return null;
|
||||
}
|
||||
|
||||
$base = dirname($importerAbs);
|
||||
$path = $base.DIRECTORY_SEPARATOR.str_replace('/', DIRECTORY_SEPARATOR, $spec);
|
||||
|
||||
return self::withExtension($path);
|
||||
}
|
||||
|
||||
/**
|
||||
* Imports may omit the extension or point at a directory (index.vue,
|
||||
* index.ts). Probe the common targets in order.
|
||||
*/
|
||||
private static function withExtension(string $path): ?string
|
||||
{
|
||||
if (is_file($path)) {
|
||||
return realpath($path) ?: $path;
|
||||
}
|
||||
|
||||
foreach (self::RESOLVABLE_EXTENSIONS as $ext) {
|
||||
$candidate = $path.'.'.$ext;
|
||||
if (is_file($candidate)) {
|
||||
return realpath($candidate) ?: $candidate;
|
||||
}
|
||||
}
|
||||
|
||||
foreach (self::RESOLVABLE_EXTENSIONS as $ext) {
|
||||
$candidate = $path.DIRECTORY_SEPARATOR.'index.'.$ext;
|
||||
if (is_file($candidate)) {
|
||||
return realpath($candidate) ?: $candidate;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
142
src/Plugins/Tia/JsModuleGraph.php
Normal file
142
src/Plugins/Tia/JsModuleGraph.php
Normal file
@ -0,0 +1,142 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
use Symfony\Component\Process\ExecutableFinder;
|
||||
use Symfony\Component\Process\Process;
|
||||
|
||||
/**
|
||||
* Builds a reverse dependency map for the project's JS sources under
|
||||
* `resources/js/**` — for every source file, the list of Inertia page
|
||||
* components that transitively import it.
|
||||
*
|
||||
* Tries two resolvers in order:
|
||||
*
|
||||
* 1. **Node helper** (`bin/pest-tia-vite-deps.mjs`). Spins up a
|
||||
* headless Vite server in middleware mode, walks Vite's own
|
||||
* module graph for each page entry, and outputs JSON. Uses the
|
||||
* project's real `vite.config.*`, so aliases, plugins, and SFC
|
||||
* transformers produce the same graph Vite itself would use.
|
||||
*
|
||||
* 2. **PHP fallback** (`JsImportParser`). Regex-scans ES imports
|
||||
* and resolves `@/` / `~/` aliases manually. Strictly less
|
||||
* precise — anything it can't resolve is skipped, leaving the
|
||||
* caller to fall back to the broad watch pattern. Only kicks in
|
||||
* when the Node helper is unusable (no Node on PATH, no Vite
|
||||
* installed, vite.config fails to load).
|
||||
*
|
||||
* Callers invoke this at record time; results are persisted into the
|
||||
* graph so replay never re-runs the resolver. On stale-map detection
|
||||
* the callers decide whether to rebuild.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class JsModuleGraph
|
||||
{
|
||||
private const int NODE_TIMEOUT_SECONDS = 25;
|
||||
|
||||
/**
|
||||
* @return array<string, list<string>> project-relative source path → sorted list of page component names
|
||||
*/
|
||||
public static function build(string $projectRoot): array
|
||||
{
|
||||
$viaNode = self::tryNodeHelper($projectRoot);
|
||||
|
||||
if ($viaNode !== null) {
|
||||
return $viaNode;
|
||||
}
|
||||
|
||||
return JsImportParser::parse($projectRoot);
|
||||
}
|
||||
|
||||
/**
|
||||
* True when the project looks like a Vite + Node project we can
|
||||
* ask for a module graph. Gate for callers that want to skip the
|
||||
* resolver entirely on non-Vite apps.
|
||||
*/
|
||||
public static function isApplicable(string $projectRoot): bool
|
||||
{
|
||||
return self::hasViteConfig($projectRoot) && is_dir($projectRoot.DIRECTORY_SEPARATOR.'resources'.DIRECTORY_SEPARATOR.'js'.DIRECTORY_SEPARATOR.'Pages');
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, list<string>>|null
|
||||
*/
|
||||
private static function tryNodeHelper(string $projectRoot): ?array
|
||||
{
|
||||
if (! self::hasViteConfig($projectRoot)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (! is_dir($projectRoot.DIRECTORY_SEPARATOR.'node_modules'.DIRECTORY_SEPARATOR.'vite')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$nodeBinary = (new ExecutableFinder)->find('node');
|
||||
|
||||
if ($nodeBinary === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$helperPath = dirname(__DIR__, 3).DIRECTORY_SEPARATOR.'bin'.DIRECTORY_SEPARATOR.'pest-tia-vite-deps.mjs';
|
||||
|
||||
if (! is_file($helperPath)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$process = new Process([$nodeBinary, $helperPath, $projectRoot], $projectRoot);
|
||||
$process->setTimeout(self::NODE_TIMEOUT_SECONDS);
|
||||
$process->run();
|
||||
|
||||
if (! $process->isSuccessful()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
/** @var mixed $decoded */
|
||||
$decoded = json_decode($process->getOutput(), true);
|
||||
|
||||
if (! is_array($decoded)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$out = [];
|
||||
|
||||
foreach ($decoded as $path => $components) {
|
||||
if (! is_string($path)) {
|
||||
continue;
|
||||
}
|
||||
if (! is_array($components)) {
|
||||
continue;
|
||||
}
|
||||
$names = [];
|
||||
|
||||
foreach ($components as $component) {
|
||||
if (is_string($component) && $component !== '') {
|
||||
$names[] = $component;
|
||||
}
|
||||
}
|
||||
|
||||
if ($names !== []) {
|
||||
sort($names);
|
||||
$out[$path] = $names;
|
||||
}
|
||||
}
|
||||
|
||||
ksort($out);
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
private static function hasViteConfig(string $projectRoot): bool
|
||||
{
|
||||
foreach (['vite.config.ts', 'vite.config.js', 'vite.config.mjs', 'vite.config.cjs', 'vite.config.mts'] as $name) {
|
||||
if (is_file($projectRoot.DIRECTORY_SEPARATOR.$name)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@ -29,6 +29,27 @@ final class Recorder
|
||||
*/
|
||||
private array $perTestFiles = [];
|
||||
|
||||
/**
|
||||
* Aggregated map: absolute test file → set<lowercase table name>.
|
||||
* Populated by `TableTracker` from `DB::listen` callbacks; consumed
|
||||
* at record finalize to populate the graph's `$testTables` edges
|
||||
* that drive migration-change impact analysis.
|
||||
*
|
||||
* @var array<string, array<string, true>>
|
||||
*/
|
||||
private array $perTestTables = [];
|
||||
|
||||
/**
|
||||
* Aggregated map: absolute test file → set<Inertia component name>.
|
||||
* Populated by `InertiaEdges` from Inertia responses observed at
|
||||
* request-handled time; consumed at record finalize to populate
|
||||
* the graph's per-test component edges that drive Vue / React
|
||||
* page-file impact analysis.
|
||||
*
|
||||
* @var array<string, array<string, true>>
|
||||
*/
|
||||
private array $perTestInertiaComponents = [];
|
||||
|
||||
/**
|
||||
* Cached class → test file resolution.
|
||||
*
|
||||
@ -144,6 +165,83 @@ final class Recorder
|
||||
$this->currentTestFile = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Records an extra source-file dependency for the currently-running
|
||||
* test. Used by collaborators that capture edges the coverage driver
|
||||
* cannot see — Blade templates rendered through Laravel's view
|
||||
* factory are the motivating case (their `.blade.php` source never
|
||||
* executes directly; a cached compiled PHP file does). No-op when
|
||||
* the recorder is inactive or no test is in flight, so callers can
|
||||
* fire it unconditionally from app-level hooks.
|
||||
*/
|
||||
public function linkSource(string $sourceFile): void
|
||||
{
|
||||
if (! $this->active) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->currentTestFile === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($sourceFile === '') {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->perTestFiles[$this->currentTestFile][$sourceFile] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Records that the currently-running test queried `$table`. Called
|
||||
* by `TableTracker` for every DML statement Laravel's `DB::listen`
|
||||
* reports; the table name has already been extracted by
|
||||
* `TableExtractor::fromSql()` so we just store it. No-op outside
|
||||
* a test window, so the callback is safe to leave armed across
|
||||
* setUp / tearDown boundaries.
|
||||
*/
|
||||
public function linkTable(string $table): void
|
||||
{
|
||||
if (! $this->active) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->currentTestFile === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($table === '') {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->perTestTables[$this->currentTestFile][strtolower($table)] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Records that the currently-running test server-side-rendered the
|
||||
* named Inertia component. The name is whatever
|
||||
* `Inertia::render($component, …)` was called with — typically a
|
||||
* slash-separated path like `Users/Show` that maps to
|
||||
* `resources/js/Pages/Users/Show.vue`. No-op outside a test window
|
||||
* so the underlying listener can stay armed without leaking
|
||||
* state between tests.
|
||||
*/
|
||||
public function linkInertiaComponent(string $component): void
|
||||
{
|
||||
if (! $this->active) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->currentTestFile === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($component === '') {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->perTestInertiaComponents[$this->currentTestFile][$component] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, array<int, string>> absolute test file → list of absolute source files.
|
||||
*/
|
||||
@ -158,6 +256,38 @@ final class Recorder
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, array<int, string>> absolute test file → sorted list of table names.
|
||||
*/
|
||||
public function perTestTables(): array
|
||||
{
|
||||
$out = [];
|
||||
|
||||
foreach ($this->perTestTables as $testFile => $tables) {
|
||||
$names = array_keys($tables);
|
||||
sort($names);
|
||||
$out[$testFile] = $names;
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, array<int, string>> absolute test file → sorted list of Inertia component names.
|
||||
*/
|
||||
public function perTestInertiaComponents(): array
|
||||
{
|
||||
$out = [];
|
||||
|
||||
foreach ($this->perTestInertiaComponents as $testFile => $components) {
|
||||
$names = array_keys($components);
|
||||
sort($names);
|
||||
$out[$testFile] = $names;
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
private function resolveTestFile(string $className, string $fallbackFile): ?string
|
||||
{
|
||||
if (array_key_exists($className, $this->classFileCache)) {
|
||||
@ -223,6 +353,8 @@ final class Recorder
|
||||
{
|
||||
$this->currentTestFile = null;
|
||||
$this->perTestFiles = [];
|
||||
$this->perTestTables = [];
|
||||
$this->perTestInertiaComponents = [];
|
||||
$this->classFileCache = [];
|
||||
$this->active = false;
|
||||
}
|
||||
|
||||
@ -118,6 +118,17 @@ final class ResultCollector
|
||||
$this->startTime = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Called by the Finished subscriber after a test's outcome + assertion
|
||||
* events have all fired. Clears the "currently recording" pointer so
|
||||
* the next test's events don't get mis-attributed.
|
||||
*/
|
||||
public function finishTest(): void
|
||||
{
|
||||
$this->currentTestId = null;
|
||||
$this->startTime = null;
|
||||
}
|
||||
|
||||
private function record(int $status, string $message): void
|
||||
{
|
||||
if ($this->currentTestId === null) {
|
||||
@ -128,14 +139,17 @@ final class ResultCollector
|
||||
? round(microtime(true) - $this->startTime, 3)
|
||||
: 0.0;
|
||||
|
||||
// PHPUnit can fire more than one outcome event per test — the
|
||||
// canonical case is a risky pass (`Passed` then `ConsideredRisky`).
|
||||
// Last-wins semantics preserve the most specific status; the
|
||||
// existing assertion count (if any) survives the overwrite.
|
||||
$existing = $this->results[$this->currentTestId] ?? null;
|
||||
|
||||
$this->results[$this->currentTestId] = [
|
||||
'status' => $status,
|
||||
'message' => $message,
|
||||
'time' => $time,
|
||||
'assertions' => 0,
|
||||
'assertions' => $existing['assertions'] ?? 0,
|
||||
];
|
||||
|
||||
$this->currentTestId = null;
|
||||
$this->startTime = null;
|
||||
}
|
||||
}
|
||||
|
||||
170
src/Plugins/Tia/Storage.php
Normal file
170
src/Plugins/Tia/Storage.php
Normal file
@ -0,0 +1,170 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
/**
|
||||
* Resolves TIA's on-disk state directory.
|
||||
*
|
||||
* Default location: `$HOME/.pest/tia/<project-key>/`. Keeping state in the
|
||||
* user's home directory (rather than under `vendor/pestphp/pest/`) means:
|
||||
*
|
||||
* - `composer install` / path-repo reinstalls don't wipe the graph.
|
||||
* - The state lives outside the project tree, so there is nothing for
|
||||
* users to gitignore or accidentally commit.
|
||||
* - Multiple worktrees of the same repo share one cache naturally.
|
||||
*
|
||||
* The project key is derived from the git origin URL when available — a
|
||||
* CI workflow running on `github.com/org/repo` and a developer's clone
|
||||
* of the same remote both compute the *same* key, which is what lets the
|
||||
* CI-uploaded baseline line up with the dev-side reader. When the project
|
||||
* is not in git, the key falls back to a hash of the absolute path so
|
||||
* unrelated projects on the same machine stay isolated.
|
||||
*
|
||||
* When no home directory is resolvable (`HOME` / `USERPROFILE` both
|
||||
* unset — the tests-tia sandboxes strip these deliberately, and some
|
||||
* locked-down CI environments do the same), state falls back to
|
||||
* `<projectRoot>/.pest/tia/`. That path is project-local but still
|
||||
* survives composer installs, so the degradation is graceful.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class Storage
|
||||
{
|
||||
/**
|
||||
* Directory where TIA's State blobs live for `$projectRoot`.
|
||||
*/
|
||||
public static function tempDir(string $projectRoot): string
|
||||
{
|
||||
$home = self::homeDir();
|
||||
|
||||
if ($home === null) {
|
||||
return $projectRoot
|
||||
.DIRECTORY_SEPARATOR.'.pest'
|
||||
.DIRECTORY_SEPARATOR.'tia';
|
||||
}
|
||||
|
||||
return $home
|
||||
.DIRECTORY_SEPARATOR.'.pest'
|
||||
.DIRECTORY_SEPARATOR.'tia'
|
||||
.DIRECTORY_SEPARATOR.self::projectKey($projectRoot);
|
||||
}
|
||||
|
||||
/**
|
||||
* OS-neutral home directory — `HOME` on Unix, `USERPROFILE` on
|
||||
* Windows. Returns null if neither resolves to an existing
|
||||
* directory, in which case callers fall back to project-local state.
|
||||
*/
|
||||
private static function homeDir(): ?string
|
||||
{
|
||||
foreach (['HOME', 'USERPROFILE'] as $key) {
|
||||
$value = getenv($key);
|
||||
|
||||
if (is_string($value) && $value !== '' && is_dir($value)) {
|
||||
return rtrim($value, '/\\');
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Folder name for `$projectRoot` under `~/.pest/tia/`.
|
||||
*
|
||||
* Strategy — each step rules out a class of collision:
|
||||
*
|
||||
* 1. If the project has a git origin URL, use a **normalised** form
|
||||
* (`host/org/repo`, lowercased, no `.git` suffix) as the input.
|
||||
* `git@github.com:foo/bar.git`, `ssh://git@github.com/foo/bar`
|
||||
* and `https://github.com/foo/bar` all collapse to
|
||||
* `github.com/foo/bar` — three developers cloning the same repo
|
||||
* by different transports share one cache, which is what we want.
|
||||
* 2. Otherwise, use the canonicalised absolute path (`realpath`).
|
||||
* Two unrelated `app/` checkouts under different parent folders
|
||||
* have different realpaths → different hashes → isolated.
|
||||
* 3. Hash the chosen input with sha256 and keep the first 16 hex
|
||||
* chars — 64 bits of entropy makes accidental collision
|
||||
* astronomically unlikely even across thousands of projects.
|
||||
* 4. Prefix with a slug of the project basename so `ls ~/.pest/tia/`
|
||||
* is readable; the slug is cosmetic only, all isolation comes
|
||||
* from the hash.
|
||||
*
|
||||
* Result: `myapp-a1b2c3d4e5f67890`.
|
||||
*/
|
||||
private static function projectKey(string $projectRoot): string
|
||||
{
|
||||
$origin = self::originIdentity($projectRoot);
|
||||
|
||||
$realpath = @realpath($projectRoot);
|
||||
$input = $origin ?? ($realpath === false ? $projectRoot : $realpath);
|
||||
|
||||
$hash = substr(hash('sha256', $input), 0, 16);
|
||||
$slug = self::slug(basename($projectRoot));
|
||||
|
||||
return $slug === '' ? $hash : $slug.'-'.$hash;
|
||||
}
|
||||
|
||||
/**
|
||||
* Canonical git origin identity for `$projectRoot`, or null when
|
||||
* no origin URL can be parsed. The returned form is
|
||||
* `host/org/repo` (lowercased, `.git` stripped) so SSH / HTTPS / git
|
||||
* protocol clones of the same remote produce the same value.
|
||||
*/
|
||||
private static function originIdentity(string $projectRoot): ?string
|
||||
{
|
||||
$url = self::rawOriginUrl($projectRoot);
|
||||
|
||||
if ($url === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// git@host:org/repo(.git)
|
||||
if (preg_match('#^[\w.-]+@([\w.-]+):([\w./-]+?)(?:\.git)?/?$#', $url, $m) === 1) {
|
||||
return strtolower($m[1].'/'.$m[2]);
|
||||
}
|
||||
|
||||
// scheme://[user@]host[:port]/org/repo(.git) — https, ssh, git, file
|
||||
if (preg_match('#^[a-z]+://(?:[^@/]+@)?([^/:]+)(?::\d+)?/([\w./-]+?)(?:\.git)?/?$#i', $url, $m) === 1) {
|
||||
return strtolower($m[1].'/'.$m[2]);
|
||||
}
|
||||
|
||||
// Unrecognised form — hash the raw URL so different inputs still
|
||||
// diverge, but lowercased so the only variance is intentional.
|
||||
return strtolower($url);
|
||||
}
|
||||
|
||||
private static function rawOriginUrl(string $projectRoot): ?string
|
||||
{
|
||||
$config = $projectRoot.DIRECTORY_SEPARATOR.'.git'.DIRECTORY_SEPARATOR.'config';
|
||||
|
||||
if (! is_file($config)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$raw = @file_get_contents($config);
|
||||
|
||||
if ($raw === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (preg_match('/\[remote "origin"\][^\[]*?url\s*=\s*(\S+)/s', $raw, $match) === 1) {
|
||||
return trim($match[1]);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filesystem-safe kebab of `$name`. Cosmetic only — used as a
|
||||
* human-readable prefix on the hash so `~/.pest/tia/` lists
|
||||
* recognisable folders.
|
||||
*/
|
||||
private static function slug(string $name): string
|
||||
{
|
||||
$slug = strtolower($name);
|
||||
$slug = preg_replace('/[^a-z0-9]+/', '-', $slug) ?? '';
|
||||
|
||||
return trim($slug, '-');
|
||||
}
|
||||
}
|
||||
154
src/Plugins/Tia/TableExtractor.php
Normal file
154
src/Plugins/Tia/TableExtractor.php
Normal file
@ -0,0 +1,154 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
/**
|
||||
* Extracts table names from SQL statements and migration PHP sources.
|
||||
*
|
||||
* Two callers, two methods:
|
||||
*
|
||||
* - `fromSql()` runs against query strings Laravel's `DB::listen`
|
||||
* hands us at record time. We only look at DML (`SELECT`, `INSERT`,
|
||||
* `UPDATE`, `DELETE`) because DDL emitted by `RefreshDatabase` in
|
||||
* `setUp()` is noise — we don't want every test to end up linked
|
||||
* to every migration's `CREATE TABLE`.
|
||||
* - `fromMigrationSource()` reads a migration file on disk at
|
||||
* replay time and pulls table names out of `Schema::` calls.
|
||||
* Used in two places:
|
||||
* 1. For every migration file reported as changed — what
|
||||
* tables does the current version of this file touch?
|
||||
* 2. For brand-new migration files that weren't in the graph
|
||||
* yet, so we never had a chance to observe their DDL.
|
||||
*
|
||||
* Regex isn't a parser. CTEs, subqueries, and raw `DB::statement()`
|
||||
* that reference tables only inside exotic syntax can slip through.
|
||||
* The direction of that error is under-attribution (a table the test
|
||||
* genuinely touches but we missed), so the safety net is to keep the
|
||||
* broad `database/migrations/**` watch pattern as a last resort for
|
||||
* files that produce an empty extraction.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class TableExtractor
|
||||
{
|
||||
/**
|
||||
* DML prefixes we accept. DDL (`CREATE`, `ALTER`, `DROP`,
|
||||
* `TRUNCATE`, `RENAME`) is deliberately excluded — those come
|
||||
* from migrations fired by `RefreshDatabase`, and capturing them
|
||||
* here would attribute every migration table to every test.
|
||||
*/
|
||||
private const array DML_PREFIXES = ['select', 'insert', 'update', 'delete'];
|
||||
|
||||
/**
|
||||
* @return list<string> Sorted, deduped table names referenced by the
|
||||
* SQL statement. Empty when the statement is
|
||||
* DDL, empty, or unparseable.
|
||||
*/
|
||||
public static function fromSql(string $sql): array
|
||||
{
|
||||
$trimmed = ltrim($sql);
|
||||
|
||||
if ($trimmed === '') {
|
||||
return [];
|
||||
}
|
||||
|
||||
$prefix = strtolower(substr($trimmed, 0, 6));
|
||||
|
||||
$matched = false;
|
||||
foreach (self::DML_PREFIXES as $dml) {
|
||||
if (str_starts_with($prefix, $dml)) {
|
||||
$matched = true;
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (! $matched) {
|
||||
return [];
|
||||
}
|
||||
|
||||
// Match `from`, `into`, `update`, `join` and capture the
|
||||
// following identifier, tolerating the common quoting
|
||||
// styles: "double", `back`, [bracket], or bare.
|
||||
$pattern = '/(?:\bfrom|\binto|\bupdate|\bjoin)\s+(?:"([^"]+)"|`([^`]+)`|\[([^\]]+)\]|(\w+))/i';
|
||||
|
||||
if (preg_match_all($pattern, $sql, $matches) === false) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$tables = [];
|
||||
|
||||
for ($i = 0, $n = count($matches[0]); $i < $n; $i++) {
|
||||
$name = $matches[1][$i] !== ''
|
||||
? $matches[1][$i]
|
||||
: ($matches[2][$i] !== ''
|
||||
? $matches[2][$i]
|
||||
: ($matches[3][$i] !== ''
|
||||
? $matches[3][$i]
|
||||
: $matches[4][$i]));
|
||||
if ($name === '') {
|
||||
continue;
|
||||
}
|
||||
if (self::isSchemaMeta($name)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$tables[strtolower($name)] = true;
|
||||
}
|
||||
|
||||
$out = array_keys($tables);
|
||||
sort($out);
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return list<string> Table names referenced by `Schema::` calls
|
||||
* in the given migration file contents. Empty
|
||||
* when nothing matches — callers treat that
|
||||
* as "fall back to the broad watch pattern".
|
||||
*/
|
||||
public static function fromMigrationSource(string $php): array
|
||||
{
|
||||
$pattern = '/Schema::\s*(?:create|table|drop|dropIfExists|dropColumns|rename)\s*\(\s*[\'"]([^\'"]+)[\'"](?:\s*,\s*[\'"]([^\'"]+)[\'"])?/';
|
||||
|
||||
if (preg_match_all($pattern, $php, $matches) === false) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$tables = [];
|
||||
|
||||
foreach ($matches[1] as $i => $primary) {
|
||||
// Group 1 always captures at least one char per the regex.
|
||||
$tables[strtolower($primary)] = true;
|
||||
|
||||
// Group 2 (`Schema::rename('old', 'new')`) is optional and
|
||||
// absent from non-rename matches.
|
||||
$secondary = $matches[2][$i] ?? '';
|
||||
if ($secondary !== '') {
|
||||
$tables[strtolower($secondary)] = true;
|
||||
}
|
||||
}
|
||||
|
||||
$out = array_keys($tables);
|
||||
sort($out);
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters out driver-internal tables that show up as DB::listen
|
||||
* targets without representing user schema: SQLite's master
|
||||
* catalogue, Laravel's own `migrations` metadata.
|
||||
*/
|
||||
private static function isSchemaMeta(string $name): bool
|
||||
{
|
||||
$lower = strtolower($name);
|
||||
|
||||
return in_array($lower, ['sqlite_master', 'sqlite_sequence', 'migrations'], true)
|
||||
|| str_starts_with($lower, 'pg_')
|
||||
|| str_starts_with($lower, 'information_schema');
|
||||
}
|
||||
}
|
||||
123
src/Plugins/Tia/TableTracker.php
Normal file
123
src/Plugins/Tia/TableTracker.php
Normal file
@ -0,0 +1,123 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Plugins\Tia;
|
||||
|
||||
/**
|
||||
* Laravel-only collaborator: during record mode, attributes every SQL
|
||||
* table the test body queries to the currently-running test.
|
||||
*
|
||||
* Why this exists: the coverage graph can tell us which PHP files a
|
||||
* test touched but cannot distinguish "this test depends on the
|
||||
* `users` table" from "this test depends on `questions`". That
|
||||
* distinction is the whole point of surgical migration invalidation —
|
||||
* a column rename in `create_questions_table.php` should only re-run
|
||||
* tests whose body actually queried `questions`.
|
||||
*
|
||||
* Mechanism: install a listener on Laravel's event dispatcher that
|
||||
* subscribes to `Illuminate\Database\Events\QueryExecuted`. Each
|
||||
* query string is piped through `TableExtractor::fromSql()`; DDL is
|
||||
* filtered at extraction time so migrations running in `setUp` don't
|
||||
* attribute every table to every test.
|
||||
*
|
||||
* Same dep-free handshake as `BladeEdges`: string class lookup +
|
||||
* method-capability probes so Pest's `require` stays Laravel-free.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class TableTracker
|
||||
{
|
||||
private const string CONTAINER_CLASS = '\\Illuminate\\Container\\Container';
|
||||
|
||||
/**
|
||||
* App-scoped marker that makes `arm()` idempotent across the 774
|
||||
* per-test `setUp()` calls — Laravel reuses the same app instance
|
||||
* within a single test run, so without this guard we'd stack
|
||||
* one listener per test and each query would fire the closure
|
||||
* hundreds of times.
|
||||
*/
|
||||
private const string MARKER = 'pest.tia.table-tracker-armed';
|
||||
|
||||
public static function arm(Recorder $recorder): void
|
||||
{
|
||||
if (! $recorder->isActive()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$containerClass = self::CONTAINER_CLASS;
|
||||
|
||||
if (! class_exists($containerClass)) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var object $app */
|
||||
$app = $containerClass::getInstance();
|
||||
|
||||
if (! method_exists($app, 'bound') || ! method_exists($app, 'make') || ! method_exists($app, 'instance')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($app->bound(self::MARKER)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (! $app->bound('db')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$app->instance(self::MARKER, true);
|
||||
|
||||
$listener = static function (object $query) use ($recorder): void {
|
||||
if (! property_exists($query, 'sql')) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var mixed $sql */
|
||||
$sql = $query->sql;
|
||||
|
||||
if (! is_string($sql) || $sql === '') {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (TableExtractor::fromSql($sql) as $table) {
|
||||
$recorder->linkTable($table);
|
||||
}
|
||||
};
|
||||
|
||||
// Preferred path: `DatabaseManager::listen(Closure $callback)`.
|
||||
// It's a real method — `method_exists` returns false because
|
||||
// some Laravel versions compose it via a trait the reflection
|
||||
// probe can't always see, so we gate via `is_callable` instead.
|
||||
// This path pushes the listener onto every existing AND future
|
||||
// connection, which is what we want for a process-wide capture.
|
||||
/** @var object $db */
|
||||
$db = $app->make('db');
|
||||
|
||||
if (is_callable([$db, 'listen'])) {
|
||||
/** @var callable $listen */
|
||||
$listen = [$db, 'listen'];
|
||||
$listen($listener);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Fallback: register directly on the event dispatcher. Works
|
||||
// as long as every connection shares the same dispatcher
|
||||
// instance this app resolved to — true in vanilla setups,
|
||||
// but not guaranteed with connections instantiated pre-arm
|
||||
// that captured an older dispatcher.
|
||||
if (! $app->bound('events')) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var object $events */
|
||||
$events = $app->make('events');
|
||||
|
||||
if (! method_exists($events, 'listen')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$events->listen('\\Illuminate\\Database\\Events\\QueryExecuted', $listener);
|
||||
}
|
||||
}
|
||||
@ -31,11 +31,18 @@ final readonly class Inertia implements WatchDefault
|
||||
: $testPath;
|
||||
|
||||
return [
|
||||
// Inertia page components (React / Vue / Svelte).
|
||||
'resources/js/Pages/**/*.vue' => [$testPath, $browserDir],
|
||||
'resources/js/Pages/**/*.tsx' => [$testPath, $browserDir],
|
||||
'resources/js/Pages/**/*.jsx' => [$testPath, $browserDir],
|
||||
'resources/js/Pages/**/*.svelte' => [$testPath, $browserDir],
|
||||
// Inertia page components (React / Vue / Svelte). Scoped to
|
||||
// `$browserDir` only — a Vue/React edit cannot change the
|
||||
// output of a server-side Inertia test (those assert on the
|
||||
// component *name* returned by `Inertia::render()`, not its
|
||||
// client-side implementation). Broad invalidation is only
|
||||
// meaningful for tests that actually render the DOM. Precise
|
||||
// per-component edges come from `InertiaEdges` at record
|
||||
// time and replace this fallback when available.
|
||||
'resources/js/Pages/**/*.vue' => [$browserDir],
|
||||
'resources/js/Pages/**/*.tsx' => [$browserDir],
|
||||
'resources/js/Pages/**/*.jsx' => [$browserDir],
|
||||
'resources/js/Pages/**/*.svelte' => [$browserDir],
|
||||
|
||||
// Shared layouts / components consumed by pages.
|
||||
'resources/js/Layouts/**/*.vue' => [$browserDir],
|
||||
|
||||
@ -60,6 +60,10 @@ final readonly class Laravel implements WatchDefault
|
||||
|
||||
// Blade templates — compiled to cache, source file not executed.
|
||||
'resources/views/**/*.blade.php' => [$featurePath],
|
||||
// Email templates are nested under views/email or views/emails
|
||||
// by convention and power mailable tests that render markup.
|
||||
'resources/views/email/**/*.blade.php' => [$featurePath],
|
||||
'resources/views/emails/**/*.blade.php' => [$featurePath],
|
||||
|
||||
// Translations — JSON translations read via file_get_contents,
|
||||
// PHP translations loaded via include (but during boot).
|
||||
|
||||
@ -29,6 +29,10 @@ final readonly class Livewire implements WatchDefault
|
||||
// Livewire views live alongside Blade views or in a dedicated dir.
|
||||
'resources/views/livewire/**/*.blade.php' => [$testPath],
|
||||
'resources/views/components/**/*.blade.php' => [$testPath],
|
||||
// Volt's second default mount — single-file components used as
|
||||
// full-page routes. Missing this means editing a Volt page
|
||||
// doesn't re-run its tests.
|
||||
'resources/views/pages/**/*.blade.php' => [$testPath],
|
||||
|
||||
// Livewire JS interop / Alpine plugins.
|
||||
'resources/js/**/*.js' => [$testPath],
|
||||
|
||||
@ -25,9 +25,14 @@ final readonly class Php implements WatchDefault
|
||||
|
||||
return [
|
||||
// Environment files — can change DB drivers, feature flags,
|
||||
// queue connections, etc. Not PHP, not fingerprinted.
|
||||
// queue connections, etc. Not PHP, not fingerprinted. Covers
|
||||
// the local-override variants (`.env.local`, `.env.testing.local`)
|
||||
// that both Laravel and Symfony recommend for machine-specific
|
||||
// config.
|
||||
'.env' => [$testPath],
|
||||
'.env.testing' => [$testPath],
|
||||
'.env.local' => [$testPath],
|
||||
'.env.*.local' => [$testPath],
|
||||
|
||||
// Docker / CI — can affect integration test infrastructure.
|
||||
'docker-compose.yml' => [$testPath],
|
||||
|
||||
@ -46,7 +46,11 @@ final readonly class Symfony implements WatchDefault
|
||||
'src/Kernel.php' => [$testPath],
|
||||
|
||||
// Migrations — run during setUp (before coverage window).
|
||||
// DoctrineMigrationsBundle's default is `migrations/` at the
|
||||
// project root; many Symfony projects relocate to
|
||||
// `src/Migrations/` — both covered.
|
||||
'migrations/**/*.php' => [$testPath],
|
||||
'src/Migrations/**/*.php' => [$testPath],
|
||||
|
||||
// Twig templates — compiled, source not PHP-executed.
|
||||
'templates/**/*.html.twig' => [$testPath],
|
||||
|
||||
@ -16,9 +16,9 @@ use PHPUnit\Event\Test\FinishedSubscriber;
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class EnsureTiaAssertionsAreRecordedOnFinished implements FinishedSubscriber
|
||||
final readonly class EnsureTiaAssertionsAreRecordedOnFinished implements FinishedSubscriber
|
||||
{
|
||||
public function __construct(private readonly ResultCollector $collector) {}
|
||||
public function __construct(private ResultCollector $collector) {}
|
||||
|
||||
public function notify(Finished $event): void
|
||||
{
|
||||
@ -30,5 +30,11 @@ final class EnsureTiaAssertionsAreRecordedOnFinished implements FinishedSubscrib
|
||||
$event->numberOfAssertionsPerformed(),
|
||||
);
|
||||
}
|
||||
|
||||
// Close the "currently recording" window on Finished so the next
|
||||
// test's events don't get mis-attributed. Keeping the pointer open
|
||||
// through the outcome subscribers is what lets a late-firing
|
||||
// `ConsideredRisky` overwrite an earlier `Passed`.
|
||||
$this->collector->finishTest();
|
||||
}
|
||||
}
|
||||
|
||||
@ -11,9 +11,9 @@ use PHPUnit\Event\Test\ErroredSubscriber;
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
final class EnsureTiaResultIsRecordedOnErrored implements ErroredSubscriber
|
||||
final readonly class EnsureTiaResultIsRecordedOnErrored implements ErroredSubscriber
|
||||
{
|
||||
public function __construct(private readonly ResultCollector $collector) {}
|
||||
public function __construct(private ResultCollector $collector) {}
|
||||
|
||||
public function notify(Errored $event): void
|
||||
{
|
||||
|
||||
@ -11,9 +11,9 @@ use PHPUnit\Event\Test\FailedSubscriber;
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
final class EnsureTiaResultIsRecordedOnFailed implements FailedSubscriber
|
||||
final readonly class EnsureTiaResultIsRecordedOnFailed implements FailedSubscriber
|
||||
{
|
||||
public function __construct(private readonly ResultCollector $collector) {}
|
||||
public function __construct(private ResultCollector $collector) {}
|
||||
|
||||
public function notify(Failed $event): void
|
||||
{
|
||||
|
||||
@ -11,9 +11,9 @@ use PHPUnit\Event\Test\MarkedIncompleteSubscriber;
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
final class EnsureTiaResultIsRecordedOnIncomplete implements MarkedIncompleteSubscriber
|
||||
final readonly class EnsureTiaResultIsRecordedOnIncomplete implements MarkedIncompleteSubscriber
|
||||
{
|
||||
public function __construct(private readonly ResultCollector $collector) {}
|
||||
public function __construct(private ResultCollector $collector) {}
|
||||
|
||||
public function notify(MarkedIncomplete $event): void
|
||||
{
|
||||
|
||||
@ -11,9 +11,9 @@ use PHPUnit\Event\Test\PassedSubscriber;
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
final class EnsureTiaResultIsRecordedOnPassed implements PassedSubscriber
|
||||
final readonly class EnsureTiaResultIsRecordedOnPassed implements PassedSubscriber
|
||||
{
|
||||
public function __construct(private readonly ResultCollector $collector) {}
|
||||
public function __construct(private ResultCollector $collector) {}
|
||||
|
||||
public function notify(Passed $event): void
|
||||
{
|
||||
|
||||
@ -11,9 +11,9 @@ use PHPUnit\Event\Test\ConsideredRiskySubscriber;
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
final class EnsureTiaResultIsRecordedOnRisky implements ConsideredRiskySubscriber
|
||||
final readonly class EnsureTiaResultIsRecordedOnRisky implements ConsideredRiskySubscriber
|
||||
{
|
||||
public function __construct(private readonly ResultCollector $collector) {}
|
||||
public function __construct(private ResultCollector $collector) {}
|
||||
|
||||
public function notify(ConsideredRisky $event): void
|
||||
{
|
||||
|
||||
@ -11,9 +11,9 @@ use PHPUnit\Event\Test\SkippedSubscriber;
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
final class EnsureTiaResultIsRecordedOnSkipped implements SkippedSubscriber
|
||||
final readonly class EnsureTiaResultIsRecordedOnSkipped implements SkippedSubscriber
|
||||
{
|
||||
public function __construct(private readonly ResultCollector $collector) {}
|
||||
public function __construct(private ResultCollector $collector) {}
|
||||
|
||||
public function notify(Skipped $event): void
|
||||
{
|
||||
|
||||
@ -20,9 +20,9 @@ use PHPUnit\Event\Test\PreparedSubscriber;
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class EnsureTiaResultsAreCollected implements PreparedSubscriber
|
||||
final readonly class EnsureTiaResultsAreCollected implements PreparedSubscriber
|
||||
{
|
||||
public function __construct(private readonly ResultCollector $collector) {}
|
||||
public function __construct(private ResultCollector $collector) {}
|
||||
|
||||
public function notify(Prepared $event): void
|
||||
{
|
||||
|
||||
@ -5,6 +5,7 @@ declare(strict_types=1);
|
||||
namespace Pest\Support;
|
||||
|
||||
use Pest\Exceptions\ShouldNotHappen;
|
||||
use Pest\Plugins\Tia\CoverageMerger;
|
||||
use SebastianBergmann\CodeCoverage\CodeCoverage;
|
||||
use SebastianBergmann\CodeCoverage\Node\Directory;
|
||||
use SebastianBergmann\CodeCoverage\Node\File;
|
||||
@ -92,7 +93,7 @@ final class Coverage
|
||||
// tests. Merge their fresh coverage slice into the cached full-run
|
||||
// snapshot (stored by the previous `--tia --coverage` pass) so the
|
||||
// report reflects the entire suite, not just what re-ran.
|
||||
\Pest\Plugins\Tia\CoverageMerger::applyIfMarked($reportPath);
|
||||
CoverageMerger::applyIfMarked($reportPath);
|
||||
|
||||
/** @var CodeCoverage $codeCoverage */
|
||||
$codeCoverage = require $reportPath;
|
||||
|
||||
178
src/Support/XdebugGuard.php
Normal file
178
src/Support/XdebugGuard.php
Normal file
@ -0,0 +1,178 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\Support;
|
||||
|
||||
use Composer\XdebugHandler\XdebugHandler;
|
||||
use Pest\Plugins\Tia;
|
||||
use Pest\Plugins\Tia\Fingerprint;
|
||||
use Pest\Plugins\Tia\Graph;
|
||||
use Pest\Plugins\Tia\Storage;
|
||||
|
||||
/**
|
||||
* Re-execs the PHP process without Xdebug on TIA replay runs, matching the
|
||||
* behaviour of composer, phpstan, rector, psalm and pint.
|
||||
*
|
||||
* Xdebug imposes a 30–50% runtime tax on every PHP process that loads it —
|
||||
* even when nothing is actively tracing, profiling or breaking. Plain `pest`
|
||||
* users might rely on Xdebug being loaded (IDE breakpoints, step-through
|
||||
* debugging, custom tooling), so we intentionally leave non-TIA runs alone.
|
||||
*
|
||||
* The guard engages only when ALL of these hold:
|
||||
* 1. `--tia` is present in argv.
|
||||
* 2. No `--fresh` flag (forced record always drives the coverage
|
||||
* driver; dropping Xdebug would break the recording).
|
||||
* 3. No `--coverage*` flag (coverage runs need the driver regardless).
|
||||
* 4. A valid graph already exists on disk AND its structural fingerprint
|
||||
* matches the current environment — i.e. TIA will replay rather than
|
||||
* record. Record runs need the driver.
|
||||
* 5. Xdebug's configured mode is either empty or exactly `['coverage']`.
|
||||
* Any other mode (debug, develop, trace, profile, gcstats) signals the
|
||||
* user wants Xdebug for reasons unrelated to coverage, so we leave it
|
||||
* alone even on replay.
|
||||
*
|
||||
* `PEST_ALLOW_XDEBUG=1` remains an explicit manual override; it is honoured
|
||||
* natively by `composer/xdebug-handler`.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class XdebugGuard
|
||||
{
|
||||
/**
|
||||
* Call as early as possible after composer autoload, before any Pest
|
||||
* class beyond the autoloader is touched. Safe when Xdebug is not
|
||||
* loaded (returns immediately) and when `composer/xdebug-handler` is
|
||||
* unavailable (defensive `class_exists` check).
|
||||
*/
|
||||
public static function maybeDrop(string $projectRoot): void
|
||||
{
|
||||
if (! class_exists(XdebugHandler::class)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (! extension_loaded('xdebug')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (! self::xdebugIsCoverageOnly()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$argv = is_array($_SERVER['argv'] ?? null) ? $_SERVER['argv'] : [];
|
||||
|
||||
if (! self::runLooksDroppable($argv, $projectRoot)) {
|
||||
return;
|
||||
}
|
||||
|
||||
(new XdebugHandler('pest'))->check();
|
||||
}
|
||||
|
||||
/**
|
||||
* True when Xdebug 3+ is running in coverage-only mode (or empty). False
|
||||
* for older Xdebug without `xdebug_info` — be conservative and leave it
|
||||
* loaded; we can't prove the mode is safe to drop.
|
||||
*/
|
||||
private static function xdebugIsCoverageOnly(): bool
|
||||
{
|
||||
if (! function_exists('xdebug_info')) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$modes = @xdebug_info('mode');
|
||||
|
||||
if (! is_array($modes)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$modes = array_values(array_filter($modes, is_string(...)));
|
||||
|
||||
if ($modes === []) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $modes === ['coverage'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Encodes the argv-based rules: `--tia` must be present, no coverage
|
||||
* flag, no forced rebuild, and TIA must be about to replay rather than
|
||||
* record. Plain `pest` (and anything else without `--tia`) keeps Xdebug
|
||||
* loaded so non-TIA users aren't surprised by behaviour changes.
|
||||
*
|
||||
* @param array<int, mixed> $argv
|
||||
*/
|
||||
private static function runLooksDroppable(array $argv, string $projectRoot): bool
|
||||
{
|
||||
$hasTia = false;
|
||||
|
||||
foreach ($argv as $value) {
|
||||
if (! is_string($value)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($value === '--coverage'
|
||||
|| str_starts_with($value, '--coverage=')
|
||||
|| str_starts_with($value, '--coverage-')) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($value === '--fresh') {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($value === '--tia') {
|
||||
$hasTia = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (! $hasTia) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return self::tiaWillReplay($projectRoot);
|
||||
}
|
||||
|
||||
/**
|
||||
* True when a valid TIA graph already lives on disk AND its structural
|
||||
* fingerprint matches the current environment. Any other outcome
|
||||
* (missing graph, unreadable JSON, structural drift) means TIA will
|
||||
* record and the driver must stay loaded.
|
||||
*/
|
||||
private static function tiaWillReplay(string $projectRoot): bool
|
||||
{
|
||||
$path = self::graphPath($projectRoot);
|
||||
|
||||
if (! is_file($path)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$json = @file_get_contents($path);
|
||||
|
||||
if ($json === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$graph = Graph::decode($json, $projectRoot);
|
||||
|
||||
if (! $graph instanceof Graph) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return Fingerprint::structuralMatches(
|
||||
$graph->fingerprint(),
|
||||
Fingerprint::compute($projectRoot),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* On-disk location of the TIA graph — delegates to {@see Storage} so
|
||||
* the writer (TIA's bootstrapper) and this reader stay in sync
|
||||
* without a runtime container lookup (the container isn't booted yet
|
||||
* at this point).
|
||||
*/
|
||||
private static function graphPath(string $projectRoot): string
|
||||
{
|
||||
return Storage::tempDir($projectRoot).DIRECTORY_SEPARATOR.Tia::KEY_GRAPH;
|
||||
}
|
||||
}
|
||||
63
tests-tia/AffectedSetTest.php
Normal file
63
tests-tia/AffectedSetTest.php
Normal file
@ -0,0 +1,63 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Pest\TestsTia\Support\Sandbox;
|
||||
|
||||
/*
|
||||
* Mutating a source file should narrow replay to the tests that depend
|
||||
* on it. Untouched areas of the suite keep cache-hitting.
|
||||
*/
|
||||
|
||||
test('editing a source file marks only its dependents as affected', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
$sandbox->pest(['--tia']);
|
||||
|
||||
$sandbox->write('src/Math.php', <<<'PHP'
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App;
|
||||
|
||||
final class Math
|
||||
{
|
||||
public static function add(int $a, int $b): int
|
||||
{
|
||||
return $a + $b;
|
||||
}
|
||||
|
||||
public static function sub(int $a, int $b): int
|
||||
{
|
||||
return $a - $b;
|
||||
}
|
||||
}
|
||||
PHP);
|
||||
|
||||
$process = $sandbox->pest(['--tia']);
|
||||
|
||||
expect($process->isSuccessful())->toBeTrue(tiaOutput($process));
|
||||
expect(tiaOutput($process))->toMatch('/2 affected,\s*1 replayed/');
|
||||
});
|
||||
});
|
||||
|
||||
test('adding a new test file runs the new test + replays the rest', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
$sandbox->pest(['--tia']);
|
||||
|
||||
$sandbox->write('tests/ExtraTest.php', <<<'PHP'
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
test('extra smoke', function () {
|
||||
expect(true)->toBeTrue();
|
||||
});
|
||||
PHP);
|
||||
|
||||
$process = $sandbox->pest(['--tia']);
|
||||
|
||||
expect($process->isSuccessful())->toBeTrue(tiaOutput($process));
|
||||
expect(tiaOutput($process))->toMatch('/1 affected,\s*3 replayed/');
|
||||
});
|
||||
});
|
||||
52
tests-tia/FingerprintDriftTest.php
Normal file
52
tests-tia/FingerprintDriftTest.php
Normal file
@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Pest\TestsTia\Support\Sandbox;
|
||||
|
||||
/*
|
||||
* Fingerprint splits into structural vs environmental. Hand-forge each
|
||||
* drift flavour on a valid graph and assert the right branch fires.
|
||||
*/
|
||||
|
||||
test('structural drift discards the graph entirely', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
$sandbox->pest(['--tia']);
|
||||
|
||||
$graphPath = $sandbox->path().'/.pest/tia/graph.json';
|
||||
$graph = json_decode((string) file_get_contents($graphPath), true);
|
||||
$graph['fingerprint']['structural']['composer_lock'] = str_repeat('0', 32);
|
||||
file_put_contents($graphPath, json_encode($graph));
|
||||
|
||||
$process = $sandbox->pest(['--tia']);
|
||||
|
||||
expect($process->isSuccessful())->toBeTrue(tiaOutput($process));
|
||||
expect(tiaOutput($process))->toContain('graph structure outdated');
|
||||
});
|
||||
});
|
||||
|
||||
test('environmental drift keeps edges, drops results', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
$sandbox->pest(['--tia']);
|
||||
|
||||
$graphPath = $sandbox->path().'/.pest/tia/graph.json';
|
||||
$graph = json_decode((string) file_get_contents($graphPath), true);
|
||||
|
||||
$edgeCountBefore = count($graph['edges']);
|
||||
|
||||
$graph['fingerprint']['environmental']['php_minor'] = '7.4';
|
||||
$graph['fingerprint']['environmental']['extensions'] = str_repeat('0', 32);
|
||||
file_put_contents($graphPath, json_encode($graph));
|
||||
|
||||
$process = $sandbox->pest(['--tia']);
|
||||
|
||||
expect($process->isSuccessful())->toBeTrue(tiaOutput($process));
|
||||
expect(tiaOutput($process))->toContain('env differs from baseline');
|
||||
expect(tiaOutput($process))->toContain('results dropped, edges reused');
|
||||
|
||||
$graphAfter = $sandbox->graph();
|
||||
expect(count($graphAfter['edges']))->toBe($edgeCountBefore);
|
||||
expect($graphAfter['fingerprint']['environmental']['php_minor'])
|
||||
->not()->toBe('7.4');
|
||||
});
|
||||
});
|
||||
27
tests-tia/Fixtures/sample-project/composer.json
Normal file
27
tests-tia/Fixtures/sample-project/composer.json
Normal file
@ -0,0 +1,27 @@
|
||||
{
|
||||
"name": "pest/tia-sample-project",
|
||||
"type": "project",
|
||||
"description": "Throw-away fixture used by tests-tia to exercise TIA end-to-end.",
|
||||
"require": {
|
||||
"php": "^8.3"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"App\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Tests\\": "tests/"
|
||||
}
|
||||
},
|
||||
"config": {
|
||||
"sort-packages": true,
|
||||
"allow-plugins": {
|
||||
"pestphp/pest-plugin": true,
|
||||
"php-http/discovery": true
|
||||
}
|
||||
},
|
||||
"minimum-stability": "dev",
|
||||
"prefer-stable": true
|
||||
}
|
||||
22
tests-tia/Fixtures/sample-project/phpunit.xml
Normal file
22
tests-tia/Fixtures/sample-project/phpunit.xml
Normal file
@ -0,0 +1,22 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
cacheDirectory=".phpunit.cache"
|
||||
executionOrder="depends,defects"
|
||||
failOnRisky="false"
|
||||
failOnWarning="false"
|
||||
displayDetailsOnTestsThatTriggerWarnings="true"
|
||||
displayDetailsOnTestsThatTriggerNotices="true">
|
||||
<testsuites>
|
||||
<testsuite name="default">
|
||||
<directory>tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<source>
|
||||
<include>
|
||||
<directory>src</directory>
|
||||
</include>
|
||||
</source>
|
||||
</phpunit>
|
||||
13
tests-tia/Fixtures/sample-project/src/Greeter.php
Normal file
13
tests-tia/Fixtures/sample-project/src/Greeter.php
Normal file
@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App;
|
||||
|
||||
final class Greeter
|
||||
{
|
||||
public static function greet(string $name): string
|
||||
{
|
||||
return sprintf('Hello, %s!', $name);
|
||||
}
|
||||
}
|
||||
13
tests-tia/Fixtures/sample-project/src/Math.php
Normal file
13
tests-tia/Fixtures/sample-project/src/Math.php
Normal file
@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App;
|
||||
|
||||
final class Math
|
||||
{
|
||||
public static function add(int $a, int $b): int
|
||||
{
|
||||
return $a + $b;
|
||||
}
|
||||
}
|
||||
9
tests-tia/Fixtures/sample-project/tests/GreeterTest.php
Normal file
9
tests-tia/Fixtures/sample-project/tests/GreeterTest.php
Normal file
@ -0,0 +1,9 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use App\Greeter;
|
||||
|
||||
test('greeter greets', function () {
|
||||
expect(Greeter::greet('Nuno'))->toBe('Hello, Nuno!');
|
||||
});
|
||||
13
tests-tia/Fixtures/sample-project/tests/MathTest.php
Normal file
13
tests-tia/Fixtures/sample-project/tests/MathTest.php
Normal file
@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use App\Math;
|
||||
|
||||
test('math add', function () {
|
||||
expect(Math::add(2, 3))->toBe(5);
|
||||
});
|
||||
|
||||
test('math add negative', function () {
|
||||
expect(Math::add(-1, 1))->toBe(0);
|
||||
});
|
||||
7
tests-tia/Fixtures/sample-project/tests/Pest.php
Normal file
7
tests-tia/Fixtures/sample-project/tests/Pest.php
Normal file
@ -0,0 +1,7 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
// Intentionally minimal — tests-tia exercises TIA against the simplest
|
||||
// possible Pest harness. Anything more and we end up debugging the
|
||||
// fixture instead of the feature under test.
|
||||
28
tests-tia/RebuildTest.php
Normal file
28
tests-tia/RebuildTest.php
Normal file
@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Pest\TestsTia\Support\Sandbox;
|
||||
|
||||
/*
|
||||
* `--tia --fresh` short-circuits whatever graph is on disk and records
|
||||
* from scratch. Used when the user knows the cache is wrong.
|
||||
*/
|
||||
|
||||
test('--tia --fresh forces record mode even with a valid graph', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
$sandbox->pest(['--tia']);
|
||||
expect($sandbox->hasGraph())->toBeTrue();
|
||||
|
||||
$graphBefore = $sandbox->graph();
|
||||
|
||||
$process = $sandbox->pest(['--tia', '--fresh']);
|
||||
|
||||
expect($process->isSuccessful())->toBeTrue(tiaOutput($process));
|
||||
expect(tiaOutput($process))->toContain('recording dependency graph');
|
||||
|
||||
$graphAfter = $sandbox->graph();
|
||||
expect(array_keys($graphAfter['edges']))
|
||||
->toEqualCanonicalizing(array_keys($graphBefore['edges']));
|
||||
});
|
||||
});
|
||||
42
tests-tia/RecordReplayTest.php
Normal file
42
tests-tia/RecordReplayTest.php
Normal file
@ -0,0 +1,42 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Pest\TestsTia\Support\Sandbox;
|
||||
|
||||
/*
|
||||
* The canonical cycle:
|
||||
* 1. Cold `--tia` run → record mode → graph written, tests pass.
|
||||
* 2. Subsequent `--tia` runs → replay mode, every test cache-hits.
|
||||
*/
|
||||
|
||||
test('cold run records the graph', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
$process = $sandbox->pest(['--tia']);
|
||||
|
||||
expect($process->isSuccessful())->toBeTrue(tiaOutput($process));
|
||||
expect(tiaOutput($process))->toContain('recording dependency graph');
|
||||
expect($sandbox->hasGraph())->toBeTrue();
|
||||
|
||||
$graph = $sandbox->graph();
|
||||
expect($graph)->toHaveKey('edges');
|
||||
expect(array_keys($graph['edges']))->toContain('tests/MathTest.php');
|
||||
expect(array_keys($graph['edges']))->toContain('tests/GreeterTest.php');
|
||||
});
|
||||
});
|
||||
|
||||
test('warm run replays every test', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
// Cold pass: records edges AND snapshots results (series mode
|
||||
// runs `snapshotTestResults` in the same `addOutput` pass).
|
||||
$sandbox->pest(['--tia']);
|
||||
|
||||
$process = $sandbox->pest(['--tia']);
|
||||
|
||||
expect($process->isSuccessful())->toBeTrue(tiaOutput($process));
|
||||
// Zero changes → only the `replayed` fragment appears in the
|
||||
// recap; the `affected` fragment is omitted when count is 0.
|
||||
expect(tiaOutput($process))->toMatch('/3 replayed/');
|
||||
expect(tiaOutput($process))->not()->toMatch('/\d+ affected/');
|
||||
});
|
||||
});
|
||||
46
tests-tia/SourceRevertTest.php
Normal file
46
tests-tia/SourceRevertTest.php
Normal file
@ -0,0 +1,46 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Pest\TestsTia\Support\Sandbox;
|
||||
|
||||
/*
|
||||
* Edit a source file, run TIA (tests re-run), revert to the original
|
||||
* bytes, run again — the revert is itself a change vs the previous
|
||||
* snapshot, so the affected tests re-execute rather than replaying the
|
||||
* stale bad-version cache.
|
||||
*/
|
||||
|
||||
test('reverting a modified file re-triggers its affected tests', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
$sandbox->pest(['--tia']);
|
||||
|
||||
$original = (string) file_get_contents($sandbox->path().'/src/Math.php');
|
||||
|
||||
$sandbox->write('src/Math.php', <<<'PHP'
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App;
|
||||
|
||||
final class Math
|
||||
{
|
||||
public static function add(int $a, int $b): int
|
||||
{
|
||||
return 999; // broken
|
||||
}
|
||||
}
|
||||
PHP);
|
||||
|
||||
$broken = $sandbox->pest(['--tia']);
|
||||
expect($broken->isSuccessful())->toBeFalse();
|
||||
|
||||
$sandbox->write('src/Math.php', $original);
|
||||
|
||||
$recovered = $sandbox->pest(['--tia']);
|
||||
|
||||
expect($recovered->isSuccessful())->toBeTrue(tiaOutput($recovered));
|
||||
expect(tiaOutput($recovered))->toMatch('/2 affected,\s*1 replayed/');
|
||||
});
|
||||
});
|
||||
53
tests-tia/StatusReplayTest.php
Normal file
53
tests-tia/StatusReplayTest.php
Normal file
@ -0,0 +1,53 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Pest\TestsTia\Support\Sandbox;
|
||||
|
||||
/*
|
||||
* Cached statuses + assertion counts should survive replay.
|
||||
*/
|
||||
|
||||
test('assertion counts survive replay', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
$sandbox->pest(['--tia']);
|
||||
|
||||
$process = $sandbox->pest(['--tia']);
|
||||
$output = tiaOutput($process);
|
||||
|
||||
// MathTest has 2 assertions, GreeterTest has 1 → 3 total.
|
||||
// The "Tests: … (N assertions, … replayed)" banner should show 3.
|
||||
expect($output)->toMatch('/\(3 assertions/');
|
||||
});
|
||||
});
|
||||
|
||||
test('breaking a test replays as a failure on the next run', function () {
|
||||
tiaScenario(function (Sandbox $sandbox) {
|
||||
// Prime.
|
||||
$sandbox->pest(['--tia']);
|
||||
|
||||
// Break the test. Its test file's edge map still points at
|
||||
// `src/Math.php`; editing the test file counts as a change
|
||||
// and the test re-executes.
|
||||
$sandbox->write('tests/MathTest.php', <<<'PHP'
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use App\Math;
|
||||
|
||||
test('math add', function () {
|
||||
expect(Math::add(2, 3))->toBe(999); // wrong
|
||||
});
|
||||
|
||||
test('math add negative', function () {
|
||||
expect(Math::add(-1, 1))->toBe(0);
|
||||
});
|
||||
PHP);
|
||||
|
||||
$process = $sandbox->pest(['--tia']);
|
||||
|
||||
expect($process->isSuccessful())->toBeFalse();
|
||||
expect(tiaOutput($process))->toContain('math add');
|
||||
});
|
||||
});
|
||||
447
tests-tia/Support/Sandbox.php
Normal file
447
tests-tia/Support/Sandbox.php
Normal file
@ -0,0 +1,447 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pest\TestsTia\Support;
|
||||
|
||||
use RuntimeException;
|
||||
use Symfony\Component\Process\Process;
|
||||
|
||||
/**
|
||||
* Throw-away sandbox for a TIA end-to-end scenario.
|
||||
*
|
||||
* On first call in a test run, a shared "template" sandbox is created
|
||||
* under the system temp dir and composer-installed against the host
|
||||
* Pest source. Subsequent `::create()` calls clone the template — cheap
|
||||
* (rcopy + git init) vs. running composer install per test.
|
||||
*
|
||||
* Each test owns its own clone; no cross-test state.
|
||||
*
|
||||
* Set `PEST_TIA_KEEP=1` to skip teardown so a failing scenario can be
|
||||
* reproduced manually — the path is emitted to STDERR.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
final class Sandbox
|
||||
{
|
||||
private static ?string $templatePath = null;
|
||||
|
||||
private function __construct(private readonly string $path) {}
|
||||
|
||||
/**
|
||||
* Eagerly provision the shared template. Call once from the harness
|
||||
* bootstrap so parallel workers don't race on first `create()`.
|
||||
*/
|
||||
public static function warmTemplate(): void
|
||||
{
|
||||
self::ensureTemplate();
|
||||
}
|
||||
|
||||
public static function create(): self
|
||||
{
|
||||
$template = self::ensureTemplate();
|
||||
|
||||
$path = sys_get_temp_dir()
|
||||
.DIRECTORY_SEPARATOR
|
||||
.'pest-tia-sandbox-'
|
||||
.bin2hex(random_bytes(4));
|
||||
|
||||
self::rcopy($template, $path);
|
||||
self::bootstrapGit($path);
|
||||
|
||||
return new self($path);
|
||||
}
|
||||
|
||||
public function path(): string
|
||||
{
|
||||
return $this->path;
|
||||
}
|
||||
|
||||
public function write(string $relative, string $content): void
|
||||
{
|
||||
$absolute = $this->path.DIRECTORY_SEPARATOR.$relative;
|
||||
$dir = dirname($absolute);
|
||||
|
||||
if (! is_dir($dir) && ! @mkdir($dir, 0755, true) && ! is_dir($dir)) {
|
||||
throw new RuntimeException("Cannot create {$dir}");
|
||||
}
|
||||
|
||||
if (@file_put_contents($absolute, $content) === false) {
|
||||
throw new RuntimeException("Cannot write {$absolute}");
|
||||
}
|
||||
}
|
||||
|
||||
public function delete(string $relative): void
|
||||
{
|
||||
$absolute = $this->path.DIRECTORY_SEPARATOR.$relative;
|
||||
|
||||
if (is_file($absolute)) {
|
||||
@unlink($absolute);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, string> $flags
|
||||
*/
|
||||
public function pest(array $flags = []): Process
|
||||
{
|
||||
// Invoke Pest's bin script through PHP directly rather than the
|
||||
// `vendor/bin/pest` symlink — `rcopy()` loses the `+x` bit when
|
||||
// cloning the template. Going through `php` bypasses the exec
|
||||
// check. Use `PHP_BINARY` (not a bare `php`) so the sandbox
|
||||
// executes under the same interpreter that launched the outer
|
||||
// test suite — otherwise macOS multi-version setups (Herd, brew,
|
||||
// asdf, …) fall back to the first `php` on `$PATH`, which often
|
||||
// lacks the coverage driver TIA's record mode needs.
|
||||
$process = new Process(
|
||||
[PHP_BINARY, 'vendor/pestphp/pest/bin/pest', ...$flags],
|
||||
$this->path,
|
||||
[
|
||||
// Strip any CI signal so TIA doesn't suppress instructions.
|
||||
'GITHUB_ACTIONS' => '',
|
||||
'GITLAB_CI' => '',
|
||||
'CIRCLECI' => '',
|
||||
// Force TIA's Storage to fall back to the sandbox-local
|
||||
// `.pest/tia/` layout. Without this, every sandbox run
|
||||
// would dump state into the developer's real home dir
|
||||
// (`~/.pest/tia/`), polluting it and making tests
|
||||
// non-hermetic.
|
||||
'HOME' => '',
|
||||
'USERPROFILE' => '',
|
||||
],
|
||||
);
|
||||
$process->setTimeout(120.0);
|
||||
$process->run();
|
||||
|
||||
return $process;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, mixed>|null
|
||||
*/
|
||||
public function graph(): ?array
|
||||
{
|
||||
$path = $this->path.'/.pest/tia/graph.json';
|
||||
|
||||
if (! is_file($path)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$raw = @file_get_contents($path);
|
||||
|
||||
if ($raw === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$decoded = json_decode($raw, true);
|
||||
|
||||
return is_array($decoded) ? $decoded : null;
|
||||
}
|
||||
|
||||
public function hasGraph(): bool
|
||||
{
|
||||
return $this->graph() !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, string> $args
|
||||
*/
|
||||
public function git(array $args): Process
|
||||
{
|
||||
$process = new Process(['git', ...$args], $this->path);
|
||||
$process->setTimeout(30.0);
|
||||
$process->run();
|
||||
|
||||
return $process;
|
||||
}
|
||||
|
||||
public function destroy(): void
|
||||
{
|
||||
if (getenv('PEST_TIA_KEEP') === '1') {
|
||||
fwrite(STDERR, "[PEST_TIA_KEEP] sandbox: {$this->path}\n");
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if (is_dir($this->path)) {
|
||||
self::rrmdir($this->path);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Lazily provisions a once-per-process template with composer already
|
||||
* installed against the host Pest source. Every sandbox clone copies
|
||||
* from here, avoiding a ~30s composer install per test.
|
||||
*/
|
||||
private static function ensureTemplate(): string
|
||||
{
|
||||
if (self::$templatePath !== null && is_dir(self::$templatePath.'/vendor')) {
|
||||
return self::$templatePath;
|
||||
}
|
||||
|
||||
// Cache key includes a fingerprint of the host Pest source tree —
|
||||
// when we edit Pest internals, the key changes, old templates
|
||||
// become orphaned, the new template rebuilds. Without this, a
|
||||
// stale template with yesterday's Pest code silently masks today's
|
||||
// code under test.
|
||||
$template = sys_get_temp_dir()
|
||||
.DIRECTORY_SEPARATOR
|
||||
.'pest-tia-template-'
|
||||
.self::hostFingerprint();
|
||||
|
||||
// Serialise template creation across parallel paratest workers.
|
||||
// Without the lock, three workers hitting `ensureTemplate()`
|
||||
// simultaneously each see "no vendor yet → rebuild", stomp on
|
||||
// each other's composer install, and produce half-written
|
||||
// fixtures. `flock` on a sibling lockfile keeps it to one
|
||||
// builder; the others block, then observe the finished
|
||||
// template and skip straight to the fast path.
|
||||
$lockPath = sys_get_temp_dir().DIRECTORY_SEPARATOR.'pest-tia-template.lock';
|
||||
$lock = fopen($lockPath, 'c');
|
||||
|
||||
if ($lock === false) {
|
||||
throw new RuntimeException('Cannot open template lock at '.$lockPath);
|
||||
}
|
||||
|
||||
flock($lock, LOCK_EX);
|
||||
|
||||
try {
|
||||
// Re-check after acquiring the lock — another worker may have
|
||||
// just finished the build while we were waiting.
|
||||
if (is_dir($template.'/vendor')) {
|
||||
self::$templatePath = $template;
|
||||
|
||||
return $template;
|
||||
}
|
||||
|
||||
// Garbage-collect every older template keyed by a different
|
||||
// fingerprint so /tmp doesn't accumulate a 200 MB graveyard
|
||||
// over a month of edits.
|
||||
foreach (glob(sys_get_temp_dir().DIRECTORY_SEPARATOR.'pest-tia-template-*') ?: [] as $orphan) {
|
||||
if ($orphan !== $template) {
|
||||
self::rrmdir($orphan);
|
||||
}
|
||||
}
|
||||
|
||||
if (is_dir($template)) {
|
||||
self::rrmdir($template);
|
||||
}
|
||||
|
||||
$fixture = __DIR__.'/../Fixtures/sample-project';
|
||||
|
||||
if (! is_dir($fixture)) {
|
||||
throw new RuntimeException('Missing fixture at '.$fixture);
|
||||
}
|
||||
|
||||
if (! @mkdir($template, 0755, true) && ! is_dir($template)) {
|
||||
throw new RuntimeException('Cannot create template at '.$template);
|
||||
}
|
||||
|
||||
self::rcopy($fixture, $template);
|
||||
self::wireHostPest($template);
|
||||
self::composerInstall($template);
|
||||
|
||||
self::$templatePath = $template;
|
||||
|
||||
return $template;
|
||||
} finally {
|
||||
flock($lock, LOCK_UN);
|
||||
fclose($lock);
|
||||
}
|
||||
}
|
||||
|
||||
private static function wireHostPest(string $path): void
|
||||
{
|
||||
$hostRoot = realpath(__DIR__.'/../..');
|
||||
|
||||
if ($hostRoot === false) {
|
||||
throw new RuntimeException('Cannot resolve host Pest root');
|
||||
}
|
||||
|
||||
$composerJson = $path.'/composer.json';
|
||||
$decoded = json_decode((string) file_get_contents($composerJson), true);
|
||||
|
||||
$decoded['repositories'] = [
|
||||
['type' => 'path', 'url' => $hostRoot, 'options' => ['symlink' => false]],
|
||||
];
|
||||
$decoded['require']['pestphp/pest'] = '*@dev';
|
||||
|
||||
file_put_contents(
|
||||
$composerJson,
|
||||
json_encode($decoded, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)."\n",
|
||||
);
|
||||
}
|
||||
|
||||
private static function composerInstall(string $path): void
|
||||
{
|
||||
// Invoke composer via the *same* PHP binary that's running this
|
||||
// process. On macOS multi-version setups (Herd, brew, asdf, etc.)
|
||||
// the `composer` shebang often points at the system PHP, which
|
||||
// may not match the version the test suite booted with — leading
|
||||
// to "your PHP version does not satisfy the requirement" errors
|
||||
// even when the interpreter in use would satisfy it. Going
|
||||
// through `PHP_BINARY` + the located composer binary/phar
|
||||
// sidesteps that entirely.
|
||||
$composer = self::locateComposer();
|
||||
$args = $composer === null
|
||||
? ['composer', 'install']
|
||||
: [PHP_BINARY, $composer, 'install'];
|
||||
|
||||
$process = new Process(
|
||||
[...$args, '--no-interaction', '--prefer-dist', '--no-progress', '--quiet'],
|
||||
$path,
|
||||
);
|
||||
$process->setTimeout(600.0);
|
||||
$process->run();
|
||||
|
||||
if (! $process->isSuccessful()) {
|
||||
throw new RuntimeException(
|
||||
"composer install failed in template:\n".$process->getOutput().$process->getErrorOutput(),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves the composer binary to a real path PHP can execute. Returns
|
||||
* `null` when composer isn't findable, in which case the caller falls
|
||||
* back to invoking plain `composer` via `$PATH` (and hopes for the
|
||||
* best — usually fine on CI Linux runners).
|
||||
*/
|
||||
private static function locateComposer(): ?string
|
||||
{
|
||||
$probe = new Process(['command', '-v', 'composer']);
|
||||
$probe->run();
|
||||
|
||||
$path = trim($probe->getOutput());
|
||||
|
||||
if ($path === '' || ! is_file($path)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// `composer` may be a shell-script wrapper (Herd does this) —
|
||||
// resolve the actual phar it invokes. Heuristic: parse out the
|
||||
// last `.phar` argument from the wrapper, fall back to the file
|
||||
// itself if no wrapper is detected.
|
||||
$content = @file_get_contents($path);
|
||||
|
||||
if ($content !== false && preg_match('/\S+\.phar/', $content, $m) === 1) {
|
||||
$phar = $m[0];
|
||||
|
||||
if (is_file($phar)) {
|
||||
return $phar;
|
||||
}
|
||||
}
|
||||
|
||||
return $path;
|
||||
}
|
||||
|
||||
private static function bootstrapGit(string $path): void
|
||||
{
|
||||
// Each clone needs its own repo — TIA's SHA / branch / diff logic
|
||||
// all rely on `.git/`. The template has no git dir so clones start
|
||||
// from a clean slate.
|
||||
$run = function (array $args) use ($path): void {
|
||||
$process = new Process(['git', ...$args], $path);
|
||||
$process->setTimeout(30.0);
|
||||
$process->run();
|
||||
|
||||
if (! $process->isSuccessful()) {
|
||||
throw new RuntimeException('git '.implode(' ', $args).' failed: '.$process->getErrorOutput());
|
||||
}
|
||||
};
|
||||
|
||||
// `.git` may have been cloned from the template if we ever add one
|
||||
// there — nuke it just in case so every sandbox starts fresh.
|
||||
if (is_dir($path.'/.git')) {
|
||||
self::rrmdir($path.'/.git');
|
||||
}
|
||||
|
||||
// Keep `vendor/` and composer lock out of the sandbox's git repo
|
||||
// entirely. With ~thousands of files `git add .` takes tens of
|
||||
// seconds; TIA also ignores vendor paths via `shouldIgnore()` so
|
||||
// tracking them buys nothing except slowness.
|
||||
file_put_contents($path.'/.gitignore', "vendor/\ncomposer.lock\n");
|
||||
|
||||
$run(['init', '-q', '-b', 'main']);
|
||||
$run(['config', 'user.email', 'sandbox@pest.test']);
|
||||
$run(['config', 'user.name', 'Pest Sandbox']);
|
||||
$run(['config', 'commit.gpgsign', 'false']);
|
||||
$run(['add', '.']);
|
||||
$run(['commit', '-q', '-m', 'initial']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Short hash derived from the host Pest source that the template is
|
||||
* built against. Hashing the newest mtime across `src/`, `overrides/`,
|
||||
* and `composer.json` is cheap (one stat each) and catches every edit
|
||||
* that could alter TIA behaviour.
|
||||
*/
|
||||
private static function hostFingerprint(): string
|
||||
{
|
||||
$hostRoot = realpath(__DIR__.'/../..');
|
||||
|
||||
if ($hostRoot === false) {
|
||||
return 'unknown';
|
||||
}
|
||||
|
||||
$newest = 0;
|
||||
|
||||
foreach ([$hostRoot.'/src', $hostRoot.'/overrides'] as $dir) {
|
||||
if (! is_dir($dir)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$iter = new \RecursiveIteratorIterator(
|
||||
new \RecursiveDirectoryIterator($dir, \FilesystemIterator::SKIP_DOTS),
|
||||
);
|
||||
|
||||
foreach ($iter as $file) {
|
||||
if ($file->isFile()) {
|
||||
$newest = max($newest, $file->getMTime());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (is_file($hostRoot.'/composer.json')) {
|
||||
$newest = max($newest, (int) filemtime($hostRoot.'/composer.json'));
|
||||
}
|
||||
|
||||
return substr(sha1($hostRoot.'|'.PHP_VERSION.'|'.$newest), 0, 12);
|
||||
}
|
||||
|
||||
private static function rcopy(string $src, string $dest): void
|
||||
{
|
||||
if (! is_dir($dest) && ! @mkdir($dest, 0755, true) && ! is_dir($dest)) {
|
||||
throw new RuntimeException("Cannot create {$dest}");
|
||||
}
|
||||
|
||||
$iter = new \RecursiveIteratorIterator(
|
||||
new \RecursiveDirectoryIterator($src, \FilesystemIterator::SKIP_DOTS),
|
||||
\RecursiveIteratorIterator::SELF_FIRST,
|
||||
);
|
||||
|
||||
foreach ($iter as $item) {
|
||||
$target = $dest.DIRECTORY_SEPARATOR.$iter->getSubPathname();
|
||||
|
||||
if ($item->isDir()) {
|
||||
@mkdir($target, 0755, true);
|
||||
} else {
|
||||
copy($item->getPathname(), $target);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static function rrmdir(string $dir): void
|
||||
{
|
||||
if (! is_dir($dir)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// `rm -rf` shells out but handles symlinks, read-only files, and
|
||||
// the composer-vendor quirks (lock files, .bin symlinks) that
|
||||
// PHP's own recursive delete stumbles on. Non-fatal on failure.
|
||||
$process = new Process(['rm', '-rf', $dir]);
|
||||
$process->setTimeout(60.0);
|
||||
$process->run();
|
||||
}
|
||||
}
|
||||
65
tests-tia/bootstrap.php
Normal file
65
tests-tia/bootstrap.php
Normal file
@ -0,0 +1,65 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* tests-tia bootstrap.
|
||||
*
|
||||
* Pest's automatic `Pest.php` loader scans the configured `testDirectory()`
|
||||
* which defaults to `tests/` and is hard to override from a nested suite.
|
||||
* So instead of relying on `tests-tia/Pest.php` being found, wire the
|
||||
* helpers in via PHPUnit's explicit `bootstrap=` attribute — simpler,
|
||||
* no config-search surprises.
|
||||
*/
|
||||
require __DIR__.'/../vendor/autoload.php';
|
||||
require __DIR__.'/Support/Sandbox.php';
|
||||
|
||||
use Pest\TestsTia\Support\Sandbox;
|
||||
use Symfony\Component\Process\Process;
|
||||
|
||||
// tests-tia exercises the record path end-to-end, which means the
|
||||
// sandbox PHP must expose a coverage driver (pcov or xdebug with
|
||||
// coverage mode). Without one, `--tia` records zero edges and every
|
||||
// scenario assertion fails with a useless "no coverage driver" banner.
|
||||
// Bail out loudly at bootstrap so the failure mode is obvious.
|
||||
if (! extension_loaded('pcov') && ! extension_loaded('xdebug')) {
|
||||
fwrite(STDERR, "\n");
|
||||
fwrite(STDERR, " \e[30;43m SKIP \e[0m tests-tia requires a coverage driver (pcov or xdebug).\n");
|
||||
fwrite(STDERR, " Install one, then retry: composer test:tia\n\n");
|
||||
|
||||
// Exit 0 so CI doesn't fail when the driver is genuinely absent —
|
||||
// the CI workflow adds pcov explicitly so this branch only fires on
|
||||
// dev machines that haven't set one up.
|
||||
exit(0);
|
||||
}
|
||||
|
||||
// Pre-warm the shared composer template once, up-front. Without this,
|
||||
// parallel workers race on first use — whoever hits `ensureTemplate()`
|
||||
// second gets a half-written template. A file-based lock + single
|
||||
// bootstrap pre-warm sidesteps the problem entirely.
|
||||
Sandbox::warmTemplate();
|
||||
|
||||
/**
|
||||
* Runs `$body` inside a fresh sandbox, guaranteeing teardown even when the
|
||||
* body throws. Keeps scenario tests tidy — one line per setup + destroy.
|
||||
*/
|
||||
function tiaScenario(Closure $body): void
|
||||
{
|
||||
$sandbox = Sandbox::create();
|
||||
|
||||
try {
|
||||
$body($sandbox);
|
||||
} finally {
|
||||
$sandbox->destroy();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Strip ANSI escapes so assertions are terminal-agnostic.
|
||||
*/
|
||||
function tiaOutput(Process $process): string
|
||||
{
|
||||
$output = $process->getOutput().$process->getErrorOutput();
|
||||
|
||||
return preg_replace('/\e\[[0-9;]*m/', '', $output) ?? $output;
|
||||
}
|
||||
17
tests-tia/phpunit.xml
Normal file
17
tests-tia/phpunit.xml
Normal file
@ -0,0 +1,17 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="../vendor/phpunit/phpunit/phpunit.xsd"
|
||||
bootstrap="bootstrap.php"
|
||||
colors="true"
|
||||
cacheDirectory="../.phpunit.cache/tests-tia"
|
||||
executionOrder="default"
|
||||
failOnRisky="false"
|
||||
failOnWarning="false">
|
||||
<testsuites>
|
||||
<testsuite name="tia">
|
||||
<directory>.</directory>
|
||||
<exclude>Fixtures</exclude>
|
||||
<exclude>Support</exclude>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
</phpunit>
|
||||
Reference in New Issue
Block a user