Skip to content

Improve object keys performance #3130

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

Open
joshkel wants to merge 1 commit into
base: master
Choose a base branch
from
+42 −1
Open

Improve object keys performance #3130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 17 additions & 1 deletion lib/types/keys.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,23 @@ module.exports = Any.extend({
if (schema.$_terms.keys) {
const topo = new Topo.Sorter();
for (const child of schema.$_terms.keys) {
Common.tryWithPath(() => topo.add(child, { after: child.schema.$_rootReferences(), group: child.key }), child.key);
Common.tryWithPath(() => topo.add(child, { after: child.schema.$_rootReferences(), group: child.key, manual: true }), child.key);

@Marsup Marsup Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Very nice find! Though I'd go for a less repetitive version like calling an external function:

schema.$_terms.keys = new internals.Keys(...internals.sortKeys(schema.$_terms.keys));

.....

internals.sortKeys = function (keys, manual = true) {

    const topo = new Topo.Sorter();
    for (const child of keys) {
        Common.tryWithPath(() => topo.add(child, { after: child.schema.$_rootReferences(), group: child.key, manual }), child.key);
    }

    try {
        return topo.sort();
    }
    catch {
        return internals.sortKeys(keys, false);
    }
};

}

try {
topo.sort();
}
catch (err) {
// Sorting failed (e.g. circular references). Replay the adds one at a
// time, sorting after each, to identify the offending key in the error.
const detailed = new Topo.Sorter();
for (const child of schema.$_terms.keys) {
Common.tryWithPath(() => detailed.add(child, { after: child.schema.$_rootReferences(), group: child.key }), child.key);
}

// The replay above always throws first - this is an unreachable safety net

throw err; // $lab:coverage:ignore$
}

schema.$_terms.keys = new internals.Keys(...topo.nodes);
Expand Down
25 changes: 25 additions & 0 deletions test/types/object.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1638,6 +1638,31 @@ describe('object', () => {
[{ type: 'a', set: true, flag: true }, false, '"flag" must be [false]']
]);
});

it('errors on circular references between sibling keys', () => {

const err = expect(() => {

Joi.object({
a: Joi.ref('b'),
b: Joi.ref('a')
});
}).to.throw('item added into group b created a dependencies error');

expect(err.path).to.equal('b');
});

it('errors on circular references introduced by rebuild', () => {

const schema = Joi.object({
a: Joi.any(),
b: Joi.any()
})
.fork('a', (s) => s.default(Joi.ref('b')));

const err = expect(() => schema.fork('b', (s) => s.default(Joi.ref('a')))).to.throw('item added into group a created a dependencies error');
expect(err.path).to.equal('a');
});
});

describe('length()', () => {
Expand Down