[GraphQl][Wishlist] Implementing a new Query of getting customer wishlist #29148

eduard13 · 2020-07-15T12:13:44Z

Description (*)

This PR is a follow up of the following discussion, that is supposed to introduce a new Query, that will return the customer wishlists.
For CE version, it will always return a single wishlist (as there is no possibility to create more wishlists), so probably it doesn't make sense to implement any kind of logic to limit it to just 1 result. What do you think?

Related Pull Requests

https://github.com/magento/partners-magento2-infrastructure/pull/26

Fixed Issues (if relevant)

N/A

Manual testing scenarios (*)

Get Customer's wishlist

query {
  customer {
    wishlists {
      items_count
      sharing_code
      items_v2 {
        id
      	quantity
      	description
      	added_at
      }
    }
  }
}

Get Customer's wishlist (`wishlist_v2`)

query {
  customer {
    wishlist_v2(id: 0) {
      items_count
      sharing_code
      updated_at
      items_v2 {
        id
        quantity
        description
        added_at
        ... on DownloadableWishlistItem {
            links_v2 {
                id
                title
                sample_url
            }
            samples {
                id
                title
                sample_url
            }
        }
        ... on ConfigurableWishlistItem {
            child_sku
            configurable_options {
                id
                option_label
                value_id
		value_label
            }
        }
        ... on BundleWishlistItem {
            bundle_options {
                id
                label
                type
		values {
                    id
                    label
                    quantity
                    price
                }
            }
        }
      }
    }
  }
}

Questions or comments

The new Query will also be working for Multiple Wishlists, that will return all the customer's wishlists. Additionally it supports pagination, that may be used in EE version.

cc. @nrkapoor, @DrewML, @prabhuram93

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 · 2020-07-15T12:13:47Z

Hi @eduard13. 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:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
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.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

eduard13 · 2020-07-15T12:59:15Z

@magento run all tests

rogyar · 2020-07-16T17:25:54Z

The general idea looks good to me. But before jumping into details, I believe the schema/architecture should be approved by @paliarush.

Alex, could you share your thoughts, please, on this implementation?
Appreciate your time.

nrkapoor · 2020-07-16T19:00:09Z

The general idea looks good to me. But before jumping into details, I believe the schema/architecture should be approved by @paliarush.

Alex, could you share your thoughts, please, on this implementation?
Appreciate your time.

@rogyar I believe the changes were approved but we still need to merge the architecture PR. @DrewML @paliarush can you merge the PR?

DrewML · 2020-07-16T22:49:46Z

Apologies for the lag - architecture PR here magento/architecture#403

rogyar · 2020-07-17T14:55:27Z

app/code/Magento/WishlistGraphQl/Model/Resolver/CustomerWishlists.php

+        array $args = null
+    ) {
+        if (!$this->wishlistConfig->isEnabled()) {
+            throw new GraphQlInputException(__('The wishlist is not currently available.'));


I would recommend some more meaningful explanation here. Otherwise, it might sound like EntityNotFound issue for some particular wishlist.

rogyar · 2020-07-17T14:57:15Z

app/code/Magento/WishlistGraphQl/Model/Resolver/CustomerWishlists.php

+            $collection->setPageSize($pageSize);
+        }
+
+        $result = [];


I would recommend using more specific names for variables

Suggested change

$result = [];

$wishlists = [];

rogyar · 2020-07-17T15:01:00Z

Hi @eduard13. Please, check my minor recommendations above. Thank you.

eduard13 · 2020-07-22T09:02:43Z

@magento run all tests

eduard13 · 2020-07-22T11:21:07Z

@magento run all tests

eduard13 · 2020-07-23T06:32:08Z

Hi @rogyar, your suggestions have been implemented.
Thank you.

…list-graphql

prabhuram93 · 2020-08-19T16:26:56Z

@magento run all tests

keharper

Mostly changing "wishlist to wish list", since that's how it's spelled in the Admin and Luma

keharper · 2020-08-20T20:19:19Z

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

+    wishlists(
+        pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. This attribute is optional."),
+        currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1.")
+    ): [Wishlist!]! @doc(description: "An array of wishlists. In Magento Open Source, customers are limited to one wishlist. The number of wishlists is not restricted for Magento Commerce") @resolver(class:"\\Magento\\WishlistGraphQl\\Model\\Resolver\\CustomerWishlists")


Suggested change

): [Wishlist!]! @doc(description: "An array of wishlists. In Magento Open Source, customers are limited to one wishlist. The number of wishlists is not restricted for Magento Commerce") @resolver(class:"\\Magento\\WishlistGraphQl\\Model\\Resolver\\CustomerWishlists")

): [Wishlist!]! @doc(description: "An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Magento Commerce") @resolver(class:"\\Magento\\WishlistGraphQl\\Model\\Resolver\\CustomerWishlists")

keharper · 2020-08-20T20:19:54Z

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

