modifiedpaths are not returning as expected when we use .set() with nested paths as an object in v5.12.5 vs v6.x.x

[sakethyerra]

Prerequisites

• I have written a descriptive issue title
• I have searched existing issues to ensure the bug has not already been reported

Mongoose version

6.12.1

Node.js version

14.18.1

MongoDB server version

4.4

Typescript version (if applicable)

No response

Description

Hi, the following code behaves differently in both versions v5.12.5 and v6.x.x.
Note: modified paths are not returning as expected when we use .set() with nested paths as an object.

var mongoose = require('mongoose')
let Schema = mongoose.Schema
var eventSchema = new Schema({
  name: { type: String },
  __stateBeforeSuspension: {
    field1: { type: String },
    field2: { type: String },
    jsonField: {
        name: { type: String }
    }
  }
})
var Event = mongoose.model('Event', eventSchema)
async function run() {
  await mongoose.connect('mongodb://localhost:27017');
  let eventObj = new Event({ name: 'event object', __stateBeforeSuspension: { field1: 'test', jsonField: { name: 'test3' }} })
  eventObj.save(function (err, eventObj) {
    var newObject = eventObj.toObject()
    newObject.__stateBeforeSuspension = { field1: '12', jsonField: { name: 'test4' }}
    eventObj.set(newObject)
    var modifiedPaths = eventObj.modifiedPaths()
    console.log(modifiedPaths)
   
  })
}
run();

Output with v5.12.5 :

[
  '__stateBeforeSuspension',
  '__stateBeforeSuspension.field1',
  '__stateBeforeSuspension.jsonField',
  '__stateBeforeSuspension.jsonField.name'
]

Output with v6.12.1 :

[ '__stateBeforeSuspension', '__stateBeforeSuspension.jsonField' ]

The modified paths are returning differently in both versions.
Note: We have raised a different issue similar to .set() one. for more info please refer to #14022

Steps to Reproduce

Added the full-fledged details on how to reproduce the issue in the description with a code snippet.

Expected Behavior

No response

[sakethyerra]

We observed another thing non-modified paths are showing as modified paths for more info please refer to the below code.

var mongoose = require('mongoose')
let Schema = mongoose.Schema
var eventSchema = new Schema({
  name: { type: String },
  __stateBeforeSuspension: {
    field1: { type: String },
    field2: { type: String },
    jsonField: {
        name: { type: String },
        name1: { type: String }
    }
  }
})
var Event = mongoose.model('Event', eventSchema)
async function run() {
  await mongoose.connect('mongodb://localhost:27017');
  let eventObj = new Event({ name: "event object", __stateBeforeSuspension: { field1: "test", jsonField: { name: "test3" }} })
  eventObj.save(function (err, eventObj) {
    var newObject =  { field1: "test", jsonField: { name: "test3", name1: "test4"} }
    eventObj.set('__stateBeforeSuspension', newObject)
    var modifiedPaths = eventObj.modifiedPaths()
    console.log(modifiedPaths)
  })
}
run();

Output with v5.12.5 :

[ '__stateBeforeSuspension' ]

Output with v6.12.1 :

[
  '__stateBeforeSuspension',
  '__stateBeforeSuspension.jsonField',
  '__stateBeforeSuspension.jsonField.name',
  '__stateBeforeSuspension.jsonField.name1'
]

[sakethyerra]

@vkarpov15 Can you please update the status of this tracker

[IslandRhythms]

confirmed for both

const mongoose = require('mongoose');
const { Schema } = mongoose;

// for function run()
/*
const eventSchema = new Schema({
  name: { type: String },
  __stateBeforeSuspension: {
    field1: { type: String },
    field2: { type: String },
    jsonField: {
        name: { type: String }
    }
  }
});*/


// for function test
const eventSchema = new Schema({
  name: { type: String },
  __stateBeforeSuspension: {
    field1: { type: String },
    field2: { type: String },
    jsonField: {
        name: { type: String },
        name1: { type: String }
    }
  }
})
const  Event = mongoose.model('Event', eventSchema)
async function run() {
  await mongoose.connect('mongodb://localhost:27017');
  await mongoose.connection.dropDatabase();
  const  eventObj = new Event({ name: 'event object', __stateBeforeSuspension: { field1: 'test', jsonField: { name: 'test3' }} })
  eventObj.save(function (err, eventObj) {
    var newObject = eventObj.toObject()
    newObject.__stateBeforeSuspension = { field1: '12', jsonField: { name: 'test4' }}
    eventObj.set(newObject)
    var modifiedPaths = eventObj.modifiedPaths()
    console.log(modifiedPaths)
   
  })
}
// run();

async function test() {
  await mongoose.connect('mongodb://localhost:27017');
  await mongoose.connection.dropDatabase();

  const eventObj = new Event({ name: "event object", __stateBeforeSuspension: { field1: "test", jsonField: { name: "test3" }} })
  eventObj.save(function (err, eventObj) {
    var newObject =  { field1: "test", jsonField: { name: "test3", name1: "test4"} }
    eventObj.set('__stateBeforeSuspension', newObject)
    var modifiedPaths = eventObj.modifiedPaths()
    console.log(modifiedPaths)
  })
}

test();

[vkarpov15]

