Fix tests and use distinct model classes

Author: GromNaN

src/Scout/ScoutEngine.php

@@ -487,21 +487,6 @@ private function usesSoftDelete(Model|EloquentCollection $model): bool
         return in_array(SoftDeletes::class, class_uses_recursive($model));
     }
 
-    private function getMapping(Model $model): array
-    {
-        $mapping = self::DEFAULT_DEFINITION;
-
-        if ($this->usesSoftDelete($model)) {
-            // This field is a boolean represented with the integers 0 and 1
-            // https://www.mongodb.com/docs/atlas/atlas-search/field-types/number-type/#configure-fts-field-type-field-properties
-            $mapping['fields']['__soft_deleted'] ??= [
-                'type' => 'boolean',
-            ];
-        }
-
-        return $mapping;
-    }
-
     /**
      * Wait for the callback to return true, use it for asynchronous
      * Atlas Search index management operations.

tests/Models/SqlUser.php

@@ -11,7 +11,6 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Schema\SQLiteBuilder;
 use Illuminate\Support\Facades\Schema;
-use Laravel\Scout\Searchable;
 use MongoDB\Laravel\Eloquent\HybridRelations;
 use MongoDB\Laravel\Relations\MorphToMany;
 
@@ -20,7 +19,6 @@
 class SqlUser extends EloquentModel
 {
     use HybridRelations;
-    use Searchable;
 
     protected $connection = 'sqlite';
     protected $table = 'users';
@@ -56,14 +54,6 @@ public function experiences(): MorphToMany
         return $this->morphedByMany(Experience::class, 'experienced');
     }
 
-    public function toSearchableArray()
-    {
-        return [
-            'email' => $this->email,
-            'name' => $this->name,
-        ];
-    }
-
     /**
      * Check if we need to run the schema.
      */
@@ -76,10 +66,6 @@ public static function executeSchema(): void
         $schema->create('users', function (Blueprint $table) {
             $table->increments('id');
             $table->string('name');
-            $table->string('email')->nullable();
-            $table->date('email_verified_at')->nullable();
-            $table->string('password')->nullable();
-            $table->string('remember_token')->nullable();
             $table->timestamps();
         });
 

tests/Models/User.php

@@ -14,7 +14,6 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Notifications\Notifiable;
 use Illuminate\Support\Str;
-use Laravel\Scout\Searchable;
 use MongoDB\Laravel\Eloquent\Builder;
 use MongoDB\Laravel\Eloquent\DocumentModel;
 use MongoDB\Laravel\Eloquent\MassPrunable;
@@ -38,7 +37,6 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     use CanResetPassword;
     use Notifiable;
     use MassPrunable;
-    use Searchable;
 
     protected $keyType = 'string';
     protected $connection = 'mongodb';
@@ -141,17 +139,4 @@ public function prunable(): Builder
     {
         return $this->where('age', '>', 18);
     }
-
-    public function getScoutKey(): string
-    {
-        return (string) $this->getKey();
-    }
-
-    public function toSearchableArray(): array
-    {
-        return [
-            'id' => $this->id,
-            'name' => $this->name,
-        ];
-    }
 }

tests/Scout/Models/ScoutUser.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Tests\Scout\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Schema\SQLiteBuilder;
+use Illuminate\Support\Facades\Schema;
+use Laravel\Scout\Searchable;
+use MongoDB\Laravel\Eloquent\SoftDeletes;
+
+use function assert;
+
+class ScoutUser extends Model
+{
+    use Searchable;
+    use SoftDeletes;
+
+    protected $connection       = 'sqlite';
+    protected $table            = 'scout_users';
+    protected static $unguarded = true;
+
+    public function searchableAs(): string
+    {
+        return 'mongodb_scout_users';
+    }
+
+    /**
+     * Check if we need to run the schema.
+     */
+    public static function executeSchema(): void
+    {
+        $schema = Schema::connection('sqlite');
+        assert($schema instanceof SQLiteBuilder);
+
+        $schema->dropIfExists('scout_users');
+        $schema->create('scout_users', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('name');
+            $table->string('email')->nullable();
+            $table->date('email_verified_at')->nullable();
+            $table->timestamps();
+            $table->softDeletes();
+        });
+    }
+}

tests/Models/SearchableInSameNamespace.php renamed to tests/Scout/Models/SearchableInSameNamespace.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace MongoDB\Laravel\Tests\Models;
+namespace MongoDB\Laravel\Tests\Scout\Models;
 
 use Illuminate\Database\Eloquent\Model;
 use Laravel\Scout\Searchable;

tests/Models/SearchableModel.php renamed to tests/Scout/Models/SearchableModel.php

@@ -1,30 +1,27 @@
 <?php
 
-declare(strict_types=1);
-
-namespace MongoDB\Laravel\Tests\Models;
+namespace MongoDB\Laravel\Tests\Scout\Models;
 
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
 use Laravel\Scout\Searchable;
