[GraphQl] Single mutation for adding different types of products to the shopping cart

[rogyar]

Description (*)

This PR introduces a new approach that allows adding different types of products using the same mutation.

More details will be provided soon ...

Solution Architecture

Related Pull Requests

https://github.com/magento/partners-magento2ee/pull/260
https://github.com/magento/partners-magento2-infrastructure/pull/17

Fixed Issues (if relevant)

1. Single mutation for Add to Cart that supports all product types

Manual testing scenarios (*)

TBP

Questions or comments

The data providers for different product types were decoupled as separate modules according to the suggestion from @mslabko.

• This PR does not include resolvers for ID_V2 of different options. This functionality will be provided in a separate PR
• This PR does not include a possibility to use Parent SKU + SKU pair for adding items to cart (only via Parent SKU + product options in the same manner as the standard storefront works). The possibility to use Parent SKU + SKU may be provided in a separate PR (still in discussion)

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @rogyar. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

[paliarush]

GraphQL schema looks good and corresponds to the design https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/add-items-to-cart-single-mutation.md

[lenaorobei]

@paliarush please confirm interfaces comply with requirements and standards.

[lenaorobei]

For complex errors we should be able utilize composite GraphQlInputException. Please see example \Magento\QuoteGraphQl\Model\Cart\AddSimpleProductToCart::execute.

[rogyar]

Hi @lenaorobei. Thank you for your suggestion. In case of GraphQl modules, this approach will work. However, in this particular case, we work with the Quote module that has no dependency to GraphQl modules.
We use a similar approach in the Reorder functionality

magento2/app/code/Magento/Sales/Model/Reorder/Reorder.php

Line 189 in 03a9a24

if (is_string($addProductResult)) {

[mslabko]

@lenaorobei this ugly approach comes from \Magento\Quote\Model\Quote::addProduct and due to we need to provide error message(s) we need to "parse" it in that way, as was "designed" in Quote::addProduct

       /**
         * Error message
         */
        if (is_string($cartCandidates) || $cartCandidates instanceof \Magento\Framework\Phrase) {
            return (string)$cartCandidates;
        }

[lenaorobei]

With mentioned exception we should be able to return both - cart data and errors.

[dthampy]

@rogyar :
Below is a list of few of the use cases that are failing. Please take a look.
Case 1: add product to cart with a qty> the stock available
Actual result:

"errors": {
      "debugMessage": "Expected a value of type \"CheckoutUserInputErrorCodes\" but received: (empty string)","message": "Internal server error",

Case 2 : Add product with qty=0 and a valid sku,

Expected: cart is empty and error message to enter a quantity >0
Actual: The product is still added to the cart with qty =1

Case 3: Add disabled product to cart

Expected: Cart is empty and message that "product is not available"
Actual result :

exception: {
  "errors": [
    {
      "debugMessage": "Expected a value of type \"CheckoutUserInputErrorCodes\" but received: (empty string)",
      "message": "Internal server error",
Now, if we omit "code" from userInputError{} and run the same query, below exception is returned
exception: ""errors": [
    {
      "debugMessage": "User Error: expected iterable, but did not find one for field CheckoutUserInputError.path.","

Case 4 : Same result as above when you try to add a product with "Out of Stock" status.

[prabhuram93]

@magento run all tests

[prabhuram93]

@magento run all tests

[prabhuram93]

@magento run all tests

[prabhuram93]

@magento run all tests

[m2-assistant]

Hi @rogyar, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.