feat: Add error handling for nonexistent file case with --file option #5086

khoaHyh · 2024-01-24T06:54:48Z

🔎 Overview

Added validation to the file(s) passed in to the --file option by resolving the argument to an absolute path and check for its existence. We now log a warning and exit if the file does not exist.
- the errors for --require bubble up to the middleware in lib/cli/run.js. See here. This specific error occurs in lib/cli/run-helpers.js in the singleRun method when we load files asynchronously. Since we were lacking error handling there, the errors appeared the way they previously did before these changes.
Added a test to assert our changes

- added error handling when using the --file flag to do it the way --require does - added a test to assert that we throw the same type of error

linux-foundation-easycla · 2024-01-24T06:54:52Z

The committers listed above are authorized under a signed CLA.

✅ login: khoaHyh / name: Khoa Huynh (b905d21, bd47d79, b6d6dc2, 4aad184, a6bdef4, f8aedff, 909834d, 645e0b0, cf69df1, 0e1e84a, 9685b82, 6d4170e, 9b3d5d2, 21e566d, 8983b84, 4c9f318, ea092be, bad240d, dce26f4)

- require.resolve() by Node.js follows a Node.js module resolution algo which includes checking if the resolved path actually exists on the file system.

coveralls · 2024-02-07T19:16:58Z

coverage: 94.347% (+0.01%) from 94.335%
when pulling f8aedff on khoaHyh:issue/4047
into 3345eff on mochajs:master.

JoshuaKGoldberg

Cool! 😎

Requesting changes on adding a bit more testing. But also let's talk about the direction a bit - I feel nervous adding in process.exit/throws deep within code. Thanks for sending!

JoshuaKGoldberg · 2024-03-04T18:47:25Z

test/integration/options/file.spec.js

[Testing] Since the implementation uses require.resolve, I think it'd be good to make sure there is at least one test each for CJS and ESM. Using module-specific APIs such as require or import scares me, even for ones that should always work... Thoughts?

I thought to use require.resolve here because the original stack trace showed require being used. Alternatively, I could use fs.existsSync like how our --require flag does it. If we do go down the route of using require.resolve I agree with adding one test for each CJS and ESM.

I removed the use of require.resolve and instead opted to use the path and fs modules to check for file existence instead.

Wait, require.resolve is a good thing to use though! If someone is in CJS mode and passes path/to/place they'll expect that both path/to/place.js and path/to/place/index.js would work. Not to mention .js vs .cjs shenanigans. Right?

I just meant to ask for more testing, not a refactor.

Oops I misunderstood, yeah that makes sense. I'll add the tests and revert back to using require.resolve.

Before I commit my changes, what do we think of this output?

That looks pretty good to me!

Though, would it be a lot of work to reduce it to two lines? That screenshot has two saying nothing found and one mentioning the absolutePath. I wonder if it would be cleaner for users to reduce down to, say...

No test file(s) found with the given pattern(s), exiting with code 1 absolutePath: /home/ka9/dev/mocha/nonexistent.js

...if that's a lot of work to reorder to, then I'd say let's treat that as a followup issue and not a blocker here.

I reduced it to two lines but I kept the absolute path on the same line as the pattern statement in case there are multiple files passed in. Here the --file argument is treated as an array when the values are comma-separated.

Beautiful! I'm happy with that. Nice 🔥

Pushed changes and added tests for esm + cjs!

JoshuaKGoldberg · 2024-03-04T18:52:52Z

lib/cli/collect-files.js

+        `${symbols.warning} Warning: Cannot find test file "${file}" at the path "${fileAbsolutePath}"`
+      );
+      console.warn(`${warningMessage}\n`);
+      process.exit(1);


[Refactor] I don't love having a process.exit deep within code. n/no-process-exit has good reasoning around it.

It's also not really a "warning" yellow if the whole thing exits. At that point it's an error (red).

I think a more future-facing, approach would be either:

(less work, but still partially flawed) have this function throw a special error that any higher-up handler(s) know how to log nicely

(more work, but more understandable long-term) have this function return an object explaining its results, and have higher-up handler(s) work nicely with it

I haven't looked deeply enough to know whether either or both is feasible. Before we go into a whole deep dive, what do you think about this direction?

Good to learn about the no-process-exit, thanks! I think the latter where we return an object and having the higher-up handler(s) deal with it sounds like the approach here. The error wasn't handled in run-helpers so maybe we can add something so that bubbles up to run.js like the other methods?

Yeah that approach sounds like a good one to try!

khoaHyh · 2024-03-24T23:30:12Z

