Skip to content

Commit f5e3b44

Browse files
oprypkhantcoprypkhantc
authored
Allow constructor fields to use middleware (#636)
* Allow constructor fields to use middleware * Fix failing tests * Fix failing PHPStan * Add actual tests * Fix missing typehint * Revert source change
1 parent a685145 commit f5e3b44

31 files changed

Lines changed: 416 additions & 571 deletions

‎phpstan.neon‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,7 @@ parameters:
1717
- "#Parameter .* of class ReflectionMethod constructor expects string(\\|null)?, object\\|string given.#"
1818
- "#PHPDoc tag @throws with type Psr\\\\SimpleCache\\\\InvalidArgumentException is not subtype of Throwable#"
1919
- '#Variable \$context might not be defined.#'
20-
# TODO: fix these in the resolver refactor PR that follows; it'll be initialized in the constructor
21-
- '#Class TheCodingMachine\\GraphQLite\\(QueryFieldDescriptor|InputFieldDescriptor) has an uninitialized readonly property \$(originalResolver|resolver)\. Assign it in the constructor.#'
22-
- '#Readonly property TheCodingMachine\\GraphQLite\\(QueryFieldDescriptor|InputFieldDescriptor)::\$(originalResolver|resolver) is assigned outside of the constructor\.#'
23-
- '#Property TheCodingMachine\\GraphQLite\\(QueryFieldDescriptor|InputFieldDescriptor)::\$resolver \(callable\) in isset\(\) is not nullable\.#'
20+
- '#Parameter \#1 \$callable of class TheCodingMachine\\GraphQLite\\Middlewares\\ServiceResolver constructor expects array{object, string}&callable\(\): mixed, array{object, non-empty-string} given.#'
2421
-
2522
message: '#Parameter .* of class GraphQL\\Error\\Error constructor expects#'
2623
path: src/Exceptions/WebonyxErrorHandler.php

‎src/FailedResolvingInputType.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010

1111
class FailedResolvingInputType extends RuntimeException
1212
{
13-
public static function createForMissingConstructorParameter(string $class, string $parameter): self
13+
public static function createForMissingConstructorParameter(\ArgumentCountError $original): self
1414
{
15-
return new self(sprintf("Parameter '%s' is missing for class '%s' constructor. It should be mapped as required field.", $parameter, $class));
15+
return new self(sprintf("%s. It should be mapped as required field.", $original->getMessage()), previous: $original);
1616
}
1717

1818
public static function createForDecorator(string $class): self

‎src/FieldsBuilder.php‎

Lines changed: 75 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,13 @@
3838
use TheCodingMachine\GraphQLite\Middlewares\FieldMiddlewareInterface;
3939
use TheCodingMachine\GraphQLite\Middlewares\InputFieldHandlerInterface;
4040
use TheCodingMachine\GraphQLite\Middlewares\InputFieldMiddlewareInterface;
41+
use TheCodingMachine\GraphQLite\Middlewares\MagicPropertyResolver;
4142
use TheCodingMachine\GraphQLite\Middlewares\MissingMagicGetException;
43+
use TheCodingMachine\GraphQLite\Middlewares\ServiceResolver;
44+
use TheCodingMachine\GraphQLite\Middlewares\SourceConstructorParameterResolver;
45+
use TheCodingMachine\GraphQLite\Middlewares\SourceInputPropertyResolver;
46+
use TheCodingMachine\GraphQLite\Middlewares\SourceMethodResolver;
47+
use TheCodingMachine\GraphQLite\Middlewares\SourcePropertyResolver;
4248
use TheCodingMachine\GraphQLite\Parameters\InputTypeParameterInterface;
4349
use TheCodingMachine\GraphQLite\Parameters\ParameterInterface;
4450
use TheCodingMachine\GraphQLite\Parameters\PrefetchDataParameter;
@@ -370,14 +376,6 @@ private function getFieldsByMethodAnnotations(string|object $controller, Reflect
370376
$type = $this->typeMapper->mapReturnType($refMethod, $docBlockObj);
371377
}
372378

373-
$fieldDescriptor = new QueryFieldDescriptor(
374-
name: $name,
375-
type: $type,
376-
comment: trim($description),
377-
deprecationReason: $this->getDeprecationReason($docBlockObj),
378-
refMethod: $refMethod,
379-
);
380-
381379
$parameters = $refMethod->getParameters();
382380
if ($injectSource === true) {
383381
$firstParameter = array_shift($parameters);
@@ -398,19 +396,21 @@ private function getFieldsByMethodAnnotations(string|object $controller, Reflect
398396
$args = ['__graphqlite_prefectData' => $prefetchDataParameter, ...$args];
399397
}
400398

401-
$fieldDescriptor = $fieldDescriptor->withParameters($args);
399+
$resolver = is_string($controller) ?
400+
new SourceMethodResolver($refMethod) :
401+
new ServiceResolver([$controller, $methodName]);
402402

403-
if (is_string($controller)) {
404-
$fieldDescriptor = $fieldDescriptor->withTargetMethodOnSource($refMethod->getDeclaringClass()->getName(), $methodName);
405-
} else {
406-
$callable = [$controller, $methodName];
407-
assert(is_callable($callable));
408-
$fieldDescriptor = $fieldDescriptor->withCallable($callable);
409-
}
410-
411-
$fieldDescriptor = $fieldDescriptor
412-
->withInjectSource($injectSource)
413-
->withMiddlewareAnnotations($this->annotationReader->getMiddlewareAnnotations($refMethod));
403+
$fieldDescriptor = new QueryFieldDescriptor(
404+
name: $name,
405+
type: $type,
406+
resolver: $resolver,
407+
originalResolver: $resolver,
408+
parameters: $args,
409+
injectSource: $injectSource,
410+
comment: trim($description),
411+
deprecationReason: $this->getDeprecationReason($docBlockObj),
412+
middlewareAnnotations: $this->annotationReader->getMiddlewareAnnotations($refMethod),
413+
);
414414

415415
$field = $this->fieldMiddleware->process($fieldDescriptor, new class implements FieldHandlerInterface {
416416
public function handle(QueryFieldDescriptor $fieldDescriptor): FieldDefinition|null
@@ -480,26 +480,22 @@ private function getFieldsByPropertyAnnotations(string|object $controller, Refle
480480
assert($type instanceof OutputType);
481481
}
482482

483+
$originalResolver = new SourcePropertyResolver($refProperty);
484+
$resolver = is_string($controller) ?
485+
$originalResolver :
486+
fn () => PropertyAccessor::getValue($controller, $refProperty->getName());
487+
483488
$fieldDescriptor = new QueryFieldDescriptor(
484489
name: $name,
485490
type: $type,
491+
resolver: $resolver,
492+
originalResolver: $originalResolver,
493+
injectSource: false,
486494
comment: trim($description),
487495
deprecationReason: $this->getDeprecationReason($docBlock),
488-
refProperty: $refProperty,
496+
middlewareAnnotations: $this->annotationReader->getMiddlewareAnnotations($refProperty),
489497
);
490498

491-
if (is_string($controller)) {
492-
$fieldDescriptor = $fieldDescriptor->withTargetPropertyOnSource($refProperty->getDeclaringClass()->getName(), $refProperty->getName());
493-
} else {
494-
$fieldDescriptor = $fieldDescriptor->withCallable(static function () use ($controller, $refProperty) {
495-
return PropertyAccessor::getValue($controller, $refProperty->getName());
496-
});
497-
}
498-
499-
$fieldDescriptor = $fieldDescriptor
500-
->withInjectSource(false)
501-
->withMiddlewareAnnotations($this->annotationReader->getMiddlewareAnnotations($refProperty));
502-
503499
$field = $this->fieldMiddleware->process($fieldDescriptor, new class implements FieldHandlerInterface {
504500
public function handle(QueryFieldDescriptor $fieldDescriptor): FieldDefinition|null
505501
{
@@ -597,15 +593,16 @@ private function getQueryFieldsFromSourceFields(array $sourceFields, ReflectionC
597593
$type = $this->typeMapper->mapReturnType($refMethod, $docBlockObj);
598594
}
599595

596+
$resolver = new SourceMethodResolver($refMethod);
597+
600598
$fieldDescriptor = new QueryFieldDescriptor(
601599
name: $sourceField->getName(),
602600
type: $type,
601+
resolver: $resolver,
602+
originalResolver: $resolver,
603603
parameters: $args,
604-
targetClass: $refMethod->getDeclaringClass()->getName(),
605-
targetMethodOnSource: $methodName,
606604
comment: $description,
607605
deprecationReason: $deprecationReason ?? null,
608-
refMethod: $refMethod,
609606
);
610607
} else {
611608
$outputType = $sourceField->getOutputType();
@@ -619,11 +616,13 @@ private function getQueryFieldsFromSourceFields(array $sourceFields, ReflectionC
619616
$type = $this->resolvePhpType($phpTypeStr, $refClass, $magicGefRefMethod);
620617
}
621618

619+
$resolver = new MagicPropertyResolver($refClass->getName(), $sourceField->getSourceName() ?? $sourceField->getName());
620+
622621
$fieldDescriptor = new QueryFieldDescriptor(
623622
name: $sourceField->getName(),
624623
type: $type,
625-
targetClass: $refClass->getName(),
626-
magicProperty: $sourceField->getSourceName() ?? $sourceField->getName(),
624+
resolver: $resolver,
625+
originalResolver: $resolver,
627626
comment: $sourceField->getDescription(),
628627
);
629628
}
@@ -889,27 +888,22 @@ private function getInputFieldsByMethodAnnotations(string|object $controller, Re
889888

890889
assert($type instanceof InputType);
891890

891+
$resolver = new SourceMethodResolver($refMethod);
892+
892893
$inputFieldDescriptor = new InputFieldDescriptor(
893894
name: $name,
894895
type: $type,
896+
resolver: $resolver,
897+
originalResolver: $resolver,
895898
parameters: $args,
899+
injectSource: $injectSource,
896900
comment: trim($description),
897-
refMethod: $refMethod,
901+
middlewareAnnotations: $this->annotationReader->getMiddlewareAnnotations($refMethod),
898902
isUpdate: $isUpdate,
903+
hasDefaultValue: $isUpdate,
904+
defaultValue: $args[$name]->getDefaultValue()
899905
);
900906

901-
$inputFieldDescriptor = $inputFieldDescriptor
902-
->withHasDefaultValue($isUpdate)
903-
->withDefaultValue($args[$name]->getDefaultValue());
904-
$constructerParameters = $this->getClassConstructParameterNames($refClass);
905-
if (!in_array($name, $constructerParameters)) {
906-
$inputFieldDescriptor = $inputFieldDescriptor->withTargetMethodOnSource($refMethod->getDeclaringClass()->getName(), $methodName);
907-
}
908-
909-
$inputFieldDescriptor = $inputFieldDescriptor
910-
->withInjectSource($injectSource)
911-
->withMiddlewareAnnotations($this->annotationReader->getMiddlewareAnnotations($refMethod));
912-
913907
$field = $this->inputFieldMiddleware->process($inputFieldDescriptor, new class implements InputFieldHandlerInterface {
914908
public function handle(InputFieldDescriptor $inputFieldDescriptor): InputField|null
915909
{
@@ -965,53 +959,38 @@ private function getInputFieldsByPropertyAnnotations(string|object $controller,
965959
$description = $inputProperty->getDescription();
966960
}
967961

968-
if (in_array($name, $constructerParameters)) {
969-
$middlewareAnnotations = $this->annotationReader->getPropertyAnnotations($refProperty, MiddlewareAnnotationInterface::class);
970-
if ($middlewareAnnotations !== []) {
971-
throw IncompatibleAnnotationsException::middlewareAnnotationsUnsupported();
972-
}
973-
// constructor hydrated
974-
$field = new InputField(
975-
$name,
976-
$inputProperty->getType(),
977-
[$inputProperty->getName() => $inputProperty],
978-
null,
979-
null,
980-
trim($description),
981-
$isUpdate,
982-
$inputProperty->hasDefaultValue(),
983-
$inputProperty->getDefaultValue(),
984-
);
985-
} else {
986-
$type = $inputProperty->getType();
987-
if (!$inputType && $isUpdate && $type instanceof NonNull) {
988-
$type = $type->getWrappedType();
989-
}
990-
assert($type instanceof InputType);
962+
$type = $inputProperty->getType();
963+
if (!$inputType && $isUpdate && $type instanceof NonNull) {
964+
$type = $type->getWrappedType();
965+
}
966+
assert($type instanceof InputType);
967+
$forConstructorHydration = in_array($name, $constructerParameters);
968+
$resolver = $forConstructorHydration ?
969+
new SourceConstructorParameterResolver($refProperty->getDeclaringClass()->getName(), $refProperty->getName()) :
970+
new SourceInputPropertyResolver($refProperty);
991971

992-
// setters and properties
993-
$inputFieldDescriptor = new InputFieldDescriptor(
994-
name: $inputProperty->getName(),
995-
type: $type,
996-
parameters: [$inputProperty->getName() => $inputProperty],
997-
targetClass: $refProperty->getDeclaringClass()->getName(),
998-
targetPropertyOnSource: $refProperty->getName(),
999-
injectSource: false,
1000-
comment: trim($description),
1001-
middlewareAnnotations: $this->annotationReader->getMiddlewareAnnotations($refProperty),
1002-
refProperty: $refProperty,
1003-
isUpdate: $isUpdate,
1004-
hasDefaultValue: $inputProperty->hasDefaultValue(),
1005-
defaultValue: $inputProperty->getDefaultValue(),
1006-
);
972+
// setters and properties
973+
$inputFieldDescriptor = new InputFieldDescriptor(
974+
name: $inputProperty->getName(),
975+
type: $type,
976+
resolver: $resolver,
977+
originalResolver: $resolver,
978+
parameters: [$inputProperty->getName() => $inputProperty],
979+
injectSource: false,
980+
forConstructorHydration: $forConstructorHydration,
981+
comment: trim($description),
982+
middlewareAnnotations: $this->annotationReader->getMiddlewareAnnotations($refProperty),
983+
isUpdate: $isUpdate,
984+
hasDefaultValue: $inputProperty->hasDefaultValue(),
985+
defaultValue: $inputProperty->getDefaultValue(),
986+
);
1007987

1008-
$field = $this->inputFieldMiddleware->process($inputFieldDescriptor, new class implements InputFieldHandlerInterface {
1009-
public function handle(InputFieldDescriptor $inputFieldDescriptor): InputField|null
1010-
{
1011-
return InputField::fromFieldDescriptor($inputFieldDescriptor);
1012-
}
1013-
});
1014-
}
988+
$field = $this->inputFieldMiddleware->process($inputFieldDescriptor, new class implements InputFieldHandlerInterface {
989+
public function handle(InputFieldDescriptor $inputFieldDescriptor): InputField|null
990+
{
991+
return InputField::fromFieldDescriptor($inputFieldDescriptor);
992+
}
993+
});
1015994

1016995
if ($field === null) {
1017996
continue;

‎src/InputField.php‎

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,25 @@ final class InputField extends InputObjectField
3232
/** @var callable */
3333
private $resolve;
3434

35-
private bool $forConstructorHydration = false;
36-
3735
/**
3836
* @param (Type&InputType) $type
3937
* @param array<string, ParameterInterface> $arguments Indexed by argument name.
4038
* @param mixed|null $defaultValue the default value set for this field
4139
* @param array{defaultValue?: mixed,description?: string|null,astNode?: InputValueDefinitionNode|null}|null $additionalConfig
4240
*/
43-
public function __construct(string $name, InputType $type, array $arguments, ResolverInterface|null $originalResolver, callable|null $resolver, string|null $comment, bool $isUpdate, bool $hasDefaultValue, mixed $defaultValue, array|null $additionalConfig = null)
44-
{
41+
public function __construct(
42+
string $name,
43+
InputType $type,
44+
array $arguments,
45+
ResolverInterface $originalResolver,
46+
callable $resolver,
47+
private bool $forConstructorHydration,
48+
string|null $comment,
49+
bool $isUpdate,
50+
bool $hasDefaultValue,
51+
mixed $defaultValue,
52+
array|null $additionalConfig = null
53+
) {
4554
$config = [
4655
'name' => $name,
4756
'type' => $type,
@@ -52,28 +61,27 @@ public function __construct(string $name, InputType $type, array $arguments, Res
5261
$config['defaultValue'] = $defaultValue;
5362
}
5463

55-
if ($originalResolver !== null && $resolver !== null) {
56-
$this->resolve = function (object $source, array $args, $context, ResolveInfo $info) use ($arguments, $originalResolver, $resolver) {
64+
$this->resolve = function (object|null $source, array $args, $context, ResolveInfo $info) use ($arguments, $originalResolver, $resolver) {
65+
if ($this->forConstructorHydration) {
66+
$toPassArgs = [
67+
$arguments[$this->name]->resolve($source, $args, $context, $info)
68+
];
69+
} else {
5770
$toPassArgs = $this->paramsToArguments($arguments, $source, $args, $context, $info, $resolver);
58-
$result = $resolver($source, ...$toPassArgs);
59-
60-
try {
61-
$this->assertInputType($result);
62-
} catch (TypeMismatchRuntimeException $e) {
63-
$e->addInfo($this->name, $originalResolver->toString());
64-
throw $e;
65-
}
66-
67-
return $result;
68-
};
69-
} else {
70-
$this->forConstructorHydration = true;
71-
$this->resolve = function (object|null $source, array $args, $context, ResolveInfo $info) use ($arguments) {
72-
$result = $arguments[$this->name]->resolve($source, $args, $context, $info);
71+
}
72+
73+
$result = $resolver($source, ...$toPassArgs);
74+
75+
try {
7376
$this->assertInputType($result);
74-
return $result;
75-
};
76-
}
77+
} catch (TypeMismatchRuntimeException $e) {
78+
$e->addInfo($this->name, $originalResolver->toString());
79+
throw $e;
80+
}
81+
82+
return $result;
83+
};
84+
7785
if ($additionalConfig !== null) {
7886
if (isset($additionalConfig['astNode'])) {
7987
$config['astNode'] = $additionalConfig['astNode'];
@@ -126,6 +134,7 @@ private static function fromDescriptor(InputFieldDescriptor $fieldDescriptor): s
126134
$fieldDescriptor->getParameters(),
127135
$fieldDescriptor->getOriginalResolver(),
128136
$fieldDescriptor->getResolver(),
137+
$fieldDescriptor->isForConstructorHydration(),
129138
$fieldDescriptor->getComment(),
130139
$fieldDescriptor->isUpdate(),
131140
$fieldDescriptor->hasDefaultValue(),

0 commit comments

Comments
 (0)