graphQl-903: deprecated use_for_shipping in billing address schema

Vitaliy Boyko · Vitaliy Boyko · commit 095d7075a9f2 · 2019-09-18T16:17:45.000+03:00
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/AssignBillingAddressToCart.php b/app/code/Magento/QuoteGraphQl/Model/Cart/AssignBillingAddressToCart.php
@@ -39,17 +39,17 @@ public function __construct(
      *
      * @param CartInterface $cart
      * @param AddressInterface $billingAddress
-     * @param bool $useForShipping
+     * @param bool $sameAsShipping
      * @throws GraphQlInputException
      * @throws GraphQlNoSuchEntityException
      */
     public function execute(
         CartInterface $cart,
         AddressInterface $billingAddress,
-        bool $useForShipping
+        bool $sameAsShipping
     ): void {
         try {
-            $this->billingAddressManagement->assign($cart->getId(), $billingAddress, $useForShipping);
+            $this->billingAddressManagement->assign($cart->getId(), $billingAddress, $sameAsShipping);
         } catch (NoSuchEntityException $e) {
             throw new GraphQlNoSuchEntityException(__($e->getMessage()), $e);
         } catch (LocalizedException $e) {
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/SetBillingAddressOnCart.php b/app/code/Magento/QuoteGraphQl/Model/Cart/SetBillingAddressOnCart.php
@@ -56,8 +56,8 @@ public function execute(ContextInterface $context, CartInterface $cart, array $b
     {
         $customerAddressId = $billingAddressInput['customer_address_id'] ?? null;
         $addressInput = $billingAddressInput['address'] ?? null;
-        $useForShipping = isset($billingAddressInput['use_for_shipping'])
-            ? (bool)$billingAddressInput['use_for_shipping'] : false;
+        $sameAsshipping = isset($billingAddressInput['same_as_shipping'])
+            ? (bool)$billingAddressInput['same_as_shipping'] : false;
 
         if (null === $customerAddressId && null === $addressInput) {
             throw new GraphQlInputException(
@@ -72,15 +72,15 @@ public function execute(ContextInterface $context, CartInterface $cart, array $b
         }
 
         $addresses = $cart->getAllShippingAddresses();
-        if ($useForShipping && count($addresses) > 1) {
+        if ($sameAsshipping && count($addresses) > 1) {
             throw new GraphQlInputException(
-                __('Using the "use_for_shipping" option with multishipping is not possible.')
+                __('Using the "same_as_shipping" option with multishipping is not possible.')
             );
         }
 
         $billingAddress = $this->createBillingAddress($context, $customerAddressId, $addressInput);
 
-        $this->assignBillingAddressToCart->execute($cart, $billingAddress, $useForShipping);
+        $this->assignBillingAddressToCart->execute($cart, $billingAddress, $sameAsshipping);
     }
 
     /**
diff --git a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls
@@ -96,7 +96,8 @@ input SetBillingAddressOnCartInput {
 input BillingAddressInput {
     customer_address_id: Int
     address: CartAddressInput
-    use_for_shipping: Boolean
+    use_for_shipping: Boolean @doc(description: "Deprecated. Use same_as_shipping")
+    same_as_shipping: Boolean
 }
 
 input CartAddressInput {
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/Customer/SetBillingAddressOnCartTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/Customer/SetBillingAddressOnCartTest.php
@@ -120,7 +120,7 @@ public function testSetNewBillingAddress()
      * @magentoApiDataFixture Magento/GraphQl/Quote/_files/customer/create_empty_cart.php
      * @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php
      */
-    public function testSetNewBillingAddressWithUseForShippingParameter()
+    public function testSetNewBillingAddressWithSameAsShippingParameter()
     {
         $maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');
 
@@ -142,7 +142,7 @@ public function testSetNewBillingAddressWithUseForShippingParameter()
           telephone: "88776655"
           save_in_address_book: false
          }
-         use_for_shipping: true
+         same_as_shipping: true
       }
     }
   ) {
@@ -337,7 +337,7 @@ public function testSetNewBillingAddressWithoutCustomerAddressIdAndAddress()
     input: {
       cart_id: "$maskedQuoteId"
       billing_address: {
-        use_for_shipping: true
+        same_as_shipping: true
       }
     }
   ) {
@@ -363,7 +363,7 @@ public function testSetNewBillingAddressWithoutCustomerAddressIdAndAddress()
      * @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php
      * @magentoApiDataFixture Magento/GraphQl/Quote/_files/set_multishipping_with_two_shipping_addresses.php
      */
-    public function testSetNewBillingAddressWithUseForShippingAndMultishipping()
+    public function testSetNewBillingAddressWithSameAsShippingAndMultishipping()
     {
         $maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');
 
@@ -385,7 +385,7 @@ public function testSetNewBillingAddressWithUseForShippingAndMultishipping()
           telephone: "88776655"
           save_in_address_book: false
         }
-        use_for_shipping: true
+        same_as_shipping: true
       }
     }
   ) {
@@ -399,7 +399,7 @@ public function testSetNewBillingAddressWithUseForShippingAndMultishipping()
 QUERY;
 
         self::expectExceptionMessage(
-            'Using the "use_for_shipping" option with multishipping is not possible.'
+            'Using the "same_as_shipping" option with multishipping is not possible.'
         );
         $this->graphQlMutation($query, [], '', $this->getHeaderMap());
     }
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/Guest/SetBillingAddressOnCartTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/Guest/SetBillingAddressOnCartTest.php
@@ -90,7 +90,7 @@ public function testSetNewBillingAddress()
      * @magentoApiDataFixture Magento/GraphQl/Quote/_files/guest/create_empty_cart.php
      * @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php
      */
-    public function testSetNewBillingAddressWithUseForShippingParameter()
+    public function testSetNewBillingAddressWithSameAsShippingParameter()
     {
         $maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');
 
@@ -112,7 +112,7 @@ public function testSetNewBillingAddressWithUseForShippingParameter()
           telephone: "88776655"
           save_in_address_book: false
          }
-         use_for_shipping: true
+         same_as_shipping: true
       }
     }
   ) {
@@ -346,7 +346,7 @@ public function testSetNewBillingAddressWithoutCustomerAddressIdAndAddress()
     input: {
       cart_id: "$maskedQuoteId"
       billing_address: {
-        use_for_shipping: true
+        same_as_shipping: true
       }
     }
   ) {
@@ -371,7 +371,7 @@ public function testSetNewBillingAddressWithoutCustomerAddressIdAndAddress()
      * @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php
      * @magentoApiDataFixture Magento/GraphQl/Quote/_files/set_multishipping_with_two_shipping_addresses.php
      */
-    public function testSetNewBillingAddressWithUseForShippingAndMultishipping()
+    public function testSetNewBillingAddressWithSameAsShippingAndMultishipping()
     {
         $maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');
 
@@ -393,7 +393,7 @@ public function testSetNewBillingAddressWithUseForShippingAndMultishipping()
           telephone: "88776655"
           save_in_address_book: false
         }
-        use_for_shipping: true
+        same_as_shipping: true
       }
     }
   ) {
@@ -407,7 +407,7 @@ public function testSetNewBillingAddressWithUseForShippingAndMultishipping()
 QUERY;
 
         self::expectExceptionMessage(
-            'Using the "use_for_shipping" option with multishipping is not possible.'
+            'Using the "same_as_shipping" option with multishipping is not possible.'
         );
         $this->graphQlMutation($query);
     }

