Skip to content

Commit 035f602

Browse files
naydavnaydav
committed
GraphQL-631: Schema inconsistency of "Quantity / Qty" declaration
1 parent e8f1369 commit 035f602

16 files changed

+105
-105
lines changed

‎app/code/Magento/ConfigurableProductGraphQl/etc/schema.graphqls

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ type AddConfigurableProductsToCartOutput {
4949
}
5050

5151
input ConfigurableProductCartItemInput {
52-
data: CartItemQuantityInput!
52+
data: CartItemInput!
5353
variant_sku: String!
5454
customizable_options:[CustomizableOptionInput!]
5555
}

‎app/code/Magento/QuoteGraphQl/Model/Cart/AddSimpleProductToCart.php

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ public function __construct(
6666
public function execute(Quote $cart, array $cartItemData): void
6767
{
6868
$sku = $this->extractSku($cartItemData);
69-
$qty = $this->extractQty($cartItemData);
70-
if ($qty <= 0) {
69+
$quantity = $this->extractQuantity($cartItemData);
70+
if ($quantity <= 0) {
7171
throw new GraphQlInputException(
7272
__('Please enter a number greater than 0 in this field.')
7373
);
@@ -81,7 +81,7 @@ public function execute(Quote $cart, array $cartItemData): void
8181
}
8282

8383
try {
84-
$result = $cart->addProduct($product, $this->createBuyRequest($qty, $customizableOptions));
84+
$result = $cart->addProduct($product, $this->createBuyRequest($quantity, $customizableOptions));
8585
} catch (\Exception $e) {
8686
throw new GraphQlInputException(
8787
__(
@@ -113,19 +113,19 @@ private function extractSku(array $cartItemData): string
113113
}
114114

115115
/**
116-
* Extract Qty from cart item data
116+
* Extract quantity from cart item data
117117
*
118118
* @param array $cartItemData
119119
* @return float
120120
* @throws GraphQlInputException
121121
*/
122-
private function extractQty(array $cartItemData): float
122+
private function extractQuantity(array $cartItemData): float
123123
{
124-
$qty = $this->arrayManager->get('data/quantity', $cartItemData);
125-
if (!isset($qty)) {
124+
$quantity = $this->arrayManager->get('data/quantity', $cartItemData);
125+
if (!isset($quantity)) {
126126
throw new GraphQlInputException(__('Missing key "quantity" in cart item data'));
127127
}
128-
return (float)$qty;
128+
return (float)$quantity;
129129
}
130130

131131
/**
@@ -148,15 +148,15 @@ private function extractCustomizableOptions(array $cartItemData): array
148148
/**
149149
* Format GraphQl input data to a shape that buy request has
150150
*
151-
* @param float $qty
151+
* @param float $quantity
152152
* @param array $customOptions
153153
* @return DataObject
154154
*/
155-
private function createBuyRequest(float $qty, array $customOptions): DataObject
155+
private function createBuyRequest(float $quantity, array $customOptions): DataObject
156156
{
157157
return $this->dataObjectFactory->create([
158158
'data' => [
159-
'qty' => $qty,
159+
'qty' => $quantity,
160160
'options' => $customOptions,
161161
],
162162
]);

‎app/code/Magento/QuoteGraphQl/Model/Resolver/UpdateCartItems.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ private function processCartItems(Quote $cart, array $items): void
9898
if (!isset($item['quantity'])) {
9999
throw new GraphQlInputException(__('Required parameter "quantity" for "cart_items" is missing.'));
100100
}
101-
$qty = (float)$item['quantity'];
101+
$quantity = (float)$item['quantity'];
102102

103103
$cartItem = $cart->getItemById($itemId);
104104
if ($cartItem === false) {
@@ -107,10 +107,10 @@ private function processCartItems(Quote $cart, array $items): void
107107
);
108108
}
109109

110-
if ($qty <= 0.0) {
110+
if ($quantity <= 0.0) {
111111
$this->cartItemRepository->deleteById((int)$cart->getId(), $itemId);
112112
} else {
113-
$cartItem->setQty($qty);
113+
$cartItem->setQty($quantity);
114114
$this->cartItemRepository->save($cartItem);
115115
}
116116
}

‎app/code/Magento/QuoteGraphQl/etc/schema.graphqls

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ input AddSimpleProductsToCartInput {
3131
}
3232

3333
input SimpleProductCartItemInput {
34-
data: CartItemQuantityInput!
34+
data: CartItemInput!
3535
customizable_options:[CustomizableOptionInput!]
3636
}
3737

@@ -41,11 +41,11 @@ input AddVirtualProductsToCartInput {
4141
}
4242

4343
input VirtualProductCartItemInput {
44-
data: CartItemQuantityInput!
44+
data: CartItemInput!
4545
customizable_options:[CustomizableOptionInput!]
4646
}
4747

48-
input CartItemQuantityInput {
48+
input CartItemInput {
4949
sku: String!
5050
quantity: Float!
5151
}
@@ -62,10 +62,10 @@ input ApplyCouponToCartInput {
6262

6363
input UpdateCartItemsInput {
6464
cart_id: String!
65-
cart_items: [CartItemUpdateQuantityInput!]!
65+
cart_items: [CartItemUpdateInput!]!
6666
}
6767

68-
input CartItemUpdateQuantityInput {
68+
input CartItemUpdateInput {
6969
cart_item_id: Int!
7070
quantity: Float!
7171
}

‎dev/tests/api-functional/testsuite/Magento/GraphQl/CatalogInventory/AddProductToCartTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ protected function setUp()
3939
public function testAddProductIfQuantityIsNotAvailable()
4040
{
4141
$sku = 'simple';
42-
$qty = 200;
42+
$quantity = 200;
4343
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
4444

45-
$query = $this->getQuery($maskedQuoteId, $sku, $qty);
45+
$query = $this->getQuery($maskedQuoteId, $sku, $quantity);
4646
$this->graphQlMutation($query);
4747
}
4848

@@ -58,10 +58,10 @@ public function testAddMoreProductsThatAllowed()
5858
$this->markTestIncomplete('https://github.com/magento/graphql-ce/issues/167');
5959

6060
$sku = 'custom-design-simple-product';
61-
$qty = 7;
61+
$quantity = 7;
6262
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
6363

64-
$query = $this->getQuery($maskedQuoteId, $sku, $qty);
64+
$query = $this->getQuery($maskedQuoteId, $sku, $quantity);
6565
$this->graphQlMutation($query);
6666
}
6767

‎dev/tests/api-functional/testsuite/Magento/GraphQl/ConfigurableProduct/AddConfigurableProductToCartTest.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ protected function setUp()
3737
public function testAddConfigurableProductToCart()
3838
{
3939
$variantSku = 'simple_41';
40-
$qty = 2;
40+
$quantity = 2;
4141
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
4242

43-
$query = $this->getQuery($maskedQuoteId, $variantSku, $qty);
43+
$query = $this->getQuery($maskedQuoteId, $variantSku, $quantity);
4444
$response = $this->graphQlMutation($query);
4545

4646
$cartItems = $response['addConfigurableProductsToCart']['cart']['items'];
47-
self::assertEquals($qty, $cartItems[0]['quantity']);
47+
self::assertEquals($quantity, $cartItems[0]['quantity']);
4848
self::assertEquals($variantSku, $cartItems[0]['product']['sku']);
4949
}
5050

@@ -57,10 +57,10 @@ public function testAddConfigurableProductToCart()
5757
public function testAddProductIfQuantityIsNotAvailable()
5858
{
5959
$variantSku = 'simple_41';
60-
$qty = 200;
60+
$quantity = 200;
6161
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
6262

63-
$query = $this->getQuery($maskedQuoteId, $variantSku, $qty);
63+
$query = $this->getQuery($maskedQuoteId, $variantSku, $quantity);
6464
$this->graphQlMutation($query);
6565
}
6666

@@ -73,20 +73,20 @@ public function testAddProductIfQuantityIsNotAvailable()
7373
public function testAddOutOfStockProduct()
7474
{
7575
$variantSku = 'simple_1010';
76-
$qty = 1;
76+
$quantity = 1;
7777
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
7878

79-
$query = $this->getQuery($maskedQuoteId, $variantSku, $qty);
79+
$query = $this->getQuery($maskedQuoteId, $variantSku, $quantity);
8080
$this->graphQlMutation($query);
8181
}
8282

8383
/**
8484
* @param string $maskedQuoteId
8585
* @param string $variantSku
86-
* @param int $qty
86+
* @param int $quantity
8787
* @return string
8888
*/
89-
private function getQuery(string $maskedQuoteId, string $variantSku, int $qty): string
89+
private function getQuery(string $maskedQuoteId, string $variantSku, int $quantity): string
9090
{
9191
return <<<QUERY
9292
mutation {
@@ -97,7 +97,7 @@ private function getQuery(string $maskedQuoteId, string $variantSku, int $qty):
9797
{
9898
variant_sku: "{$variantSku}"
9999
data: {
100-
quantity: {$qty}
100+
quantity: {$quantity}
101101
sku: "{$variantSku}"
102102
}
103103
}

‎dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/AddSimpleProductWithCustomOptionsToCartTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ protected function setUp()
4646
public function testAddSimpleProductWithOptions()
4747
{
4848
$sku = 'simple';
49-
$qty = 1;
49+
$quantity = 1;
5050
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
5151

5252
$customOptionsValues = $this->getCustomOptionsValuesForQuery($sku);
@@ -62,7 +62,7 @@ public function testAddSimpleProductWithOptions()
6262
cartItems: [
6363
{
6464
data: {
65-
quantity: $qty
65+
quantity: $quantity
6666
sku: "$sku"
6767
},
6868
customizable_options: $queryCustomizableOptions
@@ -110,7 +110,7 @@ public function testAddSimpleProductWithOptions()
110110
public function testAddSimpleProductWithNoRequiredOptionsSet()
111111
{
112112
$sku = 'simple';
113-
$qty = 1;
113+
$quantity = 1;
114114
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
115115

116116
$query = <<<QUERY
@@ -121,7 +121,7 @@ public function testAddSimpleProductWithNoRequiredOptionsSet()
121121
cartItems: [
122122
{
123123
data: {
124-
quantity: $qty
124+
quantity: $quantity
125125
sku: "$sku"
126126
}
127127
}

‎dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/AddVirtualProductWithCustomOptionsToCartTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ protected function setUp()
4646
public function testAddVirtualProductWithOptions()
4747
{
4848
$sku = 'virtual';
49-
$qty = 1;
49+
$quantity = 1;
5050
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
5151

5252
$customOptionsValues = $this->getCustomOptionsValuesForQuery($sku);
@@ -62,7 +62,7 @@ public function testAddVirtualProductWithOptions()
6262
cartItems: [
6363
{
6464
data: {
65-
quantity: $qty
65+
quantity: $quantity
6666
sku: "$sku"
6767
},
6868
customizable_options: $queryCustomizableOptions
@@ -110,7 +110,7 @@ public function testAddVirtualProductWithOptions()
110110
public function testAddVirtualProductWithNoRequiredOptionsSet()
111111
{
112112
$sku = 'virtual';
113-
$qty = 1;
113+
$quantity = 1;
114114
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_order_1');
115115

116116
$query = <<<QUERY
@@ -121,7 +121,7 @@ public function testAddVirtualProductWithNoRequiredOptionsSet()
121121
cartItems: [
122122
{
123123
data: {
124-
quantity: $qty
124+
quantity: $quantity
125125
sku: "$sku"
126126
}
127127
}

‎dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/Customer/AddSimpleProductToCartTest.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ protected function setUp()
4343
public function testAddSimpleProductToCart()
4444
{
4545
$sku = 'simple_product';
46-
$qty = 2;
46+
$quantity = 2;
4747
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');
48-
$query = $this->getQuery($maskedQuoteId, $sku, $qty);
48+
$query = $this->getQuery($maskedQuoteId, $sku, $quantity);
4949
$response = $this->graphQlMutation($query, [], '', $this->getHeaderMap());
5050

5151
self::assertArrayHasKey('cart', $response['addSimpleProductsToCart']);
52-
self::assertEquals($qty, $response['addSimpleProductsToCart']['cart']['items'][0]['quantity']);
52+
self::assertEquals($quantity, $response['addSimpleProductsToCart']['cart']['items'][0]['quantity']);
5353
self::assertEquals($sku, $response['addSimpleProductsToCart']['cart']['items'][0]['product']['sku']);
5454
}
5555

@@ -63,10 +63,10 @@ public function testAddSimpleProductToCart()
6363
public function testAddProductToNonExistentCart()
6464
{
6565
$sku = 'simple_product';
66-
$qty = 2;
66+
$quantity = 2;
6767
$maskedQuoteId = 'non_existent_masked_id';
6868

69-
$query = $this->getQuery($maskedQuoteId, $sku, $qty);
69+
$query = $this->getQuery($maskedQuoteId, $sku, $quantity);
7070
$this->graphQlMutation($query, [], '', $this->getHeaderMap());
7171
}
7272

@@ -130,10 +130,10 @@ public function testAddSimpleProductToAnotherCustomerCart()
130130
/**
131131
* @param string $maskedQuoteId
132132
* @param string $sku
133-
* @param int $qty
133+
* @param float $quantity
134134
* @return string
135135
*/
136-
private function getQuery(string $maskedQuoteId, string $sku, int $qty): string
136+
private function getQuery(string $maskedQuoteId, string $sku, float $quantity): string
137137
{
138138
return <<<QUERY
139139
mutation {
@@ -142,7 +142,7 @@ private function getQuery(string $maskedQuoteId, string $sku, int $qty): string
142142
cartItems: [
143143
{
144144
data: {
145-
quantity: {$qty}
145+
quantity: {$quantity}
146146
sku: "{$sku}"
147147
}
148148
}

‎dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/Customer/AddVirtualProductToCartTest.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ protected function setUp()
4343
public function testAddVirtualProductToCart()
4444
{
4545
$sku = 'virtual_product';
46-
$qty = 2;
46+
$quantity = 2;
4747
$maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute('test_quote');
48-
$query = $this->getQuery($maskedQuoteId, $sku, $qty);
48+
$query = $this->getQuery($maskedQuoteId, $sku, $quantity);
4949
$response = $this->graphQlMutation($query, [], '', $this->getHeaderMap());
5050

5151
self::assertArrayHasKey('cart', $response['addVirtualProductsToCart']);
52-
self::assertEquals($qty, $response['addVirtualProductsToCart']['cart']['items'][0]['quantity']);
52+
self::assertEquals($quantity, $response['addVirtualProductsToCart']['cart']['items'][0]['quantity']);
5353
self::assertEquals($sku, $response['addVirtualProductsToCart']['cart']['items'][0]['product']['sku']);
5454
}
5555

@@ -130,10 +130,10 @@ public function testAddVirtualProductToAnotherCustomerCart()
130130
/**
131131
* @param string $maskedQuoteId
132132
* @param string $sku
133-
* @param int $qty
133+
* @param float $quantity
134134
* @return string
135135
*/
136-
private function getQuery(string $maskedQuoteId, string $sku, int $qty): string
136+
private function getQuery(string $maskedQuoteId, string $sku, float $quantity): string
137137
{
138138
return <<<QUERY
139139
mutation {
@@ -142,7 +142,7 @@ private function getQuery(string $maskedQuoteId, string $sku, int $qty): string
142142
cartItems: [
143143
{
144144
data: {
145-
quantity: {$qty}
145+
quantity: {$quantity}
146146
sku: "{$sku}"
147147
}
148148
}

0 commit comments

Comments
 (0)