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

Fix cypress run --headless #5953

Merged
merged 16 commits into from
Dec 16, 2019
Merged

Fix cypress run --headless #5953

merged 16 commits into from
Dec 16, 2019

Conversation

flotwig
Copy link
Contributor

@flotwig flotwig commented Dec 13, 2019

User facing changelog

  • Fixed a bug where cypress run --headless would not run Chrome-family browsers headlessly.

Additional details

  • mis-merged a decaffeinated version of chrome.js and tests didn't catch it :/

Results of Browser.getWindowBounds:

chrome
headless 800x600
headed 1050x1004

How has the user experience changed?

PR Tasks

  • Have tests been added/updated?
  • Has the original issue been tagged with a release in ZenHub?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Dec 13, 2019

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.

@@ -118,7 +118,11 @@ const pluginsBeforeBrowserLaunch = function (browser, args) {
})
}

const _normalizeArgExtensions = function (dest, args) {
const _normalizeArgExtensions = function (dest, args, browser) {
Copy link
Contributor

Choose a reason for hiding this comment

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

can we have some JSDocs here? or comments if the browser is headless, then we cannot load any extensions, thus we return arguments as is. Because it is unclear what this function does - if the browser is headless we return args - but what if the arguments include LOAD_EXTENSION? shouldn't we filter them out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

if the plugin returns extensions, they are filtered out elsewhere. in any case, chrome will still successfully launch with --load-extension passed, but no extension will really be loaded

Copy link
Contributor Author

Choose a reason for hiding this comment

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

converted the .js to .ts and added documentation: 86969ee


pathToTheme = extension.getPathToTheme()

chrome.open("chrome", "http://", { isHeadless: true, isHeaded: false }, @automation)
chrome.open({ isHeadless: true, isHeaded: false }, "http://", {}, @automation)
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel here it would be helpful to extract arguments into named objects like maybe

browserInfo = {
  isHeadless: true,
  isHeaded: false
}
urlToLoad = "http://"
options = {}
chrome.open(browserInfo, urlToLoad, options, @automation)

@cypress
Copy link

cypress bot commented Dec 13, 2019



Test summary

3584 0 47 0


Run details

Project cypress
Status Passed
Commit bd52820
Started Dec 16, 2019 4:35 PM
Ended Dec 16, 2019 4:41 PM
Duration 05:56 💡
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

@flotwig flotwig changed the title [WIP] Fix cypress run --headless Fix cypress run --headless Dec 13, 2019
@flotwig flotwig requested review from brian-mann, bahmutov and a team December 13, 2019 21:36
@flotwig flotwig merged commit c8b184b into develop Dec 16, 2019
kenrick95 added a commit to kenrick95/cypress-documentation that referenced this pull request Jan 2, 2020
Per this PR (cypress-io/cypress#5953), the file `packages/server/lib/browsers/chrome.js` has been renamed to `packages/server/lib/browsers/chrome.ts`. This commit updates that link (also updates the line number to the desired information).
jennifer-shehane pushed a commit to cypress-io/cypress-documentation that referenced this pull request Jan 2, 2020
Per this PR (cypress-io/cypress#5953), the file `packages/server/lib/browsers/chrome.js` has been renamed to `packages/server/lib/browsers/chrome.ts`. This commit updates that link (also updates the line number to the desired information).
@flotwig flotwig deleted the issue-5949-fix-headless branch January 24, 2022 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Running with headless chrome settings opens a visible maximized chrome instance
3 participants