chore: connecting to electron browser (#26471)

cypress-io · Apr 13, 2023 · 66bd182 · 66bd182
1 parent 9c5fffb
commit 66bd182
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 8 deletions.
diff --git a/packages/server/lib/browsers/cdp_automation.ts b/packages/server/lib/browsers/cdp_automation.ts
@@ -9,7 +9,7 @@ import debugModule from 'debug'
 import { URL } from 'url'
 
 import type { ResourceType, BrowserPreRequest, BrowserResponseReceived } from '@packages/proxy'
-import type { WriteVideoFrame } from '@packages/types'
+import type { CDPClient, WriteVideoFrame } from '@packages/types'
 import type { Automation } from '../automation'
 import { cookieMatches, CyCookie, CyCookieFilter } from '../automation/util'
 
@@ -154,10 +154,16 @@ const ffToStandardResourceTypeMap: { [ff: string]: ResourceType } = {
   'webmanifest': 'manifest',
 }
 
-export class CdpAutomation {
+export class CdpAutomation implements CDPClient {
+  on: OnFn
+  send: SendDebuggerCommand
+
   private constructor (private sendDebuggerCommandFn: SendDebuggerCommand, private onFn: OnFn, private sendCloseCommandFn: SendCloseCommand, private automation: Automation) {
     onFn('Network.requestWillBeSent', this.onNetworkRequestWillBeSent)
     onFn('Network.responseReceived', this.onResponseReceived)
+
+    this.on = onFn
+    this.send = sendDebuggerCommandFn
   }
 
   async startVideoRecording (writeVideoFrame: WriteVideoFrame, screencastOpts) {

diff --git a/packages/server/lib/browsers/electron.ts b/packages/server/lib/browsers/electron.ts
@@ -11,7 +11,7 @@ import * as errors from '../errors'
 import type { Browser, BrowserInstance } from './types'
 import type { BrowserWindow, WebContents } from 'electron'
 import type { Automation } from '../automation'
-import type { BrowserLaunchOpts, Preferences, RunModeVideoApi } from '@packages/types'
+import type { BrowserLaunchOpts, Preferences, ProtocolManager, RunModeVideoApi } from '@packages/types'
 import memory from './memory'
 
 // TODO: unmix these two types
@@ -202,9 +202,7 @@ export = {
       win.maximize()
     }
 
-    const launched = await this._launch(win, url, automation, preferences, options.videoApi)
-
-    automation.use(await _getAutomation(win, preferences, automation))
+    const launched = await this._launch(win, url, automation, preferences, options.videoApi, options.protocolManager)
 
     return launched
   },
@@ -235,7 +233,7 @@ export = {
     return this._launch(win, url, automation, electronOptions)
   },
 
-  async _launch (win: BrowserWindow, url: string, automation: Automation, options: ElectronOpts, videoApi?: RunModeVideoApi) {
+  async _launch (win: BrowserWindow, url: string, automation: Automation, options: ElectronOpts, videoApi?: RunModeVideoApi, protocolManager?: ProtocolManager) {
     if (options.show) {
       menu.set({ withInternalDevTools: true })
     }
@@ -283,6 +281,7 @@ export = {
     automation.use(cdpAutomation)
 
     await Promise.all([
+      protocolManager?.connectToBrowser(cdpAutomation),
       videoApi && recordVideo(cdpAutomation, videoApi),
       this._handleDownloads(win, options.downloadsFolder, automation),
     ])

diff --git a/packages/types/src/protocol.ts b/packages/types/src/protocol.ts
@@ -6,7 +6,7 @@ type Command<T extends keyof Commands> = Commands[T]
 type Events = ProtocolMapping.Events
 type Event<T extends keyof Events> = Events[T]
 
-interface CDPClient {
+export interface CDPClient {
   send<T extends Extract<keyof Commands, string>> (command: T, params?: Command<T>['paramsType'][0]): Promise<Command<T>['returnType']>
   on<T extends Extract<keyof Events, string>> (eventName: T, cb: (event: Event<T>[0]) => void): void
 }