Original file line number	Diff line number	Diff line change
`@@ -56,8 +56,8 @@ public function execute(ContextInterface $context, CartInterface $cart, array $b`
`56`	`56`	`{`
`57`	`57`	`$customerAddressId = $billingAddressInput['customer_address_id'] ?? null;`
`58`	`58`	`$addressInput = $billingAddressInput['address'] ?? null;`
`59`		`- $useForShipping = isset($billingAddressInput['use_for_shipping'])`
`60`		`- ? (bool)$billingAddressInput['use_for_shipping'] : false;`
	`59`	`+ $sameAsshipping = isset($billingAddressInput['same_as_shipping'])`
	`60`	`+ ? (bool)$billingAddressInput['same_as_shipping'] : false;`
`61`	`61`
`62`	`62`	`if (null === $customerAddressId && null === $addressInput) {`
`63`	`63`	`throw new GraphQlInputException(`
`@@ -72,15 +72,15 @@ public function execute(ContextInterface $context, CartInterface $cart, array $b`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`$addresses = $cart->getAllShippingAddresses();`
`75`		`- if ($useForShipping && count($addresses) > 1) {`
	`75`	`+ if ($sameAsshipping && count($addresses) > 1) {`
`76`	`76`	`throw new GraphQlInputException(`
`77`		`- __('Using the "use_for_shipping" option with multishipping is not possible.')`
	`77`	`+ __('Using the "same_as_shipping" option with multishipping is not possible.')`
