fix async recursion when retrying to start SC tunnel

[enriquegh]

Proposed changes

Prior to this change, when retrying the function was not called using await

This change adds await when retrying SC tunnel startup

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]

• ❌ - Enrique Gonzalez The commit (88573b5) is not authorized under a signed CLA. Please click here to be authorized. For further assistance with EasyCLA, please submit a support request ticket.

[christian-bromann]

@enriquegh thanks for sending a PR.

I am not sure if this change has any effect. It already returns a promise which fails if rejected. With await it would fail in the function but the result is the same.

[enriquegh]

Hey @christian-bromann thanks for the comment.
Main reason I thought about this is because I see something like this in a customer's logs:

28 09 2021 16:41:25.389:INFO [framework.browserify]: bundle built
28 09 2021 16:41:25.451:INFO [karma-server]: Karma v6.3.2 server started at http://localhost:8001/
28 09 2021 16:41:25.452:INFO [launcher]: Launching browsers sl_chrome_latest_macOS_Catalina, sl_firefox_macOS_Catalina with concurrency 4
28 09 2021 16:41:25.457:INFO [launcher]: Starting browser Chrome latest macOS 10.15 on SauceLabs
28 09 2021 16:41:25.457:***** [launcher]: null -> BEING_CAPTURED
28 09 2021 16:41:25.491:INFO [launcher]: Starting browser Firefox  macOS 10.15 on SauceLabs
28 09 2021 16:41:25.491:***** [launcher]: null -> BEING_CAPTURED
28 09 2021 16:41:33.621:***** [launcher.SauceConnect]: Failed to start Sauce Connect Proxy due to Error: spawn /home/circleci/user/node_modules/saucelabs/build/.sc-v4.6.4/bin/sc ENOENT
    at Process.ChildProcess._handle.onexit (internal/child_process.js:269:19)
    at onErrorNT (internal/child_process.js:467:16)
    at processTicksAndRejections (internal/process/task_queues.js:82:21)
28 09 2021 16:41:33.621:***** [launcher.SauceConnect]: Retrying 1/3

nothing really happening after Retrying 1/3 and the job times out after 10 minutes.
So that kinda made me think it might not be getting called because of the await?
I will admit since I can't reproduce this at all it's hard for me to say if it even is retrying.

[christian-bromann]

Hey @enriquegh

I looked into this and I believe the await would be counter productive because if the retry doesn't work it would throw the error in the catch block and not retry again. The problem must be somewhere else 🤔