packages/deriver/tests/Unit/Deriver/Lowerer/CallLoweringTest.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\CallableCheck;
22use Deriver\Deriver\Evaluator\Execution\Call\CallExecutor;
23use Deriver\Deriver\Evaluator\Execution\Call\CallResolution;
24use Deriver\Deriver\Evaluator\Execution\Call\Native\Properties;
25use Deriver\Deriver\Evaluator\Execution\Call\Native\Signatures;
26use Deriver\Deriver\Evaluator\Execution\Call\ParameterBinding;
27use Deriver\Deriver\Evaluator\Execution\Call\PassedArgument;
28use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Arguments;
29use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Methods;
30use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Modes;
31use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Resolution;
32use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Target;
33use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Transfer;
34use Deriver\Deriver\Evaluator\Execution\Call\TypeBinding;
35use Deriver\Deriver\Evaluator\Execution\Call\TypeCheck;
36use Deriver\Deriver\Evaluator\Execution\Completion\Alternative;
37use Deriver\Deriver\Evaluator\Execution\Completion\Assessment;
38use Deriver\Deriver\Evaluator\Execution\Completion\Completion;
39use Deriver\Deriver\Evaluator\Execution\Completion\StorageSnapshot;
40use Deriver\Deriver\Evaluator\Execution\Constant\ClassNames;
41use Deriver\Deriver\Evaluator\Execution\Context;
42use Deriver\Deriver\Evaluator\Execution\Control\ExceptionChain;
43use Deriver\Deriver\Evaluator\Execution\Control\ExceptionMatch;
44use Deriver\Deriver\Evaluator\Execution\Control\Handler;
45use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
46use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
47use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
48use Deriver\Deriver\Evaluator\Execution\Demand\Cell;
49use Deriver\Deriver\Evaluator\Execution\Demand\Components;
50use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
51use Deriver\Deriver\Evaluator\Execution\Demand\Key;
52use Deriver\Deriver\Evaluator\Execution\Demand\Table;
53use Deriver\Deriver\Evaluator\Execution\Dependencies;
54use Deriver\Deriver\Evaluator\Execution\Evaluator;
55use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
56use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
57use Deriver\Deriver\Evaluator\Execution\Memory\Location;
58use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
59use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
60use Deriver\Deriver\Evaluator\Execution\Memory\ReferenceConstraint;
61use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
62use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
63use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
64use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
65use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
66use Deriver\Deriver\Evaluator\Execution\State;
67use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
68use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
69use Deriver\Deriver\Evaluator\Execution\Summary\Invocation;
70use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
71use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
72use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
73use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
74use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
75use Deriver\Deriver\Evaluator\Request\Budget;
76use Deriver\Deriver\Evaluator\Request\EntryPoint;
77use Deriver\Deriver\Evaluator\Request\QueryScope;
78use Deriver\Deriver\Evaluator\Request\ReturnQuery;
79use Deriver\Deriver\Evaluator\Scalar\Arrays;
80use Deriver\Deriver\Evaluator\Scalar\Identity;
81use Deriver\Deriver\Evaluator\Scalar\Operations;
82use Deriver\Deriver\Evaluator\TargetProfile;
83use Deriver\Deriver\Evaluator\Term;
84use Deriver\Deriver\Execution\DerivationResult;
85use Deriver\Deriver\Execution\QueryExecution;
86use Deriver\Deriver\Execution\ResultAssessment;
87use Deriver\Deriver\Identity\QueryEncoding;
88use Deriver\Deriver\Identity\ValueGraph;
89use Deriver\Deriver\Lowerer\AggregateLowering;
90use Deriver\Deriver\Lowerer\AssignmentLowering;
91use Deriver\Deriver\Lowerer\CallLowering;
92use Deriver\Deriver\Lowerer\Control\DestructuringLowering;
93use Deriver\Deriver\Lowerer\Control\ExceptionLowering;
94use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
95use Deriver\Deriver\Lowerer\Declaration\CallableSource;
96use Deriver\Deriver\Lowerer\Declaration\ConstantSignatures;
97use Deriver\Deriver\Lowerer\Declaration\Index;
98use Deriver\Deriver\Lowerer\Declaration\Indexer;
99use Deriver\Deriver\Lowerer\Declaration\Metadata\ClassDeclaration;
100use Deriver\Deriver\Lowerer\Declaration\Metadata\PropertyDeclaration;
101use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
102use Deriver\Deriver\Lowerer\EffectInspection;
103use Deriver\Deriver\Lowerer\ExpressionLowering;
104use Deriver\Deriver\Lowerer\Graph\Argument;
105use Deriver\Deriver\Lowerer\Graph\BasicBlock;
106use Deriver\Deriver\Lowerer\Graph\CallableGraph;
107use Deriver\Deriver\Lowerer\Graph\CatchTarget;
108use Deriver\Deriver\Lowerer\Graph\ExceptionRegion;
109use Deriver\Deriver\Lowerer\Graph\Instruction;
110use Deriver\Deriver\Lowerer\Graph\Literal;
111use Deriver\Deriver\Lowerer\Graph\Parameter;
112use Deriver\Deriver\Lowerer\Graph\Terminator;
113use Deriver\Deriver\Lowerer\Hierarchy\Access;
114use Deriver\Deriver\Lowerer\Hierarchy\Builtins;
115use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
116use Deriver\Deriver\Lowerer\InstructionEmitter;
117use Deriver\Deriver\Lowerer\Lowerer;
118use Deriver\Deriver\Lowerer\LoweringScope;
119use Deriver\Deriver\Lowerer\StatementLowering;
120use Deriver\Deriver\MicroEvaluatorConversion;
121use Deriver\Deriver\Parser\Node\File;
122use Deriver\Deriver\Parser\Parser;
123use Deriver\Deriver\Parser\ParserConfig;
124use Deriver\Deriver\Parser\TargetSyntax;
125use Deriver\Deriver\Providers\ProviderExpansion;
126use Deriver\Deriver\Resolver\AssignmentPatterns;
127use Deriver\Deriver\Resolver\ClassScope;
128use Deriver\Deriver\Resolver\ExpressionValidation;
129use Deriver\Deriver\Resolver\MagicContext;
130use Deriver\Deriver\Resolver\Resolver;
131use Deriver\Deriver\Selection\QueryValidation;
132use Deriver\Deriver\SnapshotIdentity;
133use Deriver\Deriver\Sources\LineMap;
134use Deriver\Deriver\Sources\Path;
135use Deriver\Deriver\Sources\Source;
136use Deriver\Deriver\Sources\SourceRef;
137use Deriver\Deriver\Sources\Sources;
138use Deriver\Exception\ParserException;
139use Deriver\Exception\ResolutionException;
140use PhpParser\Node\Expr\FuncCall;
141use PhpParser\Node\Expr\NullsafeMethodCall;
142use PhpParser\Node\Name;
143use PHPUnit\Framework\Attributes\CoversClass;
144use PHPUnit\Framework\Attributes\DataProvider;
145use PHPUnit\Framework\Attributes\Small;
146use PHPUnit\Framework\Attributes\UsesClass;
147use PHPUnit\Framework\TestCase;
148
149#[UsesClass(Resolver::class)]
150#[UsesClass(ExpressionValidation::class)]
151#[UsesClass(ResolutionException::class)]
152#[UsesClass(ParserConfig::class)]
153#[UsesClass(ParserException::class)]
154#[CoversClass(CallLowering::class)]
155#[UsesClass(QueryExecution::class)]
156#[UsesClass(QueryValidation::class)]
157#[UsesClass(ResultAssessment::class)]
158#[UsesClass(Deriver::class)]
159#[UsesClass(Argument::class)]
160#[UsesClass(BasicBlock::class)]
161#[UsesClass(CallableGraph::class)]
162#[UsesClass(CallableIdentity::class)]
163#[UsesClass(CatchTarget::class)]
164#[UsesClass(ClassDeclaration::class)]
165#[UsesClass(ExceptionRegion::class)]
166#[UsesClass(Instruction::class)]
167#[UsesClass(Parameter::class)]
168#[UsesClass(PropertyDeclaration::class)]
169#[UsesClass(Terminator::class)]
170#[UsesClass(ArgumentBinding::class)]
171#[UsesClass(ArgumentOrder::class)]
172#[UsesClass(CallExecutor::class)]
173#[UsesClass(CallResolution::class)]
174#[UsesClass(CallableCheck::class)]
175#[UsesClass(Builtins::class)]
176#[UsesClass(Dispatch::class)]
177#[UsesClass(Access::class)]
178#[UsesClass(Properties::class)]
179#[UsesClass(Signatures::class)]
180#[UsesClass(ParameterBinding::class)]
181#[UsesClass(PassedArgument::class)]
182#[UsesClass(Arguments::class)]
183#[UsesClass(Methods::class)]
184#[UsesClass(Modes::class)]
185#[UsesClass(Resolution::class)]
186#[UsesClass(Target::class)]
187#[UsesClass(Transfer::class)]
188#[UsesClass(TypeBinding::class)]
189#[UsesClass(TypeCheck::class)]
190#[UsesClass(Completion::class)]
191#[UsesClass(ClassNames::class)]
192#[UsesClass(Context::class)]
193#[UsesClass(ExceptionChain::class)]
194#[UsesClass(ExceptionMatch::class)]
195#[UsesClass(Handler::class)]
196#[UsesClass(ObservationLimit::class)]
197#[UsesClass(StateJoin::class)]
198#[UsesClass(Unwinding::class)]
199#[UsesClass(Cell::class)]
200#[UsesClass(Components::class)]
201#[UsesClass(Discovery::class)]
202#[UsesClass(Key::class)]
203#[UsesClass(Table::class)]
204#[UsesClass(Dependencies::class)]
205#[UsesClass(InstructionTransfer::class)]
206#[UsesClass(Evaluator::class)]
207#[UsesClass(SlotReference::class)]
208#[UsesClass(ObservationCollector::class)]
209#[UsesClass(Conversions::class)]
210#[UsesClass(ScalarErrors::class)]
211#[UsesClass(State::class)]
212#[UsesClass(CompletionRecord::class)]
213#[UsesClass(Evaluation::class)]
214#[UsesClass(Invocation::class)]
215#[UsesClass(Isolation::class)]
216#[UsesClass(MemoryStep::class)]
217#[UsesClass(PureStep::class)]
218#[UsesClass(ReferenceAssignment::class)]
219#[UsesClass(Location::class)]
220#[UsesClass(Materialization::class)]
221#[UsesClass(Memory::class)]
222#[UsesClass(ReferenceConstraint::class)]
223#[UsesClass(StorageCapture::class)]
224#[UsesClass(Extensions::class)]
225#[UsesClass(ProviderExpansion::class)]
226#[UsesClass(Evaluators::class)]
227#[UsesClass(StateRegistry::class)]
228#[UsesClass(DeriverConfig::class)]
229#[UsesClass(EntryPoint::class)]
230#[UsesClass(Sources::class)]
231#[UsesClass(Path::class)]
232#[UsesClass(Snapshot::class)]
233#[UsesClass(Source::class)]
234#[UsesClass(TargetProfile::class)]
235#[UsesClass(Budget::class)]
236#[UsesClass(QueryScope::class)]
237#[UsesClass(ReturnQuery::class)]
238#[UsesClass(ResultRef::class)]
239#[UsesClass(SourceRef::class)]
240#[UsesClass(Alternative::class)]
241#[UsesClass(Assessment::class)]
242#[UsesClass(Derivation::class)]
243#[UsesClass(DerivationResult::class)]
244#[UsesClass(QueryEncoding::class)]
245#[UsesClass(ValueGraph::class)]
246#[UsesClass(Statistics::class)]
247#[UsesClass(StorageSnapshot::class)]
248#[UsesClass(Parser::class)]
249#[UsesClass(File::class)]
250#[UsesClass(AggregateLowering::class)]
251#[UsesClass(AssignmentLowering::class)]
252#[UsesClass(Lowerer::class)]
253#[UsesClass(DestructuringLowering::class)]
254#[UsesClass(ExceptionLowering::class)]
255#[UsesClass(EffectInspection::class)]
256#[UsesClass(ExpressionLowering::class)]
257#[UsesClass(InstructionEmitter::class)]
258#[UsesClass(LoweringScope::class)]
259#[UsesClass(StatementLowering::class)]
260#[UsesClass(ConstantSignatures::class)]
261#[UsesClass(CallableSource::class)]
262#[UsesClass(Indexer::class)]
263#[UsesClass(Index::class)]
264#[UsesClass(Composition::class)]
265#[UsesClass(LineMap::class)]
266#[UsesClass(MagicContext::class)]
267#[UsesClass(AssignmentPatterns::class)]
268#[UsesClass(ClassScope::class)]
269#[UsesClass(TargetSyntax::class)]
270#[UsesClass(Arrays::class)]
271#[UsesClass(Identity::class)]
272#[UsesClass(Operations::class)]
273#[UsesClass(Literal::class)]
274#[Small]
275final class CallLoweringTest extends TestCase
276{
277    public function testLowerPreservesTheSemanticContract(): void
278    {
279        $source = '<?php function tagged(string $tag,int $id) { return $tag . ":" . $id; } function target() { return [tagged("user",1),tagged("item",2)]; }';
280        $symbol = 'target';
281        $input = new Sources([new Source('fixture.php', $source)]);
282        $configuration = new DeriverConfig();
283        $contributions = new Contributions();
284        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
285        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
286        $contributions1 = $providers->contributions;
287        $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);
288        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
289        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
290        $snapshotId = $identity->id;
291        $input1 = $providers->input;
292        $parser = new Parser(new ParserConfig($target->version));
293        $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));
294        $program = new Index($snapshotId, $trees);
295        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
296        self::assertSame(['user:1', 'item:2'], $result->normalOutcomes[0]->values['return']->native());
297        self::assertSame([], $result->frontiers);
298        self::assertSame([], $result->exceptionalOutcomes);
299    }
300    public function testNullsafeUsesThePreviouslyEvaluatedReceiver(): void
301    {
302        $source = '<?php function target(){return 1;}';
303        $snapshotId = 'test';
304        $input = new Sources([new Source('fixture.php', $source)]);
305        $profile = new TargetProfile();
306        $parser = new Parser(new ParserConfig($profile->version));
307        $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));
308        $index = new Index($snapshotId, $trees);
309        $l = new LoweringScope($index->builder('fixture.php'), $index, 'target');
310        $node = new NullsafeMethodCall(new FuncCall(new Name('receiver')), 'run');
311        (new CallLowering($l))->nullsafe($node, 'receiver-once');
312        self::assertSame(['constant', 'call-prepare', 'invoke-method'], array_column($l->graph->instructions[0], 'operation'));
313        self::assertSame('receiver-once', $l->graph->instructions[0][1]->operands[0]);
314    }
315    public function testInvokeCapturesTheSignatureBeforeArgumentSideEffects(): void
316    {
317        $source = '<?php class Box{private static function hidden($x){}}function target(){$x=1;try{Box::hidden($x=2);}catch(Error $e){return $x;}return 999;}';
318        $symbol = 'target';
319        $input = new Sources([new Source('fixture.php', $source)]);
320        $configuration = new DeriverConfig();
321        $contributions = new Contributions();
322        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
323        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
324        $contributions1 = $providers->contributions;
325        $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);
326        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
327        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
328        $snapshotId = $identity->id;
329        $input1 = $providers->input;
330        $parser = new Parser(new ParserConfig($target->version));
331        $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));
332        $program = new Index($snapshotId, $trees);
333        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
334        self::assertSame(1, $result->normalOutcomes[0]->values['return']->native());
335        self::assertSame([], array_column($result->frontiers, 'code'));
336        self::assertSame([], $result->exceptionalOutcomes);
337    }
338    #[DataProvider('providerClassOperandSyntax')]
339    public function testLowerPreservesWhetherAClassOperandIsLiteral(string $expression, bool $literal): void
340    {
341        $source = '<?php function target($class,$value){return ' . $expression . ';}';
342        $snapshotId = 'test';
343        $input = new Sources([new Source('fixture.php', $source)]);
344        $profile = new TargetProfile();
345        $parser = new Parser(new ParserConfig($profile->version));
346        $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));
347        $index = new Index($snapshotId, $trees);
348        $body = $index->callable('target');
349        self::assertNotNull($body);
350        $instructions = array_values(array_filter($body->blocks[0]->instructions, static fn (Instruction $instruction): bool => $instruction->operation === 'invoke-static'));
351        self::assertCount(1, $instructions);
352        self::assertSame($literal, $instructions[0]->attributes['literal-class']);
353    }
354    /**
355     * @return iterable<string,array{string,bool}>
356     */
357    public static function providerClassOperandSyntax(): iterable
358    {
359        yield 'Box::value()' => ['Box::value()', true];
360        yield '$class::value()' => ['$class::value()', false];
361    }
362}
363