packages/deriver/tests/Unit/Deriver/Evaluator/Builtin/FunctionEvaluatorTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Evaluator\Builtin;
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\Builtin\FunctionEvaluator;
14use Deriver\Deriver\Evaluator\Builtin\Library;
15use Deriver\Deriver\Evaluator\Call\ArgumentBindings;
16use Deriver\Deriver\Evaluator\Call\BoundArgument;
17use Deriver\Deriver\Evaluator\Call\CallDecision;
18use Deriver\Deriver\Evaluator\Call\CallDescription;
19use Deriver\Deriver\Evaluator\Call\CallDescriptor;
20use Deriver\Deriver\Evaluator\Call\Evaluators;
21use Deriver\Deriver\Evaluator\Call\Extensions;
22use Deriver\Deriver\Evaluator\Call\Plan\Action;
23use Deriver\Deriver\Evaluator\Call\Plan\ActionKind;
24use Deriver\Deriver\Evaluator\Call\Plan\Expression;
25use Deriver\Deriver\Evaluator\Call\Plan\Location\LocationRef;
26use Deriver\Deriver\Evaluator\Call\Plan\PlanActions;
27use Deriver\Deriver\Evaluator\Call\Plan\PlanCompiler;
28use Deriver\Deriver\Evaluator\Call\Plan\PlanFootprints;
29use Deriver\Deriver\Evaluator\Call\Plan\PlanValidation;
30use Deriver\Deriver\Evaluator\Call\Plan\SemanticPlan;
31use Deriver\Deriver\Evaluator\Call\Registrations;
32use Deriver\Deriver\Evaluator\Call\StateRegistry;
33use Deriver\Deriver\Evaluator\Declaration\Parameter as DeclarationParameter;
34use Deriver\Deriver\Evaluator\Declaration\Signature;
35use Deriver\Deriver\Evaluator\EvaluatorConfig;
36use Deriver\Deriver\Evaluator\Evidence\Frontier;
37use Deriver\Deriver\Evaluator\Execution\Call\ArgumentBinding;
38use Deriver\Deriver\Evaluator\Execution\Call\ArgumentOrder;
39use Deriver\Deriver\Evaluator\Execution\Call\CallableCheck;
40use Deriver\Deriver\Evaluator\Execution\Call\CallExecutor;
41use Deriver\Deriver\Evaluator\Execution\Call\CallResolution;
42use Deriver\Deriver\Evaluator\Execution\Call\Contract\Inputs;
43use Deriver\Deriver\Evaluator\Execution\Call\Contract\NativeArguments;
44use Deriver\Deriver\Evaluator\Execution\Call\ParameterBinding;
45use Deriver\Deriver\Evaluator\Execution\Call\PassedArgument;
46use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Arguments;
47use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Modes;
48use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Resolution;
49use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Target;
50use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Transfer;
51use Deriver\Deriver\Evaluator\Execution\Call\TypeBinding;
52use Deriver\Deriver\Evaluator\Execution\Call\TypeCheck;
53use Deriver\Deriver\Evaluator\Execution\Completion\Alternative;
54use Deriver\Deriver\Evaluator\Execution\Completion\Assessment;
55use Deriver\Deriver\Evaluator\Execution\Completion\Completion;
56use Deriver\Deriver\Evaluator\Execution\Completion\StorageSnapshot;
57use Deriver\Deriver\Evaluator\Execution\Context;
58use Deriver\Deriver\Evaluator\Execution\Control\CollectionCalls;
59use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
60use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
61use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
62use Deriver\Deriver\Evaluator\Execution\Demand\Cell;
63use Deriver\Deriver\Evaluator\Execution\Demand\Components;
64use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
65use Deriver\Deriver\Evaluator\Execution\Demand\Key;
66use Deriver\Deriver\Evaluator\Execution\Demand\Table;
67use Deriver\Deriver\Evaluator\Execution\Dependencies;
68use Deriver\Deriver\Evaluator\Execution\Evaluator;
69use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
70use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
71use Deriver\Deriver\Evaluator\Execution\Memory\Location;
72use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
73use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
74use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
75use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
76use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
77use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
78use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
79use Deriver\Deriver\Evaluator\Execution\State;
80use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
81use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
82use Deriver\Deriver\Evaluator\Execution\Summary\Invocation;
83use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
84use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
85use Deriver\Deriver\Evaluator\Execution\Transfer\CallableTransfer;
86use Deriver\Deriver\Evaluator\Execution\Transfer\IntrinsicTransfer;
87use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
88use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
89use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
90use Deriver\Deriver\Evaluator\Request\Budget;
91use Deriver\Deriver\Evaluator\Request\EntryPoint;
92use Deriver\Deriver\Evaluator\Request\QueryScope;
93use Deriver\Deriver\Evaluator\Request\ReturnQuery;
94use Deriver\Deriver\Evaluator\Scalar\Arithmetic;
95use Deriver\Deriver\Evaluator\Scalar\Arrays;
96use Deriver\Deriver\Evaluator\Scalar\Identity;
97use Deriver\Deriver\Evaluator\Scalar\Operations;
98use Deriver\Deriver\Evaluator\TargetProfile;
99use Deriver\Deriver\Evaluator\Term;
100use Deriver\Deriver\Execution\DerivationResult;
101use Deriver\Deriver\Execution\QueryExecution;
102use Deriver\Deriver\Execution\ResultAssessment;
103use Deriver\Deriver\Identity\QueryEncoding;
104use Deriver\Deriver\Identity\ValueGraph;
105use Deriver\Deriver\Lowerer\AggregateLowering;
106use Deriver\Deriver\Lowerer\CallLowering;
107use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
108use Deriver\Deriver\Lowerer\Declaration\CallableSource;
109use Deriver\Deriver\Lowerer\Declaration\Index;
110use Deriver\Deriver\Lowerer\Declaration\Indexer;
111use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
112use Deriver\Deriver\Lowerer\EffectInspection;
113use Deriver\Deriver\Lowerer\ExpressionLowering;
114use Deriver\Deriver\Lowerer\Graph\Argument;
115use Deriver\Deriver\Lowerer\Graph\BasicBlock;
116use Deriver\Deriver\Lowerer\Graph\CallableGraph;
117use Deriver\Deriver\Lowerer\Graph\Instruction;
118use Deriver\Deriver\Lowerer\Graph\Parameter;
119use Deriver\Deriver\Lowerer\Graph\Terminator;
120use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
121use Deriver\Deriver\Lowerer\InstructionEmitter;
122use Deriver\Deriver\Lowerer\Lowerer;
123use Deriver\Deriver\Lowerer\LoweringScope;
124use Deriver\Deriver\Lowerer\StatementLowering;
125use Deriver\Deriver\MicroEvaluatorConversion;
126use Deriver\Deriver\Parser\Node\File;
127use Deriver\Deriver\Parser\Parser;
128use Deriver\Deriver\Parser\ParserConfig;
129use Deriver\Deriver\Parser\TargetSyntax;
130use Deriver\Deriver\Providers\ProviderExpansion;
131use Deriver\Deriver\Resolver\AssignmentPatterns;
132use Deriver\Deriver\Resolver\ClassScope;
133use Deriver\Deriver\Resolver\ExpressionValidation;
134use Deriver\Deriver\Resolver\MagicContext;
135use Deriver\Deriver\Resolver\Resolver;
136use Deriver\Deriver\Selection\QueryValidation;
137use Deriver\Deriver\SnapshotIdentity;
138use Deriver\Deriver\Sources\LineMap;
139use Deriver\Deriver\Sources\Path;
140use Deriver\Deriver\Sources\Source;
141use Deriver\Deriver\Sources\SourceRef;
142use Deriver\Deriver\Sources\Sources;
143use Deriver\Exception\ParserException;
144use Deriver\Exception\ResolutionException;
145use PHPUnit\Framework\Attributes\CoversClass;
146use PHPUnit\Framework\Attributes\Small;
147use PHPUnit\Framework\Attributes\UsesClass;
148use PHPUnit\Framework\TestCase;
149
150#[UsesClass(Resolver::class)]
151#[UsesClass(ExpressionValidation::class)]
152#[UsesClass(ResolutionException::class)]
153#[UsesClass(ParserConfig::class)]
154#[UsesClass(ParserException::class)]
155#[CoversClass(FunctionEvaluator::class)]
156#[UsesClass(QueryExecution::class)]
157#[UsesClass(QueryValidation::class)]
158#[UsesClass(ResultAssessment::class)]
159#[UsesClass(Deriver::class)]
160#[UsesClass(Argument::class)]
161#[UsesClass(BasicBlock::class)]
162#[UsesClass(CallableGraph::class)]
163#[UsesClass(CallableIdentity::class)]
164#[UsesClass(Instruction::class)]
165#[UsesClass(Parameter::class)]
166#[UsesClass(Terminator::class)]
167#[UsesClass(ArgumentBinding::class)]
168#[UsesClass(ArgumentOrder::class)]
169#[UsesClass(CallExecutor::class)]
170#[UsesClass(CallResolution::class)]
171#[UsesClass(CallableCheck::class)]
172#[UsesClass(Dispatch::class)]
173#[UsesClass(Inputs::class)]
174#[UsesClass(NativeArguments::class)]
175#[UsesClass(ParameterBinding::class)]
176#[UsesClass(PassedArgument::class)]
177#[UsesClass(Arguments::class)]
178#[UsesClass(Modes::class)]
179#[UsesClass(Resolution::class)]
180#[UsesClass(Target::class)]
181#[UsesClass(Transfer::class)]
182#[UsesClass(TypeBinding::class)]
183#[UsesClass(TypeCheck::class)]
184#[UsesClass(Completion::class)]
185#[UsesClass(Context::class)]
186#[UsesClass(CollectionCalls::class)]
187#[UsesClass(ObservationLimit::class)]
188#[UsesClass(StateJoin::class)]
189#[UsesClass(Unwinding::class)]
190#[UsesClass(Cell::class)]
191#[UsesClass(Components::class)]
192#[UsesClass(Discovery::class)]
193#[UsesClass(Key::class)]
194#[UsesClass(Table::class)]
195#[UsesClass(Dependencies::class)]
196#[UsesClass(InstructionTransfer::class)]
197#[UsesClass(Evaluator::class)]
198#[UsesClass(SlotReference::class)]
199#[UsesClass(ObservationCollector::class)]
200#[UsesClass(Conversions::class)]
201#[UsesClass(ScalarErrors::class)]
202#[UsesClass(State::class)]
203#[UsesClass(CompletionRecord::class)]
204#[UsesClass(Evaluation::class)]
205#[UsesClass(Invocation::class)]
206#[UsesClass(Isolation::class)]
207#[UsesClass(CallableTransfer::class)]
208#[UsesClass(IntrinsicTransfer::class)]
209#[UsesClass(MemoryStep::class)]
210#[UsesClass(PureStep::class)]
211#[UsesClass(ReferenceAssignment::class)]
212#[UsesClass(Location::class)]
213#[UsesClass(Materialization::class)]
214#[UsesClass(Memory::class)]
215#[UsesClass(StorageCapture::class)]
216#[UsesClass(ArgumentBindings::class)]
217#[UsesClass(BoundArgument::class)]
218#[UsesClass(LocationRef::class)]
219#[UsesClass(Library::class)]
220#[UsesClass(CallDescription::class)]
221#[UsesClass(PlanActions::class)]
222#[UsesClass(PlanCompiler::class)]
223#[UsesClass(PlanFootprints::class)]
224#[UsesClass(PlanValidation::class)]
225#[UsesClass(CallDecision::class)]
226#[UsesClass(CallDescriptor::class)]
227#[UsesClass(Action::class)]
228#[UsesClass(Expression::class)]
229#[UsesClass(SemanticPlan::class)]
230#[UsesClass(Extensions::class)]
231#[UsesClass(ProviderExpansion::class)]
232#[UsesClass(Evaluators::class)]
233#[UsesClass(StateRegistry::class)]
234#[UsesClass(DeclarationParameter::class)]
235#[UsesClass(Signature::class)]
236#[UsesClass(DeriverConfig::class)]
237#[UsesClass(EntryPoint::class)]
238#[UsesClass(Sources::class)]
239#[UsesClass(Path::class)]
240#[UsesClass(Snapshot::class)]
241#[UsesClass(Source::class)]
242#[UsesClass(TargetProfile::class)]
243#[UsesClass(Budget::class)]
244#[UsesClass(QueryScope::class)]
245#[UsesClass(ReturnQuery::class)]
246#[UsesClass(ResultRef::class)]
247#[UsesClass(SourceRef::class)]
248#[UsesClass(Alternative::class)]
249#[UsesClass(Assessment::class)]
250#[UsesClass(Derivation::class)]
251#[UsesClass(DerivationResult::class)]
252#[UsesClass(QueryEncoding::class)]
253#[UsesClass(ValueGraph::class)]
254#[UsesClass(Statistics::class)]
255#[UsesClass(StorageSnapshot::class)]
256#[UsesClass(Parser::class)]
257#[UsesClass(File::class)]
258#[UsesClass(AggregateLowering::class)]
259#[UsesClass(CallLowering::class)]
260#[UsesClass(Lowerer::class)]
261#[UsesClass(EffectInspection::class)]
262#[UsesClass(ExpressionLowering::class)]
263#[UsesClass(InstructionEmitter::class)]
264#[UsesClass(LoweringScope::class)]
265#[UsesClass(StatementLowering::class)]
266#[UsesClass(CallableSource::class)]
267#[UsesClass(Indexer::class)]
268#[UsesClass(Index::class)]
269#[UsesClass(Composition::class)]
270#[UsesClass(LineMap::class)]
271#[UsesClass(MagicContext::class)]
272#[UsesClass(AssignmentPatterns::class)]
273#[UsesClass(ClassScope::class)]
274#[UsesClass(TargetSyntax::class)]
275#[UsesClass(Arithmetic::class)]
276#[UsesClass(Arrays::class)]
277#[UsesClass(Identity::class)]
278#[UsesClass(Operations::class)]
279#[UsesClass(Term::class)]
280#[Small]
281final class FunctionEvaluatorTest extends TestCase
282{
283    public function testDescriptorPreservesTheSemanticContract(): void
284    {
285        $source = '<?php function target(){return array_map(fn($x)=>$x*2,[1,2,3]);}';
286        $symbol = 'target';
287        $input = new Sources([new Source('fixture.php', $source)]);
288        $configuration = new DeriverConfig();
289        $contributions = new Contributions();
290        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
291        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
292        $contributions1 = $providers->contributions;
293        $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);
294        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
295        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
296        $snapshotId = $identity->id;
297        $input1 = $providers->input;
298        $parser = new Parser(new ParserConfig($target->version));
299        $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));
300        $program = new Index($snapshotId, $trees);
301        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
302        self::assertSame([2, 4, 6], $result->normalOutcomes[0]->values['return']->native());
303        self::assertSame([], $result->frontiers);
304        self::assertSame([], $result->exceptionalOutcomes);
305    }
306    public function testEvaluateDeclaresReferenceWritesForSorting(): void
307    {
308        $evaluator = (new Library())->evaluator('sort');
309        self::assertNotNull($evaluator);
310        $decision = $evaluator->evaluate(new CallDescription('sort', $evaluator->descriptor()->signature, new TargetProfile()));
311        self::assertNotNull($decision->plan);
312        self::assertSame(['parameter:array'], $decision->plan->writes);
313        self::assertSame(ActionKind::WriteParameter, $decision->plan->actions[0]->operation);
314    }
315    public function testMutationBranchesRemovalsOnEmptinessAndAppendsOnTheirFailure(): void
316    {
317        $shift = (new FunctionEvaluator('array_shift', []))->mutation([]);
318        self::assertSame(ActionKind::Choice, $shift[0]->operation);
319        self::assertSame('array', $shift[0]->operands[0]->name);
320        self::assertSame([ActionKind::WriteParameter, ActionKind::WriteParameter, ActionKind::Return], array_column($shift[0]->yes, 'operation'));
321        self::assertSame([ActionKind::Return], array_column($shift[0]->no, 'operation'));
322        $push = (new FunctionEvaluator('array_push', []))->mutation([]);
323        self::assertSame([ActionKind::WriteParameter, ActionKind::Choice], array_column($push, 'operation'));
324        self::assertSame([ActionKind::WriteParameter, ActionKind::Throw], array_column($push[1]->no, 'operation'));
325        self::assertSame([ActionKind::WriteParameter, ActionKind::WriteParameter, ActionKind::Return], array_column((new FunctionEvaluator('array_unshift', []))->mutation([]), 'operation'));
326    }
327    public function testEvaluateWritesTheMutatedArrayThroughTheReference(): void
328    {
329        $source = '<?php function target(){$a=[5=>"a","k"=>"b"];$first=array_shift($a);$n=array_push($a,"c");return [$first,$n,$a];}';
330        $symbol = 'target';
331        $input = new Sources([new Source('fixture.php', $source)]);
332        $configuration = new DeriverConfig();
333        $contributions = new Contributions();
334        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
335        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
336        $contributions1 = $providers->contributions;
337        $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);
338        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
339        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
340        $snapshotId = $identity->id;
341        $input1 = $providers->input;
342        $parser = new Parser(new ParserConfig($target->version));
343        $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));
344        $program = new Index($snapshotId, $trees);
345        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
346        self::assertSame(['a', 2, ['k' => 'b', 0 => 'c']], $result->normalOutcomes[0]->values['return']->native());
347        self::assertSame([], $result->frontiers);
348        self::assertSame([], $result->exceptionalOutcomes);
349        $evaluator = (new Library())->evaluator('array_pop');
350        self::assertNotNull($evaluator);
351        self::assertSame(['parameter:array'], $evaluator->evaluate(new CallDescription('array_pop', $evaluator->descriptor()->signature, new TargetProfile()))->plan?->writes);
352    }
353}
354