Feat: event setup for nightwatch hooks

[harshit-bs]

Supported Events

Default Nightwatch Runner Events

1. GlobalBeforeStarted
2. GlobalBeforeFinished
3. GlobalBeforeChildProcessStarted
4. GlobalBeforeChildProcessFinished
5. GlobalBeforeEachStarted
6. GlobalBeforeEachFinished
7. GlobalAfterEachStarted
8. GlobalAfterEachFinished
9. GlobalAfterChildProcessStarted
10. GlobalAfterChildProcessFinished
11. GlobalAfterStarted
12. GlobalAfterFinished
13. TestSuiteStarted
14. TestSuiteFinished
15. BeforeStarted
16. BeforeFinished
17. BeforeEachStarted
18. BeforeEachFinished
19. TestRunStarted
20. TestRunFinished
21. AfterEachStarted
22. AfterEachFinished
23. AfterStarted
24. AfterFinished
25. LogCreated

Cucumber Runner Events

1. TestStarted
2. TestFinished
3. TestCaseStarted
4. TestCaseFinished
5. TestStepStarted
6. TestStepFinished

Common Events

1. ScreenshotCreated

Subscribing to Events

In order to subscribe to the events, the user has the option to define an registerEventHandlers function within the globals of either NightwatchJS or plugins.

Here's how you could define an registerEventHandlers function to handle these events:

module.exports = {
  // Custom reporter
  reporter: function(results, done) {
    // do something with the results
    done(results);
  },
  
  registerEventHandlers(eventBroadcaster) {
    eventBroadcaster.on('TestRunStarted', (args) => console.log('test run started'));
    eventBroadcaster.on('TestRunFinished', (args) => console.log('test run finished'))
  };
}

[gravityvi]

is it possible to give out instance of event emitter to plugins and globals? In this approach we are iterating over plugins for each event emission which I don't think is optimally correct. Also why can't we emit specific events instead of emitting one global event and running all the functions on each plugin.

Example:
at plugin level the implementation wuold look like

onEvent(eventBroadcaster) {
    eventBroadcaster.on('TestRunStarted', () => consol.log('test run started'))
  // ....
}

[swrdfish]

is it possible to give out instance of event emitter to plugins and globals? In this approach we are iterating over plugins for each event emission which I don't think is optimally correct. Also why can't we emit specific events instead of emitting one global event and running all the functions on each plugin.

Example: at plugin level the implementation wuold look like

onEvent(eventBroadcaster) {
    eventBroadcaster.on('TestRunStarted', () => consol.log('test run started'))
  // ....
}

@gravityvi It possible to pass in the event emitter. I came up with this approach because the api looked a bit strange to me (onEvent gives the notion that the function will be called on some event). But since you have pointed it out, this approach IS less efficient. Thinking about it again I guess something like this should be good. What do you think?

 setEventHandlers(eventBroadcaster) {
     eventBroadcaster.on('TestRunStarted', () => consol.log('test run started'))
   // ....
 }

@beatfactor What are your thoughts? How should the API look?

[github-actions]

Status

• ❌ No modified files found in the types directory.
  Please make sure to include types for any changes you have made. Thank you!.