packages/deriver/tests/Unit/Deriver/Evaluator/Scalar/ComparisonTest.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\Constraints;
28use Deriver\Deriver\Evaluator\Execution\Context;
29use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
30use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
31use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
32use Deriver\Deriver\Evaluator\Execution\Demand\Cell;
33use Deriver\Deriver\Evaluator\Execution\Demand\Components;
34use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
35use Deriver\Deriver\Evaluator\Execution\Demand\Key;
36use Deriver\Deriver\Evaluator\Execution\Demand\Table;
37use Deriver\Deriver\Evaluator\Execution\Dependencies;
38use Deriver\Deriver\Evaluator\Execution\Evaluator;
39use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
40use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
41use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
42use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
43use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
44use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
45use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
46use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
47use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
48use Deriver\Deriver\Evaluator\Execution\State;
49use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
50use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
51use Deriver\Deriver\Evaluator\Execution\Summary\Invocation;
52use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
53use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
54use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
55use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
56use Deriver\Deriver\Evaluator\Request\Budget;
57use Deriver\Deriver\Evaluator\Request\EntryPoint;
58use Deriver\Deriver\Evaluator\Request\QueryScope;
59use Deriver\Deriver\Evaluator\Request\ReturnQuery;
60use Deriver\Deriver\Evaluator\Scalar\Arithmetic;
61use Deriver\Deriver\Evaluator\Scalar\Comparison;
62use Deriver\Deriver\Evaluator\Scalar\FloatConversion;
63use Deriver\Deriver\Evaluator\Scalar\Identity;
64use Deriver\Deriver\Evaluator\Scalar\Operations;
65use Deriver\Deriver\Evaluator\TargetProfile;
66use Deriver\Deriver\Evaluator\Term;
67use Deriver\Deriver\Evaluator\TermKind;
68use Deriver\Deriver\Execution\DerivationResult;
69use Deriver\Deriver\Execution\QueryExecution;
70use Deriver\Deriver\Execution\ResultAssessment;
71use Deriver\Deriver\Identity\QueryEncoding;
72use Deriver\Deriver\Identity\ValueGraph;
73use Deriver\Deriver\Lowerer\Control\ConditionalLowering;
74use Deriver\Deriver\Lowerer\Control\MatchLowering;
75use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
76use Deriver\Deriver\Lowerer\Declaration\CallableSource;
77use Deriver\Deriver\Lowerer\Declaration\Index;
78use Deriver\Deriver\Lowerer\Declaration\Indexer;
79use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
80use Deriver\Deriver\Lowerer\ExpressionLowering;
81use Deriver\Deriver\Lowerer\Graph\BasicBlock;
82use Deriver\Deriver\Lowerer\Graph\CallableGraph;
83use Deriver\Deriver\Lowerer\Graph\Instruction;
84use Deriver\Deriver\Lowerer\Graph\Terminator;
85use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
86use Deriver\Deriver\Lowerer\InstructionEmitter;
87use Deriver\Deriver\Lowerer\Lowerer;
88use Deriver\Deriver\Lowerer\LoweringScope;
89use Deriver\Deriver\Lowerer\StatementLowering;
90use Deriver\Deriver\MicroEvaluatorConversion;
91use Deriver\Deriver\Parser\Node\File;
92use Deriver\Deriver\Parser\Parser;
93use Deriver\Deriver\Parser\ParserConfig;
94use Deriver\Deriver\Parser\TargetSyntax;
95use Deriver\Deriver\Providers\ProviderExpansion;
96use Deriver\Deriver\Resolver\AssignmentPatterns;
97use Deriver\Deriver\Resolver\ClassScope;
98use Deriver\Deriver\Resolver\ExpressionValidation;
99use Deriver\Deriver\Resolver\MagicContext;
100use Deriver\Deriver\Resolver\Resolver;
101use Deriver\Deriver\Selection\QueryValidation;
102use Deriver\Deriver\SnapshotIdentity;
103use Deriver\Deriver\Sources\LineMap;
104use Deriver\Deriver\Sources\Path;
105use Deriver\Deriver\Sources\Source;
106use Deriver\Deriver\Sources\SourceRef;
107use Deriver\Deriver\Sources\Sources;
108use Deriver\Exception\ParserException;
109use Deriver\Exception\ResolutionException;
110use PHPUnit\Framework\Attributes\CoversClass;
111use PHPUnit\Framework\Attributes\DataProvider;
112use PHPUnit\Framework\Attributes\Small;
113use PHPUnit\Framework\Attributes\UsesClass;
114use PHPUnit\Framework\TestCase;
115
116#[UsesClass(Resolver::class)]
117#[UsesClass(ExpressionValidation::class)]
118#[UsesClass(ResolutionException::class)]
119#[UsesClass(ParserConfig::class)]
120#[UsesClass(ParserException::class)]
121#[CoversClass(Comparison::class)]
122#[UsesClass(QueryExecution::class)]
123#[UsesClass(QueryValidation::class)]
124#[UsesClass(ResultAssessment::class)]
125#[UsesClass(Deriver::class)]
126#[UsesClass(Constraints::class)]
127#[UsesClass(BasicBlock::class)]
128#[UsesClass(CallableGraph::class)]
129#[UsesClass(CallableIdentity::class)]
130#[UsesClass(Instruction::class)]
131#[UsesClass(Terminator::class)]
132#[UsesClass(ArgumentBinding::class)]
133#[UsesClass(ArgumentOrder::class)]
134#[UsesClass(Dispatch::class)]
135#[UsesClass(TypeBinding::class)]
136#[UsesClass(TypeCheck::class)]
137#[UsesClass(Completion::class)]
138#[UsesClass(Context::class)]
139#[UsesClass(ObservationLimit::class)]
140#[UsesClass(StateJoin::class)]
141#[UsesClass(Unwinding::class)]
142#[UsesClass(Cell::class)]
143#[UsesClass(Components::class)]
144#[UsesClass(Discovery::class)]
145#[UsesClass(Key::class)]
146#[UsesClass(Table::class)]
147#[UsesClass(Dependencies::class)]
148#[UsesClass(InstructionTransfer::class)]
149#[UsesClass(Evaluator::class)]
150#[UsesClass(SlotReference::class)]
151#[UsesClass(ObservationCollector::class)]
152#[UsesClass(Conversions::class)]
153#[UsesClass(ScalarErrors::class)]
154#[UsesClass(State::class)]
155#[UsesClass(CompletionRecord::class)]
156#[UsesClass(Evaluation::class)]
157#[UsesClass(Invocation::class)]
158#[UsesClass(Isolation::class)]
159#[UsesClass(PureStep::class)]
160#[UsesClass(ReferenceAssignment::class)]
161#[UsesClass(Materialization::class)]
162#[UsesClass(Memory::class)]
163#[UsesClass(StorageCapture::class)]
164#[UsesClass(Extensions::class)]
165#[UsesClass(ProviderExpansion::class)]
166#[UsesClass(Evaluators::class)]
167#[UsesClass(StateRegistry::class)]
168#[UsesClass(DeriverConfig::class)]
169#[UsesClass(EntryPoint::class)]
170#[UsesClass(Sources::class)]
171#[UsesClass(Path::class)]
172#[UsesClass(Snapshot::class)]
173#[UsesClass(Source::class)]
174#[UsesClass(TargetProfile::class)]
175#[UsesClass(Budget::class)]
176#[UsesClass(QueryScope::class)]
177#[UsesClass(ReturnQuery::class)]
178#[UsesClass(ResultRef::class)]
179#[UsesClass(SourceRef::class)]
180#[UsesClass(Alternative::class)]
181#[UsesClass(Assessment::class)]
182#[UsesClass(Derivation::class)]
183#[UsesClass(DerivationResult::class)]
184#[UsesClass(QueryEncoding::class)]
185#[UsesClass(ValueGraph::class)]
186#[UsesClass(Statistics::class)]
187#[UsesClass(StorageSnapshot::class)]
188#[UsesClass(Parser::class)]
189#[UsesClass(File::class)]
190#[UsesClass(Lowerer::class)]
191#[UsesClass(ConditionalLowering::class)]
192#[UsesClass(MatchLowering::class)]
193#[UsesClass(ExpressionLowering::class)]
194#[UsesClass(InstructionEmitter::class)]
195#[UsesClass(LoweringScope::class)]
196#[UsesClass(StatementLowering::class)]
197#[UsesClass(CallableSource::class)]
198#[UsesClass(Indexer::class)]
199#[UsesClass(Index::class)]
200#[UsesClass(Composition::class)]
201#[UsesClass(LineMap::class)]
202#[UsesClass(MagicContext::class)]
203#[UsesClass(AssignmentPatterns::class)]
204#[UsesClass(ClassScope::class)]
205#[UsesClass(TargetSyntax::class)]
206#[UsesClass(Arithmetic::class)]
207#[UsesClass(FloatConversion::class)]
208#[UsesClass(Identity::class)]
209#[UsesClass(Operations::class)]
210#[UsesClass(Term::class)]
211#[Small]
212final class ComparisonTest extends TestCase
213{
214    public function testApplyPreservesTheSemanticContract(): void
215    {
216        $source = '<?php function target(){return match(2){1=>"a",2=>"b",default=>"c"};}';
217        $symbol = 'target';
218        $input = new Sources([new Source('fixture.php', $source)]);
219        $configuration = new DeriverConfig();
220        $contributions = new Contributions();
221        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
222        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
223        $contributions1 = $providers->contributions;
224        $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);
225        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
226        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
227        $snapshotId = $identity->id;
228        $input1 = $providers->input;
229        $parser = new Parser(new ParserConfig($target->version));
230        $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));
231        $program = new Index($snapshotId, $trees);
232        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
233        self::assertSame('b', $result->normalOutcomes[0]->values['return']->native());
234        self::assertSame([], $result->frontiers);
235        self::assertSame([], $result->exceptionalOutcomes);
236    }
237    public function testScalarPreservesPhpNumericStringAndStrictComparisons(): void
238    {
239        $comparison = new Comparison();
240        self::assertSame(true, $comparison->scalar('==', 2, '2'));
241        self::assertSame(false, $comparison->scalar('===', 2, '2'));
242        self::assertSame(-1, $comparison->scalar('<=>', 2, 3));
243    }
244    public function testIdenticalComparesSharedArrayGraphsWithoutExpandingPaths(): void
245    {
246        $depth = 64;
247        $leaf = Term::constant(1);
248        $leaf = array_reduce(array_fill(0, $depth, null), static fn (Term $leaf): Term => Term::array([$leaf, $leaf]), $leaf);
249        $a = $leaf;
250        $depth1 = 64;
251        $leaf1 = Term::constant(1);
252        $leaf1 = array_reduce(array_fill(0, $depth1, null), static fn (Term $leaf1): Term => Term::array([$leaf1, $leaf1]), $leaf1);
253        $b = $leaf1;
254        $depth2 = 64;
255        $leaf2 = Term::constant(2);
256        $leaf2 = array_reduce(array_fill(0, $depth2, null), static fn (Term $leaf2): Term => Term::array([$leaf2, $leaf2]), $leaf2);
257        $c = $leaf2;
258        $comparison = new Comparison();
259        self::assertTrue($comparison->identical($a, $b));
260        self::assertFalse($comparison->identical($a, $c));
261    }
262    public function testIdenticalPreservesNaNAndSignedZeroSemantics(): void
263    {
264        $comparison = new Comparison();
265        $nan = Term::array([Term::constant(NAN)]);
266        self::assertFalse($comparison->identical($nan, $nan));
267        self::assertTrue($comparison->identical(Term::fromNative([-0.0]), Term::fromNative([0.0])));
268    }
269    public function testIdenticalPreservesKeyOrderAndScalarTypes(): void
270    {
271        $comparison = new Comparison();
272        self::assertFalse($comparison->identical(Term::fromNative(['a' => 1, 'b' => 2]), Term::fromNative(['b' => 2, 'a' => 1])));
273        self::assertFalse($comparison->identical(Term::fromNative([1]), Term::fromNative([1.0])));
274        self::assertFalse($comparison->identical(Term::parameter('x'), Term::parameter('x')));
275    }
276    public function testObjectDistinguishesClosureAllocationIdentities(): void
277    {
278        $a = new Term(TermKind::Closure, 'same-body', attributes: ['identity' => 'first']);
279        $b = new Term(TermKind::Closure, 'same-body', attributes: ['identity' => 'second']);
280        $comparison = new Comparison();
281        self::assertTrue($comparison->object('===', $a, $a)?->native());
282        self::assertFalse($comparison->object('===', $a, $b)?->native());
283        self::assertTrue($comparison->object('!==', $a, $b)?->native());
284        self::assertNull($comparison->object('==', $a, $b));
285    }
286    public function testObjectComparesTheSameIdentity(): void
287    {
288        $result = (new Comparison())->object('===', new Term(TermKind::Object, 'one'), new Term(TermKind::Object, 'one'));
289        self::assertNotNull($result);
290    }
291    /**
292     * @param string $operator
293     * @param scalar|null $left
294     * @param scalar|null $right
295     * @param bool|int $expected
296     */
297    #[DataProvider('providerScalarComparisons')]
298    public function testScalarKeepsEqualityOrderingAndNumericStringRules(string $operator, int|float|string|bool|null $left, int|float|string|bool|null $right, bool|int $expected): void
299    {
300        self::assertSame($expected, (new Comparison())->scalar($operator, $left, $right));
301    }
302    /**
303     * @return list<array{string, scalar|null, scalar|null, bool|int}>
304     */
305    public static function providerScalarComparisons(): array
306    {
307        return [['===', 1, 1, true], ['===', 1, '1', false], ['!==', 1, '1', true], ['!==', 1, 1, false], ['==', 1, '1', true], ['==', 1, 'x', false], ['!=', 1, '1', false], ['!=', 1, 'x', true], ['<', 1, 2, true], ['<', 1, 1, false], ['<=', 1, 1, true], ['<=', 2, 1, false], ['>', 2, 1, true], ['>', 1, 1, false], ['>=', 1, 1, true], ['>=', 1, 2, false], ['<=>', 1, 2, -1], ['<=>', 2, 1, 1], ['<=>', 1, 1, 0], ['unknown', 1, 1, false], ['==', null, false, true], ['==', '10', '2', false], ['>', '10', '2', true]];
308    }
309    public function testApplyPreservesSymbolicOperandsAndResultCategories(): void
310    {
311        $comparison = new Comparison();
312        $left = Term::parameter('left', 'int');
313        $right = Term::constant(3);
314        $ordered = $comparison->apply('<=>', $left, $right);
315        self::assertSame(['binary', '<=>', [$left, $right], ['type' => 'int']], [$ordered->kind->value, $ordered->literal, $ordered->operands, $ordered->attributes]);
316        self::assertSame('bool', $comparison->apply('===', $left, $right)->attributes['type']);
317    }
318    public function testIdenticalRequiresOrderedKeysAndRecursivelyIdenticalTypes(): void
319    {
320        $comparison = new Comparison();
321        self::assertFalse($comparison->identical(Term::parameter('a'), Term::constant(1)));
322        self::assertFalse($comparison->identical(Term::constant(1), Term::parameter('b')));
323        self::assertFalse($comparison->identical(Term::array([]), Term::constant(null)));
324        self::assertFalse($comparison->identical(Term::fromNative(['a' => 1, 'b' => 2]), Term::fromNative(['b' => 2, 'a' => 1])));
325        self::assertFalse($comparison->identical(Term::fromNative([[1]]), Term::fromNative([['1']])));
326        self::assertTrue($comparison->identical(Term::fromNative([[1]]), Term::fromNative([[1]])));
327        self::assertTrue($comparison->apply('!==', Term::fromNative([1]), Term::fromNative([2]))->native());
328        self::assertFalse($comparison->apply('!==', Term::fromNative([1]), Term::fromNative([1]))->native());
329    }
330    public function testObjectUsesAllocationIdentityForObjectsEnumsAndClosures(): void
331    {
332        $comparison = new Comparison();
333        $object = new Term(TermKind::Object, 'same');
334        self::assertTrue($comparison->object('===', $object, new Term(TermKind::Object, 'same'))?->native());
335        self::assertFalse($comparison->object('!==', $object, new Term(TermKind::Object, 'same'))?->native());
336        self::assertTrue($comparison->object('!==', $object, new Term(TermKind::Object, 'different'))?->native());
337        self::assertTrue($comparison->object('===', new Term(TermKind::Enum, 'E::A'), new Term(TermKind::Enum, 'E::A'))?->native());
338        self::assertFalse($comparison->object('===', new Term(TermKind::Closure, 'body', attributes: ['identity' => 'a']), new Term(TermKind::Closure, 'body', attributes: ['identity' => 'b']))?->native());
339        self::assertNull($comparison->object('===', new Term(TermKind::Closure, 'body'), new Term(TermKind::Closure, 'body')));
340        self::assertNull($comparison->object('===', $object, new Term(TermKind::Enum, 'same')));
341        self::assertNull($comparison->object('==', $object, $object));
342        self::assertNull($comparison->object('===', Term::constant(1), Term::constant(1)));
343    }
344    public function testScalarConvertsFloatsForNonNumericStringsUnderTheCapturedPrecision(): void
345    {
346        self::assertSame(-1, (new Comparison(14))->scalar('<=>', 0.1 + 0.2, '0.3 x'));
347        self::assertSame(1, (new Comparison(-1))->scalar('<=>', 0.1 + 0.2, '0.3 x'));
348    }
349}
350