cart: adjust response type of update delivery shipping options mutati…

…on (#318)

CHANGELOG.md

@@ -19,6 +19,7 @@
   * Add new type `Commerce_Cart_CustomAttributes` with method for getting key/value pairs
   * **Breaking**: Make naming convention consistent in graphql schema `Commerce_Cart_*`
   * **Breaking**: Remove the fields `getAdditionalData, additionalDataKeys, additionalDeliveryInfoKeys` from the `Commerce_CartDeliveryInfo` type
+  * **Breaking**: `Commerce_Cart_UpdateDeliveryShippingOptions` mutation responded with slice of `Commerce_Cart_DeliveryAddressForm` which was incorrect as we don't process any form data within the mutation. It responds now rightly only with `processed` state.
 
 **checkout**
 * Introducing Flamingo events on final states of the place order process

cart/interfaces/graphql/dto/dto.go

@@ -53,9 +53,12 @@ type (
 
 	// SelectedPaymentResult represents the selected payment
 	SelectedPaymentResult struct {
-		//Processed
-		Processed bool
-		//ValidationInfo
+		Processed      bool
 		ValidationInfo ValidationInfo
 	}
+
+	// UpdateShippingOptionsResult definition
+	UpdateShippingOptionsResult struct {
+		Processed bool
+	}
 )

cart/interfaces/graphql/mutationresolvers.go

@@ -199,32 +199,17 @@ func (r *CommerceCartMutationResolver) CommerceCartUpdateDeliveryAddresses(ctx c
 }
 
 // CommerceCartUpdateDeliveryShippingOptions updates the method/carrier of one or multiple existing deliveries
-func (r *CommerceCartMutationResolver) CommerceCartUpdateDeliveryShippingOptions(ctx context.Context, shippingOptions []*dto.DeliveryShippingOption) ([]*dto.DeliveryAddressForm, error) {
-	result := make([]*dto.DeliveryAddressForm, 0, len(shippingOptions))
-
+func (r *CommerceCartMutationResolver) CommerceCartUpdateDeliveryShippingOptions(ctx context.Context, shippingOptions []*dto.DeliveryShippingOption) (*dto.UpdateShippingOptionsResult, error) {
 	session := web.SessionFromContext(ctx)
 	cart, err := r.cartReceiverService.ViewCart(ctx, session)
 	if err != nil {
 		return nil, err
 	}
 
 	for _, shippingOption := range shippingOptions {
-		formResult := dto.DeliveryAddressForm{
-			Processed:    false,
-			DeliveryCode: shippingOption.DeliveryCode,
-			Method:       shippingOption.Method,
-			Carrier:      shippingOption.Carrier,
-		}
-
 		delivery, found := cart.GetDeliveryByCode(shippingOption.DeliveryCode)
 		if !found {
-			formResult.ValidationInfo.GeneralErrors = []domain.Error{
-				{
-					MessageKey: "delivery_not_found",
-				},
-			}
-			result = append(result, &formResult)
-			continue
+			return nil, cartDomain.ErrDeliveryCodeNotFound
 		}
 
 		deliveryInfo := delivery.DeliveryInfo
@@ -235,11 +220,9 @@ func (r *CommerceCartMutationResolver) CommerceCartUpdateDeliveryShippingOptions
 		if err != nil {
 			return nil, err
 		}
-		formResult.Processed = true
-		result = append(result, &formResult)
 	}
 
-	return result, nil
+	return &dto.UpdateShippingOptionsResult{Processed: true}, nil
 }
 
 // CartClean clears users cart

cart/interfaces/graphql/schema.graphql

@@ -435,6 +435,11 @@ type Commerce_Cart_DeliveryAddressForm {
     processed: Boolean
 }
 
+type Commerce_Cart_UpdateDeliveryShippingOptions_Result {
+    "Shows if the request was successfully processed"
+    processed: Boolean
+}
+
 input Commerce_Cart_DeliveryShippingOptionInput {
     "Unique delivery code to identify an **existing** delivery"
     deliveryCode: String!
@@ -475,7 +480,7 @@ extend type Mutation {
     "Adds/Updates one/multiple Delivery Addresses"
     Commerce_Cart_UpdateDeliveryAddresses(deliveryAdresses: [Commerce_Cart_DeliveryAddressInput!]): [Commerce_Cart_DeliveryAddressForm]!
     "Adds/Updates one/multiple Delivery Addresses"
-    Commerce_Cart_UpdateDeliveryShippingOptions(shippingOptions: [Commerce_Cart_DeliveryShippingOptionInput!]): [Commerce_Cart_DeliveryAddressForm]!
+    Commerce_Cart_UpdateDeliveryShippingOptions(shippingOptions: [Commerce_Cart_DeliveryShippingOptionInput!]): Commerce_Cart_UpdateDeliveryShippingOptions_Result!
     "Cleans current cart"
     Commerce_Cart_Clean: Boolean!
     "Adds/Updates additional data for the cart"

cart/interfaces/graphql/service.go

@@ -77,6 +77,8 @@ func (*Service) Types(types *graphql.Types) {
 	types.Resolve("Commerce_Cart_DefaultPaymentSelection", "cartSplit", CommerceCartQueryResolver{}, "CartSplit")
 	types.Map("Commerce_Cart_DeliveryAddressForm", dto.DeliveryAddressForm{})
 	types.Map("Commerce_Cart_DeliveryAddressInput", forms.DeliveryForm{})
+	types.Map("Commerce_Cart_UpdateDeliveryShippingOptions_Result", dto.UpdateShippingOptionsResult{})
+
 	types.GoField("Commerce_Cart_DeliveryAddressInput", "deliveryCode", "LocationCode")
 	types.GoField("Commerce_Cart_DeliveryAddressInput", "carrier", "ShippingCarrier")
 	types.GoField("Commerce_Cart_DeliveryAddressInput", "method", "ShippingMethod")

test/integrationtest/projecttest/graphql/schema/flamingo.me_flamingo-commerce_v3_cart_interfaces_graphql-Service.graphql

@@ -435,6 +435,11 @@ type Commerce_Cart_DeliveryAddressForm {
     processed: Boolean
 }
 
+type Commerce_Cart_UpdateDeliveryShippingOptions_Result {
+    "Shows if the request was successfully processed"
+    processed: Boolean
+}
+
 input Commerce_Cart_DeliveryShippingOptionInput {
     "Unique delivery code to identify an **existing** delivery"
     deliveryCode: String!
@@ -475,7 +480,7 @@ extend type Mutation {
     "Adds/Updates one/multiple Delivery Addresses"
     Commerce_Cart_UpdateDeliveryAddresses(deliveryAdresses: [Commerce_Cart_DeliveryAddressInput!]): [Commerce_Cart_DeliveryAddressForm]!
     "Adds/Updates one/multiple Delivery Addresses"
-    Commerce_Cart_UpdateDeliveryShippingOptions(shippingOptions: [Commerce_Cart_DeliveryShippingOptionInput!]): [Commerce_Cart_DeliveryAddressForm]!
+    Commerce_Cart_UpdateDeliveryShippingOptions(shippingOptions: [Commerce_Cart_DeliveryShippingOptionInput!]): Commerce_Cart_UpdateDeliveryShippingOptions_Result!
     "Cleans current cart"
     Commerce_Cart_Clean: Boolean!
     "Adds/Updates additional data for the cart"

test/integrationtest/projecttest/tests/graphql/cart_test.go

@@ -78,35 +78,7 @@ func Test_CommerceCartUpdateDeliveryShippingOptions(t *testing.T) {
 	// update shipping options
 	response = helper.GraphQlRequest(t, e, loadGraphQL(t, "update_delivery_shipping_options", nil)).Expect()
 	response.Status(http.StatusOK)
-	forms = getArray(response, "Commerce_Cart_UpdateDeliveryShippingOptions")
-	forms.Length().Equal(3)
-
-	address := forms.Element(0).Object()
-	address.Value("deliveryCode").String().Equal("foo")
-	address.Value("carrier").String().Equal("foo-carrier")
-	address.Value("method").String().Equal("foo-method")
-	address.Value("processed").Boolean().Equal(true)
-	validation := address.Value("validationInfo").Object()
-	validation.Value("generalErrors").Null()
-	validation.Value("fieldErrors").Null()
-
-	address = forms.Element(1).Object()
-	address.Value("deliveryCode").Equal("bar")
-	address.Value("carrier").String().Equal("bar-carrier")
-	address.Value("method").String().Equal("bar-method")
-	address.Value("processed").Boolean().Equal(true)
-	validation = address.Value("validationInfo").Object()
-	validation.Value("generalErrors").Null()
-	validation.Value("fieldErrors").Null()
-
-	address = forms.Element(2).Object()
-	address.Value("deliveryCode").Equal("non-existing")
-	address.Value("carrier").String().Equal("bar")
-	address.Value("method").String().Equal("foo")
-	address.Value("processed").Boolean().Equal(false)
-	validation = address.Value("validationInfo").Object()
-	validation.Value("generalErrors").NotNull()
-	validation.Value("fieldErrors").Null()
+	getValue(response, "Commerce_Cart_UpdateDeliveryShippingOptions", "processed").Boolean().Equal(true)
 
 	// check cart
 	response = helper.GraphQlRequest(t, e, loadGraphQL(t, "cart_decorated_cart", nil)).Expect()

test/integrationtest/projecttest/tests/graphql/testdata/update_delivery_shipping_options.graphql

@@ -11,27 +11,8 @@ mutation {
                 method: "bar-method"
                 carrier: "bar-carrier"
             }
-            {
-                deliveryCode: "non-existing"
-                method: "foo"
-                carrier: "bar"
-            }
         ]
     ) {
-        deliveryCode
-        carrier
-        method
         processed
-        validationInfo {
-            fieldErrors {
-                messageKey
-                defaultLabel
-                fieldName
-            }
-            generalErrors {
-                messageKey
-                defaultLabel
-            }
-        }
     }
 }