Broadleaf Microservices
  • v1.0.0-latest-prod

Upgrade to 2.3.0

Security

Important

This release contains several security-related fixes. It is strongly recommended that you review the security-related content for these releases at Broadleaf Security. You will need your login credentials originally provided for accessing the Broadleaf nexus.

Requirements

  • Java 17 is required since 2.0.0-GA.

New Services

Introduced new Workflow Service
Introduced new Audit Service
Introduced Subscription Lifecycle & Billing Functionality
  • Impacted Services: CatalogServices, PricingServices, OfferServices, CartOperationServices, OrderOperationServices, SubscriptionOperationServices, BillingServices, WorkflowServices, AuditServices

  • Highlights:

    • Subscription Purchase & Fulfillment: Out-of-box support for handling subscription-based products directly within the cart & checkout.

    • Subscription Management: Manage the full subscription lifecycle with configurable edit, upgrade, downgrade, and cancellation scenarios. Includes advanced support for sandboxing and delayed prepaid actions.

    • Recurring Billing: A highly configurable recurring billing engine that works in conjunction with Broadleaf’s Catalog, Pricing, and Offer Engines to support complex or unique recurring billing needs.

    • CSR Interactions: Allow CSRs to manage subscriptions price changes and add discounts to existing subscriptions.

Introduction of Chase Payment integration module

New and Notable Changes

Support for Kafka KRaft and Strimzi Operator
Support for Fees and Fee Calculation for Cart Pricing
Support Retail Delivery Fees from Avalara Tax
Added Domain Support for Default Frequency for Products with Recurring Pricing
Microservice Gateways Performance Improvements
  • Impacted Services: Microservices Gateways

  • Highlights:

    • Rewrote OAuth2ClientCredentialsGatewayFilterFactory to use a fully non-blocking mechanism for all logic related to obtaining a new access token.

    • Rewrote ApplicationTokenGatewayFilterFactory and ExternalApplicationResolverService to move blocking cache interactions off of the event loop thread and into worker threads.

  • Links: Please refer to Gateways 2.0.5

Confirmed Node 22 and 24 Support for Frontend Projects
New Components and Component Enhancements
Introduced TenantService Component to make interactions with Tenant Microservice extensible
Removed Bootstrap dependency
Added support for customizing access token cache key
  • Impacted Services: Auth SDK (@broadleaf/auth-web)

  • Links: Please refer to Auth JS SDK 1.6.5

Support Specifying Variant Hydration Behavior in Product Details Requests
Introduced Lightweight Inventory Availability Index Based on Lite Variant Details
Introduced New API for Consolidated Returnable Items and Fees Information
Support for Consolidated OMS Refund Transactions
Support for Two-Tier Pricing using Attributes and Characteristics
Added new Price List Types
Introduced Pricing Categories
Introduced Variant Pricing Strategy
Added support for Caffeine and Ehcache as Spring Cache options
  • Impacted Services: All services implementing caching

  • Links: Please refer to Caching for more information.

Breaking Changes Requiring Action

ProductCharacteristic domain separation

Notable Bug Fixes

Fixed RecordTooLargeException from Changing Status of a Large Fulfillment
Fixed Various Refund Bugs

Frontend Compatibility and Release Notes

