Better handle reserved key CYPRESS_ENV being set by users to valid values

[jennifer-shehane]

• Closes Warn when using reserved key CYPRESS_ENV with non production value #6436

User facing changelog

• We now warn when setting the reserved key CYPRESS_INTERNAL_ENV to a non-production value.

Additional details

• I've renamed the CYPRESS_ENV variable to CYPRESS_INTERNAL_ENV. The use of this keyword is not frequent, but the consequences of accidentally setting it are complete blocker for users trying to record and it a real headache to debug from within support.
• We were previously only erroring and exiting on invalid values, but a user could pass valid, non-production values that would result in unexpected consequences. We now warn in this situation so they would at least get some indication that they did something wrong.
• The check for 'non-production' values includes a check for undefined which will set our default and I don't suspect anyone would set 'undefined' anyway.

See https://github.com/cypress-io/cypress-services/issues/2194

How has the user experience changed?

Before: Can't find projectID

The most optimistic error is that it can't find the projectId (because the project doesn't exist in staging) - this results in a string of emails to support because their project definitely exists!

$ CYPRESS_ENV=staging cypress run --record --key abc123
We could not find a project with the ID: f0paa2

This projectId came from your 'cypress.json' file or an environment variable.

Please log into the Dashboard and find your project.

We will list the correct projectId in the 'Settings' tab.

Alternatively, you can create a new project using the Desktop Application.

https://on.cypress.io/dashboard

Before: recording to staging db 😬

If their project is found, it could just record to staging - this results in a string of emails to support because they see it recording but do not see the recordings in their Dashboard!

$ CYPRESS_ENV=staging cypress run --record --key abc123

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

  (Run Starting)

  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
  │ Cypress:    3.8.3                                                                              │
  │ Browser:    Electron 78 (headless)                                                             │
  │ Specs:      1 found (api_spec.js)  
  │ Params:     Tag: false, Group: false, Parallel: false                                          │
  │ Run URL:    https://dashboard-staging.cypress.io/projects/123456/runs/3777                     │
  └────────────────────────────────────────────────────────────────────────────────────────────────┘

After:

The CYPRESS_ENV is now `CYPRESS_INTERNAL_ENV, which is less likely to be set by users for their own use.

After: Warning when setting to not production or undefined

$ CYPRESS_INTERNAL_ENV=staging cypress run --record --key abc123

⚠ Warning: It looks like you're passing CYPRESS_INTERNAL_ENV=staging

The environment variable "CYPRESS_INTERNAL_ENV" is reserved and should only be used internally.

Unset the "CYPRESS_INTERNAL_ENV" environment variable and run Cypress again.

PR Tasks

• Have tests been added/updated?
• Has the original issue been tagged with a release in ZenHub?
• Has a PR for user-facing changes been opened in cypress-documentation? Add note about reserved CYPRESS_INTERNAL_ENV env var cypress-documentation#2587
• [NA] Have API changes been updated in the type definitions?
• [NA] Have new configuration options been added to the cypress.schema.json?

[cypress-bot]

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.

[cypress]

---

Test summary

6966 • 0 • 97 • 0

---

Run details

Project	cypress
Status	Passed
Commit	e96ab04
Started	Mar 6, 2020 9:09 AM
Ended	Mar 6, 2020 9:15 AM
Duration	05:38 💡
OS	Linux Debian - 10.0
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

[bahmutov]

just to avoid repetition

const {CYPRESS_INTERNAL_ENV} = process.env

[bahmutov]

nice, will avoid the unnecessary confusion