fix(gatsby-source-mongodb): pass useUnifiedTopology option to MongoClient (gatsbyjs#21127)

robinmetral · web-flow · commit 61ec54b33568 · 2020-02-01T22:55:45.000+02:00
* fix(gatsby-source-mongodb): pass useUnifiedTopology option to MongoClient

* docs(gatsby-source-mongodb): document useUnifiedTopology as a default MongoClient option
diff --git a/packages/gatsby-source-mongodb/README.md b/packages/gatsby-source-mongodb/README.md
@@ -48,7 +48,7 @@ module.exports = {
   properties user and password. ex. auth: { user: `admin`, password: `12345` }
 - **extraParams**: useful to set additional parameters for the connection, like authSource, ssl or replicaSet
   (needed for connecting to MongoDB Atlas db as a service), ex: extraParams: { replicaSet: `test-shard-0`, ssl: `true`, authSource: `admin` }. These are the types of options that can be appended as query parameters to the connection URI: https://docs.mongodb.com/manual/reference/connection-string/#connections-connection-options
-- **clientOptions**: for setting options on the creation of a `MongoClient` instance. By default to handle the various connection URI's necessary for newer versions of MongoDB Atlas, for instance, we pass { `useNewUrlParser`: `true` }. You can override the default by passing either an empty object literal or filled with other valid connection options. All options [specified in the `MongoClient` documentation](http://mongodb.github.io/node-mongodb-native/3.1/reference/connecting/connection-settings/) are valid for usage.
+- **clientOptions**: for setting options on the creation of a `MongoClient` instance. By default, we pass `useNewUrlParser: true` to handle the various connection URI's necessary for newer versions of MongoDB Atlas, as well as `useUnifiedTopology: true` to opt in to using the MongoDB driver's new topology engine, which improves server discovery and monitoring. You can override the default by passing either an empty object literal or filled with other valid connection options. All options [specified in the `MongoClient` documentation](http://mongodb.github.io/node-mongodb-native/3.1/reference/connecting/connection-settings/) are valid for usage.
 - **preserveObjectIds**: for preserving nested ObjectIDs within documents, set this to the Boolean `true`, ex: preserveObjectIds: `true`.
 
 ### Mapping mediatype feature
diff --git a/packages/gatsby-source-mongodb/src/gatsby-node.js b/packages/gatsby-source-mongodb/src/gatsby-node.js
@@ -22,7 +22,10 @@ exports.sourceNodes = (
   let connectionExtraParams = getConnectionExtraParams(
     pluginOptions.extraParams
   )
-  const clientOptions = pluginOptions.clientOptions || { useNewUrlParser: true }
+  const clientOptions = pluginOptions.clientOptions || {
+    useNewUrlParser: true,
+    useUnifiedTopology: true,
+  }
   const connectionURL = pluginOptions.connectionString
     ? `${pluginOptions.connectionString}/${dbName}${connectionExtraParams}`
     : `mongodb://${authUrlPart}${serverOptions.address}:${serverOptions.port}/${dbName}${connectionExtraParams}`
