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

Enum collapsing #7655

Merged
merged 3 commits into from Feb 13, 2022
+85 −24
Merged

Enum collapsing #7655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
60feb5f
allow collapsing enum cases under named object in combiner
orklah Feb 12, 2022
954884e
consistency between TernaryAnalyzer and IfElseAnalyzer
orklah Feb 12, 2022
9cc82d5
add test
orklah Feb 12, 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
80 changes: 56 additions & 24 deletions src/Psalm/Internal/Analyzer/Statements/Expression/TernaryAnalyzer.php
View file
Open in desktop
Expand Up @@ -5,6 +5,7 @@
use PhpParser;
use Psalm\CodeLocation;
use Psalm\Context;
use Psalm\Exception\ComplicatedExpressionException;
use Psalm\Exception\ScopeAnalysisException;
use Psalm\Internal\Algebra;
use Psalm\Internal\Algebra\FormulaGenerator;
Expand All @@ -15,6 +16,7 @@
use Psalm\Internal\Clause;
use Psalm\Internal\Scope\IfScope;
use Psalm\Internal\Type\AssertionReconciler;
use Psalm\Node\Expr\VirtualBooleanNot;
use Psalm\Storage\Assertion\Truthy;
use Psalm\Type;
use Psalm\Type\Reconciler;
Expand All @@ -27,6 +29,7 @@
use function array_map;
use function array_merge;
use function array_values;
use function count;
use function in_array;
use function preg_match;
use function preg_quote;
Expand Down Expand Up @@ -56,6 +59,7 @@ public static function analyze(
$context->branch_point ?: (int) $stmt->getAttribute('startFilePos')
);

// this is the context for stuff that happens within the first operand of the ternary
$if_context = $if_conditional_scope->if_context;

$cond_referenced_var_ids = $if_conditional_scope->cond_referenced_var_ids;
Expand All @@ -64,19 +68,21 @@ public static function analyze(
return false;
}

$codebase = $statements_analyzer->getCodebase();

$cond_id = spl_object_id($stmt->cond);
$cond_object_id = spl_object_id($stmt->cond);

$if_clauses = FormulaGenerator::getFormula(
$cond_id,
$cond_id,
$cond_object_id,
$cond_object_id,
$stmt->cond,
$context->self,
$statements_analyzer,
$codebase
);

if (count($if_clauses) > 200) {
$if_clauses = [];
}

$mixed_var_ids = [];

