PHPORM-56 Replace Collection proxy class with Driver monitoring (#3137)

Author: GromNaN

CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to this project will be documented in this file.
 * Remove `MongoFailedJobProvider`, replaced by Laravel `DatabaseFailedJobProvider` by @GromNaN in [#3122](https://github.com/mongodb/laravel-mongodb/pull/3122)
 * Remove custom `PasswordResetServiceProvider`, use the default `DatabaseTokenRepository` by @GromNaN in [#3124](https://github.com/mongodb/laravel-mongodb/pull/3124)
 * Remove `Blueprint::background()` method by @GromNaN in [#3132](https://github.com/mongodb/laravel-mongodb/pull/3132)
+* Replace `Collection` proxy class with Driver monitoring by @GromNaN in [#3137]((https://github.com/mongodb/laravel-mongodb/pull/3137)
 
 ## [4.8.0] - 2024-08-27
 

composer.json

@@ -30,7 +30,7 @@
         "illuminate/database": "^11",
         "illuminate/events": "^11",
         "illuminate/support": "^11",
-        "mongodb/mongodb": "^1.15"
+        "mongodb/mongodb": "^1.18"
     },
     "require-dev": {
         "mongodb/builder": "^0.2",

docs/includes/query-builder/QueryBuilderTest.php

@@ -9,7 +9,7 @@
 use Illuminate\Support\Facades\DB;
 use MongoDB\BSON\ObjectId;
 use MongoDB\BSON\Regex;
-use MongoDB\Laravel\Collection;
+use MongoDB\Collection;
 use MongoDB\Laravel\Tests\TestCase;
 
 use function file_get_contents;

src/Bus/MongoBatchRepository.php

@@ -14,8 +14,8 @@
 use Illuminate\Support\Carbon;
 use MongoDB\BSON\ObjectId;
 use MongoDB\BSON\UTCDateTime;
+use MongoDB\Collection;
 use MongoDB\Driver\ReadPreference;
-use MongoDB\Laravel\Collection;
 use MongoDB\Laravel\Connection;
 use MongoDB\Operation\FindOneAndUpdate;
 use Override;

src/Cache/MongoLock.php

@@ -6,7 +6,7 @@
 use Illuminate\Support\Carbon;
 use InvalidArgumentException;
 use MongoDB\BSON\UTCDateTime;
-use MongoDB\Laravel\Collection;
+use MongoDB\Collection;
 use MongoDB\Operation\FindOneAndUpdate;
 use Override;
 

src/Cache/MongoStore.php

@@ -7,7 +7,7 @@
 use Illuminate\Contracts\Cache\Store;
 use Illuminate\Support\Carbon;
 use MongoDB\BSON\UTCDateTime;
-use MongoDB\Laravel\Collection;
+use MongoDB\Collection;
 use MongoDB\Laravel\Connection;
 use MongoDB\Operation\FindOneAndUpdate;
 use Override;

src/Collection.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace MongoDB\Laravel;
+
+use MongoDB\BSON\Document;
+use MongoDB\Driver\Monitoring\CommandFailedEvent;
+use MongoDB\Driver\Monitoring\CommandStartedEvent;
+use MongoDB\Driver\Monitoring\CommandSubscriber as CommandSubscriberInterface;
+use MongoDB\Driver\Monitoring\CommandSucceededEvent;
+
+use function get_object_vars;
+use function in_array;
+
+/** @internal */
+final class CommandSubscriber implements CommandSubscriberInterface
+{
+    /** @var array<string, CommandStartedEvent> */
+    private array $commands = [];
+
+    public function __construct(private Connection $connection)
+    {
+    }
+
+    public function commandStarted(CommandStartedEvent $event)
+    {
+        $this->commands[$event->getOperationId()] = $event;
+    }
+
+    public function commandFailed(CommandFailedEvent $event)
+    {
+        $this->logQuery($event);
+    }
+
+    public function commandSucceeded(CommandSucceededEvent $event)
+    {
+        $this->logQuery($event);
+    }
+
+    private function logQuery(CommandSucceededEvent|CommandFailedEvent $event): void
+    {
+        $startedEvent = $this->commands[$event->getOperationId()];
+        unset($this->commands[$event->getOperationId()]);
+
+        $command = [];
+        foreach (get_object_vars($startedEvent->getCommand()) as $key => $value) {
+            if ($key[0] !== '$' && ! in_array($key, ['lsid', 'txnNumber'])) {
+                $command[$key] = $value;
+            }
+        }
+
+        $this->connection->logQuery(Document::fromPHP($command)->toCanonicalExtendedJSON(), [], $event->getDurationMicros());
+    }
+}

src/CommandSubscriber.php

@@ -8,6 +8,7 @@
 use Illuminate\Database\Connection as BaseConnection;
 use InvalidArgumentException;
 use MongoDB\Client;
+use MongoDB\Collection;
 use MongoDB\Database;
 use MongoDB\Driver\Exception\AuthenticationException;
 use MongoDB\Driver\Exception\ConnectionException;
@@ -47,6 +48,8 @@ class Connection extends BaseConnection
      */
     protected $connection;
 
+    private ?CommandSubscriber $commandSubscriber;
+
     /**
      * Create a new database connection instance.
      */
@@ -62,6 +65,8 @@ public function __construct(array $config)
 
         // Create the connection
         $this->connection = $this->createConnection($dsn, $config, $options);
+        $this->commandSubscriber = new CommandSubscriber($this);
+        $this->connection->addSubscriber($this->commandSubscriber);
 
         // Select database
         $this->db = $this->connection->selectDatabase($this->getDefaultDatabaseName($dsn, $config));
@@ -97,9 +102,9 @@ public function table($table, $as = null)
      *
      * @return Collection
      */
-    public function getCollection($name)
+    public function getCollection($name): Collection
     {
-        return new Collection($this, $this->db->selectCollection($this->tablePrefix . $name));
+        return $this->db->selectCollection($this->tablePrefix . $name);
     }
 
     /** @inheritdoc */
@@ -198,6 +203,8 @@ public function ping(): void
     /** @inheritdoc */
     public function disconnect()
     {
+        $this->connection?->removeSubscriber($this->commandSubscriber);
+        $this->commandSubscriber = null;
         $this->connection = null;
     }
 
@@ -264,12 +271,6 @@ protected function getDsn(array $config): string
         throw new InvalidArgumentException('MongoDB connection configuration requires "dsn" or "host" key.');
     }
 
-    /** @inheritdoc */
-    public function getElapsedTime($start)
-    {
-        return parent::getElapsedTime($start);
-    }
-
     /** @inheritdoc */
     public function getDriverName()
     {

src/Connection.php

@@ -10,9 +10,8 @@
 use Iterator;
 use MongoDB\Builder\BuilderEncoder;
 use MongoDB\Builder\Stage\FluentFactoryTrait;
-use MongoDB\Collection as MongoDBCollection;
+use MongoDB\Collection;
 use MongoDB\Driver\CursorInterface;
-use MongoDB\Laravel\Collection as LaravelMongoDBCollection;
 
 use function array_replace;
 use function collect;
@@ -24,7 +23,7 @@ class AggregationBuilder
     use FluentFactoryTrait;
 
     public function __construct(
-        private MongoDBCollection|LaravelMongoDBCollection $collection,
+        private Collection $collection,
         private readonly array $options = [],
     ) {
     }

src/Query/AggregationBuilder.php

@@ -82,7 +82,7 @@ class Builder extends BaseBuilder
     /**
      * The database collection.
      *
-     * @var \MongoDB\Laravel\Collection
+     * @var \MongoDB\Collection
      */
     protected $collection;
 

src/Query/Builder.php

@@ -6,7 +6,7 @@
 
 use Illuminate\Database\Connection;
 use Illuminate\Database\Schema\Blueprint as SchemaBlueprint;
-use MongoDB\Laravel\Collection;
+use MongoDB\Collection;
 
 use function array_flip;
 use function implode;
@@ -21,14 +21,14 @@ class Blueprint extends SchemaBlueprint
     /**
      * The MongoConnection object for this blueprint.
      *
-     * @var \MongoDB\Laravel\Connection
+     * @var Connection
      */
     protected $connection;
 
     /**
-     * The MongoCollection object for this blueprint.
+     * The Collection object for this blueprint.
      *
-     * @var Collection|\MongoDB\Collection
+     * @var Collection
      */
     protected $collection;
 

src/Schema/Blueprint.php

@@ -8,8 +8,8 @@
 use Illuminate\Support\Facades\DB;
 use InvalidArgumentException;
 use MongoDB\BSON\UTCDateTime;
+use MongoDB\Collection;
 use MongoDB\Laravel\Cache\MongoLock;
-use MongoDB\Laravel\Collection;
 use MongoDB\Laravel\Tests\TestCase;
 use PHPUnit\Framework\Attributes\TestWith;
 

tests/Cache/MongoLockTest.php

@@ -10,7 +10,7 @@
 use MongoDB\BSON\Int64;
 use MongoDB\BSON\Javascript;
 use MongoDB\BSON\UTCDateTime;
-use MongoDB\Laravel\Collection;
+use MongoDB\Collection;
 use MongoDB\Laravel\Tests\Models\Casting;
 use MongoDB\Laravel\Tests\TestCase;