feat: Add support for optional env key to browser launch options (#23624

) Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com>
cypress-io · Sep 22, 2022 · acc1050 · acc1050 · cypress-bot · Sep 22, 2022
1 parent 90729e7
commit acc1050
Show file tree

Hide file tree

Showing 13 changed files with 208 additions and 72 deletions.
diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -5495,6 +5495,7 @@ declare namespace Cypress {
     extensions: string[]
     preferences: { [key: string]: any }
     args: string[]
+    env: { [key: string]: any }
   }
 
   interface Dimensions {

diff --git a/cli/types/tests/plugins-config.ts b/cli/types/tests/plugins-config.ts
@@ -19,6 +19,7 @@ const pluginConfig2: Cypress.PluginConfig = (on, config) => {
     browser.displayName // $ExpectType string
     options.extensions // $ExpectType string[]
     options.args // $ExpectType string[]
+    options.env // $ExpectType { [key: string]: any; }
 
     console.log('launching browser', browser.displayName)
     return options

diff --git a/...ONFIG_VALIDATION_ERROR - pluginsFile.html → ...__/BROWSER_UNSUPPORTED_LAUNCH_OPTION.html b/...ONFIG_VALIDATION_ERROR - pluginsFile.html → ...__/BROWSER_UNSUPPORTED_LAUNCH_OPTION.html
diff --git a/packages/errors/src/errors.ts b/packages/errors/src/errors.ts
@@ -90,6 +90,12 @@ export const AllCypressErrors = {
 
         This option will not have an effect in ${fmt.off(_.capitalize(browser))}. Tests that rely on web security being disabled will not run as expected.`
   },
+  BROWSER_UNSUPPORTED_LAUNCH_OPTION: (browser: string, options: string[]) => {
+    return errTemplate`\
+        Warning: The following browser launch options were provided but are not supported by ${fmt.highlightSecondary(browser)}
+
+        ${fmt.listItems(options)}`
+  },
   BROWSER_NOT_FOUND_BY_NAME: (browser: string, foundBrowsersStr: string[]) => {
     let canarySuffix: PartialErr | null = null
 

diff --git a/packages/errors/test/unit/visualSnapshotErrors_spec.ts b/packages/errors/test/unit/visualSnapshotErrors_spec.ts
@@ -1206,5 +1206,11 @@ describe('visual error templates', () => {
         default: [],
       }
     },
+
+    BROWSER_UNSUPPORTED_LAUNCH_OPTION: () => {
+      return {
+        default: ['electron', ['env']],
+      }
+    },
   })
 })
diff --git a/packages/launcher/lib/browsers.ts b/packages/launcher/lib/browsers.ts
@@ -165,7 +165,7 @@ export function launch (
   url: string,
   debuggingPort: number,
   args: string[] = [],
-  defaultBrowserEnv = {},
+  browserEnv = {},
 ) {
   debug('launching browser %o', { browser, url })
 
@@ -181,7 +181,9 @@ export function launch (
 
   // allow setting default env vars such as MOZ_HEADLESS_WIDTH
   // but only if it's not already set by the environment
-  const env = Object.assign({}, defaultBrowserEnv, process.env)
+  const env = Object.assign({}, browserEnv, process.env)
+
+  debug('spawning browser with environment %o', { env })
 
   const proc = cp.spawn(browser.path, args, { stdio: ['ignore', 'pipe', 'pipe'], env })
 

diff --git a/packages/server/lib/browsers/chrome.ts b/packages/server/lib/browsers/chrome.ts
@@ -651,7 +651,7 @@ export = {
     // first allows us to connect the remote interface,
     // start video recording and then
     // we will load the actual page
-    const launchedBrowser = await launch(browser, 'about:blank', port, args) as unknown as BrowserInstance & { browserCriClient: BrowserCriClient}
+    const launchedBrowser = await launch(browser, 'about:blank', port, args, launchOptions.env) as unknown as BrowserInstance & { browserCriClient: BrowserCriClient}
 
     la(launchedBrowser, 'did not get launched browser instance')
 

diff --git a/packages/server/lib/browsers/electron.ts b/packages/server/lib/browsers/electron.ts
@@ -465,6 +465,18 @@ export = {
     throw new Error('Attempting to connect to existing browser for Cypress in Cypress which is not yet implemented for electron')
   },
 
+  validateLaunchOptions (launchOptions: typeof utils.defaultLaunchOptions) {
+    const options: string[] = []
+
+    if (Object.keys(launchOptions.env).length > 0) options.push('env')
+
+    if (launchOptions.args.length > 0) options.push('args')
+
+    if (options.length > 0) {
+      errors.warning('BROWSER_UNSUPPORTED_LAUNCH_OPTION', 'electron', options)
+    }
+  },
+
   async open (browser: Browser, url: string, options: BrowserLaunchOpts, automation: Automation) {
     debug('open %o', { browser, url })
 
@@ -486,6 +498,8 @@ export = {
 
     const launchOptions = await utils.executeBeforeBrowserLaunch(browser, defaultLaunchOptions, electronOptions)
 
+    this.validateLaunchOptions(launchOptions)
+
     const { preferences } = launchOptions
 
     debug('launching browser window to url: %s', url)

diff --git a/packages/server/lib/browsers/firefox.ts b/packages/server/lib/browsers/firefox.ts
@@ -536,6 +536,7 @@ export async function open (browser: Browser, url: string, options: BrowserLaunc
     // user can overwrite this default with these env vars or --height, --width arguments
     MOZ_HEADLESS_WIDTH: '1280',
     MOZ_HEADLESS_HEIGHT: '721',
+    ...launchOptions.env,
   })
 
   try {

diff --git a/packages/server/lib/browsers/utils.ts b/packages/server/lib/browsers/utils.ts
@@ -46,10 +46,12 @@ const defaultLaunchOptions: {
   preferences: {[key: string]: any}
   extensions: string[]
   args: string[]
+  env: {[key: string]: any}
 } = {
   preferences: {},
   extensions: [],
   args: [],
+  env: {},
 }
 
 const KNOWN_LAUNCH_OPTION_PROPERTIES = _.keys(defaultLaunchOptions)

diff --git a/packages/server/lib/browsers/webkit.ts b/packages/server/lib/browsers/webkit.ts
@@ -70,6 +70,7 @@ export async function open (browser: Browser, url: string, options: BrowserLaunc
     },
     extensions: [],
     args: [],
+    env: {},
   }
 
   const launchOptions = await utils.executeBeforeBrowserLaunch(browser, defaultLaunchOptions, options)