packages/deriver/tests/Unit/Deriver/Evaluator/Execution/StateTest.php

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