+        currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1.")
+    ): [Wishlist!]! @doc(description: "An array of wishlists. In Magento Open Source, customers are limited to one wishlist. The number of wishlists is not restricted for Magento Commerce") @resolver(class:"\\Magento\\WishlistGraphQl\\Model\\Resolver\\CustomerWishlists")
+    wishlist: Wishlist! @deprecated(reason: "Use `Customer.wishlists` or `Customer.wishlist_v2`") @resolver(class:"\\Magento\\WishlistGraphQl\\Model\\Resolver\\CustomerWishlistResolver") @doc(description: "Contains a customer's wish lists")  @cache(cacheable: false)
+    wishlist_v2(id: ID!): Wishlist @doc(description: "Retrieve the specified wishlist") @resolver(class: "\\Magento\\WishlistGraphQl\\Model\\Resolver\\WishlistById")


Suggested change

wishlist_v2(id: ID!): Wishlist @doc(description: "Retrieve the specified wishlist") @resolver(class: "\\Magento\\WishlistGraphQl\\Model\\Resolver\\WishlistById")

wishlist_v2(id: ID!): Wishlist @doc(description: "Retrieve the specified wish list") @resolver(class: "\\Magento\\WishlistGraphQl\\Model\\Resolver\\WishlistById")

keharper · 2020-08-20T20:21:01Z

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

@@ -492,3 +492,9 @@ type StoreConfig @doc(description: "The type contains information about a store
    catalog_default_sort_by : String @doc(description: "Default Sort By.")
    root_category_id: Int @doc(description: "The ID of the root category") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\RootCategoryId")
 }
