(docs): saveScreenshot requires afterTest hook to be async

[hashar]

Proposed changes

When requesting a screenshot in afterTest I would sometime lack a screenshot file. I eventually found browser.saveScreenshot is async and the hook has to be explicitly defined async: #5545 (comment)

Add an example for using browser.saveScreenshot in the afterTest hook with the hook being set async explicitly. This would have saved me a bit of troubleshooting time.

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

Reviewers: @webdriverio/project-committers

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: hashar / name: Antoine Musso (f7cabb6)
• ✅ login: christian-bromann / name: Christian Bromann (0425383)

[hashar]

I am making this contribution with a shared copyright between me as an individual and @wikimedia foundation. I don't know whether this contribution is copyrightable or subject to CLA, if it can be opted out feel free to merge it in.

Meanwhile I will reach out to @wikimedia legal department to review and sign the OpenJS CCLA which I can not sign in name of the organization.

[zeljkofilipin]

@hashar I have contacted @wikimedia legal team while working on #7999. I think the CLA is signed. They will probably know what to do, but as far as I remember, you have to add your wikimedia email to your github profile and sign the commit with it.

https://github.com/settings/emails

[hashar]

I have amended the commit message to add:

 Signed-off-by: Antoine Musso <amusso@wikimedia.org>

But EasyCLA still fails. That is now pending approval of my account by the Wikimedia Legal team :)

[erwinheitzman]

Honestly this applies to all commands you use, not just in a hook but everywhere, so I don't really see a benefit in explicitly adding this.

It also applies to all hooks that they have to be async when awaiting any promise.

[christian-bromann]

Any updates @hashar ?

[hashar]

Any updates @hashar ?

I went ahead and signed an individual CLA since I have shared copyright for the work I am doing while working for Wikimedia. I will still reach out to our the organization legal team to find out how to get added to the corporate CLA as well.

I have no idea how to retrigger EasyCLA verification :)

[hashar]

Honestly this applies to all commands you use, not just in a hook but everywhere, so I don't really see a benefit in explicitly adding this.

It also applies to all hooks that they have to be async when awaiting any promise.

I guess the issue I have is I am not familiar with JavaScript and got caught on calling the browser.saveScreenshot without an await cause the hook does not have async by default, at least it did not have it at the time we generated the wdio.conf.js and it seems online documentation do not explicitly mention the hooks are async. I blame myself for my poor familiarity with Javascript and hoping this documentation my save someone some hours figuring out why screenshots are not taken :]

[christian-bromann]

@linux-foundation-easycla
EasyCLA — EasyCLA check passed. You are authorized to contribute.

It is actually passing now, thanks for getting the approval

[christian-bromann]

LGTM 👍

[hashar]

Any updates @hashar ?

I went ahead and signed an individual CLA since I have shared copyright for the work I am doing while working for Wikimedia. I will still reach out to our the organization legal team to find out how to get added to the corporate CLA as well.

I have no idea how to retrigger EasyCLA verification :)

As a follow-up, I got added to the Wikimedia Foundation contributors and signed the corporate CLA through EasyCLA. Success!

[christian-bromann]

Nice 🎉 looking forward to more contributions then 😉