Merge branch '10.x' into 11.x

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

Author: driesvints

.github/ISSUE_TEMPLATE/2_Feature_request.md

@@ -1,5 +1,8 @@
 blank_issues_enabled: false
 contact_links:
+  - name: Feature request
+    url: https://github.com/laravel/scout/pulls
+    about: 'For ideas or feature requests, send in a pull request'
   - name: Support Questions & Other
     url: https://laravel.com/docs/contributions#support-questions
     about: 'This repository is only for reporting bugs. If you have a question or need help using the library, click:'

.github/ISSUE_TEMPLATE/config.yml

@@ -15,7 +15,7 @@ If you discover a security vulnerability within Laravel, please send an email to
 ```
 -----BEGIN PGP PUBLIC KEY BLOCK-----
 Version: OpenPGP v2.0.8
-Comment: https://sela.io/pgp/
+Comment: Report Security Vulnerabilities to taylor@laravel.com
 
 xsFNBFugFSQBEACxEKhIY9IoJzcouVTIYKJfWFGvwFgbRjQWBiH3QdHId5vCrbWo
 s2l+4Rv03gMG+yHLJ3rWElnNdRaNdQv59+lShrZF7Bvu7Zvc0mMNmFOM/mQ/K2Lt

.github/SECURITY.md

@@ -7,9 +7,34 @@ on:
       - '*.x'
   pull_request:
 
-permissions:
-  contents: read
-
 jobs:
-  tests:
-    uses: laravel/.github/.github/workflows/static-analysis.yml@main
+  types:
+    runs-on: ubuntu-24.04
+
+    strategy:
+      fail-fast: true
+      matrix:
+        directory: [src, types]
+
+    name: ${{ matrix.directory == 'src' && 'Source Code' || 'Types' }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer:v2
+          coverage: none
+
+      - name: Install dependencies
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          command: composer update --prefer-stable --prefer-dist --no-interaction --no-progress
+
+      - name: Execute type checking
+        run: vendor/bin/phpstan --configuration="phpstan.${{ matrix.directory }}.neon.dist"

.github/workflows/static-analysis.yml

@@ -1,6 +1,30 @@
 # Release Notes
 
-## [Unreleased](https://github.com/laravel/scout/compare/v10.9.0...11.x)
+## [Unreleased](https://github.com/laravel/scout/compare/v10.11.2...11.x)
+
+## [v10.11.2](https://github.com/laravel/scout/compare/v10.11.1...v10.11.2) - 2024-09-03
+
+* [10.x] Add Generic Docblocks To Builder by [@Magnesium38](https://github.com/Magnesium38) in https://github.com/laravel/scout/pull/857
+
+## [v10.11.1](https://github.com/laravel/scout/compare/v10.11.0...v10.11.1) - 2024-08-06
+
+* refactor(typesense): remove unused exists checks by [@saibotk](https://github.com/saibotk) in https://github.com/laravel/scout/pull/847
+
+## [v10.11.0](https://github.com/laravel/scout/compare/v10.10.2...v10.11.0) - 2024-07-30
+
+* [10.x] Allow setting custom scout builder class by [@gdebrauwer](https://github.com/gdebrauwer) in https://github.com/laravel/scout/pull/852
+
+## [v10.10.2](https://github.com/laravel/scout/compare/v10.10.1...v10.10.2) - 2024-07-23
+
+* [Typesense]  Sync server state in getOrCreateCollectionFromModel #845 by [@tharropoulos](https://github.com/tharropoulos) in https://github.com/laravel/scout/pull/846
+
+## [v10.10.1](https://github.com/laravel/scout/compare/v10.10.0...v10.10.1) - 2024-07-02
+
+* [10.x] Get the key name through getScoutKeyName() on the Database engine by [@antonioribeiro](https://github.com/antonioribeiro) in https://github.com/laravel/scout/pull/843
+
+## [v10.10.0](https://github.com/laravel/scout/compare/v10.9.0...v10.10.0) - 2024-06-18
+
+* Added possibility to version indexes.  by [@Boorinio](https://github.com/Boorinio) in https://github.com/laravel/scout/pull/836
 
 ## [v10.9.0](https://github.com/laravel/scout/compare/v10.8.6...v10.9.0) - 2024-05-07
 

CHANGELOG.md

@@ -0,0 +1,4 @@
+parameters:
+    level: max
+    paths:
+        - types

phpstan.neon.dist renamed to phpstan.src.neon.dist

@@ -11,14 +11,17 @@
 use Laravel\Scout\Contracts\PaginatesEloquentModels;
 use Laravel\Scout\Contracts\PaginatesEloquentModelsUsingDatabase;
 
+/**
+ * @template TModel of \Illuminate\Database\Eloquent\Model
+ */
 class Builder
 {
     use Conditionable, Macroable, Tappable;
 
     /**
      * The model instance.
      *
-     * @var \Illuminate\Database\Eloquent\Model
+     * @var TModel
      */
     public $model;
 
@@ -95,7 +98,7 @@ class Builder
     /**
      * Create a new search builder instance.
      *
-     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @param  TModel  $model
      * @param  string  $query
      * @param  \Closure|null  $callback
      * @param  bool  $softDelete
@@ -300,7 +303,7 @@ public function keys()
     /**
      * Get the first result from the search.
      *
-     * @return \Illuminate\Database\Eloquent\Model
+     * @return TModel
      */
     public function first()
     {
@@ -310,7 +313,7 @@ public function first()
     /**
      * Get the results of the search.
      *
-     * @return \Illuminate\Database\Eloquent\Collection
+     * @return \Illuminate\Database\Eloquent\Collection<int, TModel>
      */
     public function get()
     {
@@ -320,7 +323,7 @@ public function get()
     /**
      * Get the results of the search as a "lazy collection" instance.
      *
-     * @return \Illuminate\Support\LazyCollection
+     * @return \Illuminate\Support\LazyCollection<int, TModel>
      */
     public function cursor()
     {

phpstan.types.neon.dist

@@ -92,7 +92,7 @@ public function paginateUsingDatabase(Builder $builder, $perPage, $pageName, $pa
                 }
             })
             ->when(! $this->getFullTextColumns($builder), function ($query) use ($builder) {
-                $query->orderBy($builder->model->getKeyName(), 'desc');
+                $query->orderBy($builder->model->getScoutKeyName(), 'desc');
             })
             ->paginate($perPage, ['*'], $pageName, $page);
     }
@@ -127,7 +127,7 @@ public function simplePaginateUsingDatabase(Builder $builder, $perPage, $pageNam
                 }
             })
             ->when(! $this->getFullTextColumns($builder), function ($query) use ($builder) {
-                $query->orderBy($builder->model->getKeyName(), 'desc');
+                $query->orderBy($builder->model->getScoutKeyName(), 'desc');
             })
             ->simplePaginate($perPage, ['*'], $pageName, $page);
     }
@@ -152,7 +152,7 @@ protected function searchModels(Builder $builder, $page = null, $perPage = null)
                 }
             })
             ->when(! $this->getFullTextColumns($builder), function ($query) use ($builder) {
-                $query->orderBy($builder->model->getKeyName(), 'desc');
+                $query->orderBy($builder->model->getScoutKeyName(), 'desc');
             })
             ->get();
     }
@@ -198,7 +198,7 @@ protected function initializeSearchQuery(Builder $builder, array $columns, array
             $canSearchPrimaryKey = ctype_digit($builder->query) &&
                                    in_array($builder->model->getKeyType(), ['int', 'integer']) &&
                                    ($connectionType != 'pgsql' || $builder->query <= PHP_INT_MAX) &&
-                                   in_array($builder->model->getKeyName(), $columns);
+                                   in_array($builder->model->getScoutKeyName(), $columns);
 
             if ($canSearchPrimaryKey) {
                 $query->orWhere($builder->model->getQualifiedKeyName(), $builder->query);
@@ -214,7 +214,7 @@ protected function initializeSearchQuery(Builder $builder, array $columns, array
                         $this->getFullTextOptions($builder)
                     );
                 } else {
-                    if ($canSearchPrimaryKey && $column === $builder->model->getKeyName()) {
+                    if ($canSearchPrimaryKey && $column === $builder->model->getScoutKeyName()) {
                         continue;
                     }
 

src/Builder.php

@@ -498,10 +498,19 @@ protected function getOrCreateCollectionFromModel($model, bool $indexOperation =
     {
         $method = $indexOperation ? 'indexableAs' : 'searchableAs';
 
-        $collection = $this->typesense->getCollections()->{$model->{$method}()};
+        $collectionName = $model->{$method}();
+        $collection = $this->typesense->getCollections()->{$collectionName};
+
+        // Determine if the collection exists in Typesense...
+        try {
+            $collection->retrieve();
+
+            // No error means this collection exists on the server...
+            $collection->setExists(true);
 
-        if ($collection->exists() === true) {
             return $collection;
+        } catch (TypesenseClientError $e) {
+            //
         }
 
         $schema = config('scout.typesense.model-settings.'.get_class($model).'.collection-schema') ?? [];

src/Engines/DatabaseEngine.php

@@ -114,11 +114,11 @@ public function searchIndexShouldBeUpdated()
      *
      * @param  string  $query
      * @param  \Closure  $callback
-     * @return \Laravel\Scout\Builder
+     * @return \Laravel\Scout\Builder<static>
      */
     public static function search($query = '', $callback = null)
     {
-        return app(Builder::class, [
+        return app(static::$scoutBuilder ?? Builder::class, [
             'model' => new static,
             'query' => $query,
             'callback' => $callback,

src/Engines/TypesenseEngine.php

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Scout\Builder;
+
+use function PHPStan\Testing\assertType;
+
+/** @param \Laravel\Scout\Builder<User> $builder */
+function test(
+    Builder $builder,
+): void {
+    assertType('Illuminate\Database\Eloquent\Collection<int, User>', $builder->get());
+    assertType('User', $builder->first());
+}
+
+class User extends Model
+{
+}

src/Searchable.php

@@ -0,0 +1,13 @@
+<?php
+
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Scout\Searchable;
+
+use function PHPStan\Testing\assertType;
+
+assertType('Laravel\Scout\Builder<Post>', Post::search());
+
+class Post extends Model
+{
+    use Searchable;
+}