Print warning message for --opts argument

[benedikt-roth]

When specified options file does not exist

(Tackling #2576)

Requirements

• Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
• All new code requires tests to ensure against regressions.

Description of the Change

• Check if specified options file exists
• If it does not, print a warning message

Alternate Designs

Why should this be in core?

Benefits

Less headache when your options file is not being loaded.

Possible Drawbacks

Applicable issues

• This is probably a breaking change since it triggers a non-zero exit of the application.

[jsf-clabot]

All committers have signed the CLA.

[plroebuck]

Like the idea and most of the coding implementation. But issue #2576 was for it to throw any error and die, rather than print warning and continue with defaults... Depending on how/where it is run, quite possible no one would notice the warning.

/* bin/options.js#L33 - don't continue, die! */
var noSuchFileError = new Error(`no such options file: ${optsPath}`);
noSuchFileError.code = 'ENOENT';
throw noSuchFileError;

[plroebuck]

Migrated to #3354

[benedikt-roth]

Went for the less invasive variant in the beginning, but I would also prefer to make the script fail.

The code was changed to throw an error instead of a warning in 2dbc42f.

Need some more feedback on this change. If it proves to be the way to go, I will add some tests.

[benedikt-roth]

I agree on that value assignment (2). Fixed it in f5cd0b5.

About the use of the env variable in general - It was introduced to fix #1980. Its purpose is not to try to process the options twice - once from the mocha wrapper and a second time from internal _mocha binary.

It looks like it was a quick fix and there might be a nicer way than to store it in a global env variable. Fixing that is the scope of a separate PR. I want to keep the changes rather small here.

[plroebuck]

Benedikt, was not trying to imply my post-review notes were to be part of your issue changes. 1) and 3) probably should have another issue opened. My apologies if that was unclear due to my adding those notes.

[benedikt-roth]

It's all right, @plroebuck. It is good to talk about it since we are already here 🙂

[boneskull]

Thanks! I have some comments was hoping you could address.

This is a breaking change, but it's a good one.

[boneskull]

please just change this to 1 for simplicity

OK, so, to be clear, this is good enough the way it is. It should be 1, but apparently some odd projects are depending on this for one reason or another, and 'true' isn't so painful that this needs changing. If this is causing other issues in Mocha, or creates otherwise significant technical debt, we're free to modify or remove it as we see fit.

Projects should not be depending on this variable, and should certainly not be depending on its value to be any particular thing other than set or unset.

[plroebuck]

Value needs to be 'true' to prevent breaking other npm packages unnecessarily.

[boneskull]

What packages are using this? This is not documented and is not a "public" API (or an API at all, really).

[benedikt-roth]

I agree with @boneskull. LOADED_MOCHA_OPTS is intended for internal use only.
(Whereas this is not a good use case for an environment variable.)

[boneskull]

this is nitpicky but can you please save the index? DRY and all that

const optsIndex = process.argv.indexOf('--opts');
const optsPathSpecified = optsIndex !== -1; // it will never be 0, so..
const optsPath = optsPathSpecified
  ? process.argv[optsIndex + 1]
  : 'test/mocha.opts';

[boneskull]

It's better to just do it and recover instead of make this extra check.

So on L52 where we're catching the err, inspect it for err.code === 'ENOENT', then you can throw with your noSuchFileError, otherwise just rethrow.

[boneskull]

(in other words, avoid fs.existsSync)

[benedikt-roth]

(Am on vocation right now. Gonna come back to this in about a week.)

…

On Mon 30. Apr 2018 at 13:17, Christopher Hiller ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In bin/options.js <#3352 (comment)>: > @@ -44,5 +52,5 @@ function getOptions() { // ignore } - process.env.LOADED_MOCHA_OPTS = true; + process.env.LOADED_MOCHA_OPTS = 'true'; What packages are using this? This is not documented and is not a "public" API (or an API at all, really). — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#3352 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAOVWExt3wgtn21n5RfWdocU4FLtQebjks5tt0ccgaJpZM4TjID0> .

[benedikt-roth]

Closing this one in favour of #3381.