Merge pull request #219 from mglaman/fix-head

Fix remaining test and analysis errors

Author: mglaman

phpstan.neon

@@ -5,8 +5,11 @@ parameters:
 	level: 8
 	checkGenericClassInNonGenericObjectType: false
 	checkMissingIterableValueType: false
+	reportUnmatchedIgnoredErrors: false
 	paths:
 		- src
 		- drupal-phpunit-hack.php
 		- drupal-autoloader.php
 		- tests/src
+	excludePaths:
+		-  tests/src/Type/data/entity-type-manager.php

phpunit.xml

@@ -6,15 +6,17 @@
          beStrictAboutCoversAnnotation="true"
          beStrictAboutOutputDuringTests="true"
          beStrictAboutTodoAnnotatedTests="true"
+         beStrictAboutChangesToGlobalState="true"
          verbose="false">
     <php>
         <ini name="error_reporting" value="32767"/>
         <ini name="memory_limit" value="-1"/>
+        <!-- Drupal requires Symfony PHPUnit Bridge, silence its warnings. -->
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled"/>
     </php>
     <testsuites>
         <testsuite name="default">
-            <directory suffix="Test.php">tests</directory>
-            <exclude>tests/fixtures/</exclude>
+            <directory suffix="Test.php">tests/src</directory>
         </testsuite>
     </testsuites>
     <logging>

src/Drupal/DrupalAutoloader.php

@@ -188,15 +188,7 @@ class: Drupal\jsonapi\Routing\JsonApiParamEnhancer
         }
 
         $service_map = $container->getByType(ServiceMap::class);
-        assert($service_map instanceof ServiceMap);
-        // @todo this is a hack that needs investigation.
-        // We cannot manipulate the service container and add parameters, so we take the existing
-        // service and modify it's properties so that its reference is updated within the container.
-        //
-        // During debug this works, but other times it fails.
         $service_map->setDrupalServices($this->serviceMap);
-        // So, to work around whatever is happening we force it into globals.
-        $GLOBALS['drupalServiceMap'] = $service_map->getServices();
     }
 
     protected function loadLegacyIncludes(): void

src/Drupal/ServiceMap.php

@@ -2,56 +2,54 @@
 
 namespace mglaman\PHPStanDrupal\Drupal;
 
-use PHPStan\ShouldNotHappenException;
-
 class ServiceMap
 {
-    /** @var \mglaman\PHPStanDrupal\Drupal\DrupalServiceDefinition[] */
-    private $services = [];
+    /** @var DrupalServiceDefinition[] */
+    private static $services = [];
 
     public function getService(string $id): ?DrupalServiceDefinition
     {
-        // @see notes in DrupalAutoloader.
-        // This is all a work around due to inability to set container parameters.
-        if (count($this->services) === 0) {
-            $this->services = $GLOBALS['drupalServiceMap'] ?? [];
-            if (count($this->services) === 0) {
-                throw new ShouldNotHappenException('No Drupal service map was registered.');
-            }
-        }
-        return $this->services[$id] ?? null;
+        return self::$services[$id] ?? null;
     }
 
     /**
-     * @return \mglaman\PHPStanDrupal\Drupal\DrupalServiceDefinition[]
+     * @return DrupalServiceDefinition[]
      */
     public function getServices(): array
     {
-        return $this->services;
+        return self::$services;
     }
 
     public function setDrupalServices(array $drupalServices): void
     {
-        $this->services = [];
+        self::$services = [];
 
         foreach ($drupalServices as $serviceId => $serviceDefinition) {
             // @todo support factories
             if (!isset($serviceDefinition['class'])) {
                 if (isset($serviceDefinition['alias'], $drupalServices[$serviceDefinition['alias']])) {
-                    $serviceDefinition['class'] = $drupalServices[$serviceDefinition['alias']]['class'];
+                    $aliasedService = $drupalServices[$serviceDefinition['alias']];
+
+                    if (isset($aliasedService['class'])) {
+                        $serviceDefinition['class'] = $drupalServices[$serviceDefinition['alias']]['class'];
+                    } elseif (class_exists($serviceDefinition['alias'])) {
+                        $serviceDefinition['class'] = $serviceDefinition['alias'];
+                    }
+                } elseif (class_exists($serviceId)) {
+                    $serviceDefinition['class'] = $serviceId;
                 } else {
                     continue;
                 }
             }
-            $this->services[$serviceId] = new DrupalServiceDefinition(
+            self::$services[$serviceId] = new DrupalServiceDefinition(
                 (string) $serviceId,
                 $serviceDefinition['class'],
                 $serviceDefinition['public'] ?? true,
                 $serviceDefinition['alias'] ?? null
             );
             $deprecated = $serviceDefinition['deprecated'] ?? null;
             if ($deprecated) {
-                $this->services[$serviceId]->setDeprecated(true, $deprecated);
+                self::$services[$serviceId]->setDeprecated(true, $deprecated);
             }
         }
     }

src/Rules/Drupal/LoadIncludes.php

@@ -86,6 +86,7 @@ public function processNode(Node $node, Scope $scope): array
 
             $module_name = $module_arg->value->value;
             if (!isset($modules[$module_name])) {
+                // @todo return error that module is missing.
                 return [];
             }
             $type_prefix = $name_arg->value->value;

src/Rules/Drupal/ModuleLoadInclude.php

@@ -72,6 +72,7 @@ public function processNode(Node $node, Scope $scope): array
 
             $module_name = $module_arg->value->value;
             if (!isset($modules[$module_name])) {
+                // @todo return error that the module does not exist.
                 return [];
             }
             $type_prefix = $name_arg->value->value;

src/Type/EntityTypeManagerGetStorageDynamicReturnTypeExtension.php

@@ -76,6 +76,8 @@ public function getTypeFromMethodCall(
         if (isset($this->entityTypeStorageMapping[$entityTypeId])) {
             return new ObjectType($this->entityTypeStorageMapping[$entityTypeId]);
         }
+        // @todo get entity type class reflection and return proper storage for entity type
+        // example: config storage, sqlcontententitystorage, etc.
         return $returnType;
     }
 }

tests/fixtures/drupal/modules/module_load_include_fixture/module_load_include_fixture.module

@@ -7,4 +7,5 @@ function test_locale_translation_inc_included() {
     locale_translation_build_projects();
     module_load_include('translation.inc', 'locale');
     locale_translation_build_sources();
+    module_load_include('translationzzzz.inc', 'locale');
 }