@revoloo/cypress6/packages/server/lib/util/node_options.ts

Cypress.io end to end testing tool

import cp from 'child_process'
import debugModule from 'debug'

const debug = debugModule('cypress:server:util:node_options')

export const NODE_OPTIONS = `--max-http-header-size=${1024 ** 2}`

/**
 * If Cypress was not launched via CLI, it may be missing certain startup
 * options. This checks that those startup options were applied.
 *
 * @returns {boolean} does Cypress have the expected NODE_OPTIONS?
 */
export function needsOptions (): boolean {
  if ((process.env.NODE_OPTIONS || '').includes(NODE_OPTIONS)) {
    debug('NODE_OPTIONS check passed, not forking %o', { NODE_OPTIONS: process.env.NODE_OPTIONS })

    return false
  }

  if (typeof require.main === 'undefined') {
    debug('require.main is undefined, this should not happen normally, not forking')

    return false
  }

  return true
}

/**
 * Retrieve the current inspect flag, if the process was launched with one.
 */
function getCurrentInspectFlag (): string | undefined {
  const flag = process.execArgv.find((v) => v.startsWith('--inspect'))

  return flag ? flag.split('=')[0] : undefined
}

/**
 * Fork the current process using the good NODE_OPTIONS and pipe stdio
 * through the current process. On exit, copy the error code too.
 */
export function forkWithCorrectOptions (): void {
  // this should only happen when running from global mode, when the CLI couldn't set the NODE_OPTIONS
  process.env.ORIGINAL_NODE_OPTIONS = process.env.NODE_OPTIONS || ''
  process.env.NODE_OPTIONS = `${NODE_OPTIONS} ${process.env.ORIGINAL_NODE_OPTIONS}`

  debug('NODE_OPTIONS check failed, forking %o', {
    NODE_OPTIONS: process.env.NODE_OPTIONS,
    ORIGINAL_NODE_OPTIONS: process.env.ORIGINAL_NODE_OPTIONS,
  })

  const launchArgs = process.argv.slice(1)
  const inspectFlag = getCurrentInspectFlag()

  if (inspectFlag) {
    launchArgs.unshift(`${inspectFlag}=${process.debugPort + 1}`)
  }

  cp.spawn(
    process.execPath,
    launchArgs,
    { stdio: 'inherit' },
  )
  .on('error', () => {})
  .on('exit', (code, signal) => {
    debug('child exited %o', { code, signal })
    process.exit(code === null ? 1 : code)
  })
}

/**
 * Once the Electron process is launched, restore the user's original NODE_OPTIONS
 * environment variables from before the CLI added extra NODE_OPTIONS.
 *
 * This way, any `node` processes launched by Cypress will retain the user's
 * `NODE_OPTIONS` without unexpected modificiations that could cause issues with
 * user code.
 */
export function restoreOriginalOptions (): void {
  // @ts-ignore
  if (!process.versions || !process.versions.electron) {
    debug('not restoring NODE_OPTIONS since not yet in Electron')

    return
  }

  debug('restoring NODE_OPTIONS %o', {
    NODE_OPTIONS: process.env.NODE_OPTIONS,
    ORIGINAL_NODE_OPTIONS: process.env.ORIGINAL_NODE_OPTIONS,
  })

  process.env.NODE_OPTIONS = process.env.ORIGINAL_NODE_OPTIONS || ''
}