PHPC-1290: Expose pinned server on session object

Author: alcaeus

src/MongoDB/Session.c

@@ -234,6 +234,30 @@ static PHP_METHOD(Session, getOperationTime)
 	php_phongo_new_timestamp_from_increment_and_timestamp(return_value, increment, timestamp TSRMLS_CC);
 } /* }}} */
 
+/* {{{ proto MongoDB\Driver\Server|null MongoDB\Driver\Session::getServer()
+   Returns the server this session is pinned to */
+static PHP_METHOD(Session, getServer)
+{
+	php_phongo_session_t* intern;
+	uint32_t              server_id = 0;
+
+	intern = Z_SESSION_OBJ_P(getThis());
+	SESSION_CHECK_LIVELINESS(intern, "getServer")
+
+	if (zend_parse_parameters_none() == FAILURE) {
+		return;
+	}
+
+	server_id = mongoc_client_session_get_server_id(intern->client_session);
+
+	/* For sessions without a pinned server, 0 is returned. */
+	if (!server_id) {
+	    RETURN_NULL();
+	}
+
+	phongo_server_init(return_value, mongoc_client_session_get_client(intern->client_session), server_id TSRMLS_CC);
+} /* }}} */
+
 /* Creates a opts structure from an array optionally containing an RP, RC,
  * WC object, and/or maxCommitTimeMS int. Returns NULL if no options were found,
  * or there was an invalid option. If there was an invalid option or structure,
@@ -461,6 +485,7 @@ static zend_function_entry php_phongo_session_me[] = {
 	PHP_ME(Session, getClusterTime, ai_Session_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Session, getLogicalSessionId, ai_Session_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Session, getOperationTime, ai_Session_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_ME(Session, getServer, ai_Session_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Session, isInTransaction, ai_Session_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Session, startTransaction, ai_Session_startTransaction, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	ZEND_NAMED_ME(__construct, PHP_FN(MongoDB_disabled___construct), ai_Session_void, ZEND_ACC_PRIVATE | ZEND_ACC_FINAL)
@@ -601,6 +626,30 @@ static HashTable* php_phongo_session_get_debug_info(zval* object, int* is_temp T
 		ADD_ASSOC_NULL_EX(&retval, "operationTime");
 	}
 
+	if (intern->client_session) {
+		uint32_t server_id = mongoc_client_session_get_server_id(intern->client_session);
+
+		if (server_id) {
+
+#if PHP_VERSION_ID >= 70000
+			zval server;
+
+			phongo_server_init(&server, mongoc_client_session_get_client(intern->client_session), server_id TSRMLS_CC);
+			ADD_ASSOC_ZVAL_EX(&retval, "server", &server);
+#else
+			zval* server = NULL;
+
+			MAKE_STD_ZVAL(server);
+			phongo_server_init(server, mongoc_client_session_get_client(intern->client_session), server_id TSRMLS_CC);
+			ADD_ASSOC_ZVAL_EX(&retval, "server", server);
+#endif
+		} else {
+			ADD_ASSOC_NULL_EX(&retval, "server");
+		}
+	} else {
+		ADD_ASSOC_NULL_EX(&retval, "server");
+	}
+
 	return Z_ARRVAL(retval);
 } /* }}} */
 /* }}} */

tests/session/session-debug-001.phpt

@@ -35,5 +35,7 @@ object(MongoDB\Driver\Session)#%d (%d) {
   bool(true)
   ["operationTime"]=>
   NULL
+  ["server"]=>
+  NULL
 }
 ===DONE===

tests/session/session-debug-002.phpt

@@ -53,5 +53,7 @@ object(MongoDB\Driver\Session)#%d (%d) {
     ["timestamp"]=>
     string(%d) "%d"
   }
+  ["server"]=>
+  NULL
 }
 ===DONE===

tests/session/session-debug-003.phpt

@@ -35,5 +35,7 @@ object(MongoDB\Driver\Session)#%d (%d) {
   bool(false)
   ["operationTime"]=>
   NULL
+  ["server"]=>
+  NULL
 }
 ===DONE===

tests/session/session-debug-004.phpt

@@ -32,5 +32,7 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["operationTime"]=>
   NULL
+  ["server"]=>
+  NULL
 }
 ===DONE===

tests/session/session-debug-005.phpt

@@ -0,0 +1,67 @@
+--TEST--
+MongoDB\Driver\Session debug output (during a pinned transaction)
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_mongos_with_replica_set(); ?>
+<?php skip_if_server_version('<', '4.1.6'); ?>
+<?php skip_if_not_clean(); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+$manager = new MongoDB\Driver\Manager(URI);
+$server = $manager->selectServer(new \MongoDB\Driver\ReadPreference('primary'));
+
+$session = $manager->startSession();
+$session->startTransaction();
+
+$query = new MongoDB\Driver\Query([]);
+$server->executeQuery(NS, $query, ['session' => $session]);
+
+var_dump($session);
+
+$session->abortTransaction();
+$session->endSession();
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+object(MongoDB\Driver\Session)#%d (%d) {
+  ["logicalSessionId"]=>
+  array(1) {
+    ["id"]=>
+    object(MongoDB\BSON\Binary)#%d (%d) {
+      ["data"]=>
+      string(16) "%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c"
+      ["type"]=>
+      int(4)
+    }
+  }
+  ["clusterTime"]=>
+  array(2) {
+    ["clusterTime"]=>
+    object(MongoDB\BSON\Timestamp)#%d (%d) {
+      ["increment"]=>
+      string(%d) "%d"
+      ["timestamp"]=>
+      string(%d) "%d"
+    }
+    ["signature"]=>
+    %a
+  }
+  ["causalConsistency"]=>
+  bool(true)
+  ["operationTime"]=>
+  object(MongoDB\BSON\Timestamp)#%d (%d) {
+    ["increment"]=>
+    string(%d) "%d"
+    ["timestamp"]=>
+    string(%d) "%d"
+  }
+  ["server"]=>
+  object(MongoDB\Driver\Server)#%d (%d) {
+    %a
+  }
+}
+===DONE===