test(phpstan): Start fixing PHPStan level 6 warnings (#1142)

Author: klausi

examples/graphql_composable/src/Plugin/GraphQL/SchemaExtension/ComposableSchemaExampleExtension.php

@@ -21,7 +21,7 @@ class ComposableSchemaExampleExtension extends SdlSchemaExtensionPluginBase {
   /**
    * {@inheritdoc}
    */
-  public function registerResolvers(ResolverRegistryInterface $registry) {
+  public function registerResolvers(ResolverRegistryInterface $registry): void {
     $builder = new ResolverBuilder();
 
     $registry->addFieldResolver('Query', 'article',

examples/graphql_example/src/Plugin/GraphQL/Schema/ExampleSchema.php

@@ -35,7 +35,7 @@ public function getResolverRegistry() {
    * @param \Drupal\graphql\GraphQL\ResolverRegistry $registry
    * @param \Drupal\graphql\GraphQL\ResolverBuilder $builder
    */
-  protected function addArticleFields(ResolverRegistry $registry, ResolverBuilder $builder) {
+  protected function addArticleFields(ResolverRegistry $registry, ResolverBuilder $builder): void {
     $registry->addFieldResolver('Article', 'id',
       $builder->produce('entity_id')
         ->map('entity', $builder->fromParent())
@@ -64,7 +64,7 @@ protected function addArticleFields(ResolverRegistry $registry, ResolverBuilder
    * @param \Drupal\graphql\GraphQL\ResolverRegistry $registry
    * @param \Drupal\graphql\GraphQL\ResolverBuilder $builder
    */
-  protected function addQueryFields(ResolverRegistry $registry, ResolverBuilder $builder) {
+  protected function addQueryFields(ResolverRegistry $registry, ResolverBuilder $builder): void {
     $registry->addFieldResolver('Query', 'article',
       $builder->produce('entity_load')
         ->map('type', $builder->fromValue('node'))
@@ -84,7 +84,7 @@ protected function addQueryFields(ResolverRegistry $registry, ResolverBuilder $b
    * @param \Drupal\graphql\GraphQL\ResolverRegistry $registry
    * @param \Drupal\graphql\GraphQL\ResolverBuilder $builder
    */
-  protected function addConnectionFields($type, ResolverRegistry $registry, ResolverBuilder $builder) {
+  protected function addConnectionFields($type, ResolverRegistry $registry, ResolverBuilder $builder): void {
     $registry->addFieldResolver($type, 'total',
       $builder->callback(function (QueryConnection $connection) {
         return $connection->total();

examples/graphql_example/src/Plugin/GraphQL/SchemaExtension/ExampleSchemaExtension.php

@@ -19,7 +19,7 @@ class ExampleSchemaExtension extends SdlSchemaExtensionPluginBase {
   /**
    * {@inheritdoc}
    */
-  public function registerResolvers(ResolverRegistryInterface $registry) {
+  public function registerResolvers(ResolverRegistryInterface $registry): void {
     $builder = new ResolverBuilder();
 
     $this->addQueryFields($registry, $builder);
@@ -30,7 +30,7 @@ public function registerResolvers(ResolverRegistryInterface $registry) {
    * @param \Drupal\graphql\GraphQL\ResolverRegistryInterface $registry
    * @param \Drupal\graphql\GraphQL\ResolverBuilder $builder
    */
-  protected function addPageFields(ResolverRegistryInterface $registry, ResolverBuilder $builder) {
+  protected function addPageFields(ResolverRegistryInterface $registry, ResolverBuilder $builder): void {
     $registry->addFieldResolver('Page', 'id',
       $builder->produce('entity_id')
         ->map('entity', $builder->fromParent())
@@ -50,7 +50,7 @@ protected function addPageFields(ResolverRegistryInterface $registry, ResolverBu
    * @param \Drupal\graphql\GraphQL\ResolverRegistryInterface $registry
    * @param \Drupal\graphql\GraphQL\ResolverBuilder $builder
    */
-  protected function addQueryFields(ResolverRegistryInterface $registry, ResolverBuilder $builder) {
+  protected function addQueryFields(ResolverRegistryInterface $registry, ResolverBuilder $builder): void {
     $registry->addFieldResolver('Query', 'page',
       $builder->produce('entity_load')
         ->map('type', $builder->fromValue('node'))

graphql.install

@@ -11,7 +11,7 @@ use GraphQL\Error\DebugFlag;
 /**
  * Implements hook_requirements().
  */
-function graphql_requirements($phase) {
+function graphql_requirements(string $phase): array {
   // This is the first reference into the library performed by the module.
   $libraryAvailable = class_exists('\GraphQL\GraphQL');
 
@@ -31,7 +31,7 @@ function graphql_requirements($phase) {
 /**
  * Implements hook_uninstall().
  */
-function graphql_uninstall() {
+function graphql_uninstall(): void {
   // Remove the config keys set in GraphQLConfigOverrides::loadOverrides().
   /** @var \Drupal\Core\Config\ConfigFactoryInterface $configFactory */
   $configFactory = \Drupal::getContainer()->get('config.factory');
@@ -46,7 +46,7 @@ function graphql_uninstall() {
 /**
  * Update GraphQL Server debug configuration value.
  */
-function graphql_update_8001() {
+function graphql_update_8001(): void {
   // The `debug` config item has changed to `debug_flag`. It is no longer a
   // boolean toggle but instead a set of flags providing more control. In this
   // case we default to debug messages and a backtrace in case debugging was

graphql.module

@@ -8,9 +8,9 @@
 /**
  * Implements hook_help().
  */
-function graphql_help($routeName) {
+function graphql_help(string $routeName): ?string {
   if ($routeName !== 'help.page.graphql') {
-    return;
+    return NULL;
   }
 
   $title = t('About');
@@ -32,7 +32,7 @@ EOT;
 /**
  * Implements hook_theme().
  */
-function graphql_theme() {
+function graphql_theme(): array {
   return [
     'page__graphql_explorer' => [
       'render element' => 'elements',

phpcs.xml.dist

@@ -17,6 +17,12 @@
     <exclude-pattern>src/GraphQL/ResolverBuilder.php</exclude-pattern>
   </rule>
 
+  <!-- We want to document the return type on the base class even when there is
+    no return statement on the default implementation. -->
+  <rule ref="Drupal.Commenting.FunctionComment.InvalidNoReturn">
+    <exclude-pattern>src/GraphQL/Buffers/BufferBase.php</exclude-pattern>
+  </rule>
+
   <rule ref="Drupal.Commenting.DocComment.MissingShort">
     <exclude-pattern>src/Plugin/GraphQL/Schema/SdlSchemaPluginBase.php</exclude-pattern>
     <exclude-pattern>src/Plugin/GraphQL/Schema/ComposableSchema.php</exclude-pattern>

phpstan.neon

@@ -8,13 +8,19 @@ parameters:
   # PHPStan cannot find files in this test directory automatically.
   scanDirectories:
     - ../../core/tests/Drupal/Tests
-  level: 5
+  level: 6
   customRulesetUsed: true
   paths:
     - .
   # We test with PHPStan on Drupal 8 and 9 and might have different ignored
   # errors on both.
   reportUnmatchedIgnoredErrors: false
+  # We inherit a lot of Drupal core docs that don't specify iterable types on
+  # arrays, not sure we can fix this in a good way.
+  checkMissingIterableValueType: false
+  # Not sure we can specify generic types properly with Drupal coding standards
+  # yet, disable for now.
+  checkGenericClassInNonGenericObjectType: false
   ignoreErrors:
     # @todo Ignore phpstan-drupal extension's rules for now, activate later.
     - '#\Drupal calls should be avoided in classes, use dependency injection instead#'
@@ -46,3 +52,35 @@ parameters:
       count: 1
       path: src/Plugin/LanguageNegotiation/OperationLanguageNegotiation.php
     - "#^Parameter .+ of method Drupal\\\\Core\\\\Entity\\\\Query\\\\QueryInterface\\:\\:range\\(\\) expects null, int given\\.$#"
+    # We forgot to use return type hints on some interfaces, cannot be changed
+    # in stable 4.0.
+    # @todo use return type hints everywhere for 5.0.
+    -
+      message: "#^Method Drupal\\\\graphql\\\\Entity\\\\ServerInterface\\:\\:addPersistedQueryInstance\\(\\) has no return typehint specified\\.$#"
+      count: 1
+      path: src/Entity/ServerInterface.php
+
+    -
+      message: "#^Method Drupal\\\\graphql\\\\Entity\\\\ServerInterface\\:\\:removePersistedQueryInstance\\(\\) has no return typehint specified\\.$#"
+      count: 1
+      path: src/Entity/ServerInterface.php
+
+    -
+      message: "#^Method Drupal\\\\graphql\\\\Entity\\\\ServerInterface\\:\\:removeAllPersistedQueryInstances\\(\\) has no return typehint specified\\.$#"
+      count: 1
+      path: src/Entity/ServerInterface.php
+
+    -
+      message: "#^Method Drupal\\\\graphql\\\\Plugin\\\\PersistedQueryPluginInterface\\:\\:setWeight\\(\\) has no return typehint specified\\.$#"
+      count: 1
+      path: src/Plugin/PersistedQueryPluginInterface.php
+
+    -
+      message: "#^Method Drupal\\\\graphql\\\\Plugin\\\\SchemaExtensionPluginInterface\\:\\:registerResolvers\\(\\) has no return typehint specified\\.$#"
+      count: 1
+      path: src/Plugin/SchemaExtensionPluginInterface.php
+
+    -
+      message: "#^Unable to resolve the template type ExpectedType in call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\)$#"
+      count: 1
+      path: tests/src/Kernel/ResolverBuilderTest.php

src/Controller/ExplorerController.php

@@ -45,7 +45,7 @@ class ExplorerController implements ContainerInjectionInterface {
    *
    * @codeCoverageIgnore
    */
-  public static function create(ContainerInterface $container) {
+  public static function create(ContainerInterface $container): self {
     return new static(
       $container->get('url_generator'),
       $container->get('graphql.introspection'),

src/Controller/RequestController.php

@@ -25,7 +25,7 @@ class RequestController implements ContainerInjectionInterface {
    *
    * @codeCoverageIgnore
    */
-  public static function create(ContainerInterface $container) {
+  public static function create(ContainerInterface $container): self {
     return new static($container->getParameter('graphql.config'));
   }
 

src/Controller/SubrequestExtractionController.php

@@ -34,7 +34,7 @@ class SubrequestExtractionController extends ControllerBase {
    *
    * @codeCoverageIgnore
    */
-  public static function create(ContainerInterface $container) {
+  public static function create(ContainerInterface $container): self {
     return new static(
       $container->get('request_stack'),
       $container->get('language_manager'),