chore: added support for --runner-ui and --no-runner-ui cli options

[mschile]

Additional details

• Added new run mode cli only options, --runner-ui and --no-runner-ui
• Added new runnerUi parameter to the module API
• In addition to hiding the command log, when the runner is hidden, the runner header is also hidden.
• If the protocol is enabled, the runner is hidden:
  • passing --runner-ui will override this behavior and show the runner

Steps to test

• In run mode, pass --no-runner-ui and verify the runner is not displayed
• With protocol enabled, pass --runner-ui and verify the runner is displayed

How has the user experience changed?

Protocol enabled (runner is hidden by default):

Protocol enabled passing --runner-ui

PR Tasks

• Have tests been added/updated?
• Has a PR for user-facing changes been opened in cypress-documentation?
• Have API changes been updated in the type definitions?

[cypress]

4 flaky tests on run #50156 ↗︎

0

5332

82

0

4

Details:

Merge branch 'release/13.0.0' into mschile/protocol/no_runner_ui
Project: cypress	Commit: cb6ed1cebb
Status: Passed	Duration: 12:48 💡
Started: Aug 18, 2023 8:57 PM	Ended: Aug 18, 2023 9:09 PM

  commands/net_stubbing.cy.ts • 1 flaky test • 5x-driver-chrome:beta

View Output Video

Test		Artifacts
network stubbing > intercepting request > can delay and throttle a StaticResponse		Output

  cypress/cypress.cy.js • 3 flaky tests • 5x-driver-chrome:beta

View Output Video

Test		Artifacts
... > correctly returns currentRetry		Output
... > correctly returns currentRetry		Output
... > correctly returns currentRetry		Output

_{This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.}

[jennifer-shehane]

@mschile Are these options also made available in the Module API so that people running in that mode can opt out? (Could be followup to release if that's warranted.)

[mschile]

@mschile Are these options also made available in the Module API so that people running in that mode can opt out? (Could be followup to release if that's warranted.)

Yes, the module API is supported through the runnerUi parameter. In this case, the user would provide true/false for the parameter similar to the exit parameter.

[chrisbreiding]

When hiding the runner UI, shouldn't we also be preventing events from going to the reporter, like with hideCommandLog: true? For example, here we don't send the reporter runnables:ready. That improves performance further since the reporter doesn't instantiate a bunch of its own state based off of that.

[mschile]

When hiding the runner UI, shouldn't we also be preventing events from going to the reporter, like with hideCommandLog: true? For example, here we don't send the reporter runnables:ready. That improves performance further since the reporter doesn't instantiate a bunch of its own state based off of that.

When hideRunnerUi is set, I also set hideCommandLog, so this will still happen.

[cypress-bot]

Released in 13.0.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v13.0.0, please open a new issue.