Merge pull request #357 from mixmaxhq/feature/add-native-mongodb3-support

feat: add native driver mongodb v3 and v4 support

Author: hishank

.gitignore

@@ -37,6 +37,7 @@ jspm_packages
 .node_repl_history
 
 *.sublime-workspace
+.idea
 
 # Node 6 transpiled code.
 dist/node

jest.config.js

@@ -2,4 +2,8 @@ module.exports = {
   clearMocks: true,
   collectCoverageFrom: ['src/**/*.js'],
   testEnvironment: 'node',
+  moduleNameMapper: {
+    '^mongodbMapped$': `mongodb${process.env.DRIVER_VERSION || ''}`,
+  },
+  testTimeout: 15000,
 };

package-lock.json

@@ -16,7 +16,7 @@
     "lint": "eslint .",
     "prepublishOnly": "npm run babelBuild && if [ \"$CI\" = '' ]; then node -p 'JSON.parse(process.env.npm_package_config_manualPublishMessage)'; exit 1; fi",
     "semantic-release": "SEMANTIC_COMMITLINT_SKIP=f4543f643bac890c627d538e6200c5f5a1d45ebc semantic-release",
-    "test": "npm run babelBuild; DRIVER=mongoist jest --forceExit && DRIVER=native jest --forceExit"
+    "test": "npm run babelBuild; DRIVER=mongoist jest --forceExit && DRIVER=native jest && DRIVER=native DRIVER_VERSION=v3 jest && DRIVER=native DRIVER_VERSION=v2 jest"
   },
   "repository": {
     "type": "git",
@@ -40,10 +40,10 @@
   "dependencies": {
     "base64-url": "^2.2.0",
     "bson": "^4.7.0",
-    "object-path": "^0.11.5",
+    "object-path": "^0.11.8",
     "projection-utils": "^1.1.0",
     "semver": "^5.4.1",
-    "underscore": "^1.9.2"
+    "underscore": "^1.12.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.18.10",
@@ -55,14 +55,16 @@
     "@mixmaxhq/semantic-release-config": "^2.0.0",
     "babel-jest": "^29.0.0",
     "cz-conventional-changelog": "^3.2.0",
-    "eslint": "^6.8.0",
+    "eslint": "^7.32.0",
     "eslint-config-mixmax": "^4.11.2",
-    "jest": "^26.0.1",
+    "jest": "^29.6.2",
     "mockgoose": "^8.0.4",
-    "mongodb": "^2.2.11",
+    "mongodb": "^4.17.0",
+    "mongodbv3": "npm:mongodb@^3.7.4",
+    "mongodbv2": "npm:mongodb@^2.2.36",
     "mongodb-memory-server": "6.9.6",
     "mongoist": "^2.7.0",
-    "mongoose": "5.11.10",
+    "mongoose": "^5.13.20",
     "prettier": "^1.19.1",
     "semantic-release": "^17.2.3"
   },

package.json

@@ -1,7 +1,8 @@
 const _ = require('underscore');
-const sanitizeParams = require('./utils/sanitizeParams');
-const { prepareResponse, generateSort, generateCursorQuery } = require('./utils/query');
+
 const config = require('./config');
+const { prepareResponse, generateSort, generateCursorQuery } = require('./utils/query');
+const sanitizeParams = require('./utils/sanitizeParams');
 
 /**
  * Performs an aggregate() query on a passed-in Mongo collection, using criteria you specify.

src/aggregate.js

@@ -1,8 +1,14 @@
 const _ = require('underscore');
-const sanitizeParams = require('./utils/sanitizeParams');
-const { prepareResponse, generateSort, generateCursorQuery } = require('./utils/query');
+
 const aggregate = require('./aggregate');
 const config = require('./config');
+const { prepareResponse, generateSort, generateCursorQuery } = require('./utils/query');
+const sanitizeParams = require('./utils/sanitizeParams');
+
+const COLLECTION_METHODS = {
+  FIND: 'find',
+  FIND_AS_CURSOR: 'findAsCursor',
+};
 
 /**
  * Performs a find() query on a passed-in Mongo collection, using criteria you specify. The results
@@ -55,9 +61,17 @@ module.exports = async function(collection, params) {
 
     // Support both the native 'mongodb' driver and 'mongoist'. See:
     // https://www.npmjs.com/package/mongoist#cursor-operations
-    const findMethod = collection.findAsCursor ? 'findAsCursor' : 'find';
+    const findMethod = collection.findAsCursor
+      ? COLLECTION_METHODS.FIND_AS_CURSOR
+      : COLLECTION_METHODS.FIND;
 
-    const query = collection[findMethod]({ $and: [cursorQuery, params.query] }, params.fields);
+    // Required to support native mongodb 3+ and keep the backward compatibility with version 2
+    let query;
+    if (findMethod === COLLECTION_METHODS.FIND_AS_CURSOR) {
+      query = collection[findMethod]({ $and: [cursorQuery, params.query] }, params.fields);
+    } else {
+      query = collection[findMethod]({ $and: [cursorQuery, params.query] }).project(params.fields);
+    }
 
     /**
      * IMPORTANT

src/find.js

@@ -1,11 +1,11 @@
-const config = require('./config');
 const aggregate = require('./aggregate');
+const config = require('./config');
 const find = require('./find');
 const findWithReq = require('./findWithReq');
+const mongoosePlugin = require('./mongoose.plugin');
 const search = require('./search');
-const sanitizeQuery = require('./utils/sanitizeQuery');
 const { encodePaginationTokens } = require('./utils/query');
-const mongoosePlugin = require('./mongoose.plugin');
+const sanitizeQuery = require('./utils/sanitizeQuery');
 
 module.exports = {
   config,

src/index.js

@@ -1,6 +1,7 @@
+const _ = require('underscore');
+
 const find = require('./find');
 const search = require('./search');
-const _ = require('underscore');
 
 /**
  * Mongoose plugin

src/mongoose.plugin.js

@@ -1,4 +1,5 @@
 const _ = require('underscore');
+
 const config = require('./config');
 const bsonUrlEncoding = require('./utils/bsonUrlEncoding');
 

src/search.js

@@ -1,5 +1,5 @@
-const { EJSON } = require('bson');
 const base64url = require('base64-url');
+const { EJSON } = require('bson');
 
 // BSON can't encode undefined values, so we will use this value instead:
 const BSON_UNDEFINED = '__mixmax__undefined__';