Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix empty array #7517

Merged
merged 2 commits into from Jan 30, 2022
Merged

Fix empty array #7517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a3735b
Change code so it handles what it was designed for
orklah Jan 29, 2022
0592c03
fix issues resulting from previous commit
orklah Jan 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
63 changes: 33 additions & 30 deletions src/Psalm/Internal/Analyzer/Statements/Expression/Fetch/ArrayFetchAnalyzer.php
View file
Open in desktop
Expand Up @@ -61,6 +61,7 @@
use Psalm\Type\Atomic\TInt;
use Psalm\Type\Atomic\TKeyedArray;
use Psalm\Type\Atomic\TList;
use Psalm\Type\Atomic\TLiteralClassString;
use Psalm\Type\Atomic\TLiteralFloat;
use Psalm\Type\Atomic\TLiteralInt;
use Psalm\Type\Atomic\TLiteralString;
Expand Down Expand Up @@ -473,10 +474,10 @@ public static function getArrayAccessTypeGivenOffset(

$key_values = [];

if ($stmt->dim instanceof PhpParser\Node\Scalar\String_
|| $stmt->dim instanceof PhpParser\Node\Scalar\LNumber
) {
$key_values[] = $stmt->dim->value;
if ($stmt->dim instanceof PhpParser\Node\Scalar\String_) {
$key_values[] = new TLiteralString($stmt->dim->value);
} elseif ($stmt->dim instanceof PhpParser\Node\Scalar\LNumber) {
$key_values[] = new TLiteralInt($stmt->dim->value);
} elseif ($stmt->dim && ($stmt_dim_type = $statements_analyzer->node_data->getType($stmt->dim))) {
$string_literals = $stmt_dim_type->getLiteralStrings();
$int_literals = $stmt_dim_type->getLiteralInts();
Expand All @@ -485,11 +486,11 @@ public static function getArrayAccessTypeGivenOffset(

if (count($string_literals) + count($int_literals) === count($all_atomic_types)) {
foreach ($string_literals as $string_literal) {
$key_values[] = $string_literal->value;
$key_values[] = $string_literal;
}

foreach ($int_literals as $int_literal) {
$key_values[] = $int_literal->value;
$key_values[] = $int_literal;
}
}
}
Expand Down Expand Up @@ -776,7 +777,8 @@ public static function getArrayAccessTypeGivenOffset(
$used_offset = 'using a ' . $offset_type->getId() . ' offset';

if ($key_values) {
$used_offset = "using offset value of '" . implode('|', $key_values) . "'";
$used_offset = "using offset value of '" .
implode('|', array_map(fn (Atomic $atomic_type) => $atomic_type->value, $key_values)) . "'";
}

if ($has_valid_expected_offset && $has_valid_absolute_offset && $context->inside_isset) {
Expand Down Expand Up @@ -1076,7 +1078,7 @@ public static function handleMixedArrayAccess(
/**
* @param list<string> $expected_offset_types
* @param TArray|TKeyedArray|TList|TClassStringMap $type
* @param list<array-key> $key_values
* @param list<TLiteralInt|TLiteralString> $key_values
*/
private static function handleArrayAccessOnArray(
bool $in_assignment,
Expand All @@ -1099,22 +1101,23 @@ private static function handleArrayAccessOnArray(
): void {
$has_array_access = true;

if ($in_assignment
&& $type instanceof TArray
&& $type->isEmptyArray()
) {
if ($in_assignment && $type instanceof TArray) {
$from_empty_array = $type->isEmptyArray();

if (count($key_values) === 1) {
$single_atomic = $key_values[0];
$from_mixed_array = $type->type_params[1]->isMixed();

[$previous_key_type, $previous_value_type] = $type->type_params;

// ok, type becomes an TKeyedArray
$array_type->removeType($type_string);
$type = new TKeyedArray([
$key_values[0] => $from_mixed_array ? Type::getMixed() : Type::getNever()
$single_atomic->value => $from_mixed_array ? Type::getMixed() : Type::getNever()
]);
if ($single_atomic instanceof TLiteralClassString) {
$type->class_strings[$single_atomic->value] = true;
}

$type->sealed = $from_empty_array;

Expand All @@ -1135,7 +1138,7 @@ private static function handleArrayAccessOnArray(
&& $type->previous_value_type->isMixed()
&& count($key_values) === 1
) {
$type->properties[$key_values[0]] = Type::getMixed();
$type->properties[$key_values[0]->value] = Type::getMixed();
}

$offset_type = self::replaceOffsetTypeWithInts($offset_type);
Expand Down Expand Up @@ -1478,7 +1481,7 @@ private static function handleArrayAccessOnClassStringMap(

/**
* @param list<string> $expected_offset_types
* @param list<array-key> $key_values
* @param list<TLiteralString|TLiteralInt> $key_values
*/
private static function handleArrayAccessOnKeyedArray(
StatementsAnalyzer $statements_analyzer,
Expand All @@ -1500,31 +1503,31 @@ private static function handleArrayAccessOnKeyedArray(
$generic_key_type = $type->getGenericKeyType();

if (!$stmt->dim && $type->sealed && $type->is_list) {
$key_values[] = count($type->properties);
$key_values[] = new TLiteralInt(count($type->properties));
}

if ($key_values) {
foreach ($key_values as $key_value) {
if (isset($type->properties[$key_value]) || $replacement_type) {
if (isset($type->properties[$key_value->value]) || $replacement_type) {
$has_valid_offset = true;

if ($replacement_type) {
$type->properties[$key_value] = Type::combineUnionTypes(
$type->properties[$key_value] ?? null,
$type->properties[$key_value->value] = Type::combineUnionTypes(
$type->properties[$key_value->value] ?? null,
$replacement_type
);
}

$array_access_type = Type::combineUnionTypes(
$array_access_type,
clone $type->properties[$key_value]
clone $type->properties[$key_value->value]
);
} elseif ($in_assignment) {
$type->properties[$key_value] = new Union([new TNever]);
$type->properties[$key_value->value] = new Union([new TNever]);

$array_access_type = Type::combineUnionTypes(
$array_access_type,
clone $type->properties[$key_value]
clone $type->properties[$key_value->value]
);
} elseif ($type->previous_value_type) {
if ($codebase->config->ensure_array_string_offsets_exist) {
Expand All @@ -1549,7 +1552,7 @@ private static function handleArrayAccessOnKeyedArray(
);
}

$type->properties[$key_value] = clone $type->previous_value_type;
$type->properties[$key_value->value] = clone $type->previous_value_type;

$array_access_type = clone $type->previous_value_type;
} elseif ($array_type->hasMixed()) {
Expand Down Expand Up @@ -1679,7 +1682,7 @@ private static function handleArrayAccessOnKeyedArray(

/**
* @param list<string> $expected_offset_types
* @param list<array-key> $key_values
* @param list<TLiteralString|TLiteralInt> $key_values
*/
private static function handleArrayAccessOnList(
StatementsAnalyzer $statements_analyzer,
Expand All @@ -1700,10 +1703,10 @@ private static function handleArrayAccessOnList(
if (!$in_assignment) {
if (!$type instanceof TNonEmptyList
|| (count($key_values) === 1
&& is_int($key_values[0])
&& $key_values[0] > 0
&& $key_values[0] > ($type->count - 1)
&& $key_values[0] > ($type->min_count - 1))
&& $key_values[0] instanceof TLiteralInt
&& $key_values[0]->value > 0
&& $key_values[0]->value > ($type->count - 1)
&& $key_values[0]->value > ($type->min_count - 1))
) {
$expected_offset_type = Type::getInt();

Expand All @@ -1719,8 +1722,8 @@ private static function handleArrayAccessOnList(
}
$has_valid_offset = true;
} elseif (count($key_values) === 1
&& is_int($key_values[0])
&& $key_values[0] < 0
&& $key_values[0] instanceof TLiteralInt
&& $key_values[0]->value < 0
) {
$expected_offset_types[] = 'positive-int';
$has_valid_offset = false;
Expand Down
20 changes: 10 additions & 10 deletions src/Psalm/Internal/Type/SimpleNegatedAssertionReconciler.php
View file
Open in desktop
Expand Up @@ -527,7 +527,16 @@ private static function reconcileNotNonEmptyCountable(
$did_remove_type = true;

$existing_var_type->removeType('array');
} elseif (!($array_atomic_type instanceof TArray && $array_atomic_type->isEmptyArray())) {
} elseif ($array_atomic_type instanceof TKeyedArray) {
$did_remove_type = true;

foreach ($array_atomic_type->properties as $property_type) {
if (!$property_type->possibly_undefined) {
$did_remove_type = false;
break;
}
}
} elseif (!$array_atomic_type instanceof TArray || !$array_atomic_type->isEmptyArray()) {
$did_remove_type = true;

if (!$min_count) {
Expand All @@ -538,15 +547,6 @@ private static function reconcileNotNonEmptyCountable(
]
));
}
} elseif ($array_atomic_type instanceof TKeyedArray) {
$did_remove_type = true;

foreach ($array_atomic_type->properties as $property_type) {
if (!$property_type->possibly_undefined) {
$did_remove_type = false;
break;
}
}
}

if (!$is_equality
Expand Down
14 changes: 9 additions & 5 deletions src/Psalm/Internal/Type/TypeCombiner.php
View file
Open in desktop
Expand Up @@ -737,7 +737,7 @@ private static function scrapeTypeProperties(
$min_prop_count = count(
array_filter(
$type->properties,
fn($p) => $p->possibly_undefined
fn($p) => !$p->possibly_undefined
)
);
$combination->array_min_counts[$min_prop_count] = true;
Expand Down Expand Up @@ -1328,9 +1328,7 @@ private static function handleKeyedArrayEntries(
$combination->objectlike_sealed = false;
}

if (!$combination->array_type_params
|| $combination->array_type_params[1]->isNever()
) {
if (!$combination->array_type_params || $combination->array_type_params[1]->isNever()) {
if (!$overwrite_empty_array
&& ($combination->array_type_params
&& ($combination->array_type_params[1]->isNever()
Expand Down Expand Up @@ -1383,7 +1381,13 @@ private static function handleKeyedArrayEntries(

$new_types[] = $objectlike;
} else {
$new_types[] = new TArray([Type::getArrayKey(), Type::getMixed()]);
$key_type = $combination->objectlike_key_type ?? Type::getArrayKey();
$value_type = $combination->objectlike_value_type ?? Type::getMixed();
if ($combination->array_always_filled) {
$new_types[] = new TNonEmptyArray([$key_type, $value_type]);
} else {
$new_types[] = new TArray([$key_type, $value_type]);
}
}

// if we're merging an empty array with an object-like, clobber empty array
Expand Down
2 changes: 1 addition & 1 deletion tests/ArrayAssignmentTest.php
View file
Open in desktop
Expand Up @@ -371,7 +371,7 @@ function fooFoo($a) {
$a = [];
$a["foo"] = ["bar" => "baz"];',
'assertions' => [
'$a' => 'non-empty-array<string, non-empty-array<string, string>>',
'$a' => 'array{foo: array{bar: string}}<string, array<string, string>>',
],
],
'additionWithEmpty' => [
Expand Down