packages/deriver/tests/Unit/Deriver/Selection/QueryValidationTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Selection;
6
7use Deriver\Deriver\Contributions;
8use Deriver\Deriver\DeriverConfig;
9use Deriver\Deriver\Evaluator\Call\BoundInstruction;
10use Deriver\Deriver\Evaluator\Call\Evaluators;
11use Deriver\Deriver\Evaluator\Call\Extensions;
12use Deriver\Deriver\Evaluator\Call\Registrations;
13use Deriver\Deriver\Evaluator\Call\StateRegistry;
14use Deriver\Deriver\Evaluator\EvaluatorConfig;
15use Deriver\Deriver\Evaluator\Evidence\Frontier;
16use Deriver\Deriver\Evaluator\Execution\Context;
17use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
18use Deriver\Deriver\Evaluator\Projection;
19use Deriver\Deriver\Evaluator\Request\Budget;
20use Deriver\Deriver\Evaluator\Request\Query;
21use Deriver\Deriver\Evaluator\Request\QueryScope;
22use Deriver\Deriver\Evaluator\Request\ReturnQuery;
23use Deriver\Deriver\Evaluator\Request\StateQuery;
24use Deriver\Deriver\Evaluator\Request\TupleQuery;
25use Deriver\Deriver\Evaluator\Request\ValueQuery;
26use Deriver\Deriver\Evaluator\TargetProfile;
27use Deriver\Deriver\Evaluator\Term;
28use Deriver\Deriver\Execution\QueryExecution;
29use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
30use Deriver\Deriver\Lowerer\Declaration\CallableSource;
31use Deriver\Deriver\Lowerer\Declaration\Index;
32use Deriver\Deriver\Lowerer\Declaration\Indexer;
33use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
34use Deriver\Deriver\Lowerer\ExpressionLowering;
35use Deriver\Deriver\Lowerer\Graph\BasicBlock;
36use Deriver\Deriver\Lowerer\Graph\CallableGraph;
37use Deriver\Deriver\Lowerer\Graph\ExpressionRef;
38use Deriver\Deriver\Lowerer\Graph\Instruction;
39use Deriver\Deriver\Lowerer\Graph\ObservationPhase;
40use Deriver\Deriver\Lowerer\Graph\PointRef;
41use Deriver\Deriver\Lowerer\Graph\Program;
42use Deriver\Deriver\Lowerer\Graph\Terminator;
43use Deriver\Deriver\Lowerer\Graph\TerminatorKind;
44use Deriver\Deriver\Lowerer\InstructionEmitter;
45use Deriver\Deriver\Lowerer\Lowerer;
46use Deriver\Deriver\Lowerer\LoweringScope;
47use Deriver\Deriver\Lowerer\StatementLowering;
48use Deriver\Deriver\MicroEvaluatorConversion;
49use Deriver\Deriver\Parser\Node\File;
50use Deriver\Deriver\Parser\Parser;
51use Deriver\Deriver\Parser\ParserConfig;
52use Deriver\Deriver\Parser\TargetSyntax;
53use Deriver\Deriver\Providers\ProviderExpansion;
54use Deriver\Deriver\Resolver\AssignmentPatterns;
55use Deriver\Deriver\Resolver\ClassScope;
56use Deriver\Deriver\Resolver\ExpressionValidation;
57use Deriver\Deriver\Resolver\MagicContext;
58use Deriver\Deriver\Resolver\Resolver;
59use Deriver\Deriver\Selection\QueryValidation;
60use Deriver\Deriver\SnapshotIdentity;
61use Deriver\Deriver\Sources\LineMap;
62use Deriver\Deriver\Sources\Path;
63use Deriver\Deriver\Sources\Source;
64use Deriver\Deriver\Sources\SourceRef;
65use Deriver\Deriver\Sources\Sources;
66use Deriver\Exception\InvalidInputException;
67use Deriver\Exception\ParserException;
68use Deriver\Exception\ResolutionException;
69use PHPUnit\Framework\Attributes\CoversClass;
70use PHPUnit\Framework\Attributes\DataProvider;
71use PHPUnit\Framework\Attributes\Small;
72use PHPUnit\Framework\Attributes\UsesClass;
73use PHPUnit\Framework\TestCase;
74
75/**
76 * @covers \Deriver\Deriver\Selection\QueryValidation
77 */
78#[UsesClass(Resolver::class)]
79#[UsesClass(ExpressionValidation::class)]
80#[UsesClass(ResolutionException::class)]
81#[UsesClass(ParserConfig::class)]
82#[UsesClass(ParserException::class)]
83#[CoversClass(QueryValidation::class)]
84#[UsesClass(BasicBlock::class)]
85#[UsesClass(CallableGraph::class)]
86#[UsesClass(CallableIdentity::class)]
87#[UsesClass(Instruction::class)]
88#[UsesClass(Terminator::class)]
89#[UsesClass(Context::class)]
90#[UsesClass(Extensions::class)]
91#[UsesClass(Evaluators::class)]
92#[UsesClass(StateRegistry::class)]
93#[UsesClass(DeriverConfig::class)]
94#[UsesClass(Sources::class)]
95#[UsesClass(Path::class)]
96#[UsesClass(Source::class)]
97#[UsesClass(TargetProfile::class)]
98#[UsesClass(Budget::class)]
99#[UsesClass(QueryScope::class)]
100#[UsesClass(ReturnQuery::class)]
101#[UsesClass(TupleQuery::class)]
102#[UsesClass(ValueQuery::class)]
103#[UsesClass(ExpressionRef::class)]
104#[UsesClass(PointRef::class)]
105#[UsesClass(SourceRef::class)]
106#[UsesClass(Parser::class)]
107#[UsesClass(File::class)]
108#[UsesClass(Lowerer::class)]
109#[UsesClass(ExpressionLowering::class)]
110#[UsesClass(InstructionEmitter::class)]
111#[UsesClass(LoweringScope::class)]
112#[UsesClass(StatementLowering::class)]
113#[UsesClass(CallableSource::class)]
114#[UsesClass(Indexer::class)]
115#[UsesClass(Index::class)]
116#[UsesClass(Composition::class)]
117#[UsesClass(LineMap::class)]
118#[UsesClass(MagicContext::class)]
119#[UsesClass(AssignmentPatterns::class)]
120#[UsesClass(ClassScope::class)]
121#[UsesClass(TargetSyntax::class)]
122#[UsesClass(Projection::class)]
123#[UsesClass(Term::class)]
124#[Small]
125final class QueryValidationTest extends TestCase
126{
127    public function testOwnerRejectsAnEmptyReturnSymbol(): void
128    {
129        $this->expectException(InvalidInputException::class);
130        $source = '<?php function target(){return 1;}';
131        $budget = new Budget();
132        $configuration = new DeriverConfig();
133        $contributions = new Contributions();
134        $input = new Sources([new Source('fixture.php', $source)]);
135        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
136        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
137        $contributions1 = $providers->contributions;
138        $evaluators = new Evaluators(new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision), new Registrations($contributions1->evaluators, $contributions1->providers, $contributions1->domains, $contributions1->intrinsics, $contributions1->stateSlots), $configuration->standardEvaluators);
139        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
140        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
141        $snapshotId = $identity->id;
142        $input1 = $providers->input;
143        $parser = new Parser(new ParserConfig($target->version));
144        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
145        $program1 = new Index($snapshotId, $trees);
146        $execution = new QueryExecution($program1, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program1->diagnostics())));
147        $snapshotId1 = 'test';
148        $input2 = new Sources([new Source('fixture.php', $source)]);
149        $profile = $execution->configuration->target;
150        $parser1 = new Parser(new ParserConfig($profile->version));
151        $trees1 = array_map(static fn (Source $source2): File => (new Resolver())->resolve($parser1->parse(new Source(Path::normalize($source2->path), $source2->contents, $source2->declarationsOnly))), iterator_to_array($input2, false));
152        $program = new Index($snapshotId1, $trees1);
153        (new QueryValidation((new Context($program, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators))->program, 'test'))->owner(new ReturnQuery(''));
154    }
155    public function testReferenceRejectsForeignSnapshots(): void
156    {
157        $reference = new ExpressionRef(new SourceRef('foreign', 'fixture.php', 0, 1), 'target', 'r0');
158        $this->expectException(InvalidInputException::class);
159        $source = '<?php function target(){return 1;}';
160        $budget = new Budget();
161        $configuration = new DeriverConfig();
162        $contributions = new Contributions();
163        $input = new Sources([new Source('fixture.php', $source)]);
164        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
165        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
166        $contributions1 = $providers->contributions;
167        $evaluators = new Evaluators(new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision), new Registrations($contributions1->evaluators, $contributions1->providers, $contributions1->domains, $contributions1->intrinsics, $contributions1->stateSlots), $configuration->standardEvaluators);
168        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
169        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
170        $snapshotId = $identity->id;
171        $input1 = $providers->input;
172        $parser = new Parser(new ParserConfig($target->version));
173        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
174        $program1 = new Index($snapshotId, $trees);
175        $execution = new QueryExecution($program1, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program1->diagnostics())));
176        $snapshotId1 = 'test';
177        $input2 = new Sources([new Source('fixture.php', $source)]);
178        $profile = $execution->configuration->target;
179        $parser1 = new Parser(new ParserConfig($profile->version));
180        $trees1 = array_map(static fn (Source $source2): File => (new Resolver())->resolve($parser1->parse(new Source(Path::normalize($source2->path), $source2->contents, $source2->declarationsOnly))), iterator_to_array($input2, false));
181        $program = new Index($snapshotId1, $trees1);
182        (new QueryValidation((new Context($program, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators))->program, 'test'))->reference($reference);
183    }
184    public function testReferenceAcceptsAnActualCapturedInstruction(): void
185    {
186        $source = '<?php function target(){return 1;}';
187        $budget = new Budget();
188        $configuration = new DeriverConfig();
189        $contributions = new Contributions();
190        $input = new Sources([new Source('fixture.php', $source)]);
191        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
192        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
193        $contributions1 = $providers->contributions;
194        $evaluators = new Evaluators(new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision), new Registrations($contributions1->evaluators, $contributions1->providers, $contributions1->domains, $contributions1->intrinsics, $contributions1->stateSlots), $configuration->standardEvaluators);
195        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
196        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
197        $snapshotId = $identity->id;
198        $input1 = $providers->input;
199        $parser = new Parser(new ParserConfig($target->version));
200        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
201        $program2 = new Index($snapshotId, $trees);
202        $execution = new QueryExecution($program2, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program2->diagnostics())));
203        $snapshotId1 = 'test';
204        $input2 = new Sources([new Source('fixture.php', $source)]);
205        $profile = $execution->configuration->target;
206        $parser1 = new Parser(new ParserConfig($profile->version));
207        $trees1 = array_map(static fn (Source $source2): File => (new Resolver())->resolve($parser1->parse(new Source(Path::normalize($source2->path), $source2->contents, $source2->declarationsOnly))), iterator_to_array($input2, false));
208        $program1 = new Index($snapshotId1, $trees1);
209        $program = (new Context($program1, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators))->program;
210        $body = $program->callable('target');
211        self::assertNotNull($body);
212        $instruction = $body->blocks[0]->instructions[0];
213        $reference = new ExpressionRef($instruction->source, 'target', $instruction->result);
214        $validation = new QueryValidation($program, 'test');
215        $validation->reference($reference);
216        self::assertSame('target', $validation->owner(new ValueQuery($reference)));
217    }
218    #[DataProvider('providerInvalidReferences')]
219    public function testReferenceRejectsEveryMismatchedIdentityComponent(ExpressionRef|PointRef $reference): void
220    {
221        $source = new SourceRef('snapshot', 'fixture.php', 10, 20);
222        $body = new CallableGraph('target', [], [new BasicBlock(0, [new BoundInstruction('instruction', 'constant', $source, 'register')], new Terminator(TerminatorKind::Return))], $source);
223        $program = self::createStub(Program::class);
224        $program->method('callable')->willReturn($body);
225        $this->expectException(InvalidInputException::class);
226        (new QueryValidation($program, 'snapshot'))->reference($reference);
227    }
228    /**
229     * @return array<string,array{ExpressionRef|PointRef}>
230     */
231    public static function providerInvalidReferences(): array
232    {
233        return ['expression path' => [new ExpressionRef(new SourceRef('snapshot', 'other.php', 10, 20), 'target', 'register')], 'expression start' => [new ExpressionRef(new SourceRef('snapshot', 'fixture.php', 9, 20), 'target', 'register')], 'expression end' => [new ExpressionRef(new SourceRef('snapshot', 'fixture.php', 10, 21), 'target', 'register')], 'expression register' => [new ExpressionRef(new SourceRef('snapshot', 'fixture.php', 10, 20), 'target', 'other')], 'point path' => [new PointRef(new SourceRef('snapshot', 'other.php', 10, 20), 'target', 'instruction', ObservationPhase::After)], 'point start' => [new PointRef(new SourceRef('snapshot', 'fixture.php', 9, 20), 'target', 'instruction', ObservationPhase::Before)], 'point end' => [new PointRef(new SourceRef('snapshot', 'fixture.php', 10, 21), 'target', 'instruction', ObservationPhase::Invocation)], 'point instruction' => [new PointRef(new SourceRef('snapshot', 'fixture.php', 10, 20), 'target', 'register', ObservationPhase::After)], 'point snapshot' => [new PointRef(new SourceRef('foreign', 'fixture.php', 10, 20), 'target', 'instruction', ObservationPhase::After)]];
234    }
235    #[DataProvider('providerValidQueries')]
236    public function testOwnerResolvesEachSupportedObservationForm(Query $query): void
237    {
238        $source = new SourceRef('snapshot', 'fixture.php', 10, 20);
239        $body = new CallableGraph('target', [], [new BasicBlock(0, [new BoundInstruction('instruction', 'constant', $source, 'register')], new Terminator(TerminatorKind::Return))], $source);
240        $program = self::createStub(Program::class);
241        $program->method('callable')->willReturn($body);
242        self::assertSame('target', (new QueryValidation($program, 'snapshot'))->owner($query));
243    }
244    /**
245     * @return array<string,array{Query}>
246     */
247    public static function providerValidQueries(): array
248    {
249        $source = new SourceRef('snapshot', 'fixture.php', 10, 20);
250        $expression = new ExpressionRef($source, 'target', 'register');
251        return ['return' => [new ReturnQuery('target')], 'value' => [new ValueQuery($expression)], 'state before' => [new StateQuery(new PointRef($source, 'target', 'instruction', ObservationPhase::Before), 'value')], 'state after' => [new StateQuery(new PointRef($source, 'target', 'instruction', ObservationPhase::After), 'value')], 'state invocation' => [new StateQuery(new PointRef($source, 'target', 'instruction', ObservationPhase::Invocation), 'value')], 'tuple' => [new TupleQuery(new PointRef($source, 'target', 'instruction', ObservationPhase::After), ['value' => $expression])]];
252    }
253    public function testOwnerRejectsUnknownQueryImplementations(): void
254    {
255        $program = self::createStub(Program::class);
256        $this->expectException(InvalidInputException::class);
257        $this->expectExceptionMessage('Unsupported query implementation.');
258        (new QueryValidation($program, 'snapshot'))->owner(self::createStub(Query::class));
259    }
260    public function testReferenceRejectsMissingCallableBodies(): void
261    {
262        $program = self::createStub(Program::class);
263        $program->method('callable')->willReturn(null);
264        $this->expectException(InvalidInputException::class);
265        (new QueryValidation($program, 'snapshot'))->reference(new ExpressionRef(new SourceRef('snapshot', 'fixture.php', 10, 20), 'missing', 'register'));
266    }
267    public function testOwnerRejectsAnEmptyTupleAtAnOtherwiseValidPoint(): void
268    {
269        $source = new SourceRef('snapshot', 'fixture.php', 10, 20);
270        $body = new CallableGraph('target', [], [new BasicBlock(0, [new BoundInstruction('instruction', 'constant', $source, 'register')], new Terminator(TerminatorKind::Return))], $source);
271        $program = self::createStub(Program::class);
272        $program->method('callable')->willReturn($body);
273        $this->expectException(InvalidInputException::class);
274        $this->expectExceptionMessage('Tuple queries require at least one expression.');
275        (new QueryValidation($program, 'snapshot'))->owner(new TupleQuery(new PointRef($source, 'target', 'instruction', ObservationPhase::After), []));
276    }
277    public function testOwnerCannotCombineExpressionsFromDifferentInvocations(): void
278    {
279        $source = new SourceRef('snapshot', 'fixture.php', 10, 20);
280        $block = new BasicBlock(0, [new BoundInstruction('instruction', 'constant', $source, 'register')], new Terminator(TerminatorKind::Return));
281        $program = self::createStub(Program::class);
282        $program->method('callable')->willReturnMap([['target', new CallableGraph('target', [], [$block], $source)], ['other', new CallableGraph('other', [], [$block], $source)]]);
283        $query = new TupleQuery(new PointRef($source, 'target', 'instruction', ObservationPhase::After), ['foreign' => new ExpressionRef($source, 'other', 'register')]);
284        $this->expectException(InvalidInputException::class);
285        $this->expectExceptionMessage('Tuple expressions must belong to the observation callable.');
286        (new QueryValidation($program, 'snapshot'))->owner($query);
287    }
288    public function testOwnerAllowsEquivalentNamedOwnersWithinACorrelatedTuple(): void
289    {
290        $source = new SourceRef('snapshot', 'fixture.php', 10, 20);
291        $body = new CallableGraph('N\target', [], [new BasicBlock(0, [new BoundInstruction('instruction', 'constant', $source, 'register')], new Terminator(TerminatorKind::Return))], $source);
292        $program = self::createStub(Program::class);
293        $program->method('callable')->willReturn($body);
294        $query = new TupleQuery(new PointRef($source, '\N\TARGET', 'instruction', ObservationPhase::After), ['value' => new ExpressionRef($source, 'n\target', 'register')]);
295        self::assertSame('\N\TARGET', (new QueryValidation($program, 'snapshot'))->owner($query));
296    }
297    public function testOwnerCannotFoldDifferentScriptPathsIntoTheSameTuple(): void
298    {
299        $source = new SourceRef('snapshot', 'fixture.php', 10, 20);
300        $block = new BasicBlock(0, [new BoundInstruction('instruction', 'constant', $source, 'register')], new Terminator(TerminatorKind::Return));
301        $program = self::createStub(Program::class);
302        $program->method('callable')->willReturnMap([['script:A.php', new CallableGraph('script:A.php', [], [$block], $source)], ['script:a.php', new CallableGraph('script:a.php', [], [$block], $source)]]);
303        $query = new TupleQuery(new PointRef($source, 'script:A.php', 'instruction', ObservationPhase::After), ['foreign' => new ExpressionRef($source, 'script:a.php', 'register')]);
304        $this->expectException(InvalidInputException::class);
305        $this->expectExceptionMessage('Tuple expressions must belong to the observation callable.');
306        (new QueryValidation($program, 'snapshot'))->owner($query);
307    }
308}
309