PHPLIB-1627: BulkWriteCommand API

.evergreen/config/templates/build/build-extension.yml

@@ -7,7 +7,10 @@
       - func: "compile extension"
         # TODO: remove once 2.0.0 is released
         vars:
-          EXTENSION_BRANCH: "v2.x"
+          # TODO: replace with "v2.x" once mongodb/mongo-php-driver#1790 is merged
+          # EXTENSION_BRANCH: "v2.x"
+          EXTENSION_REPO: "https://github.com/jmikola/mongo-php-driver.git"
+          EXTENSION_BRANCH: "2.x-bulkwrite"
       - func: "upload extension"
   # TODO: re-enable once 2.0.0 is released
 #  - name: "build-php-%phpVersion%-lowest"

.github/workflows/coding-standards.yml

@@ -15,7 +15,9 @@ env:
   PHP_VERSION: "8.2"
   # TODO: change to "stable" once 2.0.0 is released
   # DRIVER_VERSION: "stable"
-  DRIVER_VERSION: "mongodb/[email protected]"
+  # TODO: change to "mongodb/[email protected]" once mongodb/mongo-php-driver#1790 is merged
+  # DRIVER_VERSION: "mongodb/[email protected]"
+  DRIVER_VERSION: "jmikola/[email protected]"
 
 jobs:
   phpcs:

.github/workflows/generator.yml

@@ -15,7 +15,9 @@ env:
   PHP_VERSION: "8.2"
   # TODO: change to "stable" once 2.0.0 is released
   # DRIVER_VERSION: "stable"
-  DRIVER_VERSION: "mongodb/[email protected]"
+  # TODO: change to "mongodb/[email protected]" once mongodb/mongo-php-driver#1790 is merged
+  # DRIVER_VERSION: "mongodb/[email protected]"
+  DRIVER_VERSION: "jmikola/[email protected]"
 
 jobs:
   psalm:

.github/workflows/static-analysis.yml

@@ -21,7 +21,9 @@ env:
   PHP_VERSION: "8.2"
   # TODO: change to "stable" once 2.0.0 is released
   # DRIVER_VERSION: "stable"
-  DRIVER_VERSION: "mongodb/[email protected]"
+  # TODO: change to "mongodb/[email protected]" once mongodb/mongo-php-driver#1790 is merged
+  # DRIVER_VERSION: "mongodb/[email protected]"
+  DRIVER_VERSION: "jmikola/[email protected]"
 
 jobs:
   psalm:

.github/workflows/tests.yml

@@ -14,7 +14,9 @@ on:
 env:
   # TODO: change to "stable" once 2.0.0 is released
   # DRIVER_VERSION: "stable"
-  DRIVER_VERSION: "mongodb/[email protected]"
+  # TODO: change to "mongodb/[email protected]" once mongodb/mongo-php-driver#1790 is merged
+  # DRIVER_VERSION: "mongodb/[email protected]"
+  DRIVER_VERSION: "jmikola/[email protected]"
 
 jobs:
   phpunit:

psalm-baseline.xml

@@ -235,6 +235,12 @@
       <code><![CDATA[$pipeline]]></code>
     </PossiblyInvalidArgument>
   </file>
+  <file src="src/ClientBulkWrite.php">
+    <PossiblyInvalidArgument>
+      <code><![CDATA[$document]]></code>
+      <code><![CDATA[$replacement]]></code>
+    </PossiblyInvalidArgument>
+  </file>
   <file src="src/Codec/EncodeIfSupported.php">
     <ArgumentTypeCoercion>
       <code><![CDATA[$value]]></code>
@@ -545,6 +551,14 @@
       <code><![CDATA[$args[2]]]></code>
     </MixedOperand>
   </file>
+  <file src="src/Operation/ClientBulkWriteCommand.php">
+    <MixedMethodCall>
+      <code><![CDATA[isInTransaction]]></code>
+    </MixedMethodCall>
+    <MixedReturnStatement>
+      <code><![CDATA[$server->executeBulkWriteCommand($this->bulkWriteCommand, $options)]]></code>
+    </MixedReturnStatement>
+  </file>
   <file src="src/Operation/Count.php">
     <MixedAssignment>
       <code><![CDATA[$cmd[$option]]]></code>

psalm.xml.dist

@@ -20,6 +20,9 @@
     </projectFiles>
 
     <stubs>
+        <file name="stubs/Driver/BulkWriteCommand.stub.php"/>
+        <file name="stubs/Driver/BulkWriteCommandException.stub.php"/>
+        <file name="stubs/Driver/BulkWriteCommandResult.stub.php"/>
         <file name="stubs/Driver/Cursor.stub.php"/>
         <file name="stubs/Driver/CursorInterface.stub.php"/>
         <file name="stubs/Driver/WriteResult.stub.php"/>

src/Client.php

@@ -24,6 +24,8 @@
 use MongoDB\Builder\BuilderEncoder;
 use MongoDB\Builder\Pipeline;
 use MongoDB\Codec\Encoder;
+use MongoDB\Driver\BulkWriteCommand;
+use MongoDB\Driver\BulkWriteCommandResult;
 use MongoDB\Driver\ClientEncryption;
 use MongoDB\Driver\Exception\InvalidArgumentException as DriverInvalidArgumentException;
 use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
@@ -39,6 +41,7 @@
 use MongoDB\Model\BSONArray;
 use MongoDB\Model\BSONDocument;
 use MongoDB\Model\DatabaseInfo;
+use MongoDB\Operation\ClientBulkWriteCommand;
 use MongoDB\Operation\DropDatabase;
 use MongoDB\Operation\ListDatabaseNames;
 use MongoDB\Operation\ListDatabases;
@@ -189,6 +192,32 @@ final public function addSubscriber(Subscriber $subscriber): void
         $this->manager->addSubscriber($subscriber);
     }
 
+    /**
+     * Executes multiple write operations across multiple namespaces.
+     *
+     * @param BulkWriteCommand|ClientBulkWrite $bulk    Assembled bulk write command or builder
+     * @param array                            $options Additional options
+     * @throws UnsupportedException if options are unsupported on the selected server
+     * @throws InvalidArgumentException for parameter/option parsing errors
+     * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
+     * @see ClientBulkWriteCommand::__construct() for supported options
+     */
+    public function bulkWrite(BulkWriteCommand|ClientBulkWrite $bulk, array $options = []): BulkWriteCommandResult
+    {
+        if (! isset($options['writeConcern']) && ! is_in_transaction($options)) {
+            $options['writeConcern'] = $this->writeConcern;
+        }
+
+        if ($bulk instanceof ClientBulkWrite) {
+            $bulk = $bulk->bulkWriteCommand;
+        }
+
+        $operation = new ClientBulkWriteCommand($bulk, $options);
+        $server = select_server_for_write($this->manager, $options);
+
+        return $operation->execute($server);
+    }
+
     /**
      * Returns a ClientEncryption instance for explicit encryption and decryption
      *