Merge branch '10.x'

# Conflicts:
#	CHANGELOG.md
#	src/EngineManager.php

Author: driesvints

.github/workflows/tests.yml

@@ -11,26 +11,24 @@ on:
 
 jobs:
   tests:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     strategy:
       fail-fast: true
       matrix:
-        php: [7.3, 7.4, '8.0', 8.1, 8.2]
-        laravel: [8, 9]
+        php: ['8.0', 8.1, 8.2]
+        laravel: [9, 10]
         exclude:
-          - php: 7.3
+          - php: '8.0'
             laravel: 9
-          - php: 7.4
-            laravel: 9
-          - php: 8.2
-            laravel: 8
+          - php: '8.0'
+            laravel: 10
 
     name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

CHANGELOG.md

@@ -1,6 +1,52 @@
 # Release Notes
 
-## [Unreleased](https://github.com/laravel/scout/compare/v9.5.1...master)
+## [Unreleased](https://github.com/laravel/scout/compare/v9.8.0...master)
+
+## [v9.8.0](https://github.com/laravel/scout/compare/v9.7.2...v9.8.0) - 2023-01-17
+
+### Added
+
+- Laravel v10 Support by @driesvints in https://github.com/laravel/scout/pull/696
+- Enable order by for `collection` & `database` engines by @stein-j in https://github.com/laravel/scout/pull/695
+
+## [v9.7.2](https://github.com/laravel/scout/compare/v9.7.1...v9.7.2) - 2023-01-09
+
+### Fixed
+
+- Handle non-consecutive key collection on MeiliSearch document deletion by @pyrou in https://github.com/laravel/scout/pull/688
+- Fix missing variable in closure by @driesvints in https://github.com/laravel/scout/pull/694
+
+## [v9.7.1](https://github.com/laravel/scout/compare/v9.7.0...v9.7.1) - 2023-01-06
+
+### Fixed
+
+- Make scout compatible with new meilisearch casing by @mmachatschek in https://github.com/laravel/scout/pull/687
+
+## [v9.7.0](https://github.com/laravel/scout/compare/v9.6.2...v9.7.0) - 2023-01-03
+
+### Changed
+
+- Add analytics for Meilisearch engine by @mmachatschek in https://github.com/laravel/scout/pull/681
+- Allow options for search requests by @driesvints in https://github.com/laravel/scout/pull/683
+
+## [v9.6.2](https://github.com/laravel/scout/compare/v9.6.1...v9.6.2) - 2022-12-21
+
+### Fixed
+
+- Added a missing import by @driesvints in https://github.com/laravel/scout/commit/56adabcc1575a692824ffa8009719b20e7778f28
+
+## [v9.6.1](https://github.com/laravel/scout/compare/v9.6.0...v9.6.1) - 2022-12-20
+
+### Changed
+
+- Allow FQCN to delete-index command by @kichetof in https://github.com/laravel/scout/pull/677
+
+## [v9.6.0](https://github.com/laravel/scout/compare/v9.5.1...v9.6.0) - 2022-12-15
+
+### Added
+
+- Add command delete-all-indexes, update scout:index to allow FQCN and apply filterable on SoftDeletes by @kichetof in https://github.com/laravel/scout/pull/671
+- Added soft deleted to Meilisearch by @kichetof in https://github.com/laravel/scout/pull/672
 
 ## [v9.5.1](https://github.com/laravel/scout/compare/v9.5.0...v9.5.1) - 2022-12-08
 

RELEASE.md

@@ -1,4 +1,4 @@
 # Release Instructions
 
-1. Update the version in [`EngineManager.php`](./src/EngineManager.php) and commit it
+1. Update the version in [`Scout.php`](./src/Scout.php) and commit it
 2. Create a new GitHub release for this version with the release notes

UPGRADE.md

@@ -1,5 +1,34 @@
 # Upgrade Guide
 
