Prepare Scout driver for release

Author: stevebauman

composer.json

@@ -28,27 +28,16 @@
     },
     "require": {
         "php": "^8.2",
-        "directorytree/opensearch-adapter": "dev-master",
-        "directorytree/opensearch-client": "dev-master",
+        "directorytree/opensearch-adapter": "^1.0",
+        "directorytree/opensearch-client": "^1.0",
         "laravel/scout": "^10.0|^11.0|^12.0|^13.0"
     },
     "require-dev": {
         "laravel/framework": "^11.0|^12.0|^13.0",
         "laravel/pint": "^1.0",
-        "mockery/mockery": "^1.0",
         "orchestra/testbench": "^9.0|^10.0|^11.0",
         "pestphp/pest": "^3.0"
     },
-    "repositories": [
-        {
-            "type": "path",
-            "url": "../OpenSearchAdapter"
-        },
-        {
-            "type": "path",
-            "url": "../OpenSearchClient"
-        }
-    ],
     "config": {
         "allow-plugins": {
             "php-http/discovery": true,

src/Engine.php

@@ -2,9 +2,9 @@
 
 namespace DirectoryTree\OpenSearchScoutDriver;
 
-use DirectoryTree\OpenSearchAdapter\Documents\DocumentManager;
+use DirectoryTree\OpenSearchAdapter\Documents\DocumentManagerInterface;
 use DirectoryTree\OpenSearchAdapter\Indices\IndexBlueprint;
-use DirectoryTree\OpenSearchAdapter\Indices\IndexManager;
+use DirectoryTree\OpenSearchAdapter\Indices\IndexManagerInterface;
 use DirectoryTree\OpenSearchAdapter\Search\Hit;
 use DirectoryTree\OpenSearchAdapter\Search\SearchResponse;
 use DirectoryTree\OpenSearchScoutDriver\Factories\DocumentFactoryInterface;
@@ -28,15 +28,13 @@ class Engine extends ScoutEngine
      * Create a new OpenSearch Scout engine instance.
      */
     public function __construct(
-        protected DocumentManager $documentManager,
+        protected ModelFactoryInterface $modelFactory,
+        protected IndexManagerInterface $indexManager,
+        protected DocumentManagerInterface $documentManager,
         protected DocumentFactoryInterface $documentFactory,
         protected SearchRequestFactoryInterface $searchRequestFactory,
-        protected ModelFactoryInterface $modelFactory,
-        protected IndexManager $indexManager,
         protected bool $refreshDocuments = false,
-    ) {
-        $this->refreshDocuments = (bool) config('opensearch-scout.refresh_documents', $refreshDocuments);
-    }
+    ) {}
 
     /**
      * Update the given models in the index.
@@ -48,6 +46,7 @@ public function update($models): void
         }
 
         $index = $models->first()->searchableAs();
+
         $documents = $this->documentFactory->makeFromModels($models);
 
         $this->documentManager->index($index, $documents->all(), $this->refreshDocuments);
@@ -63,6 +62,7 @@ public function delete($models): void
         }
 
         $index = $models->first()->searchableAs();
+
         $documentIds = $models->map(fn (Model $model) => (string) $model->getScoutKey())->all();
 
         $this->documentManager->delete($index, $documentIds, $this->refreshDocuments);
@@ -129,6 +129,7 @@ public function getTotalCount($results): ?int
     public function flush($model): void
     {
         $index = $model->searchableAs();
+
         $query = ['match_all' => new stdClass];
 
         $this->documentManager->deleteByQuery($index, $query, $this->refreshDocuments);

src/OpenSearchScoutServiceProvider.php

@@ -3,14 +3,17 @@
 namespace DirectoryTree\OpenSearchScoutDriver;
 
 use DirectoryTree\OpenSearchAdapter\Documents\DocumentManager;
+use DirectoryTree\OpenSearchAdapter\Documents\DocumentManagerInterface;
 use DirectoryTree\OpenSearchAdapter\Indices\IndexManager;
+use DirectoryTree\OpenSearchAdapter\Indices\IndexManagerInterface;
 use DirectoryTree\OpenSearchClient\OpenSearchManager;
 use DirectoryTree\OpenSearchScoutDriver\Factories\DocumentFactory;
 use DirectoryTree\OpenSearchScoutDriver\Factories\DocumentFactoryInterface;
 use DirectoryTree\OpenSearchScoutDriver\Factories\ModelFactory;
 use DirectoryTree\OpenSearchScoutDriver\Factories\ModelFactoryInterface;
 use DirectoryTree\OpenSearchScoutDriver\Factories\SearchRequestFactory;
 use DirectoryTree\OpenSearchScoutDriver\Factories\SearchRequestFactoryInterface;
+use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Support\ServiceProvider;
 use Laravel\Scout\EngineManager;
 
@@ -26,17 +29,28 @@ public function register(): void
     {
         $this->mergeConfigFrom(__DIR__.'/../config/opensearch-scout.php', 'opensearch-scout');
 
-        $this->app->bindIf(ModelFactoryInterface::class, ModelFactory::class);
-        $this->app->bindIf(DocumentFactoryInterface::class, DocumentFactory::class);
-        $this->app->bindIf(SearchRequestFactoryInterface::class, SearchRequestFactory::class);
+        $this->app->bind(ModelFactoryInterface::class, ModelFactory::class);
+        $this->app->bind(DocumentFactoryInterface::class, DocumentFactory::class);
+        $this->app->bind(SearchRequestFactoryInterface::class, SearchRequestFactory::class);
 
-        $this->app->singletonIf(DocumentManager::class, function ($app) {
+        $this->app->singleton(DocumentManagerInterface::class, function (Application $app) {
             return new DocumentManager($app->make(OpenSearchManager::class)->default());
         });
 
-        $this->app->singletonIf(IndexManager::class, function ($app) {
+        $this->app->singleton(IndexManagerInterface::class, function (Application $app) {
             return new IndexManager($app->make(OpenSearchManager::class)->default());
         });
+
+        $this->app->bind(Engine::class, function (Application $app) {
+            return new Engine(
+                $app->make(ModelFactoryInterface::class),
+                $app->make(IndexManagerInterface::class),
+                $app->make(DocumentManagerInterface::class),
+                $app->make(DocumentFactoryInterface::class),
+                $app->make(SearchRequestFactoryInterface::class),
+                $app['config']->get('opensearch-scout.refresh_documents', false),
+            );
+        });
     }
 
     /**
@@ -48,7 +62,7 @@ public function boot(): void
             __DIR__.'/../config/opensearch-scout.php' => config_path('opensearch-scout.php'),
         ]);
 
-        $this->app->make(EngineManager::class)->extend('opensearch', function ($app) {
+        $this->app->make(EngineManager::class)->extend('opensearch', function (Application $app) {
             return $app->make(Engine::class);
         });
     }

tests/Feature/OpenSearchScoutServiceProviderTest.php

@@ -1,7 +1,7 @@
 <?php
 
-use DirectoryTree\OpenSearchAdapter\Documents\DocumentManager;
-use DirectoryTree\OpenSearchAdapter\Indices\IndexManager;
+use DirectoryTree\OpenSearchAdapter\Documents\DocumentManagerInterface;
+use DirectoryTree\OpenSearchAdapter\Indices\IndexManagerInterface;
 use DirectoryTree\OpenSearchScoutDriver\Engine;
 use DirectoryTree\OpenSearchScoutDriver\Factories\DocumentFactoryInterface;
 use DirectoryTree\OpenSearchScoutDriver\Factories\ModelFactoryInterface;
@@ -16,6 +16,6 @@
     expect(app(DocumentFactoryInterface::class))->toBeInstanceOf(DocumentFactoryInterface::class)
         ->and(app(ModelFactoryInterface::class))->toBeInstanceOf(ModelFactoryInterface::class)
         ->and(app(SearchRequestFactoryInterface::class))->toBeInstanceOf(SearchRequestFactoryInterface::class)
-        ->and(app(DocumentManager::class))->toBeInstanceOf(DocumentManager::class)
-        ->and(app(IndexManager::class))->toBeInstanceOf(IndexManager::class);
+        ->and(app(DocumentManagerInterface::class))->toBeInstanceOf(DocumentManagerInterface::class)
+        ->and(app(IndexManagerInterface::class))->toBeInstanceOf(IndexManagerInterface::class);
 });

tests/Integration/OpenSearchScoutDriverTest.php

@@ -1,6 +1,6 @@
 <?php
 
-use DirectoryTree\OpenSearchAdapter\Indices\IndexManager;
+use DirectoryTree\OpenSearchAdapter\Indices\IndexManagerInterface;
 use DirectoryTree\OpenSearchAdapter\Indices\Mapping;
 use DirectoryTree\OpenSearchScoutDriver\Tests\Fixtures\Client;
 use Illuminate\Database\Schema\Blueprint;
@@ -23,24 +23,27 @@
         ['id' => 3, 'name' => 'Taylor Otwell', 'email' => 'taylor@example.com'],
     ]);
 
-    $this->indexName = (new Client)->searchableAs();
-    $this->indexManager = app(IndexManager::class);
+    $index = (new Client)->searchableAs();
+    $indexManager = app(IndexManagerInterface::class);
 
-    if ($this->indexManager->exists($this->indexName)) {
-        $this->indexManager->delete($this->indexName);
+    if ($indexManager->exists($index)) {
+        $indexManager->delete($index);
     }
 
-    app(EngineManager::class)->engine('opensearch')->createIndex($this->indexName);
+    app(EngineManager::class)->engine('opensearch')->createIndex($index);
 
-    $this->indexManager->putMapping($this->indexName, (new Mapping)
+    $indexManager->putMapping($index, (new Mapping)
         ->text('name', ['fielddata' => true])
         ->keyword('email')
         ->integer('__soft_deleted'));
 });
 
 afterEach(function (): void {
-    if (isset($this->indexManager, $this->indexName) && $this->indexManager->exists($this->indexName)) {
-        $this->indexManager->delete($this->indexName);
+    $index = (new Client)->searchableAs();
+    $indexManager = app(IndexManagerInterface::class);
+
+    if ($indexManager->exists($index)) {
+        $indexManager->delete($index);
     }
 
     Schema::dropIfExists('clients');