Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[9.x] Make scout compatible with new meilisearch casing #687

Merged
merged 2 commits into from
Jan 5, 2023
Merged

[9.x] Make scout compatible with new meilisearch casing #687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc1e5bd
Make scout compatible with new meilisearch casing
mmachatschek Jan 5, 2023
408f300
fix style issues
mmachatschek Jan 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/EngineManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,11 @@ public function createMeilisearchDriver()
$this->ensureMeiliSearchClientIsInstalled();

return new MeiliSearchEngine(
$this->container->make(MeiliSearch::class),
$this->container->make(
class_exists(MeiliSearch::class)
? MeiliSearch::class
: \Meilisearch\Client::class
),
config('scout.soft_delete', false)
);
}
Expand All @@ -130,7 +134,7 @@ public function createMeilisearchDriver()
*/
protected function ensureMeiliSearchClientIsInstalled()
{
if (class_exists(MeiliSearch::class)) {
if (class_exists(MeiliSearch::class) || class_exists(\Meilisearch\Client::class)) {
return;
}

Expand Down
27 changes: 17 additions & 10 deletions src/Engines/MeiliSearchEngine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
use Illuminate\Support\LazyCollection;
use Laravel\Scout\Builder;
use Laravel\Scout\Jobs\RemoveableScoutCollection;
use MeiliSearch\Client as MeiliSearchClient;
use MeiliSearch\MeiliSearch;
use MeiliSearch\Search\SearchResult;

Expand All @@ -14,7 +13,7 @@ class MeiliSearchEngine extends Engine
/**
* The MeiliSearch client.
*
* @var \MeiliSearch\Client
* @var \MeiliSearch\Client|\Meilisearch\Client
*/
protected $meilisearch;

Expand All @@ -28,11 +27,11 @@ class MeiliSearchEngine extends Engine
/**
* Create a new MeiliSearchEngine instance.
*
* @param \MeiliSearch\Client $meilisearch
* @param \MeiliSearch\Client|\Meilisearch\Client $meilisearch
* @param bool $softDelete
* @return void
*/
public function __construct(MeiliSearchClient $meilisearch, $softDelete = false)
public function __construct($meilisearch, $softDelete = false)
{
$this->meilisearch = $meilisearch;
$this->softDelete = $softDelete;
Expand All @@ -44,7 +43,7 @@ public function __construct(MeiliSearchClient $meilisearch, $softDelete = false)
* @param \Illuminate\Database\Eloquent\Collection $models
* @return void
*
* @throws \MeiliSearch\Exceptions\ApiException
* @throws \MeiliSearch\Exceptions\ApiException|\Meilisearch\Exceptions\ApiException
*/
public function update($models)
{
Expand Down Expand Up @@ -138,8 +137,12 @@ protected function performSearch(Builder $builder, array $searchParams = [])
{
$meilisearch = $this->meilisearch->index($builder->index ?: $builder->model->searchableAs());

$meilisearchVersionClassName = class_exists(MeiliSearch::class)
? MeiliSearch::class
: \Meilisearch\Meilisearch::class;

// meilisearch-php 0.19.0 is compatible with meilisearch server 0.21.0...
if (version_compare(MeiliSearch::VERSION, '0.19.0') >= 0 && isset($searchParams['filters'])) {
if (version_compare($meilisearchVersionClassName::VERSION, '0.19.0') >= 0 && isset($searchParams['filters'])) {
$searchParams['filter'] = $searchParams['filters'];

unset($searchParams['filters']);
Expand All @@ -155,7 +158,11 @@ protected function performSearch(Builder $builder, array $searchParams = [])
$searchParams
);

return $result instanceof SearchResult ? $result->getRaw() : $result;
$searchResultClass = class_exists(SearchResult::class)
? SearchResult::class
: \Meilisearch\Search\SearchResult;

return $result instanceof $searchResultClass ? $result->getRaw() : $result;
}

return $meilisearch->rawSearch($builder->query, $searchParams);
Expand Down Expand Up @@ -339,7 +346,7 @@ public function flush($model)
* @param array $options
* @return mixed
*
* @throws \MeiliSearch\Exceptions\ApiException
* @throws \MeiliSearch\Exceptions\ApiException|\Meilisearch\Exceptions\ApiException
*/
public function createIndex($name, array $options = [])
{
Expand All @@ -353,7 +360,7 @@ public function createIndex($name, array $options = [])
* @param array $options
* @return array
*
* @throws \MeiliSearch\Exceptions\ApiException
* @throws \MeiliSearch\Exceptions\ApiException|\Meilisearch\Exceptions\ApiException
*/
public function updateIndexSettings($name, array $options = [])
{
Expand All @@ -366,7 +373,7 @@ public function updateIndexSettings($name, array $options = [])
* @param string $name
* @return mixed
*
* @throws \MeiliSearch\Exceptions\ApiException
* @throws \MeiliSearch\Exceptions\ApiException|\Meilisearch\Exceptions\ApiException
*/
public function deleteIndex($name)
{
Expand Down
14 changes: 10 additions & 4 deletions src/ScoutServiceProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,17 @@ public function register()
{
$this->mergeConfigFrom(__DIR__.'/../config/scout.php', 'scout');

if (class_exists(MeiliSearchClient::class)) {
$this->app->singleton(MeiliSearchClient::class, function ($app) {
if (class_exists(MeiliSearchClient::class) || class_exists(\Meilisearch\Client::class)) {
$meilisearchClientClassName = class_exists(MeiliSearchClient::class)
? MeiliSearchClient::class
: \Meilisearch\Client::class;
$this->app->singleton($meilisearchClientClassName, function ($app) {
$config = $app['config']->get('scout.meilisearch');

if (version_compare(MeiliSearch::VERSION, '0.24.2') >= 0) {
$meilisearchVersionClassName = class_exists(MeiliSearch::class)
? MeiliSearch::class
: \Meilisearch\Meilisearch::class;
if (version_compare($meilisearchVersionClassName::VERSION, '0.24.2') >= 0) {
return new MeiliSearchClient(
$config['host'],
$config['key'],
Expand All @@ -37,7 +43,7 @@ public function register()
);
}

return new MeiliSearchClient($config['host'], $config['key']);
return new $meilisearchClientClassName($config['host'], $config['key']);
});
}

Expand Down