Merge pull request #14938 from Automattic/vkarpov15/gh-14935

fix: set flattenObjectIds to false when calling toObject() for internal purposes
Automattic · Oct 9, 2024 · d861d21 · d861d21
2 parents ee6b861 + 6aecc01
commit d861d21
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/lib/model.js b/lib/model.js
@@ -75,8 +75,7 @@ const subclassedSymbol = Symbol('mongoose#Model#subclassed');
 const { VERSION_INC, VERSION_WHERE, VERSION_ALL } = Document;
 
 const saveToObjectOptions = Object.assign({}, internalToObjectOptions, {
-  bson: true,
-  flattenObjectIds: false
+  bson: true
 });
 
 /**

diff --git a/lib/options.js b/lib/options.js
@@ -12,5 +12,6 @@ exports.internalToObjectOptions = {
   depopulate: true,
   flattenDecimals: false,
   useProjection: false,
-  versionKey: true
+  versionKey: true,
+  flattenObjectIds: false
 };
diff --git a/test/document.test.js b/test/document.test.js
@@ -13927,6 +13927,29 @@ describe('document', function() {
     await savedDoc.save();
   });
 
+  it('avoids flattening objectids on insertMany (gh-14935)', async function() {
+    const TestSchema = new Schema(
+      {
+        professionalId: {
+          type: Schema.Types.ObjectId
+        },
+        firstName: {
+          type: String
+        }
+      },
+      {
+        toObject: { flattenObjectIds: true }
+      }
+    );
+    const Test = db.model('Test', TestSchema);
+
+    const professionalId = new mongoose.Types.ObjectId();
+    await Test.insertMany([{ professionalId, firstName: 'test' }]);
+
+    const doc = await Test.findOne({ professionalId }).lean().orFail();
+    assert.ok(doc.professionalId instanceof mongoose.Types.ObjectId);
+  });
+
   it('handles buffers stored as EJSON POJO (gh-14911)', async function() {
     const pdfSchema = new mongoose.Schema({
       pdfSettings: {