GraphQL mapping for custom collections

[Maxell92]

We have several Doctrine entities linked like this: Order contains N boxes, each box contains several tracking numbers. I want to add a getTrackingNumbers method to Order Entity:

/**
 * @ApiResource
 *
 * @ORM\Entity
 */
class Order {
...
	/**
	 * @return TrackingNumber[]
	 */
	public function getTrackingNumbers()
	{
		$numbers = [];
		// some logic here

		return $numbers;
	}

Generated schema contains trackingNumbers: Iterable! instead of specific type. How can I fix annotation? It is working fine if I query boxes collection and then trackingNumbers collection, but I do not want to expose my DB schema and force the client to loop through properties he do not need. I tried to use Subresource annotation, but it did not helped.

[alanpoulain]

I'm working on a way to solve this kind of issue by adding a custom type to your schema and use it whenever you have a specific property in a specific class.

[Maxell92]

Thanks for answer. Not sure we need a Custom type - I am referencing known ApiResource here.

[alanpoulain]

I see. Maybe it's a real bug then. If you want to look it yourself the code handling it is here:

core/src/GraphQl/Type/SchemaBuilder.php

Lines 369 to 386 in be932e9

	switch ($builtinType = $type->getBuiltinType()) {
	case Type::BUILTIN_TYPE_BOOL:
	$graphqlType = GraphQLType::boolean();
	break;
	case Type::BUILTIN_TYPE_INT:
	$graphqlType = GraphQLType::int();
	break;
	case Type::BUILTIN_TYPE_FLOAT:
	$graphqlType = GraphQLType::float();
	break;
	case Type::BUILTIN_TYPE_STRING:
	$graphqlType = GraphQLType::string();
	break;
	case Type::BUILTIN_TYPE_ARRAY:
	case Type::BUILTIN_TYPE_ITERABLE:
	$graphqlType = $this->graphqlTypes['Iterable'];
	break;
	case Type::BUILTIN_TYPE_OBJECT:

[Maxell92]

Hi Alan,

thank you for directions. I tried to debug and this is what I have found:

• Property Extractor does not see method if there is no property with same name:

  core/src/Metadata/Property/Factory/ExtractorPropertyMetadataFactory.php

  Line 52 in be932e9

  !property_exists($resourceClass, $property) ||

• So I added a property to my class:

	/**
	 * @var TrackingNumber[]|ArrayCollection
	 */
	private $trackingNumbers;

However Annotation is read by PhpDocExtractor and not by DoctrineExtractor in that case.

core/src/Bridge/Symfony/PropertyInfo/Metadata/Property/PropertyInfoPropertyMetadataFactory.php

Line 53 in be932e9

$types = $this->propertyInfo->getTypes($resourceClass, $name, $options);

does not count with this different result:

Doctrine extractor

PhpDocExtractor

I added code to merge information to $type[0] and that helped to generate correct schema. But once I want to query on this object, I hit a Doctrine error:
[Syntax Error] line 0, col 61: Error: Unexpected 'WHERE' in QueryException.php:54. I suppose that there is some code that tries to retrieve count and maybe performs JOIN?

Any hint how to solve this issue?

[Maxell92]

The code I used to test merging schema:

if (count($types) === 2 && (
	($types[0]->getBuiltinType() === Type::BUILTIN_TYPE_OBJECT && $types[1]->getBuiltinType() === Type::BUILTIN_TYPE_ARRAY) ||
	($types[1]->getBuiltinType() === Type::BUILTIN_TYPE_OBJECT && $types[0]->getBuiltinType() === Type::BUILTIN_TYPE_ARRAY)
	)
) {
	if ($types[0]->getBuiltinType() === Type::BUILTIN_TYPE_ARRAY) {
		$mainType = $types[0];
		$secondType = $types[1];
	}
	else {
		$mainType = $types[1];
		$secondType = $types[0];
	}

	$newType = new Type(
		Type::BUILTIN_TYPE_OBJECT,
		$mainType->isNullable(),
		$secondType->getClassName(),
		$mainType->isCollection(),
		$mainType->getCollectionKeyType(),
		$mainType->getCollectionValueType()
	);

	$types[0] = $newType;
}

[alanpoulain]

Hmm so it seems the behavior between the DoctrineExtractor and the PhpDocExtractor is really different for collections. Thanks for your investigation. It would help me if you could provide a failing Behat test in a PR 🙂

[alanpoulain]

Should be solved with #3327.

[nik-lampe]

@alanpoulain

I have mentioned it on the slack channel, but it might be easer to track this here.

While creating an example for another problem I have with this annotation extracting thing I stumbled across this Unexpected ‘WHERE error here.

Don’t know what I’m doing wrong here.

I’ve created an example:
https://github.com/nik-lampe/api-graphql-issue

I copypasted the book / review example from the docs. The only thing I have added is this:

https://github.com/nik-lampe/api-graphql-issue/blob/c305fa40cdd19c74c483b36f179213995e236736/src/Entity/Book.php#L80

    /**
     * @return Review[]
     */
    public function getBadReviews()
    {
        $badReviews = [];
        $reviews = $this->reviews;
        foreach ($reviews as $review) {
            if ($review->rating < 5) {
                $badReviews[] = $review;
            }
        }
        return $badReviews;
    }