Skip to content

Commit c003bd4

Browse files
hishankhishank
authored
Merge pull request #357 from mixmaxhq/feature/add-native-mongodb3-support
feat: add native driver mongodb v3 and v4 support
2 parents df29232 + 6f3b566 commit c003bd4

21 files changed

+12347
-42647
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ jspm_packages
3737
.node_repl_history
3838

3939
*.sublime-workspace
40+
.idea
4041

4142
# Node 6 transpiled code.
4243
dist/node

‎jest.config.js

+4
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@ module.exports = {
22
clearMocks: true,
33
collectCoverageFrom: ['src/**/*.js'],
44
testEnvironment: 'node',
5+
moduleNameMapper: {
6+
'^mongodbMapped$': `mongodb${process.env.DRIVER_VERSION || ''}`,
7+
},
8+
testTimeout: 15000,
59
};

‎package-lock.json

+12,213-42,574
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+9-7
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"lint": "eslint .",
1717
"prepublishOnly": "npm run babelBuild && if [ \"$CI\" = '' ]; then node -p 'JSON.parse(process.env.npm_package_config_manualPublishMessage)'; exit 1; fi",
1818
"semantic-release": "SEMANTIC_COMMITLINT_SKIP=f4543f643bac890c627d538e6200c5f5a1d45ebc semantic-release",
19-
"test": "npm run babelBuild; DRIVER=mongoist jest --forceExit && DRIVER=native jest --forceExit"
19+
"test": "npm run babelBuild; DRIVER=mongoist jest --forceExit && DRIVER=native jest && DRIVER=native DRIVER_VERSION=v3 jest && DRIVER=native DRIVER_VERSION=v2 jest"
2020
},
2121
"repository": {
2222
"type": "git",
@@ -40,10 +40,10 @@
4040
"dependencies": {
4141
"base64-url": "^2.2.0",
4242
"bson": "^4.7.0",
43-
"object-path": "^0.11.5",
43+
"object-path": "^0.11.8",
4444
"projection-utils": "^1.1.0",
4545
"semver": "^5.4.1",
46-
"underscore": "^1.9.2"
46+
"underscore": "^1.12.1"
4747
},
4848
"devDependencies": {
4949
"@babel/cli": "^7.18.10",
@@ -55,14 +55,16 @@
5555
"@mixmaxhq/semantic-release-config": "^2.0.0",
5656
"babel-jest": "^29.0.0",
5757
"cz-conventional-changelog": "^3.2.0",
58-
"eslint": "^6.8.0",
58+
"eslint": "^7.32.0",
5959
"eslint-config-mixmax": "^4.11.2",
60-
"jest": "^26.0.1",
60+
"jest": "^29.6.2",
6161
"mockgoose": "^8.0.4",
62-
"mongodb": "^2.2.11",
62+
"mongodb": "^4.17.0",
63+
"mongodbv3": "npm:mongodb@^3.7.4",
64+
"mongodbv2": "npm:mongodb@^2.2.36",
6365
"mongodb-memory-server": "6.9.6",
6466
"mongoist": "^2.7.0",
65-
"mongoose": "5.11.10",
67+
"mongoose": "^5.13.20",
6668
"prettier": "^1.19.1",
6769
"semantic-release": "^17.2.3"
6870
},

‎src/aggregate.js

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
const _ = require('underscore');
2-
const sanitizeParams = require('./utils/sanitizeParams');
3-
const { prepareResponse, generateSort, generateCursorQuery } = require('./utils/query');
2+
43
const config = require('./config');
4+
const { prepareResponse, generateSort, generateCursorQuery } = require('./utils/query');
5+
const sanitizeParams = require('./utils/sanitizeParams');
56

67
/**
78
* Performs an aggregate() query on a passed-in Mongo collection, using criteria you specify.

‎src/find.js

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
const _ = require('underscore');
2-
const sanitizeParams = require('./utils/sanitizeParams');
3-
const { prepareResponse, generateSort, generateCursorQuery } = require('./utils/query');
2+
43
const aggregate = require('./aggregate');
54
const config = require('./config');
5+
const { prepareResponse, generateSort, generateCursorQuery } = require('./utils/query');
6+
const sanitizeParams = require('./utils/sanitizeParams');
7+
8+
const COLLECTION_METHODS = {
9+
FIND: 'find',
10+
FIND_AS_CURSOR: 'findAsCursor',
11+
};
612

713
/**
814
* 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) {
5561

5662
// Support both the native 'mongodb' driver and 'mongoist'. See:
5763
// https://www.npmjs.com/package/mongoist#cursor-operations
58-
const findMethod = collection.findAsCursor ? 'findAsCursor' : 'find';
64+
const findMethod = collection.findAsCursor
65+
? COLLECTION_METHODS.FIND_AS_CURSOR
66+
: COLLECTION_METHODS.FIND;
5967

60-
const query = collection[findMethod]({ $and: [cursorQuery, params.query] }, params.fields);
68+
// Required to support native mongodb 3+ and keep the backward compatibility with version 2
69+
let query;
70+
if (findMethod === COLLECTION_METHODS.FIND_AS_CURSOR) {
71+
query = collection[findMethod]({ $and: [cursorQuery, params.query] }, params.fields);
72+
} else {
73+
query = collection[findMethod]({ $and: [cursorQuery, params.query] }).project(params.fields);
74+
}
6175

6276
/**
6377
* IMPORTANT

‎src/index.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
const config = require('./config');
21
const aggregate = require('./aggregate');
2+
const config = require('./config');
33
const find = require('./find');
44
const findWithReq = require('./findWithReq');
5+
const mongoosePlugin = require('./mongoose.plugin');
56
const search = require('./search');
6-
const sanitizeQuery = require('./utils/sanitizeQuery');
77
const { encodePaginationTokens } = require('./utils/query');
8-
const mongoosePlugin = require('./mongoose.plugin');
8+
const sanitizeQuery = require('./utils/sanitizeQuery');
99

1010
module.exports = {
1111
config,

‎src/mongoose.plugin.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
const _ = require('underscore');
2+
13
const find = require('./find');
24
const search = require('./search');
3-
const _ = require('underscore');
45

56
/**
67
* Mongoose plugin

‎src/search.js

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
const _ = require('underscore');
2+
23
const config = require('./config');
34
const bsonUrlEncoding = require('./utils/bsonUrlEncoding');
45

‎src/utils/bsonUrlEncoding.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
const { EJSON } = require('bson');
21
const base64url = require('base64-url');
2+
const { EJSON } = require('bson');
33

44
// BSON can't encode undefined values, so we will use this value instead:
55
const BSON_UNDEFINED = '__mixmax__undefined__';

‎src/utils/query.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
const bsonUrlEncoding = require('./bsonUrlEncoding');
21
const objectPath = require('object-path');
32

3+
const bsonUrlEncoding = require('./bsonUrlEncoding');
4+
45
/**
56
* Helper function to encode pagination tokens.
67
*

‎src/utils/resolveFields.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
const _ = require('underscore');
21
const { ProjectionFieldSet } = require('projection-utils');
2+
const _ = require('underscore');
33

44
/**
55
* Produce a ProjectionFieldSet from the given mongo projection, after validating it to ensure it

‎src/utils/sanitizeParams.js

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
const _ = require('underscore');
2+
23
const bsonUrlEncoding = require('./bsonUrlEncoding');
34
const getPropertyViaDotNotation = require('./getPropertyViaDotNotation');
45
const config = require('../config');

‎src/utils/sanitizeQuery.js

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
const _ = require('underscore');
2+
23
const resolveFields = require('./resolveFields');
34

45
/**

‎test/aggregate.test.js

+16-12
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1-
const paging = require('../');
2-
const dbUtils = require('./support/db');
31
const _ = require('underscore');
42

5-
const driver = process.env.DRIVER;
3+
const dbUtils = require('./support/db');
4+
const paging = require('../');
65

7-
let mongod;
6+
const driver = process.env.DRIVER;
87

98
describe('aggregate', () => {
9+
let mongod;
10+
let client;
1011
const t = {};
1112
beforeAll(async () => {
1213
mongod = dbUtils.start();
13-
t.db = await dbUtils.db(mongod, driver);
14+
({ db: t.db, client } = await dbUtils.db(mongod, driver));
1415

1516
// Set up collections once for testing later.
1617
await Promise.all([
17-
t.db.collection('test_paging').insert([
18+
t.db.collection('test_paging').insertMany([
1819
{
1920
counter: 1,
2021
},
@@ -45,7 +46,7 @@ describe('aggregate', () => {
4546
color: 'blue',
4647
},
4748
]),
48-
t.db.collection('test_aggregation').insert([
49+
t.db.collection('test_aggregation').insertMany([
4950
{
5051
items: [1, 2, 3],
5152
},
@@ -59,7 +60,7 @@ describe('aggregate', () => {
5960
items: [2, 4, 5],
6061
},
6162
]),
62-
t.db.collection('test_aggregation_lookup').insert([
63+
t.db.collection('test_aggregation_lookup').insertMany([
6364
{
6465
_id: 1,
6566
name: 'mercury',
@@ -85,15 +86,15 @@ describe('aggregate', () => {
8586
name: 'saturn',
8687
},
8788
]),
88-
t.db.collection('test_aggregation_lookup').ensureIndex(
89+
t.db.collection('test_aggregation_lookup').createIndex(
8990
{
9091
name: 'text',
9192
},
9293
{
9394
name: 'test_index',
9495
}
9596
),
96-
t.db.collection('test_aggregation_sort').insert([
97+
t.db.collection('test_aggregation_sort').insertMany([
9798
{
9899
name: 'Alpha',
99100
},
@@ -115,7 +116,7 @@ describe('aggregate', () => {
115116
]),
116117
t.db
117118
.collection('test_null_values')
118-
.insert(
119+
.insertMany(
119120
[
120121
undefined,
121122
undefined,
@@ -131,7 +132,10 @@ describe('aggregate', () => {
131132
]);
132133
});
133134

134-
afterAll(() => mongod.stop());
135+
afterAll(async () => {
136+
await (client ? client.close() : t.db.close());
137+
await mongod.stop();
138+
});
135139

136140
beforeEach(() => {
137141
paging.config.COLLATION = undefined;

‎test/find.test.js

+22-18
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1-
const paging = require('../');
2-
const dbUtils = require('./support/db');
3-
const _ = require('underscore');
41
const { ObjectId } = require('mongoist');
5-
const driver = process.env.DRIVER;
2+
const _ = require('underscore');
63

7-
let mongod;
4+
const dbUtils = require('./support/db');
5+
const paging = require('../');
6+
const driver = process.env.DRIVER;
87

98
describe('find', () => {
9+
let mongod;
10+
let client;
1011
const t = {};
1112
beforeAll(async () => {
1213
mongod = dbUtils.start();
13-
t.db = await dbUtils.db(mongod, driver);
14+
({ db: t.db, client } = await dbUtils.db(mongod, driver));
1415

1516
// Set up collections once for testing later.
1617
await Promise.all([
17-
t.db.collection('test_paging').insert([
18+
t.db.collection('test_paging').insertMany([
1819
{
1920
counter: 1,
2021
},
@@ -45,7 +46,7 @@ describe('find', () => {
4546
color: 'blue',
4647
},
4748
]),
48-
t.db.collection('test_duplicate_custom_fields').insert([
49+
t.db.collection('test_duplicate_custom_fields').insertMany([
4950
{
5051
_id: 6,
5152
counter: 6,
@@ -77,7 +78,7 @@ describe('find', () => {
7778
timestamp: 1477347772077,
7879
},
7980
]),
80-
t.db.collection('test_paging_custom_fields').insert([
81+
t.db.collection('test_paging_custom_fields').insertMany([
8182
{
8283
counter: 6,
8384
timestamp: 1477347800603,
@@ -103,7 +104,7 @@ describe('find', () => {
103104
timestamp: 1477347755654,
104105
},
105106
]),
106-
t.db.collection('test_paging_date').insert([
107+
t.db.collection('test_paging_date').insertMany([
107108
{
108109
counter: 2,
109110
date: new Date(1477347763813),
@@ -121,7 +122,7 @@ describe('find', () => {
121122
date: new Date(1477347755654),
122123
},
123124
]),
124-
t.db.collection('test_paging_date_in_object').insert([
125+
t.db.collection('test_paging_date_in_object').insertMany([
125126
{
126127
counter: 2,
127128
start: { date: new Date(1477347763813) },
@@ -139,7 +140,7 @@ describe('find', () => {
139140
start: { date: new Date(1477347755654) },
140141
},
141142
]),
142-
t.db.collection('test_paging_limits').insert([
143+
t.db.collection('test_paging_limits').insertMany([
143144
{
144145
counter: 6,
145146
},
@@ -159,7 +160,7 @@ describe('find', () => {
159160
counter: 1,
160161
},
161162
]),
162-
t.db.collection('test_sorting').insert([
163+
t.db.collection('test_sorting').insertMany([
163164
{
164165
name: 'Alpha',
165166
},
@@ -179,7 +180,7 @@ describe('find', () => {
179180
name: 'aleph',
180181
},
181182
]),
182-
t.db.collection('test_null_values').insert(
183+
t.db.collection('test_null_values').insertMany(
183184
[
184185
undefined,
185186
undefined,
@@ -196,7 +197,10 @@ describe('find', () => {
196197
]);
197198
});
198199

199-
afterAll(() => mongod.stop());
200+
afterAll(async () => {
201+
await (client ? client.close() : t.db.close());
202+
await mongod.stop();
203+
});
200204

201205
beforeEach(() => {
202206
paging.config.COLLATION = undefined;
@@ -519,7 +523,7 @@ describe('find', () => {
519523

520524
it('uses the hint parameter', async () => {
521525
const collection = t.db.collection('test_paging');
522-
await t.db.collection('test_paging').ensureIndex({ color: 1 }, { name: 'color_1' });
526+
await t.db.collection('test_paging').createIndex({ color: 1 }, { name: 'color_1' });
523527
// First page.
524528
const res = await paging.find(collection, {
525529
query: {
@@ -710,7 +714,7 @@ describe('find', () => {
710714

711715
describe('when using strings as _ids', () => {
712716
beforeEach(async () => {
713-
await t.db.collection('test_paging_string_ids').insert([
717+
await t.db.collection('test_paging_string_ids').insertMany([
714718
{
715719
_id: new ObjectId().toString(),
716720
counter: 1,
@@ -1072,7 +1076,7 @@ describe('find', () => {
10721076
const collection = t.db.collection('test_paging_string_ids');
10731077
await t.db
10741078
.collection('test_paging_string_ids')
1075-
.ensureIndex({ color: 1 }, { name: 'color_1' });
1079+
.createIndex({ color: 1 }, { name: 'color_1' });
10761080
// First page.
10771081
const res = await paging.find(collection, {
10781082
query: {

0 commit comments

Comments
 (0)