PHPC-2003: Implement Session::isDirty() (#1293)

Author: jmikola

src/MongoDB/Session.c

@@ -587,6 +587,21 @@ static PHP_METHOD(Session, endSession)
 	intern->client_session = NULL;
 } /* }}} */
 
+/* {{{ proto bool MongoDB\Driver\Session::isDirty()
+   Returns whether the session is dirty (i.e. was used with a command that
+   encountered a network error) and will be discarded when returned to the
+   server session pool. */
+static PHP_METHOD(Session, isDirty)
+{
+	php_phongo_session_t* intern = Z_SESSION_OBJ_P(getThis());
+
+	SESSION_CHECK_LIVELINESS(intern, "isDirty")
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	RETVAL_BOOL(mongoc_client_session_get_dirty(intern->client_session));
+} /* }}} */
+
 /* {{{ proto void MongoDB\Driver\Session::isInTransaction(void)
    Returns whether a multi-document transaction is in progress */
 static PHP_METHOD(Session, isInTransaction)
@@ -636,6 +651,7 @@ static zend_function_entry php_phongo_session_me[] = {
 	PHP_ME(Session, getServer, ai_Session_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Session, getTransactionOptions, ai_Session_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Session, getTransactionState, ai_Session_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_ME(Session, isDirty, 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)
@@ -779,6 +795,12 @@ static HashTable* php_phongo_session_get_debug_info(phongo_compat_object_handler
 		ADD_ASSOC_NULL_EX(&retval, "server");
 	}
 
+	if (intern->client_session) {
+		ADD_ASSOC_BOOL_EX(&retval, "dirty", mongoc_client_session_get_dirty(intern->client_session));
+	} else {
+		ADD_ASSOC_NULL_EX(&retval, "dirty");
+	}
+
 	if (intern->client_session) {
 		ADD_ASSOC_BOOL_EX(&retval, "inTransaction", mongoc_client_session_in_transaction(intern->client_session));
 	} else {

tests/session/session-debug-001.phpt

@@ -39,6 +39,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["server"]=>
   NULL
+  ["dirty"]=>
+  bool(false)
   ["inTransaction"]=>
   bool(false)
   ["transactionState"]=>

tests/session/session-debug-002.phpt

@@ -57,6 +57,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   }
   ["server"]=>
   NULL
+  ["dirty"]=>
+  bool(false)
   ["inTransaction"]=>
   bool(false)
   ["transactionState"]=>

tests/session/session-debug-003.phpt

@@ -39,6 +39,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["server"]=>
   NULL
+  ["dirty"]=>
+  bool(false)
   ["inTransaction"]=>
   bool(false)
   ["transactionState"]=>

tests/session/session-debug-004.phpt

@@ -36,6 +36,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["server"]=>
   NULL
+  ["dirty"]=>
+  NULL
   ["inTransaction"]=>
   NULL
   ["transactionState"]=>

tests/session/session-debug-005.phpt

@@ -66,6 +66,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   object(MongoDB\Driver\Server)#%d (%d) {
     %a
   }
+  ["dirty"]=>
+  bool(false)
   ["inTransaction"]=>
   bool(true)
   ["transactionState"]=>

tests/session/session-debug-006.phpt

@@ -47,6 +47,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["server"]=>
   NULL
+  ["dirty"]=>
+  bool(false)
   ["inTransaction"]=>
   bool(true)
   ["transactionState"]=>

tests/session/session-debug-007.phpt

@@ -39,6 +39,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["server"]=>
   NULL
+  ["dirty"]=>
+  bool(false)
   ["inTransaction"]=>
   bool(false)
   ["transactionState"]=>

tests/session/session-isDirty-001.phpt

@@ -0,0 +1,41 @@
+--TEST--
+MongoDB\Driver\Session::isDirty()
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_libmongoc_crypto() ?>
+<?php skip_if_no_failcommand_failpoint(); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+$manager = create_test_manager();
+$server = $manager->selectServer();
+$session = $manager->startSession();
+
+printf("New session is dirty: %s\n", $session->isDirty() ? 'yes' : 'no');
+
+$command = new MongoDB\Driver\Command(['ping' => 1]);
+$server->executeCommand(DATABASE_NAME, $command, ['session' => $session]);
+
+printf("Session after successful command is dirty: %s\n", $session->isDirty() ? 'yes' : 'no');
+
+configureTargetedFailPoint($server, 'failCommand', [ 'times' => 1 ], [
+    'failCommands' => ['ping'],
+    'closeConnection' => true
+]);
+
+throws(function() use ($server, $command, $session) {
+    $server->executeCommand(DATABASE_NAME, $command, ['session' => $session]);
+}, MongoDB\Driver\Exception\ConnectionTimeoutException::class);
+
+printf("Session after network error is dirty: %s\n", $session->isDirty() ? 'yes' : 'no');
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+New session is dirty: no
+Session after successful command is dirty: no
+OK: Got MongoDB\Driver\Exception\ConnectionTimeoutException
+Session after network error is dirty: yes
+===DONE===