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

Add support for @psalm-no-seal-properties and @psalm-no-seal-methods #9681

Merged
merged 1 commit into from
May 2, 2023
Merged

Add support for @psalm-no-seal-properties and @psalm-no-seal-methods #9681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 25 additions & 1 deletion docs/annotating_code/supported_annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,10 @@ takesFoo(getFoo());

This provides the same, but for `false`. Psalm uses this internally for functions like `preg_replace`, which can return false if the given input has encoding errors, but where 99.9% of the time the function operates as expected.

### `@psalm-seal-properties`
### `@psalm-seal-properties`, `@psalm-no-seal-properties`

If you have a magic property getter/setter, you can use `@psalm-seal-properties` to instruct Psalm to disallow getting and setting any properties not contained in a list of `@property` (or `@property-read`/`@property-write`) annotations.
This is automatically enabled with the configuration option `sealAllProperties` and can be disabled for a class with `@psalm-no-seal-properties`

```php
<?php
Expand All @@ -181,6 +182,29 @@ $a = new A();
$a->bar = 5; // this call fails
```

### `@psalm-seal-methods`, `@psalm-no-seal-methods`

If you have a magic method caller, you can use `@psalm-seal-methods` to instruct Psalm to disallow calling any methods not contained in a list of `@method` annotations.
This is automatically enabled with the configuration option `sealAllMethods` and can be disabled for a class with `@psalm-no-seal-methods`

```php
<?php
/**
* @method foo(): string
* @psalm-seal-methods
*/
class A {
public function __call(string $name, array $args) {
if ($name === "foo") {
return "hello";
}
}
}

$a = new A();
$b = $a->bar(); // this call fails
```

### `@psalm-internal`

Used to mark a class, property or function as internal to a given namespace. Psalm treats this slightly differently to
Expand Down
1 change: 1 addition & 0 deletions src/Psalm/DocComment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,13 @@

