packages/deriver/tests/Unit/Deriver/Evaluator/Execution/BatchObservationsTest.php
1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Evaluator\Execution;
6
7use Deriver\Deriver\Contributions;
8use Deriver\Deriver\DeriverConfig;
9use Deriver\Deriver\Evaluator\Call\Evaluators;
10use Deriver\Deriver\Evaluator\Call\Registrations;
11use Deriver\Deriver\Evaluator\EvaluatorConfig;
12use Deriver\Deriver\Evaluator\Evidence\Frontier;
13use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
14use Deriver\Deriver\Evaluator\Execution\Trace\Explanation;
15use Deriver\Deriver\Evaluator\Request\Budget;
16use Deriver\Deriver\Evaluator\Request\EntryPoint;
17use Deriver\Deriver\Evaluator\Request\QueryScope;
18use Deriver\Deriver\Evaluator\Request\ReturnQuery;
19use Deriver\Deriver\Evaluator\Request\StateQuery;
20use Deriver\Deriver\Evaluator\Request\TupleQuery;
21use Deriver\Deriver\Evaluator\Request\ValueQuery;
22use Deriver\Deriver\Evaluator\TargetProfile;
23use Deriver\Deriver\Evaluator\Term;
24use Deriver\Deriver\Execution\ExecutionResultSet;
25use Deriver\Deriver\Execution\QueryExecution;
26use Deriver\Deriver\Lowerer\Declaration\Index;
27use Deriver\Deriver\MicroEvaluatorConversion;
28use Deriver\Deriver\Parser\Node\File;
29use Deriver\Deriver\Parser\Parser;
30use Deriver\Deriver\Parser\ParserConfig;
31use Deriver\Deriver\Providers\ProviderExpansion;
32use Deriver\Deriver\Resolver\Resolver;
33use Deriver\Deriver\Selection\CallObservations;
34use Deriver\Deriver\SnapshotIdentity;
35use Deriver\Deriver\Sources\Path;
36use Deriver\Deriver\Sources\Source;
37use Deriver\Deriver\Sources\Sources;
38use Deriver\Exception\InvalidInputException;
39use PHPUnit\Framework\Attributes\CoversNothing;
40use PHPUnit\Framework\Attributes\DataProvider;
41use PHPUnit\Framework\Attributes\Medium;
42use PHPUnit\Framework\TestCase;
43
44#[CoversNothing]
45#[Medium]
46final class BatchObservationsTest extends TestCase
47{
48 #[DataProvider('providerObservationIndices')]
49 public function testInstructionSharesExecutionPrefixesAndKeepsSeparateValues(int $index): void
50 {
51 $source = '<?php function sink($x){} function target(){$n=0;' . str_repeat('$n+=1;', 100) . 'sink($n);$n++;sink($n);$n++;sink($n);}';
52 $input = new Sources([new Source('fixture.php', $source)]);
53 $configuration = new DeriverConfig();
54 $contributions = new Contributions();
55 $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
56 $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
57 $contributions1 = $providers->contributions;
58 $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);
59 $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
60 $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
61 $snapshotId = $identity->id;
62 $input1 = $providers->input;
63 $parser = new Parser(new ParserConfig($target->version));
64 $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));
65 $program = new Index($snapshotId, $trees);
66 $session = new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics())));
67 $queries = array_map(static fn ($site) => new ValueQuery($site->argument(0)), (new CallObservations($session->program, $session->evaluators))->find('sink'));
68 $independent = (new ExecutionResultSet(array_map($session->derive(...), $queries)))->results;
69 $batch = $session->together($queries)->results;
70 self::assertCount(3, $batch);
71 $result = $batch[$index];
72 self::assertNotNull($result->definite());
73 self::assertSame(100 + $index, $result->definite()->values['value']->native());
74 self::assertSame($independent[$index]->normalOutcomes[0]->values['value']->native(), $result->normalOutcomes[0]->values['value']->native());
75 self::assertNotSame($independent[$index]->reference->id, $result->reference->id);
76 self::assertSame($result->evidence, (new Explanation($result->evidence, $result->frontiers, $result->assumptions))->nodes);
77 self::assertLessThan(array_sum(array_map(static fn ($result) => $result->statistics->transfers, $independent)) / 2, $batch[0]->statistics->transfers);
78 self::assertSame($batch[0]->statistics->transfers, $batch[2]->statistics->transfers);
79 $repeated = $session->derive($queries[0]);
80 self::assertNotSame($independent[0], $repeated);
81 self::assertEquals($independent[0]->normalOutcomes, $repeated->normalOutcomes);
82 }
83 public function testBatchPreservesTupleCorrelationStateAndReturn(): void
84 {
85 $input = new Sources([new Source('fixture.php', '<?php function sink($a,$b){} function target(bool $flag){$a=$flag?1:2;$b=$a+10;sink($a,$b);return $a;}')]);
86 $configuration = new DeriverConfig();
87 $contributions = new Contributions();
88 $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
89 $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
90 $contributions1 = $providers->contributions;
91 $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);
92 $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
93 $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
94 $snapshotId = $identity->id;
95 $input1 = $providers->input;
96 $parser = new Parser(new ParserConfig($target->version));
97 $trees = array_map(static fn (Source $source): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source->path), $source->contents, $source->declarationsOnly))), iterator_to_array($input1, false));
98 $program = new Index($snapshotId, $trees);
99 $session = new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics())));
100 $site = (new CallObservations($session->program, $session->evaluators))->find('sink')[0];
101 $results = $session->together([new TupleQuery($site->beforeInvocation(), ['a' => $site->argument(0), 'b' => $site->argument(1)]), new StateQuery($site->beforeInvocation(), 'a'), new ReturnQuery('target')])->results;
102 $pairs = array_map(static fn ($outcome) => [$outcome->values['a']->native(), $outcome->values['b']->native()], $results[0]->normalOutcomes);
103 sort($pairs);
104 self::assertSame([[1, 11], [2, 12]], $pairs);
105 self::assertCount(2, $results[1]->normalOutcomes);
106 self::assertCount(2, $results[2]->normalOutcomes);
107 self::assertSame([], $results[0]->frontiers);
108 }
109 /**
110 * @param string $body Body under symbolic inputs
111 */
112 #[DataProvider('providerControlFlow')]
113 public function testCompletionAgreesWithIndependentControlFlow(string $body, int $index): void
114 {
115 $input = new Sources([new Source('fixture.php', '<?php function sink($x){} function target(bool $flag){' . $body . '}')]);
116 $configuration = new DeriverConfig();
117 $contributions = new Contributions();
118 $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
119 $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
120 $contributions1 = $providers->contributions;
121 $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);
122 $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
123 $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
124 $snapshotId = $identity->id;
125 $input1 = $providers->input;
126 $parser = new Parser(new ParserConfig($target->version));
127 $trees = array_map(static fn (Source $source): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source->path), $source->contents, $source->declarationsOnly))), iterator_to_array($input1, false));
128 $program = new Index($snapshotId, $trees);
129 $session = new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics())));
130 $queries = array_map(static fn ($site) => new ValueQuery($site->argument(0)), (new CallObservations($session->program, $session->evaluators))->find('sink'));
131 $independent = (new ExecutionResultSet(array_map($session->derive(...), $queries)))->results;
132 $batch = $session->together($queries)->results;
133 $result = $batch[$index];
134 $expected = array_map(static fn ($outcome) => $outcome->values['value']->native(), $independent[$index]->normalOutcomes);
135 $actual = array_map(static fn ($outcome) => $outcome->values['value']->native(), $result->normalOutcomes);
136 sort($expected);
137 sort($actual);
138 self::assertSame($expected, $actual);
139 self::assertSame(count($independent[$index]->exceptionalOutcomes), count($result->exceptionalOutcomes));
140 self::assertSame($independent[$index]->reachability, $result->reachability);
141 }
142 /**
143 * @return iterable<string, array{string, int}>
144 */
145 public static function providerControlFlow(): iterable
146 {
147 $cases = ['branch' => ['if($flag){sink(1);}else{sink(2);}sink(3);', 3], 'throw after first' => ['sink(1);throw new Exception;sink(2);', 2], 'branch exception' => ['if($flag){sink(1);}throw new Exception;sink(2);', 2], 'loop' => ['for($i=0;$i<3;$i++){sink($i);}sink(9);', 2], 'finally' => ['try{sink(1);if($flag){throw new Exception;}}finally{sink(2);}sink(3);', 3], 'unreachable' => ['return;sink(1);sink(2);', 2]];
148 foreach ($cases as $name => [$body, $count]) {
149 for ($i = 0; $i < $count; $i++) {
150 yield $name . ':' . $i => [$body, $i];
151 }
152 }
153 }
154 /**
155 * @return list<array{int}>
156 */
157 public static function providerObservationIndices(): array
158 {
159 return [[0], [1], [2]];
160 }
161 #[DataProvider('providerInterruptedIndices')]
162 public function testSynchronizeKeepsSharedInterruptionAndRecoveredTypes(int $index): void
163 {
164 $input = new Sources([new Source('fixture.php', '<?php function target(PDO $pdo){heavy();$pdo->query("SELECT 1");$pdo->query("SELECT 2");}')]);
165 $configuration = new DeriverConfig();
166 $contributions = new Contributions();
167 $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
168 $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
169 $contributions1 = $providers->contributions;
170 $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);
171 $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
172 $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
173 $snapshotId = $identity->id;
174 $input1 = $providers->input;
175 $parser = new Parser(new ParserConfig($target->version));
176 $trees = array_map(static fn (Source $source): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source->path), $source->contents, $source->declarationsOnly))), iterator_to_array($input1, false));
177 $program = new Index($snapshotId, $trees);
178 $session = new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics())));
179 $queries = array_map(static function ($site): TupleQuery {
180 self::assertNotNull($site->receiver);
181 return new TupleQuery($site->beforeInvocation(), ['sql' => $site->argument(0), 'receiver' => $site->receiver], budget: new Budget(transfers: 1));
182 }, (new CallObservations($session->program, $session->evaluators))->find('query'));
183 $result = $session->together($queries)->results[$index];
184 self::assertSame('SELECT ' . ($index + 1), $result->normalOutcomes[0]->values['sql']->native());
185 self::assertSame('PDO', $result->normalOutcomes[0]->values['receiver']->attributes['type']);
186 self::assertContains('BUDGET_EXCEEDED', array_column($result->frontiers, 'code'));
187 self::assertNull($result->definite());
188 }
189 /**
190 * @return list<array{int}>
191 */
192 public static function providerInterruptedIndices(): array
193 {
194 return [[0], [1]];
195 }
196 /**
197 * @param ReturnQuery $other Incompatible query
198 */
199 #[DataProvider('providerMismatches')]
200 public function testMismatchedExecutionContractsAreRejected(ReturnQuery $other): void
201 {
202 $input = new Sources([new Source('fixture.php', '<?php function first(){return 1;}function second(){return 2;}')]);
203 $configuration = new DeriverConfig();
204 $contributions = new Contributions();
205 $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
206 $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
207 $contributions1 = $providers->contributions;
208 $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);
209 $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
210 $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
211 $snapshotId = $identity->id;
212 $input1 = $providers->input;
213 $parser = new Parser(new ParserConfig($target->version));
214 $trees = array_map(static fn (Source $source): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source->path), $source->contents, $source->declarationsOnly))), iterator_to_array($input1, false));
215 $program = new Index($snapshotId, $trees);
216 $session = new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics())));
217 $this->expectException(InvalidInputException::class);
218 $session->together([new ReturnQuery('first'), $other]);
219 }
220 /**
221 * @return list<array{ReturnQuery}>
222 */
223 public static function providerMismatches(): array
224 {
225 return [[new ReturnQuery('second')], [new ReturnQuery('first', QueryScope::fromEntrypoints([new EntryPoint('first')]))], [new ReturnQuery('first', budget: new Budget(transfers: 1))]];
226 }
227 public function testEmptyAndDuplicateBatchesKeepRequestedOrdering(): void
228 {
229 $input = new Sources([new Source('fixture.php', '<?php function target(){return 3;}')]);
230 $configuration = new DeriverConfig();
231 $contributions = new Contributions();
232 $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
233 $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
234 $contributions1 = $providers->contributions;
235 $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);
236 $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
237 $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
238 $snapshotId = $identity->id;
239 $input1 = $providers->input;
240 $parser = new Parser(new ParserConfig($target->version));
241 $trees = array_map(static fn (Source $source): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source->path), $source->contents, $source->declarationsOnly))), iterator_to_array($input1, false));
242 $program = new Index($snapshotId, $trees);
243 $session = new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics())));
244 self::assertSame([], $session->together([])->results);
245 $result = $session->together([new ReturnQuery('target'), new ReturnQuery('target')])->results;
246 self::assertCount(2, $result);
247 self::assertEquals($result[0]->normalOutcomes, $result[1]->normalOutcomes);
248 self::assertSame(3, $result[0]->normalOutcomes[0]->values['return']->native());
249 }
250}
251