packages/deriver/tests/Unit/Deriver/Lowerer/LoweringScopeTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Lowerer;
6
7use Deriver\Deriver;
8use Deriver\Deriver\Candidate\ResultRef;
9use Deriver\Deriver\Candidate\Snapshot;
10use Deriver\Deriver\Candidate\Statistics;
11use Deriver\Deriver\Contributions;
12use Deriver\Deriver\DeriverConfig;
13use Deriver\Deriver\Evaluator\Call\Evaluators;
14use Deriver\Deriver\Evaluator\Call\Extensions;
15use Deriver\Deriver\Evaluator\Call\Registrations;
16use Deriver\Deriver\Evaluator\Call\StateRegistry;
17use Deriver\Deriver\Evaluator\EvaluatorConfig;
18use Deriver\Deriver\Evaluator\Evidence\Frontier;
19use Deriver\Deriver\Evaluator\Execution\Call\ArgumentBinding;
20use Deriver\Deriver\Evaluator\Execution\Call\ArgumentOrder;
21use Deriver\Deriver\Evaluator\Execution\Call\TypeBinding;
22use Deriver\Deriver\Evaluator\Execution\Call\TypeCheck;
23use Deriver\Deriver\Evaluator\Execution\Completion\Alternative;
24use Deriver\Deriver\Evaluator\Execution\Completion\Assessment;
25use Deriver\Deriver\Evaluator\Execution\Completion\Completion;
26use Deriver\Deriver\Evaluator\Execution\Completion\StorageSnapshot;
27use Deriver\Deriver\Evaluator\Execution\Context;
28use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
29use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
30use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
31use Deriver\Deriver\Evaluator\Execution\Demand\Cell;
32use Deriver\Deriver\Evaluator\Execution\Demand\Components;
33use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
34use Deriver\Deriver\Evaluator\Execution\Demand\Key;
35use Deriver\Deriver\Evaluator\Execution\Demand\Table;
36use Deriver\Deriver\Evaluator\Execution\Dependencies;
37use Deriver\Deriver\Evaluator\Execution\Evaluator;
38use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
39use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
40use Deriver\Deriver\Evaluator\Execution\Memory\Location;
41use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
42use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
43use Deriver\Deriver\Evaluator\Execution\Memory\ReferenceConstraint;
44use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
45use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
46use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
47use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
48use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
49use Deriver\Deriver\Evaluator\Execution\State;
50use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
51use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
52use Deriver\Deriver\Evaluator\Execution\Summary\Invocation;
53use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
54use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
55use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
56use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
57use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
58use Deriver\Deriver\Evaluator\Request\Budget;
59use Deriver\Deriver\Evaluator\Request\EntryPoint;
60use Deriver\Deriver\Evaluator\Request\QueryScope;
61use Deriver\Deriver\Evaluator\Request\ReturnQuery;
62use Deriver\Deriver\Evaluator\Scalar\Identity;
63use Deriver\Deriver\Evaluator\Scalar\Operations;
64use Deriver\Deriver\Evaluator\TargetProfile;
65use Deriver\Deriver\Evaluator\Term;
66use Deriver\Deriver\Execution\DerivationResult;
67use Deriver\Deriver\Execution\QueryExecution;
68use Deriver\Deriver\Execution\ResultAssessment;
69use Deriver\Deriver\Identity\QueryEncoding;
70use Deriver\Deriver\Identity\ValueGraph;
71use Deriver\Deriver\Lowerer\AssignmentLowering;
72use Deriver\Deriver\Lowerer\Control\DestructuringLowering;
73use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
74use Deriver\Deriver\Lowerer\Declaration\CallableSource;
75use Deriver\Deriver\Lowerer\Declaration\Index;
76use Deriver\Deriver\Lowerer\Declaration\Indexer;
77use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
78use Deriver\Deriver\Lowerer\EffectInspection;
79use Deriver\Deriver\Lowerer\ExpressionLowering;
80use Deriver\Deriver\Lowerer\Graph\Argument;
81use Deriver\Deriver\Lowerer\Graph\BasicBlock;
82use Deriver\Deriver\Lowerer\Graph\CallableGraph;
83use Deriver\Deriver\Lowerer\Graph\Instruction;
84use Deriver\Deriver\Lowerer\Graph\Literal;
85use Deriver\Deriver\Lowerer\Graph\Parameter;
86use Deriver\Deriver\Lowerer\Graph\Terminator;
87use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
88use Deriver\Deriver\Lowerer\InstructionEmitter;
89use Deriver\Deriver\Lowerer\Lowerer;
90use Deriver\Deriver\Lowerer\LoweringScope;
91use Deriver\Deriver\Lowerer\StatementLowering;
92use Deriver\Deriver\MicroEvaluatorConversion;
93use Deriver\Deriver\Parser\Node\File;
94use Deriver\Deriver\Parser\Parser;
95use Deriver\Deriver\Parser\ParserConfig;
96use Deriver\Deriver\Parser\TargetSyntax;
97use Deriver\Deriver\Providers\ProviderExpansion;
98use Deriver\Deriver\Resolver\AssignmentPatterns;
99use Deriver\Deriver\Resolver\ClassScope;
100use Deriver\Deriver\Resolver\ExpressionValidation;
101use Deriver\Deriver\Resolver\MagicContext;
102use Deriver\Deriver\Resolver\Resolver;
103use Deriver\Deriver\Selection\QueryValidation;
104use Deriver\Deriver\SnapshotIdentity;
105use Deriver\Deriver\Sources\LineMap;
106use Deriver\Deriver\Sources\Path;
107use Deriver\Deriver\Sources\Source;
108use Deriver\Deriver\Sources\SourceRef;
109use Deriver\Deriver\Sources\Sources;
110use Deriver\Exception\ParserException;
111use Deriver\Exception\ResolutionException;
112use PhpParser\Node\Arg;
113use PhpParser\Node\Expr\Variable;
114use PhpParser\Node\Identifier;
115use PhpParser\Node\Name;
116use PhpParser\Node\Scalar\Int_;
117use PhpParser\Node\Stmt\Return_;
118use PHPUnit\Framework\Attributes\CoversClass;
119use PHPUnit\Framework\Attributes\DataProvider;
120use PHPUnit\Framework\Attributes\Small;
121use PHPUnit\Framework\Attributes\UsesClass;
122use PHPUnit\Framework\TestCase;
123
124#[UsesClass(Resolver::class)]
125#[UsesClass(ExpressionValidation::class)]
126#[UsesClass(ResolutionException::class)]
127#[UsesClass(ParserConfig::class)]
128#[UsesClass(ParserException::class)]
129#[CoversClass(LoweringScope::class)]
130#[UsesClass(QueryExecution::class)]
131#[UsesClass(QueryValidation::class)]
132#[UsesClass(ResultAssessment::class)]
133#[UsesClass(Deriver::class)]
134#[UsesClass(Argument::class)]
135#[UsesClass(BasicBlock::class)]
136#[UsesClass(CallableGraph::class)]
137#[UsesClass(CallableIdentity::class)]
138#[UsesClass(Instruction::class)]
139#[UsesClass(Parameter::class)]
140#[UsesClass(Terminator::class)]
141#[UsesClass(ArgumentBinding::class)]
142#[UsesClass(ArgumentOrder::class)]
143#[UsesClass(Dispatch::class)]
144#[UsesClass(TypeBinding::class)]
145#[UsesClass(TypeCheck::class)]
146#[UsesClass(Completion::class)]
147#[UsesClass(Context::class)]
148#[UsesClass(ObservationLimit::class)]
149#[UsesClass(StateJoin::class)]
150#[UsesClass(Unwinding::class)]
151#[UsesClass(Cell::class)]
152#[UsesClass(Components::class)]
153#[UsesClass(Discovery::class)]
154#[UsesClass(Key::class)]
155#[UsesClass(Table::class)]
156#[UsesClass(Dependencies::class)]
157#[UsesClass(InstructionTransfer::class)]
158#[UsesClass(Evaluator::class)]
159#[UsesClass(SlotReference::class)]
160#[UsesClass(ObservationCollector::class)]
161#[UsesClass(Conversions::class)]
162#[UsesClass(ScalarErrors::class)]
163#[UsesClass(State::class)]
164#[UsesClass(CompletionRecord::class)]
165#[UsesClass(Evaluation::class)]
166#[UsesClass(Invocation::class)]
167#[UsesClass(Isolation::class)]
168#[UsesClass(MemoryStep::class)]
169#[UsesClass(PureStep::class)]
170#[UsesClass(ReferenceAssignment::class)]
171#[UsesClass(Location::class)]
172#[UsesClass(Materialization::class)]
173#[UsesClass(Memory::class)]
174#[UsesClass(ReferenceConstraint::class)]
175#[UsesClass(StorageCapture::class)]
176#[UsesClass(Extensions::class)]
177#[UsesClass(ProviderExpansion::class)]
178#[UsesClass(Evaluators::class)]
179#[UsesClass(StateRegistry::class)]
180#[UsesClass(DeriverConfig::class)]
181#[UsesClass(EntryPoint::class)]
182#[UsesClass(Sources::class)]
183#[UsesClass(Path::class)]
184#[UsesClass(Snapshot::class)]
185#[UsesClass(Source::class)]
186#[UsesClass(TargetProfile::class)]
187#[UsesClass(Budget::class)]
188#[UsesClass(QueryScope::class)]
189#[UsesClass(ReturnQuery::class)]
190#[UsesClass(ResultRef::class)]
191#[UsesClass(SourceRef::class)]
192#[UsesClass(Alternative::class)]
193#[UsesClass(Assessment::class)]
194#[UsesClass(Derivation::class)]
195#[UsesClass(DerivationResult::class)]
196#[UsesClass(QueryEncoding::class)]
197#[UsesClass(ValueGraph::class)]
198#[UsesClass(Statistics::class)]
199#[UsesClass(StorageSnapshot::class)]
200#[UsesClass(Parser::class)]
201#[UsesClass(File::class)]
202#[UsesClass(AssignmentLowering::class)]
203#[UsesClass(Lowerer::class)]
204#[UsesClass(DestructuringLowering::class)]
205#[UsesClass(EffectInspection::class)]
206#[UsesClass(ExpressionLowering::class)]
207#[UsesClass(InstructionEmitter::class)]
208#[UsesClass(StatementLowering::class)]
209#[UsesClass(CallableSource::class)]
210#[UsesClass(Indexer::class)]
211#[UsesClass(Index::class)]
212#[UsesClass(Composition::class)]
213#[UsesClass(LineMap::class)]
214#[UsesClass(MagicContext::class)]
215#[UsesClass(AssignmentPatterns::class)]
216#[UsesClass(ClassScope::class)]
217#[UsesClass(TargetSyntax::class)]
218#[UsesClass(Identity::class)]
219#[UsesClass(Operations::class)]
220#[UsesClass(Literal::class)]
221#[Small]
222final class LoweringScopeTest extends TestCase
223{
224    public function testExpressionPreservesTheSemanticContract(): void
225    {
226        $source = '<?php function target() { $x="before"; $x="after"; return $x . ":done"; }';
227        $symbol = 'target';
228        $input = new Sources([new Source('fixture.php', $source)]);
229        $configuration = new DeriverConfig();
230        $contributions = new Contributions();
231        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
232        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
233        $contributions1 = $providers->contributions;
234        $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);
235        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
236        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
237        $snapshotId = $identity->id;
238        $input1 = $providers->input;
239        $parser = new Parser(new ParserConfig($target->version));
240        $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));
241        $program = new Index($snapshotId, $trees);
242        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
243        self::assertSame('after:done', $result->normalOutcomes[0]->values['return']->native());
244        self::assertSame([], $result->frontiers);
245        self::assertSame([], $result->exceptionalOutcomes);
246    }
247    public function testStatementsStartsASeparateBlockAfterReturn(): void
248    {
249        $source = '<?php function target(){return 1;}';
250        $snapshotId = 'test';
251        $input = new Sources([new Source('fixture.php', $source)]);
252        $profile = new TargetProfile();
253        $parser = new Parser(new ParserConfig($profile->version));
254        $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($input, false));
255        $index = new Index($snapshotId, $trees);
256        $lowering = new LoweringScope($index->builder('fixture.php'), $index, 'target');
257        $lowering->statements([new Return_(new Int_(1)), new Return_(new Int_(2))]);
258        self::assertCount(2, $lowering->graph->finish());
259        self::assertSame(1, $lowering->graph->finish()[0]->instructions[0]->constant?->native());
260        self::assertSame(2, $lowering->graph->finish()[1]->instructions[0]->constant?->native());
261    }
262    public function testLocationDoesNotReadTheVariable(): void
263    {
264        $source = '<?php function target(){return 1;}';
265        $snapshotId = 'test';
266        $input = new Sources([new Source('fixture.php', $source)]);
267        $profile = new TargetProfile();
268        $parser = new Parser(new ParserConfig($profile->version));
269        $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($input, false));
270        $index = new Index($snapshotId, $trees);
271        $lowering = new LoweringScope($index->builder('fixture.php'), $index, 'target');
272        $lowering->location(new Variable('x'));
273        self::assertSame(['local'], array_column($lowering->graph->instructions[0], 'operation'));
274    }
275    public function testNameUsesTheResolvedNamespace(): void
276    {
277        $source = '<?php function target(){return 1;}';
278        $snapshotId = 'test';
279        $input = new Sources([new Source('fixture.php', $source)]);
280        $profile = new TargetProfile();
281        $parser = new Parser(new ParserConfig($profile->version));
282        $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($input, false));
283        $index = new Index($snapshotId, $trees);
284        $lowering = new LoweringScope($index->builder('fixture.php'), $index, 'target');
285        $lowering->name(new Name('work', ['namespacedName' => new Name('App\work')]));
286        self::assertSame('App\work', $lowering->graph->instructions[0][0]->constant?->native());
287    }
288    public function testArgumentsRetainsNamedStorageArguments(): void
289    {
290        $source = '<?php function target(){return 1;}';
291        $snapshotId = 'test';
292        $input = new Sources([new Source('fixture.php', $source)]);
293        $profile = new TargetProfile();
294        $parser = new Parser(new ParserConfig($profile->version));
295        $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($input, false));
296        $index = new Index($snapshotId, $trees);
297        $lowering = new LoweringScope($index->builder('fixture.php'), $index, 'target');
298        $arguments = $lowering->arguments([new Arg(new Variable('x'), name: new Identifier('value'))]);
299        self::assertSame('value', $arguments[0]->name);
300        self::assertNotNull($arguments[0]->location);
301        self::assertSame(['local', 'read'], array_column($lowering->graph->instructions[0], 'operation'));
302    }
303    public function testAddressableRejectsComputedValues(): void
304    {
305        $source = '<?php function target(){return 1;}';
306        $snapshotId = 'test';
307        $input = new Sources([new Source('fixture.php', $source)]);
308        $profile = new TargetProfile();
309        $parser = new Parser(new ParserConfig($profile->version));
310        $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($input, false));
311        $index = new Index($snapshotId, $trees);
312        $lowering = new LoweringScope($index->builder('fixture.php'), $index, 'target');
313        self::assertFalse($lowering->addressable(new Int_(1)));
314        self::assertTrue($lowering->addressable(new Variable('x')));
315    }
316    #[DataProvider('providerClassOperandSyntax')]
317    public function testLocationPreservesWhetherAClassOperandIsLiteral(string $expression, bool $literal): void
318    {
319        $source = '<?php function target($class,$value){return ' . $expression . ';}';
320        $snapshotId = 'test';
321        $input = new Sources([new Source('fixture.php', $source)]);
322        $profile = new TargetProfile();
323        $parser = new Parser(new ParserConfig($profile->version));
324        $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($input, false));
325        $index = new Index($snapshotId, $trees);
326        $body = $index->callable('target');
327        self::assertNotNull($body);
328        $instructions = array_values(array_filter($body->blocks[0]->instructions, static fn (Instruction $instruction): bool => $instruction->operation === 'static-address'));
329        self::assertCount(1, $instructions);
330        self::assertSame($literal, $instructions[0]->attributes['literal-class']);
331    }
332    /**
333     * @return iterable<string,array{string,bool}>
334     */
335    public static function providerClassOperandSyntax(): iterable
336    {
337        yield 'Box::$value' => ['Box::$value', true];
338        yield '$class::$value' => ['$class::$value', false];
339    }
340}
341