For your first post (the following code snippet), this is expected behavior. In Mongoose 6, modifiedPaths() doesn't include children of already modified paths by default. Use modifiedPaths({ includeChildren: true }) to get the Mongoose 5 behavior in Mongoose 6.

var mongoose = require('mongoose')
let Schema = mongoose.Schema
var eventSchema = new Schema({
  name: { type: String },
  __stateBeforeSuspension: {
    field1: { type: String },
    field2: { type: String },
    jsonField: {
        name: { type: String }
    }
  }
})
var Event = mongoose.model('Event', eventSchema)
async function run() {
  await mongoose.connect('mongodb://localhost:27017');
  let eventObj = new Event({ name: 'event object', __stateBeforeSuspension: { field1: 'test', jsonField: { name: 'test3' }} })
  eventObj.save(function (err, eventObj) {
    var newObject = eventObj.toObject()
    newObject.__stateBeforeSuspension = { field1: '12', jsonField: { name: 'test4' }}
    eventObj.set(newObject)
    var modifiedPaths = eventObj.modifiedPaths()
    console.log(modifiedPaths)
   
  })
}
run();

Re: your 2nd post, the fact that name and name1 were showing up in modifiedPaths() is a bug. I fixed in #14053 with 4bd5927.

[sakethyerra]

@vkarpov15 For the first use case, it's working as expected but we found that we are using isDirectModified() and it's not returning the child-modified paths. please find the below code snippet for more information.
Note: In our case, we are mostly relying on isDirectModified() to check in the database docs which will impact us a lot.

var mongoose = require('mongoose')
let Schema = mongoose.Schema
var eventSchema = new Schema({
  name: { type: String },
  __stateBeforeSuspension: {
    field1: { type: String },
    field2: { type: String },
    jsonField: {
        name: { type: String }
    }
  }
})
var Event = mongoose.model('Event', eventSchema)
async function run() {
  await mongoose.connect('mongodb://localhost:27017');
  let eventObj = new Event({ name: 'event object', __stateBeforeSuspension: { field1: 'test', jsonField: { name: 'test3' }} })
  eventObj.save(function (err, eventObj) {
    var newObject = eventObj.toObject()
    newObject.__stateBeforeSuspension = { field1: '12', jsonField: { name: 'test4' }}
    eventObj.set(newObject)
    var modifiedPaths = eventObj.modifiedPaths({ includeChildren: true })
    console.log(modifiedPaths)
    modifiedPaths.forEach(function (modifiedPath) {
      console.log('modifiedPath: ', modifiedPath)
      if (eventObj.isDirectModified(modifiedPath)) {
        console.log('direct modified path: ', modifiedPath)
      }})
  })
}
run();

Output with v5.12.5 :

[
  '__stateBeforeSuspension',
  '__stateBeforeSuspension.field1',
  '__stateBeforeSuspension.jsonField',
  '__stateBeforeSuspension.jsonField.name'
]
modifiedPath:  __stateBeforeSuspension
modifiedPath:  __stateBeforeSuspension.field1
direct modified path:  __stateBeforeSuspension.field1
modifiedPath:  __stateBeforeSuspension.jsonField
modifiedPath:  __stateBeforeSuspension.jsonField.name
direct modified path:  __stateBeforeSuspension.jsonField.name

Output with v6.12.1 :

[
  '__stateBeforeSuspension',
  '__stateBeforeSuspension.jsonField',
  '__stateBeforeSuspension.jsonField.name',
  '__stateBeforeSuspension.field1'
]
modifiedPath:  __stateBeforeSuspension
direct modified path:  __stateBeforeSuspension
modifiedPath:  __stateBeforeSuspension.jsonField
direct modified path:  __stateBeforeSuspension.jsonField
modifiedPath:  __stateBeforeSuspension.jsonField.name
modifiedPath:  __stateBeforeSuspension.field1

If we see the above outputs we are not getting the as-expected values for the "direct modified path" log
Note: Let me know if we need to raise a new issue for it. Can you please add it to the 6.12.3

[vkarpov15]

I think the isDirectModified() bit is expected behavior. The spirit of isDirectModified() is that it should return true for fields that you have explicitly set (not 100% true in 6.x, we've made some improvements on that front in subsequent versions). So given that you're calling eventObj.set(newObject), the only direct modified path should be __stateBeforeSuspension, because eventObj.set(newObject) becomes eventObj.set('name', 'event object'); eventObj.set('__stateBeforeSuspension', ...) and __stateBeforeSuspension is the only path that is set to a different value. If you want __stateBeforeSuspension.jsonField.name to show up as the direct modified path, you should do eventObj.set('__stateBeforeSuspension.jsonField.name', 'test 4') or something similar.

[sakethyerra]

@vkarpov15 We are using .set() in many places of our code and it is hard for us to modify it in all the paces. We are using isDirectModified() for auditing(To get the specific modified field) the docs to show those details to the end users. Is there any way to achieve the older behaviour?

[vkarpov15]

Does using isModified() instead of isDirectModified() work for you?

[sakethyerra]

@vkarpov15, No it doesn't work as isModified() will come true for all the values coming in modifiedPaths(). To avoid this issue we are using the isDirectModified() to get the exact fields that were modified but in 6.x.x we are not getting the exact child fields that are modified. Is there a way to achieve the same behaviour of the 5.12.5v?