PHPC-1889: Session snapshot option

Author: jmikola

src/MongoDB/Manager.c

@@ -805,6 +805,18 @@ static PHP_METHOD(Manager, startSession)
 		}
 	}
 
+	if (options && php_array_existsc(options, "snapshot")) {
+		if (!cs_opts) {
+			cs_opts = mongoc_session_opts_new();
+		}
+		mongoc_session_opts_set_snapshot(cs_opts, php_array_fetchc_bool(options, "snapshot"));
+	}
+
+	if (cs_opts && mongoc_session_opts_get_causal_consistency(cs_opts) && mongoc_session_opts_get_snapshot(cs_opts)) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Only one of \"causalConsistency\" and \"snapshot\" can be enabled");
+		goto cleanup;
+	}
+
 	/* If the Manager was created in a different process, reset the client so
 	 * that its session pool is cleared. This will ensure that we do not re-use
 	 * a server session (i.e. LSID) created by a parent process. */

src/MongoDB/Session.c

@@ -740,8 +740,10 @@ static HashTable* php_phongo_session_get_debug_info(phongo_compat_object_handler
 	if (intern->client_session) {
 		const mongoc_session_opt_t* cs_opts = mongoc_client_session_get_opts(intern->client_session);
 		ADD_ASSOC_BOOL_EX(&retval, "causalConsistency", mongoc_session_opts_get_causal_consistency(cs_opts));
+		ADD_ASSOC_BOOL_EX(&retval, "snapshot", mongoc_session_opts_get_snapshot(cs_opts));
 	} else {
 		ADD_ASSOC_NULL_EX(&retval, "causalConsistency");
+		ADD_ASSOC_NULL_EX(&retval, "snapshot");
 	}
 
 	if (intern->client_session) {

tests/manager/manager-startSession_error-002.phpt

@@ -0,0 +1,30 @@
+--TEST--
+MongoDB\Driver\Manager::startSession() snapshot and causalConsistency cannot both be true
+--DESCRIPTION--
+Session spec prose test #1
+https://github.com/mongodb/specifications/blob/master/source/sessions/tests/README.rst#prose-tests
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_libmongoc_crypto(); ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('<', '3.6'); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+$manager = create_test_manager();
+
+echo throws(function() use ($manager) {
+    $manager->startSession([
+        'causalConsistency' => true,
+        'snapshot' => true,
+    ]);
+}, MongoDB\Driver\Exception\InvalidArgumentException::class), "\n";
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Only one of "causalConsistency" and "snapshot" can be enabled
+===DONE===

tests/session/session-debug-001.phpt

@@ -33,6 +33,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["causalConsistency"]=>
   bool(true)
+  ["snapshot"]=>
+  bool(false)
   ["operationTime"]=>
   NULL
   ["server"]=>

tests/session/session-debug-002.phpt

@@ -46,6 +46,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   }
   ["causalConsistency"]=>
   bool(true)
+  ["snapshot"]=>
+  bool(false)
   ["operationTime"]=>
   object(MongoDB\BSON\Timestamp)#%d (%d) {
     ["increment"]=>

tests/session/session-debug-003.phpt

@@ -33,6 +33,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["causalConsistency"]=>
   bool(false)
+  ["snapshot"]=>
+  bool(false)
   ["operationTime"]=>
   NULL
   ["server"]=>

tests/session/session-debug-004.phpt

@@ -30,6 +30,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["causalConsistency"]=>
   NULL
+  ["snapshot"]=>
+  NULL
   ["operationTime"]=>
   NULL
   ["server"]=>

tests/session/session-debug-005.phpt

@@ -53,6 +53,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   }
   ["causalConsistency"]=>
   bool(true)
+  ["snapshot"]=>
+  bool(false)
   ["operationTime"]=>
   object(MongoDB\BSON\Timestamp)#%d (%d) {
     ["increment"]=>

tests/session/session-debug-006.phpt

@@ -41,6 +41,8 @@ object(MongoDB\Driver\Session)#%d (%d) {
   NULL
   ["causalConsistency"]=>
   bool(true)
+  ["snapshot"]=>
+  bool(false)
   ["operationTime"]=>
   NULL
   ["server"]=>

tests/session/session-debug-007.phpt

@@ -0,0 +1,49 @@
+--TEST--
+MongoDB\Driver\Session debug output (snapshot=true)
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_libmongoc_crypto(); ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('<', '3.6'); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+$manager = create_test_manager();
+$session = $manager->startSession(['snapshot' => true]);
+
+var_dump($session);
+
+?>
+===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"]=>
+  NULL
+  ["causalConsistency"]=>
+  bool(false)
+  ["snapshot"]=>
+  bool(true)
+  ["operationTime"]=>
+  NULL
+  ["server"]=>
+  NULL
+  ["inTransaction"]=>
+  bool(false)
+  ["transactionState"]=>
+  string(4) "none"
+  ["transactionOptions"]=>
+  NULL
+}
+===DONE===