foreach ($context->vars_in_scope as $var_id => $type) {
Expand All @@ -95,15 +101,15 @@ public static function analyze(
/**
* @return Clause
*/
function (Clause $c) use ($mixed_var_ids, $cond_id): Clause {
function (Clause $c) use ($mixed_var_ids, $cond_object_id): Clause {
$keys = array_keys($c->possibilities);

$mixed_var_ids = array_diff($mixed_var_ids, $keys);

foreach ($keys as $key) {
foreach ($mixed_var_ids as $mixed_var_id) {
if (preg_match('/^' . preg_quote($mixed_var_id, '/') . '(\[|-)/', $key)) {
return new Clause([], $cond_id, $cond_id, true);
return new Clause([], $cond_object_id, $cond_object_id, true);
}
}
}
Expand All @@ -113,6 +119,8 @@ function (Clause $c) use ($mixed_var_ids, $cond_id): Clause {
$if_clauses
);

$entry_clauses = $context->clauses;

// this will see whether any of the clauses in set A conflict with the clauses in set B
AlgebraAnalyzer::checkForParadox(
$context->clauses,
Expand All @@ -122,34 +130,58 @@ function (Clause $c) use ($mixed_var_ids, $cond_id): Clause {
$assigned_in_conditional_var_ids
);

$ternary_clauses = array_merge($context->clauses, $if_clauses);
$if_clauses = Algebra::simplifyCNF($if_clauses);

$ternary_context_clauses = array_merge($entry_clauses, $if_clauses);

if ($if_context->reconciled_expression_clauses) {
$reconciled_expression_clauses = $if_context->reconciled_expression_clauses;

$ternary_clauses = array_values(
$ternary_context_clauses = array_values(
array_filter(
$ternary_clauses,
$ternary_context_clauses,
fn($c): bool => !in_array($c->hash, $reconciled_expression_clauses)
)
);
}

$ternary_clauses = Algebra::simplifyCNF($ternary_clauses);
if (count($if_context->clauses) === 1
&& $if_context->clauses[0]->wedge
&& !$if_context->clauses[0]->possibilities
) {
$if_context->clauses = [];
$if_context->reconciled_expression_clauses = [];
}
}

$negated_clauses = Algebra::negateFormula($if_clauses);
try {
$if_scope->negated_clauses = Algebra::negateFormula($if_clauses);
} catch (ComplicatedExpressionException $e) {
try {
$if_scope->negated_clauses = FormulaGenerator::getFormula(
$cond_object_id,
$cond_object_id,
new VirtualBooleanNot($stmt->cond),
$context->self,
$statements_analyzer,
$codebase,
false
);
} catch (ComplicatedExpressionException $e) {
$if_scope->negated_clauses = [];
}
}

$negated_if_types = Algebra::getTruthsFromFormula(
$if_scope->negated_types = Algebra::getTruthsFromFormula(
Algebra::simplifyCNF(
array_merge($context->clauses, $negated_clauses)
array_merge($context->clauses, $if_scope->negated_clauses)
)
);

$active_if_types = [];

$reconcilable_if_types = Algebra::getTruthsFromFormula(
$ternary_clauses,
$cond_id,
$ternary_context_clauses,
$cond_object_id,
$cond_referenced_var_ids,
$active_if_types
);
Expand Down Expand Up @@ -189,16 +221,16 @@ function (Clause $c) use ($mixed_var_ids, $cond_id): Clause {
$t_else_context->clauses = Algebra::simplifyCNF(
array_merge(
$t_else_context->clauses,
$negated_clauses
$if_scope->negated_clauses
)
);

if ($negated_if_types) {
$changed_var_ids = [];
$changed_var_ids = [];

$t_else_vars_in_scope_reconciled = Reconciler::reconcileKeyedTypes(
$negated_if_types,
$negated_if_types,
if ($if_scope->negated_types) {
$else_vars_reconciled = Reconciler::reconcileKeyedTypes(
$if_scope->negated_types,
$if_scope->negated_types,
$t_else_context->vars_in_scope,
$t_else_context->references_in_scope,
$changed_var_ids,
Expand All @@ -209,7 +241,7 @@ function (Clause $c) use ($mixed_var_ids, $cond_id): Clause {
new CodeLocation($statements_analyzer->getSource(), $stmt->else)
);

$t_else_context->vars_in_scope = $t_else_vars_in_scope_reconciled;
$t_else_context->vars_in_scope = $else_vars_reconciled;

$t_else_context->clauses = Context::removeReconciledClauses($t_else_context->clauses, $changed_var_ids)[0];
}
Expand Down
6 changes: 6 additions & 0 deletions src/Psalm/Internal/Type/TypeCombiner.php
View file
Open in desktop
Expand Up @@ -18,6 +18,7 @@
use Psalm\Type\Atomic\TClassString;
use Psalm\Type\Atomic\TClassStringMap;
use Psalm\Type\Atomic\TEmptyMixed;
use Psalm\Type\Atomic\TEnumCase;
use Psalm\Type\Atomic\TFalse;
use Psalm\Type\Atomic\TFloat;
use Psalm\Type\Atomic\TGenericObject;
Expand Down Expand Up @@ -334,6 +335,11 @@ public static function combine(
}

if ($combination->named_object_types !== null) {
foreach ($combination->value_types as $key => $atomic_type) {
if ($atomic_type instanceof TEnumCase && isset($combination->named_object_types[$atomic_type->value])) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that enum case can be represented as TClassConstant when it comes from docblock, e.g.

/** @var Code::Ok|int $code */

Ideally we'd want to check if the const is actually a enum case (by calling $codebase->classlikes->enumExists($atomic->value)), but $codebase is not available during scanning phase. I tried to pass it from TypeParser, but that leads to unrelated errors like SplFileInfo not existing prior to stub files scanning.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not great :( Maybe we should have a different syntax for enum cases?

But thinking about it, it may not be too bad. The type from docblock will be collapsed at some point anyway, it may not be a problem

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should have a different syntax for enum cases?

Well, why? Enum cases are constants, so it makes sense to use the same syntax.

The type from docblock will be collapsed at some point anyway

Doesn't seem to be happening, even in your branch: https://psalm.dev/r/1698218e19

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why

Well, exactly because of what you're describing. An Enum and a property of an enum should be collapsed but this is not the case for constants

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That doesn't mean we should introduce a new syntax for cases.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what we can do then. I'll merge this for now, it's at least a good first step

unset($combination->value_types[$key]);
}
}
$combination->value_types += $combination->named_object_types;
}

Expand Down
23 changes: 23 additions & 0 deletions tests/EnumTest.php
View file
Open in desktop
Expand Up @@ -382,6 +382,29 @@ enum Status: int {
'ignored_issues' => [],
'php_version' => '8.1',
],
'EnumCollapsing' => [
'code' => '<?php
enum Code: int
{
case Ok = 0;
case Fatal = 1;
}

function foo(): int|Code|null
{
return null;
}

$code = foo();
if(!isset($code)){
$code = Code::Ok;
}',
'assertions' => [
'$code' => 'Code|int',
],
'ignored_issues' => [],
'php_version' => '8.1',
],
];
}

Expand Down