PHPORM-255 Add a method to disable renaming the id to _id field in embedded documents

Author: GromNaN

src/Connection.php

@@ -53,6 +53,9 @@ class Connection extends BaseConnection
 
     private ?CommandSubscriber $commandSubscriber = null;
 
+    /** @var bool Whether to rename the rename "id" into "_id" for embedded documents. */
+    private bool $renameEmbeddedIdField = true;
+
     /**
      * Create a new database connection instance.
      */
@@ -395,6 +398,18 @@ public function __call($method, $parameters)
         return $this->db->$method(...$parameters);
     }
 
+    /** Set whether to rename "id" field into "_id" for embedded documents. */
+    public function setRenameEmbeddedIdField(bool $rename): void
+    {
+        $this->renameEmbeddedIdField = $rename;
+    }
+
+    /** Get whether to rename "id" field into "_id" for embedded documents. */
+    public function getRenameEmbeddedIdField(): bool
+    {
+        return $this->renameEmbeddedIdField;
+    }
+
     /**
      * Return the server version of one of the MongoDB servers: primary for
      * replica sets and standalone, and the selected server for sharded clusters.

src/Query/Builder.php

@@ -29,6 +29,7 @@
 use MongoDB\Builder\Type\SearchOperatorInterface;
 use MongoDB\Driver\Cursor;
 use MongoDB\Driver\ReadPreference;
+use MongoDB\Laravel\Connection;
 use Override;
 use RuntimeException;
 use stdClass;
@@ -83,6 +84,7 @@
 use function trait_exists;
 use function var_export;
 
+/** @method Connection getConnection() */
 class Builder extends BaseBuilder
 {
     private const REGEX_DELIMITERS = ['/', '#', '~'];
@@ -124,6 +126,8 @@ class Builder extends BaseBuilder
      */
     public $options = [];
 
+    private ?bool $renameEmbeddedIdField;
+
     /**
      * All of the available clause operators.
      *
@@ -1764,9 +1768,9 @@ public function orWhereIntegerNotInRaw($column, $values, $boolean = 'and')
         throw new BadMethodCallException('This method is not supported by MongoDB');
     }
 
-    private function aliasIdForQuery(array $values): array
+    private function aliasIdForQuery(array $values, bool $root = true): array
     {
-        if (array_key_exists('id', $values)) {
+        if (array_key_exists('id', $values) && ($root || $this->getConnection()->getRenameEmbeddedIdField())) {
             if (array_key_exists('_id', $values) && $values['id'] !== $values['_id']) {
                 throw new InvalidArgumentException('Cannot have both "id" and "_id" fields.');
             }
@@ -1793,7 +1797,7 @@ private function aliasIdForQuery(array $values): array
             }
 
             // ".id" subfield are alias for "._id"
-            if (str_ends_with($key, '.id')) {
+            if (str_ends_with($key, '.id') && ($root || $this->getConnection()->getRenameEmbeddedIdField())) {
                 $newkey = substr($key, 0, -3) . '._id';
                 if (array_key_exists($newkey, $values) && $value !== $values[$newkey]) {
                     throw new InvalidArgumentException(sprintf('Cannot have both "%s" and "%s" fields.', $key, $newkey));
@@ -1806,7 +1810,7 @@ private function aliasIdForQuery(array $values): array
 
         foreach ($values as &$value) {
             if (is_array($value)) {
-                $value = $this->aliasIdForQuery($value);
+                $value = $this->aliasIdForQuery($value, false);
             } elseif ($value instanceof DateTimeInterface) {
                 $value = new UTCDateTime($value);
             }
@@ -1824,10 +1828,13 @@ private function aliasIdForQuery(array $values): array
      *
      * @template T of array|object
      */
-    public function aliasIdForResult(array|object $values): array|object
+    public function aliasIdForResult(array|object $values, bool $root = true): array|object
     {
         if (is_array($values)) {
-            if (array_key_exists('_id', $values) && ! array_key_exists('id', $values)) {
+            if (
+                array_key_exists('_id', $values) && ! array_key_exists('id', $values)
+                && ($root || $this->getConnection()->getRenameEmbeddedIdField())
+            ) {
                 $values['id'] = $values['_id'];
                 unset($values['_id']);
             }
@@ -1837,13 +1844,16 @@ public function aliasIdForResult(array|object $values): array|object
                     $values[$key] = Date::instance($value->toDateTime())
                         ->setTimezone(new DateTimeZone(date_default_timezone_get()));
                 } elseif (is_array($value) || is_object($value)) {
-                    $values[$key] = $this->aliasIdForResult($value);
+                    $values[$key] = $this->aliasIdForResult($value, false);
                 }
             }
         }
 
         if ($values instanceof stdClass) {
-            if (property_exists($values, '_id') && ! property_exists($values, 'id')) {
+            if (
+                property_exists($values, '_id') && ! property_exists($values, 'id')
+                && ($root || $this->getConnection()->getRenameEmbeddedIdField())
+            ) {
                 $values->id = $values->_id;
                 unset($values->_id);
             }
@@ -1853,7 +1863,7 @@ public function aliasIdForResult(array|object $values): array|object
                     $values->{$key} = Date::instance($value->toDateTime())
                         ->setTimezone(new DateTimeZone(date_default_timezone_get()));
                 } elseif (is_array($value) || is_object($value)) {
-                    $values->{$key} = $this->aliasIdForResult($value);
+                    $values->{$key} = $this->aliasIdForResult($value, false);
                 }
             }
         }

