PWA-1379: [GraphQl] AddWishlistItemsToCartOutput.status doesn't return the correct status if items are not added to cart

- Added fix, minor schema changes and tests

Author: Prabhu Ram

app/code/Magento/WishlistGraphQl/Model/Resolver/Wishlist/AddToCart.php

@@ -147,6 +147,12 @@ public function resolve(
 
         $collection = $this->getWishlistItems($wishlist, $itemIds);
 
+        if (!empty($itemIds)) {
+            $unknownItemIds = array_diff($itemIds, array_keys($collection->getItems()));
+            if (!empty($unknownItemIds)) {
+                throw new GraphQlInputException(__('The wishlist item ids "'.implode(',', $unknownItemIds).'" were not found.'));
+            }
+        }
         $maskedCartId = $this->createEmptyCartForCustomer->execute($customerId);
 
         $cartErrors = [];
@@ -180,6 +186,7 @@ function (Error $error) {
             $wishlist->save();
         }
         return [
+            'wishlist' => $this->wishlistDataMapper->map($wishlist),
             'status' => empty($cartErrors) ? true : false,
             'add_wishlist_items_to_cart_user_errors' => $cartErrors,
         ];

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

@@ -67,6 +67,7 @@ type Mutation {
 }
 
 type AddWishlistItemsToCartOutput {
+    wishlist: Wishlist! @doc(description: "Contains the wish list with all items that were successfully added")
     status: Boolean! @doc(description: "Indicates whether the attempt to add items to the customer's cart was successful")
     add_wishlist_items_to_cart_user_errors: [CartUserInputError!]! @doc(description: "An array of errors encountered while adding products to the customer's cart")
 }

dev/tests/api-functional/testsuite/Magento/GraphQl/Wishlist/AddWishlistItemsToCartTest.php

@@ -49,6 +49,31 @@ public function testAddItemsToCart(): void
         $response = $this->graphQlMutation($query, [], '', $this->getHeaderMap());
 
         $this->assertArrayHasKey('addWishlistItemsToCart', $response);
+        $wishlistAfterAddingToCart = $response['addWishlistItemsToCart']['wishlist'];
+        $wishlistItems = $wishlistAfterAddingToCart['items_v2']['items'];
+        $this->assertEmpty($wishlistItems);
+        $this->assertArrayHasKey('status', $response['addWishlistItemsToCart']);
+        $this->assertEquals($response['addWishlistItemsToCart']['status'], true);
+    }
+
+    /**
+     * @magentoConfigFixture default_store wishlist/general/active 1
+     * @magentoApiDataFixture Magento/Customer/_files/customer.php
+     * @magentoApiDataFixture Magento/Wishlist/_files/wishlist_with_multiple_products.php
+     */
+    public function testAddAllItemsToCart(): void
+    {
+        $wishlist = $this->getWishlist();
+        $customerWishlist = $wishlist['customer']['wishlists'][0];
+        $wishlistId = $customerWishlist['id'];
+
+        $query = $this->getAddAllItemsToCartQuery($wishlistId);
+        $response = $this->graphQlMutation($query, [], '', $this->getHeaderMap());
+
+        $this->assertArrayHasKey('addWishlistItemsToCart', $response);
+        $wishlistAfterAddingToCart = $response['addWishlistItemsToCart']['wishlist'];
+        $wishlistItems = $wishlistAfterAddingToCart['items_v2']['items'];
+        $this->assertEmpty($wishlistItems);
         $this->assertArrayHasKey('status', $response['addWishlistItemsToCart']);
         $this->assertEquals($response['addWishlistItemsToCart']['status'], true);
     }
@@ -134,6 +159,25 @@ public function testAddItemsToCartWithInvalidId(): void
         $this->graphQlMutation($query, [], '', $this->getHeaderMap());
     }
 
+    /**
+     * @magentoConfigFixture default_store wishlist/general/active 1
+     * @magentoApiDataFixture Magento/Customer/_files/customer.php
+     * @magentoApiDataFixture Magento/Wishlist/_files/wishlist_with_simple_product.php
+     */
+    public function testAddItemsToCartWithInvalidItemId(): void
+    {
+        $itemId = '9999';
+
+        $this->expectException(Exception::class);
+        $this->expectExceptionMessage('The wishlist item ids "9999" were not found.');
+
+        $wishlist = $this->getWishlist();
+        $customerWishlist = $wishlist['customer']['wishlists'][0];
+
+        $query = $this->getQuery($customerWishlist['id'], $itemId);
+        $this->graphQlMutation($query, [], '', $this->getHeaderMap());
+    }
+
     /**
      * Authentication header map
      *
@@ -170,6 +214,46 @@ private function getQuery(
       wishlistItemIds: ["{$itemId}"]
     ) {
     status
+    wishlist {
+      items_v2 {
+        items {
+          id
+        }
+      }
+    }
+    add_wishlist_items_to_cart_user_errors{
+        message
+        code
+    }
+   }
+}
+MUTATION;
+    }
+
+    /**
+     * Returns GraphQl mutation string
+     *
+     * @param string $wishlistId
+     * @param string $itemId
+     * @return string
+     */
+    private function getAddAllItemsToCartQuery(
+        string $wishlistId
+    ): string {
+        return <<<MUTATION
+mutation {
+    addWishlistItemsToCart
+    (
+      wishlistId: "{$wishlistId}"
+    ) {
+    status
+    wishlist {
+      items_v2 {
+        items {
+          id
+        }
+      }
+    }
     add_wishlist_items_to_cart_user_errors{
         message
         code

dev/tests/integration/testsuite/Magento/Wishlist/_files/wishlist_with_multiple_products.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento\Catalog\Api\ProductRepositoryInterface;
+use Magento\Customer\Model\CustomerRegistry;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\Wishlist\Model\WishlistFactory;
+use Magento\TestFramework\Workaround\Override\Fixture\Resolver;
+
+Resolver::getInstance()->requireDataFixture('Magento/Customer/_files/customer.php');
+Resolver::getInstance()->requireDataFixture('Magento/Catalog/_files/multiple_products.php');
+
+$objectManager = Bootstrap::getObjectManager();
+/** @var CustomerRegistry $customerRegistry */
+$customerRegistry = Bootstrap::getObjectManager()->create(CustomerRegistry::class);
+$customer = $customerRegistry->retrieve(1);
+/** @var ProductRepositoryInterface $productRepository */
+$productRepository = $objectManager->create(ProductRepositoryInterface::class);
+$product = $productRepository->get('simple1');
+$product2 = $productRepository->get('simple2');
+
+$wishlistFactory = $objectManager->get(WishlistFactory::class);
+$wishlist = $wishlistFactory->create();
+$wishlist->loadByCustomerId($customer->getId(), true);
+/** @var \Magento\Catalog\Helper\Product $productHelper */
+$productHelper = $objectManager->get(\Magento\Catalog\Helper\Product::class);
+$isSkipSaleableCheck = $productHelper->getSkipSaleableCheck();
+$productHelper->setSkipSaleableCheck(true);
+$wishlist->addNewItem($product);
+$wishlist->addNewItem($product2);
+$productHelper->setSkipSaleableCheck($isSkipSaleableCheck);

dev/tests/integration/testsuite/Magento/Wishlist/_files/wishlist_with_multiple_products_rollback.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento\TestFramework\Workaround\Override\Fixture\Resolver;
+
+Resolver::getInstance()->requireDataFixture('Magento/Customer/_files/customer_rollback.php');
+Resolver::getInstance()->requireDataFixture('Magento/Catalog/_files/multiple_products_rollback.php');