-use MongoDB\Laravel\Eloquent\Model;
-use MongoDB\Laravel\Eloquent\SoftDeletes;
 
 class SearchableModel extends Model
 {
     use Searchable;
     use SoftDeletes;
 
-    protected $connection       = 'sqlite';
-    protected $table            = 'searchable';
-    protected static $unguarded = true;
+    protected $connection = 'sqlite';
+    protected $fillable = ['id', 'name', 'date'];
 
     public function searchableAs(): string
     {
-        return 'table_searchable';
+        return 'collection_searchable';
     }
 
     public function indexableAs(): string
     {
-        return 'table_indexable';
+        return 'collection_indexable';
     }
 
     /**

tests/Scout/ScoutEngineTest.php

@@ -8,30 +8,26 @@
 use Illuminate\Support\Collection as IlluminateCollection;
 use Laravel\Scout\Builder;
 use Laravel\Scout\Jobs\RemoveFromSearch;
-use LogicException;
 use Mockery as m;
 use MongoDB\BSON\Document;
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Collection;
 use MongoDB\Database;
 use MongoDB\Driver\CursorInterface;
 use MongoDB\Laravel\Scout\ScoutEngine;
-use MongoDB\Laravel\Tests\Models\SearchableInSameNamespace;
-use MongoDB\Laravel\Tests\Models\SearchableModel;
+use MongoDB\Laravel\Tests\Scout\Models\SearchableModel;
 use MongoDB\Laravel\Tests\TestCase;
 use MongoDB\Model\BSONDocument;
 use PHPUnit\Framework\Attributes\DataProvider;
 
 use function array_replace_recursive;
-use function env;
 use function serialize;
-use function sprintf;
 use function unserialize;
 
 /** Unit tests that do not require an Atlas Search cluster */
 class ScoutEngineTest extends TestCase
 {
-    private const EXPECTED_SEARCH_OPTIONS = ['typeMap' => ['root' => 'object', 'document' => 'array', 'array' => 'array']];
+    private const EXPECTED_SEARCH_OPTIONS = ['typeMap' => ['root' => 'array', 'document' => 'array', 'array' => 'array']];
 
     /** @param callable(): Builder $builder  */
     #[DataProvider('provideSearchPipelines')]
@@ -41,7 +37,7 @@ public function testSearch(Closure $builder, array $expectedPipeline): void
         $database = m::mock(Database::class);
         $collection = m::mock(Collection::class);
         $database->shouldReceive('selectCollection')
-            ->with('table_searchable')
+            ->with('collection_searchable')
             ->andReturn($collection);
         $cursor = m::mock(CursorInterface::class);
         $cursor->shouldReceive('toArray')->once()->with()->andReturn($data);
@@ -337,7 +333,7 @@ public function testPaginate()
         $collection = m::mock(Collection::class);
         $cursor = m::mock(CursorInterface::class);
         $database->shouldReceive('selectCollection')
-            ->with('table_searchable')
+            ->with('collection_searchable')
             ->andReturn($collection);
         $collection->shouldReceive('aggregate')
             ->once()
@@ -451,7 +447,7 @@ public function testUpdate(): void
         $database = m::mock(Database::class);
         $collection = m::mock(Collection::class);
         $database->shouldReceive('selectCollection')
-            ->with('table_indexable')
+            ->with('collection_indexable')
             ->andReturn($collection);
         $collection->shouldReceive('bulkWrite')
             ->once()
@@ -490,7 +486,7 @@ public function testUpdateWithSoftDelete(): void
         $database = m::mock(Database::class);
         $collection = m::mock(Collection::class);
         $database->shouldReceive('selectCollection')
-            ->with('table_indexable')
+            ->with('collection_indexable')
             ->andReturn($collection);
         $collection->shouldReceive('bulkWrite')
             ->once()
@@ -516,7 +512,7 @@ public function testDelete(): void
         $database = m::mock(Database::class);
         $collection = m::mock(Collection::class);
         $database->shouldReceive('selectCollection')
-            ->with('table_indexable')
+            ->with('collection_indexable')
             ->andReturn($collection);
         $collection->shouldReceive('deleteMany')
             ->once()
@@ -540,7 +536,7 @@ public function testDeleteWithRemoveableScoutCollection(): void
         $database = m::mock(Database::class);
         $collection = m::mock(Collection::class);
         $database->shouldReceive('selectCollection')
-            ->with('table_indexable')
+            ->with('collection_indexable')
             ->andReturn($collection);
         $collection->shouldReceive('deleteMany')
             ->once()
@@ -549,16 +545,4 @@ public function testDeleteWithRemoveableScoutCollection(): void
         $engine = new ScoutEngine($database, softDelete: false, prefix: 'ignored_prefix_');
         $engine->delete($job->models);
     }
-
-    public function testItCannotIndexInTheSameNamespace()
-    {
-        self::expectException(LogicException::class);
-        self::expectExceptionMessage(sprintf(
-            'The MongoDB Scout collection "%s.searchable_in_same_namespaces" must use a different collection from the collection name of the model "%s". Set the "scout.prefix" configuration or use a distinct MongoDB database',
-            env('MONGODB_DATABASE', 'unittest'),
-            SearchableInSameNamespace::class,
-        ),);
-
-        SearchableInSameNamespace::create(['name' => 'test']);
-    }
 }