23.6.1

What's changed

Updates

• SiteGenesis frontend: userTokens are now set for Insight events

Fixes

• AlgoliaProductIndex_v2: don't send empty batches

23.6.0

Changelog

Updates

• Updated frontend libraries to their latest versions
• New Insights events implementation for SFRA:
  • add-to-cart events now contain additional data (price, quantity)
  • A new purchase event is now triggered from the Order-Confirm page. Algolia queryIDs tracking is done using the user's browser storage, when user gave their consent to be tracked
  • Events now use the userToken and authenticatedUserToken exposed by SFCC
• New Business Manager setting to enable or disable insights events, for SFRA and SG
• Improved Business Manager UI and validation

Bug fixes

• fullCatalogReindex was failing on the newer Algolia infra, when the job was triggered for the first time
• retry mechanism wasn't working as expected on newer Algolia infra: if a batch was containing a record to big to be indexed, the whole batch was ignored instead of removing the faulty record and retrying
• SG cartridge was missing the embedded Algolia frontend libraries

23.5.1

What's changed

Updates

• New job step parameter: failureThresholdPercentage (integer, default: 0): the maximum percentage of records allowed to have errors during indexing before marking the job in error. If indexingMethod is fullCatalogReindex, the temporary index isn't moved to production if the failure rate exceeds this threshold. For other methods, successfully imported records successfully are kept in the Algolia indices.

23.5.0

What's changed

Breaking changes

No breaking changes.
Due to the new v2 jobs functionally replacing the v1 jobs (see below), v1 jobs are now considered deprecated and will be removed from the cartridge at a later time.
Upgrading from an older version keeps the v1 jobs on the instance, but new installations no longer add them to the instance.
We strongly recommend upgrading to the v2 jobs in the grace period (see Migration Guide).

Updates

• v2 jobs: new set of faster, chunk-based, parallelized, fileless export jobs that index directly to Algolia Search APIs (instead of a legacy ingestion middleware) and can be used for multi-instance indexing
  • Introduced atomic reindexing: full catalog reindexing can now be performed with zero downtime
  • The new jobs have a new set of base attributes to be sent
  • Added new indexingMethod parameter with support for partial record updates on product and product delta export jobs
• Logging is now more verbose to help diagnose any issues
• Overhauled the Algolia BM module
• Overhauled and improved job monitoring / reporting on the BM module
• Exported records now contain a relative product page URL (useful for multi-instance indexing)
• Deprecated the Host Base URL, OCAPIClientID and OCAPIClientPassword site preferences and removed them from the Algolia BM module as they are no longer needed
• The Custom Fields site preference is now called Additional Product Attributes
• Multiple additional improvements and bug fixes

For more information see the Algolia Salesforce B2C documentation.

You can find the migration guide here.

For more information on multi-instance indexing, see here.

23.4.1

What's changed

Updates

• Fixed an issue that prevented search results from being shown in certain situations (#51)
• Improvements to AlgoliaProductsDeltaExport, AlgoliaProductPricesExport and AlgoliaProductInventoryExport (#52)
  • The jobs now only index variants. Products can be further filtered with productFilter.js
  • AlgoliaProductsDeltaExport: changes made to variation masters now propagate to the variants for inherited values
  • Changed default chunk size for AlgoliaProductPricesExport and AlgoliaProductInventoryExport from 100 to 500 to improve performance.

23.4.0

What's changed

Breaking Changes

• the way in_stock is calculated was changed (true if ATS >= Algolia_InStockThreshold) (#46, #48)

Updates

• new export jobs utilizing B2C Delta Exports (for incremental product data changes) and parallelized execution (for lightweight price and inventory data changes) to reduce index update times and overhead (#34, #36, #47)

23.3.0

What's changed

Breaking Changes

No breaking changes.

Updates

• added Server-Side Rendering (SSR) to improve SEO (#32)
• index prefix is now configurable in BM (#29)
• user tracking improvements + refactored analytics via Automatic Insights (#30, #31)
• updated Algolia libraries (#31)

Fixes

• various small fixes (#35, #38, #42)

23.2.0

What's Changed

Breaking Changes

• upgraded search-insights library to v2 (#17)
  • serach-insights v2 introduces a breaking change: the default value for useCookie is now false by default which means that search-insights will no longer generate anonymous userTokens by default -- you have to call setUserToken() explicitly in order to send events for unregistered customers or set useCookie back to true after asking for consent;
  • attempting to send events with useCookie set to false without having set a user token with setUserToken() will result in HTTP 422 errors in the Algolia Events Debugger -- for more info see here and here.

Updates

• recommended Node version is now v18 (minimum version is v14) (#14)
• upgraded algoliasearch library from v3 to v4 (#16)
• initialized the InstantSearch Insights middleware in order to provide more data points for analytics (#17)
• implemented facet bucketing for refinementSize based on the previous refinementColor (#18)
  • meta data added for the Product SO's refinementColor and refinementSize custom attributes
• analytics events are now tracked when a search result is accessed from Autocomplete (#24)
  • adding a product to the Cart on the PDP is now tracked when coming from an Autocomplete result
  • new event "Clicked on autocomplete product" added when clicking on an Autocomplete result
• SEO: category name is now populated server-side (#22)
• OCAPI credentials (custom site preferences Algolia_OCAPIClientID and Algolia_OCAPIClientPassword) are now optional (#20)
• Polyfill removed as IE11 has become deprecated (#14)
• folder structure for JS files overhauled (#14)

Fixes

• some category landing pages may not have displayed any products on load due to a typecasting error, this is now fixed (#19)
• fixed existence check when trying to access custom attributes that had not been defined in BM previously (#18)

Cleanup

• Algolia libraries are now committed to the library instead of pulling them in from a CDN (#14)
• miscellaneous minor formatting and typo fixes

Full Changelog: 23.1.0...23.2.0

23.1.0

Original release