Commerce Search v3 extensions

3 min

Prerequisites

See how to enable Commerce Search v3.

Custom extensions

To add custom extensions to RunProductSearch shared search pipelines, add extension pipes for both Elasticsearch v7 and Google Retail Search using the DependencySystemSetting attribute. See the following example for guidance.

To upgrade from Commerce Search v2 to Commerce Search v3 with existing extensions for Elasticsearch v7, update those custom extension pipes using the DependencySystemSetting attribute and replicate the pipes for both Elasticsearch v7 and Google Retail Search. See the following example for guidance.

When you extend a shared search pipeline for Elasticsearch v7 or Google Retail Search, review the pipe order and add new custom pipes to fit through this pipeline.

You should update any Spire Blueprints to the latest release versions for the Product Listing page, search input, and autocomplete.

Example

namespace Extensions.Modules.Search.Shared.DocumentTypes.Product.Query.Pipelines.Pipes.FormProductFilter 
{ 
    using Insite.Core.Interfaces.Dependency; 
    using Insite.Search.GoogleCloudRetailSearch.DocumentTypes.Product; 
 
    [DependencySystemSetting("SearchGeneral", "SearchProviderName", "Elasticsearch v7")] 
    public sealed class FormIsDiscontinuedFilterElasticsearchV7 
        : IPipe<FormProductFilterParameter, FormProductFilterResult> 
    { 
        public int Order => 450; 
 
        public FormProductFilterResult Execute( 
            IUnitOfWork unitOfWork, 
            FormProductFilterParameter parameter, 
            FormProductFilterResult result 
        ) 
        { 
            var filterProperty = nameof(ElasticSearchProduct.IsDiscontinued) 
                .ToCamelCase(); 
 
            var isDiscontinuedFilter = parameter.SearchQueryBuilder.MakeFieldQuery( 
                filterProperty, 
                "false" 
            ); 
            result.AllFilters.Add(isDiscontinuedFilter); 
 
            return result; 
        } 
    } 
} 
 
namespace Extensions.Modules.Search.Shared.DocumentTypes.Product.Query.Pipelines.Pipes.FormProductFilter 
{ 
    using Insite.Core.Interfaces.Dependency; 
    using Insite.Search.GoogleCloudRetailSearch.DocumentTypes.Product; 
 
    [DependencySystemSetting("SearchGeneral", "SearchProviderName", "Google Retail Search")] 
    public sealed class FormIsDiscontinuedFilterGoogleRetailSearch 
        : IPipe<FormProductFilterParameter, FormProductFilterResult> 
    { 
        public int Order => 450; 
 
        public FormProductFilterResult Execute( 
            IUnitOfWork unitOfWork, 
            FormProductFilterParameter parameter, 
            FormProductFilterResult result 
        ) 
        { 
            var filterProperty = nameof(GoogleCloudRetailSearchProduct.IsDiscontinued) 
                .ToCamelCase(); 
 
            var isDiscontinuedFilter = parameter.SearchQueryBuilder.MakeFieldQuery( 
                filterProperty, 
                "false" 
            ); 
            result.AllFilters.Add(isDiscontinuedFilter); 
 
            return result; 
        } 
    } 
}

Rate limit handling

The Commerce Search Service enforces a rate limit of 300 requests per minute on the Search API and 1200 requests per minute on the Autocomplete API. When Commerce Search v3 is enabled and the service returns HTTP 429 Too Many Requests:

The Search API falls back to Elasticsearch until the rate limit resets. Results during the fallback window reflect the Elasticsearch index and may differ from Commerce Search v3 results.

The Autocomplete API returns an empty result set so shoppers use the search results page.

Commerce Search v3 writes a warning to the log when it triggers the fallback and throttles subsequent warnings to one entry per minute to prevent log flooding. The log entry identifies the API that hit the rate limit.