`78`	`78`	`);`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`$billingAddress = $this->createBillingAddress($context, $customerAddressId, $addressInput);`
`82`	`82`
`83`		`- $this->assignBillingAddressToCart->execute($cart, $billingAddress, $useForShipping);`
	`83`	`+ $this->assignBillingAddressToCart->execute($cart, $billingAddress, $sameAsshipping);`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,8 @@ input SetBillingAddressOnCartInput {`
`96`	`96`	`input BillingAddressInput {`
`97`	`97`	`customer_address_id: Int`
`98`	`98`	`address: CartAddressInput`
`99`		`- use_for_shipping: Boolean`
	`99`	`+ use_for_shipping: Boolean @doc(description: "Deprecated. Use same_as_shipping")`
	`100`	`+ same_as_shipping: Boolean`
`100`	`101`	`}`
`101`	`102`
`102`	`103`	`input CartAddressInput {`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ public function testSetNewBillingAddress()`
`120`	`120`	`* @magentoApiDataFixture Magento/GraphQl/Quote/_files/customer/create_empty_cart.php`
`121`	`121`	`* @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php`
`122`	`122`	`*/`
`123`		`- public function testSetNewBillingAddressWithUseForShippingParameter()`
	`123`	`+ public function testSetNewBillingAddressWithSameAsShippingParameter()`
`124`	`124`	`{`
`125`	`125`	`$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');`
`126`	`126`
`@@ -142,7 +142,7 @@ public function testSetNewBillingAddressWithUseForShippingParameter()`
`142`	`142`	`telephone: "88776655"`
`143`	`143`	`save_in_address_book: false`
`144`	`144`	`}`
`145`		`- use_for_shipping: true`
	`145`	`+ same_as_shipping: true`
`146`	`146`	`}`
`147`	`147`	`}`
`148`	`148`	`) {`
`@@ -337,7 +337,7 @@ public function testSetNewBillingAddressWithoutCustomerAddressIdAndAddress()`
`337`	`337`	`input: {`
`338`	`338`	`cart_id: "$maskedQuoteId"`
`339`	`339`	`billing_address: {`
`340`		`- use_for_shipping: true`
	`340`	`+ same_as_shipping: true`
`341`	`341`	`}`
`342`	`342`	`}`
`343`	`343`	`) {`
`@@ -363,7 +363,7 @@ public function testSetNewBillingAddressWithoutCustomerAddressIdAndAddress()`
`363`	`363`	`* @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php`
`364`	`364`	`* @magentoApiDataFixture Magento/GraphQl/Quote/_files/set_multishipping_with_two_shipping_addresses.php`
`365`	`365`	`*/`
`366`		`- public function testSetNewBillingAddressWithUseForShippingAndMultishipping()`
	`366`	`+ public function testSetNewBillingAddressWithSameAsShippingAndMultishipping()`
`367`	`367`	`{`
`368`	`368`	`$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');`
`369`	`369`
`@@ -385,7 +385,7 @@ public function testSetNewBillingAddressWithUseForShippingAndMultishipping()`
`385`	`385`	`telephone: "88776655"`
`386`	`386`	`save_in_address_book: false`
`387`	`387`	`}`
`388`		`- use_for_shipping: true`
	`388`	`+ same_as_shipping: true`
`389`	`389`	`}`
`390`	`390`	`}`
`391`	`391`	`) {`
`@@ -399,7 +399,7 @@ public function testSetNewBillingAddressWithUseForShippingAndMultishipping()`
`399`	`399`	`QUERY;`
`400`	`400`
`401`	`401`	`self::expectExceptionMessage(`
`402`		`- 'Using the "use_for_shipping" option with multishipping is not possible.'`
	`402`	`+ 'Using the "same_as_shipping" option with multishipping is not possible.'`
`403`	`403`	`);`
`404`	`404`	`$this->graphQlMutation($query, [], '', $this->getHeaderMap());`
`405`	`405`	`}`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ public function testSetNewBillingAddress()`
`90`	`90`	`* @magentoApiDataFixture Magento/GraphQl/Quote/_files/guest/create_empty_cart.php`
`91`	`91`	`* @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php`
`92`	`92`	`*/`
`93`		`- public function testSetNewBillingAddressWithUseForShippingParameter()`
	`93`	`+ public function testSetNewBillingAddressWithSameAsShippingParameter()`
`94`	`94`	`{`
`95`	`95`	`$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');`
`96`	`96`
`@@ -112,7 +112,7 @@ public function testSetNewBillingAddressWithUseForShippingParameter()`
`112`	`112`	`telephone: "88776655"`
`113`	`113`	`save_in_address_book: false`
`114`	`114`	`}`
`115`		`- use_for_shipping: true`
	`115`	`+ same_as_shipping: true`
`116`	`116`	`}`
`117`	`117`	`}`
`118`	`118`	`) {`
`@@ -346,7 +346,7 @@ public function testSetNewBillingAddressWithoutCustomerAddressIdAndAddress()`
`346`	`346`	`input: {`
`347`	`347`	`cart_id: "$maskedQuoteId"`
`348`	`348`	`billing_address: {`
`349`		`- use_for_shipping: true`
	`349`	`+ same_as_shipping: true`
`350`	`350`	`}`
`351`	`351`	`}`
`352`	`352`	`) {`
`@@ -371,7 +371,7 @@ public function testSetNewBillingAddressWithoutCustomerAddressIdAndAddress()`
`371`	`371`	`* @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php`
`372`	`372`	`* @magentoApiDataFixture Magento/GraphQl/Quote/_files/set_multishipping_with_two_shipping_addresses.php`
`373`	`373`	`*/`
`374`		`- public function testSetNewBillingAddressWithUseForShippingAndMultishipping()`
	`374`	`+ public function testSetNewBillingAddressWithSameAsShippingAndMultishipping()`
`375`	`375`	`{`
`376`	`376`	`$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');`
`377`	`377`
`@@ -393,7 +393,7 @@ public function testSetNewBillingAddressWithUseForShippingAndMultishipping()`
`393`	`393`	`telephone: "88776655"`
`394`	`394`	`save_in_address_book: false`
`395`	`395`	`}`
`396`		`- use_for_shipping: true`
	`396`	`+ same_as_shipping: true`
`397`	`397`	`}`
`398`	`398`	`}`
`399`	`399`	`) {`
`@@ -407,7 +407,7 @@ public function testSetNewBillingAddressWithUseForShippingAndMultishipping()`
`407`	`407`	`QUERY;`
`408`	`408`
`409`	`409`	`self::expectExceptionMessage(`
`410`		`- 'Using the "use_for_shipping" option with multishipping is not possible.'`
	`410`	`+ 'Using the "same_as_shipping" option with multishipping is not possible.'`
`411`	`411`	`);`
`412`	`412`	`$this->graphQlMutation($query);`
`413`	`413`	`}`