Merge branch 'master' into vkarpov15/gh-13755

vkarpov15 · vkarpov15 · commit 09e84454ca69 · 2023-10-10T14:38:08.000-04:00
diff --git a/.mocharc.yml b/.mocharc.yml
@@ -2,3 +2,7 @@ reporter: spec # better to identify failing / slow tests than "dot"
 ui: bdd # explicitly setting, even though it is mocha default
 require:
   - test/mocha-fixtures.js
+extension:
+  - test.js
+watch-files:
+  - test/**/*.js
diff --git a/.npmignore b/.npmignore
@@ -47,4 +47,13 @@ webpack.base.config.js
 notes.md
 list.out
 
-eslintrc.json
+# config files
+lgtm.yml
+.mocharc.yml
+.eslintrc.js
+.markdownlint-cli2.cjs
+tsconfig.json
+
+# scripts
+scripts/
+tools/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+7.6.1 / 2023-10-09
+==================
+ * fix: bump bson to match mongodb@5.9.0 exactly #13947 [hasezoey](https://github.com/hasezoey)
+ * fix: raw result deprecation message #13954 [simllll](https://github.com/simllll)
+ * type: add types for includeResultMetadata #13955 [simllll](https://github.com/simllll)
+ * perf(npmignore): ignore newer files #13946 [hasezoey](https://github.com/hasezoey)
+ * perf: move mocha config from package.json to mocharc #13948 [hasezoey](https://github.com/hasezoey)
+
 7.6.0 / 2023-10-06
 ==================
  * feat: upgrade mongodb node driver -> 5.9.0 #13927 #13926 [sanguineti](https://github.com/sanguineti)
diff --git a/lib/model.js b/lib/model.js
@@ -3780,6 +3780,7 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
   }
 
   setDefaultOptions();
