detect playwright-webkit browser

cypress-io · Mar 16, 2021 · de8e6c3 · vitmalina · Mar 23, 2021 · flotwig
1 parent ed4bf54
commit de8e6c3
Show file tree

Hide file tree

Showing 5 changed files with 419 additions and 9 deletions.
diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -32,11 +32,11 @@ declare namespace Cypress {
     (task: 'net', eventName: string, frame: any): Promise<void>
   }
 
-  type BrowserName = 'electron' | 'chrome' | 'chromium' | 'firefox' | 'edge' | string
+  type BrowserName = 'electron' | 'chrome' | 'chromium' | 'firefox' | 'edge' | 'webkit' | string
 
   type BrowserChannel = 'stable' | 'canary' | 'beta' | 'dev' | 'nightly' | string
 
-  type BrowserFamily = 'chromium' | 'firefox'
+  type BrowserFamily = 'chromium' | 'firefox' | 'webkit'
 
   /**
    * Describes a browser Cypress can control

diff --git a/packages/launcher/lib/browsers.ts b/packages/launcher/lib/browsers.ts
@@ -90,6 +90,16 @@ export const browsers: Browser[] = [
     versionRegex: /Microsoft Edge Dev (\S+)/m,
     binary: ['edge-dev', 'microsoft-edge-dev'],
   },
+  {
+    name: 'webkit',
+    family: 'webkit',
+    channel: 'dev',
+    displayName: 'WebKit',
+    // WebKitGTK 2.31.1 (r272495)
+    versionRegex: /WebKitGTK (\S+)/m,
+    module: 'playwright-webkit',
+    getBinaryPath: (pw) => pw.webkit.executablePath(),
+  },
 ]
 
 /** starts a found browser and opens URL if given one */

diff --git a/packages/launcher/lib/detect.ts b/packages/launcher/lib/detect.ts
@@ -83,6 +83,16 @@ function lookup (
  * we don't use the `binary` field on Windows.
  */
 function checkBrowser (browser: Browser): Bluebird<(boolean | FoundBrowser)[]> {
+  if (browser.module) {
+    try {
+      browser.binary = browser.getBinaryPath(require(browser.module))
+    } catch (e) {
+      log('error ', e)
+
+      return Bluebird.resolve([])
+    }
+  }
+
   if (Array.isArray(browser.binary) && os.platform() !== 'win32') {
     return Bluebird.map(browser.binary, (binary: string) => {
       return checkOneBrowser(extend({}, browser, { binary }))

diff --git a/packages/launcher/lib/types.ts b/packages/launcher/lib/types.ts
@@ -3,11 +3,11 @@ import * as Bluebird from 'bluebird'
 
 // TODO: some of these types can be combined with cli/types/index.d.ts
 
-type BrowserName = 'electron' | 'chrome' | 'chromium' | 'firefox' | string
+type BrowserName = 'electron' | 'chrome' | 'chromium' | 'firefox' | 'edge' | 'webkit' | string
 
 type BrowserChannel = 'stable' | 'canary' | 'beta' | 'dev' | 'nightly' | string
 
-type BrowserFamily = 'chromium' | 'firefox'
+type BrowserFamily = 'chromium' | 'firefox' | 'webkit'
 
 export type PlatformName = 'darwin' | 'linux' | 'win32'
 
@@ -31,22 +31,30 @@ export type Browser = {
    * Human-readable browser name.
    */
   displayName: string
-  /** RegExp to use to extract version from something like "Google Chrome 58.0.3029.110" */
-  versionRegex: RegExp
   /** If set, this is the base path that will be used for setting userDataDir. Useful for creating profiles in snap confinement. */
   profilePath?: string
-  /** A single binary name or array of binary names for this browser. Not used on Windows. */
-  binary: string | string[]
+  /** RegExp to use to extract version from something like "Google Chrome 58.0.3029.110" */
+  versionRegex: RegExp
   /** optional warning that will be shown in the GUI */
   warning?: string
   /** optional info that will be shown in the GUI */
   info?: string
+} & (BrowserBinary | BrowserNpm)
+
+type BrowserBinary = {
+  /** A single binary name or array of binary names for this browser. Not used on Windows. */
+  binary: string | string[]
+}
+
+type BrowserNpm = {
+  module: string
+  getBinaryPath: (module: any) => string
 }
 
 /**
  * Represents a real browser that exists on the user's system.
  */
-export type FoundBrowser = Omit<Browser, 'versionRegex' | 'binary'> & {
+export type FoundBrowser = Omit<Browser, keyof BrowserBinary | keyof BrowserNpm> & {
   path: string
   version: string
   majorVersion?: string