feat(mock): emit 'request', 'overwrite', 'fail', 'match', 'continue' events

[KuznetsovRoman]

Proposed changes

Make a mock EventEmitter, emitting request, overwrite, fail, continue events

request is being emitted on request
overwrite is being emitted if response is being overwrited by respond / respondOnce
fail is being emitted if request is aborted by abort / abortOnce
match is being emitted when request is added to matches array (before continue or overwrite) (it has mockedResponse property if overwrite is provided)
continue is being emitted if mock is a spy of if response was already sent (like in case with two mocks. If two mock patterns match current request, and both of them has some overwrites. Then first mock will trigger overwrite event, and the second one will trigger continue)

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update

Checklist

• I have read the CONTRIBUTING doc
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)
• I have added proper type definitions for new commands (if appropriate)

Further comments

Will be provided in self-review by lines

Reviewers: @webdriverio/project-committers

[christian-bromann]

The change looks good to me. Can you provide the motivation of this change and maybe add it to the docs section for people that skim through them can immediately for what this is useful?

[KuznetsovRoman]

Can you provide the motivation of this change and maybe add it to the docs section for people that skim through them can immediately for what this is useful?

Sure. Added some examples in Events section of mock page.

In addition, you could also modify props of object, passed to event handler, but for now i could not imagine use-cases for that.

Also, here is the order of emitting events:

• request
• match
• continue / overwrite / fail (strictly one of these per request in each mock)

[christian-bromann]

Great examples! Some last questions.

[christian-bromann]

How about we wrap this into a custom command, e.g.

await browser.addCustomCommand('loadPageWithout404', (url, { selector, predicate }) => { ... })

browser.loadPageWithout404('some/url', { selector: 'main' })

Seems to be more WebdriverIO native.

[KuznetsovRoman]

Done

[christian-bromann]

Awesome, thanks a lot 👍