lib/cli/collect-files.js

@@ -30,7 +32,7 @@ module.exports = ({
  sort,
  spec
 } = {}) => {
-  const unmatched = [];
+  const unmatchedSpecFiles = [];


Renamed variable for semantic clarity

feat: handle nonexistent files passed to --file

bd47d79

- added error handling when using the --file flag to do it the way --require does - added a test to assert that we throw the same type of error

khoaHyh marked this pull request as ready for review January 24, 2024 06:57

khoaHyh changed the title ~~ISSUE #4047: Add error handling for nonexistent file case with --file option~~ feat: Add error handling for nonexistent file case with --file option Jan 24, 2024

khoaHyh added 3 commits January 24, 2024 13:02

refactor: remove path.resolve()

4aad184

- require.resolve() by Node.js follows a Node.js module resolution algo which includes checking if the resolved path actually exists on the file system.

add comment to new code in collect-files.js

8983b84

fix: add back absolute path resolving

b6d6dc2

khoaHyh mentioned this pull request Feb 7, 2024

🚀 Feature: Better error for --file option with non-existent file #4047

Open

khoaHyh added 3 commits February 6, 2024 22:59

refactor: log warning and remove call stack

9b3d5d2

revert changes to bin/mocha.js

645e0b0

improve test case

0e1e84a

khoaHyh added 2 commits February 10, 2024 23:19

Merge branch 'master' into issue/4047

9685b82

Merge branch 'master' into issue/4047

f8aedff

JoshuaKGoldberg requested changes Mar 4, 2024

View reviewed changes

JoshuaKGoldberg added the status: waiting for author waiting on response from OP - more information needed label Mar 4, 2024

khoaHyh added 2 commits March 24, 2024 19:25

Merge branch 'master' into issue/4047

a6bdef4

throw error and have handler work with it

909834d

khoaHyh commented Mar 24, 2024

View reviewed changes

khoaHyh requested a review from JoshuaKGoldberg March 24, 2024 23:30

khoaHyh added 8 commits March 24, 2024 20:00

change collectFiles to return object

cf69df1

clean up

b905d21

exit mocha immediately on missing file

ea092be

new log message

6d4170e

add tests

bad240d

Merge branch 'master' into issue/4047

21e566d

Merge branch 'master' into issue/4047

dce26f4

Merge branch 'master' into issue/4047

4c9f318

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add error handling for nonexistent file case with --file option #5086

feat: Add error handling for nonexistent file case with --file option #5086

khoaHyh commented Jan 24, 2024 •

edited by JoshuaKGoldberg

linux-foundation-easycla bot commented Jan 24, 2024 •

edited

coveralls commented Feb 7, 2024 •

edited

JoshuaKGoldberg left a comment

JoshuaKGoldberg Mar 4, 2024

khoaHyh Mar 10, 2024 •

edited

khoaHyh Mar 25, 2024 •

edited

JoshuaKGoldberg Mar 25, 2024 •

edited

khoaHyh Mar 25, 2024

khoaHyh Mar 25, 2024

JoshuaKGoldberg Mar 26, 2024

khoaHyh Mar 26, 2024

JoshuaKGoldberg Mar 26, 2024

khoaHyh Mar 26, 2024

JoshuaKGoldberg Mar 4, 2024 •

edited

khoaHyh Mar 10, 2024

JoshuaKGoldberg Mar 10, 2024

khoaHyh Mar 24, 2024

feat: Add error handling for nonexistent file case with --file option #5086

Are you sure you want to change the base?

feat: Add error handling for nonexistent file case with --file option #5086

Conversation

khoaHyh commented Jan 24, 2024 • edited by JoshuaKGoldberg

🔎 Overview

linux-foundation-easycla bot commented Jan 24, 2024 • edited

coveralls commented Feb 7, 2024 • edited

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khoaHyh Mar 10, 2024 • edited

Choose a reason for hiding this comment

khoaHyh Mar 25, 2024 • edited

Choose a reason for hiding this comment

JoshuaKGoldberg Mar 25, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoshuaKGoldberg Mar 4, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khoaHyh commented Jan 24, 2024 •

edited by JoshuaKGoldberg

linux-foundation-easycla bot commented Jan 24, 2024 •

edited

coveralls commented Feb 7, 2024 •

edited

khoaHyh Mar 10, 2024 •

edited

khoaHyh Mar 25, 2024 •

edited

JoshuaKGoldberg Mar 25, 2024 •

edited

JoshuaKGoldberg Mar 4, 2024 •

edited