Automatically retry verify and run commands on Linux if suspect DISPLAY problem #4165

bahmutov · 2019-05-09T01:25:57Z

closes Presence of DISPLAY env var causes "Cypress failed to start" #4034
if the first verify retry fails, reruns with our XVFB. If still fails, shows error message with first and second errors
should display a warning message if gets a display error on the first verify attempt
should retry cypress run if there is suspected display error (shows warning as well)

cypress run warning on Linux if DISPLAY is set before re-running with our XVFB

⚠ Warning: Cypress process has finished very quickly with an error,
which might be related to a potential problem with how the DISPLAY is configured.

DISPLAY was set to "test-display"

We will attempt to spin our XVFB server and run Cypress again.

Note: to see how it performs, spin a Docker container (instructions in a comment below) and

to see cypress verify use

node -e 'require("./cli/lib/tasks/verify").start({force: true})'

to see spawn cypress run use

node -e 'require("./cli/lib/exec/spawn").start(["--run-project", "."], {dev: true})

bahmutov · 2019-05-09T14:48:52Z

cli/test/lib/errors_spec.js

+    it('expects solution to be a string', () => {
+      const error = {
+        description: 'description',
+        solution: 42,


42 is never a good answer

bahmutov · 2019-05-09T15:26:07Z

ughh, what is going on with Win32 build

15:00:18 #buildPackages win32
npm run all build -- --serial --skip-packages cli
> cypress@3.3.0 all C:\projects\cypress
> node ./scripts/run.js "build" "--serial" "--skip-packages" "cli"
npm ERR! file undefined
npm ERR! path undefined
npm ERR! code ELIFECYCLE
npm ERR! errno ENOENT
npm ERR! syscall spawn undefined
npm ERR! cypress@3.3.0 all: `node ./scripts/run.js "build" "--serial" "--skip-packages" "cli"`
npm ERR! spawn undefined ENOENT
npm ERR! 
npm ERR! Failed at the cypress@3.3.0 all script.

bahmutov · 2019-05-09T17:05:09Z

found that we can detect X11 problem using a flag

root@eabed8eaef87:/cypress/cli# ../packages/electron/dist/Cypress/Cypress --enable-logging
[215:0509/165930.091489:WARNING:browser_main_loop.cc(275)] <unknown>: Could not open X display
[215:0509/165930.091727:WARNING:browser_main_loop.cc(275)] Gtk: cannot open display: 99
root@eabed8eaef87:/cypress/cli#

so need to switch this PR to enable logging during verify step

bahmutov · 2019-05-09T18:26:52Z

the way to see this locally (via Docker)

run Docker in the cypress root folder

docker run -it -v $PWD:/cypress -w /cypress cypress/browsers:node8.9.3-chrome73

in the container install global Cypress binary (so you have something to verify)

npm i -g cypress@3.2.0

set binary as environment variable pointing at the newly installed binary

export CYPRESS_RUN_BINARY=/root/.cache/Cypress/3.2.0/Cypress/Cypress

set DISPLAY variable to something and start node

export DISPLAY=99
node

load verify task module and execute it

var verify = require('./cli/lib/tasks/verify')
verify.start({force: true})

If the verify code uses --enable-logging then you should see the good message

  cypress:cli smoke test command: /root/.cache/Cypress/3.2.0/Cypress/Cypress --smoke-test --ping=471 --enable-logging +1ms
  cypress:cli Smoke test failed: { Error: Command failed: /root/.cache/Cypress/3.2.0/Cypress/Cypress --smoke-test --ping=471 --enable-logging
[769:0509/181151.619094:WARNING:browser_main_loop.cc(258)] Gtk: cannot open display: 99


    at makeError (/cypress/cli/node_modules/execa/index.js:172:9)
    at Promise.all.then.arr (/cypress/cli/node_modules/execa/index.js:277:16)
    at <anonymous>
    at process._tickDomainCallback (internal/process/next_tick.js:228:7)
  code: 1,
  stdout: '',
  stderr: '[769:0509/181151.619094:WARNING:browser_main_loop.cc(258)] Gtk: cannot open display: 99\n',
  failed: true,
  signal: null,
  cmd: '/root/.cache/Cypress/3.2.0/Cypress/Cypress --smoke-test --ping=471 --enable-logging',
  timedOut: false,
  killed: false } +82ms
 ✖  Verifying Cypress can run /root/.cache/Cypress/3.2.0/Cypress
   → Cypress Version: 0.0.0
Unhandled rejection Error: Cypress failed to start.

This is usually caused by a missing library or dependency.

The error below should indicate which dependency is missing.

https://on.cypress.io/required-dependencies

If you are using Docker, we provide containers with all required dependencies installed.

We have noticed that DISPLAY variable is set to "99"
This might be a problem if X11 server is not responding.

https://github.com/cypress-io/cypress/issues/4034

Try deleting the DISPLAY variable and running the command again.

----------

[769:0509/181151.619094:WARNING:browser_main_loop.cc(258)] Gtk: cannot open display: 99

----------

Platform: linux (Debian - 8.11)
Cypress Version: 0.0.0

A nice way to iterate over the code (because the local source code folder has been mounted into Docker container) is to run this line, which goes around require cache

node -e 'require("./cli/lib/tasks/verify").start({force: true})'

bahmutov · 2019-05-09T20:15:42Z

cli/lib/exec/xvfb.js

+      const issueUrl = util.getGitHubIssueUrl(4034)
+
+      const message = stripIndent`
+        DISPLAY environment variable is set to ${process.env.DISPLAY} on Linux


being verbose is good, hopefully, someone reads it and understand the problem, even if we work around it using our XVFB

bahmutov · 2019-05-09T22:04:40Z

uggh, if we enable Cypress logging during full cypress spawn, there is a lot of extra stuff displayed

  cypress:server:cypress starting cypress with argv [ '/cypress/packages/electron/dist/Cypress/Cypress', '--cwd=/cypress', '--config={}', '--enable-logging' ] +0ms
[4598:0509/220121.170576:ERROR:bus.cc(395)] Failed to connect to the bus: Failed to connect to socket /var/run/dbus/system_bus_socket: No such file or directory
  cypress:server:cypress starting in mode interactive +3s
libudev: udev_has_devtmpfs: name_to_handle_at on /dev: Operation not permitted
[4598:0509/220139.987910:ERROR:bus.cc(395)] Failed to connect to the bus: Address does not contain a colon
[4598:0509/220140.032274:ERROR:bus.cc(395)] Failed to connect to the bus: Address does not contain a colon
[4598:0509/220140.630393:INFO:CONSOLE(73528)] "%cDownload the React DevTools for a better development experience: https://fb.me/react-devtools
You might need to use a local HTTP server (instead of file://): https://fb.me/react-devtools-faq", source: file:///cypress/packages/desktop-gui/dist/app.js (73528)
Gtk-Message: GtkDialog mapped without a transient parent. This is discouraged.

(Cypress:4598): dconf-WARNING **: failed to commit changes to dconf: Address element '/dev/null' does not contain a colon (:)
[4598:0509/220233.220295:ERROR:bus.cc(395)] Failed to connect to the bus: Address does not contain a colon
GET /__/ 200 217.315 ms - -

…r xvfb

bahmutov · 2019-05-13T16:44:12Z

cli/__snapshots__/errors_spec.js

@@ -16,18 +27,54 @@ Cypress Version: 1.2.3
 `

 exports['errors individual has the following errors 1'] = [


the names of the errors are now sorted before snapshotting

bahmutov · 2019-05-13T16:47:03Z

cli/lib/errors.js

@@ -102,6 +108,39 @@ const smokeTestFailure = (smokeTestCommand, timedOut) => {
  }
 }

+const invalidDisplayError = {


a complex error that has both the display error and the follow-up error

bahmutov · 2019-05-13T16:47:18Z

cli/lib/errors.js

-  solution: '',
+  solution: stripIndent`
+    See discussion and possible solutions at
+    ${chalk.blue(util.getGitHubIssueUrl(1281))}


at least give the relevant issue url

bahmutov · 2019-05-13T16:48:10Z

cli/lib/errors.js

+    // assuming that if there the solution is a function it will handle
+    // error message and (optional previous error message)
+    if (is.fn(obj.solution)) {
+      const text = obj.solution(msg, prevMessage)


if error solution property is a function, let it form the full error text

bahmutov · 2019-05-13T16:49:45Z

cli/lib/exec/spawn.js

+        if (os.platform() === 'linux' && process.env.DISPLAY) {
+          // make sure we use the latest DISPLAY variable if any
+          debug('passing DISPLAY', process.env.DISPLAY)
+          options.env.DISPLAY = process.env.DISPLAY


otherwise a new value from XVFB will not take effect

bahmutov · 2019-05-13T16:50:03Z

cli/lib/exec/spawn.js

-          // else pass it along!
-          process.stderr.write(data)
-        })
+        child.stderr &&


just a little bit of reformatting

bahmutov · 2019-05-13T16:51:09Z

cli/lib/exec/spawn.js

    }

-    return userFriendlySpawn()
-
+    return userFriendlySpawn(os.platform() === 'linux')


if we are on Linux, and there is a display problem, we should attempt handling it once

bahmutov · 2019-05-13T16:52:34Z

cli/lib/tasks/verify.js

  return spawn()
+  .catch({ displayError: true, platform: 'linux' }, (e) => {


handle display error once

bahmutov · 2019-05-13T16:53:08Z

cli/test/lib/errors_spec.js

+        solution: 42,
+      }
+
+      return expect(formErrorText(error)).to.be.rejected


chai-as-promised is nice

bahmutov · 2019-05-13T16:54:03Z

package.json

@@ -33,6 +33,7 @@
    "clean-deps": "npm run all clean-deps && rm -rf node_modules",
    "docker": "./scripts/run-docker-local.sh",
    "lint-js": "eslint --fix scripts/*.js packages/ts/*.js cli/*.js cli/**/*.js",
+    "lint-changed": "git diff --name-only | grep '\\.js$' | xargs npx eslint --fix",


little utility to fix all changes JS files before committing

bahmutov · 2019-05-13T16:54:28Z

packages/electron/lib/electron.coffee

@@ -72,6 +72,10 @@ module.exports = {

      debug("spawning %s with args", execPath, argv)

+      if debug.enabled
+        # let's see everything Electron spits back
+        argv.push("--enable-logging")


when running with DEBUG=cypress:electron it would be nice to see everything

bahmutov · 2019-05-13T16:55:48Z

packages/server/lib/cypress.coffee

          fn = (code) ->
            ## juggle up the totalFailed since our outer
            ## promise is expecting this object structure
            debug("electron finished with", code)
-            resolve({totalFailed: code})
-          cypressElectron.open(".", require("./util/args").toArray(options), fn)
+            electronFinished = Number(new Date())


detect display or missing dependency problem by noticing how quickly Electron exits. If we suspect display or missing dependency problem then return a special exit code

kuceb · 2019-05-13T17:34:12Z

cli/__snapshots__/errors_spec.js

+Cypress failed to start.
+
+First, we have tried to start Cypress using your DISPLAY settings
+but his the following problem:


fixed typo

kuceb · 2019-05-13T19:33:13Z

Did the same driver-integration test just fail twice?

bahmutov · 2019-05-13T19:59:26Z

did it?

1) src/cy/commands/actions/type #type value changing [contenteditable] can type into an iframe with designmode = 'on':
     CypressError: Timed out retrying: expected false to equal true

bahmutov added 5 commits May 8, 2019 20:00

cli: debug explanation for XVFB

142a830

linting

ff9e26e

add chai-as-promised to CLI dev

5a9f586

show Linux specific error solution if cannot verify

6bb8e1d

add todo

8b329d0

bahmutov requested a review from brian-mann May 9, 2019 01:26

bahmutov added 3 commits May 9, 2019 09:43

chore: consolidate github issue url logic

51d5389

linting

a7a74a7

add npm script lint-changed to quickly eslint fix changes JS files

8d0d9fc

bahmutov requested a review from kuceb May 9, 2019 14:48

bahmutov commented May 9, 2019

View reviewed changes

bahmutov changed the title ~~Console error with more clarity about Linux DISPLAY variable~~ WIP: Console error with more clarity about Linux DISPLAY variable May 9, 2019

bahmutov added 3 commits May 9, 2019 15:25

retry verify with our XVFB

7747152

update errors and tests

04b5891

update CLI tests

4ad307c

bahmutov commented May 9, 2019

View reviewed changes

bahmutov added 5 commits May 9, 2019 16:19

add test for display error message

8c2c367

fix unit test

fa00621

add successful test with retry

66a2d83

finish verify retry test

2b50102

warn users if hit display problem on first verify

cc9c06b

bahmutov added 3 commits May 10, 2019 17:27

try to detect display problem when running electron and retry with ou…

afacdc1

…r xvfb

add warning message to spawn when attempting xvfb re-run

859c1bf

add test for display retry behavior on spawn

4aa038b

bahmutov changed the title ~~WIP: Console error with more clarity about Linux DISPLAY variable~~ Automatically retry verify and run commands on Linux if suspect DISPLAY problem May 13, 2019

bahmutov commented May 13, 2019

View reviewed changes

cli/test/lib/errors_spec.js

solution: 42,

}

return expect(formErrorText(error)).to.be.rejected

Copy link

Contributor Author

bahmutov May 13, 2019

Choose a reason for hiding this comment

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

chai-as-promised is nice

bahmutov commented May 13, 2019

View reviewed changes

more comments for clarity

8850c04

kuceb previously requested changes May 13, 2019

View reviewed changes

fix typo

080d3b2

bahmutov requested a review from kuceb May 13, 2019 18:00

Merge branch 'develop' into more-clarity-about-linux-display-4034

ac5915d

kuceb approved these changes May 13, 2019

View reviewed changes

bahmutov merged commit d25cfac into develop May 13, 2019

cypress-bot bot mentioned this pull request May 13, 2019

Presence of DISPLAY env var causes "Cypress failed to start" #4034

Closed

flotwig mentioned this pull request Jul 9, 2019

Console info/warnings in STDOUT about config.browsers and react #4255

Closed

emilyrohrbough deleted the more-clarity-about-linux-display-4034 branch August 1, 2024 13:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically retry verify and run commands on Linux if suspect DISPLAY problem #4165

Automatically retry verify and run commands on Linux if suspect DISPLAY problem #4165

bahmutov commented May 9, 2019 •

edited

Loading

bahmutov May 9, 2019

bahmutov commented May 9, 2019

bahmutov commented May 9, 2019

bahmutov commented May 9, 2019 •

edited

Loading

bahmutov May 9, 2019

bahmutov commented May 9, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

bahmutov May 13, 2019

kuceb May 13, 2019

kuceb commented May 13, 2019

bahmutov commented May 13, 2019

		@@ -16,18 +27,54 @@ Cypress Version: 1.2.3
		`

		exports['errors individual has the following errors 1'] = [

		return spawn()
		.catch({ displayError: true, platform: 'linux' }, (e) => {

Automatically retry verify and run commands on Linux if suspect DISPLAY problem #4165

Automatically retry verify and run commands on Linux if suspect DISPLAY problem #4165

Conversation

bahmutov commented May 9, 2019 • edited Loading

Choose a reason for hiding this comment

bahmutov commented May 9, 2019

bahmutov commented May 9, 2019

bahmutov commented May 9, 2019 • edited Loading

Choose a reason for hiding this comment

bahmutov commented May 9, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kuceb commented May 13, 2019

bahmutov commented May 13, 2019

bahmutov commented May 9, 2019 •

edited

Loading

bahmutov commented May 9, 2019 •

edited

Loading