Minimum Cypress 12.15.0 for new Google Chrome 117 needed

[MikeMcC399]

Subject

Guides > Launching Browsers > Chrome Browsers

Description

According to discussion in https://discord.com/channels/755913899261296641/1151449941449912420

Google Chrome 117 needs a minimum of Cypress 12.15.0 to work together out-of-the-box.

I'm uncertain if this needs to be documented, since https://docs.cypress.io/guides/guides/launching-browsers#Download-specific-Chrome-version already says:

The Chrome browser is evergreen - meaning it will automatically update itself,
sometimes causing a breaking change in your automated tests. We host
chromium.cypress.io with links to download a
specific released version of Chrome (dev, Canary and stable) for every platform.

So this is just a "heads-up".

Edit: See #5479 (comment) for workaround.

[mjhenkes]

I can't log into discord for whatever reason but if this is related to --headless=new, you should be able to enable it in any older version of cypress by modifying this guide: https://docs.cypress.io/api/plugins/browser-launch-api#Disable---headlessnew-for-Chrome

on('before:browser:launch', (browser = {}, launchOptions) => {
  if (browser.name === 'chrome' && browser.isHeadless) {
    launchOptions.args = launchOptions.args.map((arg) => {
      if (arg === '--headless') {
        return '--headless=new'
      }

      return arg
    })
  }

  return launchOptions
})

[mjhenkes]

@MikeMcC399, could you state what the root issue is that you're seeing outside of a link to discord. I'm just guessing it might be related to the headless new flag and demonstrating how you could change that flag in cypress versions prior to 12.15.0

[MikeMcC399]

@mjhenkes

Sorry for the updates on the fly, which may have been a bit confusing!

So the root issue reported in Discord is that using Cypress 12.9.0 in headless mode resulted in a failure to connect to Chrome 117.

Still waiting to connect to Chrome, retrying in 1 second (attempt 62/62)
All promises were rejected
AggregateError: All promises were rejected

• workaround: update to a minimum of Cypress 12.15.0.
• workaround: npx cypress run --browser chrome --headed
• not a workaround: https://docs.cypress.io/api/plugins/browser-launch-api#Disable---headlessnew-for-Chrome. This just had no effect in Cypress 12.9.0. "Still waiting to connect to Chrome ..." continued to be output.

Edit:

• workaround: use code posted in Minimum Cypress 12.15.0 for new Google Chrome 117 needed #5479 (comment) (not the code from the website link)

[PlaxoGhouse]

Cypress works fine on Chrome Headed browser. However, When I run on Chrome (Version 117.0.5938.63 (Official Build) (64-bit)) headless browser then it fails.

Still waiting to connect to Chrome, retrying in 1 second (attempt 62/62)
Cypress failed to make a connection to the Chrome DevTools Protocol after retrying for 50 seconds.
This usually indicates there was a problem opening the Chrome browser.
The CDP port requested was 54291.
Error: connect ECONNREFUSED 127.0.0.1:54291 at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1161:16)

[MikeMcC399]

@PlaxoGhouse

Which version of Cypress, which operating system and which version of Node.js are you using? The error message is very similar to what I saw, but it is not identical.

[PlaxoGhouse]

For one of my Project, I am using "cypress": "^9.7.0", node : v18.16.0. Running it on Windows 10 and Linux machine.

 "cypress": "^9.6.0",
    "cypress-cucumber-attach-screenshots-to-failed-steps": "^1.0.0",
    "cypress-cucumber-preprocessor": "^4.3.0",
    "cypress-failed-log": "^2.9.5",
    "cypress-file-upload": "^4.1.1",
    "cypress-terminal-report": "^3.5.2",
    "cypress-wait-until": "^1.7.1",
    "cypress-xpath": "^1.8.0",
    "multiple-cucumber-html-reporter": "^3.1.0"

It was working fine on Headless with previous Chrome version (116).

[MikeMcC399]

I can't see anything in the Chrome 117 blog which could explain the sudden Cypress compatibility issues, where older versions of Cypress which worked with Chrome 116 now stopped working with Chrome 117.

[drc-nloftsgard]

@MikeMcC399 any removal in this list chrome-117-beta that would explain the issue?

[MikeMcC399]

@drc-nloftsgard

