[GraphQL] Compare products

[Usik2203]

Description (*)

Based on this schema compare-list.graphqls we should provide functionality for list_id parameter in schema
New schema https://github.com/magento/architecture/pull/430/files
Purpose list_id is next:

The list_id becomes necessary since we want to move out the state from 
the app we have some freedom to build define a new schema GraphQL schema. 
The same as it was before for card, we need somehow to identify the list in the operations. 
Compare list may belong to a registered customer or a guest for both cases set of operation will be the same,
 technically there is no sense to associate compare list with a client unless you want to save the list for future usage. 
This is why we need to expose a new identifier list_id.
This new Id requires a new table that will have relation one to many (comparable items) and 
will represent the list as an entity.

This PR adds list_id parameter during comparing products and add CompareListGraphQl module

Related Pull Requests

Fixed Issues (if relevant)

1. Fixes Catalog/Customer :: Product Compare List #28522>

Manual testing scenario

Create Compare List

mutation{
  createCompareList (input: { products: ["123", "456"] }) #products optional {
      uid
        items {
	uid
      	product {
              id
              sku
            }
      	attributes {
          code
          value
        }
      }
    attributes {
      code
      label
    }
  }
}

Getting compared list for Customer

{
  customer {
    firstname
    lastname
    
    compare_list {
      uid 
          items {
	uid
      	product {
              id
              sku
            }
      	attributes {
          code
          value
        }
      }
    attributes {
      code
      label
    }
    }
  }
}

Get compareList by ID

{
  compareList(uid: hash) {
    uid
           items {
	uid
      	product {
              id
              sku
            }
      	attributes {
          code
          value
        }
      }
    attributes {
      code
      label
    }
  }
}

Add Products to compare list

mutation {
  addProductsToCompareList(input: { uid: hash, products: [ 2049,  2048 ]}) {
    uid
        items {
	uid
      	product {
              id
              sku
            }
      	attributes {
          code
          value
        }
      }
    attributes {
      code
      label
    }
  }
}

Remove items from compare list

mutation {
   removeProductsFromCompareList(input: {uid: "hash" , products: [2047, 2048]}) {
      uid
         items {
	uid
      	product {
              id
              sku
            }
      	attributes {
          code
          value
        }
      }
    attributes {
      code
      label
    }
  }
}

Assign compare list to customer

mutation {
  assignCompareListToCustomer(uid: hash)
}

Delete compare list

mutation {
  deleteCompareList(uid:"zo8OIjXQR0r04lx8GEbg9Ivy0HabwFnS") {
    result
  }
}

[m2-assistant]

Hi @Usik2203. 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

❗ Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s)
  For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

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

[Usik2203]

Hi @rogyar
Could I kindly ask you to review this PR if you have slot of free time?
Perhaps you will advise me something before I will start to do GraphQl coverage based on this functional.
Thanks a lot!

[keharper]

A few more description updates

[Usik2203]

@magento run all tests

[Usik2203]

Hi @keharper
All your recommendations were applied.
Thanks

[prabhuram93]

@magento run all tests

[Usik2203]

@magento run all tests

[prabhuram93]

@magento run all tests

[prabhuram93]

@magento run all tests

[prabhuram93]

@magento run all tests

[Usik2203]

@magento run all tests

[prabhuram93]

@Usik2203 The changes are merged from our internal PR, but the PR is not because your last 2.4-develop merge commit is is not referenced in our internal PR. We will make sure to merge that commit on our next PR to 2.4-develop and this PR status will be updated. cc: @cpartica

[m2-assistant]

Hi @Usik2203, 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.