docs: make a note on each optional require that using try is necessary

mongodb · Jul 16, 2021 · 02bae84 · 02bae84
1 parent 5106f2d
commit 02bae84
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 0 deletions.
diff --git a/lib/core/auth/mongodb_aws.js b/lib/core/auth/mongodb_aws.js
@@ -9,6 +9,7 @@ const url = require('url');
 
 let aws4;
 try {
+  // Ensure you always wrap an optional require in the try block NODE-3199
   aws4 = require('aws4');
 } catch (e) {
   // don't do anything;

diff --git a/lib/core/auth/scram.js b/lib/core/auth/scram.js
@@ -11,6 +11,7 @@ const Binary = BSON.Binary;
 
 let saslprep;
 try {
+  // Ensure you always wrap an optional require in the try block NODE-3199
   saslprep = require('saslprep');
 } catch (e) {
   // don't do anything;

diff --git a/lib/core/index.js b/lib/core/index.js
@@ -5,6 +5,7 @@ const require_optional = require('optional-require')(require);
 const EJSON = require('./utils').retrieveEJSON();
 
 try {
+  // Ensure you always wrap an optional require in the try block NODE-3199
   // Attempt to grab the native BSON parser
   const BSONNative = require_optional('bson-ext');
   // If we got the native parser, use it instead of the

diff --git a/lib/core/utils.js b/lib/core/utils.js
@@ -27,6 +27,7 @@ function retrieveKerberos() {
   let kerberos;
 
   try {
+    // Ensure you always wrap an optional require in the try block NODE-3199
     kerberos = requireOptional('kerberos');
   } catch (err) {
     if (err.code === 'MODULE_NOT_FOUND') {

diff --git a/lib/encrypter.js b/lib/encrypter.js
@@ -5,6 +5,7 @@ const MongoError = require('./core/error').MongoError;
 
 let mongodbClientEncryption = undefined;
 try {
+  // Ensure you always wrap an optional require in the try block NODE-3199
   mongodbClientEncryption = require('mongodb-client-encryption');
 } catch (err) {
   throw new MongoError(