(webdriverio): add throttleCPU and throttleNetwork commands

[erwinheitzman]

Proposed changes

• Added a throttleNetwork and throttleCPU command, after which the throttle command has become an alias for throttleNetwork.
• Updated the debugging docs to explain the different causes of flakiness and how they can be debugged (using the throttleNetwork and throttleCPU command)

This allows our users to easily throttle both and debug flaky tests.
We can remove the throttle command itself in v9.

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)

Reviewers: @webdriverio/project-committers

[christian-bromann]

Some minor comments but overall looks good.

[erwinheitzman]

Thanks @christian-bromann I have resolved your feedback 👍

[erwinheitzman]

Is there a way to improve the failing test?

I don't see why we check the amount of browser commands

[christian-bromann]

I would love to see a better deprecation system because this message gets lost in the logs and I wonder if we can better amplify it in the stdout. However this should not block this PR to get merged.

LGTM 👍

[erwinheitzman]

Can this be merged with the failing tests?

[christian-bromann]

I think we should fix the one that is failing. I can take a look when I have time.

[erwinheitzman]

I think we should fix the one that is failing. I can take a look when I have time.

These are the same tests that are failing for #11542 and I honestly have no idea why it's failing in either of these PR's 😮
Any pointers or help with this is greatly appreciated ❤️

[christian-bromann]

These are the same tests that are failing for #11542

Not quite, in this PR this test is failing:

 FAIL  packages/webdriverio/tests/commands/browser.test.ts > browser commands list and strategies
AssertionError: expected [ 'puppeteer', '$$', '$', …(36) ] to deeply equal [ 'puppeteer', '$$', '$', …(37) ]

in #11542 the following tests are failing:

FAIL  packages/wdio-utils/tests/node/index.test.ts > startWebDriver > should start firefox driver
AssertionError: expected "spy" to be called with arguments: [ { port: 1234, foo: 'bar', …(1) } ]

 FAIL  packages/wdio-utils/tests/node/index.test.ts > startWebDriver > should start no driver or download geckodriver if binaries are defined
AssertionError: expected "spy" to be called with arguments: [ { cacheDir: Any{ …(3) }, …(2) } ]

For latter you have to adjust the assertions since you now set different arguments when starting a Chromedriver session. For this PR it seems like the throttle command is not attached to the scope properly.

[christian-bromann]

By removing this export, the command is not attached to the browser scope anymore which would cause a breaking change

[christian-bromann]

Resolve build issues.

[christian-bromann]

I will go ahead and merge this and gonna fix remaining test issues in main.

Thanks a lot, this is awesome 👍