magento/graphql-ce#892: [Checkout] Improve strict typing in CartAddressInterface

Author: lenaorobei

app/code/Magento/QuoteGraphQl/Model/Cart/ValidateAddressFromSchema.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\QuoteGraphQl\Model\Cart;
+
+use Magento\Framework\GraphQl\Schema\Type\TypeRegistry;
+
+/**
+ * Validates address against required fields from schema
+ */
+class ValidateAddressFromSchema
+{
+    /**
+     * @var TypeRegistry
+     */
+    private $typeRegistry;
+
+    /**
+     * @param TypeRegistry $typeRegistry
+     */
+    public function __construct(
+        TypeRegistry $typeRegistry
+    ) {
+        $this->typeRegistry = $typeRegistry;
+    }
+
+
+    /**
+     * Validate data from address against mandatory fields from graphql schema for address
+     *
+     * @param array $address
+     * @return bool
+     */
+    public function execute(array $address = []) : bool
+    {
+        /** @var \Magento\Framework\GraphQL\Schema\Type\Input\InputObjectType $cartAddressInput */
+        $cartAddressInput = $this->typeRegistry->get('CartAddressInput');
+        $fields = $cartAddressInput->getFields();
+
+        foreach ($fields as $field) {
+            if ($field->getType() instanceof \Magento\Framework\GraphQL\Schema\Type\NonNull) {
+                // an array key has to exist but it's value should not be null
+                if (array_key_exists($field->name, $address)
+                    && !is_array($address[$field->name])
+                    && !isset($address[$field->name])) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+}

app/code/Magento/QuoteGraphQl/Model/Resolver/BillingAddress.php

@@ -13,6 +13,7 @@
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\Quote\Api\Data\CartInterface;
 use Magento\QuoteGraphQl\Model\Cart\ExtractQuoteAddressData;
+use Magento\QuoteGraphQl\Model\Cart\ValidateAddressFromSchema;
 
 /**
  * @inheritdoc
@@ -24,12 +25,22 @@ class BillingAddress implements ResolverInterface
      */
     private $extractQuoteAddressData;
 
+    /**
+     * @var ValidateAddressFromSchema
+     */
+    private $validateAddressFromSchema;
+
     /**
      * @param ExtractQuoteAddressData $extractQuoteAddressData
+     * @param ValidateAddressFromSchema $validateAddressFromSchema
      */
-    public function __construct(ExtractQuoteAddressData $extractQuoteAddressData)
+    public function __construct(
+        ExtractQuoteAddressData $extractQuoteAddressData,
+        ValidateAddressFromSchema $validateAddressFromSchema
+)
     {
         $this->extractQuoteAddressData = $extractQuoteAddressData;
+        $this->validateAddressFromSchema = $validateAddressFromSchema;
     }
 
     /**
@@ -44,17 +55,10 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
         $cart = $value['model'];
 
         $billingAddress = $cart->getBillingAddress();
-        if (null === $billingAddress ||
-            null === $billingAddress->getFirstname() ||
-            null === $billingAddress->getLastname() ||
-            null === $billingAddress->getCity() ||
-            null === $billingAddress->getCountry() ||
-            null === $billingAddress->getTelephone() ||
-            null === $billingAddress->getStreet()) {
+        $addressData = $this->extractQuoteAddressData->execute($billingAddress);
+        if (!$this->validateAddressFromSchema->execute($addressData)) {
             return null;
         }
-
-        $addressData = $this->extractQuoteAddressData->execute($billingAddress);
         return $addressData;
     }
 }

app/code/Magento/QuoteGraphQl/Model/Resolver/ShippingAddresses.php

@@ -13,8 +13,7 @@
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\Quote\Model\Quote;
 use Magento\QuoteGraphQl\Model\Cart\ExtractQuoteAddressData;
-use Magento\Framework\GraphQl\Schema\Type\TypeRegistry;
-use Magento\Framework\App\ObjectManager;
+use Magento\QuoteGraphQl\Model\Cart\ValidateAddressFromSchema;
 
 /**
  * @inheritdoc
@@ -27,20 +26,21 @@ class ShippingAddresses implements ResolverInterface
     private $extractQuoteAddressData;
 
     /**
-     * @var TypeRegistry
+     * @var ValidateAddressFromSchema
      */
-    private $typeRegistry;
+    private $validateAddressFromSchema;
 
     /**
      * @param ExtractQuoteAddressData $extractQuoteAddressData
-     * @param TypeRegistry|null $typeRegistry
+     * @param ValidateAddressFromSchema
      */
     public function __construct(
         ExtractQuoteAddressData $extractQuoteAddressData,
-        TypeRegistry $typeRegistry = null
-    ) {
+        ValidateAddressFromSchema $validateAddressFromSchema
+    )
+    {
         $this->extractQuoteAddressData = $extractQuoteAddressData;
-        $this->typeRegistry = $typeRegistry ?: ObjectManager::getInstance()->get(TypeRegistry::class);
+        $this->validateAddressFromSchema = $validateAddressFromSchema;
     }
 
     /**
@@ -61,36 +61,11 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
             foreach ($shippingAddresses as $shippingAddress) {
                 $address = $this->extractQuoteAddressData->execute($shippingAddress);
 
-                if ($this->validateAddressFromSchema($address)) {
+                if ($this->validateAddressFromSchema->execute($address)) {
                     $addressesData[] = $address;
                 }
             }
         }
         return $addressesData;
     }
-
-    /**
-     * Validate data from address against mandatory fields from graphql schema for address
-     *
-     * @param array $address
-     * @return bool
-     */
-    private function validateAddressFromSchema(array $address) : bool
-    {
-        /** @var \Magento\Framework\GraphQL\Schema\Type\Input\InputObjectType $cartAddressInput */
-        $cartAddressInput = $this->typeRegistry->get('CartAddressInput');
-        $fields = $cartAddressInput->getFields();
-
-        foreach ($fields as $field) {
-            if ($field->getType() instanceof \Magento\Framework\GraphQL\Schema\Type\NonNull) {
-                // an array key has to exist but it's value should not be null
-                if (array_key_exists($field->name, $address)
-                    && !is_array($address[$field->name])
-                    && !isset($address[$field->name])) {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
 }