PHPC-1989: Fix missing fields in CommandSucceededEvent debug output (#1266)

* PHPC-1989: Fix missing fields in CommandSucceededEvent debug output

Add debug output tests for APM event classes.

* Rename tests for APM event classes

Author: jmikola

src/MongoDB/Monitoring/CommandSucceededEvent.c

@@ -248,7 +248,7 @@ static HashTable* php_phongo_commandsucceededevent_get_debug_info(phongo_compat_
 	sprintf(operation_id, "%" PRIu64, intern->operation_id);
 	ADD_ASSOC_STRING(&retval, "operationId", operation_id);
 
-	if (php_phongo_bson_to_zval_ex(bson_get_data(intern->reply), intern->reply->len, &reply_state)) {
+	if (!php_phongo_bson_to_zval_ex(bson_get_data(intern->reply), intern->reply->len, &reply_state)) {
 		zval_ptr_dtor(&reply_state.zchild);
 		goto done;
 	}

tests/apm/monitoring-commandFailed-001.phpt renamed to tests/apm/commandFailedEvent-001.phpt

@@ -0,0 +1,66 @@
+--TEST--
+MongoDB\Driver\Monitoring\CommandFailedEvent debug output
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_live(); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+class MySubscriber implements MongoDB\Driver\Monitoring\CommandSubscriber
+{
+    public function commandStarted(MongoDB\Driver\Monitoring\CommandStartedEvent $event)
+    {
+    }
+
+    public function commandSucceeded(MongoDB\Driver\Monitoring\CommandSucceededEvent $event)
+    {
+    }
+
+    public function commandFailed(MongoDB\Driver\Monitoring\CommandFailedEvent $event)
+    {
+        var_dump($event);
+    }
+}
+
+$manager = create_test_manager();
+$manager->addSubscriber(new MySubscriber);
+
+$command = new MongoDB\Driver\Command([
+    'aggregate' => COLLECTION_NAME,
+    'pipeline' => [['$unsupported' => 1]],
+]);
+
+/* Note: Although executeCommand() throws a CommandException, CommandFailedEvent
+ * will report a ServerException for its "error" property (PHPC-1990) */
+throws(function() use ($manager, $command) {
+    $manager->executeCommand(DATABASE_NAME, $command);
+}, MongoDB\Driver\Exception\CommandException::class);
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+object(MongoDB\Driver\Monitoring\CommandFailedEvent)#%d (%d) {
+  ["commandName"]=>
+  string(9) "aggregate"
+  ["durationMicros"]=>
+  int(%d)
+  ["error"]=>
+  object(MongoDB\Driver\Exception\ServerException)#%d (%d) {%A
+  }
+  ["operationId"]=>
+  string(%d) "%d"
+  ["reply"]=>
+  object(stdClass)#%d (%d) {%A
+  }
+  ["requestId"]=>
+  string(%d) "%d"
+  ["server"]=>
+  object(MongoDB\Driver\Server)#%d (%d) {%A
+  }
+  ["serviceId"]=>
+  %r(NULL|object\(MongoDB\\BSON\\ObjectId\).*)%r
+}
+OK: Got MongoDB\Driver\Exception\CommandException
+===DONE===

tests/apm/monitoring-commandFailed-002.phpt renamed to tests/apm/commandFailedEvent-002.phpt

@@ -1,5 +1,5 @@
 --TEST--
-MongoDB\Driver\Monitoring\CommandFailedEvent
+MongoDB\Driver\Monitoring\CommandFailedEvent::getReply()
 --SKIPIF--
 <?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
 <?php skip_if_not_live(); ?>

tests/apm/commandFailedEvent-debug-001.phpt

@@ -0,0 +1,53 @@
+--TEST--
+MongoDB\Driver\Monitoring\CommandStartedEvent debug output
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_live(); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+class MySubscriber implements MongoDB\Driver\Monitoring\CommandSubscriber
+{
+    public function commandStarted(MongoDB\Driver\Monitoring\CommandStartedEvent $event)
+    {
+        var_dump($event);
+    }
+
+    public function commandSucceeded(MongoDB\Driver\Monitoring\CommandSucceededEvent $event)
+    {
+    }
+
+    public function commandFailed(MongoDB\Driver\Monitoring\CommandFailedEvent $event)
+    {
+    }
+}
+
+$manager = create_test_manager();
+$manager->addSubscriber(new MySubscriber);
+
+$manager->executeCommand(DATABASE_NAME, new MongoDB\Driver\Command(['ping' => 1]));
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+object(MongoDB\Driver\Monitoring\CommandStartedEvent)#%d (%d) {
+  ["command"]=>
+  object(stdClass)#%d (%d) {%A
+  }
+  ["commandName"]=>
+  string(4) "ping"
+  ["databaseName"]=>
+  string(%d) "%s"
+  ["operationId"]=>
+  string(%d) "%d"
+  ["requestId"]=>
+  string(%d) "%d"
+  ["server"]=>
+  object(MongoDB\Driver\Server)#%d (%d) {%A
+  }
+  ["serviceId"]=>
+  %r(NULL|object\(MongoDB\\BSON\\ObjectId\).*)%r
+}
+===DONE===

tests/apm/monitoring-commandFailed-003.phpt renamed to tests/apm/commandFailedEvent-getReply-001.phpt

@@ -0,0 +1,53 @@
+--TEST--
+MongoDB\Driver\Monitoring\CommandSucceededEvent debug output
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_live(); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+class MySubscriber implements MongoDB\Driver\Monitoring\CommandSubscriber
+{
+    public function commandStarted(MongoDB\Driver\Monitoring\CommandStartedEvent $event)
+    {
+    }
+
+    public function commandSucceeded(MongoDB\Driver\Monitoring\CommandSucceededEvent $event)
+    {
+        var_dump($event);
+    }
+
+    public function commandFailed(MongoDB\Driver\Monitoring\CommandFailedEvent $event)
+    {
+    }
+}
+
+$manager = create_test_manager();
+$manager->addSubscriber(new MySubscriber);
+
+$manager->executeCommand(DATABASE_NAME, new MongoDB\Driver\Command(['ping' => 1]));
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+object(MongoDB\Driver\Monitoring\CommandSucceededEvent)#%d (%d) {
+  ["commandName"]=>
+  string(4) "ping"
+  ["durationMicros"]=>
+  int(%d)
+  ["operationId"]=>
+  string(%d) "%d"
+  ["reply"]=>
+  object(stdClass)#%d (%d) {%A
+  }
+  ["requestId"]=>
+  string(%d) "%d"
+  ["server"]=>
+  object(MongoDB\Driver\Server)#%d (%d) {%A
+  }
+  ["serviceId"]=>
+  %r(NULL|object\(MongoDB\\BSON\\ObjectId\).*)%r
+}
+===DONE===