Use a distinct collection names for each test using atlas search indexes

Author: GromNaN

docs/includes/fundamentals/as-avs/AtlasSearchTest.php

@@ -8,6 +8,7 @@
 use Illuminate\Support\Facades\DB;
 use MongoDB\Builder\Query;
 use MongoDB\Builder\Search;
+use MongoDB\Collection;
 use MongoDB\Driver\Exception\ServerException;
 use MongoDB\Laravel\Schema\Builder;
 use MongoDB\Laravel\Tests\TestCase;
@@ -32,6 +33,7 @@ protected function setUp(): void
         parent::setUp();
 
         $moviesCollection = DB::connection('mongodb')->getCollection('movies');
+        self::assertInstanceOf(Collection::class, $moviesCollection);
         $moviesCollection->drop();
 
         Movie::insert([
@@ -49,7 +51,10 @@ protected function setUp(): void
             ['title' => 'D', 'plot' => 'Stranded on a distant planet, astronauts must repair their ship before supplies run out.'],
         ]));
 
-        $moviesCollection = DB::connection('mongodb')->getCollection('movies');
+        // Waits for the search index created in previous test to be deleted
+        do {
+            usleep(1_000);
+        } while ($moviesCollection->listSearchIndexes()->count());
 
         try {
             $moviesCollection->createSearchIndex([
@@ -87,9 +92,7 @@ protected function setUp(): void
             $ready = true;
             usleep(10_000);
             foreach ($moviesCollection->listSearchIndexes() as $index) {
-                if ($index['status'] !== 'READY') {
-                    $ready = false;
-                }
+                $ready = $ready && $index['queryable'];
             }
         } while (! $ready);
     }

tests/AtlasSearchTest.php

@@ -29,6 +29,10 @@ class AtlasSearchTest extends TestCase
 
     public function setUp(): void
     {
+        // Use a unique prefix per test to avoid collisions when the search index is
+        // deleted asynchronously while we try to create it in setup of the next test
+        $_SERVER['DB_PREFIX'] = 'AtlasSearchTest_' . $this->name() . '_';
+
         parent::setUp();
 
         Book::insert($this->addVector([
@@ -54,7 +58,7 @@ public function setUp(): void
             ['title' => 'Pattern Recognition and Machine Learning'],
         ]));
 
-        $collection = $this->getConnection('mongodb')->getCollection('books');
+        $collection = $this->getConnection('mongodb')->getCollection($this->getBookCollectionName());
         assert($collection instanceof MongoDBCollection);
 
         try {
@@ -92,25 +96,24 @@ public function setUp(): void
         // Wait for the index to be ready
         do {
             $ready = true;
-            usleep(10_000);
+            usleep(100);
             foreach ($collection->listSearchIndexes() as $index) {
-                if ($index['status'] !== 'READY') {
-                    $ready = false;
-                }
+                $ready = $ready && $index['queryable'];
             }
         } while (! $ready);
     }
 
     public function tearDown(): void
     {
-        $this->getConnection('mongodb')->getCollection('books')->drop();
+        $this->getConnection('mongodb')->getCollection($this->getBookCollectionName())->drop();
+        unset($_SERVER['DB_PREFIX']);
 
         parent::tearDown();
     }
 
     public function testGetIndexes()
     {
-        $indexes = Schema::getIndexes('books');
+        $indexes = Schema::getIndexes($this->getBookCollectionName());
 
         self::assertIsArray($indexes);
         self::assertCount(4, $indexes);
@@ -171,7 +174,7 @@ public function testEloquentBuilderSearch()
 
     public function testDatabaseBuilderSearch()
     {
-        $results = $this->getConnection('mongodb')->table('books')
+        $results = $this->getConnection('mongodb')->table($this->getBookCollectionName())
             ->search(Search::text('title', 'systems'), sort: ['title' => 1]);
 
         self::assertInstanceOf(LaravelCollection::class, $results);
@@ -199,7 +202,7 @@ public function testEloquentBuilderAutocomplete()
 
     public function testDatabaseBuilderAutocomplete()
     {
-        $results = $this->getConnection('mongodb')->table('books')
+        $results = $this->getConnection('mongodb')->table($this->getBookCollectionName())
             ->autocomplete('title', 'system');
 
         self::assertInstanceOf(LaravelCollection::class, $results);
@@ -213,7 +216,7 @@ public function testDatabaseBuilderAutocomplete()
 
     public function testDatabaseBuilderVectorSearch()
     {
-        $results = $this->getConnection('mongodb')->table('books')
+        $results = $this->getConnection('mongodb')->table($this->getBookCollectionName())
             ->vectorSearch(
                 index: 'vector',
                 path: 'vector4',
@@ -253,6 +256,15 @@ public function testEloquentBuilderVectorSearch()
         );
     }
 
+    private function getBookCollectionName(): string
+    {
+        $name = (new Book())->getTable();
+
+        self::assertStringStartsWith('AtlasSearchTest_', $name);
+
+        return $name;
+    }
+
     /** Generate random vectors using fixed seed to make tests deterministic */
     private function addVector(array $items): array
     {

tests/Models/Book.php

@@ -23,6 +23,15 @@ class Book extends Model
     protected $table = 'books';
     protected static $unguarded = true;
 
+    public function __construct(array $attributes = [])
+    {
+        /* @TODO remove when connection prefix is supported
+         * @see https://jira.mongodb.org/browse/PHPORM-433 */
+        $this->table = ($_SERVER['DB_PREFIX'] ?? '') . $this->table;
+
+        parent::__construct($attributes);
+    }
+
     public function author(): BelongsTo
     {
         return $this->belongsTo(User::class, 'author_id');

tests/Scout/ScoutIntegrationTest.php

@@ -112,8 +112,9 @@ public function testItCanCreateTheCollection()
         self::assertSame(['mappings' => ['dynamic' => true, 'fields' => ['bool_field' => ['type' => 'boolean']]]], iterator_to_array($searchIndexes)[0]['latestDefinition']);
 
         // Wait for all documents to be indexed asynchronously
-        $i = 100;
+        $i = 1000;
         while (true) {
+            usleep(10_000);
             $indexedDocuments = $collection->aggregate([
                 ['$search' => ['index' => 'scout', 'exists' => ['path' => 'name']]],
             ])->toArray();
@@ -125,8 +126,6 @@ public function testItCanCreateTheCollection()
             if ($i-- === 0) {
                 self::fail('Documents not indexed');
             }
-
-            usleep(100_000);
         }
 
         self::assertCount(44, $indexedDocuments);
@@ -135,7 +134,7 @@ public function testItCanCreateTheCollection()
     #[Depends('testItCanCreateTheCollection')]
     public function testItCanUseBasicSearch()
     {
-        // All the search queries use "sort" option to ensure the results are deterministic
+        // All the search queries use the "sort" option to ensure the results are deterministic
         $results = ScoutUser::search('lar')->take(10)->orderBy('id')->get();
 
         self::assertSame([