+  const discriminatorKey = this.schema.options.discriminatorKey;
 
   const writeOperations = documents.reduce((accumulator, document, i) => {
     if (!options.skipValidation) {
@@ -3810,6 +3811,12 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
 
       _applyCustomWhere(document, where);
 
+      // Set the discriminator key, so bulk write casting knows which
+      // schema to use re: gh-13907
+      if (document[discriminatorKey] != null && !(discriminatorKey in where)) {
+        where[discriminatorKey] = document[discriminatorKey];
+      }
+
       document.$__version(where, delta);
       const writeOperation = { updateOne: { filter: where, update: changes } };
       utils.injectTimestampsOption(writeOperation.updateOne, options.timestamps);
diff --git a/lib/query.js b/lib/query.js
@@ -1680,7 +1680,7 @@ Query.prototype.setOptions = function(options, overwrite) {
 
 const printRawResultDeprecationWarning = util.deprecate(
   function printRawResultDeprecationWarning() {},
-  'The `rawResult` option for Mongoose queries is deprecated. Use `includeResultMetadata: false` as a replacement for `rawResult: true`.'
+  'The `rawResult` option for Mongoose queries is deprecated. Use `includeResultMetadata: true` as a replacement for `rawResult: true`.'
 );
 
 /*!
diff --git a/lib/schema.js b/lib/schema.js
@@ -723,19 +723,6 @@ Schema.prototype.add = function add(obj, prefix) {
         for (const key in val[0].discriminators) {
           schemaType.discriminator(key, val[0].discriminators[key]);
         }
-      } else if (val[0] != null && val[0].instanceOfSchema && val[0]._applyDiscriminators instanceof Map) {
-        const applyDiscriminators = val[0]._applyDiscriminators;
-        const schemaType = this.path(prefix + key);
-        for (const disc of applyDiscriminators.keys()) {
-          schemaType.discriminator(disc, applyDiscriminators.get(disc));
-        }
-      }
-      else if (val != null && val.instanceOfSchema && val._applyDiscriminators instanceof Map) {
-        const applyDiscriminators = val._applyDiscriminators;
-        const schemaType = this.path(prefix + key);
-        for (const disc of applyDiscriminators.keys()) {
-          schemaType.discriminator(disc, applyDiscriminators.get(disc));
-        }
       }
     } else if (Object.keys(val).length < 1) {
       // Special-case: {} always interpreted as Mixed path so leaf at this node
diff --git a/lib/schema/SubdocumentPath.js b/lib/schema/SubdocumentPath.js
@@ -55,6 +55,12 @@ function SubdocumentPath(schema, path, options) {
   this.$isSingleNested = true;
   this.base = schema.base;
   SchemaType.call(this, path, options, 'Embedded');
+
+  if (schema._applyDiscriminators != null) {
+    for (const disc of schema._applyDiscriminators.keys()) {
+      this.discriminator(disc, schema._applyDiscriminators.get(disc));
+    }
+  }
 }
 
 /*!
diff --git a/lib/schema/documentarray.js b/lib/schema/documentarray.js
@@ -88,6 +88,12 @@ function DocumentArrayPath(key, schema, options, schemaOptions) {
 
   this.$embeddedSchemaType.caster = this.Constructor;
   this.$embeddedSchemaType.schema = this.schema;
+
+  if (schema._applyDiscriminators != null) {
+    for (const disc of schema._applyDiscriminators.keys()) {
+      this.discriminator(disc, schema._applyDiscriminators.get(disc));
+    }
+  }
 }
 
 /**
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "7.6.0",
+  "version": "7.6.1",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -19,7 +19,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "bson": "^5.4.0",
+    "bson": "^5.5.0",
     "kareem": "2.5.1",
     "mongodb": "5.9.0",
     "mpath": "0.9.0",
@@ -39,7 +39,6 @@
     "axios": "1.1.3",
     "babel-loader": "8.2.5",
     "benchmark": "2.1.4",
-    "bluebird": "3.7.2",
     "broken-link-checker": "^0.7.8",
     "buffer": "^5.6.0",
     "cheerio": "1.0.0-rc.12",
@@ -130,14 +129,6 @@
   },
   "homepage": "https://mongoosejs.com",
   "browser": "./dist/browser.umd.js",
-  "mocha": {
-    "extension": [
-      "test.js"
-    ],
-    "watch-files": [
-      "test/**/*.js"
-    ]
-  },
   "config": {
     "mongodbMemoryServer": {
       "disablePostinstall": true
diff --git a/test/document.test.js b/test/document.test.js
@@ -12520,6 +12520,56 @@ describe('document', function() {
     await doc.save();
     assert.strictEqual(attachmentSchemaPreValidateCalls, 1);
   });
+
+  it('handles embedded discriminators defined using Schema.prototype.discriminator (gh-13898)', async function() {
+    const baseNestedDiscriminated = new Schema({
+      type: { type: Number, required: true }
+    }, { discriminatorKey: 'type' });
+
+    class BaseClass {
+      whoAmI() {
+        return 'I am baseNestedDiscriminated';
+      }
+    }
+    BaseClass.type = 1;
+
+    baseNestedDiscriminated.loadClass(BaseClass);
+
+    class NumberTyped extends BaseClass {
+      whoAmI() {
+        return 'I am NumberTyped';
+      }
+    }
+    NumberTyped.type = 3;
+
+    class StringTyped extends BaseClass {
+      whoAmI() {
+        return 'I am StringTyped';
+      }
+    }
+    StringTyped.type = 4;
+
+    baseNestedDiscriminated.discriminator(1, new Schema({}).loadClass(NumberTyped));
+    baseNestedDiscriminated.discriminator('3', new Schema({}).loadClass(StringTyped));
+
+    const containsNestedSchema = new Schema({
+      nestedDiscriminatedTypes: { type: [baseNestedDiscriminated], required: true }
+    });
+
+    class ContainsNested {
+      whoAmI() {
+        return 'I am ContainsNested';
+      }
+    }
+    containsNestedSchema.loadClass(ContainsNested);
+
+    const Test = db.model('Test', containsNestedSchema);
+    const instance = await Test.create({ type: 1, nestedDiscriminatedTypes: [{ type: 1 }, { type: '3' }] });
+    assert.deepStrictEqual(
+      instance.nestedDiscriminatedTypes.map(i => i.whoAmI()),
+      ['I am NumberTyped', 'I am StringTyped']
+    );
+  });
 });
 
 describe('Check if instance function that is supplied in schema option is availabe', function() {
diff --git a/test/model.test.js b/test/model.test.js
@@ -6239,6 +6239,27 @@ describe('Model', function() {
       assert.equal(writeOperations.length, 3);
     });
 
+    it('saves changes in discriminators if calling `bulkSave()` on base model (gh-13907)', async() => {
+      const schema = new mongoose.Schema(
+        { value: String },
+        { discriminatorKey: 'type' }
+      );
+      const typeASchema = new mongoose.Schema({ aValue: String });
+      schema.discriminator('A', typeASchema);
+
+      const TestModel = db.model('Test', schema);
+      const testData = { value: 'initValue', type: 'A', aValue: 'initAValue' };
+      const doc = await TestModel.create(testData);
+
+      doc.value = 'updatedValue1';
+      doc.aValue = 'updatedValue2';
+      await TestModel.bulkSave([doc]);
+
+      const findDoc = await TestModel.findById(doc._id);
+      assert.strictEqual(findDoc.value, 'updatedValue1');
+      assert.strictEqual(findDoc.aValue, 'updatedValue2');
+    });
+
     it('accepts `timestamps: false` (gh-12059)', async() => {
       // Arrange
       const userSchema = new Schema({
diff --git a/types/models.d.ts b/types/models.d.ts
@@ -32,7 +32,9 @@ declare module 'mongoose' {
     PopulateOption,
     SessionOption {
     limit?: number;
+    // @deprecated, use includeResultMetadata instead
     rawResult?: boolean;
+    includeResultMetadata?: boolean;
     ordered?: boolean;
     lean?: boolean;
     throwOnValidationError?: boolean;
diff --git a/types/query.d.ts b/types/query.d.ts
@@ -124,9 +124,14 @@ declare module 'mongoose' {
     overwriteDiscriminatorKey?: boolean;
     projection?: ProjectionType<DocType>;
     /**
+     * @deprecated use includeResultMetadata instead.
      * if true, returns the raw result from the MongoDB driver
      */
     rawResult?: boolean;
+    /**
+     * if ture, includes meta data for the result from the MongoDB driver
+     */
+    includeResultMetadata?: boolean;
     readPreference?: string | mongodb.ReadPreferenceMode;
     /**
      * An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.
