checkout: Add CartValidationResult to place order context if in failed state

CHANGELOG.md

@@ -23,6 +23,13 @@
 
 **checkout**
 * Introducing Flamingo events on final states of the place order process
+* API
+  * In case of an invalid cart during place order process we now expose the cart validation result, affected endpoints:
+    ```
+    GET /api/v1/checkout/placeorder
+    POST /api/v1/checkout/placeorder/refresh
+    POST /api/v1/checkout/placeorder/refresh-blocking
+    ```
 
 **customer**
 * Add mockery mocks for both `Customer` / `CustomerIdentityService` for easier testing

cart/domain/validation/cartValidator.go

@@ -2,13 +2,14 @@ package validation
 
 import (
 	"context"
+
 	"flamingo.me/flamingo-commerce/v3/cart/domain/decorator"
 
 	"flamingo.me/flamingo/v3/framework/web"
 )
 
 type (
-	//Result groups the validation result
+	// Result groups the validation result
 	Result struct {
 		HasCommonError        bool
 		CommonErrorMessageKey string

checkout/interfaces/controller/apicontroller.go

@@ -7,6 +7,7 @@ import (
 
 	"flamingo.me/flamingo-commerce/v3/cart/domain/cart"
 	placeorderDomain "flamingo.me/flamingo-commerce/v3/cart/domain/placeorder"
+	"flamingo.me/flamingo-commerce/v3/cart/domain/validation"
 	"flamingo.me/flamingo-commerce/v3/checkout/application"
 	"flamingo.me/flamingo-commerce/v3/checkout/domain/placeorder/process"
 
@@ -35,12 +36,13 @@ type (
 
 	// placeOrderContext infos
 	placeOrderContext struct {
-		Cart         *cart.Cart
-		OrderInfos   *placedOrderInfos
-		State        string
-		StateData    process.StateData
-		UUID         string
-		FailedReason string
+		Cart                 *cart.Cart
+		OrderInfos           *placedOrderInfos
+		State                string
+		StateData            process.StateData
+		UUID                 string
+		FailedReason         string
+		CartValidationResult *validation.Result
 	}
 
 	// placedOrderInfos infos
@@ -181,17 +183,24 @@ func (c *APIController) getPlaceOrderContext(ctx context.Context, pctx *process.
 			PlacedDecoratedCart: decoratedCart,
 		}
 	}
+
+	var validationResult *validation.Result
 	var failedReason string
 	if pctx.FailedReason != nil {
 		failedReason = pctx.FailedReason.Reason()
+		if reason, ok := pctx.FailedReason.(process.CartValidationErrorReason); ok {
+			validationResult = &reason.ValidationResult
+		}
 	}
+
 	return placeOrderContext{
-		Cart:         &pctx.Cart,
-		OrderInfos:   orderInfos,
-		State:        pctx.CurrentStateName,
-		StateData:    pctx.CurrentStateData,
-		FailedReason: failedReason,
-		UUID:         pctx.UUID,
+		Cart:                 &pctx.Cart,
+		OrderInfos:           orderInfos,
+		State:                pctx.CurrentStateName,
+		StateData:            pctx.CurrentStateData,
+		FailedReason:         failedReason,
+		CartValidationResult: validationResult,
+		UUID:                 pctx.UUID,
 	}
 }
 

docs/openapi/docs.go

@@ -1710,6 +1710,9 @@ var doc = `{
                 "Cart": {
                     "$ref": "#/definitions/cart.Cart"
                 },
+                "CartValidationResult": {
+                    "$ref": "#/definitions/validation.Result"
+                },
                 "FailedReason": {
                     "type": "string"
                 },

docs/openapi/swagger.json

@@ -1693,6 +1693,9 @@
                 "Cart": {
                     "$ref": "#/definitions/cart.Cart"
                 },
+                "CartValidationResult": {
+                    "$ref": "#/definitions/validation.Result"
+                },
                 "FailedReason": {
                     "type": "string"
                 },

docs/openapi/swagger.yaml

@@ -427,6 +427,8 @@ definitions:
     properties:
       Cart:
         $ref: '#/definitions/cart.Cart'
+      CartValidationResult:
+        $ref: '#/definitions/validation.Result'
       FailedReason:
         type: string
       OrderInfos: