PHPC-684: Report bypassDocumentValidation in BulkWrite debug output

Author: jmikola

php_phongo_structs-5.h

@@ -89,6 +89,7 @@ typedef struct {
 	mongoc_bulk_operation_t *bulk;
 	size_t                   num_ops;
 	bool                     ordered;
+	int                      bypass;
 	char                    *database;
 	char                    *collection;
 	bool                     executed;

php_phongo_structs-7.h

@@ -88,6 +88,7 @@ typedef struct {
 	mongoc_bulk_operation_t *bulk;
 	size_t                   num_ops;
 	bool                     ordered;
+	int                      bypass;
 	char                    *database;
 	char                    *collection;
 	bool                     executed;

src/MongoDB/BulkWrite.c

@@ -46,6 +46,7 @@
 #include "php_phongo.h"
 #include "php_bson.h"
 
+#define BYPASS_UNSET -1
 
 PHONGO_API zend_class_entry *php_phongo_bulkwrite_ce;
 
@@ -77,10 +78,13 @@ PHP_METHOD(BulkWrite, __construct)
 
 	intern->bulk = phongo_bulkwrite_init(ordered);
 	intern->ordered = ordered;
+	intern->bypass = BYPASS_UNSET;
 	intern->num_ops = 0;
 
 	if (options && php_array_exists(options, "bypassDocumentValidation")) {
-		mongoc_bulk_operation_set_bypass_document_validation(intern->bulk, php_array_fetch_bool(options, "bypassDocumentValidation"));
+		zend_bool bypass = php_array_fetch_bool(options, "bypassDocumentValidation");
+		mongoc_bulk_operation_set_bypass_document_validation(intern->bulk, bypass);
+		intern->bypass = bypass;
 	}
 }
 /* }}} */
@@ -351,6 +355,13 @@ HashTable *php_phongo_bulkwrite_get_debug_info(zval *object, int *is_temp TSRMLS
 	}
 
 	ADD_ASSOC_BOOL_EX(&retval, "ordered", intern->ordered);
+
+	if (intern->bypass != BYPASS_UNSET) {
+		ADD_ASSOC_BOOL_EX(&retval, "bypassDocumentValidation", intern->bypass);
+	} else {
+		ADD_ASSOC_NULL_EX(&retval, "bypassDocumentValidation");
+	}
+
 	ADD_ASSOC_BOOL_EX(&retval, "executed", intern->executed);
 	ADD_ASSOC_LONG_EX(&retval, "server_id", mongoc_bulk_operation_get_hint(intern->bulk));
 

tests/bulk/bulkwrite-debug-001.phpt

@@ -0,0 +1,105 @@
+--TEST--
+MongoDB\Driver\BulkWrite debug output before execution
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+$tests = [
+    [],
+    ['ordered' => true],
+    ['ordered' => false],
+    ['bypassDocumentValidation' => true],
+    ['bypassDocumentValidation' => false],
+];
+
+foreach ($tests as $options) {
+    var_dump(new MongoDB\Driver\BulkWrite($options));
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+object(MongoDB\Driver\BulkWrite)#%d (%d) {
+  ["database"]=>
+  NULL
+  ["collection"]=>
+  NULL
+  ["ordered"]=>
+  bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
+  ["executed"]=>
+  bool(false)
+  ["server_id"]=>
+  int(0)
+  ["write_concern"]=>
+  NULL
+}
+object(MongoDB\Driver\BulkWrite)#%d (%d) {
+  ["database"]=>
+  NULL
+  ["collection"]=>
+  NULL
+  ["ordered"]=>
+  bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
+  ["executed"]=>
+  bool(false)
+  ["server_id"]=>
+  int(0)
+  ["write_concern"]=>
+  NULL
+}
+object(MongoDB\Driver\BulkWrite)#%d (%d) {
+  ["database"]=>
+  NULL
+  ["collection"]=>
+  NULL
+  ["ordered"]=>
+  bool(false)
+  ["bypassDocumentValidation"]=>
+  NULL
+  ["executed"]=>
+  bool(false)
+  ["server_id"]=>
+  int(0)
+  ["write_concern"]=>
+  NULL
+}
+object(MongoDB\Driver\BulkWrite)#%d (%d) {
+  ["database"]=>
+  NULL
+  ["collection"]=>
+  NULL
+  ["ordered"]=>
+  bool(true)
+  ["bypassDocumentValidation"]=>
+  bool(true)
+  ["executed"]=>
+  bool(false)
+  ["server_id"]=>
+  int(0)
+  ["write_concern"]=>
+  NULL
+}
+object(MongoDB\Driver\BulkWrite)#%d (%d) {
+  ["database"]=>
+  NULL
+  ["collection"]=>
+  NULL
+  ["ordered"]=>
+  bool(true)
+  ["bypassDocumentValidation"]=>
+  bool(false)
+  ["executed"]=>
+  bool(false)
+  ["server_id"]=>
+  int(0)
+  ["write_concern"]=>
+  NULL
+}
+===DONE===

tests/bulk/write-0001.phpt

@@ -45,6 +45,8 @@ object(MongoDB\Driver\BulkWrite)#%d (%d) {
   NULL
   ["ordered"]=>
   bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
   ["executed"]=>
   bool(false)
   ["server_id"]=>
@@ -59,6 +61,8 @@ object(MongoDB\Driver\BulkWrite)#%d (%d) {
   NULL
   ["ordered"]=>
   bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
   ["executed"]=>
   bool(false)
   ["server_id"]=>
@@ -73,6 +77,8 @@ object(MongoDB\Driver\BulkWrite)#%d (%d) {
   NULL
   ["ordered"]=>
   bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
   ["executed"]=>
   bool(false)
   ["server_id"]=>
@@ -87,6 +93,8 @@ object(MongoDB\Driver\BulkWrite)#%d (%d) {
   NULL
   ["ordered"]=>
   bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
   ["executed"]=>
   bool(false)
   ["server_id"]=>
@@ -101,6 +109,8 @@ object(MongoDB\Driver\BulkWrite)#%d (%d) {
   string(15) "bulk_write_0001"
   ["ordered"]=>
   bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
   ["executed"]=>
   bool(true)
   ["server_id"]=>

tests/bulk/write-0002.phpt

@@ -41,6 +41,8 @@ object(MongoDB\Driver\BulkWrite)#%d (%d) {
   NULL
   ["ordered"]=>
   bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
   ["executed"]=>
   bool(false)
   ["server_id"]=>
@@ -55,6 +57,8 @@ object(MongoDB\Driver\BulkWrite)#%d (%d) {
   string(15) "bulk_write_0002"
   ["ordered"]=>
   bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
   ["executed"]=>
   bool(true)
   ["server_id"]=>