Download the PHP package loyaltycorp/search without Composer

Search

The goals of this search package are to provide common functionality that enables creating and maintaining Elasticsearch search indices for an application.

It is up to the application to provide implementations of the SearchHandlerInterface (for simple search indices that the package will ensure are created) and TransformableSearchHandlerInterface (for indices that will react to changes to entities in external systems and transform those entities into search documents to be indexed).

An example implementation of both is provided.

Overview

This package provides multiple parts to enable easy search.

• There are index management commands provided that allow for reindexing without destroying the previous indices.
• Command options that will only reindex when the index mappings have changed (not yet implemented PYMT-1690)
• The Lumen service provider will auto discover any services tagged with search_handler and will use those discovered handlers to create and manage indices in Elasticsearch.
• The Lumen bridge providers a listener that will react to any Doctrine entity changes through the use of EasyEntityChange.
• The search handler interfaces provide multiple options for implementation depending on the application requirements.

Theory of Operation

The primary and default implementation of this package sets up a listener that will react to any entity changes inside Doctrine and dispatch jobs for re-indexing those entities based on Search Handlers that are interested in specific changes.

Each application Search Handler will define an array of ChangeSubscription DTOs that describe the entities and relevant properties that should trigger the reindexing of a document.

The package will handle batching search updates into multiple jobs for handling, and pass a ObjectForChange DTO to the application Search Handler that describes an object that has changed - either the object was updated or deleted. It is then up to the Search Handler to return a DocumentAction DTO that describes what should happen to the Elasticsearch document.

Lifecycle - Index management

When an application is initially created or deployed, the indices must be created before the application writes to Elasticsearch. Elasticsearch will eagerly create indices which is a behavior we dont want- so before the application accepts requests a migration/search setup process must run.

Following an imaginary index transactions through the following process:

Lifecycle - reacting to Doctrine changes

This package listens for EntityChange events from the EasyEntityChange package. The EntityUpdateWorker converts these events into ObjectForChange DTOs that are then processed against the Search Handler subscriptions to find any intersections.

Once any intersections are found, the work is batched and dispatched as jobs for workers to process as required.

Example Search Handler

The below example is verbose, and contains code that would normally be placed inside an abstract search handler, to show the expectations of an implementation of the TransformableSearchHandlerInterface.

Example Entity Repository

Along with the search handler, there are a few methods that need to be implemented into the entity's repository. The package provides a SearchRepository trait that does the heavy lifting, but you still need to implement the interface and a few methods that proxy to the trait.