👁 Image
Ucommerce.Extensions.Search.Abstractions 10.12.13

Ucommerce.Extensions.Search.Abstractions

The Ucommerce.Extensions.Search.Abstractions project is a foundational library for Ucommerce's search and indexing system. It provides core interfaces, base classes, and shared models that abstract the search architecture, enabling developers to implement custom search providers or extend existing functionality without being tied to a specific implementation like ElasticSearch.

This abstraction layer ensures flexibility and modularity, making it easier to integrate alternative search backends or customize the indexing pipeline.

Key Features

1. Provider-Agnostic Search Queries

• Interfaces and base classes for building search queries that are independent of the underlying search provider.
• Enables seamless swapping of search backends (e.g., ElasticSearch, Azure Search).

2. Indexing Pipeline

• Abstracts the process of indexing entities (e.g., products, prices) with support for batching, error handling, and extensibility.
• Simplifies the creation of custom indexing providers.

3. Extensibility

• Built with extensibility in mind. Developers can inherit from base classes or implement interfaces to add custom logic.
• Ideal for integrating new search backends or extending the existing indexing pipeline.

4. Shared Models

• Provides reusable models that are used throughout the search and indexing system, ensuring consistency and reducing duplication.

When to Use

You should use this project if you are:

• Extending Ucommerce's indexing pipeline to meet specific business requirements.
• Integrating a custom search backend (e.g., Azure Search, Solr).
• Building custom search queries or modifying the default search behavior.

Setup

To use Ucommerce.Extensions.Search.Abstractions in your project, follow these steps:

1. Add the Package

Reference the Ucommerce.Extensions.Search.Abstractions package in your project.

2. Register Search Services

During application startup, register the search services using the following code:

builder.Services
 .AddUcommerce(builder.Configuration)
 .AddSearch();

Common Bug Locations

• : Issues with provider-agnostic search queries might involve incorrect query construction or missing support for specific filters.
• : Bugs in the indexing pipeline might involve failure to index certain entities, performance bottlenecks, or incorrect error handling.
• Extensibility Points: If custom logic is not working as expected, the issue might be in how interfaces or base classes are extended.