Skip to content

Fix: listen to 'start' and 'end' events when using Mocha programmatically #3660

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
Merged
merged 1 commit into from
Mar 9, 2020
Merged

Fix: listen to 'start' and 'end' events when using Mocha programmatically #3660

merged 1 commit into from
Mar 9, 2020

Conversation

@juergba
Copy link
Contributor

@juergba juergba commented Jan 6, 2019 •
edited
Loading

Description

mocha.run() returns a runner instance. Since the EVENT_RUN_BEGIN (start) event is emitted synchronously, it's impossible to register an EVENT_RUN_BEGIN listener in time. The event is emitted, but never catched.

When no tests are provided - eg. by a too restrictive grep expression - then neither EVENT_RUN_BEGIN nor EVENT_RUN_END (end) events can be listened to.

var mocha = new Mocha();

mocha.addFile("../eventStart.js");

mocha.run()
  .on(EVENT_RUN_BEGIN, () => console.log('start'))    // never runs
  .on(EVENT_RUN_END, () => console.log('end'));       // never runs when no tests are provided

Description of Change

We delay the start of the root Suite by Runner.immediately. The order of the event emissions remains unchanged.

Applicable issues

#3395 (backed out)
#3331
#3065
closes #2753

@coveralls
Copy link

coveralls commented Jan 6, 2019 •
edited
Loading

Coverage Status

Coverage increased (+0.07%) to 92.97% when pulling 1f31f4e on juergba:juergba/issue/3414 into 9cbb6f6 on mochajs:master.

@juergba juergba closed this Jan 6, 2019
@juergba juergba force-pushed the juergba/issue/3414 branch from 34d1d2b to cb1c6b0 Compare January 6, 2019 16:15
@juergba
Copy link
Contributor Author

juergba commented Jan 6, 2019

I messed up my branch, now everything is ok. Hopefully this will reopen my PR.

@juergba juergba reopened this Jan 6, 2019
@plroebuck
Copy link
Contributor

plroebuck commented Jan 7, 2019

There is no way to register EventListener to the runner instance when Mocha runs programmatically with mocha.run().

Isn't this already possible with delayed root suite?

@juergba juergba force-pushed the juergba/issue/3414 branch from 88da0fc to df86333 Compare January 8, 2019 09:26
@juergba
Copy link
Contributor Author

juergba commented Jan 8, 2019

@plroebuck
I don't expect the user to know the answer, if I (we) don't know it without analyzing code and try-and-error testing. It wouldn't be an user-friendly solution.

yes, but... : if there are test files found, which include the (delay) run() function. (no: waiting)
no: if there are no test files found (grep)
no: waiting event doesn't work at all, which is emitted before start event

--delay does alter the event firing. start and end events are emitted twice, probably one additional set while the files get loaded.

@juergba juergba changed the title WIP: EventListener for runner instance when running programmatically with mocha.run() EventListener for runner instance when running programmatically with mocha.run() Jan 8, 2019
@juergba juergba force-pushed the juergba/issue/3414 branch from df86333 to c4f23a3 Compare January 19, 2019 10:23
@outsideris outsideris added the area: usability concerning user experience or interface label Jan 26, 2019
boneskull
boneskull previously requested changes Feb 27, 2019
View reviewed changes
Copy link
Member

@boneskull boneskull left a comment

Choose a reason for hiding this comment

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

It seems we could instantiate the Runner in the Mocha constructor instead of in Mocha#run(), and then make it a property of the Mocha instance:

function Mocha() {
  // create root suite, process options
  this.runner = new Runner(rootSuite, options.delay);
}

Then users could:

const mocha = new Mocha();
mocha.runner.on('stuff', () => {})

Needs conflicts resolved

@boneskull boneskull added the semver-minor implementation requires increase of "minor" version number; "features" label Feb 27, 2019
@juergba juergba force-pushed the juergba/issue/3414 branch from c4f23a3 to 2338a41 Compare March 14, 2019 18:19
@juergba juergba changed the title EventListener for runner instance when running programmatically with mocha.run() WIP: Registration of EventListener to the "runner" instance with mocha.run() Mar 14, 2019
@juergba juergba added status: needs review a maintainer should (re-)review this pull request and removed pr-needs-work labels Mar 14, 2019
@juergba juergba force-pushed the juergba/issue/3414 branch from 2338a41 to 430af80 Compare March 15, 2019 09:43
@juergba juergba removed the status: needs review a maintainer should (re-)review this pull request label Mar 31, 2019
@juergba juergba self-assigned this Mar 31, 2019
@juergba juergba added area: async related to asynchronous use of Mocha type: bug a defect, confirmed by a maintainer semver-patch implementation requires increase of "patch" version number; "bug fixes" and removed semver-minor implementation requires increase of "minor" version number; "features" area: usability concerning user experience or interface labels Feb 28, 2020
@juergba juergba dismissed boneskull’s stale review February 28, 2020 08:21

Outdated, I started a new approach to fix this issue

@juergba juergba changed the title WIP: Registration of EventListener to the "runner" instance with mocha.run() Fix: listen to 'start' and 'end' events when using Mocha programmatically Feb 28, 2020
@juergba juergba requested review from a team and removed request for craigtaub, outsideris and plroebuck February 28, 2020 08:52
@juergba juergba added the status: needs review a maintainer should (re-)review this pull request label Feb 28, 2020
@mochajs mochajs deleted a comment from plroebuck Feb 28, 2020
@mochajs mochajs deleted a comment from boneskull Feb 28, 2020
@juergba juergba force-pushed the juergba/issue/3414 branch from c4aa79a to 1f31f4e Compare March 9, 2020 07:08
@juergba juergba removed the status: needs review a maintainer should (re-)review this pull request label Mar 9, 2020
@juergba juergba added this to the next milestone Mar 9, 2020
@juergba juergba merged commit e1389ef into mochajs:master Mar 9, 2020
@juergba juergba deleted the juergba/issue/3414 branch March 9, 2020 08:38
@juergba juergba added the landed-on-v7.1.x cherry-picked from master label Mar 18, 2020
This was referenced Apr 28, 2020
Open
Merged
Merged
Merged
Closed
Merged
Merged
Merged
@tpicard586 tpicard586 mentioned this pull request Jul 21, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@boneskull boneskull boneskull left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@juergba juergba

Labels

area: async related to asynchronous use of Mocha landed-on-v7.1.x cherry-picked from master semver-patch implementation requires increase of "patch" version number; "bug fixes" type: bug a defect, confirmed by a maintainer

Projects

None yet

Milestone

v7.1.1

Development

Successfully merging this pull request may close these issues.

unable to listen to start event during programmatic run

5 participants

@juergba @coveralls @plroebuck @boneskull @outsideris