This commit is contained in:
nuno maduro
2026-04-21 09:40:01 -07:00
parent f6609f4039
commit 51fc380789
3 changed files with 241 additions and 69 deletions

View File

@ -503,6 +503,22 @@ final class Tia implements AddsOutput, HandlesArguments, Terminable
$finalised[$testFile] = array_keys($sourceSet); $finalised[$testFile] = array_keys($sourceSet);
} }
// Empty-edges guard: if every worker returned no edges it almost
// always means the coverage driver wasn't loaded in the workers
// (common footgun with custom PHP ini scan dirs, Herd profiles,
// stripped CI runners). Writing the empty graph would silently
// seed a broken baseline; fail loud instead.
if ($finalised === []) {
$this->output->writeln([
'',
' <fg=white;bg=red> ERROR </> TIA recorded zero edges — coverage driver likely missing.',
' Install / enable <fg=cyan>pcov</> or <fg=cyan>xdebug</> (mode: coverage) in the worker PHP and retry.',
'',
]);
return $exitCode;
}
$graph->replaceEdges($finalised); $graph->replaceEdges($finalised);
$graph->pruneMissingTests(); $graph->pruneMissingTests();
@ -527,6 +543,56 @@ final class Tia implements AddsOutput, HandlesArguments, Terminable
return $exitCode; return $exitCode;
} }
/**
* Compares a loaded graph's fingerprint to the current one and decides
* how much of the graph is still usable.
*
* - **Structural drift** (composer.lock, Pest.php, factory codegen,
* schema bump): edges themselves are potentially wrong → discard
* the whole graph + coverage cache and return null. Caller falls
* through to record mode.
* - **Environmental drift** (PHP minor, extension set, Pest version):
* edges describe the code correctly; only the cached per-test
* results were captured against a different runtime and might not
* reproduce. Drop `baselines[branch].results` + coverage cache,
* bump the fingerprint to the current env, persist. Caller uses
* the graph for edges; results refill naturally during this run's
* replay (every test misses cache, runs normally, seeds results).
* - **Match**: return the graph untouched.
*
* @param array{structural: array<string, mixed>, environmental: array<string, mixed>} $current
*/
private function reconcileFingerprint(Graph $graph, array $current): ?Graph
{
$stored = $graph->fingerprint();
if (! Fingerprint::structuralMatches($stored, $current)) {
$this->output->writeln(
' <fg=yellow>TIA</> graph structure outdated — rebuilding.',
);
$this->state->delete(self::KEY_GRAPH);
$this->state->delete(self::KEY_COVERAGE_CACHE);
return null;
}
$drift = Fingerprint::environmentalDrift($stored, $current);
if ($drift !== []) {
$this->output->writeln(sprintf(
' <fg=yellow>TIA</> env differs from baseline (%s) — results dropped, edges reused.',
implode(', ', $drift),
));
$graph->clearResults($this->branch);
$graph->setFingerprint($current);
$this->saveGraph($graph);
$this->state->delete(self::KEY_COVERAGE_CACHE);
}
return $graph;
}
/** /**
* @param array<int, string> $arguments * @param array<int, string> $arguments
* @return array<int, string> * @return array<int, string>
@ -547,11 +613,8 @@ final class Tia implements AddsOutput, HandlesArguments, Terminable
$graph = $forceRebuild ? null : $this->loadGraph($projectRoot); $graph = $forceRebuild ? null : $this->loadGraph($projectRoot);
if ($graph instanceof Graph && ! Fingerprint::matches($graph->fingerprint(), $fingerprint)) { if ($graph instanceof Graph) {
$this->output->writeln( $graph = $this->reconcileFingerprint($graph, $fingerprint);
' <fg=yellow>TIA</> environment fingerprint changed — graph will be rebuilt.',
);
$graph = null;
} }
if ($graph instanceof Graph) { if ($graph instanceof Graph) {
@ -571,18 +634,13 @@ final class Tia implements AddsOutput, HandlesArguments, Terminable
// No local graph and not being forced to rebuild from scratch: try // No local graph and not being forced to rebuild from scratch: try
// to pull a team-shared baseline so fresh checkouts (new devs, CI // to pull a team-shared baseline so fresh checkouts (new devs, CI
// containers) don't pay the full record cost. If the pull succeeds // containers) don't pay the full record cost. If the pull succeeds
// the graph is re-read and re-validated against the local env. // the graph is re-read and reconciled against the local env.
if ($graph === null && ! $forceRebuild) { if ($graph === null && ! $forceRebuild) {
if ($this->baselineSync->fetchIfAvailable($projectRoot)) { if ($this->baselineSync->fetchIfAvailable($projectRoot)) {
$graph = $this->loadGraph($projectRoot); $graph = $this->loadGraph($projectRoot);
if ($graph instanceof Graph && ! Fingerprint::matches($graph->fingerprint(), $fingerprint)) { if ($graph instanceof Graph) {
$this->output->writeln( $graph = $this->reconcileFingerprint($graph, $fingerprint);
' <fg=yellow>TIA</> pulled baseline fingerprint mismatch — discarding.',
);
$this->state->delete(self::KEY_GRAPH);
$this->state->delete(self::KEY_COVERAGE_CACHE);
$graph = null;
} }
} }
} }

View File

@ -5,54 +5,177 @@ declare(strict_types=1);
namespace Pest\Plugins\Tia; 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 * - **structural** — describes what the graph's *edges* were recorded
* what a test actually exercises, so the graph must be rebuilt in those cases. * 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 * @internal
*/ */
final readonly class Fingerprint final readonly class Fingerprint
{ {
// Bump this whenever the set of inputs or the hash algorithm changes, so // Bump this whenever the set of inputs or the hash algorithm changes,
// older graphs are invalidated automatically. // so older graphs are invalidated automatically.
private const int SCHEMA_VERSION = 3; private const int SCHEMA_VERSION = 4;
/** /**
* @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 public static function compute(string $projectRoot): array
{ {
return [ return [
'schema' => self::SCHEMA_VERSION, 'structural' => [
'php' => PHP_VERSION, 'schema' => self::SCHEMA_VERSION,
// Loaded extensions + their versions. Guards against the 'composer_lock' => self::hashIfExists($projectRoot.'/composer.lock'),
// "recorded without pcov/xdebug → subsequent run has the 'phpunit_xml' => self::hashIfExists($projectRoot.'/phpunit.xml'),
// driver but graph has no edges" trap where the fingerprint 'phpunit_xml_dist' => self::hashIfExists($projectRoot.'/phpunit.xml.dist'),
// matches but the graph is effectively empty. Sorted so two 'pest_php' => self::hashIfExists($projectRoot.'/tests/Pest.php'),
// processes with the same extensions in different load order // Pest's generated classes bake the code-generation logic
// still produce the same hash. // in — if TestCaseFactory changes (new attribute, different
'extensions' => self::extensionsFingerprint(), // method signature, etc.) every previously-recorded edge is
'pest' => self::readPestVersion($projectRoot), // stale. Hashing the factory sources makes path-repo /
'composer_lock' => self::hashIfExists($projectRoot.'/composer.lock'), // dev-main installs automatically rebuild their graphs when
'phpunit_xml' => self::hashIfExists($projectRoot.'/phpunit.xml'), // Pest itself is edited.
'phpunit_xml_dist' => self::hashIfExists($projectRoot.'/phpunit.xml.dist'), 'pest_factory' => self::hashIfExists(__DIR__.'/../../Factories/TestCaseFactory.php'),
'pest_php' => self::hashIfExists($projectRoot.'/tests/Pest.php'), 'pest_method_factory' => self::hashIfExists(__DIR__.'/../../Factories/TestCaseMethodFactory.php'),
// Pest's generated classes bake the code-generation logic in — if ],
// TestCaseFactory changes (new attribute, different method 'environmental' => [
// signature, etc.) every previously-recorded edge is stale. // PHP **minor** only (8.4, not 8.4.19) — CI's resolved patch
// Hashing the factory sources makes path-repo / dev-main installs // almost never matches a dev's Herd/Homebrew install, and
// automatically rebuild their graphs when Pest itself is edited. // the patch rarely changes anything test-visible.
'pest_factory' => self::hashIfExists(__DIR__.'/../../Factories/TestCaseFactory.php'), 'php_minor' => PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION,
'pest_method_factory' => self::hashIfExists(__DIR__.'/../../Factories/TestCaseMethodFactory.php'), 'extensions' => self::extensionsFingerprint(),
'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 structuralMatches(array $a, array $b): bool
{
$aStructural = self::structuralOnly($a);
$bStructural = self::structuralOnly($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
{
if (! is_file($path)) {
return null;
}
$hash = @hash_file('xxh128', $path);
return $hash === false ? null : $hash;
}
/** /**
* Deterministic hash of the PHP extension set: `ext-name@version` pairs * Deterministic hash of the PHP extension set: `ext-name@version` pairs
* sorted alphabetically and joined. Captures both presence (pcov * sorted alphabetically and joined.
* disappeared? graph must rebuild) and version changes (xdebug minor
* bump with coverage-mode semantics).
*/ */
private static function extensionsFingerprint(): string private static function extensionsFingerprint(): string
{ {
@ -69,29 +192,6 @@ final readonly class Fingerprint
return hash('xxh128', implode("\n", $parts)); return hash('xxh128', implode("\n", $parts));
} }
/**
* @param array<string, mixed> $a
* @param array<string, mixed> $b
*/
public static function matches(array $a, array $b): bool
{
ksort($a);
ksort($b);
return $a === $b;
}
private static function hashIfExists(string $path): ?string
{
if (! is_file($path)) {
return null;
}
$hash = @hash_file('xxh128', $path);
return $hash === false ? null : $hash;
}
private static function readPestVersion(string $projectRoot): string private static function readPestVersion(string $projectRoot): string
{ {
$installed = $projectRoot.'/vendor/composer/installed.json'; $installed = $projectRoot.'/vendor/composer/installed.json';

View File

@ -223,7 +223,7 @@ final class Graph
} }
/** /**
* @param array<string, int|string|null> $fingerprint * @param array<string, mixed> $fingerprint
*/ */
public function setFingerprint(array $fingerprint): void public function setFingerprint(array $fingerprint): void
{ {
@ -231,7 +231,7 @@ final class Graph
} }
/** /**
* @return array<string, int|string|null> * @return array<string, mixed>
*/ */
public function fingerprint(): array public function fingerprint(): array
{ {
@ -323,6 +323,20 @@ final class Graph
$this->baselines[$branch]['tree'] = $tree; $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> * @return array<string, string>
*/ */