PHPC-2478: Implement API for bulkWrite command (#1790)

* PHPC-2495, PHPC-2490, PHPC-2491, PHPC-2492: BulkWriteCommand ctor and ops

* PHPC-2494: BulkWriteCommandResult and BulkWriteCommandException

It was possible to reuse WriteConcernError and WriteError with slight changes to their init functions.

* Include missing header in WriteResult.h

This was not necessary for compilation, but it makes the header internally consistent.

* PHPC-2493: Manager and Server::executeBulkWriteCommand()

* PHPC-2494: Handle null error fields in BulkWriteCommandResult

Always return arrays for writeErrors and writeConcernErrors

* PHPC-2494: Return writeErrors as an associative array

* PHPC-2493: Revise error handling for mongoc_bulkwrite_execute

* Consistent WriteError and WriteConcernError parsing for bulk write results

* BulkWriteCommand tests

* clang-format

* Remove BulkWriteCommandResult::getServer()

Per CDRIVER-5843, libmongoc does not consistently populate this field. It also isn't required by the spec, so omit it for now.

* Check for _id extraction before appending insert

* Regenerate BulkWriteCommandException arginfo

* PHPC-2493: Relocate writeConcern option to executeBulkWriteCommand()

* Parse sort option for replaceOne and updateOne

* BulkWriteCommand::replaceOne() need not accept root-level arrays

* Preserve empty documents for verbose results and error reply

Result maps should only be null if verboseResults=false. Additionally, the error reply document can default to an empty document on error (as it is in libmongoc).

* PHPC-2494: Relocate error fields to BulkWriteCommandException

Revise the stubs to reflect that executeBulkWriteCommand() always returns a BulkWriteCommandResult. If the result is unacknowledged, that is reported via isAcknowledged() and other methods can throw, which is consistent with WriteResult for the legacy bulk write API.

If the result is empty on error (i.e. no writes were successful), BulkWriteCommandException::$partialResult is left unset.

* Throw BulkWriteCommandException directly for server errors

This also ensures that BulkWriteCommandException uses the original server-side error code and message (if available) for top-level errors.

* Check for empty error_reply instead of NULL

mongoc_bulkwriteexception_errorreply() always returns an initialized document, but it may be empty. This ensures that an InvalidArgumentException is not unnecessarily proxied behind a BulkWriteCommandException.

Author: jmikola

config.m4

@@ -167,6 +167,8 @@ if test "$PHP_MONGODB" != "no"; then
     src/BSON/UTCDateTime.c \
     src/BSON/UTCDateTimeInterface.c \
     src/MongoDB/BulkWrite.c \
+    src/MongoDB/BulkWriteCommand.c \
+    src/MongoDB/BulkWriteCommandResult.c \
     src/MongoDB/ClientEncryption.c \
     src/MongoDB/Command.c \
     src/MongoDB/Cursor.c \
@@ -186,6 +188,7 @@ if test "$PHP_MONGODB" != "no"; then
     src/MongoDB/WriteResult.c \
     src/MongoDB/Exception/AuthenticationException.c \
     src/MongoDB/Exception/BulkWriteException.c \
+    src/MongoDB/Exception/BulkWriteCommandException.c \
     src/MongoDB/Exception/CommandException.c \
     src/MongoDB/Exception/ConnectionException.c \
     src/MongoDB/Exception/ConnectionTimeoutException.c \

config.w32

@@ -116,8 +116,8 @@ if (PHP_MONGODB != "no") {
   EXTENSION("mongodb", "php_phongo.c", null, PHP_MONGODB_CFLAGS);
   MONGODB_ADD_SOURCES("/src", "phongo_apm.c phongo_atomic.c phongo_bson.c phongo_bson_encode.c phongo_client.c phongo_compat.c phongo_error.c phongo_execute.c phongo_ini.c phongo_log.c phongo_util.c");
   MONGODB_ADD_SOURCES("/src/BSON", "Binary.c BinaryInterface.c Document.c Iterator.c DBPointer.c Decimal128.c Decimal128Interface.c Int64.c Javascript.c JavascriptInterface.c MaxKey.c MaxKeyInterface.c MinKey.c MinKeyInterface.c ObjectId.c ObjectIdInterface.c PackedArray.c Persistable.c Regex.c RegexInterface.c Serializable.c Symbol.c Timestamp.c TimestampInterface.c Type.c Undefined.c Unserializable.c UTCDateTime.c UTCDateTimeInterface.c");
-  MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c ClientEncryption.c Command.c Cursor.c CursorInterface.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c ServerApi.c ServerDescription.c Session.c TopologyDescription.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c");
-  MONGODB_ADD_SOURCES("/src/MongoDB/Exception", "AuthenticationException.c BulkWriteException.c CommandException.c ConnectionException.c ConnectionTimeoutException.c EncryptionException.c Exception.c ExecutionTimeoutException.c InvalidArgumentException.c LogicException.c RuntimeException.c ServerException.c UnexpectedValueException.c");
+  MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c BulkWriteCommand.c BulkWriteCommandResult.c ClientEncryption.c Command.c Cursor.c CursorInterface.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c ServerApi.c ServerDescription.c Session.c TopologyDescription.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c");
+  MONGODB_ADD_SOURCES("/src/MongoDB/Exception", "AuthenticationException.c BulkWriteException.c BulkWriteCommandException.c CommandException.c ConnectionException.c ConnectionTimeoutException.c EncryptionException.c Exception.c ExecutionTimeoutException.c InvalidArgumentException.c LogicException.c RuntimeException.c ServerException.c UnexpectedValueException.c");
   MONGODB_ADD_SOURCES("/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c LogSubscriber.c SDAMSubscriber.c Subscriber.c ServerChangedEvent.c ServerClosedEvent.c ServerHeartbeatFailedEvent.c ServerHeartbeatStartedEvent.c ServerHeartbeatSucceededEvent.c ServerOpeningEvent.c TopologyChangedEvent.c TopologyClosedEvent.c TopologyOpeningEvent.c functions.c");
   MONGODB_ADD_SOURCES("/src/libmongoc/src/common/src", PHP_MONGODB_COMMON_SOURCES);
   MONGODB_ADD_SOURCES("/src/libmongoc/src/libbson/src/bson", PHP_MONGODB_BSON_SOURCES);

php_phongo.c

@@ -252,6 +252,8 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 	php_phongo_cursor_interface_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 
 	php_phongo_bulkwrite_init_ce(INIT_FUNC_ARGS_PASSTHRU);
+	php_phongo_bulkwritecommand_init_ce(INIT_FUNC_ARGS_PASSTHRU);
+	php_phongo_bulkwritecommandresult_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_clientencryption_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_command_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_cursor_init_ce(INIT_FUNC_ARGS_PASSTHRU);
@@ -277,6 +279,7 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 
 	php_phongo_authenticationexception_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_bulkwriteexception_init_ce(INIT_FUNC_ARGS_PASSTHRU);
+	php_phongo_bulkwritecommandexception_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_commandexception_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_connectiontimeoutexception_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_encryptionexception_init_ce(INIT_FUNC_ARGS_PASSTHRU);