fix improper warnings for invalid reporters #4275

boneskull · 2020-05-08T21:27:29Z

also: reorganize, add, and refactor a bunch of problematic unit tests for lib/mocha.js. better isolation except where we can't really do that (calling require)

there's still missing tests in here, but this is an improvement.

@craigtaub this touches some stuff regarding warnings for invalid reporters. it looks like the conditionals were backwards?

boneskull · 2020-05-08T21:31:22Z

I should note that I started out adding more coverage and refactoring, but I found a bug while I was doing that...

craigtaub · 2020-05-09T11:40:24Z

Odd the logic been broken for so long for such an important check. Would have been good to see an issue or details in the description to help replicate locally.

Would this logic apply all the time or just programmatic use of mocha only? (cli catches bad reporters when I try locally)

lib/mocha.js

boneskull · 2020-05-11T17:54:17Z

can't use require.resolve in unit tests because browser. will need to move some of these into test/node-unit/mocha.spec.js

boneskull · 2020-05-11T19:04:42Z

OK, we can't use rewiremock in test/unit/*.spec.js because it's apparently incompatible with browserify as written. so I've ripped it out of there, and moved some tests for Mocha#reporter() into test/node-unit/mocha.spec.js where we can safely test reporter resolution.

Ref: theKashey/rewiremock#113

cc @Munter -- how's the transpilation coming? 😄

coveralls · 2020-05-11T19:16:03Z

Coverage increased (+0.08%) to 93.228% when pulling 0bd7e14 on boneskull/mocha-unit-tests into 81e203c on master.

boneskull · 2020-05-11T19:54:12Z

tests broke because you can't use Object.assign() in IE11 (I forgot), but I noticed we also didn't have a lint rule preventing it, so I added one.

boneskull · 2020-05-12T19:07:23Z

@nicojs I had heavily refactored test/unit/mocha.spec.js, where most of your new tests live--so they, too, are assimilated in this PR. May want to take a look.

nicojs · 2020-05-12T19:39:12Z

@boneskull You're not kidding, file looks like a Christmas tree in my browser 🎄. Will checkout this branch locally to take a better look. Will have to wait till tomorrow.

boneskull · 2020-05-12T21:23:56Z

your changes highlight that Mocha.prototype.run has a very strange API.

It accepts an optional callback, and that callback is called with a single parameter, failures, a number. This doesn't conform to a typical convention. If it did use an error-first style, that convention expects the function to not throw, and rather call the callback w/ an Error instance.

It would likely be highly disruptive to break this, unfortunately. Off the top of my head, two ways we could improve the situation:

The way forward may instead be to create a new runAsync (or whatever) in the future and return a Promise. If the Runner instance is needed (the current return value) then this would not be appropriate.
In Mocha.prototype.run, inspect the callback. If it exists and has an arity greater than 1, use an error-first style; otherwise use the current behavior.

Consumers of Mocha.prototype.run don't currently expect it to throw (for any reason), and the current situation may be awkward to work with.

nicojs

Looks good to me! Some minor suggestions.

test/node-unit/mocha.spec.js

nicojs · 2020-05-12T19:35:42Z

test/node-unit/mocha.spec.js

+        });
+
+        describe('when the reporter throws upon load', function() {
+          it('should throw "invalid reporter" exception', function() {


Love the fact that this is split out from the should warn ... test 😍. Also for the mocha unit tests.

also: reorganize, add, and refactor a bunch of problematic unit tests for `lib/mocha.js`. better isolation except where we can't really do that (calling `require`) there's still missing tests in here, but this is an improvement.

- better isolation - a use of `process.cwd()` in `lib/runner.js` was left in place to avoid conflicts, because another PR will remove it

* fix improper warnings for invalid reporters also: reorganize, add, and refactor a bunch of problematic unit tests for `lib/mocha.js`. better isolation except where we can't really do that (calling `require`) there's still missing tests in here, but this is an improvement. * restrict use of Object.assign in ESLint config * add wrapper around process.cwd() - better isolation - a use of `process.cwd()` in `lib/runner.js` was left in place to avoid conflicts, because another PR will remove it

boneskull added type: bug a defect, confirmed by a maintainer type: chore generally involving deps, tooling, configuration, etc. semver-patch implementation requires increase of "patch" version number; "bug fixes" labels May 8, 2020

boneskull requested a review from craigtaub May 8, 2020 21:27

boneskull self-assigned this May 8, 2020

boneskull force-pushed the boneskull/mocha-unit-tests branch from 65b5a7d to 1ba7cc6 Compare May 8, 2020 21:30

craigtaub reviewed May 9, 2020

View reviewed changes

lib/mocha.js Show resolved Hide resolved

craigtaub approved these changes May 9, 2020

View reviewed changes

boneskull force-pushed the boneskull/mocha-unit-tests branch from 1ba7cc6 to 89cb1e7 Compare May 11, 2020 19:01

boneskull force-pushed the boneskull/mocha-unit-tests branch from 263c7b1 to 0929e14 Compare May 12, 2020 19:03

boneskull force-pushed the boneskull/mocha-unit-tests branch from 0929e14 to f210e64 Compare May 12, 2020 21:15

boneskull force-pushed the boneskull/mocha-unit-tests branch from f210e64 to cf53102 Compare May 12, 2020 21:25

nicojs approved these changes May 13, 2020

View reviewed changes

boneskull added 2 commits May 14, 2020 12:24

fix improper warnings for invalid reporters

5b7798a

also: reorganize, add, and refactor a bunch of problematic unit tests for `lib/mocha.js`. better isolation except where we can't really do that (calling `require`) there's still missing tests in here, but this is an improvement.

restrict use of Object.assign

4f01095

boneskull force-pushed the boneskull/mocha-unit-tests branch from cf53102 to 4f01095 Compare May 14, 2020 19:24

add wrapper around process.cwd()

0bd7e14

- better isolation - a use of `process.cwd()` in `lib/runner.js` was left in place to avoid conflicts, because another PR will remove it

boneskull merged commit 1a4646d into master May 14, 2020

boneskull deleted the boneskull/mocha-unit-tests branch May 14, 2020 21:49

craigtaub added this to the next milestone May 21, 2020

Omrisnyk mentioned this pull request Dec 7, 2023

[Snyk] Fix for 1 vulnerabilities Omrisnyk/npm-lockfiles#131

Open

tpicard586 mentioned this pull request Jul 21, 2024

[Snyk] Upgrade mocha from 7.1.1 to 7.2.0 tpicard586/damn-vulnerable-defi#3

Open

hashim21223445 mentioned this pull request Jul 28, 2024

[Snyk] Upgrade mocha from 7.1.2 to 7.2.0 hashim21223445/port-authority#3

Closed

jennifer-shehane mentioned this pull request Apr 1, 2025

dependency: upgrade mocha to 7.2.0 cypress-io/cypress#31423

Merged

3 tasks

Uh oh!

fix improper warnings for invalid reporters #4275

fix improper warnings for invalid reporters #4275

Uh oh!

Conversation

boneskull commented May 8, 2020

Uh oh!

boneskull commented May 8, 2020

Uh oh!

craigtaub commented May 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

boneskull commented May 11, 2020

Uh oh!

boneskull commented May 11, 2020

Uh oh!

coveralls commented May 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

boneskull commented May 11, 2020

Uh oh!

boneskull commented May 12, 2020

Uh oh!

nicojs commented May 12, 2020

Uh oh!

boneskull commented May 12, 2020

Uh oh!

nicojs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nicojs May 12, 2020

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

craigtaub commented May 9, 2020 •

edited

Loading

coveralls commented May 11, 2020 •

edited

Loading