New rule to detect incorrect use of addCacheableDependency

rules.neon

@@ -12,6 +12,7 @@ rules:
 	- mglaman\PHPStanDrupal\Rules\Drupal\LoadIncludes
 	- mglaman\PHPStanDrupal\Rules\Drupal\EntityQuery\EntityQueryHasAccessCheckRule
 	- mglaman\PHPStanDrupal\Rules\Drupal\TestClassesProtectedPropertyModulesRule
+	- mglaman\PHPStanDrupal\Rules\Drupal\CacheableDependencyRule
 
 conditionalTags:
 	mglaman\PHPStanDrupal\Rules\Drupal\Tests\TestClassSuffixNameRule:

src/Rules/Drupal/CacheableDependencyRule.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Rules\Drupal;
+
+use PhpParser\Node;
+use PhpParser\NodeFinder;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+
+/**
+ * @implements Rule<Node\Expr\StaticCall>
+ */
+class CacheableDependencyRule implements Rule
+{
+
+    public function getNodeType(): string
+    {
+        return Node\Expr\MethodCall::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        $nodeFinder = new NodeFinder();
+        $method = $nodeFinder->findFirst($class->stmts, static function (Node $node) {
+            return $node instanceof Node\Stmt\ClassMethod && $node->name->toString() === 'addCacheableDependency';
+        });
+        if (!$method instanceof Node\Stmt\ClassMethod) {
+            return [];
+        }
+
+        $args = $node->getArgs();
+        $traversableArg = $args[0]->value;
+        $object = $scope->getType($traversableArg);
+
+        // We need to check if isInstanceOf method exists as phpstan returns
+        // MixedType for unknown objects.
+        if (method_exists($object, 'isInstanceOf') && $object->isInstanceOf('Drupal\Core\Cache\CacheableDependencyInterface')) {
+            return [];
+        }
+        return [
+            'Calling addCacheableDependency($object) when $object does not implement CacheableDependencyInterface effectively disables caching and should be avoided.',
+        ];
+    }
+}

tests/fixtures/drupal/modules/phpstan_fixtures/src/UsesIncorrectCacheableDependency.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Drupal\phpstan_fixtures;
+
+use Drupal\Core\Cache\CacheableMetadata;
+
+class UsesIncorrectCacheableDependency {
+    public function test() {
+        $element = [];
+        $cacheable_metadata = CacheableMetadata::createFromRenderArray($element);
+
+        $object = new \Stdclass;
+        $cacheable_metadata->addCacheableDependency($object);
+    }
+}

tests/src/Rules/CachableDependencyRuleTest.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Rules;
+
+use mglaman\PHPStanDrupal\Rules\Drupal\CacheableDependencyRule;
+use mglaman\PHPStanDrupal\Tests\DrupalRuleTestCase;
+
+final class CachableDependencyRuleTest extends DrupalRuleTestCase {
+
+    protected function getRule(): \PHPStan\Rules\Rule
+    {
+        return new CacheableDependencyRule();
+    }
+
+    /**
+     * @dataProvider resultData
+     *
+     * @param list<array{0: string, 1: int, 2?: string|null}> $errorMessages
+     */
+    public function testRule(string $path, array $errorMessages): void
+    {
+        $this->analyse([$path], $errorMessages);
+    }
+
+    public static function resultData(): \Generator
+    {
+        yield [
+            __DIR__ . '/../../fixtures/drupal/modules/phpstan_fixtures/src/UsesIncorrectCacheableDependency.php',
+            [
+                [
+                    'Calling addCacheableDependency($object) when $object does not implement CacheableDependencyInterface effectively disables caching and should be avoided.',
+                    07
+                ],
+            ]
+        ];
+
+    }
+
+
+}