Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Network emulation for Chrome #6932

Closed
wants to merge 1 commit into from
Closed

[WIP] Network emulation for Chrome #6932

wants to merge 1 commit into from

Conversation

EtienneBruines
Copy link

@EtienneBruines EtienneBruines commented Apr 3, 2020 •
edited
Loading

User facing changelog

  • Added new command cy.network() that simulates network conditions

Additional details

This allows you to simulate network conditions, such as being offline or on a slow 3G network.

How has the user experience changed?

It allows the following:

    cy.contains('We are currently online.')
    cy.network({ offline: true })
    cy.contains('We are currently offline.')
    cy.network({ offline: false })
    cy.contains('We are currently online.')

PR Tasks

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Apr 3, 2020

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

@CLAassistant
Copy link

CLAassistant commented Apr 3, 2020 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

flotwig
flotwig reviewed Apr 3, 2020
View reviewed changes
Copy link
Contributor

@flotwig flotwig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for opening a PR! This is a good idea, but I think it is better suited to be used as a separate NPM module users can require in their support file for now.

While this is definitely functionality we eventually want to have in Cypress core, the lack of Firefox support blocks this from being merged for now.

Handles cy.request
- No idea what the desired behavior is here?

cy.request is simply a means for the user to perform a normal, unintercepted HTTP request from their test code, so it should be exempt from any network conditioning that applies to their test code.

@EtienneBruines
Copy link
Author

Thank you @flotwig for your reply.

For supporting Firefox, we should be able to simulate clicks towards the user-facing "Work offline" function of Firefox.

As far as I know, the cy.click() command clicks within the app, is there a way to emulate clicks on the browser window itself? e.g. such that we can enable/disable Work offline?

That would go a long way in bridging the gap until Firefox offers "real" API-support for it.

Because lack of Firefox-support seems like the only major blocking issue, this would seem like a doable workaround - one that I can imagine people will be happy with.

(Whether released in the end as separate package or as PR - I don't mind either way. I would like to offer as much functionality as possible on this topic.)

@jennifer-shehane
Copy link
Member

is there a way to emulate clicks on the browser window itself? e.g. such that we can enable/disable Work offline

@EtienneBruines no, there's no way to do this currently, you'd have to work through Firefox's available APIs to enable/disable work offline mode.

When you do publish a plugin, you can open a pull request to add it to our documentation? Instructions here.

Closing this PR for now.

@EtienneBruines EtienneBruines mentioned this pull request Apr 30, 2020
Open
@aidanxyz aidanxyz mentioned this pull request Jun 2, 2020
Closed
@EtienneBruines EtienneBruines mentioned this pull request Nov 4, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flotwig flotwig flotwig left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Simulate offline mode
4 participants
@EtienneBruines @CLAassistant @jennifer-shehane @flotwig