PHPORM-28 Add Scout engine to index into MongoDB Search (#3205)

Author: GromNaN

Diff for: .github/workflows/build-ci.yml

@@ -65,6 +65,9 @@ jobs:
                     until docker exec --tty mongodb mongosh 127.0.0.1:27017 --eval "db.runCommand({ ping: 1 })"; do
                       sleep 1
                     done
+                    until docker exec --tty mongodb mongosh 127.0.0.1:27017 --eval "db.createCollection('connection_test') && db.getCollection('connection_test').createSearchIndex({mappings:{dynamic: true}})"; do
+                      sleep 1
+                    done
 
             -   name: "Show MongoDB server status"
                 run: |

Diff for: composer.json

@@ -35,6 +35,7 @@
     },
     "require-dev": {
         "mongodb/builder": "^0.2",
+        "laravel/scout": "^11",
         "league/flysystem-gridfs": "^3.28",
         "league/flysystem-read-only": "^3.0",
         "phpunit/phpunit": "^10.3",

Diff for: docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.5'
-
 services:
     app:
         tty: true
@@ -16,11 +14,11 @@ services:
 
     mongodb:
         container_name: mongodb
-        image: mongo:latest
+        image: mongodb/mongodb-atlas-local:latest
         ports:
             - "27017:27017"
         healthcheck:
-            test: echo 'db.runCommand("ping").ok' | mongosh mongodb:27017 --quiet
+            test: mongosh --quiet --eval 'db.runCommand("ping").ok'
             interval: 10s
             timeout: 10s
             retries: 5

Diff for: phpstan-baseline.neon

@@ -24,3 +24,8 @@ parameters:
 			message: "#^Method Illuminate\\\\Database\\\\Schema\\\\Blueprint\\:\\:create\\(\\) invoked with 1 parameter, 0 required\\.$#"
 			count: 1
 			path: src/Schema/Builder.php
+
+		-
+			message: "#^Call to an undefined method Illuminate\\\\Support\\\\HigherOrderCollectionProxy\\<\\(int\\|string\\), Illuminate\\\\Database\\\\Eloquent\\\\Model\\>\\:\\:pushSoftDeleteMetadata\\(\\)\\.$#"
+			count: 1
+			path: src/Scout/ScoutEngine.php

Diff for: phpunit.xml.dist

@@ -17,7 +17,7 @@
         </testsuite>
     </testsuites>
     <php>
-        <env name="MONGODB_URI" value="mongodb://mongodb/"/>
+        <env name="MONGODB_URI" value="mongodb://mongodb/?directConnection=true"/>
         <env name="MONGODB_DATABASE" value="unittest"/>
         <env name="SQLITE_DATABASE" value=":memory:"/>
         <env name="QUEUE_CONNECTION" value="database"/>

Diff for: src/MongoDBServiceProvider.php

@@ -7,19 +7,22 @@
 use Closure;
 use Illuminate\Cache\CacheManager;
 use Illuminate\Cache\Repository;
+use Illuminate\Container\Container;
 use Illuminate\Filesystem\FilesystemAdapter;
 use Illuminate\Filesystem\FilesystemManager;
 use Illuminate\Foundation\Application;
 use Illuminate\Session\SessionManager;
 use Illuminate\Support\ServiceProvider;
 use InvalidArgumentException;
+use Laravel\Scout\EngineManager;
 use League\Flysystem\Filesystem;
 use League\Flysystem\GridFS\GridFSAdapter;
 use League\Flysystem\ReadOnly\ReadOnlyFilesystemAdapter;
 use MongoDB\GridFS\Bucket;
 use MongoDB\Laravel\Cache\MongoStore;
 use MongoDB\Laravel\Eloquent\Model;
 use MongoDB\Laravel\Queue\MongoConnector;
+use MongoDB\Laravel\Scout\ScoutEngine;
 use RuntimeException;
 use Symfony\Component\HttpFoundation\Session\Storage\Handler\MongoDbSessionHandler;
 
@@ -102,6 +105,7 @@ public function register()
         });
 
         $this->registerFlysystemAdapter();
+        $this->registerScoutEngine();
     }
 
     private function registerFlysystemAdapter(): void
@@ -155,4 +159,21 @@ private function registerFlysystemAdapter(): void
             });
         });
     }
+
+    private function registerScoutEngine(): void
+    {
+        $this->app->resolving(EngineManager::class, function (EngineManager $engineManager) {
+            $engineManager->extend('mongodb', function (Container $app) {
+                $connectionName = $app->get('config')->get('scout.mongodb.connection', 'mongodb');
+                $connection = $app->get('db')->connection($connectionName);
+                $softDelete = (bool) $app->get('config')->get('scout.soft_delete', false);
+
+                assert($connection instanceof Connection, new InvalidArgumentException(sprintf('The connection "%s" is not a MongoDB connection.', $connectionName)));
+
+                return new ScoutEngine($connection->getMongoDB(), $softDelete);
+            });
+
+            return $engineManager;
+        });
+    }
 }