+## Upgrading To 10.0 From 9.x
+
+### Minimum Versions
+
+The following dependency versions have been updated:
+
+- The minimum PHP version is now v8.0
+- The minimum Laravel version is now v9.0
+
+### The `getScoutKeyName` Method
+
+PR: https://github.com/laravel/scout/pull/509
+
+In Scout 10.x, the `getScoutKeyName` method will return the unqualified key name and no longer qualifies the key name with the table name. If you are overriding the `getScoutKeyName` method you will need to account for this change and make sure you return an unqualified key name.
+
+```diff
+public function getScoutKeyName()
+{
+-    return 'posts.id';
++    return 'id';
+}
+```
+
+### Removal Of `getUnqualifiedScoutKeyName`
+
+PR: https://github.com/laravel/scout/pull/657
+
+Due to the `getScoutKeyName` change discussed above, the `getUnqualifiedScoutKeyName` method was removed as it is no longer necessary.
+
 ## Upgrading To 9.0 From 8.x
 
 ### Minimum Laravel Version

composer.json

@@ -14,19 +14,20 @@
         }
     ],
     "require": {
-        "php": "^7.3|^8.0",
-        "illuminate/bus": "^8.0|^9.0",
-        "illuminate/contracts": "^8.0|^9.0",
-        "illuminate/database": "^8.0|^9.0",
-        "illuminate/http": "^8.0|^9.0",
-        "illuminate/pagination": "^8.0|^9.0",
-        "illuminate/queue": "^8.0|^9.0",
-        "illuminate/support": "^8.0|^9.0"
+        "php": "^8.0",
+        "illuminate/bus": "^9.0|^10.0",
+        "illuminate/contracts": "^9.0|^10.0",
+        "illuminate/database": "^9.0|^10.0",
+        "illuminate/http": "^9.0|^10.0",
+        "illuminate/pagination": "^9.0|^10.0",
+        "illuminate/queue": "^9.0|^10.0",
+        "illuminate/support": "^9.0|^10.0"
     },
     "require-dev": {
-        "meilisearch/meilisearch-php": "^0.19",
+        "meilisearch/meilisearch-php": "^0.23",
         "mockery/mockery": "^1.0",
-        "orchestra/testbench": "^6.17|^7.0",
+        "php-http/guzzle7-adapter": "^1.0",
+        "orchestra/testbench": "^7.0|^8.0",
         "phpunit/phpunit": "^9.3"
     },
     "autoload": {
@@ -54,7 +55,10 @@
         "meilisearch/meilisearch-php": "Required to use the MeiliSearch engine (^0.23)."
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
     },
     "minimum-stability": "dev",
     "prefer-stable": true

src/Builder.php

@@ -75,6 +75,13 @@ class Builder
      */
     public $orders = [];
 
+    /**
+     * Extra options that should be applied to the search.
+     *
+     * @var int
+     */
+    public $options = [];
+
     /**
      * Create a new search builder instance.
      *
@@ -190,6 +197,19 @@ public function orderBy($column, $direction = 'asc')
         return $this;
     }
 
+    /**
+     * Set extra options for the search query.
+     *
+     * @param  array  $options
+     * @return $this
+     */
+    public function options(array $options)
+    {
+        $this->options = $options;
+
+        return $this;
+    }
+
     /**
      * Apply the callback's query changes if the given "value" is true.
      *

src/Console/DeleteIndexCommand.php

@@ -4,6 +4,7 @@
 
 use Exception;
 use Illuminate\Console\Command;
+use Illuminate\Support\Str;
 use Laravel\Scout\EngineManager;
 
 class DeleteIndexCommand extends Command
@@ -31,11 +32,28 @@ class DeleteIndexCommand extends Command
     public function handle(EngineManager $manager)
     {
         try {
-            $manager->engine()->deleteIndex($this->argument('name'));
+            $manager->engine()->deleteIndex($name = $this->indexName($this->argument('name')));
 
-            $this->info('Index "'.$this->argument('name').'" deleted.');
+            $this->info('Index "'.$name.'" deleted.');
         } catch (Exception $exception) {
             $this->error($exception->getMessage());
         }
     }
+
+    /**
+     * Get the fully-qualified index name for the given index.
+     *
+     * @param  string  $name
+     * @return string
+     */
+    protected function indexName($name)
+    {
+        if (class_exists($name)) {
+            return (new $name)->searchableAs();
+        }
+
+        $prefix = config('scout.prefix');
+
+        return ! Str::startsWith($name, $prefix) ? $prefix.$name : $name;
+    }
 }

src/EngineManager.php

