Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf: speed up creating maps of subdocuments #13280

Merged
merged 6 commits into from
Apr 27, 2023
Merged

perf: speed up creating maps of subdocuments #13280

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4f22223
perf(document): avoid some unnecessary work when checking if map path…
vkarpov15 Apr 16, 2023
51b8982
perf(document): fix build, avoid unnecessary Object.keys() re: #13191
vkarpov15 Apr 16, 2023
7bec506
perf(map): delay string concatenation unless necessary
vkarpov15 Apr 16, 2023
e6eec87
test: fix tests re: #13191
vkarpov15 Apr 16, 2023
96890ec
chore: add benchmark for #13191
vkarpov15 Apr 18, 2023
b9ca7ca
fix: use Object.prototype.hasOwnProperty re: code review
vkarpov15 Apr 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions lib/document.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2217,19 +2217,26 @@ Document.prototype[documentModifiedPaths] = Document.prototype.modifiedPaths;

Document.prototype.isModified = function(paths, modifiedPaths) {
if (paths) {
const directModifiedPaths = Object.keys(this.$__.activePaths.getStatePaths('modify'));
if (directModifiedPaths.length === 0) {
return false;
}

if (!Array.isArray(paths)) {
paths = paths.indexOf(' ') === -1 ? [paths] : paths.split(' ');
}

const directModifiedPathsObj = this.$__.activePaths.states.modify;
if (directModifiedPathsObj == null) {
return false;
}
for (const path of paths) {
if (directModifiedPathsObj.hasOwnProperty(path)) {
vkarpov15 marked this conversation as resolved.
Show resolved Hide resolved
return true;
}
}

const modified = modifiedPaths || this[documentModifiedPaths]();
const isModifiedChild = paths.some(function(path) {
return !!~modified.indexOf(path);
});

const directModifiedPaths = Object.keys(directModifiedPathsObj);
return isModifiedChild || paths.some(function(path) {
return directModifiedPaths.some(function(mod) {
Uzlopak marked this conversation as resolved.
Show resolved Hide resolved
return mod === path || path.startsWith(mod + '.');
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just calling startsWith is more ergonomic than making the direct comparison.
Or maybe store path length in a variable and then do someting like

return mod.length === pathLength && mod === path || mod.length > pathLength && mod[pathLength] === "." && path.startsWith(mod)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we do this we would need to put it into a for loop. We could theoretically do directly a for of loop of Object.keys as Object.keys returns an iterator and it should not make a perf difference.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a bad idea, but I'd like to do some additional benchmarking to see if this makes a meaningful difference. We'll keep #13191 open for future work related to this.

Expand Down
36 changes: 25 additions & 11 deletions lib/types/map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,10 @@ class MongooseMap extends Map {
return;
}

const fullPath = this.$__path + '.' + key;
const populated = this.$__parent != null && this.$__parent.$__ ?
this.$__parent.$populated(fullPath, true) || this.$__parent.$populated(this.$__path, true) :
let _fullPath;
const parent = this.$__parent;
const populated = parent != null && parent.$__ && parent.$__.populated ?
parent.$populated(fullPath.call(this), true) || parent.$populated(this.$__path, true) :
null;
const priorVal = this.get(key);

Expand Down Expand Up @@ -127,11 +128,19 @@ class MongooseMap extends Map {
}
} else {
try {
value = this.$__schemaType.
applySetters(value, this.$__parent, false, this.get(key), { path: fullPath });
const options = this.$__schemaType.$isMongooseDocumentArray || this.$__schemaType.$isSingleNested ?
{ path: fullPath.call(this) } :
null;
value = this.$__schemaType.applySetters(
value,
this.$__parent,
false,
this.get(key),
options
);
} catch (error) {
if (this.$__parent != null && this.$__parent.$__ != null) {
this.$__parent.invalidate(fullPath, error);
this.$__parent.invalidate(fullPath.call(this), error);
return;
}
throw error;
Expand All @@ -140,13 +149,18 @@ class MongooseMap extends Map {

super.set(key, value);

if (value != null && value.$isSingleNested) {
value.$basePath = this.$__path + '.' + key;
if (parent != null && parent.$__ != null && !deepEqual(value, priorVal)) {
parent.markModified(fullPath.call(this));
}

const parent = this.$__parent;
if (parent != null && parent.$__ != null && !deepEqual(value, priorVal)) {
parent.markModified(this.$__path + '.' + key);
// Delay calculating full path unless absolutely necessary, because string
// concatenation is a bottleneck re: #13171
function fullPath() {
if (_fullPath) {
return _fullPath;
}
_fullPath = this.$__path + '.' + key;
return _fullPath;
}
}

Expand Down
1 change: 1 addition & 0 deletions test/types.map.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -956,6 +956,7 @@ describe('Map', function() {
});
doc.myMap.set('abc', { myValue: 'some value' });
const changes = doc.getChanges();

assert.ok(!changes.$unset);
assert.deepEqual(changes, { $set: { 'myMap.abc': { myValue: 'some value' } } });
});
Expand Down