Rewrite query builder to support all missing methods

[guestpectacular]

Rewrite query builder to support all missing methods

I have performed a complete internal rewrite of the where method in the Laravel/Scout package to natively support Laravel query builder methods. This allows for more flexible queries that support AND, OR, and combined multiple scopes using closures.

Current state supporting only AND operator:

// Search through users where age = 38 AND where name = 'Edgar'
User::search('Pimienta')->where('age', 38)->where('name', 'Edgar')->get();

If we need to implement a filter using OR:

User::search($this->search, function ($engine, $query, $options) {
   $options['filter'] = "age = 38 OR name = 'Edgar'";
   return $meilisearch->search($query, $options);
})->get()

What about more custom filters?

$ids	=	[1,2,3];
User::search("Pimienta", function ($engine, $query, $options) use ($ids) {
   $options['filter'] = "(age = 38 OR name = 'Edgar') OR id NOT IN [" . implode(', ', $ids) . "]";
   return $meilisearch->search($query, $options);
})->get()

The code starts to feel bloated and difficult to maintain. With this contribution, it is now possible to filter between age = 38 OR name = 'Edgar' using a cleaner syntax:

User::search('Pimienta')->where(function ($query) {
    $query->where('age', 38)->orWhere('name', 'Edgar');
})->get();

The enhanced query builder also supports custom filters, making it easier to create complex queries. For example, filtering based on age, name, and a list of excluded IDs can be accomplished as follows:

$ids = [1, 2, 3];
User::search('Pimienta')->where(function ($query) use ($ids) {
    $query->where(function ($query) {
        $query->where('age', 38)->orWhere('name', 'Edgar');
    })->orWhereNotIn('id', $ids);
})->get();

I have ported missing functions from Illuminate\Database\Query\Builder into Laravel\Scout\Builder. These include where, orWhere, whereIn, orWhereIn, whereNotIn, orWhereNotIn, whereExists, orWhereExists, whereNotExists, whereBetween, whereNull, orWhereNull, whereNotNull, whereIsEmpty, orWhereIsEmpty, whereIsNotEmpty, enabling us to practically use the same functionality as with Eloquent models.

I'm currently working on extending this functionality to support Algolia. Until this transition is complete, I've added a helper method enableMeilisearchNewQueryBuilder that allows users to enable the new query builder features:

Model::enableMeilisearchNewQueryBuilder()->whereIn('id', 3);

Benefits:

• This enhancement significantly improves the query building capabilities of Laravel Scout, making it more powerful and user-friendly.
• Developers can now create more complex and expressive search queries using a familiar Laravel syntax.
• The contribution makes it easier to work with Elasticsearch and seamlessly integrates with Laravel's query builder.

I'm actively working on extending this functionality to support Algolia, which will complete the transition to using this new query builder across different search engines. Further discussions and collaboration on this are welcome.

Please review and provide feedback on this pull request. Your input is greatly appreciated.

Thank you for your time and consideration.

[driesvints]

Thanks. Can you please:

• Undo all unrelated styling changes
• Fix the tests

Then afterwards mark as ready for review.

[guestpectacular]

Hi @driesvints, I need guidance on how to detect the current search engine used at runtime directly from the package, rather than relying on Laravel to enable a smoother transition between versions once the Algolia engine it's finished, any help or pointers would be greatly appreciated!

[taylorotwell]

The point of Scout is not to provide a 1-to-1 match with the query builder - it is simply to provide a common set of search primitives. This will become a leaky abstraction.

[guestpectacular]

Roger that.

Do you have any tip to help me detect the current search engine used at runtime directly from the package itself?