chore: use treat phpdoc type as certain (#7250)

VincentLanglet · web-flow · commit 078b1a628a18 · 2025-06-30T14:44:06.000+02:00
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -5,6 +5,7 @@ parameters:
 		- tests
 		- tests/Fixtures/app/console
 	inferPrivatePropertyTypeFromConstructor: true
+	treatPhpDocTypesAsCertain: false
 	symfony:
 		containerXmlPath: tests/Fixtures/app/var/cache/test/AppKernelTestDebugContainer.xml
 		constantHassers: false
@@ -107,11 +108,7 @@ parameters:
 		    identifier: property.unusedType
 		-
 		    identifier: varTag.nativeType
-		-
-		    identifier: isset.offset
 		-
 		    identifier: trait.unused
-		-
-		    identifier: instanceof.alwaysTrue
 		-
 		    identifier: catch.neverThrown
diff --git a/src/Doctrine/Odm/State/LinksHandlerTrait.php b/src/Doctrine/Odm/State/LinksHandlerTrait.php
@@ -20,7 +20,6 @@
 use ApiPlatform\State\Util\StateOptionsTrait;
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
 use Doctrine\ODM\MongoDB\DocumentManager;
-use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\Persistence\ManagerRegistry;
 
 /**
@@ -94,10 +93,6 @@ private function buildAggregation(string $toClass, array $links, array $identifi
 
         $classMetadata = $manager->getClassMetadata($aggregationClass);
 
-        if (!$classMetadata instanceof ClassMetadata) {
-            throw new RuntimeException(\sprintf('The class metadata for "%s" must be an instance of "%s".', $aggregationClass, ClassMetadata::class));
-        }
-
         $aggregation = $previousAggregationBuilder;
         if ($aggregationClass !== $previousAggregationClass) {
             $aggregation = $manager->createAggregationBuilder($aggregationClass);
diff --git a/src/Doctrine/Orm/Metadata/Property/DoctrineOrmPropertyMetadataFactory.php b/src/Doctrine/Orm/Metadata/Property/DoctrineOrmPropertyMetadataFactory.php
@@ -70,7 +70,7 @@ public function create(string $resourceClass, string $property, array $options =
 
         if ($doctrineClassMetadata instanceof ClassMetadata && \in_array($property, $doctrineClassMetadata->getFieldNames(), true)) {
             $fieldMapping = $doctrineClassMetadata->getFieldMapping($property);
-            if (class_exists(FieldMapping::class) && $fieldMapping instanceof FieldMapping) {
+            if (class_exists(FieldMapping::class)) {
                 $propertyMetadata = $propertyMetadata->withDefault($fieldMapping->default ?? $propertyMetadata->getDefault());
             } else {
                 $propertyMetadata = $propertyMetadata->withDefault($fieldMapping['options']['default'] ?? $propertyMetadata->getDefault());
diff --git a/src/Doctrine/Orm/State/CollectionProvider.php b/src/Doctrine/Orm/State/CollectionProvider.php
@@ -56,7 +56,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
         $manager = $this->managerRegistry->getManagerForClass($entityClass);
 
         $repository = $manager->getRepository($entityClass);
-        if (!method_exists($repository, 'createQueryBuilder')) { // @phpstan-ignore-line function.alreadyNarrowedType
+        if (!method_exists($repository, 'createQueryBuilder')) {
             throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
         }
 
diff --git a/src/Doctrine/Orm/State/ItemProvider.php b/src/Doctrine/Orm/State/ItemProvider.php
@@ -65,7 +65,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
         }
 
         $repository = $manager->getRepository($entityClass);
-        if (!method_exists($repository, 'createQueryBuilder')) { // @phpstan-ignore-line function.alreadyNarrowedType
+        if (!method_exists($repository, 'createQueryBuilder')) {
             throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
         }
 
diff --git a/src/Elasticsearch/State/ItemProvider.php b/src/Elasticsearch/State/ItemProvider.php
@@ -14,7 +14,6 @@
 namespace ApiPlatform\Elasticsearch\State;
 
 use ApiPlatform\Elasticsearch\Serializer\DocumentNormalizer;
-use ApiPlatform\Metadata\Exception\RuntimeException;
 use ApiPlatform\Metadata\InflectorInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Util\Inflector;
@@ -49,9 +48,9 @@ public function __construct(
     public function provide(Operation $operation, array $uriVariables = [], array $context = []): ?object
     {
         $resourceClass = $operation->getClass();
-        $options = $operation->getStateOptions() instanceof Options ? $operation->getStateOptions() : new Options(index: $this->getIndex($operation));
+        $options = $operation->getStateOptions();
         if (!$options instanceof Options) {
-            throw new RuntimeException(\sprintf('The "%s" provider was called without "%s".', self::class, Options::class));
+            $options = new Options(index: $this->getIndex($operation));
         }
 
         $params = [
diff --git a/src/Metadata/ApiResource.php b/src/Metadata/ApiResource.php
@@ -1026,7 +1026,7 @@ class: $class,
     }
 
     /**
-     * @return Operations<HttpOperation>
+     * @return Operations<HttpOperation>|null
      */
     public function getOperations(): ?Operations
     {
diff --git a/src/Metadata/Tests/Resource/OperationTest.php b/src/Metadata/Tests/Resource/OperationTest.php
@@ -36,7 +36,7 @@ public function testWithResourceTrait(): void
 
         $this->assertSame($operation->getShortName(), 'test');
         $this->assertSame($operation->canRead(), false);
-        $this->assertSame($operation instanceof CollectionOperationInterface, true);
+        $this->assertInstanceOf(CollectionOperationInterface::class, $operation);
     }
 
     #[\PHPUnit\Framework\Attributes\DataProvider('operationProvider')]
diff --git a/src/OpenApi/Factory/OpenApiFactory.php b/src/OpenApi/Factory/OpenApiFactory.php
@@ -186,7 +186,7 @@ private function collectPaths(ApiResource $resource, ResourceMetadataCollection
             $openapiAttribute = $operation->getOpenapi();
 
             // Operation ignored from OpenApi
-            if ($operation instanceof HttpOperation && false === $openapiAttribute) {
+            if (false === $openapiAttribute) {
                 continue;
             }
 
@@ -386,7 +386,7 @@ private function collectPaths(ApiResource $resource, ResourceMetadataCollection
             $existingResponses = $openapiOperation->getResponses() ?: [];
             $overrideResponses = $operation->getExtraProperties()[self::OVERRIDE_OPENAPI_RESPONSES] ?? $this->openApiOptions->getOverrideResponses();
             $errors = null;
-            if ($operation instanceof HttpOperation && null !== ($errors = $operation->getErrors())) {
+            if (null !== ($errors = $operation->getErrors())) {
                 /** @var array<class-string|string, Error> */
                 $errorOperations = [];
                 foreach ($errors as $error) {
@@ -629,7 +629,7 @@ private function getLinks(ResourceMetadataCollection $resourceMetadataCollection
                 }
 
                 // Operation ignored from OpenApi
-                if ($operation instanceof HttpOperation && (false === $operation->getOpenapi() || $operation->getOpenapi() instanceof Webhook)) {
+                if (false === $operation->getOpenapi() || $operation->getOpenapi() instanceof Webhook) {
                     continue;
                 }
 
diff --git a/src/Serializer/AbstractItemNormalizer.php b/src/Serializer/AbstractItemNormalizer.php
@@ -909,7 +909,7 @@ protected function getAttributeValue(object $object, string $attribute, ?string
 
                 $data = $this->normalizeCollectionOfRelations($propertyMetadata, $attributeValue, $resourceClass, $format, $childContext);
                 $context['data'] = $data;
-                $context['type'] = ($nullable && $type instanceof Type) ? Type::nullable($type) : $type;
+                $context['type'] = $nullable ? Type::nullable($type) : $type;
 
                 if ($this->tagCollector) {
                     $this->tagCollector->collect($context);
diff --git a/src/Serializer/Tests/AbstractItemNormalizerTest.php b/src/Serializer/Tests/AbstractItemNormalizerTest.php
@@ -1204,7 +1204,7 @@ public function testDeserializationPathForNotDenormalizableRelations(): void
         $errors = [];
         $actual = $normalizer->denormalize($data, Dummy::class, null, ['not_normalizable_value_exceptions' => &$errors]);
         $this->assertEmpty($actual->relatedDummies);
-        $this->assertCount(1, $errors); // @phpstan-ignore-line method.impossibleType (false positive)
+        $this->assertCount(1, $errors);
         $this->assertInstanceOf(NotNormalizableValueException::class, $errors[0]);
         $this->assertSame('relatedDummies[0]', $errors[0]->getPath());
         $this->assertSame('Invalid IRI "wrong".', $errors[0]->getMessage());
diff --git a/src/State/Provider/DeserializeProvider.php b/src/State/Provider/DeserializeProvider.php
@@ -75,7 +75,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
             throw new UnsupportedMediaTypeHttpException('Format not supported.');
         }
 
-        if ($operation instanceof HttpOperation && null === ($serializerContext[SerializerContextBuilderInterface::ASSIGN_OBJECT_TO_POPULATE] ?? null)) {
+        if (null === ($serializerContext[SerializerContextBuilderInterface::ASSIGN_OBJECT_TO_POPULATE] ?? null)) {
             $method = $operation->getMethod();
             $assignObjectToPopulate = 'POST' === $method
                 || 'PATCH' === $method
diff --git a/src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php b/src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php
@@ -629,7 +629,6 @@ private function registerGraphQlConfiguration(ContainerBuilder $container, array
 
         $loader->load('graphql.xml');
 
-        // @phpstan-ignore-next-line because PHPStan uses the container of the test env cache and in test the parameter kernel.bundles always contains the key TwigBundle
         if (!class_exists(Environment::class) || !isset($container->getParameter('kernel.bundles')['TwigBundle'])) {
             if ($graphiqlEnabled) {
                 throw new RuntimeException(\sprintf('GraphiQL interfaces depend on Twig. Please activate TwigBundle for the %s environnement or disable GraphiQL.', $container->getParameter('kernel.environment')));
diff --git a/src/Symfony/Controller/MainController.php b/src/Symfony/Controller/MainController.php
@@ -49,7 +49,7 @@ public function __invoke(Request $request): Response
     {
         $operation = $this->initializeOperation($request);
 
-        if (!$operation || !$operation instanceof HttpOperation) {
+        if (!$operation instanceof HttpOperation) {
             throw new RuntimeException('Not an HTTP API operation.');
         }
 
diff --git a/src/Symfony/EventListener/DeserializeListener.php b/src/Symfony/EventListener/DeserializeListener.php
@@ -13,7 +13,6 @@
 
 namespace ApiPlatform\Symfony\EventListener;
 
-use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\SerializerContextBuilderInterface;
@@ -62,7 +61,7 @@ public function onKernelRequest(RequestEvent $event): void
             return;
         }
 
-        if (null === $operation->canDeserialize() && $operation instanceof HttpOperation) {
+        if (null === $operation->canDeserialize()) {
             $operation = $operation->withDeserialize(\in_array($method, ['POST', 'PUT', 'PATCH'], true));
         }
 
diff --git a/src/Symfony/EventListener/ReadListener.php b/src/Symfony/EventListener/ReadListener.php
@@ -15,7 +15,6 @@
 
 use ApiPlatform\Metadata\Exception\InvalidIdentifierException;
 use ApiPlatform\Metadata\Exception\InvalidUriVariableException;
-use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\UriVariablesConverterInterface;
 use ApiPlatform\Metadata\Util\CloneTrait;
@@ -73,7 +72,7 @@ public function onKernelRequest(RequestEvent $event): void
         }
 
         $uriVariables = [];
-        if (!$request->attributes->has('exception') && $operation instanceof HttpOperation) {
+        if (!$request->attributes->has('exception')) {
             try {
                 $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $operation->getClass());
             } catch (InvalidIdentifierException|InvalidUriVariableException $e) {
diff --git a/src/Symfony/EventListener/WriteListener.php b/src/Symfony/EventListener/WriteListener.php
@@ -16,7 +16,6 @@
 use ApiPlatform\Metadata\Error;
 use ApiPlatform\Metadata\Exception\InvalidIdentifierException;
 use ApiPlatform\Metadata\Exception\InvalidUriVariableException;
-use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\UriVariablesConverterInterface;
 use ApiPlatform\Metadata\Util\ClassInfoTrait;
@@ -70,7 +69,7 @@ public function onKernelView(ViewEvent $event): void
         }
 
         $uriVariables = $request->attributes->get('_api_uri_variables') ?? [];
-        if (!$uriVariables && !$operation instanceof Error && $operation instanceof HttpOperation) {
+        if (!$uriVariables && !$operation instanceof Error) {
             try {
                 $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $operation->getClass());
             } catch (InvalidIdentifierException|InvalidUriVariableException $e) {

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ parameters:`
`5`	`5`	`- tests`
`6`	`6`	`- tests/Fixtures/app/console`
`7`	`7`	`inferPrivatePropertyTypeFromConstructor: true`
	`8`	`+ treatPhpDocTypesAsCertain: false`
`8`	`9`	`symfony:`
`9`	`10`	`containerXmlPath: tests/Fixtures/app/var/cache/test/AppKernelTestDebugContainer.xml`
`10`	`11`	`constantHassers: false`
`@@ -107,11 +108,7 @@ parameters:`
`107`	`108`	`identifier: property.unusedType`
`108`	`109`	`-`
`109`	`110`	`identifier: varTag.nativeType`
`110`		`- -`
`111`		`- identifier: isset.offset`
`112`	`111`	`-`
`113`	`112`	`identifier: trait.unused`
`114`		`- -`
`115`		`- identifier: instanceof.alwaysTrue`
`116`	`113`	`-`
`117`	`114`	`identifier: catch.neverThrown`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c`
`56`	`56`	`$manager = $this->managerRegistry->getManagerForClass($entityClass);`
`57`	`57`
`58`	`58`	`$repository = $manager->getRepository($entityClass);`
`59`		`- if (!method_exists($repository, 'createQueryBuilder')) { // @phpstan-ignore-line function.alreadyNarrowedType`
	`59`	`+ if (!method_exists($repository, 'createQueryBuilder')) {`
`60`	`60`	`throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');`
`61`	`61`	`}`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`$repository = $manager->getRepository($entityClass);`
`68`		`- if (!method_exists($repository, 'createQueryBuilder')) { // @phpstan-ignore-line function.alreadyNarrowedType`
	`68`	`+ if (!method_exists($repository, 'createQueryBuilder')) {`
`69`	`69`	`throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');`
`70`	`70`	`}`
`71`	`71`
Original file line number	Diff line number	Diff line change
`@@ -1026,7 +1026,7 @@ class: $class,`
`1026`	`1026`	`}`
`1027`	`1027`
`1028`	`1028`	`/**`
`1029`		`- * @return Operations<HttpOperation>`
	`1029`	`+ * @return Operations<HttpOperation>\|null`
`1030`	`1030`	`*/`
`1031`	`1031`	`public function getOperations(): ?Operations`
`1032`	`1032`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function testWithResourceTrait(): void`
`36`	`36`
`37`	`37`	`$this->assertSame($operation->getShortName(), 'test');`
`38`	`38`	`$this->assertSame($operation->canRead(), false);`
`39`		`- $this->assertSame($operation instanceof CollectionOperationInterface, true);`
	`39`	`+ $this->assertInstanceOf(CollectionOperationInterface::class, $operation);`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`#[\PHPUnit\Framework\Attributes\DataProvider('operationProvider')]`