10BC0 repl: fix getters triggering side effects during completion by dario-piotrowicz · Pull Request #61043 · nodejs/node · GitHub
[go: up one dir, main page]
Skip to content

repl: fix getters triggering side effects during completion #61043

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

Merged
nodejs-github-bot merged 4 commits into from
Dec 20, 2025
Merged

repl: fix getters triggering side effects during completion #61043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7108179
repl: fix getters triggering side effects during completion
dario-piotrowicz Dec 13, 2025
1f05135
improve code
dario-piotrowicz Dec 13, 2025
5615839
remove unnecessary string interpolation
dario-piotrowicz Dec 16, 2025
b6cb5c9
update type and name of `propName` argument
dario-piotrowicz Dec 16, 2025
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
75 changes: 33 additions & 42 deletions lib/internal/repl/completion.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,35 +731,15 @@ function includesProxiesOrGetters(expr, exprStr, evalFn, ctx, callback) {

if (astProp.type === 'Literal') {
// We have something like `obj['foo'].x` where `x` is the literal

if (safeIsProxyAccess(obj, astProp.value)) {
return cb(true);
}

const propDescriptor = ObjectGetOwnPropertyDescriptor(
obj,
`${astProp.value}`,
);
const propHasGetter = typeof propDescriptor?.get === 'function';
return cb(propHasGetter);
return propHasGetterOrIsProxy(obj, astProp.value, cb);
}

if (
astProp.type === 'Identifier' &&
exprStr.at(astProp.start - 1) === '.'
) {
// We have something like `obj.foo.x` where `foo` is the identifier

if (safeIsProxyAccess(obj, astProp.name)) {
return cb(true);
}

const propDescriptor = ObjectGetOwnPropertyDescriptor(
obj,
`${astProp.name}`,
);
const propHasGetter = typeof propDescriptor?.get === 'function';
return cb(propHasGetter);
return propHasGetterOrIsProxy(obj, astProp.name, cb);
}

return evalFn(
Expand All @@ -773,37 +753,48 @@ function includesProxiesOrGetters(expr, exprStr, evalFn, ctx, callback) {
getREPLResourceName(),
(err, evaledProp) => {
if (err) {
return callback(false);
return cb(false);
}

if (typeof evaledProp === 'string') {
if (safeIsProxyAccess(obj, evaledProp)) {
return cb(true);
}

const propDescriptor = ObjectGetOwnPropertyDescriptor(
obj,
evaledProp,
);
const propHasGetter = typeof propDescriptor?.get === 'function';
return cb(propHasGetter);
return propHasGetterOrIsProxy(obj, evaledProp, cb);
}

return callback(false);
return cb(false);
},
);
}

function safeIsProxyAccess(obj, prop) {
// Accessing `prop` may trigger a getter that throws, so we use try-catch to guard against it
try {
return isProxy(obj[prop]);
} catch {
return false;
}
return callback(false);
}

/**
* Given an object and a property name, checks whether the property has a getter, if not checks whether its
* value is a proxy.
*
* Note: the order is relevant here, we want to check whether the property has a getter _before_ we check
* whether its value is a proxy, to ensure that is the property does have a getter we don't end up
* triggering it when checking its value
* @param {any} obj The target object
* @param {string | number | bigint | boolean | RegExp} prop The target property
* @param {(includes: boolean) => void} cb Callback that will be called with the result of the operation
* @returns {void}
*/
function propHasGetterOrIsProxy(obj, prop, cb) {
const propDescriptor = ObjectGetOwnPropertyDescriptor(
obj,
prop,
);
const propHasGetter = typeof propDescriptor?.get === 'function';
if (propHasGetter) {
return cb(true);
}

return callback(false);
if (isProxy(obj[prop])) {
return cb(true);
}

return cb(false);
}

module.exports = {
Expand Down
27 changes: 27 additions & 0 deletions test/parallel/test-repl-completion-on-getters-disabled.js
View file D980
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,33 @@ describe('REPL completion in relation of getters', () => {
['objWithGetters[getGFooKey()].b', []],
]);
});

test('no side effects are triggered for getters during completion', async () => {
const { replServer } = startNewREPLServer();

await new Promise((resolve, reject) => {
replServer.eval('const foo = { get name() { globalThis.nameGetterRun = true; throw new Error(); } };',
replServer.context, '', (err) => {
if (err) {
reject(err);
} else {
resolve();
}
});
});

['foo.name.', 'foo["name"].'].forEach((test) => {
replServer.complete(
test,
common.mustCall((error, data) => {
// The context's nameGetterRun variable hasn't been set
assert.strictEqual(replServer.context.nameGetterRun, undefined);
// No errors has been thrown
assert.strictEqual(error, null);
})
);
});
});
});

describe('completions on proxies', () => {
Expand Down
36 changes: 0 additions & 36 deletions test/parallel/test-repl-tab-complete-getter-error.js
View file
Open in desktop

This file was deleted.

Loading
0