1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 08:49:52 +01:00
psalm/tests/TypeReconciliation/TypeAlgebraTest.php

1487 lines
52 KiB
PHP
Raw Normal View History

<?php
namespace Psalm\Tests\TypeReconciliation;
2021-12-03 20:11:20 +01:00
use Psalm\Tests\TestCase;
use Psalm\Tests\Traits\InvalidCodeAnalysisTestTrait;
use Psalm\Tests\Traits\ValidCodeAnalysisTestTrait;
class TypeAlgebraTest extends TestCase
{
2021-12-03 20:11:20 +01:00
use InvalidCodeAnalysisTestTrait;
use ValidCodeAnalysisTestTrait;
/**
Add support for strict arrays, fix type alias intersection, fix array_is_list assertion on non-lists (#8395) * Immutable CodeLocation * Remove excess clones * Remove external clones * Remove leftover clones * Fix final clone issue * Immutable storages * Refactoring * Fixes * Fixes * Fix * Fix * Fixes * Simplify * Fixes * Fix * Fixes * Update * Fix * Cache global types * Fix * Update * Update * Fixes * Fixes * Refactor * Fixes * Fix * Fix * More caching * Fix * Fix * Update * Update * Fix * Fixes * Update * Refactor * Update * Fixes * Break one more test * Fix * FIx * Fix * Fix * Fix * Fix * Improve performance and readability * Equivalent logic * Fixes * Revert * Revert "Revert" This reverts commit f9175100c8452c80559234200663fd4c4f4dd889. * Fix * Fix reference bug * Make default TypeVisitor immutable * Bugfix * Remove clones * Partial refactoring * Refactoring * Fixes * Fix * Fixes * Fixes * cs-fix * Fix final bugs * Add test * Misc fixes * Update * Fixes * Experiment with removing different property * revert "Experiment with removing different property" This reverts commit ac1156e077fc4ea633530d51096d27b6e88bfdf9. * Uniform naming * Uniform naming * Hack hotfix * Clean up $_FILES ref #8621 * Undo hack, try fixing properly * Helper method * Remove redundant call * Partially fix bugs * Cleanup * Change defaults * Fix bug * Fix (?, hope this doesn't break anything else) * cs-fix * Review fixes * Bugfix * Bugfix * Improve logic * Add support for list{} and callable-list{} types, properly implement array_is_list assertions (fixes #8389) * Default to sealed arrays * Fix array_merge bug * Fixes * Fix * Sealed type checks * Properly infer properties-of and get_object_vars on final classes * Fix array_map zipping * Fix tests * Fixes * Fixes * Fix more stuff * Recursively resolve type aliases * Fix typo * Fixes * Fix array_is_list assertion on keyed array * Add BC docs * Fixes * fix * Update * Update * Update * Update * Seal arrays with count assertions * Fix #8528 * Fix * Update * Improve sealed array foreach logic * get_object_vars on template properties * Fix sealed array assertion reconciler logic * Improved reconciler * Add tests * Single source of truth for test types * Fix tests * Fixup tests * Fixup tests * Fixup tests * Update * Fix tests * Fix tests * Final fixes * Fixes * Use list syntax only when needed * Fix tests * Cs-fix * Update docs * Update docs * Update docs * Update docs * Update docs * Document missing types * Update docs * Improve class-string-map docs * Update * Update * I love working on psalm :) * Keep arrays unsealed by default * Fixup tests * Fix syntax mistake * cs-fix * Fix typo * Re-import missing types * Keep strict types only in return types * argc/argv fixes * argc/argv fixes * Fix test * Comment-out valinor code, pinging @romm pls merge https://github.com/CuyZ/Valinor/pull/246 so we can add valinor to the psalm docs :)
2022-11-05 22:34:42 +01:00
*
*/
public function providerValidCodeParse(): iterable
{
return [
2019-12-06 20:47:05 +01:00
'twoVarLogicSimple' => [
'code' => '<?php
function foo(?string $a, ?string $b): string {
if ($a !== null || $b !== null) {
if ($a !== null) {
return $a;
} else {
return $b;
}
}
return "foo";
2017-05-27 02:05:57 +02:00
}',
],
'threeVarLogic' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function takesString(string $s): void {}
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b, ?string $c): void {
if ($a !== null || $b !== null || $c !== null) {
if ($a !== null) {
$d = $a;
} elseif ($b !== null) {
$d = $b;
} else {
$d = $c;
}
takesString($d);
}
2017-05-27 02:05:57 +02:00
}',
],
2019-12-06 20:47:05 +01:00
'twoVarLogicNotNestedSimple' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if (!$a && !$b) return "bad";
if (!$a) return $b;
return $a;
2017-05-27 02:05:57 +02:00
}',
],
'twoVarLogicNotNestedWithAllPathsReturning' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if (!$a && !$b) {
return "bad";
} else {
if (!$a) {
return $b;
} else {
return $a;
}
}
2017-05-27 02:05:57 +02:00
}',
],
'twoVarLogicNotNestedWithAssignmentBeforeReturn' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if (!$a && !$b) {
$a = 5;
return "bad";
}
if (!$a) {
$a = 7;
return $b;
}
return $a;
2017-05-27 02:05:57 +02:00
}',
],
'invertedTwoVarLogicNotNested' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if ($a || $b) {
// do nothing
} else {
return "bad";
}
if (!$a) return $b;
return $a;
2017-05-27 02:05:57 +02:00
}',
],
'invertedTwoVarLogicNotNestedWithAssignmentBeforeReturn' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if ($a || $b) {
// do nothing
} else {
$a = 5;
return "bad";
}
if (!$a) return $b;
return $a;
2017-05-27 02:05:57 +02:00
}',
],
'twoVarLogicNotNestedWithElseifAndNoNegations' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if ($a) {
// do nothing
} elseif ($b) {
// do nothing here
} else {
return "bad";
}
if (!$a) return $b;
return $a;
2017-05-27 02:05:57 +02:00
}',
],
2018-05-07 07:26:06 +02:00
'threeVarLogicNotNestedWithNoRedefinitionsWithClasses' => [
'code' => '<?php
2018-05-07 07:26:06 +02:00
function foo(?stdClass $a, ?stdClass $b, ?stdClass $c): stdClass {
if ($a) {
// do nothing
} elseif ($b) {
// do nothing here
} elseif ($c) {
// do nothing here
} else {
return new stdClass;
}
if (!$a && !$b) {
return $c;
}
2018-05-07 07:26:06 +02:00
if (!$a) return $b;
return $a;
}',
],
'threeVarLogicNotNestedWithNoRedefinitionsWithStrings' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b, ?string $c): string {
if ($a) {
// do nothing
} elseif ($b) {
// do nothing here
} elseif ($c) {
// do nothing here
} else {
return "bad";
}
if (!$a && !$b) return $c;
if (!$a) return $b;
return $a;
2017-05-27 02:05:57 +02:00
}',
],
'threeVarLogicNotNestedAndOrWithNoRedefinitions' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b, ?string $c): string {
if ($a) {
// do nothing
} elseif ($b || $c) {
// do nothing here
} else {
return "bad";
}
if (!$a && !$b) return $c;
if (!$a) return $b;
return $a;
2017-05-27 02:05:57 +02:00
}',
],
'twoVarLogicNotNestedWithElseifCorrectlyNegatedInElseIf' => [
'code' => '<?php
function foo(string $a, string $b): string {
if ($a) {
// do nothing here
} elseif ($b) {
2019-12-13 23:52:37 +01:00
$a = null;
} else {
return "bad";
}
if (!$a) return $b;
return $a;
2017-05-27 02:05:57 +02:00
}',
],
'nestedReassignment' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a): void {
if ($a === null) {
$a = "blah-blah";
} else {
$a = rand(0, 1) ? "blah" : null;
if ($a === null) {
}
}
2017-05-27 02:05:57 +02:00
}',
],
'twoVarLogicNotNestedWithElseifCorrectlyReinforcedInIf' => [
'code' => '<?php
class A {}
class B extends A {}
2018-01-11 21:50:45 +01:00
function foo(?A $a, ?A $b): A {
if ($a) {
$a = new B;
} elseif ($b) {
// do nothing
} else {
return new A;
}
if (!$a) return $b;
return $a;
2017-05-27 02:05:57 +02:00
}',
],
'differentValueChecks' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(string $a): void {
if ($a === "foo") {
// do something
} elseif ($a === "bar") {
// can never get here
}
2017-05-27 02:05:57 +02:00
}',
],
'byRefAssignment' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(): void {
preg_match("/hello/", "hello molly", $matches);
if (!$matches) {
return;
}
preg_match("/hello/", "hello dolly", $matches);
if (!$matches) {
}
}',
],
'orConditionalAfterAndConditional' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(string $a, string $b): void {
if ($a && $b) {
echo "a";
} elseif ($a || $b) {
echo "b";
}
}',
],
'issetOnOneStringAfterAnother' => [
'code' => '<?php
/** @param string[] $arr */
2018-01-11 21:50:45 +01:00
function foo(array $arr): void {
$a = "a";
if (!isset($arr[$a])) {
return;
}
foreach ([0, 1, 2, 3] as $i) {
if (!isset($arr[$a . $i])) {
echo "a";
}
$a = "hello";
}
2017-05-27 02:05:57 +02:00
}',
],
'issetArrayCreation' => [
'code' => '<?php
$arr = [];
foreach ([0, 1, 2, 3] as $i) {
$a = rand(0, 1) ? 5 : "010";
if (!isset($arr[(int) $a])) {
$arr[(int) $a] = 5;
} else {
$arr[(int) $a] += 4;
}
}',
],
2018-05-07 23:15:27 +02:00
'moreConvolutedArrayCreation' => [
'code' => '<?php
2018-05-07 23:15:27 +02:00
function fetchRow() : array {
return ["c" => "UK"];
}
$arr = [];
foreach ([1, 2, 3] as $i) {
$row = fetchRow();
if (!isset($arr[$row["c"]])) {
$arr[$row["c"]] = 0;
}
$arr[$row["c"]] = 1;
}',
'assertions' => [],
'ignored_issues' => ['MixedArrayOffset'],
2018-05-07 23:15:27 +02:00
],
'moreConvolutedNestedArrayCreation' => [
'code' => '<?php
2018-05-07 23:15:27 +02:00
function fetchRow() : array {
return ["c" => "UK"];
}
$arr = [];
foreach ([1, 2, 3] as $i) {
$row = fetchRow();
if (!isset($arr[$row["c"]]["foo"])) {
$arr[$row["c"]]["foo"] = 0;
}
$arr[$row["c"]]["foo"] = 1;
}',
'assertions' => [],
'ignored_issues' => ['MixedArrayOffset'],
2018-05-07 23:15:27 +02:00
],
'noParadoxInLoop' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function paradox2(): void {
$condition = rand() % 2 > 0;
if (!$condition) {
foreach ([1, 2] as $value) {
if ($condition) { }
$condition = true;
}
}
}',
],
'noParadoxInListAssignment' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(string $a): void {
if (!$a) {
list($a) = explode(":", "a:b");
if ($a) { }
}
}',
],
'noParadoxAfterAssignment' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function get_bool(): bool {
return rand() % 2 > 0;
}
2018-01-11 21:50:45 +01:00
function leftover(): bool {
$res = get_bool();
if ($res === false) {
return true;
}
$res = get_bool();
if ($res === false) {
return false;
}
return true;
2017-10-12 20:02:06 +02:00
}',
],
'noParadoxAfterArrayAppending' => [
'code' => '<?php
/** @return array|false */
function array_append(array $errors) {
if ($errors) {
return $errors;
}
if (rand() % 2 > 0) {
$errors[] = "unlucky";
}
if ($errors) {
return false;
}
return $errors;
2017-10-12 20:02:06 +02:00
}',
],
'noParadoxInCatch' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function maybe_returns_array(): ?array {
if (rand() % 2 > 0) {
return ["key" => "value"];
}
if (rand() % 3 > 0) {
throw new Exception("An exception occurred");
}
return null;
}
2018-01-11 21:50:45 +01:00
function try_catch_check(): array {
$arr = null;
try {
$arr = maybe_returns_array();
if (!$arr) { return []; }
} catch (Exception $e) {
if (!$arr) { return []; }
}
return $arr;
2017-10-12 20:02:06 +02:00
}',
],
'lotsaTruthyStatements' => [
'code' => '<?php
class A {
/**
* @var ?string
*/
public $a = null;
/**
* @var ?string
*/
public $b = null;
}
function f(A $obj): string {
if (($obj->a !== null) == true) {
return $obj->a; // definitely not null
} elseif (!is_null($obj->b) == true) {
return $obj->b;
} else {
throw new \InvalidArgumentException("$obj->a or $obj->b must be set");
}
}',
],
'lotsaFalsyStatements' => [
'code' => '<?php
class A {
/**
* @var ?string
*/
public $a = null;
/**
* @var ?string
*/
public $b = null;
}
function f(A $obj): string {
if (($obj->a === null) == false) {
return $obj->a; // definitely not null
} elseif (is_null($obj->b) == false) {
return $obj->b;
} else {
throw new \InvalidArgumentException("$obj->a or $obj->b must be set");
}
}',
],
'ifGetClass' => [
'code' => '<?php
class A {}
class B extends A {
2018-01-11 21:50:45 +01:00
public function foo(): void {}
}
2018-01-11 21:50:45 +01:00
function takesA(A $a): void {
if (get_class($a) === B::class) {
$a->foo();
}
}',
],
'ifNotEqualsGetClass' => [
'code' => '<?php
class A {}
class B extends A {
2018-01-11 21:50:45 +01:00
public function foo(): void {}
}
2018-01-11 21:50:45 +01:00
function takesA(A $a): void {
if (get_class($a) !== B::class) {
// do nothing
} else {
$a->foo();
}
}',
],
'nestedCheckWithSingleVarPerLevel' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?stdClass $a, ?stdClass $b): void {
if ($a) {
if ($b) {}
}
}',
],
'nestedCheckWithTwoVarsPerLevel' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?stdClass $a, ?stdClass $b, ?stdClass $c, ?stdClass $d): void {
if ($a && $b) {
if ($c && $d) {}
}
}',
],
'nestedCheckWithReturn' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?stdClass $a, ?stdClass $b): void {
if ($a === null) {
return;
}
if ($b) {
echo "hello";
}
}',
],
'propertyFetchAfterNotNullCheck' => [
'code' => '<?php
class A {
/** @var ?string */
public $foo;
}
$a = new A;
if ($a->foo === null) {
$a->foo = "hello";
exit;
}
if ($a->foo === "somestring") {}',
],
2017-12-11 02:21:21 +01:00
'noParadoxForGetopt' => [
'code' => '<?php
2017-12-11 02:21:21 +01:00
$options = getopt("t:");
try {
if (!isset($options["t"])) {
throw new Exception("bad");
}
} catch (Exception $e) {}',
],
2018-05-06 02:32:04 +02:00
'instanceofInOr' => [
'code' => '<?php
2017-12-18 06:06:23 +01:00
class A {}
class B extends A {}
class C extends A {}
2018-01-11 21:50:45 +01:00
function takesA(A $a): void {}
2017-12-18 06:06:23 +01:00
2018-01-11 21:50:45 +01:00
function foo(?A $a): void {
2017-12-18 06:06:23 +01:00
if ($a instanceof B
|| ($a instanceof C && rand(0, 1))
) {
takesA($a);
}
}',
],
2018-05-06 02:32:04 +02:00
'instanceofInOrNegated' => [
'code' => '<?php
2018-05-06 02:32:04 +02:00
class A {}
class B extends A {}
class C extends A {}
function takesA(A $a): void {}
function foo(?A $a, ?A $b, ?A $c): void {
2018-05-07 07:26:06 +02:00
if (!$a || ($b && $c)) {
2018-05-06 02:32:04 +02:00
return;
}
takesA($a);
}',
],
'instanceofInBothOrs' => [
'code' => '<?php
2018-05-06 02:32:04 +02:00
class A {}
class B extends A {}
class C extends A {}
function takesA(A $a): void {}
function foo(?A $a): void {
if (($a instanceof B && rand(0, 1))
|| ($a instanceof C && rand(0, 1))
) {
takesA($a);
}
}',
],
'instanceofInBothOrsWithSecondVar' => [
'code' => '<?php
2018-05-06 02:32:04 +02:00
class A {}
class B extends A {}
class C extends A {}
function takesA(A $a): void {}
function foo(?A $a, ?A $b): void {
if (($a instanceof B && $b instanceof B)
|| ($a instanceof C && $b instanceof C)
) {
takesA($a);
takesA($b);
}
}',
],
'explosionOfCNF' => [
'code' => '<?php
2018-05-06 02:32:04 +02:00
class A {
/** @var ?string */
public $foo;
/** @var ?string */
public $bar;
}
$a1 = rand(0, 1) ? new A() : null;
$a4 = rand(0, 1) ? new A() : null;
$a5 = rand(0, 1) ? new A() : null;
$a7 = rand(0, 1) ? new A() : null;
$a8 = rand(0, 1) ? new A() : null;
if ($a1 || (($a4 && $a5) || ($a7 && $a8))) {}',
],
'instanceofInCNFOr' => [
'code' => '<?php
class A {}
class B extends A {}
class C extends A {}
2018-01-11 21:50:45 +01:00
function takesA(A $a): void {}
2018-01-11 21:50:45 +01:00
function foo(?A $a): void {
$c = rand(0, 1);
if (($a instanceof B || $a instanceof C)
&& ($a instanceof B || $c)
) {
takesA($a);
}
}',
],
'reconcileNestedOrsInElse' => [
'code' => '<?php
class A {}
class B {}
2018-01-11 21:50:45 +01:00
function takesA(A $a): void {}
2018-01-11 21:50:45 +01:00
function foo(?A $a, ?B $b): void {
if ($a === null || $b === null || rand(0, 1)) {
// do nothing
} else {
takesA($a);
}
}',
],
'getClassComparison' => [
'code' => '<?php
class Foo {
public function bar() : void {}
}
class Bar extends Foo{
public function bar() : void {}
}
class Baz {
public function test(Foo $foo) : void {
if (get_class($foo) !== Foo::class) {
// do nothing
} else {
$foo->bar();
}
}
}',
],
2018-05-06 02:52:10 +02:00
'callWithNonNullInTernary' => [
'code' => '<?php
2018-05-06 02:52:10 +02:00
function sayHello(?int $a, ?int $b): void {
if ($a === null && $b === null) {
throw new \LogicException();
}
takesInt($a !== null ? $a : $b);
}
function takesInt(int $c) : void {}',
],
'callWithNonNullInIf' => [
'code' => '<?php
2018-05-06 02:52:10 +02:00
function sayHello(?int $a, ?int $b): void {
if ($a === null && $b === null) {
throw new \LogicException();
}
if ($a !== null) {
takesInt($a);
} else {
takesInt($b);
}
}
function takesInt(int $c) : void {}',
],
'callWithNonNullInIfWithCallInElseif' => [
'code' => '<?php
2018-05-06 02:52:10 +02:00
function sayHello(?int $a, ?int $b): void {
if ($a === null && $b === null) {
throw new \LogicException();
}
if ($a !== null) {
takesInt($a);
} elseif (rand(0, 1)) {
takesInt($b);
}
}
function takesInt(int $c) : void {}',
],
'typeSimplification' => [
'code' => '<?php
class A {}
class B extends A {}
function foo(A $a, A $b) : ?B {
if (($a instanceof B || !$b instanceof B) && $a instanceof B && $b instanceof B) {
return $a;
}
return null;
}',
],
2018-05-07 07:26:06 +02:00
'instanceofNoRedundant' => [
'code' => '<?php
function logic(Foo $a, Foo $b) : void {
if ((!$a instanceof Bat || !$b instanceof Bat)
&& (!$a instanceof Bat || !$b instanceof Bar)
&& (!$a instanceof Bar || !$b instanceof Bat)
2018-05-07 07:26:06 +02:00
&& (!$a instanceof Bar || !$b instanceof Bar)
) {
} else {
if ($b instanceof Bat) {}
2018-05-07 07:26:06 +02:00
}
}
class Foo {}
class Bar extends Foo {}
class Bat extends Foo {}',
],
2020-03-30 00:28:49 +02:00
'explicitValuesInOrIf' => [
'code' => '<?php
$s = rand(0, 1) ? "a" : "b";
2020-03-30 00:28:49 +02:00
if (($s === "a" && rand(0, 1)) || ($s === "b" && rand(0, 1))) {}',
],
'explicitValuesInOrTernary' => [
'code' => '<?php
2020-03-30 00:28:49 +02:00
$s = rand(0, 1) ? "a" : "b";
2018-05-07 23:52:18 +02:00
$a = (($s === "a" && rand(0, 1)) || ($s === "b" && rand(0, 1))) ? 1 : 0;',
],
2018-05-08 00:09:40 +02:00
'boolComparison' => [
'code' => '<?php
2018-05-08 00:09:40 +02:00
$a = (bool) rand(0, 1);
if (rand(0, 1)) {
$a = null;
}
if ($a !== (bool) rand(0, 1)) {
echo $a === false ? "a" : "b";
}',
],
'stringConcatenationTrackedValid' => [
'code' => '<?php
$x = "a";
$x = "_" . $x;
$array = [$x => 2];
echo $array["_a"];',
],
'noMemoryIssueWithLongConditional' => [
'code' => '<?php
function foo(int $c) : string {
if (!($c >= 0x5be && $c <= 0x10b7f)) {
return "LTR";
}
if ($c <= 0x85e) {
if ($c === 0x5be ||
$c === 0x5c0 ||
$c === 0x5c3 ||
$c === 0x5c6 ||
($c >= 0x5d0 && $c <= 0x5ea) ||
($c >= 0x5f0 && $c <= 0x5f4) ||
$c === 0x608 ||
($c >= 0x712 && $c <= 0x72f) ||
($c >= 0x74d && $c <= 0x7a5) ||
$c === 0x7b1 ||
($c >= 0x7c0 && $c <= 0x7ea) ||
($c >= 0x7f4 && $c <= 0x7f5) ||
$c === 0x7fa ||
($c >= 0x800 && $c <= 0x815) ||
$c === 0x81a ||
$c === 0x824 ||
$c === 0x828 ||
($c >= 0x830 && $c <= 0x83e) ||
($c >= 0x840 && $c <= 0x858) ||
$c === 0x85e
) {
return "RTL";
}
} elseif ($c === 0x200f) {
return "RTL";
} elseif ($c >= 0xfb1d) {
if ($c === 0xfb1d ||
($c >= 0xfb1f && $c <= 0xfb28) ||
($c >= 0xfb2a && $c <= 0xfb36) ||
($c >= 0xfb38 && $c <= 0xfb3c) ||
$c === 0xfb3e ||
($c >= 0x10a10 && $c <= 0x10a13) ||
($c >= 0x10a15 && $c <= 0x10a17) ||
($c >= 0x10a19 && $c <= 0x10a33) ||
($c >= 0x10a40 && $c <= 0x10a47) ||
($c >= 0x10a50 && $c <= 0x10a58) ||
($c >= 0x10a60 && $c <= 0x10a7f) ||
($c >= 0x10b00 && $c <= 0x10b35) ||
($c >= 0x10b40 && $c <= 0x10b55) ||
($c >= 0x10b58 && $c <= 0x10b72) ||
($c >= 0x10b78 && $c <= 0x10b7f)
) {
return "RTL";
}
}
return "LTR";
}',
'assertions' => [],
'ignored_issues' => ['MixedInferredReturnType'],
],
'grandParentInstanceofConfusion' => [
'code' => '<?php
class A {}
class B extends A {}
class C extends B {}
function bad(A $x) : void {
if (($x instanceof C && rand(0, 1)) || rand(0, 1)) {
return;
}
if ($x instanceof B) {
if ($x instanceof C) {}
}
}',
],
'invertEquation' => [
'code' => '<?php
/**
* @param mixed $width
* @param mixed $height
*
* @throws RuntimeException
*/
function Foo($width, $height) : void {
if (!(is_int($width) || is_float($width)) || !(is_int($height) || is_float($height))) {
throw new RuntimeException("bad");
}
echo sprintf("padding-top:%s%%;", 100 * ($height/$width));
2019-07-05 22:24:00 +02:00
}',
],
'invertLogic' => [
'code' => '<?php
class A {}
class B extends A {}
function foo(?A $a) : A {
if (!$a || !($a instanceof B && rand(0, 1))) {
throw new Exception();
}
return $a;
2019-07-05 22:24:00 +02:00
}',
],
'allowAssertionInElseif' => [
'code' => '<?php
class X {
public bool $a = false;
public bool $b = false;
public bool $c = false;
}
function foo(X $x) : void {
$a = false;
if ($x->b && $x->a) {
} elseif ($x->c) {
$a = true;
}
if ($x->c) {}
if ($a) {}
}'
],
'twoVarChangeInElseOnly' => [
'code' => '<?php
class A {
public function takesA(A $a) : void {}
public function foo() : void {}
}
function formatRange(?A $from, ?A $to): void {
if (!$to && !$from) {
$to = new A();
$from = new A();
} elseif (!$from) {
$from = new A();
$from->takesA($to);
} else {
if (!$to) {
$to = new A();
$to->takesA($from);
}
}
$from->foo();
$to->foo();
}'
],
'twoVarChangeInElseif' => [
'code' => '<?php
class A {
public function takesA(A $a) : void {}
public function foo() : void {}
}
function formatRange(?A $from, ?A $to): void {
if (!$to && !$from) {
$to = new A();
$from = new A();
} elseif (!$from) {
$from = new A();
$from->takesA($to);
} elseif (!$to) {
$to = new A();
$to->takesA($from);
}
$from->foo();
$to->foo();
}',
],
'testSimplishThing' => [
'code' => '<?php
function foo(
bool $a,
bool $b,
bool $c,
bool $d,
bool $e,
bool $f,
bool $g,
bool $h,
bool $i,
bool $j
): bool {
return ($a && $b)
|| ($c && $d)
|| ($e && $f)
|| ($g && $h)
|| ($i && $j);
}'
],
2020-08-26 21:35:29 +02:00
'fineCheck' => [
'code' => '<?php
2020-08-26 21:35:29 +02:00
function foo(bool $b, bool $c) : void {
if ((!$b || rand(0, 1)) && (!$c || rand(0, 1))) {}
}'
],
'noParadoxInTernary' => [
'code' => '<?php
function foo(?bool $b) : string {
return $b ? "a" : ($b === null ? "foo" : "b");
}',
],
'cancelOutSameStatement' => [
'code' => '<?php
function edit(?string $a, ?string $b): string {
if ((!$a && !$b) || ($a && !$b)) {
return "";
}
return $b;
}'
],
'cancelOutDifferentStatement' => [
'code' => '<?php
function edit(?string $a, ?string $b): string {
if (!$a && !$b) {
return "";
}
if ($a && !$b) {
return "";
}
return $b;
}'
],
'moreChecks' => [
'code' => '<?php
class B {}
class C {}
function foo(?B $b, ?C $c): B|C {
if (!$b && !$c) {
throw new Exception("bad");
}
if ($b && $c) {
return rand(0, 1) ? $b : $c;
}
if ($b) {
return $b;
}
return $c;
2022-01-22 01:00:45 +01:00
}',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.0',
],
2020-11-24 20:50:35 +01:00
'dependentType' => [
'code' => '<?php
2020-11-24 20:50:35 +01:00
class A {
public function isValid() : bool {
return (bool) rand(0, 1);
}
public function foo() : void {}
}
function takesA(?A $a) : void {
$is_valid_a = $a && $a->isValid();
if ($is_valid_a) {
$a->foo();
}
}'
],
'assignSameName' => [
'code' => '<?php
function foo(string $value): string {
$value = "yes" === $value;
return !$value ? "foo" : "bar";
}'
],
'dependentTypeUsedAfterCall' => [
'code' => '<?php
function a(string $_b): void {}
function foo(?string $c): string {
$iftrue = $c !== null;
if ($c !== null) {
a($c);
}
if ($iftrue) {
return $c;
}
return "";
}'
],
'notNullAfterSuccessfulNullsafeMethodCall' => [
'code' => '<?php
interface X {
public function a(): bool;
public function b(): string;
}
function foo(?X $x): void {
if ($x?->a()) {
echo $x->b();
}
}',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.1',
],
'narrowedTypeAfterIdenticalCheckWithOtherType' => [
'code' => '<?php
function a(int $a, ?int $b = null): void
{
if ($a === $b) {
throw new InvalidArgumentException(sprintf("a can not be the same as b (b: %s).", $b));
}
}'
],
2021-10-25 20:16:58 +02:00
'ThrowableInstanceOfThrowableMayBeFalse' => [
'code' => '<?php
2021-10-25 20:16:58 +02:00
final class Handler
{
/**
* @var class-string<Throwable>[]
*/
private array $dontReport = [];
/**
* @param class-string<Throwable> $throwable
*/
public function dontReport(string $throwable): void
{
$this->dontReport[] = $throwable;
}
public function shouldReport(Throwable $t): bool
{
foreach ($this->dontReport as $tc) {
if ($t instanceof $tc) {
return false;
}
}
return true;
}
}
$h = new Handler();
$h->dontReport(RuntimeException::class);
$h->shouldReport(new Exception());
$h->shouldReport(new RuntimeException());'
],
'ThrowableInstanceOfThrowableMayBeTrue' => [
'code' => '<?php
class Mapper
{
/** @param class-string<Throwable> $class */
final public function map(Throwable $throwable, string $class): ?Throwable
{
if (! $throwable instanceof $class) {
return null;
}
return $throwable;
}
}'
],
'combineTwoOrredClausesWithUnnecessaryTerm' => [
'code' => '<?php
function foo(bool $a, bool $b, bool $c): void {
if (($a && $b) || (!$a && $c)) {
//
} else {
if ($c) {}
}
}'
],
'combineTwoOrredClausesWithMoreComplexUnnecessaryTerm' => [
'code' => '<?php
function foo(bool $a, bool $b, bool $c): void {
if ((!$a && !$b) || ($a && $b) || ($a && $c)) {
throw new \Exception();
}
if ($a) {}
}'
],
'compareToIntInsideIfDNF' => [
'code' => '<?php
function foo(?int $foo): void {
if (($foo && $foo !== 5) || (!$foo && rand(0,1))) {
return;
}
if ($foo === null) {}
}'
],
'compareToIntInsideIfCNF' => [
'code' => '<?php
function baz(?int $foo): void {
if (
(!$foo || $foo !== 5) && ($foo || rand(0,1)) && ($foo !== 5 || rand(0, 1))
) {
return;
}
if ($foo === null) {}
}'
],
'ternaryAssertionOnBool' => [
'code' => '<?php
function test(string|object $s, bool $b) : string {
if (!$b || is_string($s)) {
return $b ? $s : "";
}
return "";
}',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.0',
]
];
}
/**
Add support for strict arrays, fix type alias intersection, fix array_is_list assertion on non-lists (#8395) * Immutable CodeLocation * Remove excess clones * Remove external clones * Remove leftover clones * Fix final clone issue * Immutable storages * Refactoring * Fixes * Fixes * Fix * Fix * Fixes * Simplify * Fixes * Fix * Fixes * Update * Fix * Cache global types * Fix * Update * Update * Fixes * Fixes * Refactor * Fixes * Fix * Fix * More caching * Fix * Fix * Update * Update * Fix * Fixes * Update * Refactor * Update * Fixes * Break one more test * Fix * FIx * Fix * Fix * Fix * Fix * Improve performance and readability * Equivalent logic * Fixes * Revert * Revert "Revert" This reverts commit f9175100c8452c80559234200663fd4c4f4dd889. * Fix * Fix reference bug * Make default TypeVisitor immutable * Bugfix * Remove clones * Partial refactoring * Refactoring * Fixes * Fix * Fixes * Fixes * cs-fix * Fix final bugs * Add test * Misc fixes * Update * Fixes * Experiment with removing different property * revert "Experiment with removing different property" This reverts commit ac1156e077fc4ea633530d51096d27b6e88bfdf9. * Uniform naming * Uniform naming * Hack hotfix * Clean up $_FILES ref #8621 * Undo hack, try fixing properly * Helper method * Remove redundant call * Partially fix bugs * Cleanup * Change defaults * Fix bug * Fix (?, hope this doesn't break anything else) * cs-fix * Review fixes * Bugfix * Bugfix * Improve logic * Add support for list{} and callable-list{} types, properly implement array_is_list assertions (fixes #8389) * Default to sealed arrays * Fix array_merge bug * Fixes * Fix * Sealed type checks * Properly infer properties-of and get_object_vars on final classes * Fix array_map zipping * Fix tests * Fixes * Fixes * Fix more stuff * Recursively resolve type aliases * Fix typo * Fixes * Fix array_is_list assertion on keyed array * Add BC docs * Fixes * fix * Update * Update * Update * Update * Seal arrays with count assertions * Fix #8528 * Fix * Update * Improve sealed array foreach logic * get_object_vars on template properties * Fix sealed array assertion reconciler logic * Improved reconciler * Add tests * Single source of truth for test types * Fix tests * Fixup tests * Fixup tests * Fixup tests * Update * Fix tests * Fix tests * Final fixes * Fixes * Use list syntax only when needed * Fix tests * Cs-fix * Update docs * Update docs * Update docs * Update docs * Update docs * Document missing types * Update docs * Improve class-string-map docs * Update * Update * I love working on psalm :) * Keep arrays unsealed by default * Fixup tests * Fix syntax mistake * cs-fix * Fix typo * Re-import missing types * Keep strict types only in return types * argc/argv fixes * argc/argv fixes * Fix test * Comment-out valinor code, pinging @romm pls merge https://github.com/CuyZ/Valinor/pull/246 so we can add valinor to the psalm docs :)
2022-11-05 22:34:42 +01:00
*
*/
public function providerInvalidCodeParse(): iterable
{
return [
'threeVarLogicWithChange' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function takesString(string $s): void {}
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b, ?string $c): void {
if ($a !== null || $b !== null || $c !== null) {
$c = null;
if ($a !== null) {
$d = $a;
} elseif ($b !== null) {
$d = $b;
} else {
$d = $c;
}
takesString($d);
}
}',
'error_message' => 'PossiblyNullArgument',
],
'threeVarLogicWithException' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b, ?string $c): void {
if ($a !== null || $b !== null || $c !== null) {
if ($c !== null) {
throw new \Exception("bad");
}
if ($a !== null) {
$d = $a;
} elseif ($b !== null) {
$d = $b;
} else {
$d = $c;
}
}
}',
'error_message' => 'RedundantCondition',
],
'invertedTwoVarLogicNotNestedWithVarChange' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if ($a !== null || $b !== null) {
$b = null;
} else {
return "bad";
}
if ($a !== null) return $b;
return $a;
}',
'error_message' => 'NullableReturnStatement',
],
'invertedTwoVarLogicNotNestedWithElseif' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if (rand(0, 1)) {
// do nothing
} elseif ($a || $b) {
// do nothing here
} else {
return "bad";
}
if (!$a) return $b;
return $a;
}',
'error_message' => 'NullableReturnStatement',
],
'threeVarLogicWithElseifAndAnd' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b, ?string $c): string {
if ($a) {
// do nothing
} elseif ($b && $c) {
// do nothing here
} else {
return "bad";
}
if (!$a && !$b) return $c;
if (!$a) return $b;
return $a;
}',
2021-09-22 19:47:37 +02:00
'error_message' => 'TypeDoesNotContainType',
],
'twoVarLogicNotNestedWithElseifIncorrectlyReinforcedInIf' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(?string $a, ?string $b): string {
if ($a) {
$a = "";
} elseif ($b) {
// do nothing
} else {
return "bad";
}
if (!$a) return $b;
return $a;
}',
2018-05-07 07:26:06 +02:00
'error_message' => 'RedundantCondition',
],
'repeatedIfStatements' => [
'code' => '<?php
/** @return string|null */
function foo(?string $a) {
if ($a) {
return $a;
}
if ($a) {
}
}',
'error_message' => 'TypeDoesNotContainType',
],
'repeatedConditionals' => [
'code' => '<?php
function foo(?object $a): void {
if ($a) {
// do something
} elseif ($a) {
// can never get here
}
}',
'error_message' => 'TypeDoesNotContainType',
2017-05-27 02:05:57 +02:00
],
'repeatedAndConditional' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(string $a, string $b): void {
if ($a && $b) {
echo "a";
} elseif ($a && $b) {
echo "b";
}
}',
'error_message' => 'ParadoxicalCondition',
],
'andConditionalAfterOrConditional' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(string $a, string $b): void {
if ($a || $b) {
echo "a";
} elseif ($a && $b) {
echo "b";
}
}',
'error_message' => 'TypeDoesNotContainType',
],
'repeatedVarFromOrConditional' => [
'code' => '<?php
2018-01-11 21:50:45 +01:00
function foo(string $a, string $b): void {
if ($a || $b) {
echo "a";
} elseif ($a) {
echo "b";
}
}',
'error_message' => 'TypeDoesNotContainType',
],
'typeDoesntEqualType' => [
'code' => '<?php
$a = "hello";
$b = 5;
if ($a !== $b) {}',
'error_message' => 'RedundantCondition',
],
'stringConcatenationTrackedInvalid' => [
'code' => '<?php
$x = "a";
$x = "_" . $x;
$array = [$x => 2];
echo $array["other"];',
'error_message' => 'InvalidArrayOffset',
],
'redundantTwoVarInElseif' => [
'code' => '<?php
class A {}
$from = rand(0, 1) ? new A() : null;
$to = rand(0, 1) ? new A() : null;
if ($from === null && $to === null) {
} elseif ($from !== null) {
} elseif ($to !== null) {}',
'error_message' => 'RedundantCondition',
],
'paradoxInTernary' => [
'code' => '<?php
function foo(string $input) : string {
return $input === "a" ? "bar" : ($input === "a" ? "foo" : "b");
}',
'error_message' => 'ParadoxicalCondition',
],
'mismatchingChecks' => [
'code' => '<?php
function doesntFindBug(?string $old, ?string $new): void {
if (empty($old) && empty($new)) {
return;
}
if (($old && empty($new)) || ($new && empty($old))) {
return;
}
}',
'error_message' => 'RedundantCondition',
],
2020-11-24 20:50:35 +01:00
'dependentTypeInvalidated' => [
'code' => '<?php
2020-11-24 20:50:35 +01:00
class A {
public function isValid() : bool {
return (bool) rand(0, 1);
}
public function foo() : void {}
}
function takesA(?A $a) : void {
$is_valid_a = $a && $a->isValid();
if (rand(0, 1)) {
$is_valid_a = false;
}
if ($is_valid_a) {
$a->foo();
}
}',
'error_message' => 'PossiblyNullReference',
],
'stillNullAfterNullsafeMethodCall' => [
'code' => '<?php
interface X {
public function a(): bool;
public function b(): string;
}
function foo(?X $x): void {
if (!($x?->a())) {
echo $x->b();
}
}',
'error_message' => 'NullReference',
'ignored_issues' => [],
'php_version' => '8.1',
],
'arrayShapeListCanBeEmpty' => [
2022-07-07 07:21:35 +02:00
'code' => '<?php
/** @param non-empty-list<mixed> $_list */
function foobar(array $_list): void {}
$list = random_int(0, 1) ? [] : ["foobar"];
foobar($list);
',
'error_message' => 'InvalidArgument',
],
];
2017-04-02 23:37:56 +02:00
}
}