Merge branch '4.x' into patch-11

Author: AbdelrahmanHafez

.gitignore

@@ -34,3 +34,7 @@ tools/31*
 *.key
 
 docs/*.html
+
+test/files/main.js
+
+.config.js

.npmignore

@@ -17,3 +17,7 @@ format_deps.js
 tools/31*
 *.key
 data/
+
+test/files
+
+.config.js

.travis.yml

@@ -1,6 +1,8 @@
 language: node_js
 sudo: false
 node_js:
+  - "9"
+  - "8"
   - "7"
   - "6"
   - "5"
@@ -9,14 +11,16 @@ node_js:
   - "0.10"
   - "iojs"
 before_script:
-  - wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-2.6.11.tgz
-  - tar -zxvf mongodb-linux-x86_64-2.6.11.tgz
+  - wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.4.23.tgz
+  - tar -zxvf mongodb-linux-x86_64-3.4.23.tgz
   - mkdir -p ./data/db/27017
   - mkdir -p ./data/db/27000
-  - ./mongodb-linux-x86_64-2.6.11/bin/mongod --fork --nopreallocj --dbpath ./data/db/27017 --syslog --port 27017
+  - printf "\n--timeout 8000" >> ./test/mocha.opts
+  - ./mongodb-linux-x86_64-3.4.23/bin/mongod --fork --dbpath ./data/db/27017 --syslog --port 27017
+  - export PATH=`pwd`/mongodb-linux-x86_64-3.4.23/bin/:$PATH
+  - sleep 3
 script:
   - npm test
   - npm run lint
-  - npm run nsp
 notifications:
   email: false

History.md

@@ -1,3 +1,150 @@
+4.13.21 / 2020-07-12
+====================
+ * fix(query): delete top-level `_bsontype` property in queries to prevent silent empty queries #8222
+
+4.13.20 / 2020-01-07
+====================
+ * fix(schema): make aliases handle mongoose-lean-virtuals #6069
+
+4.13.19 / 2019-07-02
+====================
+ * fix(aggregate): make `setOptions()` work as advertised #7950 #6011 [cdimitroulas](https://github.com/cdimitroulas)
+
+4.13.18 / 2019-01-21
+====================
+ * fix(model): handle setting populated path set via `Document#populate()` #7302
+ * fix(cast): backport fix from #7290 to 4.x
+
+4.13.17 / 2018-08-30
+====================
+ * fix(document): disallow setting `constructor` and `prototype` if strict mode false
+
+4.13.16 / 2018-08-30
+====================
+ * fix(document): disallow setting __proto__ if strict mode false
+ * feat(error): backport adding modified paths to VersionError #6928 [freewil](https://github.com/freewil)
+
+4.13.15 / 2018-08-14
+====================
+ * fix(mongoose): add global `usePushEach` option for easier Mongoose 4.x + MongoDB 3.6 #6858
+ * chore: fix flakey tests for 4.x #6853 [Fonger](https://github.com/Fonger)
+ * feat(error): add version number to VersionError #6852 [freewil](https://github.com/freewil)
+
+4.13.14 / 2018-05-25
+====================
+ * fix(model): handle retainKeyOrder option in findOneAndUpdate() #6484
+
+4.13.13 / 2018-05-17
+====================
+ * fix(update): stop clobbering $in when casting update #6441 #6339
+ * fix: upgrade async -> 2.6.0 re: security warning
+
+4.13.12 / 2018-03-13
+====================
+ * fix(document): make virtual get() return undefined instead of null if no getters #6223
+ * docs: fix url in useMongoClient error message #6219 #6217 [lineus](https://github.com/lineus)
+ * fix(discriminator): don't copy `discriminators` property from base schema #6122 #6064
+
+4.13.11 / 2018-02-07
+====================
+ * docs: fix links in 4.x docs #6081
+ * chore: add release script that uses --tag for npm publish for 4.x releases #6063
+
+4.13.10 / 2018-01-28
+====================
+ * docs(model+query): add lean() option to Model helpers #5996 [aguyinmontreal](https://github.com/aguyinmontreal)
+ * fix: use lazy loading so we can build mongoose with webpack #5993 #5842
+ * docs(connections): clarify multi-mongos with useMongoClient for 4.x docs #5984
+ * fix(populate): handle populating embedded discriminator paths #5970
+ * docs(query+aggregate): add more detail re: maxTimeMS #4066
+
+4.13.9 / 2018-01-07
+===================
+ * chore: update marked (dev dependency) re: security vulnerability #5951 [ChristianMurphy](https://github.com/ChristianMurphy)
+ * fix: upgrade mongodb -> 2.2.34 for ipv6 and autoReconnect fixes #5794 #5760
+ * docs: use useMongooseAggCursor for aggregate docs #2955
+
+4.13.8 / 2017-12-27
+===================
+ * docs(guide): use more up-to-date syntax for autoIndex example #5933
+ * docs: fix grammar #5927 [abagh0703](https://github.com/abagh0703)
+ * fix: propagate lean options to child schemas #5914
+ * fix(populate): use correct model with discriminators + nested populate #5858
+
+4.13.7 / 2017-12-11
+===================
+ * docs(schematypes): fix typo #5889 [gokaygurcan](https://github.com/gokaygurcan)
+ * fix(cursor): handle `reject(null)` with eachAsync callback #5875 #5874 [ZacharyRSmith](https://github.com/ZacharyRSmith)
+ * fix: disallow setting `mongoose.connection` to invalid values #5871 [jinasonlin](https://github.com/jinasonlin)
+ * docs(middleware): suggest using `return next()` to stop middleware execution #5866
+ * docs(connection): improve connection string query param docs #5864
+ * fix(document): run validate hooks on array subdocs even if not directly modified #5861
+ * fix(discriminator): don't treat $meta as defining projection when querying #5859
+ * fix(types): handle Decimal128 when using bson-ext on server side #5850
+ * fix(document): ensure projection with only $slice isn't treated as inclusive for discriminators #4991
+ * fix(model): throw error when passing non-object to create() #2037
+
+4.13.6 / 2017-12-02
+===================
+ * fix(schema): support strictBool option in schema #5856 [ekulabuhov](https://github.com/ekulabuhov)
+ * fix(update): make upsert option consistently handle truthy values, not just booleans, for updateOne() #5839
+ * refactor: remove unnecessary constructor check #2057
+ * docs(query): correct function signature for .mod() helper #1806
+ * fix(query): report ObjectParameterError when passing non-object as filter to find() and findOne() #1698
+
+4.13.5 / 2017-11-24
+===================
+ * fix(model): handle update cast errors correctly with bulkWrite #5845 [Michael77](https://github.com/Michael77)
+ * docs: add link to bufferCommands option #5844 [ralphite](https://github.com/ralphite)
+ * fix(model): allow virtual ref function to return arrays #5834 [brunohcastro](https://github.com/brunohcastro)
+ * fix(query): don't throw uncaught error if query filter too big #5812
+ * fix(document): if setting unselected nested path, don't overwrite nested path #5800
+ * fix(document): support calling `populate()` on nested document props #5703
+ * fix: add `strictBool` option for schema type boolean #5344 #5211 #4245
+ * docs(faq): add faq re: typeKey #1886
+ * docs(query): add more detailed docs re: options #1702
+
+4.13.4 / 2017-11-17
+===================
+ * fix(aggregate): add chainable .option() helper for setting arbitrary options #5829
+ * fix(aggregate): add `.pipeline()` helper to get the current pipeline #5825
+ * docs: grammar fixes for `unique` FAQ #5823 [mfluehr](https://github.com/mfluehr)
+ * chore: add node 9 to travis #5822 [superheri](https://github.com/superheri)
+ * fix(model): fix infinite recursion with recursive embedded discriminators #5821 [Faibk](https://github.com/Faibk)
+
+4.13.3 / 2017-11-15
+===================
+ * chore: add node 8 to travis #5818 [superheri](https://github.com/superheri)
+ * fix(document): don't apply transforms to nested docs when updating already saved doc #5807
+
+4.13.2 / 2017-11-11
+===================
+ * feat(buffer): add support for subtype prop #5530
+
+4.13.1 / 2017-11-08
+===================
+ * fix: accept multiple paths or array of paths to depopulate #5798 #5797 [adamreisnz](https://github.com/adamreisnz)
+ * fix(document): pass default array as actual array rather than taking first element #5780
+ * fix(model): increment version when $set-ing it in a save() that requires a version bump #5779
+ * fix(query): don't explicitly project in discriminator key if user projected in parent path #5775 #5754
+ * fix(model): cast query option to geoNear() #5765
+ * fix(query): don't treat projection with just $slice as inclusive #5737
+ * fix(discriminator): defer applying embedded discriminator hooks until top-level model is compiled #5706
+ * docs(discriminator): add warning to always attach hooks before calling discriminator() #5706
+
+4.13.0 / 2017-11-02
+===================
+ * feat(aggregate): add $addFields helper #5740 [AyushG3112](https://github.com/AyushG3112)
+ * feat(connection): add connection-level bufferCommands #5720
+ * feat(connection): add createCollection() helper #5712
+ * feat(populate): support setting localField and foreignField to functions #5704 #5602
+ * feat(query): add multipleCastError option for aggregating cast errors when casting update #5609
+ * feat(populate): allow passing a function to virtual ref #5602
+ * feat(schema): add excludeIndexes option to optionally prevent collecting indexes from nested schemas #5575
+ * feat(model): report validation errors from `insertMany()` if using `ordered: false` and `rawResult: true` #5337
+ * feat(aggregate): add pre/post aggregate middleware #5251
+ * feat(schema): allow using `set` as a schema path #1939
+
 4.12.6 / 2017-11-01
 ===================
  * fix(schema): make clone() copy query helpers correctly #5752

Makefile

@@ -3,7 +3,7 @@ DOCS_ = $(shell find lib/ -name '*.js')
 DOCS = $(DOCS_:.js=.json)
 DOCFILE = docs/source/_docs
 STABLE_BRANCH = master
-LEGACY_BRANCH = 3.8.x
+LEGACY_BRANCH = 4.x
 
 test:
 	@MONGOOSE_DISABLE_STABILITY_WARNING=1 ./node_modules/.bin/mocha $(T) --async-only test/*.test.js

README.md

@@ -5,8 +5,6 @@ Mongoose is a [MongoDB](https://www.mongodb.org/) object modeling tool designed
 [![Slack Status](http://slack.mongoosejs.io/badge.svg)](http://slack.mongoosejs.io)
 [![Build Status](https://api.travis-ci.org/Automattic/mongoose.svg?branch=master)](https://travis-ci.org/Automattic/mongoose)
 [![NPM version](https://badge.fury.io/js/mongoose.svg)](http://badge.fury.io/js/mongoose)
-[![Dependency Status](https://gemnasium.com/Automattic/mongoose.svg)](https://gemnasium.com/Automattic/mongoose)
-[![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/vkarpov?utm_source=github&utm_medium=button&utm_term=vkarpov&utm_campaign=github)
 
 ## Documentation
 
@@ -20,6 +18,16 @@ Mongoose is a [MongoDB](https://www.mongodb.org/) object modeling tool designed
   - [Help Forum](http://groups.google.com/group/mongoose-orm)
   - [MongoDB Support](https://docs.mongodb.org/manual/support/)
 
+## Importing
+
+```javascript
+// Using Node.js `require()`
+const mongoose = require('mongoose');
+
+// Using ES6 imports
+import mongoose from 'mongoose';
+```
+
 ## Plugins
 
 Check out the [plugins search site](http://plugins.mongoosejs.io/) to see hundreds of related modules from the community. Next, learn how to write your own plugin from the [docs](http://mongoosejs.com/docs/plugins.html) or [this blog post](http://thecodebarbarian.com/2015/03/06/guide-to-mongoose-plugins).

docs/2.7.x/docs/populate.html

@@ -230,7 +230,7 @@ <h1>Populate - DBRef-like behavior</h1>
 var Person = mongoose.model('Person', PersonSchema);
 </code></pre>
 
-<p>So far we've created two models. Our <code>Person</code> model has it's <code>stories</code> field set to an array of <code>ObjectId</code>s. The <code>ref</code> option is what tells Mongoose in which model to look, in our case the <code>Story</code> model. All <code>_id</code>s we store here must be document <code>_id</code>s from the <code>Story</code> model. We also added a <code>_creator</code> <code>ObjectId</code> to our <code>Story</code> schema which refers to a single <code>Person</code>.</p>
+<p>So far we've created two models. Our <code>Person</code> model has its <code>stories</code> field set to an array of <code>ObjectId</code>s. The <code>ref</code> option is what tells Mongoose in which model to look, in our case the <code>Story</code> model. All <code>_id</code>s we store here must be document <code>_id</code>s from the <code>Story</code> model. We also added a <code>_creator</code> <code>ObjectId</code> to our <code>Story</code> schema which refers to a single <code>Person</code>.</p>
 
 <h2>Saving a ref (to the parent)</h2>
 

docs/connections.jade

@@ -49,7 +49,7 @@ block content
     }, 60000);
 
   :markdown
-    To disable buffering, turn off the [`bufferCommands` option on your schema](http://mongoosejs.com/docs/guide.html#bufferCommands).
+    To disable buffering, turn off the [`bufferCommands` option on your schema](./guide.html#bufferCommands).
     If you have `bufferCommands` on and your connection is hanging, try turning
     `bufferCommands` off to see if you haven't opened a connection properly.
 
@@ -92,7 +92,7 @@ block content
 
   h3#callback Callback
   :markdown
-    The `connect()` function also accepts a callback parameter and returns a [promise](http://mongoosejs.com/docs/promises.html).
+    The `connect()` function also accepts a callback parameter and returns a [promise](./promises.html).
   :js
     mongoose.connect(uri, options, function(error) {
       // Check error in initial connection. There is no 2nd param to the callback.
@@ -106,26 +106,24 @@ block content
 
   h4#connection-string-options Connection String Options
   :markdown
-    Mongoose supports the following options in the connection string.
-
-    * [ssl](http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html)
-    * [poolSize](http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html)
-    * [autoReconnect](http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html)
-    * [socketTimeoutMS](http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html)
-    * [connectTimeoutMS](http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html)
-    * [authSource](http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html)
-    * [retries](http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html)
-    * [authMechanism](http://mongodb.github.io/node-mongodb-native/2.2/tutorials/connect/authenticating/)
-    * [reconnectWait](http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html)
-    * [rs_name](http://mongodb.github.io/node-mongodb-native/2.1/api/ReplSet.html)
-    * [replicaSet](http://mongodb.github.io/node-mongodb-native/2.1/api/ReplSet.html)
-    * [nativeParser](http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html)
-    * [w](http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html)
-    * [journal](http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html)
-    * [wtimeoutMS](http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html)
-    * [readPreference](http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html)
-    * [readPreferenceTags](http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html)
-    * [sslValidate](http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html)
+    You can also specify options in your connection string as [parameters in the query string](https://en.wikipedia.org/wiki/Query_string) portion of the URI.
+  :js
+    mongoose.connect('mongodb://localhost:27017/test?connectTimeoutMS=1000', { useMongoClient: true });
+    // The above is equivalent to:
+    mongoose.connect('mongodb://localhost:27017/test', {
+      useMongoClient: true,
+      connectTimeoutMS: 1000
+    });
+  :markdown
+    The disadvantage of putting options in the query string is that query
+    string options are harder to read. The advantage is that you only need a
+    single configuration option, the URI, rather than separate options for
+    `socketTimeoutMS`, `connectTimeoutMS`, etc. Best practice is to put options
+    that likely differ between development and production, like `replicaSet`
+    or `ssl`, in the connection string, and options that should remain constant,
+    like `connectTimeoutMS` or `poolSize`, in the options object.
+
+    The MongoDB docs have a full list of [supported connection string options](https://docs.mongodb.com/manual/reference/connection-string/)
 
   h4#keepAlive A note about keepAlive
   .important
@@ -157,9 +155,16 @@ block content
 
   h3#mongos_connections Multi-mongos support
   :markdown
-    High availability over multiple `mongos` instances is also supported. Pass a connection string for your `mongos` instances and set the `mongos` option to true:
+    High availability over multiple `mongos` instances is also supported.
+    Pass a connection string for your `mongos` instances. If you are not using
+    the `useMongoClient` option, you must also set the `mongos` option:
   :js
     mongoose.connect('mongodb://mongosA:27501,mongosB:27501', { mongos: true }, cb);
+  :markdown
+    With `useMongoClient`, you do not need to set the `mongos` option. You also
+    do **not** need to use `mongos` or `useMongoClient` in mongoose 5.x.
+  :js
+    mongoose.connect('mongodb://mongosA:27501,mongosB:27501', { useMongoClient: true }, cb);
 
   h3#multiple_connections Multiple connections
   :markdown

docs/documents.jade

@@ -22,7 +22,7 @@ block content
       });
     });
   :markdown
-    You can also use [`.set()`](http://mongoosejs.com/docs/api.html#document_Document-set)
+    You can also use [`.set()`](./api.html#document_Document-set)
     to modify documents. Under the hood, `tank.size = 'large';` becomes `tank.set({ size: 'large' })`.
   :js
     Tank.findById(id, function (err, tank) {
@@ -51,7 +51,7 @@ block content
     });
   :markdown
     The `findAndUpdate/Remove` static methods all make a change to at most one document, and return it with just one call to the database. There [are](./api.html#model_Model.findByIdAndRemove) [several](./api.html#model_Model.findOneAndUpdate) [variations](./api.html#model_Model.findOneAndRemove) on the [findAndModify](http://www.mongodb.org/display/DOCS/findAndModify+Command) theme. Read the [API](./api.html) docs for more detail.
-    
+
     _Note that `findAndUpdate/Remove` do *not* execute any hooks or validation before making the change in the database. You can use the [`runValidators` option](/docs/validation.html#update-validators) to access a limited subset of document validation. However, if you need hooks and full document validation, first query for the document and then `save()` it._
 
   h3 Validating
@@ -61,7 +61,7 @@ block content
   h3 Overwriting
   :markdown
     You can overwrite an entire document using `.set()`. This is handy if you
-    want to change what document is being saved in [middleware](http://mongoosejs.com/docs/middleware.html).
+    want to change what document is being saved in [middleware](./docs/middleware.html).
   :js
     Tank.findById(id, function (err, tank) {
       if (err) return handleError(err);