Reword from has to with, add test with ::entityQuery static method

mglaman · mglaman · commit 693c356eebf6 · 2022-04-06T14:22:33.000-05:00
diff --git a/extension.neon b/extension.neon
@@ -288,7 +288,7 @@ services:
 		class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryDynamicReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
-		class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryHasAccessCheckDynamicReturnTypeExtension
+		class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryAccessCheckDynamicReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\UrlToStringDynamicReturnTypeExtension
diff --git a/src/Rules/Drupal/EntityQuery/EntityQueryHasAccessCheckRule.php b/src/Rules/Drupal/EntityQuery/EntityQueryHasAccessCheckRule.php
@@ -4,20 +4,18 @@
 
 namespace mglaman\PHPStanDrupal\Rules\Drupal\EntityQuery;
 
-use mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryExecuteDoesNotHaveAccessCheckCountType;
-use mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryExecuteDoesNotHaveAccessCheckType;
-use mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryType;
+use mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryExecuteWithoutAccessCheckCountType;
+use mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryExecuteWithoutAccessCheckType;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use function PHPStan\dumpType;
 
 final class EntityQueryHasAccessCheckRule implements Rule
 {
     public function getNodeType(): string
     {
-        return \PhpParser\Node\Expr\MethodCall::class;
+        return Node\Expr\MethodCall::class;
     }
 
     public function processNode(Node $node, Scope $scope): array
@@ -36,7 +34,7 @@ public function processNode(Node $node, Scope $scope): array
 
         $type = $scope->getType($node);
 
-        if (!$type instanceof EntityQueryExecuteDoesNotHaveAccessCheckCountType && !$type instanceof EntityQueryExecuteDoesNotHaveAccessCheckType) {
+        if (!$type instanceof EntityQueryExecuteWithoutAccessCheckCountType && !$type instanceof EntityQueryExecuteWithoutAccessCheckType) {
             return [];
         }
 
diff --git a/src/Type/EntityQuery/EntityQueryAccessCheckDynamicReturnTypeExtension.php b/src/Type/EntityQuery/EntityQueryAccessCheckDynamicReturnTypeExtension.php
@@ -12,7 +12,7 @@
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
 use PHPStan\Type\Type;
 
-class EntityQueryHasAccessCheckDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+class EntityQueryAccessCheckDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
 {
     public function getClass(): string
     {
diff --git a/src/Type/EntityQuery/EntityQueryDynamicReturnTypeExtension.php b/src/Type/EntityQuery/EntityQueryDynamicReturnTypeExtension.php
@@ -54,17 +54,17 @@ public function getTypeFromMethodCall(
             if ($varType instanceof EntityQueryCountType) {
                 return $varType->hasAccessCheck()
                     ? new IntegerType()
-                    : new EntityQueryExecuteDoesNotHaveAccessCheckCountType();
+                    : new EntityQueryExecuteWithoutAccessCheckCountType();
             }
             if ($varType instanceof ConfigEntityQueryType) {
                 return $varType->hasAccessCheck()
                     ? new ArrayType(new StringType(), new StringType())
-                    : new EntityQueryExecuteDoesNotHaveAccessCheckType(new StringType(), new StringType());
+                    : new EntityQueryExecuteWithoutAccessCheckType(new StringType(), new StringType());
             }
             if ($varType instanceof ContentEntityQueryType) {
                 return $varType->hasAccessCheck()
                     ? new ArrayType(new IntegerType(), new StringType())
-                    : new EntityQueryExecuteDoesNotHaveAccessCheckType(new IntegerType(), new StringType());
+                    : new EntityQueryExecuteWithoutAccessCheckType(new IntegerType(), new StringType());
             }
             return $defaultReturnType;
         }
diff --git a/src/Type/EntityQuery/EntityQueryExecuteWithoutAccessCheckCountType.php b/src/Type/EntityQuery/EntityQueryExecuteWithoutAccessCheckCountType.php
@@ -6,7 +6,7 @@
 
 use PHPStan\Type\IntegerType;
 
-final class EntityQueryExecuteDoesNotHaveAccessCheckCountType extends IntegerType
+final class EntityQueryExecuteWithoutAccessCheckCountType extends IntegerType
 {
 
 }
diff --git a/src/Type/EntityQuery/EntityQueryExecuteWithoutAccessCheckType.php b/src/Type/EntityQuery/EntityQueryExecuteWithoutAccessCheckType.php
@@ -8,7 +8,7 @@
 
 use PHPStan\Type\StringType;
 
-final class EntityQueryExecuteDoesNotHaveAccessCheckType extends ArrayType
+final class EntityQueryExecuteWithoutAccessCheckType extends ArrayType
 {
 
 }
diff --git a/tests/fixtures/drupal/modules/phpstan_fixtures/src/EntityQueryWithAccessRule.php b/tests/fixtures/drupal/modules/phpstan_fixtures/src/EntityQueryWithAccessRule.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace fixtures\drupal\modules\phpstan_fixtures\src;
+
+final class EntityQueryWithAccessRule
+{
+    public function foo(): void
+    {
+        \Drupal::entityTypeManager()->getStorage('node')
+            ->getQuery()
+            ->accessCheck(FALSE)
+            ->condition('field_test', 'foo', '=')
+            ->execute();
+    }
+
+    public function bar(): void
+    {
+        \Drupal::entityQuery('node')
+            ->accessCheck(FALSE)
+            ->condition('field_test', 'foo', '=')
+            ->execute();
+    }
+}
diff --git a/tests/fixtures/drupal/modules/phpstan_fixtures/src/EntityQueryWithoutAccessRule.php b/tests/fixtures/drupal/modules/phpstan_fixtures/src/EntityQueryWithoutAccessRule.php
@@ -4,9 +4,7 @@
 
 namespace fixtures\drupal\modules\phpstan_fixtures\src;
 
-use function PHPStan\dumpType;
-
-final class EntityQueryDoesNotHaveAccessRule
+final class EntityQueryWithoutAccessRule
 {
     public function foo(): void
     {
@@ -15,4 +13,12 @@ public function foo(): void
             ->condition('field_test', 'foo', '=')
             ->execute();
     }
+
+    public function bar(): void
+    {
+        \Drupal::entityQuery('node')
+            ->condition('field_test', 'foo', '=')
+            ->execute();
+    }
+
 }
diff --git a/tests/src/Rules/EntityQueryHasAccessCheckRuleTest.php b/tests/src/Rules/EntityQueryHasAccessCheckRuleTest.php
@@ -25,18 +25,23 @@ public function test(array $files, array $errors): void
     public function cases(): \Generator
     {
         yield [
-            [__DIR__.'/../../fixtures/drupal/modules/phpstan_fixtures/src/EntityQueryHasAccessRule.php'],
+            [__DIR__.'/../../fixtures/drupal/modules/phpstan_fixtures/src/EntityQueryWithAccessRule.php'],
             [],
         ];
 
         yield [
-            [__DIR__.'/../../fixtures/drupal/modules/phpstan_fixtures/src/EntityQueryDoesNotHaveAccessRule.php'],
+            [__DIR__.'/../../fixtures/drupal/modules/phpstan_fixtures/src/EntityQueryWithoutAccessRule.php'],
             [
                 [
                     'Missing explicit access check on entity query.',
-                    13,
+                    11,
                     'See https://www.drupal.org/node/3201242',
-                ]
+                ],
+                [
+                    'Missing explicit access check on entity query.',
+                    19,
+                    'See https://www.drupal.org/node/3201242',
+                ],
             ],
         ];
     }

Original file line number	Diff line number	Diff line change
`@@ -288,7 +288,7 @@ services:`
`288`	`288`	`class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryDynamicReturnTypeExtension`
`289`	`289`	`tags: [phpstan.broker.dynamicMethodReturnTypeExtension]`
`290`	`290`	`-`
`291`		`- class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryHasAccessCheckDynamicReturnTypeExtension`
	`291`	`+ class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryAccessCheckDynamicReturnTypeExtension`
`292`	`292`	`tags: [phpstan.broker.dynamicMethodReturnTypeExtension]`
`293`	`293`	`-`
`294`	`294`	`class: mglaman\PHPStanDrupal\Type\UrlToStringDynamicReturnTypeExtension`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`use PHPStan\Type\DynamicMethodReturnTypeExtension;`
`13`	`13`	`use PHPStan\Type\Type;`
`14`	`14`
`15`		`-class EntityQueryHasAccessCheckDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension`
	`15`	`+class EntityQueryAccessCheckDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension`
`16`	`16`	`{`
`17`	`17`	`public function getClass(): string`
`18`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -54,17 +54,17 @@ public function getTypeFromMethodCall(`
`54`	`54`	`if ($varType instanceof EntityQueryCountType) {`
`55`	`55`	`return $varType->hasAccessCheck()`
`56`	`56`	`? new IntegerType()`
`57`		`- : new EntityQueryExecuteDoesNotHaveAccessCheckCountType();`
	`57`	`+ : new EntityQueryExecuteWithoutAccessCheckCountType();`
`58`	`58`	`}`
`59`	`59`	`if ($varType instanceof ConfigEntityQueryType) {`
`60`	`60`	`return $varType->hasAccessCheck()`
`61`	`61`	`? new ArrayType(new StringType(), new StringType())`
`62`		`- : new EntityQueryExecuteDoesNotHaveAccessCheckType(new StringType(), new StringType());`
	`62`	`+ : new EntityQueryExecuteWithoutAccessCheckType(new StringType(), new StringType());`
`63`	`63`	`}`
`64`	`64`	`if ($varType instanceof ContentEntityQueryType) {`
`65`	`65`	`return $varType->hasAccessCheck()`
`66`	`66`	`? new ArrayType(new IntegerType(), new StringType())`
`67`		`- : new EntityQueryExecuteDoesNotHaveAccessCheckType(new IntegerType(), new StringType());`
	`67`	`+ : new EntityQueryExecuteWithoutAccessCheckType(new IntegerType(), new StringType());`
`68`	`68`	`}`
`69`	`69`	`return $defaultReturnType;`
`70`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`use PHPStan\Type\IntegerType;`
`8`	`8`
`9`		`-final class EntityQueryExecuteDoesNotHaveAccessCheckCountType extends IntegerType`
	`9`	`+final class EntityQueryExecuteWithoutAccessCheckCountType extends IntegerType`
`10`	`10`	`{`
`11`	`11`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`use PHPStan\Type\StringType;`
`10`	`10`
`11`		`-final class EntityQueryExecuteDoesNotHaveAccessCheckType extends ArrayType`
	`11`	`+final class EntityQueryExecuteWithoutAccessCheckType extends ArrayType`
`12`	`12`	`{`
`13`	`13`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace fixtures\drupal\modules\phpstan_fixtures\src;`
`6`	`6`
`7`		`-use function PHPStan\dumpType;`
`8`		`-`
`9`		`-final class EntityQueryDoesNotHaveAccessRule`
	`7`	`+final class EntityQueryWithoutAccessRule`
`10`	`8`	`{`
`11`	`9`	`public function foo(): void`
`12`	`10`	`{`
`@@ -15,4 +13,12 @@ public function foo(): void`
`15`	`13`	`->condition('field_test', 'foo', '=')`
`16`	`14`	`->execute();`
`17`	`15`	`}`
	`16`	`+`
	`17`	`+ public function bar(): void`
	`18`	`+ {`
	`19`	`+ \Drupal::entityQuery('node')`
	`20`	`+ ->condition('field_test', 'foo', '=')`
	`21`	`+ ->execute();`
	`22`	`+ }`
	`23`	`+`
`18`	`24`	`}`