December 2024 release

  • Updated

Release: 5.2.2412.1504+sts

The following is a list of the release's bug fixes and enhancements. Some bug fixes may address existing support articles. A comprehensive list is at the bottom of this page.

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

Release highlights

  • Web Core Vitals: Reduce JS Time - The JavaScript execution time has been reduced by splitting and loading the react-calendar and its dependencies dynamically (removed from the main public.js bundle).

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 method behaviors in Optimizely Configured Commerce.

Low risk

  • Made the shipTo parameter optional in the CheckoutShipping/SetInitialValues.ts and OnePageCheckout/SetInitialValues.ts handlers.
  • Removed the following const strings in the public surface area. They were not used in extensions code.
    • PaymentSettings.PaymentAuthenticationNotSupported
    • PaymentSettings.AdyenDropInNotSupported
    • PaymentSettings.RetrievalNotSupported
    • PaymentSettings.RemovalNotSupported
    • PaymentSettings.StoringNotSupported
    • PaymentSettings.SubmittingNotSupported
    • PaymentSettings.RetrievingPaymentDetailsNotSupported
  • Removed and renamed some ODP code in the public surface area. This code was not used in any extensions projects.
    • Removed ObjectExtensions.GetDefaultCloneUsingJsonSettings().
    • Removed ObjectExtensions.With(JsonSerializerSettings, configuration).
    • Removed ContextKey.VisitorIdKey.
    • Renamed IOdpService to IOdpUpdatedEntityEventService.
    • Removed OdpActionTypes.
    • Renamed IOdpServiceManager to ITransactionCompletedEventProcessor.
    • Removed ISiteContext.VisitorId.
    • Removed SiteContextDto.VisitorId.
  • Replaced GemBox.Spreadsheet with Sylvan.Data.Excel – ISpreadsheetService interface was changed. ExcelFile was replaced with DataTable. The GetPropertyValue method was removed.
  • Moved StorageProvider to the Options pattern.
    • StorageProviderOptions replaces StorageProviderSettings. StorageProviderSettings.Name was split into StorageProviderOptions.UserFilesName and SystemName.
    • IUserFilesStorageProvider/StorageProviderOptions.UserFilesName is used for files that are accessible through the website, such as product images.
    • ISystemStorageProvider/StorageProviderOptions.SystemName is used for internal files, such as integration job datasets.
    • If injected, IStorageProvider will be IUserFilesStorageProvider.

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

No significant changes.

Library changes and updates

No significant changes.

Enhancements

Spire enhancements

  • Reduced the JavaScript execution time by splitting and loading the react-calendar and its dependencies dynamically (removed from the main public.js bundle).

Other enhancements 

  • Added templates to import variant types and variant traits.
  • Added a Google Geocoder API Key setting to define the API key used for Google's Geocoder provider.
  • Added a warning message in the application log during application startup if any disabled indexes are present in the database.
  • Updated the default customer field to accept a BillTo-only customer.
  • Updated Paymetric Gateway to use Worldpay.com domains to replace Paymetric.com domains that will be deprecated on March 31, 2025.

Bug fixes

  • Fixed harmless warning logs for insite.admin.formbuilder.forms.*-wizard.json.
  • Fixed an issue where the Customer_After_Insert trigger set the wrong ParentId.
  • Fixed an issue where the Spreedly 3DS callback failed after user renaming.
  • Fixed an unhandled error in Spire when no product was found with the In Stock filter.
  • Fixed an issue in Spire where the number in Find Location changed when you selected Pick Up.
  • Fixed an issue where a user was redirected to the My Account page instead of the Home page when logging in on a slow network.
  • Removed a redundant PromotionProductDiscountTotal recalculation in the Admin Console for Cart History.
  • Fixed an issue where Generate Brand Images did not generate image records for parent categories.
  • Fixed an issue where the PickUp Location modal closed abruptly when you scrolled up or down on the mobile view.
  • Mitigated thread safety issues of real-time inventory objects.
  • Fixed an issue where the cookie buttons became invisible in the mobile browser when the cookie message exceeded three lines.
  • Fixed an issue where product images overlapped with the product title when printing a list label with the 3-column layout.
  • Fixed an issue in Spire where Compare Content did not work for the Product Details page.
  • Resolved an issue where logs were not written correctly to Elasticsearch.
  • Fixed an issue where the generated PDF attachment when you shared an order by email did not display the correct product details link.
  • Fixed an issue where changing the Lookup Error Handling field value did not affect the logs.

Related Support Articles

None.

Configured Commerce REST APIs

Cumulative breaking changes spreadsheet