Merge branch '5.0' into DOCSP-43159-query-builder-returns-object

Author: rustagir

CHANGELOG.md

@@ -4,12 +4,13 @@ All notable changes to this project will be documented in this file.
 ## [5.0.0] - next
 
 * Remove support for Laravel 10 by @GromNaN in [#3123](https://github.com/mongodb/laravel-mongodb/pull/3123)
-* **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)
+* **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) and [#3136](https://github.com/mongodb/laravel-mongodb/pull/3136)
 * **BREAKING CHANGE** Make Query\Builder return objects instead of array to match Laravel behavior by @GromNaN in [#3107](https://github.com/mongodb/laravel-mongodb/pull/3107)
 * **BREAKING CHANGE** In DB query results, convert BSON `UTCDateTime` objects into `Carbon` date with the default timezone by @GromNaN in [#3119](https://github.com/mongodb/laravel-mongodb/pull/3119)
 * 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",
@@ -41,7 +41,8 @@
         "mockery/mockery": "^1.4.4",
         "doctrine/coding-standard": "12.0.x-dev",
         "spatie/laravel-query-builder": "^5.6",
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^1.10",
+        "rector/rector": "^1.2"
     },
     "suggest": {
         "league/flysystem-gridfs": "Filesystem storage in MongoDB with GridFS",
@@ -73,7 +74,8 @@
         "test": "phpunit",
         "test:coverage": "phpunit --coverage-clover ./coverage.xml",
         "cs": "phpcs",
-        "cs:fix": "phpcbf"
+        "cs:fix": "phpcbf",
+        "rector": "rector"
     },
     "config": {
         "allow-plugins": {

docs/eloquent-models/model-class.txt

@@ -302,12 +302,8 @@ including this trait, you can make the third-party class compatible with
 MongoDB.
 
 When you apply the ``DocumentModel`` trait to a model class, you must
-declare the following properties in your class:
-
-- ``$primaryKey = '_id'``, because the ``_id`` field uniquely
-  identifies MongoDB documents
-- ``$keyType = 'string'``, because the {+odm-short+} casts MongoDB
-  ``ObjectId`` values to type ``string``
+set the  ``$keyType`` property to ``'string'`` as the {+odm-short+}
+casts MongoDB ``ObjectId`` values to type ``string``.
 
 Extended Class Example
 ~~~~~~~~~~~~~~~~~~~~~~

docs/includes/query-builder/QueryBuilderTest.php

@@ -7,8 +7,9 @@
 use Illuminate\Database\Query\Builder;
 use Illuminate\Pagination\AbstractPaginator;
 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;
@@ -63,7 +64,7 @@ public function testOrWhere(): void
         // begin query orWhere
         $result = DB::connection('mongodb')
             ->table('movies')
-            ->where('year', 1955)
+            ->where('id', new ObjectId('573a1398f29313caabce9682'))
             ->orWhere('title', 'Back to the Future')
             ->get();
         // end query orWhere

docs/includes/usage-examples/FindOneTest.php

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

docs/query-builder.txt

@@ -181,15 +181,28 @@ Logical OR Example
 
 The following example shows how to chain the ``orWhere()``
 query builder method to retrieve documents from the
-``movies`` collection that either match the ``year``
-value of ``1955`` or match the ``title`` value ``"Back to the Future"``:
+``movies`` collection in which the value of the ``_id``
+field is ``ObjectId('573a1398f29313caabce9682')`` or
+the value of the ``title`` field is ``"Back to the Future"``:
 
 .. literalinclude:: /includes/query-builder/QueryBuilderTest.php
    :language: php
    :dedent:
    :start-after: begin query orWhere
    :end-before: end query orWhere
 
+.. note::
+
+   You can use the ``id`` alias in your queries to represent the
+   ``_id`` field in MongoDB documents, as shown in the preceding
+   code. When you run a find operation using the query builder, {+odm-short+}
+   automatically converts between ``id`` and ``_id``. This provides better
+   compatibility with Laravel, as the framework assumes that each record has a
+   primary key named ``id`` by default.
+   
+   Because of this behavior, you cannot have two separate ``id`` and ``_id``
+   fields in your documents.
+
 .. _laravel-query-builder-logical-and:
 
 Logical AND Example

docs/upgrade.txt

@@ -91,9 +91,24 @@ This library version introduces the following breaking changes:
      // v5.0
      $document->balance;
 
+- Removes support for the following classes:
+
+  - ``MongoDB\Laravel\Auth\DatabaseTokenRepository``. Instead, use the default
+    ``Illuminate\Queue\Failed\DatabaseFailedJobProvider`` class and
+    specify a connection to MongoDB.
+
+  - ``MongoDB\Laravel\Queue\Failed\MongoFailedJobProvider``. Instead,
+    use the default ``Illuminate\Queue\Failed\DatabaseFailedJobProvider``
+    class and specify a connection to MongoDB.
+    
 - In query results, the library converts BSON ``UTCDateTime`` objects to ``Carbon``
   date classes, applying the default timezone.
 
+- ``id`` is an alias for the ``_id`` field in MongoDB documents, and the library
+  automatically converts between ``id`` and ``_id`` when querying data. Because
+  of this behavior, you cannot have two separate ``id`` and ``_id`` fields in your
+  documents.
+
 .. _laravel-breaking-changes-v4.x:
 
 Version 4.x Breaking Changes

rector.php

@@ -0,0 +1,25 @@
+<?php
+
+use Rector\Config\RectorConfig;
+use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
+use Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector;
+use Rector\Php80\Rector\FunctionLike\MixedTypeRector;
+use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
+use Rector\TypeDeclaration\Rector\Closure\AddClosureVoidReturnTypeWhereNoReturnRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __FILE__,
+        __DIR__ . '/docs',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withPhpSets()
+    ->withTypeCoverageLevel(0)
+    ->withSkip([
+        RemoveExtraParametersRector::class,
+        ClosureToArrowFunctionRector::class,
+        NullToStrictStringFuncCallArgRector::class,
+        MixedTypeRector::class,
+        AddClosureVoidReturnTypeWhereNoReturnRector::class,
+    ]);

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;
@@ -28,7 +28,7 @@
 // are called by PruneBatchesCommand
 class MongoBatchRepository extends DatabaseBatchRepository implements PrunableBatchRepository
 {
-    private Collection $collection;
+    private readonly Collection $collection;
 
     public function __construct(
         BatchFactory $factory,

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;