Microservices Release 2.3.0 is congruent with:

  • AdminWeb 1.10.13

    • Recommended

    • Adds Node 22 and 24 support

    • Artifacts

      • @broadleaf/admin-components

      • @broadleaf/admin-stripe-components

      • @broadleaf/admin-tailwindcss

      • @broadleaf/admin-style: 1.10.11 (unchanged)

  • Auth JS SDK 1.6.5

    • Recommended

    • Adds Node 22 and 24 support

    • Artifacts

      • @broadleaf/auth-react

      • @broadleaf/auth-web

  • Commerce JS SDK 1.7.2

    • Recommended

    • Adds Node 22 and 24 support

    • Artifacts

      • @broadleaf/commerce-browse

      • @broadleaf/commerce-cart

      • @broadleaf/commerce-content

      • @broadleaf/commerce-core

      • @broadleaf/commerce-customer

      • @broadleaf/commerce-menu

      • @broadleaf/commerce-sandbox

      • @broadleaf/commerce-tenant

  • Commerce Quote UI 1.1.2

    • Optional

    • Adds Node 22 and 24 support

  • Commerce Shared React 1.0.2

    • Optional

    • Adds Node 22 and 24 support

  • Commerce Subscription React 1.0.2

    • Optional

    • Adds Node 22 and 24 support

  • Payment JS SDK 1.3.5

    • Recommended

    • Adds Node 22 and 24 support

    • Artifacts

      • @broadleaf/amazon-payment-services-api

      • @broadleaf/amazon-payment-services-react

      • @broadleaf/braintree-payment-services-api

      • @broadleaf/braintree-payment-services-react

      • @broadleaf/checkout-com-payment-services-api

      • @broadleaf/checkout-com-payment-services-react

      • @broadleaf/myfatoorah-payment-services-api

      • @broadleaf/myfatoorah-payment-services-react

      • @broadleaf/stripe-payment-services-api

      • @broadleaf/stripe-payment-services-react

      • @broadleaf/tabby-payment-services-api

      • @broadleaf/tabby-payment-services-react

      • @broadleaf/payment-js

      • @broadleaf/payment-react

      • @broadleaf/paypal-checkout-js

      • @broadleaf/paypal-checkout-react

  • Payment JS SDK 1.4.0

    • Optional

    • Drops Node 18 support

      • Minimum is Node 22

    • Artifacts

      • @broadleaf/adyen-payment-services-api 1.0.0 New

      • @broadleaf/adyen-payment-services-react 1.0.0 New

      • @broadleaf/amazon-payment-services-api

      • @broadleaf/amazon-payment-services-react

      • @broadleaf/braintree-payment-services-api

      • @broadleaf/braintree-payment-services-react

      • @broadleaf/checkout-com-payment-services-api

      • @broadleaf/checkout-com-payment-services-react

      • @broadleaf/myfatoorah-payment-services-api

      • @broadleaf/myfatoorah-payment-services-react

      • @broadleaf/stripe-payment-services-api

      • @broadleaf/stripe-payment-services-react

      • @broadleaf/tabby-payment-services-api

      • @broadleaf/tabby-payment-services-react

      • @broadleaf/payment-js

      • @broadleaf/payment-react

      • @broadleaf/paypal-checkout-js

      • @broadleaf/paypal-checkout-react

  • NextJS Starter 1.6.6

    • Recommended

    • URL: repository.broadleafcommerce.com:5001/broadleaf/commerce-nextjs-starter:1.6.6

    • Adds Node 22 and 24 support

  • NextJS Starter 2.0.0

    • Optional

    • URL: repository.broadleafcommerce.com:5001/broadleaf/commerce-nextjs-starter:2.0.0

    • Drops Node 18 and 20 support

      • Minimum is Node 22

  • Telco Starter 1.0.2

    • Recommended

    • URL: repository.broadleafcommerce.com:5001/broadleaf/telco-nextjs-starter:1.0.2

    • Adds Node 22 and 24 support

  • Telco Starter 1.1.0

    • Optional

    • URL: repository.broadleafcommerce.com:5001/broadleaf/telco-nextjs-starter:1.1.0

    • Drops Node 18 and 20 support

      • Minimum is Node 22

  • Open API 2.3.0

    • Important: Users are expected to build their own Open API image. This is present for reference only.

    • URL: repository.broadleafcommerce.com:5001/broadleaf/openapi-ui:2.3.0

    • Adds Node 22 and 24 support

    • Replaced Create React App with Vite

  • Admin Starter 1.11.7

    • Important: Users are expected to build their own Admin Starter image. This is present for reference only.

    • URL: repository.broadleafcommerce.com:5001/broadleaf/adminstarter:1.11.7

    • Adds Node 22 and 24 support

    • Uses Admin Web 1.10.13 libraries

    • Adds Node 22 and 24 support

Service-level Release Notes