V5

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+# [4.7.0] - upcoming
+
+* **BREAKING CHANGE** Use `id` as an alias for `_id` in commands and queries for compatibility with Eloquent packages by @GromNaN in [#3040](https://github.com/mongodb/laravel-mongodb/pull/3040)
+
 ## [4.6.0] - 2024-07-09
 
 * Add `DocumentModel` trait to use any 3rd party model with MongoDB @GromNaN in [#2580](https://github.com/mongodb/laravel-mongodb/pull/2580)

docs/includes/fundamentals/aggregation/AggregationsBuilderTest.php

@@ -68,7 +68,7 @@ public function testAggregationBuilderSortStage(): void
         // end aggregation sort stage
 
         $this->assertEquals(6, $result->count());
-        $this->assertEquals('Janet Doe', $result->first()['name']);
+        $this->assertEquals('Janet Doe', $result->first()->name);
     }
 
     public function testAggregationBuilderProjectStage(): void
@@ -80,8 +80,9 @@ public function testAggregationBuilderProjectStage(): void
         // end aggregation project stage
 
         $this->assertEquals(6, $result->count());
-        $this->assertNotNull($result->first()['name']);
-        $this->assertArrayNotHasKey('_id', $result->first());
+        $this->assertNotNull($result->first()->name);
+        $this->assertObjectNotHasProperty('_id', $result->first());
+        $this->assertObjectNotHasProperty('id', $result->first());
     }
 
     public function testAggregationBuilderPipeline(): void
@@ -104,7 +105,7 @@ public function testAggregationBuilderPipeline(): void
         $result = $pipeline->get();
 
         $this->assertEquals(2, $result->count());
-        $this->assertNotNull($result->first()['birth_year_avg']);
+        $this->assertNotNull($result->first()->birth_year_avg);
     }
 
     // phpcs:disable Squiz.Commenting.FunctionComment.WrongStyle
@@ -130,6 +131,6 @@ public function testCustomOperatorFactory(): void
         $result = $pipeline->get();
 
         $this->assertEquals(6, $result->count());
-        $this->assertNotNull($result->first()['birth_year']);
+        $this->assertNotNull($result->first()->birth_year);
     }
 }

docs/includes/usage-examples/FindOneTest.php

@@ -24,13 +24,13 @@ public function testFindOne(): void
 
         // begin-find-one
         $movie = Movie::where('directors', 'Rob Reiner')
-          ->orderBy('_id')
+          ->orderBy('id')
           ->first();
 
         echo $movie->toJson();
         // end-find-one
 
         $this->assertInstanceOf(Movie::class, $movie);
-        $this->expectOutputRegex('/^{"_id":"[a-z0-9]{24}","title":"The Shawshank Redemption","directors":\["Frank Darabont","Rob Reiner"\]}$/');
+        $this->expectOutputRegex('/^{"title":"The Shawshank Redemption","directors":\["Frank Darabont","Rob Reiner"\],"id":"[a-z0-9]{24}"}$/');
     }
 }

docs/includes/usage-examples/InsertOneTest.php

@@ -30,6 +30,6 @@ public function testInsertOne(): void
         // end-insert-one
 
         $this->assertInstanceOf(Movie::class, $movie);
-        $this->expectOutputRegex('/^{"title":"Marriage Story","year":2019,"runtime":136,"updated_at":".{27}","created_at":".{27}","_id":"[a-z0-9]{24}"}$/');
+        $this->expectOutputRegex('/^{"title":"Marriage Story","year":2019,"runtime":136,"updated_at":".{27}","created_at":".{27}","id":"[a-z0-9]{24}"}$/');
     }
 }

src/Auth/User.php

@@ -11,6 +11,5 @@ class User extends BaseUser
 {
     use DocumentModel;
 
-    protected $primaryKey = '_id';
     protected $keyType = 'string';
 }

src/Eloquent/Builder.php

@@ -191,7 +191,7 @@ public function raw($value = null)
         }
 
         // The result is a single object.
