August 2024 release notes

  • Updated

Release: 5.2.2408.1593+sts

Version 5.2.2408.1573+sts has been removed from the list of deployable versions, and the NuGet package has been removed from general availability. Optimizely identified a bug with a new cache key for PageByUrl. This version can return incorrect content on instances with multiple websites with the same URLs because the website key was not included in the cache key. Version 5.2.2408.1593+sts has replaced this version and includes a fix for the above problem. See Current short-term support hotfixes for information.

The following is a list of the bug fixes and enhancements in the August 2024 release. Some bug fixes listed below may address existing support articles. A comprehensive list is at the bottom of this page.

The August 2024 release is now available for developers to download and work with locally or to request deployments.

Release highlights

Breaking changes

Binary breaking changes do not necessarily require code changes but rather just a recompilation of the project. This section describes breaking changes to method signatures or to method behaviors in Optimizely Configured Commerce.

Low risk

  • Implemented DOMPurify and removed the property HtmlBodyOnly from PropertyDefinitionDto.
  • Upgraded fast-xml-parser for Dependabot by removing mobius-styleguide from the Spire modules. This was a tool for Optimizely developers and partners that is no longer used.
  • Added new overload for ICookieManager.Add method for CKFinder.
  • Fixed an issue where Product V2 routing parameters were ignored: Added Guid productId and Guid variantChildId parameters with priority over [FromUri] parameter. Only ProductsV2Controller.cs was changed.
  • Changed method signatures for ProductPrintPdfService to use EmailService as an argument. This resolves issues related to threading in the .NET 8.0.

Partners/Developers: At the bottom of this page, you can view a cumulative list of breaking changes, including Spire breaking changes. The spreadsheet has two tabs: one for cumulative breaking changes and one for Spire breaking changes.

Database changes and updates

  • The attribute retrieval phase of the GetProductData procedure used by Product V2 now reconsiders its query plan with each call, improving performance consistency for product lists that vary in size. Example: 8-item product list pages and 500-item carts.

Library changes and updates

No significant changes.

Enhancements and bug fixes

Spire enhancements

Other enhancements

  • Updated all WCF errors to show in the application logs.
  • Improved security for SVG file uploads by validating for XSS threats.
  • Improved performance of the content/pagebyurl API.
  • Added EmailService stability improvements.
  • Added a pipeline for the GetQualifyingPromotions method of PromotionsEngine.

Bug fixes

  • Fixed an issue where SX.e jobs did not automatically generate when you enabled the SX.e integration setting inside the admin panel.
  • Fixed an issue in Spire where the Paymetric credit card month field did not translate.
  • Fixed an unhandled error in Spire when you checked out with a credit card and entered invalid data.
  • Fixed an issue in Spire where disabling the option to Show Tax & Shipping Amount in Cart was not supported.
  • Fixed an issue where enabling Log Product Search Queries in Elasticsearch replaced the spaces in the query with empty strings, changing the search query terms.
  • Fixed an issue in Spire where TokenEx did not display an error message when the payment session timed out during checkout.
  • Fixed an issue in Spire where an unhandled error was displayed instead of an error message from an invalid cartId.
  • Fixed a "Could not get type for System.Collections.Generic.ICollection" warning that appeared in Spire.
  • Fixed an issue in Spire where the credit card security code field was not required with Paymetric.
  • Fixed an issue where calling api/v2/products/{ProductId}/relatedproducts did not work with a required parameter.
  • Fixed an issue in Spire where the pop-up did not display until you went to another page after clicking Add to list.
  • Fixed an issue in Spire where the Vertex tax calculation did not work with promotions of type Set Product Price.
  • Fixed a click-tracking error in Spire.
  • Fixed an issue in VMI for Spire where the Order Notes field and Filters retained your previous search, even when browsing pages.
  • Fixed an issue in Spire where the cart was wiped when the approver selected or created an address from the checkout page.
  • Fixed issues in Spire when you customized the Recent Order widget.
  • Fixed an issue in Spire where the attribute types category search failed to return results.
  • Fixed an issue in Spire where the item list in Order History disappeared after you refreshed the page.
  • Fixed an issue in Classic where you could not order a product marked as discontinued when it was in a saved order.
  • Fixed an issue where a custom recurring job ran multiple times on the wrong date and time.
  • Fixed an issue where the Order Submit job failed when processing orders with promotions with restricted website access.
  • Fixed issues in Spire with the Format Based on Language localization option.
  • Fixed an issue where the currency code was missing from the authorization sent to Paymetric when you saved a payment profile.

Related Support Articles

Configured Commerce REST APIs

Cumulative breaking changes spreadsheet