refactor: move idGetter back to being a plugin

Re: #3936
Automattic · May 10, 2020 · 36552fa · 36552fa
1 parent b6dfdb2
commit 36552fa
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 34 deletions.
diff --git a/lib/helpers/schema/addIdGetter.js b/lib/helpers/schema/addIdGetter.js
diff --git a/lib/index.js b/lib/index.js
@@ -32,6 +32,7 @@ const legacyPluralize = require('mongoose-legacy-pluralize');
 const utils = require('./utils');
 const pkg = require('../package.json');
 const cast = require('./cast');
+const idGetter = require('./plugins/idGetter');
 const removeSubdocs = require('./plugins/removeSubdocs');
 const saveSubdocs = require('./plugins/saveSubdocs');
 const validateBeforeSave = require('./plugins/validateBeforeSave');
@@ -102,6 +103,7 @@ function Mongoose(options) {
     enumerable: true,
     writable: false,
     value: [
+      [idGetter, { deduplicate: true }],
       [saveSubdocs, { deduplicate: true }],
       [validateBeforeSave, { deduplicate: true }],
       [shardingPlugin, { deduplicate: true }],

diff --git a/lib/plugins/idGetter.js b/lib/plugins/idGetter.js
@@ -4,7 +4,7 @@
  * ignore
  */
 
-module.exports = function(schema) {
+module.exports = function addIdGetter(schema) {
   // ensure the documents receive an id getter unless disabled
   const autoIdGetter = !schema.paths['id'] &&
     schema.paths['_id'] &&

diff --git a/lib/schema.js b/lib/schema.js
@@ -12,7 +12,6 @@ const SchemaTypeOptions = require('./options/SchemaTypeOptions');
 const VirtualOptions = require('./options/VirtualOptions');
 const VirtualType = require('./virtualtype');
 const addAutoId = require('./helpers/schema/addAutoId');
-const addIdGetter = require('./helpers/schema/addIdGetter');
 const applyTimestampsToChildren = require('./helpers/update/applyTimestampsToChildren');
 const applyTimestampsToUpdate = require('./helpers/update/applyTimestampsToUpdate');
 const arrayParentSymbol = require('./helpers/symbols').arrayParentSymbol;
@@ -140,8 +139,6 @@ function Schema(obj, options) {
     addAutoId(this);
   }
 
-  addIdGetter(this);
-
   this.setupTimestamp(this.options.timestamps);
 }
 

diff --git a/test/schema.test.js b/test/schema.test.js
@@ -19,6 +19,7 @@ const ReadPref = mongoose.mongo.ReadPreference;
 const vm = require('vm');
 const co = require('co');
 const Buffer = require('safe-buffer').Buffer;
+const applyPlugins = require('../lib/helpers/schema/applyPlugins');
 
 /**
  * Test Document constructor.
@@ -2432,7 +2433,10 @@ describe('schema', function() {
   });
 
   it('disables `id` virtual if no `_id` path (gh-3936)', function() {
+    const idGetter = require('../lib/plugins/idGetter');
+
     const schema = Schema({ name: String }, { _id: false });
+    applyPlugins(schema, [[idGetter]]);
     assert.ok(!schema.paths._id);
     assert.ok(!schema.virtuals.id);
   });