PHPLIB-229: Operations should not accept unsupported read concern options

jmikola · jmikola · commit 8dcc778422a5 · 2016-12-01T17:28:16.000+01:00
diff --git a/docs/includes/apiargs-MongoDBCollection-common-option.yaml b/docs/includes/apiargs-MongoDBCollection-common-option.yaml
@@ -36,6 +36,9 @@ type: :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
 description: |
    :manual:`Read concern </reference/read-concern>` to use for the operation.
    Defaults to the collection's read concern.
+
+   This is not supported for server versions prior to 3.2 and will result in an
+   exception at execution time if used.
 interface: phpmethod
 operation: ~
 optional: true
diff --git a/docs/includes/extracts-error.yaml b/docs/includes/extracts-error.yaml
@@ -29,5 +29,6 @@ content: |
 ref: error-unsupportedexception
 content: |
   :phpclass:`MongoDB\\Exception\\UnsupportedException` if options are used and
-  not supported by the selected server (e.g. ``collation``, ``writeConcern``).
+  not supported by the selected server (e.g. ``collation``, ``readConcern``,
+  ``writeConcern``).
 ...
diff --git a/src/Exception/UnsupportedException.php b/src/Exception/UnsupportedException.php
@@ -14,6 +14,16 @@ public static function collationNotSupported()
         return new static('Collations are not supported by the server executing this operation');
     }
 