Thanks for the link chrome-117-beta! The one in the blog (https://developer.chrome.com/blog/deps-rems-117/) just gave a 404.

I'll have to defer to the browser experts to judge what has gone wrong. I'm not deeply enough into this to be able to sort it out myself. Perhaps it is simply a bug / unintended regression in Chrome 117?

[mschile]

@MikeMcC399, using the workaround provided by @mjhenkes above, I was able to successfully run the tests on Cypress 12.9.0.

[mschile]

@MikeMcC399, this was on MacOS 13.5. I'm going to try my Windows and Linux VM as well.

[MikeMcC399]

@mschile

I am so sorry. I completely misread @mjhenkes advice and used the workaround from the docs, not the one he posted.

The docs say:

if (arg === '--headless=new') {
        return '--headless'

and his advice was exactly the opposite way around:

      if (arg === '--headless') {
        return '--headless=new'

I will go back and re-test.

[MikeMcC399]

I verified the workaround from above:

using the workaround provided by @mjhenkes above, I was able to successfully run the tests on Cypress 12.9.0.

With Cypress 12.9.0 and Node.js 18.17.1:

• Ubuntu 22.04.3 LTS with Chrome 117.0.5938.62

• Windows 11 Pro with Chrome 117.0.5938.63

(I have hidden the posts where I used the wrong workaround to avoid confusion.)

[MikeMcC399]

Should this workaround be published in the docs now?

[MikeMcC399]

This is not a documentation issue, since it is only a temporary condition caused by the Chromium bug 1483163 which causes Chromium 117 version family browsers (Chromium, Chrome & Edge) to crash under certain conditions when run in headless mode.

The issue is resolved in Chrome Canary 119.

Using Chrome Canary build on Windows win64 downloaded from
https://www.google.com/chrome/canary/?platform=win64
Version 119.0.6017.1 (Official Build) canary-dcheck (64-bit)

git clone --branch test/chrome-stable-cypress-12-14-0 https://github.com/MikeMcC399/github-action
cd github-action/examples/browser
npm ci
npx cypress info
npx cypress run --browser chrome:canary

runs successfully with Cypress 12.14.0 and Chrome 119.0.6017.1

  (Run Starting)

  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
  │ Cypress:        12.14.0                                                                        │
  │ Browser:        Canary 119 (headless)                                                          │
  │ Node Version:   v20.7.0 (C:\Program Files\nodejs\node.exe)                                     │
  │ Specs:          1 found (spec.cy.js)                                                           │
  │ Searched:       cypress/e2e/**/*.cy.{js,jsx,ts,tsx}                                            │
  └────────────────────────────────────────────────────────────────────────────────────────────────┘


────────────────────────────────────────────────────────────────────────────────────────────────────

  Running:  spec.cy.js                                                                      (1 of 1)
before launching browser
{
  name: 'chrome',
  family: 'chromium',
  channel: 'canary',
  displayName: 'Canary',
  version: '119.0.6017.1',
  path: 'C:\\Users\\mikem\\AppData\\Local\\Google\\Chrome SxS\\Application\\chrome.exe',
  minSupportedVersion: 64,
  majorVersion: '119',
  isHeadless: true,
  isHeaded: false
}
chrome launch args:
--test-type
--ignore-certificate-errors
--start-maximized
--silent-debugger-extension-api
--no-default-browser-check
--no-first-run
--noerrdialogs
--enable-fixed-layout
--disable-popup-blocking
--disable-password-generation
--disable-single-click-autofill
--disable-prompt-on-repos
--disable-background-timer-throttling
--disable-renderer-backgrounding
--disable-renderer-throttling
--disable-backgrounding-occluded-windows
--disable-restore-session-state
--disable-new-profile-management
--disable-new-avatar-menu
--allow-insecure-localhost
--reduce-security-for-testing
--enable-automation
--disable-print-preview
--disable-device-discovery-notifications
--autoplay-policy=no-user-gesture-required
--disable-site-isolation-trials
--metrics-recording-only
--disable-prompt-on-repost
--disable-hang-monitor
--disable-sync
--disable-web-resources
--safebrowsing-disable-download-protection
--disable-client-side-phishing-detection
--disable-component-update
--simulate-outdated-no-au='Tue, 31 Dec 2099 23:59:59 GMT'
--disable-default-apps
--use-fake-ui-for-media-stream
--use-fake-device-for-media-stream
--disable-ipc-flooding-protection
--disable-backgrounding-occluded-window
--disable-breakpad
--password-store=basic
--use-mock-keychain
--disable-dev-shm-usage
--enable-precise-memory-info
--proxy-server=http://localhost:55529
--proxy-bypass-list=<-loopback>
--headless
--window-size=1280,720
--force-device-scale-factor=1
--remote-debugging-port=55533
--remote-debugging-address=127.0.0.1
--window-size=1920,1080


  √ works (468ms)

  1 passing (3s)


  (Results)

  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
  │ Tests:        1                                                                                │
  │ Passing:      1                                                                                │
  │ Failing:      0                                                                                │
  │ Pending:      0                                                                                │
  │ Skipped:      0                                                                                │
  │ Screenshots:  0                                                                                │
  │ Video:        false                                                                            │
  │ Duration:     2 seconds                                                                        │
  │ Spec Ran:     spec.cy.js                                                                       │
  └────────────────────────────────────────────────────────────────────────────────────────────────┘


====================================================================================================

  (Run Finished)


       Spec                                              Tests  Passing  Failing  Pending  Skipped
  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
  │ ✔  spec.cy.js                               00:02        1        1        -        -        - │
  └────────────────────────────────────────────────────────────────────────────────────────────────┘
    ✔  All specs passed!                        00:02        1        1        -        -        -

[giantryansaul]

@MikeMcC399 I've been trying to implement the 'before:browser:launch' workaround in the thread, we are on Cypress 9.7.0 (we have someone looking into a cypress upgrade currently).

Locally, the fix works for me on my M1 MacBook. But when I try to run this in Github Actions using their ubuntu-22 runner it breaks.

Interestingly it works fine for the first test, but the 2nd test always runs into the same Still waiting to connect to Chrome, retrying in 1 second issue.

One thing I tried was jumbling the tests around just to see if it was a particular test that was having issues, but it looks like any combination of tests does this.

We are also using v5 of the Cypress GIthub Actions Runner. I haven't tried using v6 yet since it needs a node upgrade.

[MikeMcC399]

@giantryansaul

You may like to try the workaround of running headed temporarily until a fixed version of Chrome is rolled out.

        with:
          browser: chrome
          headed: true

I wouldn't expect any change moving from cypress-io/github-action@v5 to cypress-io/github-action@v6 as far as this issue is concerned.

If you need additional help, you could also use the Cypress technical community on Discord

(click on button)