Mutations coupons #163

rogyar · 2018-08-30T12:10:05Z

Description

The PR introduces logic for working with shopping cart coupons. It adds two operations applyCouponToCart and removeCouponFromCart.
Also, within a scope of this PR an additional interface for checking cart operations permissions is added. By using this class we can restrict a customer cart from editing by a guest or another customer.

Please note, changes from #124 are present in this branch

Fixed Issues (if relevant)

[Cart Operations] Coupons #64: [Mutations] Cart Operations > Coupons

Manual testing scenarios

Create a coupon in the system that is applicable for all products.
Create a shopping cart (quote) with items
Use the cart masked id for performing the applyCouponToCart and removeCouponFromCart correspondingly

Apply coupon

mutation {
  applyCouponToCart(input: {cart_id: "6324c290f30fc195f812de670705efd1", coupon_code: "test"}) {
    cart {
      applied_coupon {
        code
      }
    }
  }
}

Remove coupon

mutation {
  removeCouponFromCart(input: {cart_id: "6324c290f30fc195f812de670705efd1"}) {
    cart {
      applied_coupon {
        code
      }
    }
  }
}

paliarush · 2018-08-31T23:41:15Z

app/code/Magento/QuoteGraphQl/Model/CartMutationsAllowed.php

+
+        $customerId = $quote->getCustomerId();
+
+        if (!$customerId) {


Please add comments to explain allowed use cases. It might be not obvious why we have these checks.

paliarush · 2018-08-31T23:48:11Z

app/code/Magento/QuoteGraphQl/Model/CartMutationsAllowedInterface.php

+ * Service for checking that the shopping cart operations
+ * are allowed for current user
+ */
+interface CartMutationsAllowedInterface


All classes/interfaces should be named using nouns. Please consider making changes across the review. In this specific case something like Authorization\CartMutation::isAllowed sounds better

paliarush · 2018-09-01T03:35:46Z

app/code/Magento/QuoteGraphQl/Model/Resolver/Coupon/ApplyCouponToCart.php

+        $couponCode = $args['input']['coupon_code'];
+
+        if (!$maskedQuoteId || !$couponCode) {
+            throw new GraphQlInputException(__('Required parameter is missing'));


It is better to specify which parameter is missing (have two separate exceptions)

paliarush · 2018-09-01T03:37:59Z

app/code/Magento/QuoteGraphQl/Model/Resolver/Coupon/ApplyCouponToCart.php

+
+        if (!$this->cartMutationsAllowed->execute($cartId)) {
+            throw new GraphQlAuthorizationException(
+                __('Operations with selected cart is not permitted for current user')


'cart is not permitted' => 'cart are not permitted'

If you can include the cart ID, change exception text to
'The current user cannot perform operations on cart <cart_id>'

Otherwise, change the text to
The current user cannot perform operations on the selected cart'

paliarush · 2018-09-01T03:50:38Z

app/code/Magento/QuoteGraphQl/Model/Resolver/Coupon/ApplyCouponToCart.php

+        try {
+            $this->couponManagement->set($cartId, $couponCode);
+        } catch (\Exception $exception) {
+            throw new GraphQlInputException(__($exception->getMessage()));


We must not display exception messages from \Exception to the clients, they may contain sensitive information. Please log the original exception message and display some generic one.

Please make sure to fix similar issues across the PR if any.

paliarush · 2018-09-01T04:07:18Z

app/code/Magento/QuoteGraphQl/Model/Resolver/Coupon/ApplyCouponToCart.php

+            'code' => $couponCode
+        ];
+
+        $result = function () use ($data) {


How is it possible to get the full cart object if needed?

app/code/Magento/QuoteGraphQl/README.md

paliarush · 2018-09-01T04:20:01Z

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

+}
+
+type AppliedCoupon {
+    # Wrapper allows for future extension of coupon info


We probably don't need to leave such comments in the schema.

keharper · 2018-09-01T03:59:54Z

app/code/Magento/QuoteGraphQl/Model/Resolver/Coupon/ApplyCouponToCart.php

+        try {
+            $cartId = $this->maskedQuoteIdToQuoteId->execute($maskedQuoteId);
+        } catch (NoSuchEntityException $exception) {
+            throw new GraphQlNoSuchEntityException(__('No cart with provided ID found'));


If you can include the ID, then change the exception text to

'Could not find a cart with ID <ID_number>'

Otherwise, change exception text to 'Could not find a cart with the provided ID'

keharper · 2018-09-01T04:09:59Z

app/code/Magento/QuoteGraphQl/Model/Resolver/Coupon/ApplyCouponToCart.php

+
+        if (!$this->cartMutationsAllowed->execute($cartId)) {
+            throw new GraphQlAuthorizationException(
+                __('Operations with selected cart is not permitted for current user')


If you can include the cart ID, change exception text to
'The current user cannot perform operations on cart <cart_id>'

Otherwise, change the text to
The current user cannot perform operations on the selected cart'

keharper · 2018-09-01T04:13:39Z

app/code/Magento/QuoteGraphQl/Model/Resolver/Coupon/RemoveCouponFromCart.php

+    {
+        $maskedCartId = $args['input']['cart_id'];
+
+        if (!$maskedCartId) {


Apply the same edits to the exception text as with ApplyCouponToCart.php

keharper · 2018-09-01T04:15:09Z

app/code/Magento/QuoteGraphQl/README.md

+# QuoteGraphQl
+
+**QuoteGraphQl** provides type and resolver information for the GraphQl module
+to generate quote (cart) information endpoints. Also provides endpoints for modifying a quote.


Change second sentence to

It also provides...

keharper · 2018-09-01T04:17:08Z

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

+# See COPYING.txt for license details.
+
+type Mutation {
+    createEmptyCart: String @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Cart\\CreateEmptyCart") @doc(description:"Creates empty shopping cart for guest or logged in user")


Change description to

Creates an empty shopping cart for a guest or a logged in user

paliarush · 2018-09-01T04:21:33Z

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

+use Magento\TestFramework\TestCase\GraphQlAbstract;
+
+/**
+ * Test for empty cart creation mutation


Please fix the comment

paliarush

Great contribution! Please address several minor comments and we should be good to merge.

…o mutations-coupons

-- fix static tests

rogyar added 5 commits August 23, 2018 09:48

Cart coupons prototype

ced2301

Merge branch 'mutations-empty-cart' into mutations-coupons

6abc7e5

Introduced service for checking cart mutations permissions

b6eaa1f

Use corresponding service for converting masked id to int id

1a077ac

Fixed typo for exception message

9cb459e

paliarush reviewed Aug 31, 2018

View reviewed changes

paliarush reviewed Sep 1, 2018

View reviewed changes

app/code/Magento/QuoteGraphQl/README.md Outdated Show resolved Hide resolved

paliarush reviewed Sep 1, 2018

View reviewed changes

keharper reviewed Sep 1, 2018

View reviewed changes

paliarush reviewed Sep 1, 2018

View reviewed changes

paliarush suggested changes Sep 1, 2018

View reviewed changes

Merge remote-tracking branch 'origin/2.3-develop' into mutations-coupons

ba6dd12

naydav added the in-progress label Sep 13, 2018

rogyar added 3 commits September 17, 2018 15:45

Merge branch '2.3-develop' into mutations-coupons

02c2bc0

Implementation improvements

7f1148f

Merge branch 'mutations-coupons' of github.com:magento/graphql-ce int…

b6365e1

…o mutations-coupons

naydav added broken-tests and removed broken-tests labels Sep 17, 2018

Valeriy Nayda added 2 commits September 18, 2018 15:53

GraphQL-64: [Mutations] Cart Operations > Coupons

3007b3a

Merge remote-tracking branch 'origin/2.3-develop' into mutations-coupons

2a0a450

magento-engcom-team assigned naydav Sep 18, 2018

magento-engcom-team added this to the Release: 2.3.1 milestone Sep 18, 2018

magento-engcom-team added Release Line: 2.3 Partner: Atwix partners-contribution labels Sep 18, 2018

GraphQL-64: [Mutations] Cart Operations > Coupons

462601c

-- fix static tests

paliarush approved these changes Sep 18, 2018

View reviewed changes

rogyar added 4 commits September 19, 2018 15:07

Fixed error messages assertions in api-functional tests

2f4767d

Fixed coupon fixture

343e463

Use another fixture for api-functional tests

46b40b4

Mark test as incomplete because of random Bamboo fails

fc12cb7

magento-engcom-team merged commit fc12cb7 into 2.3-develop Sep 20, 2018

magento-engcom-team pushed a commit that referenced this pull request Sep 20, 2018

ENGCOM-3007: Mutations coupons #163

dc5b402

magento-engcom-team added the Award: test coverage label Sep 20, 2018

naydav mentioned this pull request Sep 20, 2018

[Cart Operations] Coupons #64

Closed

keharper added the requires-documentation label Nov 21, 2018

keharper mentioned this pull request Nov 21, 2018

GraphQL: Add docs for quote endpoint in 2.3.1 magento/devdocs#3337

Closed

12 tasks

naydav removed this from the Release: 2.3.1 milestone Dec 7, 2018

keharper mentioned this pull request Apr 10, 2019

Docs: Add reference information for updates to QueryGraphQl module #588

Closed

naydav deleted the mutations-coupons branch April 12, 2019 19:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mutations coupons #163

Mutations coupons #163

rogyar commented Aug 30, 2018 •

edited

Loading

paliarush Aug 31, 2018 •

edited

Loading

paliarush Aug 31, 2018

paliarush Sep 1, 2018

paliarush Sep 1, 2018

keharper Sep 1, 2018

paliarush Sep 1, 2018

paliarush Sep 1, 2018

paliarush Sep 1, 2018

keharper Sep 1, 2018

keharper Sep 1, 2018

keharper Sep 1, 2018

keharper Sep 1, 2018

keharper Sep 1, 2018

paliarush Sep 1, 2018

paliarush left a comment

Mutations coupons #163

Mutations coupons #163

Conversation

rogyar commented Aug 30, 2018 • edited Loading

Description

Fixed Issues (if relevant)

Manual testing scenarios

paliarush Aug 31, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paliarush left a comment

Choose a reason for hiding this comment

rogyar commented Aug 30, 2018 •

edited

Loading

paliarush Aug 31, 2018 •

edited

Loading