Add DependencySerializationTraitPropertyRule (#731)

* Add rule for FormInterface that privates are no longer allowed (#730)

* Comply with codestyle

* support returning multiple errors

* Make rule generic for all DependencySerializationTrait usages

* make rule configurable

* add tests

* adjust error messages

---------

Co-authored-by: TBiesenbeek <[email protected]>
Co-authored-by: Matt Glaman <[email protected]>

Author: 3 people

extension.neon

@@ -21,6 +21,7 @@ parameters:
 			checkDeprecatedHooksInApiFiles: false
 		rules:
 			testClassSuffixNameRule: false
+			dependencySerializationTraitPropertyRule: false
 		entityMapping:
 			aggregator_feed:
 				class: Drupal\aggregator\Entity\Feed
@@ -242,6 +243,7 @@ parametersSchema:
 		])
 		rules: structure([
 			testClassSuffixNameRule: boolean()
+			dependencySerializationTraitPropertyRule: boolean()
 		])
 		entityMapping: arrayOf(anyOf(
 			structure([

rules.neon

@@ -23,7 +23,11 @@ rules:
 conditionalTags:
 	mglaman\PHPStanDrupal\Rules\Drupal\Tests\TestClassSuffixNameRule:
 		phpstan.rules.rule: %drupal.rules.testClassSuffixNameRule%
+	mglaman\PHPStanDrupal\Rules\Drupal\DependencySerializationTraitPropertyRule:
+		phpstan.rules.rule: %drupal.rules.dependencySerializationTraitPropertyRule%
 
 services:
 	-
 		class: mglaman\PHPStanDrupal\Rules\Drupal\Tests\TestClassSuffixNameRule
+	-
+		class: mglaman\PHPStanDrupal\Rules\Drupal\DependencySerializationTraitPropertyRule

src/Rules/Drupal/DependencySerializationTraitPropertyRule.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Rules\Drupal;
+
+use Drupal\Core\DependencyInjection\DependencySerializationTrait;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\ClassPropertyNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/**
+ * @implements Rule<ClassPropertyNode>
+ */
+final class DependencySerializationTraitPropertyRule implements Rule
+{
+
+    public function getNodeType(): string
+    {
+        return ClassPropertyNode::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (!$node->getClassReflection()->hasTraitUse(DependencySerializationTrait::class)) {
+            return [];
+        }
+
+        $errors = [];
+        if ($node->isPrivate()) {
+            $errors[] = RuleErrorBuilder::message(
+                sprintf(
+                    '%s does not support private properties.',
+                    DependencySerializationTrait::class
+                )
+            )->tip('See https://www.drupal.org/node/3110266')->build();
+        }
+        if ($node->isReadOnly()) {
+            $errors[] = RuleErrorBuilder::message(
+                sprintf(
+                    'Read-only properties are incompatible with %s.',
+                    DependencySerializationTrait::class
+                )
+            )->tip('See https://www.drupal.org/node/3110266')->build();
+        }
+        return $errors;
+    }
+}

tests/src/Rules/DependencySerializationTraitPropertyRuleTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace mglaman\PHPStanDrupal\Tests\Rules;
+
+use mglaman\PHPStanDrupal\Rules\Drupal\DependencySerializationTraitPropertyRule;
+use mglaman\PHPStanDrupal\Tests\DrupalRuleTestCase;
+use PHPStan\Rules\Rule;
+
+final class DependencySerializationTraitPropertyRuleTest extends DrupalRuleTestCase
+{
+
+    protected function getRule(): Rule
+    {
+        return new DependencySerializationTraitPropertyRule();
+    }
+
+    public function testRule(): void
+    {
+        $this->analyse(
+            [__DIR__.'/data/dependency-serialization-trait.php'],
+            [
+                [
+                    'Drupal\Core\DependencyInjection\DependencySerializationTrait does not support private properties.',
+                    16,
+                    'See https://www.drupal.org/node/3110266',
+                ],
+                [
+                    'Drupal\Core\DependencyInjection\DependencySerializationTrait does not support private properties.',
+                    22,
+                    'See https://www.drupal.org/node/3110266',
+                ],
+                [
+                    'Read-only properties are incompatible with Drupal\Core\DependencyInjection\DependencySerializationTrait.',
+                    22,
+                    'See https://www.drupal.org/node/3110266',
+                ],
+                [
+                    'Read-only properties are incompatible with Drupal\Core\DependencyInjection\DependencySerializationTrait.',
+                    28,
+                    'See https://www.drupal.org/node/3110266',
+                ],
+                [
+                    'Drupal\Core\DependencyInjection\DependencySerializationTrait does not support private properties.',
+                    32,
+                    'See https://www.drupal.org/node/3110266',
+                ],
+            ]
+        );
+    }
+}

tests/src/Rules/data/dependency-serialization-trait.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace DependencySerialization;
+
+use Drupal\Core\DependencyInjection\DependencySerializationTrait;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Form\FormBase;
+
+class Foo {
+    private EntityTypeManagerInterface $entityTypeManager;
+}
+
+class Bar {
+    use DependencySerializationTrait;
+
+    private EntityTypeManagerInterface $entityTypeManager;
+}
+
+class Baz {
+    use DependencySerializationTrait;
+
+    private readonly EntityTypeManagerInterface $entityTypeManager;
+}
+
+class Qux {
+    use DependencySerializationTrait;
+
+    protected readonly EntityTypeManagerInterface $entityTypeManager;
+}
+
+class FooForm extends FormBase {
+    private EntityTypeManagerInterface $entityTypeManager;
+}