Skip to content

repl: Enable tab completion for global properties when useGlobal is false #7369

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

Closed
lance wants to merge 5 commits into from
Closed

repl: Enable tab completion for global properties when useGlobal is false #7369

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dcaf20b
repl: Enable tab completion for global properties.
lance Jun 22, 2016
12902dd
repl: Do not copy builtin properties to context.
lance Jun 23, 2016
b4d8de7
repl: remove unused test code.
lance Jun 23, 2016
0991efe
repl: Remove `context.global.global = context`.
lance Jun 24, 2016
b1981b1
repl: Check `Intl` existence before test.
lance Jun 27, 2016
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
Prev Previous commit
Next Next commit
repl: Do not copy builtin properties to context. 
When `useGlobal` is false, all of the properties on `global` are copied
to the new context (excluding `console` and `global`). Since
`Object.getOwnPropertyNames()` returns all properties, not just
enumerable ones, builtin properties on `global` are returned. We need to
filter those out.
  • Loading branch information
@lance
lance committed Jun 27, 2016
commit 12902ddd20ca2e2c70798baeff9d08d91d45db66
43 changes: 24 additions & 19 deletions lib/repl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ const debug = util.debuglog('repl');
const parentModule = module;
const replMap = new WeakMap();

const GLOBAL_OBJECT_PROPERTIES = ['NaN', 'Infinity', 'undefined',
Copy link
Copy Markdown
Member

@jasnell jasnell Jun 27, 2016

Choose a reason for hiding this comment

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

I really wish we had a better way of tracking these... ah well.

'eval', 'parseInt', 'parseFloat', 'isNaN', 'isFinite', 'decodeURI',
'decodeURIComponent', 'encodeURI', 'encodeURIComponent',
'Object', 'Function', 'Array', 'String', 'Boolean', 'Number',
'Date', 'RegExp', 'Error', 'EvalError', 'RangeError',
'ReferenceError', 'SyntaxError', 'TypeError', 'URIError',
'Math', 'JSON'];
const GLOBAL_OBJECT_PROPERTY_MAP = {};
GLOBAL_OBJECT_PROPERTIES.forEach((p) => GLOBAL_OBJECT_PROPERTY_MAP[p] = p);

