fix: Long Cypress verification times (#21174)

* Fixing some electron

* More electron refs

* Updating system test snapshots. Updating mocha timeout for module-api tests.

* Updating magic require with comment

* Updating system test snapshot again

* Removing dead code

Author: tbiethman

packages/server/lib/cypress.js

@@ -1,5 +1,14 @@
 require('./environment')
 
+// We require project-base here, as waiting to require it in
+// the Electron process for the first time can cause the process
+// to hang during smoke test execution. This occurs with Electron
+// version v15.4.0 and after.
+//
+// TODO: Investigate need/removal of this with future major versions
+// of Electron when upgraded: https://github.com/cypress-io/cypress/pull/19090
+require('@packages/server/lib/project-base')
+
 // we are not requiring everything up front
 // to optimize how quickly electron boots while
 // in dev or linux production. the reasoning is
@@ -114,12 +123,6 @@ module.exports = {
     })
   },
 
-  openProject (options) {
-    // this code actually starts a project
-    // and is spawned from nodemon
-    require('../lib/open_project').open(options.project, options)
-  },
-
   start (argv = []) {
     debug('starting cypress with argv %o', argv)
 

packages/server/lib/gui/auth.ts

@@ -4,7 +4,6 @@ const express = require('express')
 const os = require('os')
 const pkg = require('@packages/root')
 const Promise = require('bluebird')
-const { shell } = require('electron')
 const url = require('url')
 
 const machineId = require('../util/machine_id')
@@ -164,7 +163,7 @@ const launchNativeAuth = Promise.method((loginUrl, sendMessage) => {
 
   openExternalAttempted = true
 
-  return shell.openExternal(loginUrl)
+  return require('electron').shell.openExternal(loginUrl)
   .catch((err) => {
     debug('Error launching native auth: %o', { err })
     warnCouldNotLaunch()

packages/server/lib/gui/links.ts

@@ -1,5 +1,4 @@
 import _ from 'lodash'
-import { shell } from 'electron'
 import { URL, URLSearchParams } from 'url'
 
 // NOTE: in order for query params to be passed through on links
@@ -12,7 +11,7 @@ interface OpenExternalOptions {
 
 export const openExternal = (opts: OpenExternalOptions | string) => {
   if (_.isString(opts)) {
-    return shell.openExternal(opts)
+    return require('electron').shell.openExternal(opts)
   }
 
   const url = new URL(opts.url)
@@ -26,5 +25,5 @@ export const openExternal = (opts: OpenExternalOptions | string) => {
     url.search = new URLSearchParams(opts.params).toString()
   }
 
-  return shell.openExternal(url.href)
+  return require('electron').shell.openExternal(url.href)
 }

packages/server/lib/makeDataContext.ts

@@ -1,5 +1,5 @@
 import { DataContext, getCtx, clearCtx, setCtx } from '@packages/data-context'
-import electron, { OpenDialogOptions, SaveDialogOptions, BrowserWindow } from 'electron'
+import type { OpenDialogOptions, SaveDialogOptions, BrowserWindow } from 'electron'
 import pkg from '@packages/root'
 import * as configUtils from '@packages/config'
 import { isListening } from './util/ensure-url'
@@ -160,16 +160,16 @@ export function makeDataContext (options: MakeDataContextOptions): DataContext {
         })
       },
       showItemInFolder (folder: string) {
-        electron.shell.showItemInFolder(folder)
+        require('electron').shell.showItemInFolder(folder)
       },
       showOpenDialog (props: OpenDialogOptions) {
-        return electron.dialog.showOpenDialog(props)
+        return require('electron').dialog.showOpenDialog(props)
       },
       showSaveDialog (window: BrowserWindow, props: SaveDialogOptions) {
-        return electron.dialog.showSaveDialog(window, props)
+        return require('electron').dialog.showSaveDialog(window, props)
       },
       copyTextToClipboard (text: string) {
-        electron.clipboard.writeText(text)
+        require('electron').clipboard.writeText(text)
       },
     },
     localSettingsApi: {

system-tests/__snapshots__/reporters_spec.js

@@ -12,9 +12,6 @@ Error: Cannot find module '/foo/bar/.projects/e2e/node_modules/module-does-not-e
 Require stack:
 - lib/reporter.js
 - lib/project-base.ts
-- lib/open_project.ts
-- lib/makeDataContext.ts
-- lib/modes/index.ts
 - lib/cypress.js
 - index.js
 - 

system-tests/projects/module-api/package.json

@@ -5,7 +5,7 @@
   "private": true,
   "main": "index.js",
   "scripts": {
-    "test": "mocha --timeout 30000 test/spec.js"
+    "test": "mocha --timeout 45000 test/spec.js"
   },
   "devDependencies": {
     "@bahmutov/all-paths": "1.0.2",