packages/deriver/tests/Unit/Deriver/Evaluator/Execution/Transfer/ReferenceAssignmentTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Evaluator\Execution\Transfer;
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\Allocation;
20use Deriver\Deriver\Evaluator\Execution\Call\ArgumentBinding;
21use Deriver\Deriver\Evaluator\Execution\Call\ArgumentOrder;
22use Deriver\Deriver\Evaluator\Execution\Call\CallExecutor;
23use Deriver\Deriver\Evaluator\Execution\Call\Creation\Access;
24use Deriver\Deriver\Evaluator\Execution\Call\Member\Invocation;
25use Deriver\Deriver\Evaluator\Execution\Call\Native\Invocation as NativeInvocation;
26use Deriver\Deriver\Evaluator\Execution\Call\Native\Properties;
27use Deriver\Deriver\Evaluator\Execution\Call\Native\Signatures;
28use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Creation;
29use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Resolution;
30use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Target;
31use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Transfer;
32use Deriver\Deriver\Evaluator\Execution\Call\TypeBinding;
33use Deriver\Deriver\Evaluator\Execution\Call\TypeCheck;
34use Deriver\Deriver\Evaluator\Execution\Completion\Alternative;
35use Deriver\Deriver\Evaluator\Execution\Completion\Assessment;
36use Deriver\Deriver\Evaluator\Execution\Completion\Completion;
37use Deriver\Deriver\Evaluator\Execution\Completion\StorageSnapshot;
38use Deriver\Deriver\Evaluator\Execution\Context;
39use Deriver\Deriver\Evaluator\Execution\Control\ExceptionChain;
40use Deriver\Deriver\Evaluator\Execution\Control\ExceptionMatch;
41use Deriver\Deriver\Evaluator\Execution\Control\Handler;
42use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
43use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
44use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
45use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
46use Deriver\Deriver\Evaluator\Execution\Dependencies;
47use Deriver\Deriver\Evaluator\Execution\Evaluator;
48use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
49use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
50use Deriver\Deriver\Evaluator\Execution\Memory\Location;
51use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
52use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
53use Deriver\Deriver\Evaluator\Execution\Memory\ReferenceConstraint;
54use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
55use Deriver\Deriver\Evaluator\Execution\Memory\Slots\StateStorage;
56use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
57use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
58use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
59use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
60use Deriver\Deriver\Evaluator\Execution\State;
61use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
62use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
63use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
64use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
65use Deriver\Deriver\Evaluator\Execution\Transfer\ObjectAccess;
66use Deriver\Deriver\Evaluator\Execution\Transfer\PropertyAccessCheck;
67use Deriver\Deriver\Evaluator\Execution\Transfer\PropertyLookup;
68use Deriver\Deriver\Evaluator\Execution\Transfer\PropertyReference;
69use Deriver\Deriver\Evaluator\Execution\Transfer\PropertySlot;
70use Deriver\Deriver\Evaluator\Execution\Transfer\PropertyTransfer;
71use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
72use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
73use Deriver\Deriver\Evaluator\Request\Budget;
74use Deriver\Deriver\Evaluator\Request\EntryPoint;
75use Deriver\Deriver\Evaluator\Request\QueryScope;
76use Deriver\Deriver\Evaluator\Request\ReturnQuery;
77use Deriver\Deriver\Evaluator\Scalar\Arrays;
78use Deriver\Deriver\Evaluator\Scalar\Identity;
79use Deriver\Deriver\Evaluator\Scalar\NumericString;
80use Deriver\Deriver\Evaluator\Scalar\Operations;
81use Deriver\Deriver\Evaluator\TargetProfile;
82use Deriver\Deriver\Evaluator\Term;
83use Deriver\Deriver\Execution\DerivationResult;
84use Deriver\Deriver\Execution\QueryExecution;
85use Deriver\Deriver\Execution\ResultAssessment;
86use Deriver\Deriver\Identity\QueryEncoding;
87use Deriver\Deriver\Identity\ValueGraph;
88use Deriver\Deriver\Lowerer\AggregateLowering;
89use Deriver\Deriver\Lowerer\AssignmentLowering;
90use Deriver\Deriver\Lowerer\CallLowering;
91use Deriver\Deriver\Lowerer\Control\DestructuringLowering;
92use Deriver\Deriver\Lowerer\Control\ExceptionLowering;
93use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
94use Deriver\Deriver\Lowerer\Declaration\CallableSource;
95use Deriver\Deriver\Lowerer\Declaration\ConstantSignatures;
96use Deriver\Deriver\Lowerer\Declaration\Index;
97use Deriver\Deriver\Lowerer\Declaration\Indexer;
98use Deriver\Deriver\Lowerer\Declaration\Metadata\ClassDeclaration;
99use Deriver\Deriver\Lowerer\Declaration\Metadata\PropertyDeclaration;
100use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
101use Deriver\Deriver\Lowerer\ExpressionLowering;
102use Deriver\Deriver\Lowerer\Graph\BasicBlock;
103use Deriver\Deriver\Lowerer\Graph\CallableGraph;
104use Deriver\Deriver\Lowerer\Graph\CatchTarget;
105use Deriver\Deriver\Lowerer\Graph\ExceptionRegion;
106use Deriver\Deriver\Lowerer\Graph\Instruction;
107use Deriver\Deriver\Lowerer\Graph\Terminator;
108use Deriver\Deriver\Lowerer\Hierarchy\Builtins;
109use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
110use Deriver\Deriver\Lowerer\InstructionEmitter;
111use Deriver\Deriver\Lowerer\Lowerer;
112use Deriver\Deriver\Lowerer\LoweringScope;
113use Deriver\Deriver\Lowerer\StatementLowering;
114use Deriver\Deriver\MicroEvaluatorConversion;
115use Deriver\Deriver\Parser\Node\File;
116use Deriver\Deriver\Parser\Parser;
117use Deriver\Deriver\Parser\ParserConfig;
118use Deriver\Deriver\Parser\TargetSyntax;
119use Deriver\Deriver\Providers\ProviderExpansion;
120use Deriver\Deriver\Resolver\AssignmentPatterns;
121use Deriver\Deriver\Resolver\ClassScope;
122use Deriver\Deriver\Resolver\ExpressionValidation;
123use Deriver\Deriver\Resolver\MagicContext;
124use Deriver\Deriver\Resolver\Resolver;
125use Deriver\Deriver\Selection\QueryValidation;
126use Deriver\Deriver\SnapshotIdentity;
127use Deriver\Deriver\Sources\LineMap;
128use Deriver\Deriver\Sources\Path;
129use Deriver\Deriver\Sources\Source;
130use Deriver\Deriver\Sources\SourceRef;
131use Deriver\Deriver\Sources\Sources;
132use Deriver\Exception\ParserException;
133use Deriver\Exception\ResolutionException;
134use PHPUnit\Framework\Attributes\CoversClass;
135use PHPUnit\Framework\Attributes\Small;
136use PHPUnit\Framework\Attributes\UsesClass;
137use PHPUnit\Framework\TestCase;
138
139/**
140 * @covers \Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment
141 */
142#[UsesClass(Resolver::class)]
143#[UsesClass(ExpressionValidation::class)]
144#[UsesClass(ResolutionException::class)]
145#[UsesClass(ParserConfig::class)]
146#[UsesClass(ParserException::class)]
147#[CoversClass(ReferenceAssignment::class)]
148#[UsesClass(QueryExecution::class)]
149#[UsesClass(QueryValidation::class)]
150#[UsesClass(ResultAssessment::class)]
151#[UsesClass(Deriver::class)]
152#[UsesClass(BasicBlock::class)]
153#[UsesClass(CallableGraph::class)]
154#[UsesClass(CallableIdentity::class)]
155#[UsesClass(CatchTarget::class)]
156#[UsesClass(ClassDeclaration::class)]
157#[UsesClass(ExceptionRegion::class)]
158#[UsesClass(Instruction::class)]
159#[UsesClass(PropertyDeclaration::class)]
160#[UsesClass(Terminator::class)]
161#[UsesClass(Allocation::class)]
162#[UsesClass(ArgumentBinding::class)]
163#[UsesClass(ArgumentOrder::class)]
164#[UsesClass(CallExecutor::class)]
165#[UsesClass(Access::class)]
166#[UsesClass(Builtins::class)]
167#[UsesClass(Dispatch::class)]
168#[UsesClass(Invocation::class)]
169#[UsesClass(NativeInvocation::class)]
170#[UsesClass(Properties::class)]
171#[UsesClass(Signatures::class)]
172#[UsesClass(Creation::class)]
173#[UsesClass(Resolution::class)]
174#[UsesClass(Target::class)]
175#[UsesClass(Transfer::class)]
176#[UsesClass(TypeBinding::class)]
177#[UsesClass(TypeCheck::class)]
178#[UsesClass(Completion::class)]
179#[UsesClass(Context::class)]
180#[UsesClass(ExceptionChain::class)]
181#[UsesClass(ExceptionMatch::class)]
182#[UsesClass(Handler::class)]
183#[UsesClass(ObservationLimit::class)]
184#[UsesClass(StateJoin::class)]
185#[UsesClass(Unwinding::class)]
186#[UsesClass(Discovery::class)]
187#[UsesClass(Dependencies::class)]
188#[UsesClass(InstructionTransfer::class)]
189#[UsesClass(Evaluator::class)]
190#[UsesClass(SlotReference::class)]
191#[UsesClass(StateStorage::class)]
192#[UsesClass(ObservationCollector::class)]
193#[UsesClass(Conversions::class)]
194#[UsesClass(ScalarErrors::class)]
195#[UsesClass(State::class)]
196#[UsesClass(Evaluation::class)]
197#[UsesClass(Isolation::class)]
198#[UsesClass(MemoryStep::class)]
199#[UsesClass(ObjectAccess::class)]
200#[UsesClass(PropertyAccessCheck::class)]
201#[UsesClass(PropertyLookup::class)]
202#[UsesClass(PropertyReference::class)]
203#[UsesClass(PropertySlot::class)]
204#[UsesClass(PropertyTransfer::class)]
205#[UsesClass(PureStep::class)]
206#[UsesClass(Location::class)]
207#[UsesClass(Materialization::class)]
208#[UsesClass(Memory::class)]
209#[UsesClass(ReferenceConstraint::class)]
210#[UsesClass(StorageCapture::class)]
211#[UsesClass(Extensions::class)]
212#[UsesClass(ProviderExpansion::class)]
213#[UsesClass(Evaluators::class)]
214#[UsesClass(StateRegistry::class)]
215#[UsesClass(DeriverConfig::class)]
216#[UsesClass(EntryPoint::class)]
217#[UsesClass(Sources::class)]
218#[UsesClass(Path::class)]
219#[UsesClass(Snapshot::class)]
220#[UsesClass(Source::class)]
221#[UsesClass(TargetProfile::class)]
222#[UsesClass(Budget::class)]
223#[UsesClass(QueryScope::class)]
224#[UsesClass(ReturnQuery::class)]
225#[UsesClass(ResultRef::class)]
226#[UsesClass(SourceRef::class)]
227#[UsesClass(Alternative::class)]
228#[UsesClass(Assessment::class)]
229#[UsesClass(Derivation::class)]
230#[UsesClass(DerivationResult::class)]
231#[UsesClass(QueryEncoding::class)]
232#[UsesClass(ValueGraph::class)]
233#[UsesClass(Statistics::class)]
234#[UsesClass(StorageSnapshot::class)]
235#[UsesClass(Parser::class)]
236#[UsesClass(File::class)]
237#[UsesClass(AggregateLowering::class)]
238#[UsesClass(AssignmentLowering::class)]
239#[UsesClass(CallLowering::class)]
240#[UsesClass(Lowerer::class)]
241#[UsesClass(DestructuringLowering::class)]
242#[UsesClass(ExceptionLowering::class)]
243#[UsesClass(ExpressionLowering::class)]
244#[UsesClass(InstructionEmitter::class)]
245#[UsesClass(LoweringScope::class)]
246#[UsesClass(StatementLowering::class)]
247#[UsesClass(ConstantSignatures::class)]
248#[UsesClass(CallableSource::class)]
249#[UsesClass(Indexer::class)]
250#[UsesClass(Index::class)]
251#[UsesClass(Composition::class)]
252#[UsesClass(LineMap::class)]
253#[UsesClass(MagicContext::class)]
254#[UsesClass(AssignmentPatterns::class)]
255#[UsesClass(ClassScope::class)]
256#[UsesClass(TargetSyntax::class)]
257#[UsesClass(Arrays::class)]
258#[UsesClass(Identity::class)]
259#[UsesClass(NumericString::class)]
260#[UsesClass(Operations::class)]
261#[UsesClass(Term::class)]
262#[Small]
263final class ReferenceAssignmentTest extends TestCase
264{
265    public function testApplyChecksAReferenceThatOutlivesItsOriginalProperty(): void
266    {
267        $source = '<?php class B{public int $x=1;}function target(){$b=new B;$x=&$b->x;$c=clone $b;unset($b->x);try{$x=[];}catch(TypeError $e){return $c->x;}return 999;}';
268        $symbol = 'target';
269        $input = new Sources([new Source('fixture.php', $source)]);
270        $configuration = new DeriverConfig();
271        $contributions = new Contributions();
272        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
273        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
274        $contributions1 = $providers->contributions;
275        $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);
276        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
277        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
278        $snapshotId = $identity->id;
279        $input1 = $providers->input;
280        $parser = new Parser(new ParserConfig($target->version));
281        $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));
282        $program = new Index($snapshotId, $trees);
283        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
284        self::assertSame([], $result->frontiers);
285        self::assertSame([], $result->exceptionalOutcomes);
286        self::assertCount(1, $result->normalOutcomes);
287        self::assertSame(1, $result->normalOutcomes[0]->values['return']->native());
288    }
289    public function testCheckRejectsConflictingCoercions(): void
290    {
291        $source = '<?php function target(){return 1;}';
292        $budget = new Budget();
293        $configuration = new DeriverConfig();
294        $contributions = new Contributions();
295        $input = new Sources([new Source('fixture.php', $source)]);
296        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
297        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
298        $contributions1 = $providers->contributions;
299        $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);
300        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
301        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
302        $snapshotId = $identity->id;
303        $input1 = $providers->input;
304        $parser = new Parser(new ParserConfig($target->version));
305        $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));
306        $program1 = new Index($snapshotId, $trees);
307        $execution = new QueryExecution($program1, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program1->diagnostics())));
308        $snapshotId1 = 'test';
309        $input2 = new Sources([new Source('fixture.php', $source)]);
310        $profile = $execution->configuration->target;
311        $parser1 = new Parser(new ParserConfig($profile->version));
312        $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));
313        $program = new Index($snapshotId1, $trees1);
314        $check = (new ReferenceAssignment(new Context($program, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators)))->check(Term::constant(1), ['int', 'float'], false);
315        self::assertTrue($check->mustFail);
316    }
317    public function testCheckAllowsMixedToFollowAPropertyCoercion(): void
318    {
319        $source = '<?php function target(){return 1;}';
320        $budget = new Budget();
321        $configuration = new DeriverConfig();
322        $contributions = new Contributions();
323        $input = new Sources([new Source('fixture.php', $source)]);
324        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
325        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
326        $contributions1 = $providers->contributions;
327        $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);
328        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
329        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
330        $snapshotId = $identity->id;
331        $input1 = $providers->input;
332        $parser = new Parser(new ParserConfig($target->version));
333        $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));
334        $program1 = new Index($snapshotId, $trees);
335        $execution = new QueryExecution($program1, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program1->diagnostics())));
336        $snapshotId1 = 'test';
337        $input2 = new Sources([new Source('fixture.php', $source)]);
338        $profile = $execution->configuration->target;
339        $parser1 = new Parser(new ParserConfig($profile->version));
340        $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));
341        $program = new Index($snapshotId1, $trees1);
342        $check = (new ReferenceAssignment(new Context($program, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators)))->check(Term::constant('42'), ['mixed', 'int'], false);
343        self::assertFalse($check->mayFail);
344        self::assertSame(42, $check->value->native());
345    }
346}
347