Inject document factory soft delete config

Author: stevebauman

src/Factories/DocumentFactory.php

@@ -13,31 +13,63 @@
  */
 class DocumentFactory implements DocumentFactoryInterface
 {
+    /**
+     * Create a new document factory instance.
+     */
+    public function __construct(
+        protected bool $softDelete = false,
+    ) {}
+
     /**
      * Create OpenSearch documents from the given model collection.
      */
     public function makeFromModels(Collection $models): Collection
     {
         return $models->map(function (Model $model) {
-            if (
-                config('scout.soft_delete', false) &&
-                in_array(SoftDeletes::class, class_uses_recursive($model), true)
-            ) {
+            if ($this->softDelete && $this->isSoftDeletable($model)) {
                 $model->pushSoftDeleteMetadata();
             }
 
-            $documentId = (string) $model->getScoutKey();
-            $documentContent = array_merge($model->scoutMetadata(), $model->toSearchableArray());
+            $source = $this->makeDocumentSource($model);
 
-            if (array_key_exists('_id', $documentContent)) {
-                throw new UnexpectedValueException(sprintf(
-                    '_id is not allowed in the document content. Please, make sure the field is not returned by '.
-                    'the %1$s::toSearchableArray or %1$s::scoutMetadata methods.',
-                    class_basename($model)
-                ));
-            }
+            $this->assertValidDocumentSource($model, $source);
 
-            return new Document($documentId, $documentContent);
+            return new Document((string) $model->getScoutKey(), $source);
         });
     }
+
+    /**
+     * Assert that the given document source is valid.
+     *
+     * @throws \UnexpectedValueException
+     */
+    protected function assertValidDocumentSource(Model $model, array $source): void
+    {
+        if (array_key_exists('_id', $source)) {
+            throw new UnexpectedValueException(sprintf(
+                '_id is not allowed in the document source. Please, make sure the field is not returned by '.
+                'the %1$s::toSearchableArray or %1$s::scoutMetadata methods.',
+                class_basename($model)
+            ));
+        }
+    }
+
+    /**
+     * Create the document source from the given model.
+     */
+    protected function makeDocumentSource(Model $model): array
+    {
+        return array_merge(
+            $model->scoutMetadata(),
+            $model->toSearchableArray()
+        );
+    }
+
+    /**
+     * Determine if the given model uses soft deletes.
+     */
+    protected function isSoftDeletable(Model $model): bool
+    {
+        return in_array(SoftDeletes::class, class_uses_recursive($model), true);
+    }
 }

src/OpenSearchScoutServiceProvider.php

@@ -30,9 +30,12 @@ public function register(): void
         $this->mergeConfigFrom(__DIR__.'/../config/opensearch-scout.php', 'opensearch-scout');
 
         $this->app->bind(ModelFactoryInterface::class, ModelFactory::class);
-        $this->app->bind(DocumentFactoryInterface::class, DocumentFactory::class);
         $this->app->bind(SearchRequestFactoryInterface::class, SearchRequestFactory::class);
 
+        $this->app->bind(DocumentFactoryInterface::class, function (Application $app) {
+            return new DocumentFactory($app['config']->get('scout.soft_delete', false));
+        });
+
         $this->app->singleton(DocumentManagerInterface::class, function (Application $app) {
             return new DocumentManager($app->make(OpenSearchManager::class)->default());
         });

src/SearchRequestPayload.php

@@ -99,7 +99,7 @@ public function toArray(): array
             'from' => $this->from,
             'size' => $this->size,
             'aggregations' => $this->aggregations,
-        ], fn (mixed $value) => blank($value) === false);
+        ], fn (mixed $value) => filled($value));
     }
 
     /**

tests/Integration/OpenSearchScoutDriverTest.php

@@ -81,7 +81,7 @@
 it('indexes and filters soft deleted models when scout soft deletes are enabled', function (): void {
     config()->set('scout.soft_delete', true);
 
-    $engine = app(EngineManager::class)->engine('opensearch');
+    $engine = app(EngineManager::class)->forgetDrivers()->engine('opensearch');
 
     Client::query()->whereKey(3)->delete();
 

tests/Unit/Factories/DocumentFactoryTest.php

@@ -19,6 +19,20 @@
         ->and($documents->first()->source())->toBe(['name' => 'John', 'email' => 'john@example.com']);
 });
 
+it('creates documents with soft delete metadata when enabled', function () {
+    $model = new Client(['id' => 1, 'name' => 'John']);
+
+    $model->deleted_at = now();
+
+    $document = (new DocumentFactory(softDelete: true))->makeFromModels(new Collection([$model]))->first();
+
+    expect($document->source())->toBe([
+        '__soft_deleted' => 1,
+        'name' => 'John',
+        'email' => 'john@example.com',
+    ]);
+});
+
 it('rejects restricted document fields', function () {
     $model = new class extends Client
     {