final class DocComment
{
public const PSALM_ANNOTATIONS = [

Check failure on line 21 in src/Psalm/DocComment.php

View workflow job for this annotation

GitHub Actions / Check backward compatibility 

Value of constant Psalm\DocComment::PSALM_ANNOTATIONS changed from array (
  0 => 'return',
  1 => 'param',
  2 => 'template',
  3 => 'var',
  4 => 'type',
  5 => 'template-covariant',
  6 => 'property',
  7 => 'property-read',
  8 => 'property-write',
  9 => 'method',
  10 => 'assert',
  11 => 'assert-if-true',
  12 => 'assert-if-false',
  13 => 'suppress',
  14 => 'ignore-nullable-return',
  15 => 'override-property-visibility',
  16 => 'override-method-visibility',
  17 => 'seal-properties',
  18 => 'seal-methods',
  19 => 'ignore-falsable-return',
  20 => 'variadic',
  21 => 'pure',
  22 => 'ignore-variable-method',
  23 => 'ignore-variable-property',
  24 => 'internal',
  25 => 'taint-sink',
  26 => 'taint-source',
  27 => 'assert-untainted',
  28 => 'scope-this',
  29 => 'mutation-free',
  30 => 'external-mutation-free',
  31 => 'immutable',
  32 => 'readonly',
  33 => 'allow-private-mutation',
  34 => 'readonly-allow-private-mutation',
  35 => 'yield',
  36 => 'trace',
  37 => 'import-type',
  38 => 'flow',
  39 => 'taint-specialize',
  40 => 'taint-escape',
  41 => 'taint-unescape',
  42 => 'self-out',
  43 => 'consistent-constructor',
  44 => 'stub-override',
  45 => 'require-extends',
  46 => 'require-implements',
  47 => 'param-out',
  48 => 'ignore-var',
  49 => 'consistent-templates',
  50 => 'if-this-is',
  51 => 'this-out',
  52 => 'check-type',
  53 => 'check-type-exact',
  54 => 'api',
) to array (
  0 => 'return',
  1 => 'param',
  2 => 'template',
  3 => 'var',
  4 => 'type',
  5 => 'template-covariant',
  6 => 'property',
  7 => 'property-read',
  8 => 'property-write',
  9 => 'method',
  10 => 'assert',
  11 => 'assert-if-true',
  12 => 'assert-if-false',
  13 => 'suppress',
  14 => 'ignore-nullable-return',
  15 => 'override-property-visibility',
  16 => 'override-method-visibility',
  17 => 'seal-properties',
  18 => 'seal-methods',
  19 => 'no-seal-properties',
  20 => 'no-seal-methods',
  21 => 'ignore-falsable-return',
  22 => 'variadic',
  23 => 'pure',
  24 => 'ignore-variable-method',
  25 => 'ignore-variable-property',
  26 => 'internal',
  27 => 'taint-sink',
  28 => 'taint-source',
  29 => 'assert-untainted',
  30 => 'scope-this',
  31 => 'mutation-free',
  32 => 'external-mutation-free',
  33 => 'immutable',
  34 => 'readonly',
  35 => 'allow-private-mutation',
  36 => 'readonly-allow-private-mutation',
  37 => 'yield',
  38 => 'trace',
  39 => 'import-type',
  40 => 'flow',
  41 => 'taint-specialize',
  42 => 'taint-escape',
  43 => 'taint-unescape',
  44 => 'self-out',
  45 => 'consistent-constructor',
  46 => 'stub-override',
  47 => 'require-extends',
  48 => 'require-implements',
  49 => 'param-out',
  50 => 'ignore-var',
  51 => 'consistent-templates',
  52 => 'if-this-is',
  53 => 'this-out',
  54 => 'check-type',
  55 => 'check-type-exact',
  56 => 'api',
)
'return', 'param', 'template', 'var', 'type',
'template-covariant', 'property', 'property-read', 'property-write', 'method',
'assert', 'assert-if-true', 'assert-if-false', 'suppress',
'ignore-nullable-return', 'override-property-visibility',
'override-method-visibility', 'seal-properties', 'seal-methods',
'no-seal-properties', 'no-seal-methods',
'ignore-falsable-return', 'variadic', 'pure',
'ignore-variable-method', 'ignore-variable-property', 'internal',
'taint-sink', 'taint-source', 'assert-untainted', 'scope-this',
Expand Down
2 changes: 1 addition & 1 deletion ...Internal/Analyzer/Statements/Expression/Assignment/InstancePropertyAssignmentAnalyzer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1087,7 +1087,7 @@ private static function analyzeAtomicAssignment(
* If we have an explicit list of all allowed magic properties on the class, and we're
* not in that list, fall through
*/
if (!$var_id || !$class_storage->sealed_properties) {
if (!$var_id || !$class_storage->hasSealedProperties($codebase->config)) {
if (!$context->collect_initializations && !$context->collect_mutations) {
self::taintProperty(
$statements_analyzer,
Expand Down
4 changes: 2 additions & 2 deletions .../Internal/Analyzer/Statements/Expression/Call/Method/ExistingAtomicMethodCallAnalyzer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,7 +546,7 @@ private static function getMagicGetterOrSetterProperty(
case '__set':
// If `@psalm-seal-properties` is set, the property must be defined with
// a `@property` annotation
if (($class_storage->sealed_properties || $codebase->config->seal_all_properties)
if (($class_storage->hasSealedProperties($codebase->config))
&& !isset($class_storage->pseudo_property_set_types['$' . $prop_name])
) {
IssueBuffer::maybeAdd(
Expand Down Expand Up @@ -644,7 +644,7 @@ private static function getMagicGetterOrSetterProperty(
case '__get':
// If `@psalm-seal-properties` is set, the property must be defined with
// a `@property` annotation
if (($class_storage->sealed_properties || $codebase->config->seal_all_properties)
if (($class_storage->hasSealedProperties($codebase->config))
&& !isset($class_storage->pseudo_property_get_types['$' . $prop_name])
) {
IssueBuffer::maybeAdd(
Expand Down
2 changes: 1 addition & 1 deletion src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MissingMethodCallHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ public static function handleMagicMethod(
$context,
);

if ($class_storage->sealed_methods || $config->seal_all_methods) {
if ($class_storage->hasSealedMethods($config)) {
$result->non_existent_magic_method_ids[] = $method_id->__toString();

return null;
Expand Down
2 changes: 1 addition & 1 deletion src/Psalm/Internal/Analyzer/Statements/Expression/Fetch/AtomicPropertyFetchAnalyzer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -702,7 +702,7 @@ private static function propertyFetchCanBeAnalyzed(
* If we have an explicit list of all allowed magic properties on the class, and we're
* not in that list, fall through
*/
if (!($class_storage->sealed_properties || $codebase->config->seal_all_properties)
if (!($class_storage->hasSealedProperties($codebase->config))
&& !$override_property_visibility
) {
return false;
Expand Down
8 changes: 4 additions & 4 deletions src/Psalm/Internal/Codebase/Populator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -920,8 +920,8 @@ protected function inheritMethodsFromParent(
$fq_class_name = $storage->name;
$fq_class_name_lc = strtolower($fq_class_name);

if ($parent_storage->sealed_methods) {
$storage->sealed_methods = true;
if ($parent_storage->sealed_methods !== null) {
$storage->sealed_methods = $parent_storage->sealed_methods;
}

// register where they appear (can never be in a trait)
Expand Down Expand Up @@ -1032,8 +1032,8 @@ private function inheritPropertiesFromParent(
ClassLikeStorage $storage,
ClassLikeStorage $parent_storage
): void {
if ($parent_storage->sealed_properties) {
$storage->sealed_properties = true;
if ($parent_storage->sealed_properties !== null) {
$storage->sealed_properties = $parent_storage->sealed_properties;
}

// register where they appear (can never be in a trait)
Expand Down
16 changes: 16 additions & 0 deletions src/Psalm/Internal/PhpVisitor/Reflector/ClassLikeDocblockParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,10 +241,16 @@ public static function parse(
if (isset($parsed_docblock->tags['psalm-seal-properties'])) {
$info->sealed_properties = true;
}
if (isset($parsed_docblock->tags['psalm-no-seal-properties'])) {
$info->sealed_properties = false;
}

if (isset($parsed_docblock->tags['psalm-seal-methods'])) {
$info->sealed_methods = true;
}
if (isset($parsed_docblock->tags['psalm-no-seal-methods'])) {
$info->sealed_methods = false;
}

if (isset($parsed_docblock->tags['psalm-immutable'])
|| isset($parsed_docblock->tags['psalm-mutation-free'])
Expand Down Expand Up @@ -296,6 +302,9 @@ public static function parse(
}

if (isset($parsed_docblock->combined_tags['method'])) {
if ($info->sealed_methods === null) {
$info->sealed_methods = true;
}
foreach ($parsed_docblock->combined_tags['method'] as $offset => $method_entry) {
$method_entry = preg_replace('/[ \t]+/', ' ', trim($method_entry));

Expand Down Expand Up @@ -481,6 +490,13 @@ public static function parse(

$info->public_api = isset($parsed_docblock->tags['psalm-api']) || isset($parsed_docblock->tags['api']);

if (isset($parsed_docblock->tags['property'])
&& $codebase->config->docblock_property_types_seal_properties
&& $info->sealed_properties === null
) {
$info->sealed_properties = true;
}

self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'property');
self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'psalm-property');
self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'property-read');
Expand Down
6 changes: 0 additions & 6 deletions src/Psalm/Internal/PhpVisitor/Reflector/ClassLikeNodeScanner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,10 +577,6 @@ public function start(PhpParser\Node\Stmt\ClassLike $node): ?bool
);
}
}

if ($this->config->docblock_property_types_seal_properties) {
$storage->sealed_properties = true;
}
}

foreach ($docblock_info->methods as $method) {
Expand All @@ -607,8 +603,6 @@ public function start(PhpParser\Node\Stmt\ClassLike $node): ?bool
$lc_method_name,
);
}

$storage->sealed_methods = true;
}


Expand Down
4 changes: 2 additions & 2 deletions src/Psalm/Internal/Scanner/ClassLikeDocblockComment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ class ClassLikeDocblockComment
*/
public array $methods = [];

public bool $sealed_properties = false;
public ?bool $sealed_properties = null;

public bool $sealed_methods = false;
public ?bool $sealed_methods = null;

public bool $override_property_visibility = false;

Expand Down
19 changes: 15 additions & 4 deletions src/Psalm/Storage/ClassLikeStorage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Psalm\Aliases;
use Psalm\CodeLocation;
use Psalm\Config;
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
use Psalm\Internal\MethodIdentifier;
use Psalm\Internal\Type\TypeAlias\ClassTypeAlias;
Expand Down Expand Up @@ -66,14 +67,14 @@
public $mixin_declaring_fqcln;

/**
* @var bool
* @var ?bool
*/
public $sealed_properties = false;
public $sealed_properties = null;

Check failure on line 72 in src/Psalm/Storage/ClassLikeStorage.php

View workflow job for this annotation

GitHub Actions / Check backward compatibility 

Property Psalm\Storage\ClassLikeStorage#$sealed_properties changed default value from false to NULL

/**
* @var bool
* @var ?bool
*/
public $sealed_methods = false;
public $sealed_methods = null;

Check failure on line 77 in src/Psalm/Storage/ClassLikeStorage.php

View workflow job for this annotation

GitHub Actions / Check backward compatibility 

Property Psalm\Storage\ClassLikeStorage#$sealed_methods changed default value from false to NULL

/**
* @var bool
Expand Down Expand Up @@ -500,4 +501,14 @@

return $type_params;
}

public function hasSealedProperties(Config $config): bool
{
return $this->sealed_properties ?? $config->seal_all_properties;
}

public function hasSealedMethods(Config $config): bool
{
return $this->sealed_methods ?? $config->seal_all_methods;
}
}
25 changes: 25 additions & 0 deletions tests/MagicMethodAnnotationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1174,6 +1174,31 @@ class B extends A {}
$this->analyzeFile('somefile.php', new Context());
}

public function testNoSealAllMethods(): void
{
Config::getInstance()->seal_all_methods = true;

$this->addFile(
'somefile.php',
'<?php
/** @psalm-no-seal-properties */
class A {
public function __call(string $method, array $args) {}
}

class B extends A {}

$b = new B();
$b->foo();
',
);

$error_message = 'UndefinedMagicMethod';
$this->expectException(CodeException::class);
$this->expectExceptionMessage($error_message);
$this->analyzeFile('somefile.php', new Context());
}

public function testSealAllMethodsWithFoo(): void
{
Config::getInstance()->seal_all_methods = true;
Expand Down
24 changes: 24 additions & 0 deletions tests/MagicPropertyTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1213,4 +1213,28 @@ class B extends A {}
$this->expectExceptionMessage($error_message);
$this->analyzeFile('somefile.php', new Context());
}

public function testNoSealAllProperties(): void
{
Config::getInstance()->seal_all_properties = true;
Config::getInstance()->seal_all_methods = true;

$this->addFile(
'somefile.php',
'<?php
/** @psalm-no-seal-properties */
class A {
public function __get(string $name) {}
}

class B extends A {}

$b = new B();
/** @var string $result */
$result = $b->foo;
',
);

$this->analyzeFile('somefile.php', new Context());
}
}