fix: avoid ANSI character output when running the binary smoke test f…

[AtofStryker]

…or eecution environments that set FORCE_COLOR [run ci]

• Closes "Cypress verification failed" after upgrading to 13.6.5 with use of NX #28982

Additional details

Fixes an issue with env pollution inside the cypress verify step of the binary. After the electron update, something under the hood changed with how environment variables are hydrated into the process where not all options before were being respected inside the process. In particular, this causes issues with the FORCE_COLOR option that can live inside the node process. Previously, FORCE_COLOR on the previous version of electron was not respected inside the execa process, but now it is. This causes the ping number to be colored yellow via our error templating, causing an unexpected mismatch on the lines contained in the verify check. This is only an issue if FORCE_COLOR is set inside the process, which happens to be the case for nx users. Here is a sample diff of the process.env differences between invoking cypress via the nx plugin vs invoking cypress directly.

// nx process.env (from cypress-test-tiny)
{
  env: {
    NX_CLI_SET: 'true',
    NX_LOAD_DOT_ENV_FILES: 'true',
    NX_TASK_TARGET_TARGET: 'e2e',
    npm_config_inspect_brk: 'true',
    NX_TASK_HASH: '18267722001484630910',
    NX_TASK_TARGET_PROJECT: 'cypress-test-tiny',
    NX_WORKSPACE_ROOT: '/Users/$NAME/cypress-test-tiny',
    npm_command: 'run-script',
    FORCE_COLOR: 'true',
    npm_lifecycle_script: 'nx e2e',
    LERNA_PACKAGE_NAME: 'cypress-test-tiny',
  }
}

// cypress process.env (from cypress-test-tiny)
{
  env: {
    npm_command: 'exec',
    npm_lifecycle_script: 'cypress',
  }
}

Since the verify job does not need knowledge of ANSI coloring and we mainly want to make sure the verify passes, we are opting to set FORCE_COLOR to 0 in order for the verify messaging to pass and make the logic less dependent on user environments

Steps to test

Likely the best way to test is setting up cypress-test-tiny and installing the prebuild binary mentioned in this commit. once installed, run yarn nx init and install @nx/cypress. Then install via yarn and execute yarn cypress:run. The binary verification should pass.

I have also added a unit test to verify FORCE_COLOR is off. We could add a system test that leverages a binary test against an nx project, but the time to set that up locally is a bit tedious at the moment and think we get the coverage we need from this plus some of our internal repos.

How has the user experience changed?

PR Tasks

• Have tests been added/updated?
• Has a PR for user-facing changes been opened in cypress-documentation?
• Have API changes been updated in the type definitions?

[AtofStryker]

the other OS platforms are marked failing because I cancelled them to conserve resources as we know they built fine from previous runs

[cypress-bot]

Released in 13.6.6.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v13.6.6, please open a new issue.