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.

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

Update browser types #6254

Merged
merged 20 commits into from
Jan 31, 2020
Merged

Update browser types #6254

merged 20 commits into from
Jan 31, 2020

Conversation

flotwig
Copy link
Contributor

@flotwig flotwig commented Jan 27, 2020

User facing changelog

  • Updated Cypress browser objects with a new field, channel, which contains the release channel of the detected browser.
  • Changed the family of all Chromium-based browsers, including Electron, to chromium.
  • cypress run --browser can now be used to specify a specific release channel of a browser, for example, chrome:canary to select Canary.

Additional details

  • Replace all checks for family == 'chrome' with family == 'chromium'
  • Replace all checks for family == 'electron' with name == 'electron'
  • Update --browser arg passing to allow name:channel
  • Update 'electron' static browser definition - maybe move into TS
  • fix browser icons

How has the user experience changed?

PR Tasks

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jan 27, 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.

@cypress
Copy link

cypress bot commented Jan 27, 2020



Test summary

3632 0 46 0


Run details

Project cypress
Status Passed
Commit a89b23f
Started Jan 31, 2020 5:50 PM
Ended Jan 31, 2020 5:55 PM
Duration 04:43 💡
OS Linux Debian - 9.11
Browser Multiple

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@jennifer-shehane
Copy link
Member

Have you considered Edge against these changes? It has the family set to chrome for Edge and I wasn't sure if this is what was agreed upon with what y'all have planned. https://github.com/cypress-io/cypress/pull/6181/files#diff-8b47f6bfe0325f7e2f8c5dad78954073R41

@flotwig
Copy link
Contributor Author

flotwig commented Jan 29, 2020

Have you considered Edge against these changes? It has the family set to chrome for Edge and I wasn't sure if this is what was agreed upon with what y'all have planned. cypress-io/cypress/pull/6181/files#diff-8b47f6bfe0325f7e2f8c5dad78954073R41

Yeah, see the original issue #6243, it will have a family of chromium.

@brian-mann
Copy link
Member

Preliminary review of this looks good

@flotwig flotwig force-pushed the issue-6243-update-browser-types branch 2 times, most recently from 2923e6a to ca9b598 Compare January 30, 2020 20:50
@flotwig flotwig force-pushed the issue-6243-update-browser-types branch from ca9b598 to aaf2257 Compare January 30, 2020 21:13
@flotwig flotwig changed the title [WIP] Update browser types Update browser types Jan 31, 2020
@flotwig flotwig requested a review from kuceb January 31, 2020 16:01
@flotwig flotwig merged commit 0e82cde into v4.0-release Jan 31, 2020
@jennifer-shehane jennifer-shehane added the type: breaking change Requires a new major release version label Feb 3, 2020
@flotwig flotwig deleted the issue-6243-update-browser-types branch January 24, 2022 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: breaking change Requires a new major release version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants