Rename Logger to LogSubscriber and integrate with Monitoring API

Author: jmikola

bin/prep-release.php

@@ -44,7 +44,6 @@ function get_files() {
 
         "src/MongoDB/*.{c,h}",
         "src/MongoDB/Exception/*.{c,h}",
-        "src/MongoDB/Logging/*.{c,h}",
         "src/MongoDB/Monitoring/*.{c,h}",
         "src/BSON/*.{c,h}",
         "src/contrib/*.{c,h}",

config.m4

@@ -186,12 +186,11 @@ if test "$PHP_MONGODB" != "no"; then
     src/MongoDB/Exception/SSLConnectionException.c \
     src/MongoDB/Exception/UnexpectedValueException.c \
     src/MongoDB/Exception/WriteException.c \
-    src/MongoDB/Logging/Logger.c \
-    src/MongoDB/Logging/functions.c \
     src/MongoDB/Monitoring/CommandFailedEvent.c \
     src/MongoDB/Monitoring/CommandStartedEvent.c \
     src/MongoDB/Monitoring/CommandSubscriber.c \
     src/MongoDB/Monitoring/CommandSucceededEvent.c \
+    src/MongoDB/Monitoring/LogSubscriber.c \
     src/MongoDB/Monitoring/SDAMSubscriber.c \
     src/MongoDB/Monitoring/Subscriber.c \
     src/MongoDB/Monitoring/ServerChangedEvent.c \
@@ -544,15 +543,13 @@ if test "$PHP_MONGODB" != "no"; then
   PHP_ADD_INCLUDE(PHP_EXT_SRCDIR(mongodb)[/src/BSON/])
   PHP_ADD_INCLUDE(PHP_EXT_SRCDIR(mongodb)[/src/MongoDB/])
   PHP_ADD_INCLUDE(PHP_EXT_SRCDIR(mongodb)[/src/MongoDB/Exception/])
-  PHP_ADD_INCLUDE(PHP_EXT_SRCDIR(mongodb)[/src/MongoDB/Logging/])
   PHP_ADD_INCLUDE(PHP_EXT_SRCDIR(mongodb)[/src/MongoDB/Monitoring/])
   PHP_ADD_INCLUDE(PHP_EXT_SRCDIR(mongodb)[/src/contrib/])
 
   PHP_ADD_BUILD_DIR(PHP_EXT_BUILDDIR(mongodb)[/src/])
   PHP_ADD_BUILD_DIR(PHP_EXT_BUILDDIR(mongodb)[/src/BSON/])
   PHP_ADD_BUILD_DIR(PHP_EXT_BUILDDIR(mongodb)[/src/MongoDB/])
   PHP_ADD_BUILD_DIR(PHP_EXT_BUILDDIR(mongodb)[/src/MongoDB/Exception/])
-  PHP_ADD_BUILD_DIR(PHP_EXT_BUILDDIR(mongodb)[/src/MongoDB/Logging/])
   PHP_ADD_BUILD_DIR(PHP_EXT_BUILDDIR(mongodb)[/src/MongoDB/Monitoring/])
   PHP_ADD_BUILD_DIR(PHP_EXT_BUILDDIR(mongodb)[/src/contrib/])
 

config.w32

@@ -91,7 +91,6 @@ if (PHP_MONGODB != "no") {
     /I" + configure_module_dirname + "/src/BSON \
     /I" + configure_module_dirname + "/src/MongoDB \
     /I" + configure_module_dirname + "/src/MongoDB/Exception \
-    /I" + configure_module_dirname + "/src/MongoDB/Logging \
     /I" + configure_module_dirname + "/src/MongoDB/Monitoring \
     /I" + configure_module_dirname + "/src/contrib \
     /I" + configure_module_dirname + "/src/libmongoc/src/common \
@@ -128,8 +127,7 @@ if (PHP_MONGODB != "no") {
   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 functions.c");
   MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c ClientEncryption.c Command.c Cursor.c CursorId.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 SSLConnectionException.c UnexpectedValueException.c WriteException.c");
-  MONGODB_ADD_SOURCES("/src/MongoDB/Logging", "Logger.c functions.c");
-  MONGODB_ADD_SOURCES("/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.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/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", PHP_MONGODB_COMMON_SOURCES);
   MONGODB_ADD_SOURCES("/src/libmongoc/src/libbson/src/bson", PHP_MONGODB_BSON_SOURCES);
   MONGODB_ADD_SOURCES("/src/libmongoc/src/libbson/src/jsonsl", PHP_MONGODB_JSONSL_SOURCES);

php_phongo.c

@@ -282,14 +282,13 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 	php_phongo_sslconnectionexception_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_unexpectedvalueexception_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 
-	php_phongo_logger_init_ce(INIT_FUNC_ARGS_PASSTHRU);
-
 	/* Register base APM classes first */
 	php_phongo_subscriber_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_commandsubscriber_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_commandfailedevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_commandstartedevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_commandsucceededevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
+	php_phongo_logsubscriber_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_sdamsubscriber_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_serverchangedevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_serverclosedevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);

src/MongoDB/Logging/functions.c

@@ -304,6 +304,8 @@ static PHP_METHOD(MongoDB_Driver_Manager, addSubscriber)
 		zend_hash_init(intern->subscribers, 0, NULL, ZVAL_PTR_DTOR, 0);
 	}
 
+	// TODO: Consider throwing if subscriber is unsupported (see: PHPC-2289)
+
 	phongo_apm_add_subscriber(intern->subscribers, subscriber);
 }
 

src/MongoDB/Manager.c

@@ -19,11 +19,11 @@
 #include <php.h>
 
 #include "php_phongo.h"
-#include "Logger_arginfo.h"
+#include "LogSubscriber_arginfo.h"
 
-zend_class_entry* php_phongo_logger_ce;
+zend_class_entry* php_phongo_logsubscriber_ce;
 
-void php_phongo_logger_init_ce(INIT_FUNC_ARGS)
+void php_phongo_logsubscriber_init_ce(INIT_FUNC_ARGS)
 {
-	php_phongo_logger_ce = register_class_MongoDB_Driver_Logging_Logger();
+	php_phongo_logsubscriber_ce = register_class_MongoDB_Driver_Monitoring_LogSubscriber(php_phongo_subscriber_ce);
 }

src/MongoDB/Logging/Logger.c renamed to src/MongoDB/Monitoring/LogSubscriber.c

@@ -5,51 +5,49 @@
  * @generate-function-entries
  */
 
-namespace MongoDB\Driver\Logging;
+namespace MongoDB\Driver\Monitoring;
 
-interface Logger
+interface LogSubscriber extends Subscriber
 {
     /**
      * @var int
      * @cvalue MONGOC_LOG_LEVEL_ERROR
      */
-    public const LEVEL_ERROR = UNKNOWN;
+    public const LEVEL_ERROR = 0;
 
     /**
      * @var int
      * @cvalue MONGOC_LOG_LEVEL_CRITICAL
      */
-    public const LEVEL_CRITICAL = UNKNOWN;
+    public const LEVEL_CRITICAL = 1;
 
     /**
      * @var int
      * @cvalue MONGOC_LOG_LEVEL_WARNING
      */
-    public const LEVEL_WARNING = UNKNOWN;
+    public const LEVEL_WARNING = 2;
 
     /**
      * @var int
      * @cvalue MONGOC_LOG_LEVEL_MESSAGE
      */
-    public const LEVEL_MESSAGE = UNKNOWN;
+    public const LEVEL_MESSAGE = 3;
 
     /**
      * @var int
      * @cvalue MONGOC_LOG_LEVEL_INFO
      */
-    public const LEVEL_INFO = UNKNOWN;
+    public const LEVEL_INFO = 4;
 
     /**
      * @var int
      * @cvalue MONGOC_LOG_LEVEL_DEBUG
      */
-    public const LEVEL_DEBUG = UNKNOWN;
+    public const LEVEL_DEBUG = 5;
 
-    /**
-     * @var int
-     * @cvalue MONGOC_LOG_LEVEL_TRACE
-     */
-    public const LEVEL_TRACE = UNKNOWN;
+    /* MONGOC_LOG_LEVEL_TRACE is intentionally omitted. Trace logs are only
+     * reported via streams (i.e. mongodb.debug INI), so the constant is not
+     * relevant to LogSubscriber implementations. */
 
     public function log(int $level, string $domain, string $message): void;
 }

src/MongoDB/Logging/Logger.stub.php renamed to src/MongoDB/Monitoring/LogSubscriber.stub.php

@@ -1,7 +1,7 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 60e1f5e5c02b6313e39e2890c957e9c2f69d2718 */
+ * Stub hash: 4920ad21bd26ea586d4322d49bf44c9c3530e494 */
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_MongoDB_Driver_Logging_Logger_log, 0, 3, IS_VOID, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_MongoDB_Driver_Monitoring_LogSubscriber_log, 0, 3, IS_VOID, 0)
 	ZEND_ARG_TYPE_INFO(0, level, IS_LONG, 0)
 	ZEND_ARG_TYPE_INFO(0, domain, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, message, IS_STRING, 0)
@@ -10,59 +10,60 @@ ZEND_END_ARG_INFO()
 
 
 
-static const zend_function_entry class_MongoDB_Driver_Logging_Logger_methods[] = {
-	ZEND_ABSTRACT_ME_WITH_FLAGS(MongoDB_Driver_Logging_Logger, log, arginfo_class_MongoDB_Driver_Logging_Logger_log, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
+static const zend_function_entry class_MongoDB_Driver_Monitoring_LogSubscriber_methods[] = {
+	ZEND_ABSTRACT_ME_WITH_FLAGS(MongoDB_Driver_Monitoring_LogSubscriber, log, arginfo_class_MongoDB_Driver_Monitoring_LogSubscriber_log, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
 	ZEND_FE_END
 };
 
-static zend_class_entry *register_class_MongoDB_Driver_Logging_Logger(void)
+static zend_class_entry *register_class_MongoDB_Driver_Monitoring_LogSubscriber(zend_class_entry *class_entry_MongoDB_Driver_Monitoring_Subscriber)
 {
 	zend_class_entry ce, *class_entry;
 
-	INIT_NS_CLASS_ENTRY(ce, "MongoDB\\Driver\\Logging", "Logger", class_MongoDB_Driver_Logging_Logger_methods);
+	INIT_NS_CLASS_ENTRY(ce, "MongoDB\\Driver\\Monitoring", "LogSubscriber", class_MongoDB_Driver_Monitoring_LogSubscriber_methods);
 	class_entry = zend_register_internal_interface(&ce);
+	zend_class_implements(class_entry, 1, class_entry_MongoDB_Driver_Monitoring_Subscriber);
 
 	zval const_LEVEL_ERROR_value;
 	ZVAL_LONG(&const_LEVEL_ERROR_value, MONGOC_LOG_LEVEL_ERROR);
 	zend_string *const_LEVEL_ERROR_name = zend_string_init_interned("LEVEL_ERROR", sizeof("LEVEL_ERROR") - 1, 1);
 	zend_declare_class_constant_ex(class_entry, const_LEVEL_ERROR_name, &const_LEVEL_ERROR_value, ZEND_ACC_PUBLIC, NULL);
 	zend_string_release(const_LEVEL_ERROR_name);
+	ZEND_ASSERT(MONGOC_LOG_LEVEL_ERROR == 0);
 
 	zval const_LEVEL_CRITICAL_value;
 	ZVAL_LONG(&const_LEVEL_CRITICAL_value, MONGOC_LOG_LEVEL_CRITICAL);
 	zend_string *const_LEVEL_CRITICAL_name = zend_string_init_interned("LEVEL_CRITICAL", sizeof("LEVEL_CRITICAL") - 1, 1);
 	zend_declare_class_constant_ex(class_entry, const_LEVEL_CRITICAL_name, &const_LEVEL_CRITICAL_value, ZEND_ACC_PUBLIC, NULL);
 	zend_string_release(const_LEVEL_CRITICAL_name);
+	ZEND_ASSERT(MONGOC_LOG_LEVEL_CRITICAL == 1);
 
 	zval const_LEVEL_WARNING_value;
 	ZVAL_LONG(&const_LEVEL_WARNING_value, MONGOC_LOG_LEVEL_WARNING);
 	zend_string *const_LEVEL_WARNING_name = zend_string_init_interned("LEVEL_WARNING", sizeof("LEVEL_WARNING") - 1, 1);
 	zend_declare_class_constant_ex(class_entry, const_LEVEL_WARNING_name, &const_LEVEL_WARNING_value, ZEND_ACC_PUBLIC, NULL);
 	zend_string_release(const_LEVEL_WARNING_name);
+	ZEND_ASSERT(MONGOC_LOG_LEVEL_WARNING == 2);
 
 	zval const_LEVEL_MESSAGE_value;
 	ZVAL_LONG(&const_LEVEL_MESSAGE_value, MONGOC_LOG_LEVEL_MESSAGE);
 	zend_string *const_LEVEL_MESSAGE_name = zend_string_init_interned("LEVEL_MESSAGE", sizeof("LEVEL_MESSAGE") - 1, 1);
 	zend_declare_class_constant_ex(class_entry, const_LEVEL_MESSAGE_name, &const_LEVEL_MESSAGE_value, ZEND_ACC_PUBLIC, NULL);
 	zend_string_release(const_LEVEL_MESSAGE_name);
+	ZEND_ASSERT(MONGOC_LOG_LEVEL_MESSAGE == 3);
 
 	zval const_LEVEL_INFO_value;
 	ZVAL_LONG(&const_LEVEL_INFO_value, MONGOC_LOG_LEVEL_INFO);
 	zend_string *const_LEVEL_INFO_name = zend_string_init_interned("LEVEL_INFO", sizeof("LEVEL_INFO") - 1, 1);
 	zend_declare_class_constant_ex(class_entry, const_LEVEL_INFO_name, &const_LEVEL_INFO_value, ZEND_ACC_PUBLIC, NULL);
 	zend_string_release(const_LEVEL_INFO_name);
+	ZEND_ASSERT(MONGOC_LOG_LEVEL_INFO == 4);
 
 	zval const_LEVEL_DEBUG_value;
 	ZVAL_LONG(&const_LEVEL_DEBUG_value, MONGOC_LOG_LEVEL_DEBUG);
 	zend_string *const_LEVEL_DEBUG_name = zend_string_init_interned("LEVEL_DEBUG", sizeof("LEVEL_DEBUG") - 1, 1);
 	zend_declare_class_constant_ex(class_entry, const_LEVEL_DEBUG_name, &const_LEVEL_DEBUG_value, ZEND_ACC_PUBLIC, NULL);
 	zend_string_release(const_LEVEL_DEBUG_name);
-
-	zval const_LEVEL_TRACE_value;
-	ZVAL_LONG(&const_LEVEL_TRACE_value, MONGOC_LOG_LEVEL_TRACE);
-	zend_string *const_LEVEL_TRACE_name = zend_string_init_interned("LEVEL_TRACE", sizeof("LEVEL_TRACE") - 1, 1);
-	zend_declare_class_constant_ex(class_entry, const_LEVEL_TRACE_name, &const_LEVEL_TRACE_value, ZEND_ACC_PUBLIC, NULL);
-	zend_string_release(const_LEVEL_TRACE_name);
+	ZEND_ASSERT(MONGOC_LOG_LEVEL_DEBUG == 5);
 
 	return class_entry;
 }