Skip to content

fix GraphQL list types not nullable #40464

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

Open
bramstroker wants to merge 1 commit into
base: 2.4-develop
Choose a base branch
from
+28 −9
Open

fix GraphQL list types not nullable #40464

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
12 changes: 4 additions & 8 deletions lib/internal/Magento/Framework/GraphQl/Config/Data/WrappedTypeProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,8 @@ private function processIsNullable(FieldInterface $field, ?TypeInterface $object
private function processIsList(FieldInterface $field, ?TypeInterface $object = null) : TypeInterface
{
if ($field->isList()) {
if ($field instanceof \Magento\Framework\GraphQl\Config\Element\Argument) {
if ($field->areItemsRequired()) {
$object = $this->typeFactory->createNonNull($object);
}
if ($field->areItemsRequired()) {
$object = $this->typeFactory->createNonNull($object);
}
return $this->typeFactory->createList($object);
}
Expand Down Expand Up @@ -136,10 +134,8 @@ private function processScalarIsList(
) : \GraphQL\Type\Definition\Type {
$object = $object ?: $this->scalarTypes->getScalarTypeInstance($field->getTypeName());
if ($field->isList()) {
if ($field instanceof \Magento\Framework\GraphQl\Config\Element\Argument) {
if ($field->areItemsRequired()) {
$object = $this->scalarTypes->createNonNull($object);
}
if ($field->areItemsRequired()) {
$object = $this->scalarTypes->createNonNull($object);
}
return $this->scalarTypes->createList($object);
}
Expand Down
19 changes: 18 additions & 1 deletion lib/internal/Magento/Framework/GraphQl/Config/Element/Field.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ class Field implements OutputFieldInterface
*/
private $deprecated;

/**
* @var bool
*/
private bool $itemsRequired;

/**
* @param string $name
* @param string $type
Expand All @@ -83,7 +88,8 @@ public function __construct(
string $description = '',
array $arguments = [],
array $cache = [],
array $deprecated = []
array $deprecated = [],
bool $itemsRequired = false
) {
$this->name = $name;
$this->type = $isList ? $itemType : $type;
Expand All @@ -94,6 +100,7 @@ public function __construct(
$this->arguments = $arguments;
$this->cache = $cache;
$this->deprecated = $deprecated;
$this->itemsRequired = $itemsRequired;
}

/**
Expand Down Expand Up @@ -185,4 +192,14 @@ public function getDeprecated() : array
{
return $this->deprecated;
}

/**
* Return true if item is a list, and if that list must be populated by at least one item. False otherwise.
*
* @return bool
*/
public function areItemsRequired() : bool
{
return $this->itemsRequired;
}
}
1 change: 1 addition & 0 deletions lib/internal/Magento/Framework/GraphQl/Config/Element/FieldFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ public function createFromConfigData(
'arguments' => $arguments,
'cache' => isset($fieldData['cache']) ? $fieldData['cache'] : [],
'deprecated' => isset($fieldData['deprecated']) ? $fieldData['deprecated'] : [],
'itemsRequired' => isset($fieldData['itemsRequired']) ? $fieldData['itemsRequired'] : false,
]
);
}
Expand Down
5 changes: 5 additions & 0 deletions lib/internal/Magento/Framework/GraphQl/Config/Element/FieldInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ public function getTypeName(): string;
*/
public function isList(): bool;

/**
* @return bool
*/
public function areItemsRequired() : bool;

/**
* Return true if argument is required when invoking the query where the argument is specified. False otherwise.
*
Expand Down