@@ -36,7 +36,7 @@ public function createAlgoliaDriver()
     {
         $this->ensureAlgoliaClientIsInstalled();
 
-        UserAgent::addCustomUserAgent('Laravel Scout', '11.0.0-dev');
+        UserAgent::addCustomUserAgent('Laravel Scout', Scout::VERSION);
 
         $config = SearchConfig::create(
             config('scout.algolia.id'),
@@ -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)
         );
     }
@@ -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;
         }
 

src/Engines/AlgoliaEngine.php

@@ -140,6 +140,8 @@ protected function performSearch(Builder $builder, array $options = [])
             $builder->index ?: $builder->model->searchableAs()
         );
 
+        $options = array_merge($builder->options, $options);
+
         if ($builder->callback) {
             return call_user_func(
                 $builder->callback,

src/Engines/CollectionEngine.php

@@ -100,9 +100,13 @@ protected function searchModels(Builder $builder)
                                 $query->whereIn($key, $values);
                             }
                         })
-                        ->orderBy(
-                            $builder->model->qualifyColumn($builder->model->getScoutKeyName()), 'desc'
-                        );
+                        ->when($builder->orders, function ($query) use ($builder) {
+                            foreach ($builder->orders as $order) {
+                                $query->orderBy($order['column'], $order['direction']);
+                            }
+                        }, function ($query) use ($builder) {
+                            $query->orderBy($builder->model->qualifyColumn($builder->model->getScoutKeyName()), 'desc');
+                        });
 
         $models = $this->ensureSoftDeletesAreHandled($builder, $query)
                         ->get()

src/Engines/DatabaseEngine.php

@@ -72,6 +72,11 @@ public function search(Builder $builder)
     public function paginate(Builder $builder, $perPage, $page)
     {
         return $this->buildSearchQuery($builder)
+                ->when($builder->orders, function ($query) use ($builder) {
+                    foreach ($builder->orders as $order) {
+                        $query->orderBy($order['column'], $order['direction']);
+                    }
+                })
                 ->when(! $this->getFullTextColumns($builder), function ($query) use ($builder) {
                     $query->orderBy($builder->model->getKeyName(), 'desc');
                 })
@@ -89,6 +94,11 @@ public function paginate(Builder $builder, $perPage, $page)
     public function simplePaginate(Builder $builder, $perPage, $page)
     {
         return $this->buildSearchQuery($builder)
+                ->when($builder->orders, function ($query) use ($builder) {
+                    foreach ($builder->orders as $order) {
+                        $query->orderBy($order['column'], $order['direction']);
+                    }
+                })
                 ->when(! $this->getFullTextColumns($builder), function ($query) use ($builder) {
                     $query->orderBy($builder->model->getKeyName(), 'desc');
                 })
@@ -109,6 +119,11 @@ protected function searchModels(Builder $builder, $page = null, $perPage = null)
             ->when(! is_null($page) && ! is_null($perPage), function ($query) use ($page, $perPage) {
                 $query->forPage($page, $perPage);
             })
+            ->when($builder->orders, function ($query) use ($builder) {
+                foreach ($builder->orders as $order) {
+                    $query->orderBy($order['column'], $order['direction']);
+                }
+            })
             ->when(! $this->getFullTextColumns($builder), function ($query) use ($builder) {
                 $query->orderBy($builder->model->getKeyName(), 'desc');
             })
@@ -125,7 +140,7 @@ protected function buildSearchQuery(Builder $builder)
     {
         $query = $this->initializeSearchQuery(
             $builder,
-            $columns = array_keys($builder->model->toSearchableArray()),
+            array_keys($builder->model->toSearchableArray()),
             $this->getPrefixColumns($builder),
             $this->getFullTextColumns($builder)
         );
@@ -216,8 +231,8 @@ protected function addAdditionalConstraints(Builder $builder, $query)
      * Ensure that soft delete constraints are properly applied to the query.
      *
      * @param  \Laravel\Scout\Builder  $builder
-     * @param  \Illuminate\Database\Query\Builder  $query
-     * @return \Illuminate\Database\Query\Builder
+     * @param  \Illuminate\Database\Eloquent\Builder  $query
+     * @return \Illuminate\Database\Eloquent\Builder
      */
     protected function constrainForSoftDeletes($builder, $query)
     {