[WIP] Detect if NODE_OPTIONS are present in binary; if not, respawn

[flotwig]

• Closes

User facing changelog

N/A

Additional details

• Contains changes from these reverted/canceled PRs:
  • Always pass NODE_OPTIONS with max-http-header-size #5452
  • [WIP] Detect if NODE_OPTIONS are present in binary; if not, respawn #5492
• Reverts workaround from Use websockets to stub large XHR response bodies instead of headers #5525
• Ensures that the unreleased changes from Always pass NODE_OPTIONS with max-http-header-size #5452 also apply in global mode
• Figure out why original NODE_OPTIONS not properly restored when launched via CLI
• Try also adding --no-sandbox at boot time
  • Won't work - I tried creating a simple JS file that just console.logs, and doing electron test.js, and it doesn't even get to the console.log before erroring about --no-sandbox.
  • So this HAS to be set in CLI.
  • This is probably fine - very few, if any, users will be using the global mode as root, and those that are will be able to figure it out from the Chromium error message.

How has the user experience changed?

N/A

PR Tasks

• Have tests been added/updated?

[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.

[brian-mann]

I would separate out the methods that return whether the fork is needed from the fork itself - and reverse the if condition to only do that when the fork is necessary (since that's the rare, minority case).

As it's written - the logic implies the opposite (that this is the majority). I would also separate out the mutation and make the check pure and idempotent.

// if our parent process was launched without the correct
// NODE_OPTIONS environment variable then fork a new child
// process with the fixed options
if (nodeOptions.needsFork()) {
  return nodeOptions.forkWithCorrectOptions()
}

// otherwise preserve the original options
nodeOptions.preserveOriginalOptions()

module.exports = require('./lib/cypress').start(process.argv)

[flotwig]

It's reversed because we can't return here since it's not a function, so for Cypress not to start, it needs to be in some kind of control structure. I can make it an if/else, but I think those are frowned upon in this project, so I'll just make a launch function.

[flotwig]

This is now blocked, there appears to be no way to set --max-http-header-size in Electron, I've opened an issue on their repo to raise awareness/ask for guidance: electron/electron#20831

[flotwig]

Going to work around this in #5525 for now.