| Feature/Notable Change | Related Services | Links |
|---|---|---|
Introduced item proration details to represent a prorated order adjustment on a per-quantity basis |
PromotionServices, OfferClient, OrderCommon |
|
Refactored TaxService to make use of TaxDelegate pattern introduced in TaxCommon |
TaxCommon |
|
Introduced improved logging throughout the checkout process |
OrderOperationServices, MicroSecurityCommon |
|
Improve support for awaiting async result when looking up and claiming 3DS transactions in checkout |
NextJS Starter, PaymentTransactionServices, Checkout.com Integration Module |
|
|
CartOperationServices, OrderServices, CartClient, OrderClient, Commerce SDK, NextJS Starter |
|
Introduced Apple Pay integration with Checkout.com |
CartOperationServices, OrderOperationServices, PaymentGatewayCommon, PaymentTransactionServices, Checkout.com Integration Module, Commerce SDK, NextJS Starter, Payment SDK |
|
Improved catalog representation within CartOperationServices
|
CartOperationServices, CartClient |
|
Improved checkout performance and extensibility |
CartClient, OrderOperationServices, PaymentTransactionServices, CreditAccountServices |
Checkout Performance and Extensibility Improvements in 1.8.1-GA |
Updated CartStalePricingValidationActivity to honor Cart pricing within defined time-to-live by default |
| Issue |
|---|
Fixed invalid payment total if offer applied after shipping stage |
Fixed potential NullPointerException from CartItem type filter |
Fixed potential NullPointerException from Cart’s |
Fixed tax calculation for cart items with VIRTUAL fulfillment type |
In 1.8.1-GA, checkout-related components are refactored for better performance and extensibility, which include the following:
Introduced CheckoutProcessDto to hold all the data required and passed in and out of the checkout service, workflow, and activities
For example, the CheckoutWorkflow 's execute method signature changed from:
Cart execute(Cart cart,
String requestId,
Map<String, String> paymentLockTokens,
Map<String, String> securityCodes,
@Nullable ContextInfo contextInfo);
to:
CheckoutProcessDto execute(CheckoutProcessDto checkoutProcessDto,
Map<String, String> securityCodes,
@Nullable ContextInfo contextInfo);
|
Note
|
Security codes are still explicitly passed as an additional parameter so that activities that require them are easily differentiated and are required to implement RequiresSecurePaymentInformationActivity
|
This domain is useful to ensure that any additional data required for a custom workflow or activity can be easily accessed and consumed in the customization, without requiring an override in the workflow and activities to add a new parameter. To add new data, please see Adding Custom Data for instructions
Cart payments are now retrieved during the lock payments request, and they are passed throughout the workflow and activities without needing to fetch them again
Checkout-related exception handling behaviors are also updated to pass around the latest CheckoutProcessDto, to avoid having stale data
Consolidated persist cart actions into a single request where possible
Moved store credit payment balance validation to CartPaymentMethodValidationActivity, so that checkout can fail earlier rather than having some payments executed and then reversed due to checkout rollback from insufficient balance
Improved store credit payment validation to read multiple store credit accounts in a single request
Introduced property to control whether real-time pricing should be used in CartStalePricingValidationActivity
If disabled (default out-of-box), the activity will honor the stale pricing if it’s within the specified cart pricing time-to-live. See Added Properties for more details
If you have any customization around checkout-related components, such as checkout service, checkout workflow, custom activities, etc., their method signatures need to be updated accordingly.
For example, a custom added activity should change from:
public class CustomActivity implements CheckoutWorkflowActivity {
@Override
public Cart execute(@lombok.NonNull Cart cart,
@lombok.NonNull String requestId,
@Nullable ContextInfo contextInfo) {
doCustomBehavior(cart);
return cart;
}
@Override
public Cart rollback(@lombok.NonNull Cart cart,
@lombok.NonNull String requestId,
@Nullable ContextInfo contextInfo) {
return cart;
}
}to:
public class CustomActivity implements CheckoutWorkflowActivity {
@Override
public CheckoutProcessDto execute(@lombok.NonNull CheckoutProcessDto processDto,
@Nullable ContextInfo contextInfo) {
doCustomBehavior(processDto);
return processDto;
}
@Override
public CheckoutProcessDto rollback(@lombok.NonNull CheckoutProcessDto processDto,
@Nullable ContextInfo contextInfo) {
return processDto;
}
}|
Important
|
Custom activities that implement RequiresSecurePaymentInformationActivity still take the securityCodes explicitly, e.g. CheckoutProcessDto execute(CheckoutProcessDto dto,
Map<String, String> securityCodes,
@Nullable ContextInfo context)
|
To ensure that CheckoutProcessDto always has the latest data, please always remember to update CheckoutProcessDto accordingly if your custom activity persists cart, payments, etc.
For example:
// Prevents StaleCartException from stale cart version
Cart updatedCart = cartProvider.updateCart(cart, contextInfo);
processDto.setCart(updatedCart);broadleaf.cartoperation.checkout.activity.validation.cart-stale-pricing.use-real-time-cart-pricing
Description: Whether the CartStalePricingValidationActivity should use real time pricing or honer the cart pricing time-to-live based on the last catalog reprice. See Stale Cart Pricing Configurations for other related configurations
Default value: false
broadleaf.cartoperation.paymentprovider.lock-and-retrieve-payments-uri
Description: The URI path for locking multiple payments and include their PaymentSummaries in the response