fix: use util.getEnv to handle environment variables set with npm

[legap]

• Closes CYPRESS_VERIFY_TIMEOUT ignored when passed via .npmrc #19559

User facing changelog

• CYPRESS_VERIFY_TIMEOUT can also be set in package.json and .npmrc (depending on os)

Additional details

This change allows the CYPRESS_VERIFY_TIMEOUT environment variable to be set via .npmrc file or as config in package.json. The test cases were also updated to verify this case.

How has the user experience changed?

Users can set CYPRESS_VERIFY_TIMEOUT the same way as the other environment variables (config in package.json and .npmrc with some restrictions).

PR Tasks

• Have tests been added/updated?
• Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
• [n/a] Has a PR for user-facing changes been opened in cypress-documentation?
• [n/a] Have API changes been updated in the type definitions?
• [n/a] Have new configuration options been added to the cypress.schema.json?

[cypress-bot]

Thanks for taking the time to open a PR!

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
• Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

[emilyrohrbough]

Testing this locally, I'm noticing the capitalization makes a difference on the resolved value when testing with a simple dummy script.

"scripts": {
   "try": "node ./try.js"
}

// try.js
const util = require('./cli/lib/util')

console.log(process.env)
console.log(' process.env -.CYPRESS_VERIFY_TIMEOUT', process.env.CYPRESS_VERIFY_TIMEOUT)
console.log('process.env.cypress_verify_timeout -', process.env.cypress_verify_timeout)
console.log('util.getEnv('CYPRESS_VERIFY_TIMEOUT') - ', util.getEnv('CYPRESS_VERIFY_TIMEOUT'))
console.log('util.getEnv('cypress_verify_timeout') -', util.getEnv('cypress_verify_timeout'))

.npmrc

CYPRESS_VERIFY_TIMEOUT=yes

Terminal

> CYPRESS_VERIFY_TIMEOUT='no' npm run try
process.env - {
   ...
  npm_config_cypress_verify_timeout: 'yes',
  CYPRESS_VERIFY_TIMEOUT: 'no',
  ...
}
process.env.CYPRESS_VERIFY_TIMEOUT - no
process.env.cypress_verify_timeout - undefined
util.getEnv('CYPRESS_VERIFY_TIMEOUT') -  no
util.getEnv('cypress_verify_timeout') - yes

[legap]

Thanks for the review and the testing @emilyrohrbough.

I had to dig a little deeper to understand how npm handles environment variables. The results are available in this README in a small test project.

As a conclusion we can see, that npm itself handles the key of an environment variable different, depending on the operating system (I didn't have an OSX available but I would guess it behaves the same as linux).

I also looked up all calls to the getEnv method in the cypress codebase and had a look at the tests in util_spec.js and they are always with uppercase keys.

So in my opinion getEnv should work on all operating systems when using the key in uppercase and the benefit would be that we can also use the definition for CYPRESS_VERIFY_TIMEOUT in package.json or .npmrc.

The only exception is setting the variable in .npmrc where the result will vary depending on the operating system. But I guess this should be addressed with another issue for the getEnv method.

[emilyrohrbough]

@legap WOW! You led a very thorough investigation into these differences. I truly appreciate it & this is great information.

You conclusions regarding Mac OS seems correct (I have a Mac). With your findings it appears this accomplishes the intent of how CYPRESS_VERIFY_TIMEOUT will be used and accessed for this timeout.