Add newScoutQuery() for Database Engine (#923)

* Add newScoutQuery() for Database Engine

* Provide ScoutBuilder for scout query builder

* Format

Author: colq2

src/Engines/DatabaseEngine.php

@@ -188,11 +188,15 @@ protected function buildSearchQuery(Builder $builder)
      */
     protected function initializeSearchQuery(Builder $builder, array $columns, array $prefixColumns = [], array $fullTextColumns = [])
     {
+        $query = method_exists($builder->model, 'newScoutQuery')
+            ? $builder->model->newScoutQuery($builder)
+            : $builder->model->newQuery();
+
         if (blank($builder->query)) {
-            return $builder->model->newQuery();
+            return $query;
         }
 
-        return $builder->model->newQuery()->where(function ($query) use ($builder, $columns, $prefixColumns, $fullTextColumns) {
+        return $query->where(function ($query) use ($builder, $columns, $prefixColumns, $fullTextColumns) {
             $connectionType = $builder->model->getConnection()->getDriverName();
 
             $canSearchPrimaryKey = ctype_digit($builder->query) &&

tests/Feature/DatabaseEngineTest.php

@@ -7,7 +7,10 @@
 use Orchestra\Testbench\Concerns\WithLaravelMigrations;
 use Orchestra\Testbench\Concerns\WithWorkbench;
 use Orchestra\Testbench\TestCase;
+use Workbench\App\Models\Bookmark;
 use Workbench\App\Models\SearchableUser;
+use Workbench\Database\Factories\BookmarkFactory;
+use Workbench\Database\Factories\ChirpFactory;
 use Workbench\Database\Factories\SearchableUserFactory;
 
 class DatabaseEngineTest extends TestCase
@@ -186,4 +189,19 @@ public function test_it_can_order_results()
         $this->assertCount(1, $modelsSimplePaginate);
         $this->assertEquals('Taylor Otwell', $modelsSimplePaginate[0]->name);
     }
+
+    public function test_it_uses_scout_query()
+    {
+        // create bookmarks with chirp_id
+        BookmarkFactory::new()
+            ->for(ChirpFactory::new()->create(['content' => 'This chirp is searchable']))
+            ->create([
+                'label' => 'laravel',
+            ]);
+
+        $models = Bookmark::search('chirp')->get();
+        $this->assertCount(1, $models);
+        $this->assertEquals('laravel', $models[0]->label);
+        $this->assertEquals('This chirp is searchable', $models[0]->chirp->content);
+    }
 }

workbench/app/Models/Bookmark.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Workbench\App\Models;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Laravel\Scout\Searchable;
+
+class Bookmark extends Model
+{
+    use HasFactory;
+    use Searchable;
+
+    public function chirp(): BelongsTo
+    {
+        return $this->belongsTo(Chirp::class);
+    }
+
+    public function newScoutQuery(): Builder
+    {
+        return $this->newQuery()->join('chirps', 'chirps.id', '=', 'bookmarks.chirp_id');
+    }
+
+    public function toSearchableArray()
+    {
+        if (isset($_ENV['bookmark.toSearchableArray'])) {
+            return value($_ENV['bookmark.toSearchableArray'], $this);
+        }
+
+        return [
+            'label' => $this->label,
+            'chirps.content' => '',
+        ];
+    }
+}

workbench/database/factories/BookmarkFactory.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Workbench\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Workbench\App\Models\Bookmark;
+
+/**
+ * @template TModel of \Workbench\App\Models\Bookmark
+ *
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
+ */
+class BookmarkFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var class-string<TModel>
+     */
+    protected $model = Bookmark::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'chirp_id' => ChirpFactory::new(),
+            'label' => fake()->word(),
+        ];
+    }
+}

workbench/database/migrations/2025_05_13_092928_create_bookmarks_table.php

@@ -0,0 +1,29 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('bookmarks', function (Blueprint $table) {
+            $table->id();
+            $table->foreignId('chirp_id');
+            $table->string('label');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('bookmarks');
+    }
+};