Merge branch 'master' of github.com:Automattic/mongoose

vkarpov15 · vkarpov15 · commit 17a5d5a0b921 · 2022-03-21T18:58:20.000-04:00
diff --git a/benchmarks/index.js b/benchmarks/index.js
@@ -75,7 +75,6 @@ function run(label, fn) {
   res.heapUsed = used.heapUsed - started.heapUsed;
   log('change: ', res);
   a = res = used = time = started = start = total = i = null;
-  // console.error(((used.vsize - started.vsize) / 1048576)+' MB');
 }
 
 run('string', function() {
diff --git a/benchmarks/validate.js b/benchmarks/validate.js
@@ -1,5 +1,3 @@
-// require('nodetime').profile();
-
 'use strict';
 
 const mongoose = require('../../mongoose');
@@ -25,8 +23,7 @@ const breakfastSchema = new Schema({
   }
 });
 const Breakfast = mongoose.model('Breakfast', breakfastSchema);
-// const time1 = (new Date - start1);
-// console.error('reading from disk and parsing JSON took %d ms', time1);
+
 const badBreakfast = new Breakfast({
   eggs: 2,
   bacon: 0,
@@ -38,23 +35,7 @@ const goodBreakfast = new Breakfast({
   bacon: 1,
   drink: 'Tea'
 })
-// const start = new Date;
-// const total = 10000000;
-// let i = total;
-// let len;
-
-// for (i = 0, len = total; i < len; ++i) {
-
-// const goodBreakfast = new Breakfast({
-//   eggs: 6,
-//   bacon: 1,
-//   drink: 'Tea'
-// })
-//       goodBreakfast.validateSync();
-// }
 
-// const time = (new Date - start) / 1000;
-// console.error('took %d seconds for %d docs (%d dps)', time, total, total / time);
 const suite = new Benchmark.Suite()
   suite
   .add('invalid async', {
diff --git a/examples/statics/statics.js b/examples/statics/statics.js
@@ -24,7 +24,7 @@ async function run() {
   const result = await Person.findPersonByName('bill');
 
   console.log(result);
-  cleanup();
+  await cleanup();
 }
 
 async function cleanup() {
diff --git a/lib/browserDocument.js b/lib/browserDocument.js
@@ -17,6 +17,7 @@ const isObject = require('./helpers/isObject');
  * Document constructor.
  *
  * @param {Object} obj the values to set
+ * @param {Object} schema
  * @param {Object} [fields] optional object containing the fields which were selected in the query returning this document and any populated paths data
  * @param {Boolean} [skipId] bool, should we auto create an ObjectId _id
  * @inherits NodeJS EventEmitter https://nodejs.org/api/events.html#events_class_events_eventemitter
diff --git a/lib/cursor/AggregationCursor.js b/lib/cursor/AggregationCursor.js
@@ -26,7 +26,6 @@ const util = require('util');
  * Use [`Aggregate#cursor()`](/docs/api.html#aggregate_Aggregate-cursor) instead.
  *
  * @param {Aggregate} agg
- * @param {Object} options
  * @inherits Readable
  * @event `cursor`: Emitted when the cursor is created
  * @event `error`: Emitted when an error occurred
diff --git a/lib/helpers/query/castFilterPath.js b/lib/helpers/query/castFilterPath.js
@@ -41,7 +41,6 @@ module.exports = function castFilterPath(query, schematype, val) {
         }
         continue;
       }
-      // cast(schematype.caster ? schematype.caster.schema : schema, nested, options, context);
     } else {
       val[$cond] = schematype.castForQueryWrapper({
         $conditional: $cond,
diff --git a/lib/model.js b/lib/model.js
@@ -1885,7 +1885,7 @@ Model.discriminators;
  * ####Note:
  * Only translate arguments of object type anything else is returned raw
  *
- * @param {Object} raw fields/conditions that may contain aliased keys
+ * @param {Object} fields fields/conditions that may contain aliased keys
  * @return {Object} the translated 'pure' fields/conditions
  */
 Model.translateAliases = function translateAliases(fields) {
diff --git a/lib/schema/SubdocumentPath.js b/lib/schema/SubdocumentPath.js
@@ -26,7 +26,7 @@ module.exports = SubdocumentPath;
  * Single nested subdocument SchemaType constructor.
  *
  * @param {Schema} schema
- * @param {String} key
+ * @param {String} path
  * @param {Object} options
  * @inherits SchemaType
  * @api public
diff --git a/lib/schema/array.js b/lib/schema/array.js
@@ -32,6 +32,7 @@ const emptyOpts = Object.freeze({});
  * @param {String} key
  * @param {SchemaType} cast
  * @param {Object} options
+ * @param {Object} schemaOptions
  * @inherits SchemaType
  * @api public
  */
diff --git a/lib/schema/documentarray.js b/lib/schema/documentarray.js
@@ -30,6 +30,7 @@ let Subdocument;
  * @param {String} key
  * @param {Schema} schema
  * @param {Object} options
+ * @param {Object} schemaOptions
  * @inherits SchemaArray
  * @api public
  */
diff --git a/lib/types/array/methods/index.js b/lib/types/array/methods/index.js
@@ -445,6 +445,7 @@ const methods = {
    * Return whether or not the `obj` is included in the array.
    *
    * @param {Object} obj the item to check
+   * @param {Number} fromIndex
    * @return {Boolean}
    * @api public
    * @method includes
@@ -460,6 +461,7 @@ const methods = {
    * Return the index of `obj` or `-1` if not found.
    *
    * @param {Object} obj the item to look for
+   * @param {Number} fromIndex
    * @return {Number}
    * @api public
    * @method indexOf
diff --git a/lib/virtualtype.js b/lib/virtualtype.js
@@ -24,6 +24,7 @@ const utils = require('./utils');
  * @param {Number} [options.skip=null] add a default `skip` to the `populate()` query
  * @param {Number} [options.perDocumentLimit=null] For legacy reasons, `limit` with `populate()` may give incorrect results because it only executes a single query for every document being populated. If you set `perDocumentLimit`, Mongoose will ensure correct `limit` per document by executing a separate query for each document to `populate()`. For example, `.find().populate({ path: 'test', perDocumentLimit: 2 })` will execute 2 additional queries if `.find()` returns 2 documents.
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
+ * @param {string} name
  * @api public
  */
 
diff --git a/test/index.test.js b/test/index.test.js
@@ -773,7 +773,7 @@ describe('mongoose module:', function() {
 
     const movie = await Movie.create({ name: 'The Empire Strikes Back' });
     await Person.create({ name: 'Test1', favoriteMovie: movie._id });
-    assert.rejects(async() => {
+    await assert.rejects(async() => {
       await Person.findOne().populate({ path: 'favoriteGame' });
     }, { message: 'Cannot populate path `favoriteGame` because it is not in your schema. Set the `strictPopulate` option to false to override.' });
   });
@@ -788,7 +788,7 @@ describe('mongoose module:', function() {
     }));
     const movie = await Movie.create({ name: 'The Empire Strikes Back' });
     await Person.create({ name: 'Test1', favoriteMovie: movie._id });
-    assert.rejects(async() => {
+    await assert.rejects(async() => {
       await Person.findOne().populate({ path: 'favoriteGame', strictPopulate: true });
     }, { message: 'Cannot populate path `favoriteGame` because it is not in your schema. Set the `strictPopulate` option to false to override.' });
   });
@@ -912,4 +912,4 @@ describe('mongoose module:', function() {
       assert.deepEqual(await m.syncIndexes(), {});
     });
   });
-});
+});
diff --git a/test/types/populate.test.ts b/test/types/populate.test.ts
@@ -164,21 +164,37 @@ function gh11503() {
   interface User {
     friends: Types.ObjectId[];
   }
-  const UserSchema = new Schema<User>({
+  const userSchema = new Schema<User>({
     friends: [{ type: Schema.Types.ObjectId, ref: 'friends' }]
   });
-  const Users = model<User>('friends', UserSchema);
+  const User = model<User>('friends', userSchema);
 
-  Users.findOne({}).populate('friends').then(user => {
+  User.findOne({}).populate('friends').then(user => {
     expectType<Types.ObjectId | undefined>(user?.friends[0]);
     expectError(user?.friends[0].blocked);
     expectError(user?.friends.map(friend => friend.blocked));
   });
 
-  Users.findOne({}).populate<{friends: Friend[]}>('friends').then(user => {
+  User.findOne({}).populate<{friends: Friend[]}>('friends').then(user => {
     expectAssignable<Friend>(user?.friends[0]);
     expectType<boolean>(user?.friends[0].blocked);
     const firstFriendBlockedValue = user?.friends.map(friend => friend)[0];
     expectType<boolean>(firstFriendBlockedValue?.blocked);
   });
+}
+
+
+function gh11544() {
+
+  interface User {
+    friends: Types.ObjectId[];
+  }
+  const userSchema = new Schema<User>({
+    friends: [{ type: Schema.Types.ObjectId, ref: 'friends' }]
+  });
+  const User = model<User>('friends', userSchema);
+
+  User.findOne({}).populate({ path: 'friends', strictPopulate: false });
+  User.findOne({}).populate({ path: 'friends', strictPopulate: true });
+  User.findOne({}).populate({ path: 'friends', populate: { path: 'someNestedPath', strictPopulate: false } });
 }
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -709,6 +709,8 @@ declare module 'mongoose' {
     model?: string | Model<any>;
     /** optional query options like sort, limit, etc */
     options?: any;
+    /** optional boolean, set to `false` to allow populating paths that aren't in the schema */
+    strictPopulate?: boolean;
     /** deep populate */
     populate?: string | PopulateOptions | (string | PopulateOptions)[];
     /**

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,6 @@ function run(label, fn) {`
`75`	`75`	`res.heapUsed = used.heapUsed - started.heapUsed;`
`76`	`76`	`log('change: ', res);`
`77`	`77`	`a = res = used = time = started = start = total = i = null;`
`78`		`- // console.error(((used.vsize - started.vsize) / 1048576)+' MB');`
`79`	`78`	`}`
`80`	`79`
`81`	`80`	`run('string', function() {`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ async function run() {`
`24`	`24`	`const result = await Person.findPersonByName('bill');`
`25`	`25`
`26`	`26`	`console.log(result);`
`27`		`- cleanup();`
	`27`	`+ await cleanup();`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`async function cleanup() {`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ const isObject = require('./helpers/isObject');`
`17`	`17`	`* Document constructor.`
`18`	`18`	`*`
`19`	`19`	`* @param {Object} obj the values to set`
	`20`	`+ * @param {Object} schema`
`20`	`21`	`* @param {Object} [fields] optional object containing the fields which were selected in the query returning this document and any populated paths data`
`21`	`22`	`* @param {Boolean} [skipId] bool, should we auto create an ObjectId _id`
`22`	`23`	`* @inherits NodeJS EventEmitter https://nodejs.org/api/events.html#events_class_events_eventemitter`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,6 @@ const util = require('util');`
`26`	`26`	* Use [`Aggregate#cursor()`](/docs/api.html#aggregate_Aggregate-cursor) instead.
`27`	`27`	`*`
`28`	`28`	`* @param {Aggregate} agg`
`29`		`- * @param {Object} options`
`30`	`29`	`* @inherits Readable`
`31`	`30`	* @event `cursor`: Emitted when the cursor is created
`32`	`31`	* @event `error`: Emitted when an error occurred
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,6 @@ module.exports = function castFilterPath(query, schematype, val) {`
`41`	`41`	`}`
`42`	`42`	`continue;`
`43`	`43`	`}`
`44`		`- // cast(schematype.caster ? schematype.caster.schema : schema, nested, options, context);`
`45`	`44`	`} else {`
`46`	`45`	`val[$cond] = schematype.castForQueryWrapper({`
`47`	`46`	`$conditional: $cond,`
Original file line number	Diff line number	Diff line change
`@@ -1885,7 +1885,7 @@ Model.discriminators;`
`1885`	`1885`	`* ####Note:`
`1886`	`1886`	`* Only translate arguments of object type anything else is returned raw`
`1887`	`1887`	`*`
`1888`		`- * @param {Object} raw fields/conditions that may contain aliased keys`
	`1888`	`+ * @param {Object} fields fields/conditions that may contain aliased keys`
`1889`	`1889`	`* @return {Object} the translated 'pure' fields/conditions`
`1890`	`1890`	`*/`
`1891`	`1891`	`Model.translateAliases = function translateAliases(fields) {`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ module.exports = SubdocumentPath;`
`26`	`26`	`* Single nested subdocument SchemaType constructor.`
`27`	`27`	`*`
`28`	`28`	`* @param {Schema} schema`
`29`		`- * @param {String} key`
	`29`	`+ * @param {String} path`
`30`	`30`	`* @param {Object} options`
`31`	`31`	`* @inherits SchemaType`
`32`	`32`	`* @api public`