+    /**
+     * Thrown when a command's readConcern option is not supported by a server.
+     *
+     * @return self
+     */
+    public static function readConcernNotSupported()
+    {
+        return new static('Read concern is not supported by the server executing this command');
+    }
+
     /**
      * Thrown when a command's writeConcern option is not supported by a server.
      *
diff --git a/src/Operation/Aggregate.php b/src/Operation/Aggregate.php
@@ -64,8 +64,8 @@ class Aggregate implements Executable
      *  * readConcern (MongoDB\Driver\ReadConcern): Read concern. Note that a
      *    "majority" read concern is not compatible with the $out stage.
      *
-     *    For servers < 3.2, this option is ignored as read concern is not
-     *    available.
+     *    This is not supported for server versions < 3.2 and will result in an
+     *    exception at execution time if used.
      *
      *  * readPreference (MongoDB\Driver\ReadPreference): Read preference.
      *
@@ -182,7 +182,7 @@ public function __construct($databaseName, $collectionName, array $pipeline, arr
      * @param Server $server
      * @return Traversable
      * @throws UnexpectedValueException if the command response was malformed
-     * @throws UnsupportedException if collation or write concern is used and unsupported
+     * @throws UnsupportedException if collation, read concern, or write concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
     public function execute(Server $server)
@@ -191,6 +191,10 @@ public function execute(Server $server)
             throw UnsupportedException::collationNotSupported();
         }
 
+        if (isset($this->options['readConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {
+            throw UnsupportedException::readConcernNotSupported();
+        }
+
         if (isset($this->options['writeConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForWriteConcern)) {
             throw UnsupportedException::writeConcernNotSupported();
         }
@@ -254,7 +258,7 @@ private function createCommand(Server $server, $isCursorSupported)
             $cmd['maxTimeMS'] = $this->options['maxTimeMS'];
         }
 
-        if (isset($this->options['readConcern']) && \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {
+        if (isset($this->options['readConcern'])) {
             $cmd['readConcern'] = \MongoDB\read_concern_as_document($this->options['readConcern']);
         }
 
diff --git a/src/Operation/Count.php b/src/Operation/Count.php
@@ -48,8 +48,8 @@ class Count implements Executable
      *
      *  * readConcern (MongoDB\Driver\ReadConcern): Read concern.
      *
-     *    For servers < 3.2, this option is ignored as read concern is not
-     *    available.
+     *    This is not supported for server versions < 3.2 and will result in an
+     *    exception at execution time if used.
      *
      *  * readPreference (MongoDB\Driver\ReadPreference): Read preference.
      *
@@ -115,7 +115,7 @@ public function __construct($databaseName, $collectionName, $filter = [], array
      * @param Server $server
      * @return integer
      * @throws UnexpectedValueException if the command response was malformed
-     * @throws UnsupportedException if collation is used and unsupported
+     * @throws UnsupportedException if collation or read concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
     public function execute(Server $server)
@@ -124,6 +124,10 @@ public function execute(Server $server)
             throw UnsupportedException::collationNotSupported();
         }
 
+        if (isset($this->options['readConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {
+            throw UnsupportedException::readConcernNotSupported();
+        }
+
         $readPreference = isset($this->options['readPreference']) ? $this->options['readPreference'] : null;
 
         $cursor = $server->executeCommand($this->databaseName, $this->createCommand($server), $readPreference);
@@ -161,7 +165,7 @@ private function createCommand(Server $server)
             }
         }
 
-        if (isset($this->options['readConcern']) && \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {
+        if (isset($this->options['readConcern'])) {
             $cmd['readConcern'] = \MongoDB\read_concern_as_document($this->options['readConcern']);
         }
 
diff --git a/src/Operation/Distinct.php b/src/Operation/Distinct.php
@@ -44,8 +44,8 @@ class Distinct implements Executable
      *
      *  * readConcern (MongoDB\Driver\ReadConcern): Read concern.
      *
-     *    For servers < 3.2, this option is ignored as read concern is not
-     *    available.
+     *    This is not supported for server versions < 3.2 and will result in an
+     *    exception at execution time if used.
      *
      *  * readPreference (MongoDB\Driver\ReadPreference): Read preference.
      *
@@ -92,7 +92,7 @@ public function __construct($databaseName, $collectionName, $fieldName, $filter
      * @param Server $server
      * @return mixed[]
      * @throws UnexpectedValueException if the command response was malformed
-     * @throws UnsupportedException if collation is used and unsupported
+     * @throws UnsupportedException if collation or read concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
     public function execute(Server $server)
@@ -101,6 +101,10 @@ public function execute(Server $server)
             throw UnsupportedException::collationNotSupported();
         }
 
+        if (isset($this->options['readConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {
+            throw UnsupportedException::readConcernNotSupported();
+        }
+
         $readPreference = isset($this->options['readPreference']) ? $this->options['readPreference'] : null;
 
         $cursor = $server->executeCommand($this->databaseName, $this->createCommand($server), $readPreference);
diff --git a/src/Operation/Find.php b/src/Operation/Find.php
@@ -75,8 +75,8 @@ class Find implements Executable
      *
      *  * readConcern (MongoDB\Driver\ReadConcern): Read concern.
      *
-     *    For servers < 3.2, this option is ignored as read concern is not
-     *    available.
+     *    This is not supported for server versions < 3.2 and will result in an
+     *    exception at execution time if used.
      *
      *  * readPreference (MongoDB\Driver\ReadPreference): Read preference.
      *
@@ -185,7 +185,7 @@ public function __construct($databaseName, $collectionName, $filter, array $opti
      * @see Executable::execute()
      * @param Server $server
      * @return Cursor
-     * @throws UnsupportedException if collation is used and unsupported
+     * @throws UnsupportedException if collation or read concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
     public function execute(Server $server)
@@ -194,6 +194,10 @@ public function execute(Server $server)
             throw UnsupportedException::collationNotSupported();
         }
 
+        if (isset($this->options['readConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {
+            throw UnsupportedException::readConcernNotSupported();
+        }
+
         $readPreference = isset($this->options['readPreference']) ? $this->options['readPreference'] : null;
 
         $cursor = $server->executeQuery($this->databaseName . '.' . $this->collectionName, $this->createQuery(), $readPreference);
diff --git a/src/Operation/FindOne.php b/src/Operation/FindOne.php
@@ -45,8 +45,8 @@ class FindOne implements Executable
      *
      *  * readConcern (MongoDB\Driver\ReadConcern): Read concern.
      *
-     *    For servers < 3.2, this option is ignored as read concern is not
-     *    available.
+     *    This is not supported for server versions < 3.2 and will result in an
+     *    exception at execution time if used.
      *
      *  * readPreference (MongoDB\Driver\ReadPreference): Read preference.
      *
@@ -82,7 +82,7 @@ public function __construct($databaseName, $collectionName, $filter, array $opti
      * @see Executable::execute()
      * @param Server $server
      * @return array|object|null
-     * @throws UnsupportedException if collation is used and unsupported
+     * @throws UnsupportedException if collation or read concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
     public function execute(Server $server)

Original file line number	Diff line number	Diff line change
`@@ -64,8 +64,8 @@ class Aggregate implements Executable`
`64`	`64`	`* * readConcern (MongoDB\Driver\ReadConcern): Read concern. Note that a`
`65`	`65`	`* "majority" read concern is not compatible with the $out stage.`
`66`	`66`	`*`
`67`		`- * For servers < 3.2, this option is ignored as read concern is not`
`68`		`- * available.`
	`67`	`+ * This is not supported for server versions < 3.2 and will result in an`
	`68`	`+ * exception at execution time if used.`
`69`	`69`	`*`
`70`	`70`	`* * readPreference (MongoDB\Driver\ReadPreference): Read preference.`
`71`	`71`	`*`
`@@ -182,7 +182,7 @@ public function __construct($databaseName, $collectionName, array $pipeline, arr`
`182`	`182`	`* @param Server $server`
`183`	`183`	`* @return Traversable`
`184`	`184`	`* @throws UnexpectedValueException if the command response was malformed`
`185`		`- * @throws UnsupportedException if collation or write concern is used and unsupported`
	`185`	`+ * @throws UnsupportedException if collation, read concern, or write concern is used and unsupported`
`186`	`186`	`* @throws DriverRuntimeException for other driver errors (e.g. connection errors)`
`187`	`187`	`*/`
`188`	`188`	`public function execute(Server $server)`
`@@ -191,6 +191,10 @@ public function execute(Server $server)`
`191`	`191`	`throw UnsupportedException::collationNotSupported();`
`192`	`192`	`}`
`193`	`193`
	`194`	`+ if (isset($this->options['readConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {`
	`195`	`+ throw UnsupportedException::readConcernNotSupported();`
	`196`	`+ }`
	`197`	`+`
`194`	`198`	`if (isset($this->options['writeConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForWriteConcern)) {`
`195`	`199`	`throw UnsupportedException::writeConcernNotSupported();`
`196`	`200`	`}`
`@@ -254,7 +258,7 @@ private function createCommand(Server $server, $isCursorSupported)`
`254`	`258`	`$cmd['maxTimeMS'] = $this->options['maxTimeMS'];`
`255`	`259`	`}`
`256`	`260`
`257`		`- if (isset($this->options['readConcern']) && \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {`
	`261`	`+ if (isset($this->options['readConcern'])) {`
`258`	`262`	`$cmd['readConcern'] = \MongoDB\read_concern_as_document($this->options['readConcern']);`
`259`	`263`	`}`
`260`	`264`
Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,8 @@ class Count implements Executable`
`48`	`48`	`*`
`49`	`49`	`* * readConcern (MongoDB\Driver\ReadConcern): Read concern.`
`50`	`50`	`*`
`51`		`- * For servers < 3.2, this option is ignored as read concern is not`
`52`		`- * available.`
	`51`	`+ * This is not supported for server versions < 3.2 and will result in an`
	`52`	`+ * exception at execution time if used.`
`53`	`53`	`*`
`54`	`54`	`* * readPreference (MongoDB\Driver\ReadPreference): Read preference.`
`55`	`55`	`*`
`@@ -115,7 +115,7 @@ public function __construct($databaseName, $collectionName, $filter = [], array`
`115`	`115`	`* @param Server $server`
`116`	`116`	`* @return integer`
`117`	`117`	`* @throws UnexpectedValueException if the command response was malformed`
`118`		`- * @throws UnsupportedException if collation is used and unsupported`
	`118`	`+ * @throws UnsupportedException if collation or read concern is used and unsupported`
`119`	`119`	`* @throws DriverRuntimeException for other driver errors (e.g. connection errors)`
`120`	`120`	`*/`
`121`	`121`	`public function execute(Server $server)`
`@@ -124,6 +124,10 @@ public function execute(Server $server)`
`124`	`124`	`throw UnsupportedException::collationNotSupported();`
`125`	`125`	`}`
`126`	`126`
	`127`	`+ if (isset($this->options['readConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {`
	`128`	`+ throw UnsupportedException::readConcernNotSupported();`
	`129`	`+ }`
	`130`	`+`
`127`	`131`	`$readPreference = isset($this->options['readPreference']) ? $this->options['readPreference'] : null;`
`128`	`132`
`129`	`133`	`$cursor = $server->executeCommand($this->databaseName, $this->createCommand($server), $readPreference);`
`@@ -161,7 +165,7 @@ private function createCommand(Server $server)`
`161`	`165`	`}`
`162`	`166`	`}`
`163`	`167`
`164`		`- if (isset($this->options['readConcern']) && \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {`
	`168`	`+ if (isset($this->options['readConcern'])) {`
`165`	`169`	`$cmd['readConcern'] = \MongoDB\read_concern_as_document($this->options['readConcern']);`
`166`	`170`	`}`
`167`	`171`
Original file line number	Diff line number	Diff line change
`@@ -44,8 +44,8 @@ class Distinct implements Executable`
`44`	`44`	`*`
`45`	`45`	`* * readConcern (MongoDB\Driver\ReadConcern): Read concern.`
`46`	`46`	`*`
`47`		`- * For servers < 3.2, this option is ignored as read concern is not`
`48`		`- * available.`
	`47`	`+ * This is not supported for server versions < 3.2 and will result in an`
	`48`	`+ * exception at execution time if used.`
`49`	`49`	`*`
`50`	`50`	`* * readPreference (MongoDB\Driver\ReadPreference): Read preference.`
`51`	`51`	`*`
`@@ -92,7 +92,7 @@ public function __construct($databaseName, $collectionName, $fieldName, $filter`
`92`	`92`	`* @param Server $server`
`93`	`93`	`* @return mixed[]`
`94`	`94`	`* @throws UnexpectedValueException if the command response was malformed`
`95`		`- * @throws UnsupportedException if collation is used and unsupported`
	`95`	`+ * @throws UnsupportedException if collation or read concern is used and unsupported`
`96`	`96`	`* @throws DriverRuntimeException for other driver errors (e.g. connection errors)`
`97`	`97`	`*/`
`98`	`98`	`public function execute(Server $server)`
`@@ -101,6 +101,10 @@ public function execute(Server $server)`
`101`	`101`	`throw UnsupportedException::collationNotSupported();`
`102`	`102`	`}`
`103`	`103`
	`104`	`+ if (isset($this->options['readConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {`
	`105`	`+ throw UnsupportedException::readConcernNotSupported();`
	`106`	`+ }`
	`107`	`+`
`104`	`108`	`$readPreference = isset($this->options['readPreference']) ? $this->options['readPreference'] : null;`
`105`	`109`
`106`	`110`	`$cursor = $server->executeCommand($this->databaseName, $this->createCommand($server), $readPreference);`
Original file line number	Diff line number	Diff line change
`@@ -75,8 +75,8 @@ class Find implements Executable`
`75`	`75`	`*`
`76`	`76`	`* * readConcern (MongoDB\Driver\ReadConcern): Read concern.`
`77`	`77`	`*`
`78`		`- * For servers < 3.2, this option is ignored as read concern is not`
`79`		`- * available.`
	`78`	`+ * This is not supported for server versions < 3.2 and will result in an`
	`79`	`+ * exception at execution time if used.`
`80`	`80`	`*`
`81`	`81`	`* * readPreference (MongoDB\Driver\ReadPreference): Read preference.`
`82`	`82`	`*`
`@@ -185,7 +185,7 @@ public function __construct($databaseName, $collectionName, $filter, array $opti`
`185`	`185`	`* @see Executable::execute()`
`186`	`186`	`* @param Server $server`
`187`	`187`	`* @return Cursor`
`188`		`- * @throws UnsupportedException if collation is used and unsupported`
	`188`	`+ * @throws UnsupportedException if collation or read concern is used and unsupported`
`189`	`189`	`* @throws DriverRuntimeException for other driver errors (e.g. connection errors)`
`190`	`190`	`*/`
`191`	`191`	`public function execute(Server $server)`
`@@ -194,6 +194,10 @@ public function execute(Server $server)`
`194`	`194`	`throw UnsupportedException::collationNotSupported();`
`195`	`195`	`}`
`196`	`196`
	`197`	`+ if (isset($this->options['readConcern']) && ! \MongoDB\server_supports_feature($server, self::$wireVersionForReadConcern)) {`
	`198`	`+ throw UnsupportedException::readConcernNotSupported();`
	`199`	`+ }`
	`200`	`+`
`197`	`201`	`$readPreference = isset($this->options['readPreference']) ? $this->options['readPreference'] : null;`
`198`	`202`
`199`	`203`	`$cursor = $server->executeQuery($this->databaseName . '.' . $this->collectionName, $this->createQuery(), $readPreference);`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,8 @@ class FindOne implements Executable`
`45`	`45`	`*`
`46`	`46`	`* * readConcern (MongoDB\Driver\ReadConcern): Read concern.`
`47`	`47`	`*`
`48`		`- * For servers < 3.2, this option is ignored as read concern is not`
`49`		`- * available.`
	`48`	`+ * This is not supported for server versions < 3.2 and will result in an`
	`49`	`+ * exception at execution time if used.`
`50`	`50`	`*`
`51`	`51`	`* * readPreference (MongoDB\Driver\ReadPreference): Read preference.`
`52`	`52`	`*`
`@@ -82,7 +82,7 @@ public function __construct($databaseName, $collectionName, $filter, array $opti`
`82`	`82`	`* @see Executable::execute()`
`83`	`83`	`* @param Server $server`
`84`	`84`	`* @return array\|object\|null`
`85`		`- * @throws UnsupportedException if collation is used and unsupported`
	`85`	`+ * @throws UnsupportedException if collation or read concern is used and unsupported`
`86`	`86`	`* @throws DriverRuntimeException for other driver errors (e.g. connection errors)`
`87`	`87`	`*/`
`88`	`88`	`public function execute(Server $server)`