feat(graphql)!: add extra args for custom queries or mutations (#5359)

This commit also removes the generation of the required ID field in case of a custom query or mutation. It is a slight BC break if the user relies on this required ID field. It should be added back with the extra args.

Author: alanpoulain

src/GraphQl/Type/FieldsBuilder.php

@@ -82,7 +82,8 @@ public function getItemQueryFields(string $resourceClass, Operation $operation,
 
  if ($fieldConfiguration = $this->getResourceFieldConfiguration(null, $operation->getDescription(), $operation->getDeprecationReason(), new Type(Type::BUILTIN_TYPE_OBJECT, true, $resourceClass), $resourceClass, false, $operation)) {
  $args = $this->resolveResourceArgs($configuration['args'] ?? [], $operation);
- $configuration['args'] = $args ?: $configuration['args'] ?? ['id' => ['type' => GraphQLType::nonNull(GraphQLType::id())]];
+ $extraArgs = $this->resolveResourceArgs($operation->getExtraArgs() ?? [], $operation);
+ $configuration['args'] = $args ?: $configuration['args'] ?? ['id' => ['type' => GraphQLType::nonNull(GraphQLType::id())]] + $extraArgs;
 
  return [$fieldName => array_merge($fieldConfiguration, $configuration)];
  }
@@ -103,7 +104,8 @@ public function getCollectionQueryFields(string $resourceClass, Operation $opera
 
  if ($fieldConfiguration = $this->getResourceFieldConfiguration(null, $operation->getDescription(), $operation->getDeprecationReason(), new Type(Type::BUILTIN_TYPE_OBJECT, false, null, true, null, new Type(Type::BUILTIN_TYPE_OBJECT, false, $resourceClass)), $resourceClass, false, $operation)) {
  $args = $this->resolveResourceArgs($configuration['args'] ?? [], $operation);
- $configuration['args'] = $args ?: $configuration['args'] ?? $fieldConfiguration['args'];
+ $extraArgs = $this->resolveResourceArgs($operation->getExtraArgs() ?? [], $operation);
+ $configuration['args'] = $args ?: $configuration['args'] ?? $fieldConfiguration['args'] + $extraArgs;
 
  return [Inflector::pluralize($fieldName) => array_merge($fieldConfiguration, $configuration)];
  }
@@ -195,7 +197,7 @@ public function getResourceObjectTypeFields(?string $resourceClass, Operation $o
  return $fields;
  }
 
- if (!$input || ('create' !== $operation->getName() && !$operation->getInput())) {
+ if (!$input || (!$operation->getResolver() && 'create' !== $operation->getName())) {
  $fields['id'] = $idField;
  }
  if ($input && $depth >= 1) {

src/GraphQl/Type/TypeBuilder.php

@@ -147,6 +147,9 @@ public function getResourceObjectType(?string $resourceClass, ResourceMetadataCo
  if ($input && $operation instanceof Mutation && null !== $mutationArgs = $operation->getArgs()) {
  return $fieldsBuilder->resolveResourceArgs($mutationArgs, $operation) + ['clientMutationId' => $fields['clientMutationId']];
  }
+ if ($input && $operation instanceof Mutation && null !== $extraMutationArgs = $operation->getExtraArgs()) {
+ return $fields + $fieldsBuilder->resolveResourceArgs($extraMutationArgs, $operation);
+ }
 
  return $fields;
  },

src/Metadata/Extractor/ResourceExtractorTrait.php

@@ -85,6 +85,20 @@ private function buildArgs(\SimpleXMLElement $resource): ?array
  return $data;
  }
 
+ private function buildExtraArgs(\SimpleXMLElement $resource): ?array
+ {
+ if (!isset($resource->extraArgs->arg)) {
+ return null;
+ }
+
+ $data = [];
+ foreach ($resource->extraArgs->arg as $arg) {
+ $data[(string) $arg['id']] = $this->buildValues($arg->values);
+ }
+
+ return $data;
+ }
+
  private function buildValues(\SimpleXMLElement $resource): array
  {
  $data = [];

src/Metadata/Extractor/XmlResourceExtractor.php

@@ -423,6 +423,7 @@ private function buildGraphQlOperations(\SimpleXMLElement $resource, array $root
  $data[] = array_merge($datum, [
  'resolver' => $this->phpize($operation, 'resolver', 'string'),
  'args' => $this->buildArgs($operation),
+ 'extraArgs' => $this->buildExtraArgs($operation),
  'class' => (string) $operation['class'],
  'read' => $this->phpize($operation, 'read', 'bool'),
  'deserialize' => $this->phpize($operation, 'deserialize', 'bool'),

src/Metadata/Extractor/YamlResourceExtractor.php

@@ -353,6 +353,7 @@ private function buildGraphQlOperations(array $resource, array $root): ?array
  $data[] = array_merge($datum, [
  'resolver' => $this->phpize($operation, 'resolver', 'string'),
  'args' => $operation['args'] ?? null,
+ 'extraArgs' => $operation['extraArgs'] ?? null,
  'class' => (string) $class,
  'read' => $this->phpize($operation, 'read', 'bool'),
  'deserialize' => $this->phpize($operation, 'deserialize', 'bool'),

src/Metadata/Extractor/schema/resources.xsd

@@ -59,6 +59,7 @@
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
  <xsd:group ref="base"/>
  <xsd:element name="args" minOccurs="0" type="args"/>
+ <xsd:element name="extraArgs" minOccurs="0" type="args"/>
  </xsd:sequence>
  <xsd:attributeGroup ref="base"/>
  <xsd:attribute type="xsd:string" name="resolver"/>

src/Metadata/GraphQl/Operation.php

@@ -37,6 +37,7 @@ class Operation extends AbstractOperation
  public function __construct(
  protected ?string $resolver = null,
  protected ?array $args = null,
+ protected ?array $extraArgs = null,
  protected ?array $links = null,
 
  ?string $shortName = null,
@@ -160,6 +161,19 @@ public function withArgs(?array $args = null): self
  return $self;
  }
 
+ public function getExtraArgs(): ?array
+ {
+ return $this->extraArgs;
+ }
+
+ public function withExtraArgs(?array $extraArgs = null): self
+ {
+ $self = clone $this;
+ $self->extraArgs = $extraArgs;
+
+ return $self;
+ }
+
  /**
  * @return Link[]|null
  */

src/Metadata/GraphQl/Query.php

@@ -21,6 +21,7 @@ class Query extends Operation
  public function __construct(
  ?string $resolver = null,
  ?array $args = null,
+ ?array $extraArgs = null,
  ?array $links = null,
 
  ?string $shortName = null,
@@ -74,6 +75,7 @@ public function __construct(
  parent::__construct(
  resolver: $resolver,
  args: $args,
+ extraArgs: $extraArgs,
  links: $links,
  shortName: $shortName,
  class: $class,

src/Metadata/GraphQl/QueryCollection.php

@@ -22,6 +22,7 @@ final class QueryCollection extends Query implements CollectionOperationInterfac
  public function __construct(
  ?string $resolver = null,
  ?array $args = null,
+ ?array $extraArgs = null,
  ?array $links = null,
 
  ?string $shortName = null,
@@ -75,6 +76,7 @@ public function __construct(
  parent::__construct(
  resolver: $resolver,
  args: $args,
+ extraArgs: $extraArgs,
  links: $links,
  shortName: $shortName,
  class: $class,

src/Metadata/GraphQl/Subscription.php

@@ -21,6 +21,7 @@ final class Subscription extends Operation
  public function __construct(
  ?string $resolver = null,
  ?array $args = null,
+ ?array $extraArgs = null,
  ?array $links = null,
 
  ?string $shortName = null,
@@ -72,6 +73,7 @@ public function __construct(
  parent::__construct(
  resolver: $resolver,
  args: $args,
+ extraArgs: $extraArgs,
  links: $links,
  shortName: $shortName,
  class: $class,