-        if (is_array($results) && array_key_exists('_id', $results)) {
+        if (is_array($results) && array_key_exists('id', $results)) {
             return $this->model->newFromBuilder((array) $results);
         }
 

src/Eloquent/DocumentModel.php

@@ -76,8 +76,8 @@ public function getIdAttribute($value = null)
     {
         // If we don't have a value for 'id', we will use the MongoDB '_id' value.
         // This allows us to work with models in a more sql-like way.
-        if (! $value && array_key_exists('_id', $this->attributes)) {
-            $value = $this->attributes['_id'];
+        if (! $value && array_key_exists('id', $this->attributes)) {
+            $value = $this->attributes['id'];
         }
 
         // Convert ObjectID to string.
@@ -238,8 +238,8 @@ public function setAttribute($key, $value)
             };
         }
 
-        // Convert _id to ObjectID.
-        if ($key === '_id' && is_string($value)) {
+        // Convert "id" to ObjectID.
+        if ($key === 'id' && is_string($value)) {
             $builder = $this->newBaseQueryBuilder();
 
             $value = $builder->convertKey($value);
@@ -721,9 +721,9 @@ protected function isBSON(mixed $value): bool
     public function save(array $options = [])
     {
         // SQL databases would use autoincrement the id field if set to null.
-        // Apply the same behavior to MongoDB with _id only, otherwise null would be stored.
-        if (array_key_exists('_id', $this->attributes) && $this->attributes['_id'] === null) {
-            unset($this->attributes['_id']);
+        // Apply the same behavior to MongoDB with "id" only, otherwise null would be stored.
+        if (array_key_exists('id', $this->attributes) && $this->attributes['id'] === null) {
+            unset($this->attributes['id']);
         }
 
         $saved = parent::save($options);

src/Eloquent/Model.php

@@ -16,13 +16,6 @@ abstract class Model extends BaseModel
 {
     use DocumentModel;
 
-    /**
-     * The primary key for the model.
-     *
-     * @var string
-     */
-    protected $primaryKey = '_id';
-
     /**
      * The primary key type.
      *

src/MongoDBQueueServiceProvider.php

@@ -4,14 +4,11 @@
 
 namespace MongoDB\Laravel;
 
+use Illuminate\Queue\Failed\DatabaseFailedJobProvider;
 use Illuminate\Queue\Failed\NullFailedJobProvider;
 use Illuminate\Queue\QueueServiceProvider;
-use MongoDB\Laravel\Queue\Failed\MongoFailedJobProvider;
 
 use function array_key_exists;
-use function trigger_error;
-
-use const E_USER_DEPRECATED;
 
 class MongoDBQueueServiceProvider extends QueueServiceProvider
 {
@@ -52,14 +49,13 @@ protected function registerFailedJobServices()
     /**
      * Create a new MongoDB failed job provider.
      */
-    protected function mongoFailedJobProvider(array $config): MongoFailedJobProvider
+    protected function mongoFailedJobProvider(array $config): DatabaseFailedJobProvider
     {
         if (! isset($config['collection']) && isset($config['table'])) {
-            trigger_error('Since mongodb/laravel-mongodb 4.4: Using "table" option for the queue is deprecated. Use "collection" instead.', E_USER_DEPRECATED);
             $config['collection'] = $config['table'];
         }
 
-        return new MongoFailedJobProvider(
+        return new DatabaseFailedJobProvider(
             $this->app['db'],
             $config['database'] ?? null,
             $config['collection'] ?? 'failed_jobs',

src/Query/AggregationBuilder.php

@@ -88,7 +88,7 @@ private function execute(array $options): CursorInterface&Iterator
         $pipeline = $encoder->encode($this->getPipeline());
 
         $options = array_replace(
-            ['typeMap' => ['root' => 'array', 'document' => 'array']],
+            ['typeMap' => ['root' => 'object', 'document' => 'object']],
             $this->options,
             $options,
         );