fix: consistently use $__parent to store subdoc parent as a propert…

…y, and `$parent()` as a getter function

Re: #10584
Re: #10414

lib/document.js

@@ -3066,12 +3066,12 @@ Document.prototype.$__reset = function reset() {
     }).
     forEach(function(doc) {
       doc.$__reset();
-      if (doc.$__parent() === _this) {
+      if (doc.$parent() === _this) {
         _this.$__.activePaths.init(doc.$basePath);
-      } else if (doc.$__parent() != null && doc.$__parent().ownerDocument) {
+      } else if (doc.$parent() != null && doc.$parent().ownerDocument) {
         // If map path underneath subdocument, may end up with a case where
         // map path is modified but parent still needs to be reset. See gh-10295
-        doc.$__parent().$__reset();
+        doc.$parent().$__reset();
       }
     });
 

lib/schema/SubdocumentPath.js

@@ -63,7 +63,7 @@ function _createConstructor(schema, baseClass) {
   const _embedded = function SingleNested(value, path, parent) {
     const _this = this;
 
-    this.$parent = parent;
+    this.$__parent = parent;
     Subdocument.apply(this, arguments);
 
     this.$session(this.ownerDocument().$session());

lib/schematype.js

@@ -1068,7 +1068,7 @@ SchemaType.prototype.getDefault = function(scope, init) {
 
     const casted = this.applySetters(ret, scope, init);
     if (casted && casted.$isSingleNested) {
-      casted.$parent = scope;
+      casted.$__parent = scope;
     }
     return casted;
   }

lib/types/ArraySubdocument.js

@@ -32,7 +32,7 @@ function ArraySubdocument(obj, parentArr, skipId, fields, index) {
   }
   this.$setIndex(index);
   this.$isDocumentArrayElement = true;
-  this.$parent = this[documentArrayParent];
+  this.$__parent = this[documentArrayParent];
 
   // Document.call(this, obj, fields, skipId);
   Subdocument.call(this, obj, fields, this[documentArrayParent], void 0, { isNew: true });
@@ -149,7 +149,7 @@ ArraySubdocument.prototype.$__pathRelativeToParent = function(path, skipIndex) {
  * Returns this sub-documents parent document.
  */
 
-ArraySubdocument.prototype.$__parent = function() {
+ArraySubdocument.prototype.$parent = function() {
   return this[documentArrayParent];
 };
 

lib/types/subdocument.js

@@ -119,7 +119,7 @@ Subdocument.prototype.$__save = function(fn) {
  */
 
 Subdocument.prototype.$isValid = function(path) {
-  const parent = this.$__parent();
+  const parent = this.$parent();
   const fullPath = this.$__pathRelativeToParent(path);
   if (parent != null && fullPath != null) {
     return parent.$isValid(fullPath);
@@ -133,7 +133,7 @@ Subdocument.prototype.$isValid = function(path) {
 
 Subdocument.prototype.markModified = function(path) {
   Document.prototype.markModified.call(this, path);
-  const parent = this.$__parent();
+  const parent = this.$parent();
   const fullPath = this.$__pathRelativeToParent(path);
 
   if (parent == null || fullPath == null) {
@@ -144,15 +144,15 @@ Subdocument.prototype.markModified = function(path) {
   if (parent.isDirectModified(myPath) || this.isNew) {
     return;
   }
-  this.$parent.markModified(fullPath, this);
+  this.$__parent.markModified(fullPath, this);
 };
 
 /*!
  * ignore
  */
 
 Subdocument.prototype.isModified = function(paths, modifiedPaths) {
-  const parent = this.$__parent();
+  const parent = this.$parent();
   if (parent != null) {
     if (Array.isArray(paths) || typeof paths === 'string') {
       paths = (Array.isArray(paths) ? paths : paths.split(' '));
@@ -178,7 +178,7 @@ Subdocument.prototype.isModified = function(paths, modifiedPaths) {
 
 Subdocument.prototype.$markValid = function(path) {
   Document.prototype.$markValid.call(this, path);
-  const parent = this.$__parent();
+  const parent = this.$parent();
   const fullPath = this.$__pathRelativeToParent(path);
   if (parent != null && fullPath != null) {
     parent.$markValid(fullPath);
@@ -192,7 +192,7 @@ Subdocument.prototype.$markValid = function(path) {
 Subdocument.prototype.invalidate = function(path, err, val) {
   Document.prototype.invalidate.call(this, path, err, val);
 
-  const parent = this.$__parent();
+  const parent = this.$parent();
   const fullPath = this.$__pathRelativeToParent(path);
   if (parent != null && fullPath != null) {
     parent.invalidate(fullPath, err, val);
@@ -209,7 +209,7 @@ Subdocument.prototype.invalidate = function(path, err, val) {
 
 Subdocument.prototype.$ignore = function(path) {
   Document.prototype.$ignore.call(this, path);
-  const parent = this.$__parent();
+  const parent = this.$parent();
   const fullPath = this.$__pathRelativeToParent(path);
   if (parent != null && fullPath != null) {
     parent.$ignore(fullPath);
@@ -232,11 +232,11 @@ Subdocument.prototype.ownerDocument = function() {
   const paths = [];
 
   while (true) {
-    if (typeof parent.$__parent !== 'function') {
+    if (typeof parent.$__pathRelativeToParent !== 'function') {
       break;
     }
     paths.unshift(parent.$__pathRelativeToParent(void 0, true));
-    const _parent = parent.$__parent();
+    const _parent = parent.$parent();
     if (_parent == null) {
       break;
     }
@@ -256,15 +256,7 @@ Subdocument.prototype.ownerDocument = function() {
  */
 
 Subdocument.prototype.parent = function() {
-  return this.$__parent();
-};
-
-/*!
- * Returns this sub-documents parent document.
- */
-
-Subdocument.prototype.$__parent = function() {
-  return this.$parent;
+  return this.$__parent;
 };
 
 /**
@@ -287,7 +279,7 @@ Subdocument.prototype.$__remove = function(cb) {
 };
 
 Subdocument.prototype.$__removeFromParent = function() {
-  this.$parent.set(this.$basePath, null);
+  this.$__parent.set(this.$basePath, null);
 };
 
 /**

test/document.test.js

@@ -3211,7 +3211,7 @@ describe('document', function() {
       const Parent = db.model('Parent', ParentSchema);
 
       const p = new Parent();
-      assert.equal(p.child.$parent, p);
+      assert.equal(p.child.$parent(), p);
     });
 
     it('removing parent doc calls remove hooks on subdocs (gh-2348) (gh-4566)', function(done) {