tests/Query/BuilderTest.php

@@ -12,7 +12,6 @@
 use Illuminate\Tests\Database\DatabaseQueryBuilderTest;
 use InvalidArgumentException;
 use LogicException;
-use Mockery as m;
 use MongoDB\BSON\Regex;
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Driver\ReadPreference;
@@ -39,7 +38,7 @@ public function testMql(array $expected, Closure $build, ?string $requiredMethod
             $this->markTestSkipped(sprintf('Method "%s::%s()" does not exist.', Builder::class, $requiredMethod));
         }
 
-        $builder = $build(self::getBuilder());
+        $builder = $build($this->getBuilder());
         $this->assertInstanceOf(Builder::class, $builder);
         $mql = $builder->toMql();
 
@@ -1447,7 +1446,7 @@ function (Builder $elemMatchQuery): void {
     #[DataProvider('provideExceptions')]
     public function testException($class, $message, Closure $build): void
     {
-        $builder = self::getBuilder();
+        $builder = $this->getBuilder();
 
         $this->expectException($class);
         $this->expectExceptionMessage($message);
@@ -1545,7 +1544,7 @@ public static function provideExceptions(): iterable
     #[DataProvider('getEloquentMethodsNotSupported')]
     public function testEloquentMethodsNotSupported(Closure $callback)
     {
-        $builder = self::getBuilder();
+        $builder = $this->getBuilder();
 
         $this->expectException(BadMethodCallException::class);
         $this->expectExceptionMessage('This method is not supported by MongoDB');
@@ -1600,12 +1599,38 @@ public static function getEloquentMethodsNotSupported()
         yield 'orWhereIntegerNotInRaw' => [fn (Builder $builder) => $builder->orWhereIntegerNotInRaw('id', ['1a', 2])];
     }
 
-    private static function getBuilder(): Builder
+    public function testRenameEmbeddedIdFieldCanBeDisabled()
     {
-        $connection = m::mock(Connection::class);
-        $processor  = m::mock(Processor::class);
-        $connection->shouldReceive('getSession')->andReturn(null);
-        $connection->shouldReceive('getQueryGrammar')->andReturn(new Grammar($connection));
+        $builder = $this->getBuilder(false);
+        $this->assertFalse($builder->getConnection()->getRenameEmbeddedIdField());
+
+        $mql = $builder
+            ->where('id', '=', 10)
+            ->where('nested.id', '=', 20)
+            ->where('embed', '=', ['id' => 30])
+            ->toMql();
+
+        $this->assertEquals([
+            'find' => [
+                [
+                    '$and' => [
+                        ['_id' => 10],
+                        ['nested.id' => 20],
+                        ['embed' => ['id' => 30]],
+                    ],
+                ],
+                ['typeMap' => ['root' => 'object', 'document' => 'array']],
+            ],
+        ], $mql);
+    }
+
+    private function getBuilder(bool $renameEmbeddedIdField = true): Builder
+    {
+        $connection = $this->createStub(Connection::class);
+        $connection->method('getRenameEmbeddedIdField')->willReturn($renameEmbeddedIdField);
+        $processor  = $this->createStub(Processor::class);
+        $connection->method('getSession')->willReturn(null);
+        $connection->method('getQueryGrammar')->willReturn(new Grammar($connection));
 
         return new Builder($connection, null, $processor);
     }