Don't loop infinitely on self-referencing types

Author: vojtech-dobes

src/GraphQL/CorrespondanceRule.php

@@ -154,6 +154,7 @@ private function listFieldResolvedValueErrors(
 			$objectType,
 			$fieldName,
 			$resolverClassType,
+			[],
 		);
 
 		foreach ($errors as $error) {
@@ -186,6 +187,7 @@ private function listFieldResolvedValueErrors(
 
 
 	/**
+	 * @param list<string> $alreadyVisitedFields
 	 * @return array{list<PHPStan\Type\Type>, list<string>}
 	 */
 	private function listFieldResolvedValueTypes(
@@ -194,15 +196,23 @@ private function listFieldResolvedValueTypes(
 		string $objectType,
 		string $fieldName,
 		PHPStan\Type\ObjectType $resolverClassType,
+		array $alreadyVisitedFields,
 	): array
 	{
 		$errors = [];
 		$types = [];
 
+		$parentTypes = $this->listObjectTypeResolvedValueTypes(
+			$scope,
+			$schemaServiceOraculum,
+			$objectType,
+			[...$alreadyVisitedFields, "$objectType.$fieldName"],
+		);
+
 		if ($resolverClassType->getClassName() === Vojtechdobes\GraphQL\ArrayFieldResolver::class) {
 			$offsetType = new PHPStan\Type\Constant\ConstantStringType($fieldName);
 
-			foreach ($this->listObjectTypeResolvedValueTypes($scope, $schemaServiceOraculum, $objectType) as $parentType) {
+			foreach ($parentTypes as $parentType) {
 				if ($parentType->isOffsetAccessible()->yes() === false) {
 					$errors[] = sprintf(
 						"Resolver %s of field %s expects parent to have array access, but parent is resolved to %s",
@@ -225,7 +235,7 @@ private function listFieldResolvedValueTypes(
 		} elseif ($resolverClassType->getClassName() === Vojtechdobes\GraphQL\GetterFieldResolver::class) {
 			$methodName = 'get' . ucfirst($fieldName);
 
-			foreach ($this->listObjectTypeResolvedValueTypes($scope, $schemaServiceOraculum, $objectType) as $parentType) {
+			foreach ($parentTypes as $parentType) {
 				if ($parentType->isObject()->yes() === false) {
 					$errors[] = sprintf(
 						"Resolver %s of field %s expects parent to be an object, but parent is resolved to %s",
@@ -250,7 +260,7 @@ private function listFieldResolvedValueTypes(
 				}
 			}
 		} elseif ($resolverClassType->getClassName() === Vojtechdobes\GraphQL\PropertyFieldResolver::class) {
-			foreach ($this->listObjectTypeResolvedValueTypes($scope, $schemaServiceOraculum, $objectType) as $parentType) {
+			foreach ($parentTypes as $parentType) {
 				if ($parentType->isObject()->yes() === false) {
 					$errors[] = sprintf(
 						"Resolver %s of field %s expects parent to be an object, but parent is resolved to %s",
@@ -274,7 +284,7 @@ private function listFieldResolvedValueTypes(
 		} else {
 			$expectedParentType = $resolverClassType->getTemplateType(Vojtechdobes\GraphQL\FieldResolver::class, 'TObjectValue');
 
-			foreach ($this->listObjectTypeResolvedValueTypes($scope, $schemaServiceOraculum, $objectType) as $parentType) {
+			foreach ($parentTypes as $parentType) {
 				if ($expectedParentType->isSuperTypeOf($parentType)->yes() === false) {
 					$errors[] = sprintf(
 						"Resolver %s of field %s expects parent to be %s, but parent is resolved to %s",
@@ -303,12 +313,14 @@ private function listFieldResolvedValueTypes(
 
 
 	/**
+	 * @param list<string> $alreadyVisitedFields
 	 * @return list<PHPStan\Type\Type>
 	 */
 	private function listObjectTypeResolvedValueTypes(
 		PHPStan\Analyser\Scope $scope,
 		SchemaServiceOraculum $schemaServiceOraculum,
 		string $objectType,
+		array $alreadyVisitedFields,
 	): array
 	{
 		$result = [];
@@ -318,12 +330,19 @@ private function listObjectTypeResolvedValueTypes(
 		}
 
 		foreach ($schemaServiceOraculum->listFieldsResolvedToObjectType($objectType) as [$parentObjectType, $parentFieldName]) {
+			$parentField = "{$parentObjectType}.{$parentFieldName}";
+
+			if (in_array($parentField, $alreadyVisitedFields, true)) {
+				continue;
+			}
+
 			[$parentTypes] = $this->listFieldResolvedValueTypes(
 				$scope,
 				$schemaServiceOraculum,
 				$parentObjectType,
 				$parentFieldName,
 				$schemaServiceOraculum->getFieldResolverType($parentObjectType, $parentFieldName),
+				[...$alreadyVisitedFields, $parentField],
 			);
 
 			foreach ($parentTypes as $parentType) {

tests-shared/Resolvers/QueryValidSelfReferenceFieldResolver.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace Vojtechdobes\TestsShared\Resolvers;
+
+use Vojtechdobes;
+
+
+/**
+ * @implements Vojtechdobes\GraphQL\FieldResolver<null, SelfReference>
+ */
+final class QueryValidSelfReferenceFieldResolver implements Vojtechdobes\GraphQL\FieldResolver
+{
+
+	public function resolveField(mixed $objectValue, Vojtechdobes\GraphQL\FieldSelection $field): mixed
+	{
+		return new SelfReference(internalSelfReference: null);
+	}
+
+}

tests-shared/Resolvers/SelfReference.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Vojtechdobes\TestsShared\Resolvers;
+
+
+final class SelfReference
+{
+
+	public function __construct(
+		public readonly ?SelfReference $internalSelfReference,
+	) {}
+
+}

tests-shared/schema.graphqls

@@ -20,6 +20,8 @@ type Query {
 	providerOfValidEntityParentTypeThing: EntityParentType!
 
 	rootFieldWithParentBasedResolver: String # should be eg. PropertyFieldResolver
+
+	validSelfReference: SelfReference
 }
 
 type ArrayType {
@@ -38,3 +40,7 @@ type PersonParentType {
 type EntityParentType {
 	name: String!
 }
+
+type SelfReference {
+	internalSelfReference: SelfReference
+}

tests/CustomAdapter.php

@@ -56,6 +56,9 @@ public function getFieldResolverProvider(string $schemaName): Vojtechdobes\Graph
 
 			'PersonParentType.name' => new Vojtechdobes\TestsShared\Resolvers\PersonParentTypeNameFieldResolver(),
 			'EntityParentType.name' => new Vojtechdobes\TestsShared\Resolvers\EntityParentTypeNameFieldResolver(),
+
+			'Query.validSelfReference' => new Vojtechdobes\TestsShared\Resolvers\QueryValidSelfReferenceFieldResolver(),
+			'SelfReference.internalSelfReference' => new Vojtechdobes\GraphQL\PropertyFieldResolver(),
 		]);
 	}