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

Jump to bottom

fix: properties accessed on singleton now reflect current state of instance #1366

Merged
merged 3 commits into from Jul 13, 2019
Merged

fix: properties accessed on singleton now reflect current state of instance #1366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd96bee
tests: reproduce parsed frozen to false (#1144)
mleguen Jun 19, 2019
152950b
fix (singletonify): parsed frozen to false (#1144)
mleguen Jun 19, 2019
7822bb3
fix (singletonify): fix missing typeof in 152950bb
mleguen Jun 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion index.js
View file
Open in desktop
Expand Up @@ -25,8 +25,10 @@ function singletonify (inst) {
Object.keys(inst).forEach((key) => {
if (key === 'argv') {
Argv.__defineGetter__(key, inst.__lookupGetter__(key))
} else if (typeof inst[key] === 'function') {
Argv[key] = inst[key].bind(inst)
} else {
Copy link
Member

Choose a reason for hiding this comment

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

why don't we make this slightly more explicit:

if (['$0', 'parsed'].indexOf(key) !== -1) {

and we should be mindful about leaking any more stateful variables on the yargs object going forward.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't get the point. If we support singleton mode, shouldn't every property/method call on Argv have the same effect as if directly called on the singleton?

Copy link
Member

Choose a reason for hiding this comment

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

fair 👍 I just noticed that, I think, argv, $0, and parsed are the only properties that leak ... and honestly, I don't think we meant to leak parsed as part of the API.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops! I did not realize this... However, parsed is already leaking from the API when not using the singleton. So, does it have a sense to filter properties we accept to leak from the singleton, and not to do it when not using the singleton?

Argv[key] = typeof inst[key] === 'function' ? inst[key].bind(inst) : inst[key]
Argv.__defineGetter__(key, () => inst[key])
}
})
}
11 changes: 11 additions & 0 deletions test/yargs.js
View file
Open in desktop
Expand Up @@ -837,6 +837,17 @@ describe('yargs dsl tests', () => {
})
})

describe('parsed', () => {
it('should be false before parsing', () => {
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if we could figure out the specific exception that was happening with showHelp and put a test around this?

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree. A simple "showHelp should not fail" should do the job

yargs.parsed.should.equal(false)
})

it('should not be false after parsing', () => {
yargs.parse()
yargs.parsed.should.not.equal(false)
})
})

// yargs.parse(['foo', '--bar'], function (err, argv, output) {}
context('function passed as second argument to parse', () => {
it('does not print to stdout', () => {
Expand Down