Merge pull request #749

* phplib-556:
  PHPLIB-556: Throw client-side error when allowDiskUse is not supported by a server

Author: alcaeus

src/Exception/UnsupportedException.php

@@ -19,6 +19,16 @@
 
 class UnsupportedException extends RuntimeException
 {
+    /**
+     * Thrown when a command's allowDiskUse option is not supported by a server.
+     *
+     * @return self
+     */
+    public static function allowDiskUseNotSupported()
+    {
+        return new static('The "allowDiskUse" option is not supported by the server executing this operation');
+    }
+
     /**
      * Thrown when array filters are not supported by a server.
      *

src/Operation/Find.php

@@ -55,6 +55,9 @@ class Find implements Executable, Explainable
     /** @var integer */
     private static $wireVersionForReadConcern = 4;
 
+    /** @var integer */
+    private static $wireVersionForAllowDiskUseServerSideError = 4;
+
     /** @var string */
     private $databaseName;
 
@@ -322,6 +325,10 @@ public function execute(Server $server)
             throw UnsupportedException::readConcernNotSupported();
         }
 
+        if (isset($this->options['allowDiskUse']) && ! server_supports_feature($server, self::$wireVersionForAllowDiskUseServerSideError)) {
+            throw UnsupportedException::allowDiskUseNotSupported();
+        }
+
         $inTransaction = isset($this->options['session']) && $this->options['session']->isInTransaction();
         if ($inTransaction && isset($this->options['readConcern'])) {
             throw UnsupportedException::readConcernNotSupportedInTransaction();

tests/SpecTests/crud/find-allowdiskuse-clientError.json

@@ -0,0 +1,40 @@
+{
+  "runOn": [
+    {
+      "maxServerVersion": "3.0.99"
+    }
+  ],
+  "collection_name": "test_find_allowdiskuse_clienterror",
+  "tests": [
+    {
+      "description": "Find fails when allowDiskUse true is specified against pre 3.2 server",
+      "operations": [
+        {
+          "object": "collection",
+          "name": "find",
+          "arguments": {
+            "filter": {},
+            "allowDiskUse": true
+          },
+          "error": true
+        }
+      ],
+      "expectations": []
+    },
+    {
+      "description": "Find fails when allowDiskUse false is specified against pre 3.2 server",
+      "operations": [
+        {
+          "object": "collection",
+          "name": "find",
+          "arguments": {
+            "filter": {},
+            "allowDiskUse": false
+          },
+          "error": true
+        }
+      ],
+      "expectations": []
+    }
+  ]
+}

tests/SpecTests/crud/find-allowdiskuse-serverError.json

@@ -0,0 +1,61 @@
+{
+  "runOn": [
+    {
+      "minServerVersion": "3.2",
+      "maxServerVersion": "4.3.0"
+    }
+  ],
+  "collection_name": "test_find_allowdiskuse_servererror",
+  "tests": [
+    {
+      "description": "Find fails when allowDiskUse true is specified against pre 4.4 server (server-side error)",
+      "operations": [
+        {
+          "object": "collection",
+          "name": "find",
+          "arguments": {
+            "filter": {},
+            "allowDiskUse": true
+          },
+          "error": true
+        }
+      ],
+      "expectations": [
+        {
+          "command_started_event": {
+            "command": {
+              "find": "test_find_allowdiskuse_servererror",
+              "filter": {},
+              "allowDiskUse": true
+            }
+          }
+        }
+      ]
+    },
+    {
+      "description": "Find fails when allowDiskUse false is specified against pre 4.4 server (server-side error)",
+      "operations": [
+        {
+          "object": "collection",
+          "name": "find",
+          "arguments": {
+            "filter": {},
+            "allowDiskUse": false
+          },
+          "error": true
+        }
+      ],
+      "expectations": [
+        {
+          "command_started_event": {
+            "command": {
+              "find": "test_find_allowdiskuse_servererror",
+              "filter": {},
+              "allowDiskUse": false
+            }
+          }
+        }
+      ]
+    }
+  ]
+}