Allow array as return type for prepareElementQuery

[engram-design]

There's an issue with GQL queries where many of the resolvers return an array.

Which shown as per the below

cms/src/gql/base/ElementResolver.php

Lines 87 to 93 in b87d49b

	/** @var ElementQuery $query */
	$query = static::prepareQuery($source, $arguments, $fieldName);
	// If that's already preloaded, then, uhh, skip the preloading?
	if (!$query instanceof ElementQuery) {
	return $query;
	}

If prepareQuery() doesn't return an ElementQuery then return it.

Otherwise, you'll get the following error: craft\\gql\\base\\ElementResolver::prepareElementQuery(): Return value must be of type craft\\elements\\db\\ElementQuery|Illuminate\\Support\\Collection, array returned

I suppose you could either enforce the resolvers to return a collection, or tighten up the prepareQuery() return types - take your pick!

[brandonkelly]

@brianjhanson Changing the return type would be a breaking change to any resolvers that override that method, so we need to tread carefully here.

My understanding is that the only time these would not be element queries is if they were eager-loaded, in which case they should be a collection, not an array. So we should look into why arrays are cropping up—maybe a bug further up the chain?

Even if there ends up being a very good reason for them being arrays, it might make more sense to wrap them in a collection rather than changing the return type.

[engram-design]

More than happy to go with what you recommend, but as it is, Craft itself will throw this error, due to your resolvers returning an array.

cms/src/gql/resolvers/elements/Address.php

Lines 47 to 49 in b87d49b

	if (!GqlHelper::canQueryUsers()) {
	return [];
	}

cms/src/gql/resolvers/elements/Asset.php

Lines 48 to 50 in b87d49b

	if (!GqlHelper::canQueryAssets()) {
	return [];
	}

cms/src/gql/resolvers/elements/Category.php

Lines 48 to 50 in b87d49b

	if (!GqlHelper::canQueryCategories()) {
	return [];
	}

Might I suggest changing these to return Collection's instead?

[brandonkelly]

Thanks for the pointer! Fixed via #12275.

[brandonkelly]

Craft 4.3.2 is out with that fix.