Rename setting and refactor

Author: GromNaN

lib/Doctrine/ODM/MongoDB/Aggregation/Aggregation.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\ODM\MongoDB\Aggregation;
 
+use Doctrine\ODM\MongoDB\Configuration;
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Iterator\CachingIterator;
 use Doctrine\ODM\MongoDB\Iterator\HydratingIterator;
@@ -15,8 +16,10 @@
 use MongoDB\Collection;
 use MongoDB\Driver\CursorInterface;
 
-use function array_key_first;
 use function array_merge;
+use function current;
+use function in_array;
+use function key;
 
 /** @phpstan-import-type PipelineExpression from Builder */
 final class Aggregation implements IterableResult
@@ -68,7 +71,7 @@ private function prepareIterator(CursorInterface $cursor): Iterator
 
         $iterator = $this->rewindable ? new CachingIterator($cursor) : new UnrewindableIterator($cursor);
 
-        $this->assertSearchIndexExistsWhenAggregationResultsIsEmpty($iterator);
+        $this->assertSearchIndexExistsForEmptyResult($iterator);
 
         return $iterator;
     }
@@ -78,32 +81,30 @@ private function prepareIterator(CursorInterface $cursor): Iterator
      * this assertion can be removed.
      *
      * @see https://jira.mongodb.org/browse/SERVER-110974
+     * @see Configuration::setAssertSearchIndexExistsForEmptyResult()
      *
-     * @param Iterator<object> $iterator
+     * @param CachingIterator<mixed>|UnrewindableIterator<mixed> $iterator
      */
-    private function assertSearchIndexExistsWhenAggregationResultsIsEmpty(Iterator $iterator): void
+    private function assertSearchIndexExistsForEmptyResult(CachingIterator|UnrewindableIterator $iterator): void
     {
-        if ($iterator->current() !== false) {
+        // The iterator is always rewinded
+        if ($iterator->current()) {
             return; // Results not empty
         }
 
-        if (! $this->dm->getConfiguration()->assertSearchIndexExistsWhenAggregationResultsIsEmpty()) {
+        if (! $this->dm->getConfiguration()->assertSearchIndexExistsForEmptyResult()) {
             return; // Feature disabled
         }
 
         // Search stages must be the first stage in the pipeline
-        $indexName = match (array_key_first($this->pipeline[0])) {
-            '$search' => $this->pipeline[0]['$search']->index ?? null,
-            '$searchMeta' => $this->pipeline[0]['$searchMeta']->index ?? null,
-            '$vectorSearch' => $this->pipeline[0]['$vectorSearch']->index ?? null,
-            default => null,
-        };
-
-        if ($indexName === null) {
-            return; // Not a search aggregation or index not specified
+        $stage = $this->pipeline[0] ?? null;
+        if (! $stage || ! in_array(key($stage), ['$search', '$searchMeta', '$vectorSearch'], true)) {
+            return; // Not a search aggregation
         }
 
-        $index = $this->collection->listSearchIndexes(['filter' => ['name' => $indexName]])->current();
+        // @phpcs:ignore SlevomatCodingStandard.PHP.UselessParentheses
+        $indexName = ((object) current($stage))->index ?? 'default';
+        $index     = $this->collection->listSearchIndexes(['filter' => ['name' => $indexName]])->current();
         if ($index) {
             return; // Index exists
         }

lib/Doctrine/ODM/MongoDB/Configuration.php

@@ -812,18 +812,19 @@ private function getAutoEncryptionOptions(): array
     /**
      * Pipelines using a search index that does not exist or is not queryable
      * will return zero documents. By enabling this feature, an additional query
-     * is made when the pipeline doesn't return any results to check if the
-     * search index exists and is queryable. If the index does not exist or is
-     * not queryable, an exception is thrown. This feature is enabled by default.
+     * is performed when the pipeline doesn't return any results to check if the
+     * search index exists. If the index does not exist, an exception is thrown.
+     * This feature is enabled by default.
+     * This applies to $search, $searchMeta and $vectorSearch pipelines.
      */
-    public function setAssertSearchIndexExistsWhenAggregationResultsIsEmpty(bool $enabled): void
+    public function setAssertSearchIndexExistsForEmptyResult(bool $enabled): void
     {
-        $this->attributes['assertSearchIndexExistsWhenAggregationResultsIsEmpty'] = $enabled;
+        $this->attributes['assertSearchIndexExistsForEmptyResult'] = $enabled;
     }
 
-    public function assertSearchIndexExistsWhenAggregationResultsIsEmpty(): bool
+    public function assertSearchIndexExistsForEmptyResult(): bool
     {
-        return $this->attributes['assertSearchIndexExistsWhenAggregationResultsIsEmpty'] ?? true;
+        return $this->attributes['assertSearchIndexExistsForEmptyResult'] ?? true;
     }
 }
 

tests/Doctrine/ODM/MongoDB/Tests/Functional/AtlasSearchTest.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\ODM\MongoDB\Tests\Functional;
 
+use Doctrine\ODM\MongoDB\Aggregation\Stage;
 use Doctrine\ODM\MongoDB\SchemaException;
 use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
 use Documents\CmsArticle;
@@ -55,7 +56,6 @@ public function testAtlasSearch(): void
         $schemaManager->waitForSearchIndexes([CmsArticle::class, CmsUser::class]);
 
         $results = $this->dm->createAggregationBuilder(CmsArticle::class)
-            ->rewindable(false)
             ->search()
                 ->index('search_articles')
                 ->autocomplete()
@@ -137,7 +137,7 @@ public function testIndexNotCreated(): void
 
     public function testIndexNotCreatedWithoutException(): void
     {
-        $this->dm->getConfiguration()->setAssertSearchIndexExistsWhenAggregationResultsIsEmpty(false);
+        $this->dm->getConfiguration()->setAssertSearchIndexExistsForEmptyResult(false);
 
         $results = $this->dm->createAggregationBuilder(CmsArticle::class)
             ->search()
@@ -149,4 +149,20 @@ public function testIndexNotCreatedWithoutException(): void
 
         $this->assertCount(0, $results->toArray());
     }
+
+    public function testIndexNotCreatedWithCustomStage(): void
+    {
+        $aggregation = ($builder = $this->dm->createAggregationBuilder(CmsArticle::class))
+            ->addStage(new class ($builder) extends Stage {
+                public function getExpression(): array
+                {
+                    return ['$search' => ['text' => ['query' => 'Atlas Search', 'path' => 'text']]];
+                }
+            })->getAggregation();
+
+        $this->expectException(SchemaException::class);
+        $this->expectExceptionMessageMatches('#^The search index "default" of the collection "[^."]+\.CmsArticle" is not found\.$#');
+
+        $aggregation->execute();
+    }
 }