Do not disable webdriver steps reporting when using cucumber step reporter

[gambrose]

Proposed changes

Resolves #6048

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

I have marked this as a breaking change as it will affect existing users that have useCucumberStepReporter turned on. If they want to preserve the existing behaviour then would need to also enable disableWebdriverStepsReporting

Reviewers: @webdriverio/project-committers

[jsf-clabot]

All committers have signed the CLA.

[christian-bromann]

@gambrose can you please sign the CLA with the email you committed the PR with?

@BorisOsipov I would need your input here if this makes sense 🤔

[christian-bromann]

It seems that this patch disables whatever useCucumberStepReporter was suppose to be for, doesn't seem to me like a right solution.

[gambrose]

From my understanding, useCucumberStepReporter setting is used to change the report hierarchy when using cucumber. It goes this by using steps instead of tests (see line 103).

It appears it also disabled the command logging but as this is controlled using a separate flag and I would like to use both features as per #6049 I think this is the correct approach.

[BorisOsipov]

@gambrose @christian-bromann
I am useCucumberStepReporter option author. I don't remember why I disable webdriver steps reporting. If it works and report doesn't look like a mess I don't mind

[gambrose]

If it works and report doesn't look like a mess I don't mind

The report obviously has more steps with web driver reporting enabled but these extra steps appear as sub-steps to the steps with the gerkin text. So it is still readable and you can then drill down to see what commands where run.

You can also easily get the original behaviour by also enabling disableWebdriverStepsReporting.

[christian-bromann]

@gambrose can you provide a screenshot how the behavior was before and how it is now?

[gambrose]

Original behaviour

After change

And as I said you regain original behaviour if you also specify disableWebdriverStepsReporting

• example is taken from https://github.com/webdriverio/cucumber-boilerplate

[christian-bromann]

Sounds good! Thanks for looking into this 👍