Convert __soft_deleted to bool, and return root documents as array (typeMap)

Author: GromNaN

src/Scout/ScoutEngine.php

@@ -20,8 +20,7 @@
 use MongoDB\Database;
 use MongoDB\Driver\Cursor;
 use MongoDB\Driver\CursorInterface;
-use MongoDB\Exception\Exception;
-use MongoDB\Exception\RuntimeException;
+use MongoDB\Exception\RuntimeException as MongoDBRuntimeException;
 use MongoDB\Laravel\Connection;
 use Traversable;
 use TypeError;
@@ -79,15 +78,14 @@ public function __construct(
      *
      * @param EloquentCollection $models
      *
-     * @throws Exception
+     * @throws MongoDBRuntimeException
      */
     public function update($models)
     {
         if ($models->isEmpty()) {
             return;
         }
 
-        $collection = $this->getIndexableCollection($models);
 
         if ($this->softDelete && $this->usesSoftDelete($models)) {
             $models->each->pushSoftDeleteMetadata();
@@ -101,12 +99,17 @@ public function update($models)
             if ($searchableData) {
                 unset($searchableData['_id']);
 
+                $searchableData = array_merge($searchableData, $model->scoutMetadata());
+                if (isset($searchableData['__soft_deleted'])) {
+                    $searchableData['__soft_deleted'] = (bool) $searchableData['__soft_deleted'];
+                }
+
                 $bulk[] = [
                     'updateOne' => [
                         ['_id' => $model->getScoutKey()],
                         [
                             '$setOnInsert' => ['_id' => $model->getScoutKey()],
-                            '$set' => array_merge($searchableData, $model->scoutMetadata()),
+                            '$set' => $searchableData,
                         ],
                         ['upsert' => true],
                     ],
@@ -115,7 +118,7 @@ public function update($models)
         }
 
         if ($bulk) {
-            $collection->bulkWrite($bulk);
+            $this->getIndexableCollection($models)->bulkWrite($bulk);
         }
     }
 
@@ -180,9 +183,9 @@ protected function performSearch(Builder $builder, ?int $offset = null): array
                 $builder->query,
                 $offset,
             );
-            assert($result instanceof CursorInterface || is_array($result), new LogicException(sprintf('The search builder closure must return an array or a MongoDB cursor, %s returned', get_debug_type($result))));
+            assert($result instanceof CursorInterface, new LogicException(sprintf('The search builder closure must return a MongoDB cursor, %s returned', get_debug_type($result))));
 
-            return $result instanceof CursorInterface ? $result->toArray() : $result;
+            return $result->toArray();
         }
 
         $compound = [
@@ -211,6 +214,10 @@ protected function performSearch(Builder $builder, ?int $offset = null): array
         // They don't contribute to the relevance score
         // https://www.mongodb.com/docs/atlas/atlas-search/compound/#options
         foreach ($builder->wheres as $field => $value) {
+            if ($field === '__soft_deleted') {
+                $value = (bool) $value;
+            }
+
             $compound['filter'][] = ['equals' => ['path' => $field, 'value' => $value]];
         }
 
@@ -253,8 +260,7 @@ protected function performSearch(Builder $builder, ?int $offset = null): array
         }
 
         $options = [
-            'allowDiskUse' => true,
-            'typeMap' => ['root' => 'object', 'document' => 'array', 'array' => 'array'],
+            'typeMap' => ['root' => 'array', 'document' => 'array', 'array' => 'array'],
         ];
 
         return $collection->aggregate($pipeline, $options)->toArray();
@@ -322,7 +328,7 @@ public function getTotalCount($results): int
             return 0;
         }
 
-        return $results[0]->__count;
+        return $results[0]['__count'];
     }
 
     /**
@@ -513,9 +519,7 @@ private function getMapping(Model $model): array
             // 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' => 'number',
-                'representation' => 'int64',
-                'indexDoubles' => false,
+                'type' => 'boolean',
             ];
         }
 
@@ -537,6 +541,6 @@ private function wait(Closure $callback): void
             sleep(1);
         }
 
-        throw new RuntimeException('Atlas search index operation time out');
+        throw new MongoDBRuntimeException('Atlas search index operation time out');
     }
 }

tests/Scout/ScoutEngineTest.php

@@ -33,7 +33,7 @@
 /** Unit tests that do not require an Atlas Search cluster */
 class ScoutEngineTest extends TestCase
 {
-    private const EXPECTED_SEARCH_OPTIONS = ['allowDiskUse' => true, 'typeMap' => ['root' => 'object', 'document' => 'array', 'array' => 'array']];
+    private const EXPECTED_SEARCH_OPTIONS = ['typeMap' => ['root' => 'object', 'document' => 'array', 'array' => 'array']];
 
     /** @param callable(): Builder $builder  */
     #[DataProvider('provideSearchPipelines')]