packages/deriver/tests/Unit/Deriver/Evaluator/Scalar/ArraysTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Evaluator\Scalar;
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\Offset\Address;
48use Deriver\Deriver\Evaluator\Execution\Offset\Path;
49use Deriver\Deriver\Evaluator\Execution\Offset\Transfer;
50use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
51use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
52use Deriver\Deriver\Evaluator\Execution\State;
53use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
54use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
55use Deriver\Deriver\Evaluator\Execution\Summary\Invocation;
56use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
57use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
58use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
59use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
60use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
61use Deriver\Deriver\Evaluator\Request\Budget;
62use Deriver\Deriver\Evaluator\Request\EntryPoint;
63use Deriver\Deriver\Evaluator\Request\QueryScope;
64use Deriver\Deriver\Evaluator\Request\ReturnQuery;
65use Deriver\Deriver\Evaluator\Scalar\Arithmetic;
66use Deriver\Deriver\Evaluator\Scalar\Arrays;
67use Deriver\Deriver\Evaluator\Scalar\Identity;
68use Deriver\Deriver\Evaluator\Scalar\Operations;
69use Deriver\Deriver\Evaluator\TargetProfile;
70use Deriver\Deriver\Evaluator\Term;
71use Deriver\Deriver\Evaluator\TermKind;
72use Deriver\Deriver\Execution\DerivationResult;
73use Deriver\Deriver\Execution\QueryExecution;
74use Deriver\Deriver\Execution\ResultAssessment;
75use Deriver\Deriver\Identity\QueryEncoding;
76use Deriver\Deriver\Identity\ValueGraph;
77use Deriver\Deriver\Lowerer\AggregateLowering;
78use Deriver\Deriver\Lowerer\AssignmentLowering;
79use Deriver\Deriver\Lowerer\Control\DestructuringLowering;
80use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
81use Deriver\Deriver\Lowerer\Declaration\CallableSource;
82use Deriver\Deriver\Lowerer\Declaration\Index;
83use Deriver\Deriver\Lowerer\Declaration\Indexer;
84use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
85use Deriver\Deriver\Lowerer\ExpressionLowering;
86use Deriver\Deriver\Lowerer\Graph\BasicBlock;
87use Deriver\Deriver\Lowerer\Graph\CallableGraph;
88use Deriver\Deriver\Lowerer\Graph\Instruction;
89use Deriver\Deriver\Lowerer\Graph\Terminator;
90use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
91use Deriver\Deriver\Lowerer\InstructionEmitter;
92use Deriver\Deriver\Lowerer\Lowerer;
93use Deriver\Deriver\Lowerer\LoweringScope;
94use Deriver\Deriver\Lowerer\StatementLowering;
95use Deriver\Deriver\MicroEvaluatorConversion;
96use Deriver\Deriver\Parser\Node\File;
97use Deriver\Deriver\Parser\Parser;
98use Deriver\Deriver\Parser\ParserConfig;
99use Deriver\Deriver\Parser\TargetSyntax;
100use Deriver\Deriver\Providers\ProviderExpansion;
101use Deriver\Deriver\Resolver\AssignmentPatterns;
102use Deriver\Deriver\Resolver\ClassScope;
103use Deriver\Deriver\Resolver\ExpressionValidation;
104use Deriver\Deriver\Resolver\MagicContext;
105use Deriver\Deriver\Resolver\Resolver;
106use Deriver\Deriver\Selection\QueryValidation;
107use Deriver\Deriver\SnapshotIdentity;
108use Deriver\Deriver\Sources\LineMap;
109use Deriver\Deriver\Sources\Path as SourcesPath;
110use Deriver\Deriver\Sources\Source;
111use Deriver\Deriver\Sources\SourceRef;
112use Deriver\Deriver\Sources\Sources;
113use Deriver\Exception\ParserException;
114use Deriver\Exception\ResolutionException;
115use PHPUnit\Framework\Attributes\CoversClass;
116use PHPUnit\Framework\Attributes\Small;
117use PHPUnit\Framework\Attributes\UsesClass;
118use PHPUnit\Framework\TestCase;
119
120#[UsesClass(Resolver::class)]
121#[UsesClass(ExpressionValidation::class)]
122#[UsesClass(ResolutionException::class)]
123#[UsesClass(ParserConfig::class)]
124#[UsesClass(ParserException::class)]
125#[CoversClass(Arrays::class)]
126#[UsesClass(QueryExecution::class)]
127#[UsesClass(QueryValidation::class)]
128#[UsesClass(ResultAssessment::class)]
129#[UsesClass(Deriver::class)]
130#[UsesClass(BasicBlock::class)]
131#[UsesClass(CallableGraph::class)]
132#[UsesClass(CallableIdentity::class)]
133#[UsesClass(Instruction::class)]
134#[UsesClass(Terminator::class)]
135#[UsesClass(ArgumentBinding::class)]
136#[UsesClass(ArgumentOrder::class)]
137#[UsesClass(Dispatch::class)]
138#[UsesClass(TypeBinding::class)]
139#[UsesClass(TypeCheck::class)]
140#[UsesClass(Completion::class)]
141#[UsesClass(Context::class)]
142#[UsesClass(ObservationLimit::class)]
143#[UsesClass(StateJoin::class)]
144#[UsesClass(Unwinding::class)]
145#[UsesClass(Cell::class)]
146#[UsesClass(Components::class)]
147#[UsesClass(Discovery::class)]
148#[UsesClass(Key::class)]
149#[UsesClass(Table::class)]
150#[UsesClass(Dependencies::class)]
151#[UsesClass(InstructionTransfer::class)]
152#[UsesClass(Evaluator::class)]
153#[UsesClass(SlotReference::class)]
154#[UsesClass(ObservationCollector::class)]
155#[UsesClass(Address::class)]
156#[UsesClass(Path::class)]
157#[UsesClass(Transfer::class)]
158#[UsesClass(Conversions::class)]
159#[UsesClass(ScalarErrors::class)]
160#[UsesClass(State::class)]
161#[UsesClass(CompletionRecord::class)]
162#[UsesClass(Evaluation::class)]
163#[UsesClass(Invocation::class)]
164#[UsesClass(Isolation::class)]
165#[UsesClass(MemoryStep::class)]
166#[UsesClass(PureStep::class)]
167#[UsesClass(ReferenceAssignment::class)]
168#[UsesClass(Location::class)]
169#[UsesClass(Materialization::class)]
170#[UsesClass(Memory::class)]
171#[UsesClass(ReferenceConstraint::class)]
172#[UsesClass(StorageCapture::class)]
173#[UsesClass(Extensions::class)]
174#[UsesClass(ProviderExpansion::class)]
175#[UsesClass(Evaluators::class)]
176#[UsesClass(StateRegistry::class)]
177#[UsesClass(DeriverConfig::class)]
178#[UsesClass(EntryPoint::class)]
179#[UsesClass(Sources::class)]
180#[UsesClass(SourcesPath::class)]
181#[UsesClass(Snapshot::class)]
182#[UsesClass(Source::class)]
183#[UsesClass(TargetProfile::class)]
184#[UsesClass(Budget::class)]
185#[UsesClass(QueryScope::class)]
186#[UsesClass(ReturnQuery::class)]
187#[UsesClass(ResultRef::class)]
188#[UsesClass(SourceRef::class)]
189#[UsesClass(Alternative::class)]
190#[UsesClass(Assessment::class)]
191#[UsesClass(Derivation::class)]
192#[UsesClass(DerivationResult::class)]
193#[UsesClass(QueryEncoding::class)]
194#[UsesClass(ValueGraph::class)]
195#[UsesClass(Statistics::class)]
196#[UsesClass(StorageSnapshot::class)]
197#[UsesClass(Parser::class)]
198#[UsesClass(File::class)]
199#[UsesClass(AggregateLowering::class)]
200#[UsesClass(AssignmentLowering::class)]
201#[UsesClass(Lowerer::class)]
202#[UsesClass(DestructuringLowering::class)]
203#[UsesClass(ExpressionLowering::class)]
204#[UsesClass(InstructionEmitter::class)]
205#[UsesClass(LoweringScope::class)]
206#[UsesClass(StatementLowering::class)]
207#[UsesClass(CallableSource::class)]
208#[UsesClass(Indexer::class)]
209#[UsesClass(Index::class)]
210#[UsesClass(Composition::class)]
211#[UsesClass(LineMap::class)]
212#[UsesClass(MagicContext::class)]
213#[UsesClass(AssignmentPatterns::class)]
214#[UsesClass(ClassScope::class)]
215#[UsesClass(TargetSyntax::class)]
216#[UsesClass(Arithmetic::class)]
217#[UsesClass(Identity::class)]
218#[UsesClass(Operations::class)]
219#[UsesClass(Term::class)]
220#[Small]
221final class ArraysTest extends TestCase
222{
223    public function testNextPreservesTheSemanticContract(): void
224    {
225        $source = '<?php function target(){$a=[-5=>"first"];$a[]="next";return $a;}';
226        $symbol = 'target';
227        $input = new Sources([new Source('fixture.php', $source)]);
228        $configuration = new DeriverConfig();
229        $contributions = new Contributions();
230        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
231        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
232        $contributions1 = $providers->contributions;
233        $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);
234        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
235        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
236        $snapshotId = $identity->id;
237        $input1 = $providers->input;
238        $parser = new Parser(new ParserConfig($target->version));
239        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(SourcesPath::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
240        $program = new Index($snapshotId, $trees);
241        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
242        self::assertSame([-5 => 'first', -4 => 'next'], $result->normalOutcomes[0]->values['return']->native());
243        self::assertSame([], $result->frontiers);
244        self::assertSame([], $result->exceptionalOutcomes);
245    }
246    public function testNextUsesPhp83NegativeAppendRules(): void
247    {
248        self::assertSame(-4, (new Arrays())->next(Term::fromNative([-5 => 1])));
249    }
250    public function testSetNormalizesIntegerKeys(): void
251    {
252        $result = (new Arrays())->set(Term::array([]), Term::constant('2'), Term::constant('value'));
253        self::assertSame([2 => 'value'], $result->native());
254    }
255    public function testMergeReindexesNumericKeys(): void
256    {
257        $result = (new Arrays())->merge(Term::fromNative([5 => 'a', 'x' => 1]), Term::fromNative([9 => 'b', 'x' => 2]));
258        self::assertSame([5 => 'a', 'x' => 2, 6 => 'b'], $result->native());
259    }
260    public function testAppendKeyKeepsTheMaximumCounterReusableAfterUnset(): void
261    {
262        $arrays = new Arrays();
263        $occupied = Term::array([PHP_INT_MAX => Term::constant(1)]);
264        self::assertSame('Error', $arrays->appendKey($occupied)->literal);
265        $removed = new Term(TermKind::Array, operands: [], attributes: ['open' => false, 'next' => PHP_INT_MAX]);
266        self::assertSame(PHP_INT_MAX, $arrays->appendKey($removed)->literal);
267        self::assertSame([PHP_INT_MAX => 2], $arrays->set($removed, null, Term::constant(2))->native());
268    }
269    public function testSetRejectsIllegalKeysAndRetainsUnknownAppendPosition(): void
270    {
271        $arrays = new Arrays();
272        self::assertSame('TypeError', $arrays->set(Term::array([]), Term::array([]), Term::constant(1))->literal);
273        $open = $arrays->set(Term::array([], true), null, Term::constant(1));
274        self::assertSame([], $open->operands);
275        self::assertTrue($open->attributes['open']);
276    }
277    public function testMergeRetainsTheUnknownOverwriteAndFollowingAppend(): void
278    {
279        $left = Term::fromNative(['a' => 1]);
280        $right = Term::parameter('values', 'array');
281        $arrays = new Arrays();
282        $merged = $arrays->merge($left, $right);
283        self::assertSame(TermKind::ArrayMerge, $merged->kind);
284        self::assertSame([$left, $right], $merged->operands);
285        self::assertSame('array', $merged->attributes['type']);
286        $updated = $arrays->set($merged, null, Term::constant(7));
287        self::assertSame(TermKind::ArraySet, $updated->kind);
288        self::assertSame($merged, $updated->operands[0]);
289        self::assertSame(TermKind::Append, $updated->operands[1]->kind);
290        self::assertSame(7, $updated->operands[2]->literal);
291    }
292    public function testMergeRetainsEitherOpenRemainderAndUnknownDestination(): void
293    {
294        $open = Term::array(['a' => Term::constant(1)], true);
295        $closed = Term::fromNative(['a' => 2]);
296        $arrays = new Arrays();
297        self::assertSame(TermKind::ArrayMerge, $arrays->merge($open, $closed)->kind);
298        self::assertSame(TermKind::ArrayMerge, $arrays->merge($closed, $open)->kind);
299        self::assertSame(TermKind::ArrayMerge, $arrays->merge(Term::parameter('a', 'array'), $closed)->kind);
300    }
301    public function testHeadKeepsOnlyClosedIntegerKeyedDestinationsOfMerges(): void
302    {
303        $arrays = new Arrays();
304        $head = Term::fromNative(['id', 'name']);
305        $unknown = Term::parameter('x', 'array');
306        $merge = $arrays->merge($head, $unknown);
307        self::assertSame($head, $arrays->head($merge));
308        self::assertSame($head, $arrays->head($arrays->merge($merge, Term::parameter('y', 'array'))));
309        self::assertNull($arrays->head($head));
310        self::assertNull($arrays->head($arrays->merge(Term::fromNative(['k' => 'id']), $unknown)));
311        self::assertNull($arrays->head($arrays->merge(Term::array([]), $unknown)));
312        self::assertNull($arrays->head($arrays->merge(Term::array([Term::constant('id')], true), $unknown)));
313    }
314    public function testSplitSeparatesOnlyASingleMergeLevel(): void
315    {
316        $arrays = new Arrays();
317        $head = Term::fromNative(['id']);
318        $unknown = Term::parameter('x', 'array');
319        $merge = $arrays->merge($head, $unknown);
320        self::assertSame([$head, $unknown], $arrays->split($merge));
321        self::assertNull($arrays->split($arrays->merge($merge, Term::parameter('y', 'array'))));
322    }
323    public function testAppendableRequiresRoomForEveryMergedSource(): void
324    {
325        $arrays = new Arrays();
326        $unknown = Term::parameter('x', 'array');
327        self::assertTrue($arrays->appendable(Term::fromNative(['k' => 1, 5 => 2])));
328        self::assertTrue($arrays->appendable($arrays->merge(Term::fromNative([1]), $unknown)));
329        self::assertTrue($arrays->appendable(Term::array([PHP_INT_MAX - 4294967297 => Term::constant(1)])));
330        self::assertFalse($arrays->appendable(Term::array([PHP_INT_MAX - 4294967296 => Term::constant(1)])));
331        self::assertFalse($arrays->appendable($arrays->merge(Term::array([PHP_INT_MAX - 4294967297 => Term::constant(1)]), $unknown)));
332        self::assertFalse($arrays->appendable(Term::array([], true)));
333        self::assertFalse($arrays->appendable($unknown));
334    }
335    public function testSetRetainsExplicitKeysAfterAnUnknownMerge(): void
336    {
337        $array = Term::parameter('a', 'array');
338        $key = Term::constant('known');
339        $value = Term::constant(4);
340        $result = (new Arrays())->set($array, $key, $value);
341        self::assertSame([$array, $key, $value], $result->operands);
342        self::assertSame('array', $result->attributes['type']);
343    }
344    public function testNextUsesTheLargestIntegerKeyAndZeroForOnlyNamedKeys(): void
345    {
346        $arrays = new Arrays();
347        self::assertSame(0, $arrays->next(new Term(TermKind::Array)));
348        self::assertSame(0, $arrays->next(Term::fromNative(['named' => 1])));
349        self::assertSame(11, $arrays->next(Term::fromNative([10 => 1, 2 => 2, -3 => 3])));
350        self::assertSame(-1, $arrays->next(Term::fromNative([-2 => 1, -5 => 2])));
351    }
352    public function testSetRetainsEarlierAppendHistoryAndOpenRemainders(): void
353    {
354        $arrays = new Arrays();
355        $history = new Term(TermKind::Array, operands: [], attributes: ['next' => 9]);
356        $result = $arrays->set($history, Term::constant(2), Term::constant('new'));
357        self::assertSame(9, $arrays->next($result));
358        self::assertSame([2 => 'new'], $result->native());
359        $open = $arrays->set(Term::array(['a' => Term::constant(1)], true), Term::constant('b'), Term::constant(2));
360        self::assertTrue($open->attributes['open']);
361        self::assertNull($arrays->next($open));
362        self::assertSame(['a', 'b'], array_keys($open->operands));
363    }
364    public function testSetUnknownKeysKeepKnownPresenceWithoutKeepingStaleValues(): void
365    {
366        $previous = Term::constant(1);
367        $next = Term::constant(2);
368        $array = Term::array(['a' => $previous]);
369        $result = (new Arrays())->set($array, Term::parameter('key', 'string'), $next);
370        self::assertTrue($result->attributes['open']);
371        self::assertSame(['a'], array_keys($result->operands));
372        self::assertSame(TermKind::Opaque, $result->operands['a']->kind);
373        self::assertSame($previous, $result->operands['a']->operands[0]);
374        self::assertSame($next, $result->operands['a']->operands[1]);
375        self::assertSame(TermKind::ArrayKey, $result->operands['a']->operands[2]->kind);
376    }
377    public function testAppendKeyKeepsItsUnknownSourceDependency(): void
378    {
379        $array = Term::array([], true);
380        $result = (new Arrays())->appendKey($array);
381        self::assertSame('UNKNOWN_APPEND_INDEX', $result->literal);
382        self::assertSame('int', $result->attributes['type']);
383        self::assertSame([$array], $result->operands);
384    }
385    public function testMergeTreatsShapesWithoutRemainderMetadataAsClosed(): void
386    {
387        $result = (new Arrays())->merge(new Term(TermKind::Array, operands: ['a' => Term::constant(1)]), new Term(TermKind::Array, operands: [Term::constant(2)]));
388        self::assertSame(['a' => 1, 0 => 2], $result->native());
389    }
390    public function testMergeStopsAtTheFirstAppendFailure(): void
391    {
392        $result = (new Arrays())->merge(Term::fromNative([PHP_INT_MAX => 1]), Term::fromNative([2, 3]));
393        self::assertSame(TermKind::Throwable, $result->kind);
394        self::assertSame('Error', $result->literal);
395    }
396    public function testTailKeepsOnlyAppendSuffixesWithAvailableIndices(): void
397    {
398        $arrays = new Arrays();
399        $prefix = $arrays->merge(Term::array([]), Term::parameter('x', 'array'));
400        $array = $arrays->set($arrays->set($prefix, null, Term::constant('a')), null, Term::constant('z'));
401        $tail = $arrays->tail($array);
402        self::assertNotNull($tail);
403        self::assertSame($prefix, $tail[0]);
404        self::assertSame(['a', 'z'], $tail[1]->native());
405        self::assertNull($arrays->tail($arrays->set($prefix, Term::constant('key'), Term::constant('z'))));
406    }
407}
408