+
+type SimpleWishlistItem implements WishlistItemInterface @doc(description: "A simple product wishlist Item") {


Suggested change

type SimpleWishlistItem implements WishlistItemInterface @doc(description: "A simple product wishlist Item") {

type SimpleWishlistItem implements WishlistItemInterface @doc(description: "A simple product wish list item") {

keharper · 2020-08-20T20:21:17Z

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

+type SimpleWishlistItem implements WishlistItemInterface @doc(description: "A simple product wishlist Item") {
+}
+
+type VirtualWishlistItem implements WishlistItemInterface @doc(description: "A virtual product wishlist item") {


Suggested change

type VirtualWishlistItem implements WishlistItemInterface @doc(description: "A virtual product wishlist item") {

type VirtualWishlistItem implements WishlistItemInterface @doc(description: "A virtual product wish list item") {

keharper · 2020-08-20T20:21:43Z

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

@@ -68,3 +68,8 @@ type SelectedConfigurableOption {
    value_id: Int!
    value_label: String!
 }
+
+type ConfigurableWishlistItem implements WishlistItemInterface @doc(description: "A configurable product wishlist item"){


Suggested change

type ConfigurableWishlistItem implements WishlistItemInterface @doc(description: "A configurable product wishlist item"){

type ConfigurableWishlistItem implements WishlistItemInterface @doc(description: "A configurable product wish list item"){

keharper · 2020-08-20T20:29:22Z

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

@@ -64,3 +64,8 @@ type DownloadableProductSamples @doc(description: "DownloadableProductSamples de
    sample_type: DownloadableFileTypeEnum @deprecated(reason: "`sample_url` serves to get the downloadable sample")
    sample_file: String @deprecated(reason: "`sample_url` serves to get the downloadable sample")
 }
+
+type DownloadableWishlistItem implements WishlistItemInterface @doc(description: "A downloadable product wishlist item") {


Suggested change

type DownloadableWishlistItem implements WishlistItemInterface @doc(description: "A downloadable product wishlist item") {

type DownloadableWishlistItem implements WishlistItemInterface @doc(description: "A downloadable product wish list item") {

…list-graphql

prabhuram93 · 2020-08-20T23:51:57Z

@keharper I added your suggestions and linked infra PR.

prabhuram93 · 2020-08-20T23:52:17Z

@magento run all tests

m2-assistant · 2020-08-27T20:40:06Z

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

eduard13 requested review from rogyar, DrewML and prabhuram93 July 15, 2020 12:13

ghost added the Progress: pending review label Jul 15, 2020

magento-engcom-team added Component: WishlistGraphQl Release Line: 2.4 Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner labels Jul 15, 2020

rogyar self-assigned this Jul 15, 2020

nrkapoor added the Project: GraphQL label Jul 15, 2020

nrkapoor added this to the 2.4.1 milestone Jul 15, 2020

nrkapoor requested review from dthampy and avattam06 July 15, 2020 19:52

DrewML mentioned this pull request Jul 16, 2020

Wishlist updates proposed in Magento 2 Commerce PR (internal) magento/architecture#403

Merged

rogyar requested changes Jul 17, 2020

View reviewed changes

ghost added Progress: needs update and removed Progress: pending review labels Jul 17, 2020

rogyar added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: test coverage Award: category of expertise labels Jul 17, 2020

nrkapoor assigned eduard13 Jul 23, 2020

Merge remote-tracking branch 'mainline/2.4-develop' into feature/wish…

9d945d2

…list-graphql

ghost added Progress: needs update and removed Progress: testing in progress labels Aug 19, 2020

keharper reviewed Aug 20, 2020

View reviewed changes

Prabhu Ram added 3 commits August 20, 2020 17:47

Merge remote-tracking branch 'mainline/2.4-develop' into feature/wish…

b4e5ace

…list-graphql

minor schema updates

8c4de4d

Merge remote-tracking branch 'mainline/2.4-develop' into feature/wish…

7ce741e

…list-graphql

ghost added Progress: review and removed Progress: needs update labels Aug 21, 2020

prabhuram93 approved these changes Aug 21, 2020

View reviewed changes

ghost added Progress: ready for testing Progress: testing in progress Progress: accept and removed Progress: review Progress: ready for testing Progress: testing in progress labels Aug 21, 2020

magento-engcom-team merged commit c23388d into magento:2.4-develop Aug 27, 2020

ghost added Progress: needs update and removed Progress: accept labels Aug 31, 2020

ghost added Progress: ready for testing Progress: testing in progress Progress: accept and removed Progress: needs update Progress: ready for testing Progress: testing in progress labels Sep 10, 2020

keharper mentioned this pull request Nov 12, 2020

GraphQL: Document WishlistItemInterface magento/devdocs#8221

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GraphQl][Wishlist] Implementing a new Query of getting customer wishlist #29148

[GraphQl][Wishlist] Implementing a new Query of getting customer wishlist #29148

eduard13 commented Jul 15, 2020 •

edited by prabhuram93

Loading

m2-assistant bot commented Jul 15, 2020

eduard13 commented Jul 15, 2020

rogyar commented Jul 16, 2020

nrkapoor commented Jul 16, 2020

DrewML commented Jul 16, 2020

rogyar Jul 17, 2020

rogyar Jul 17, 2020

rogyar commented Jul 17, 2020

eduard13 commented Jul 22, 2020

eduard13 commented Jul 22, 2020

eduard13 commented Jul 23, 2020 •

edited

Loading

prabhuram93 commented Aug 19, 2020

keharper left a comment

keharper Aug 20, 2020

keharper Aug 20, 2020

keharper Aug 20, 2020

keharper Aug 20, 2020

keharper Aug 20, 2020

keharper Aug 20, 2020

prabhuram93 commented Aug 20, 2020

prabhuram93 commented Aug 20, 2020

m2-assistant bot commented Aug 27, 2020

	): [Wishlist!]! @doc(description: "An array of wishlists. In Magento Open Source, customers are limited to one wishlist. The number of wishlists is not restricted for Magento Commerce") @resolver(class:"\\Magento\\WishlistGraphQl\\Model\\Resolver\\CustomerWishlists")
	): [Wishlist!]! @doc(description: "An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Magento Commerce") @resolver(class:"\\Magento\\WishlistGraphQl\\Model\\Resolver\\CustomerWishlists")

	wishlist_v2(id: ID!): Wishlist @doc(description: "Retrieve the specified wishlist") @resolver(class: "\\Magento\\WishlistGraphQl\\Model\\Resolver\\WishlistById")
	wishlist_v2(id: ID!): Wishlist @doc(description: "Retrieve the specified wish list") @resolver(class: "\\Magento\\WishlistGraphQl\\Model\\Resolver\\WishlistById")

	type SimpleWishlistItem implements WishlistItemInterface @doc(description: "A simple product wishlist Item") {
	type SimpleWishlistItem implements WishlistItemInterface @doc(description: "A simple product wish list item") {

	type VirtualWishlistItem implements WishlistItemInterface @doc(description: "A virtual product wishlist item") {
	type VirtualWishlistItem implements WishlistItemInterface @doc(description: "A virtual product wish list item") {

	type ConfigurableWishlistItem implements WishlistItemInterface @doc(description: "A configurable product wishlist item"){
	type ConfigurableWishlistItem implements WishlistItemInterface @doc(description: "A configurable product wish list item"){

	type DownloadableWishlistItem implements WishlistItemInterface @doc(description: "A downloadable product wishlist item") {
	type DownloadableWishlistItem implements WishlistItemInterface @doc(description: "A downloadable product wish list item") {

[GraphQl][Wishlist] Implementing a new Query of getting customer wishlist #29148

[GraphQl][Wishlist] Implementing a new Query of getting customer wishlist #29148

Conversation

eduard13 commented Jul 15, 2020 • edited by prabhuram93 Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Get Customer's wishlist

Get Customer's wishlist (wishlist_v2)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Jul 15, 2020

eduard13 commented Jul 15, 2020

rogyar commented Jul 16, 2020

nrkapoor commented Jul 16, 2020

DrewML commented Jul 16, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rogyar commented Jul 17, 2020

eduard13 commented Jul 22, 2020

eduard13 commented Jul 22, 2020

eduard13 commented Jul 23, 2020 • edited Loading

prabhuram93 commented Aug 19, 2020

keharper left a 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

prabhuram93 commented Aug 20, 2020

prabhuram93 commented Aug 20, 2020

m2-assistant bot commented Aug 27, 2020

eduard13 commented Jul 15, 2020 •

edited by prabhuram93

Loading

Get Customer's wishlist (`wishlist_v2`)

eduard13 commented Jul 23, 2020 •

edited

Loading