fix: single readPreferenceTags should be parsed as an array

ReadPreference tags must be an array in order for matching to succeed during server selection. If a single value is entered for the `readPreferenceTags` uri option, it should be parsed as an array of size one. NODE-2541
mongodb · Apr 6, 2020 · a50611b · a50611b
1 parent d368f12
commit a50611b
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 3 deletions.
diff --git a/lib/core/uri_parser.js b/lib/core/uri_parser.js
@@ -285,8 +285,8 @@ function applyConnectionStringOption(obj, key, value, options) {
     }
   }
 
-  if (key === 'readpreferencetags' && Array.isArray(value)) {
-    value = splitArrayOfMultipleReadPreferenceTags(value);
+  if (key === 'readpreferencetags') {
+    value = Array.isArray(value) ? splitArrayOfMultipleReadPreferenceTags(value) : [value];
   }
 
   // set the actual value

diff --git a/test/spec/uri-options/read-preference-options.json b/test/spec/uri-options/read-preference-options.json
@@ -21,6 +21,21 @@
         "maxStalenessSeconds": 120
       }
     },
+    {
+      "description": "Single readPreferenceTags is parsed as array of size one",
+      "uri": "mongodb://example.com/?readPreferenceTags=dc:ny",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {
+        "readPreferenceTags": [
+          {
+            "dc": "ny"
+          }
+        ]
+      }
+    },
     {
       "description": "Invalid readPreferenceTags causes a warning",
       "uri": "mongodb://example.com/?readPreferenceTags=invalid",

diff --git a/test/spec/uri-options/read-preference-options.yml b/test/spec/uri-options/read-preference-options.yml
@@ -9,12 +9,23 @@ tests:
         options:
             readPreference: "primaryPreferred"
             readPreferenceTags:
-                - 
+                -
                     dc: "ny"
                     rack: "1"
                 -
                     dc: "ny"
             maxStalenessSeconds: 120
+    -
+        description: "Single readPreferenceTags is parsed as array of size one"
+        uri: "mongodb://example.com/?readPreferenceTags=dc:ny"
+        valid: true
+        warning: false
+        hosts: ~
+        auth: ~
+        options:
+            readPreferenceTags:
+                -
+                    dc: "ny"
     -
         description: "Invalid readPreferenceTags causes a warning"
         uri: "mongodb://example.com/?readPreferenceTags=invalid"