try {
// hack for require.resolve("./relative") to work properly.
module.filename = path.resolve('repl');
Expand Down Expand Up @@ -582,19 +592,20 @@ REPLServer.prototype.createContext = function() {
context = global;
} else {
context = vm.createContext();
context.global = context;
context.global.global = context;
const _console = new Console(this.outputStream);
Object.getOwnPropertyNames(global).forEach((name) => {
if (name === 'console') {
Object.defineProperty(context, name, {
configurable: true,
enumerable: true,
value: _console
});
}
else {
Object.defineProperty(context, name,
Object.getOwnPropertyDescriptor(global, name));
}
Object.defineProperty(context, 'console', {
configurable: true,
enumerable: true,
get: () => _console
});
Object.getOwnPropertyNames(global).filter((name) => {
if (name === 'console' || name === 'global') return false;
return GLOBAL_OBJECT_PROPERTY_MAP[name] === undefined;
Copy link
Copy Markdown
Member

@addaleax addaleax Jun 23, 2016

Choose a reason for hiding this comment

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

This has false positives for entries from Object.prototype, e.g. for name === 'constructor'. I’m not sure if that’s actually relevant, but this line should be read as equivalent to GLOBAL_OBJECT_PROPERTIES.indexOf(name) === -1, right?

Copy link
Copy Markdown
Member Author

@lance lance Jun 24, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, GLOBAL_OBJECT_PROPERTY_MAP is just a map used for convenience and to avoid having to scan the array each time for a lookup on name. So, GLOBAL_OBJECT_PROPERTY_MAP[name] === undefined is essentially equivalent to GLOBAL_OBJECT_PROPERTIES.indexOf(name) === -1.

However, I'm not seeing the false positives from Object.prototype that you mention. A tab completion does exist for constructor, but that is the case for node version 6.2.2 as well.

~ ❯❯❯ which node
/Users/lanceball/.nvm/versions/node/v6.2.2/bin/node
~ ❯❯❯ node
> con
const        continue

console

constructor

> con

And constructor doesn't appear in global's own property names.

> Object.getOwnPropertyNames(global).filter((name) => name === 'constructor');
[]

Do I misunderstand your comment @addaleax?

Copy link
Copy Markdown
Member

@addaleax addaleax Jun 27, 2016

Choose a reason for hiding this comment

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

@lance sorry for not following up here…

Yes, global has no “own” constructor property unless set by user code, but GLOBAL_OBJECT_PROPERTY_MAP['constructor'] will be truthy whereas GLOBAL_OBJECT_PROPERTIES.indexOf('constructor') === -1 will not, so these are in fact not equivalent.

I’m not thinking about tab completion here, I’m just wondering if these properties should or should not be copied to the new context.

}).forEach((name) => {
Object.defineProperty(context, name,
Copy link
Copy Markdown
Contributor

@princejwesley princejwesley Jun 23, 2016

Choose a reason for hiding this comment

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

@lance instanceof test for this filtered list may fail!. e.g Int16Array. Can you confirm that? Adding those missing properties to GLOBAL_OBJECT_PROPERTIES will solve this issue.

Copy link
Copy Markdown
Member Author

@lance lance Jun 23, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

I couldn't figure out the best way to test this programmatically, but the CLI behavior tests manually as expected.

~/s/node git:repl-useglobal-false-tab-completion ❯❯❯ ./node test-use-global-auto-complete.js
> const x = new Int16Array()
undefined
> x instanceof Int16Array
true
>

I think this is the case because there is no builtin shorthand for Int16Array and the like. For builtin objects that have a shorthand representation such as [] or /\w+/ that representation is an instanceofthe builtin language object no matter what. But there is no builtin shorthand for Int16Array.

Object.getOwnPropertyDescriptor(global, name));
});
}

Expand Down Expand Up @@ -1062,13 +1073,7 @@ REPLServer.prototype.memory = function memory(cmd) {
function addStandardGlobals(completionGroups, filter) {
// Global object properties
// (http://www.ecma-international.org/publications/standards/Ecma-262.htm)
completionGroups.push(['NaN', 'Infinity', 'undefined',
'eval', 'parseInt', 'parseFloat', 'isNaN', 'isFinite', 'decodeURI',
'decodeURIComponent', 'encodeURI', 'encodeURIComponent',
'Object', 'Function', 'Array', 'String', 'Boolean', 'Number',
'Date', 'RegExp', 'Error', 'EvalError', 'RangeError',
'ReferenceError', 'SyntaxError', 'TypeError', 'URIError',
'Math', 'JSON']);
completionGroups.push(GLOBAL_OBJECT_PROPERTIES);
// Common keywords. Exclude for completion on the empty string, b/c
// they just get in the way.
if (filter) {
Expand Down
33 changes: 33 additions & 0 deletions test/parallel/test-repl-context.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
'use strict';
const common = require('../common');
const assert = require('assert');
const repl = require('repl');

// Create a dummy stream that does nothing
const stream = new common.ArrayStream();

// Test when useGlobal is false
testContext(repl.start({
input: stream,
output: stream,
useGlobal: false
}));

// Test when useGlobal is true
repl.start({
input: stream,
output: stream
});

function testContext(repl) {
const context = repl.createContext();
// ensure that the repl context gets its own "console" instance
assert(context.console instanceof require('console').Console);

// ensure that the repl's global property is the context
assert(context.global === context);
assert(context.global.global === context);
Copy link
Copy Markdown
Member

@addaleax addaleax Jun 23, 2016

Choose a reason for hiding this comment

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

Not sure if I’m missing something, but the second line is redundant, right?

Copy link
Copy Markdown
Member Author

@lance lance Jun 24, 2016

Choose a reason for hiding this comment

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

Well, to be honest, I'm not sure why the original repl.js did context.global.global = context here. But I've replicated that behavior and am testing that I've actually done it here.

Copy link
Copy Markdown
Contributor

@princejwesley princejwesley Jun 24, 2016

Choose a reason for hiding this comment

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

Yes. context.global.global = context; is redundant!
context.global = context; ensures circular reference


// ensure that the repl console instance does not have a setter
assert.throws(() => context.console = 'foo');
}
2 changes: 1 addition & 1 deletion test/parallel/test-repl-tab-complete.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ testMe.complete('.b', common.mustCall((error, data) => {
assert.deepStrictEqual(data, [['break'], 'b']);
}));

var testNonGlobal = repl.start({
const testNonGlobal = repl.start({
input: putIn,
output: putIn,
useGlobal: false
Expand Down