Skip to content

[RFC] Pass $objectValue by reference when calling resolveType #1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[RFC] Pass $objectValue by reference when calling resolveType #1774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Type/Definition/AbstractType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ interface AbstractType
*
* @phpstan-return ResolveTypeReturn
*/
public function resolveType($objectValue, $context, ResolveInfo $info);
public function resolveType(&$objectValue, $context, ResolveInfo $info);
}
2 changes: 1 addition & 1 deletion src/Type/Definition/InterfaceType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public static function assertInterfaceType($type): self
return $type;
}

public function resolveType($objectValue, $context, ResolveInfo $info)
public function resolveType(&$objectValue, $context, ResolveInfo $info)
{
if (isset($this->config['resolveType'])) {
return ($this->config['resolveType'])($objectValue, $context, $info);
Expand Down
2 changes: 1 addition & 1 deletion src/Type/Definition/UnionType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ public function getTypes(): array
return $this->types;
}

public function resolveType($objectValue, $context, ResolveInfo $info)
public function resolveType(&$objectValue, $context, ResolveInfo $info)
{
if (isset($this->config['resolveType'])) {
return ($this->config['resolveType'])($objectValue, $context, $info);
Expand Down
94 changes: 94 additions & 0 deletions tests/Executor/AbstractTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use GraphQL\Tests\Executor\TestClasses\Cat;
use GraphQL\Tests\Executor\TestClasses\Dog;
use GraphQL\Tests\Executor\TestClasses\Human;
use GraphQL\Tests\Executor\TestClasses\PetEntity;
use GraphQL\Type\Definition\InterfaceType;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
Expand Down Expand Up @@ -773,4 +774,97 @@ public function testHintsOnConflictingTypeInstancesInResolveType(): void
$error->getMessage()
);
}

public function testResolveTypeAllowsModifyingObjectValue(): void
{
$PetType = new InterfaceType([
'name' => 'Pet',
'resolveType' => static function (PetEntity &$objectValue): string {
if ($objectValue->type === 'dog') {
$objectValue = new Dog($objectValue->name, $objectValue->woofs);

return 'Dog';
}

$objectValue = new Cat($objectValue->name, $objectValue->woofs);

return 'Cat';
},
'fields' => [
'name' => ['type' => Type::string()],
],
]);

$DogType = new ObjectType([
'name' => 'Dog',
'interfaces' => [$PetType],
'fields' => [
'name' => [
'type' => Type::string(),
'resolve' => fn (Dog $dog) => $dog->name,
],
'woofs' => [
'type' => Type::boolean(),
'resolve' => fn (Dog $dog) => $dog->woofs,
],
],
]);

$CatType = new ObjectType([
'name' => 'Cat',
'interfaces' => [$PetType],
'fields' => [
'name' => [
'type' => Type::string(),
'resolve' => fn (Cat $cat) => $cat->name,
],
'meows' => [
'type' => Type::boolean(),
'resolve' => fn (Cat $cat) => $cat->meows,
],
],
]);

$schema = new Schema([
'query' => new ObjectType([
'name' => 'Query',
'fields' => [
'pets' => [
'type' => Type::listOf($PetType),
'resolve' => static fn (): array => [
new PetEntity('dog', 'Odie', true),
new PetEntity('cat', 'Garfield', false),
],
],
],
]),
'types' => [$CatType, $DogType],
]);

$query = '{
pets {
name
... on Dog {
woofs
}
... on Cat {
meows
}
}
}';

$result = GraphQL::executeQuery($schema, $query)->toArray();

self::assertEquals(
[
'data' => [
'pets' => [
['name' => 'Odie', 'woofs' => true],
['name' => 'Garfield', 'meows' => false],
],
],
],
$result
);
}
}
21 changes: 21 additions & 0 deletions tests/Executor/TestClasses/PetEntity.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php declare(strict_types=1);

namespace GraphQL\Tests\Executor\TestClasses;

final class PetEntity
{
/** @var 'dog'|'cat' */
public string $type;

public string $name;

public bool $woofs;

/** @param 'dog'|'cat' $type */
public function __construct(string $type, string $name, bool $woofs)
{
$this->type = $type;
$this->name = $name;
$this->woofs = $woofs;
}
}
2 changes: 1 addition & 1 deletion tests/Utils/SchemaExtenderTest/SomeInterfaceClassType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ final class SomeInterfaceClassType extends InterfaceType
{
public ObjectType $concrete;

public function resolveType($objectValue, $context, ResolveInfo $info): ObjectType
public function resolveType(&$objectValue, $context, ResolveInfo $info): ObjectType
{
return $this->concrete;
}
Expand Down
2 changes: 1 addition & 1 deletion tests/Utils/SchemaExtenderTest/SomeUnionClassType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ final class SomeUnionClassType extends UnionType
{
public ObjectType $concrete;

public function resolveType($objectValue, $context, ResolveInfo $info): ObjectType
public function resolveType(&$objectValue, $context, ResolveInfo $info): ObjectType
{
return $this->concrete;
}
Expand Down
Loading