Skip to content

Trigger error on unsafe StrictGroups usages #29

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

Merged
merged 5 commits into from
Jul 13, 2024
Merged

Trigger error on unsafe StrictGroups usages #29

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4875f9f
Trigger error on unsafe StrictGroups usages
Seldaek Jul 11, 2024
eca48c7
Implement new rule to warn about unsafe strict groups calls
Seldaek Jul 12, 2024
7de8962
Apply feedback
Seldaek Jul 12, 2024
088f752
Fix 7.2/7.3 builds
Seldaek Jul 13, 2024
5cdc186
Bump minimum PHPStan version
Seldaek Jul 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"require-dev": {
"phpunit/phpunit": "^8 || ^9",
"phpstan/phpstan": "^1.11.6",
"phpstan/phpstan": "^1.11.6@dev",
"phpstan/phpstan-strict-rules": "^1.1"
},
"conflict": {
Expand Down
14 changes: 5 additions & 9 deletions src/PHPStan/PregMatchTypeSpecifyingExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,11 @@ public function specifyTypes(MethodReflection $methodReflection, StaticCall $nod
&& count($matchedType->getConstantArrays()) === 1
) {
$matchedType = $matchedType->getConstantArrays()[0];
$matchedType = new ConstantArrayType(
$matchedType->getKeyTypes(),
array_map(static function (Type $valueType): Type {
return TypeCombinator::removeNull($valueType);
}, $matchedType->getValueTypes()),
$matchedType->getNextAutoIndexes(),
[],
$matchedType->isList()
);
foreach ($matchedType as $type) {
if ($type->containsNull()) {
// TODO trigger an error here that $methodReflection->getName() should not be used, or the pattern needs to make sure that $type->?? get key name is not nullable
}
}
}

$overwrite = false;
Expand Down
32 changes: 26 additions & 6 deletions tests/PHPStanTests/nsrt/preg-match.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,33 @@ function doMatch(string $s): void
assertType('array{}|array{string}', $matches);

if (Preg::match('/Price: (£|€)\d+/', $s, $matches)) {
assertType('array{string, string|null}', $matches);
assertType('array{string, string}', $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{string, string|null}', $matches);
assertType('array{}|array{string, string}', $matches);

if (Preg::match('/Price: (£|€)?\d+/', $s, $matches)) {
assertType('array{0: string, 1?: string|null}', $matches);
assertType('array{0: string, 1: string|null}', $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{0: string, 1?: string|null}', $matches);
assertType('array{}|array{0: string, 1: string|null}', $matches);

// passing the PREG_UNMATCHED_AS_NULL should change nothing compared to above as it is always set
if (Preg::match('/Price: (£|€)?\d+/', $s, $matches, PREG_UNMATCHED_AS_NULL)) {
assertType('array{0: string, 1: string|null}', $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{0: string, 1: string|null}', $matches);

if (Preg::isMatch('/Price: (?<currency>£|€)\d+/', $s, $matches)) {
assertType('array{0: string, currency: string|null, 1: string|null}', $matches);
assertType('array{0: string, currency: string, 1: string}', $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{0: string, currency: string|null, 1: string|null}', $matches);
assertType('array{}|array{0: string, currency: string, 1: string}', $matches);
}

function doMatchStrictGroups(string $s): void
Expand All @@ -60,6 +68,18 @@ function doMatchStrictGroups(string $s): void
assertType('array{}|array{0: string, test: string, 1: string}', $matches);
}

function doMatchStrictGroupsUnsafe(string $s): void
{
if (Preg::isMatchStrictGroups('{Configure Command(?: *</td><td class="v">| *=> *)(.*)(?:</td>|$)}m', $s, $matches)) {
// does not error because the match group might be empty but is not optional
assertType('array{string, string}', $matches);
}

if (Preg::isMatchStrictGroups('{Configure Command(?: *</td><td class="v">| *=> *)(.*)?(?:</td>|$)}m', $s, $matches)) {
// should error as it is unsafe due to the optional group
}
}

// disabled until https://github.com/phpstan/phpstan-src/pull/3185 can be resolved
//
//function identicalMatch(string $s): void
Expand Down