Represent browsers as objects internally

packages/desktop-gui/cypress/fixtures/browsers.json

@@ -1,20 +1,23 @@
 [
   {
     "name": "chrome",
+    "displayName": "Chrome",
     "version": "50.0.2661.86",
     "path": "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
     "majorVersion": "50"
   },
   {
     "name": "chromium",
+    "displayName": "Chromium",
     "version": "49.0.2609.0",
     "path": "/Users/bmann/Downloads/chrome-mac/Chromium.app/Contents/MacOS/Chromium",
     "majorVersion": "49"
   },
   {
     "name": "canary",
+    "displayName": "Canary",
     "version": "48.0",
     "path": "/Users/bmann/Downloads/chrome-mac/Canary.app/Contents/MacOS/Canary",
     "majorVersion": "48"
   }
-]
+]

packages/desktop-gui/cypress/fixtures/config.json

@@ -5,23 +5,26 @@
   "browsers": [
     {
       "name": "chrome",
+      "displayName": "Chrome",
       "version": "50.0.2661.86",
       "path": "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
       "majorVersion": "50"
     },
     {
       "name": "chromium",
+      "displayName": "Chromium",
       "version": "49.0.2609.0",
       "path": "/Users/bmann/Downloads/chrome-mac/Chromium.app/Contents/MacOS/Chromium",
       "majorVersion": "49"
     },
     {
       "name": "canary",
+      "displayName": "Canary",
       "version": "48.0",
       "path": "/Users/bmann/Downloads/chrome-mac/Canary.app/Contents/MacOS/Canary",
       "majorVersion": "48"
     }
-  ],
+  ],  
   "clientRoute": "/__/",
   "clientUrl": "http://localhost:2020/__/",
   "clientUrlDisplay": "http://localhost:2020",

packages/desktop-gui/src/lib/browser-model.js

@@ -1,7 +1,7 @@
-import _ from 'lodash'
 import { computed, observable } from 'mobx'
 
 export default class Browser {
+  @observable displayName
   @observable name
   @observable version
   @observable path
@@ -10,17 +10,14 @@ export default class Browser {
   @observable isChosen = false
 
   constructor (browser) {
+    this.displayName = browser.displayName
     this.name = browser.name
     this.version = browser.version
     this.path = browser.path
     this.majorVersion = browser.majorVersion
     this.info = browser.info
   }
 
-  @computed get displayName () {
-    return _.capitalize(this.name)
-  }
-
   @computed get icon () {
     return 'chrome'
   }

packages/launcher/__snapshots__/browsers_spec.ts.js

@@ -0,0 +1,33 @@
+exports['browsers returns the expected list of browsers 1'] = [
+  {
+    "name": "chrome",
+    "family": "chrome",
+    "displayName": "Chrome",
+    "versionRegex": {},
+    "profile": true,
+    "binary": [
+      "google-chrome",
+      "chrome",
+      "google-chrome-stable"
+    ]
+  },
+  {
+    "name": "chromium",
+    "family": "chrome",
+    "displayName": "Chromium",
+    "versionRegex": {},
+    "profile": true,
+    "binary": [
+      "chromium-browser",
+      "chromium"
+    ]
+  },
+  {
+    "name": "canary",
+    "family": "chrome",
+    "displayName": "Canary",
+    "versionRegex": {},
+    "profile": true,
+    "binary": "google-chrome-canary"
+  }
+]

packages/launcher/lib/browsers.ts

@@ -1,68 +1,51 @@
 import { log } from './log'
-import { find, map } from 'lodash'
 import * as cp from 'child_process'
-import { Browser, FoundBrowser, BrowserNotFoundError } from './types'
-
-const browserNotFoundErr = (
-  browsers: FoundBrowser[],
-  name: string
-): BrowserNotFoundError => {
-  const available = map(browsers, 'name').join(', ')
-
-  const err: BrowserNotFoundError = new Error(
-    `Browser: '${name}' not found. Available browsers are: [${available}]`
-  ) as BrowserNotFoundError
-  err.specificBrowserNotFound = true
-  return err
-}
+import { Browser, FoundBrowser } from './types'
 
 /** list of the browsers we can detect and use by default */
 export const browsers: Browser[] = [
   {
     name: 'chrome',
+    family: 'chrome',
     displayName: 'Chrome',
     versionRegex: /Google Chrome (\S+)/,
     profile: true,
-    binary: 'google-chrome'
+    binary: ['google-chrome', 'chrome', 'google-chrome-stable']
   },
   {
     name: 'chromium',
+    family: 'chrome',
     displayName: 'Chromium',
     versionRegex: /Chromium (\S+)/,
     profile: true,
-    binary: 'chromium-browser'
+    binary: ['chromium-browser', 'chromium']
   },
   {
     name: 'canary',
+    family: 'chrome',
     displayName: 'Canary',
     versionRegex: /Google Chrome Canary (\S+)/,
     profile: true,
     binary: 'google-chrome-canary'
   }
 ]
 
-/** starts a browser by name and opens URL if given one */
+/** starts a found browser and opens URL if given one */
 export function launch(
-  browsers: FoundBrowser[],
-  name: string,
+  browser: FoundBrowser,
   url?: string,
   args: string[] = []
 ) {
-  log('launching browser %s to open %s', name, url)
-  const browser = find(browsers, { name })
-
-  if (!browser) {
-    throw browserNotFoundErr(browsers, name)
-  }
+  log('launching browser %o to open %s', browser, url)
 
   if (!browser.path) {
-    throw new Error(`Found browser ${name} is missing path`)
+    throw new Error(`Browser ${browser.name} is missing path`)
   }
 
   if (url) {
     args = [url].concat(args)
   }
 
-  log('spawning browser %s with args %s', browser.path, args.join(' '))
+  log('spawning browser %o with args %s', browser, args.join(' '))
   return cp.spawn(browser.path, args, { stdio: 'ignore' })
 }

packages/launcher/lib/darwin/index.ts

@@ -1,5 +1,5 @@
 import { findApp } from './util'
-import { Browser } from '../types'
+import { FoundBrowser, Browser } from '../types'
 import { detectBrowserLinux } from '../linux'
 import { log } from '../log'
 import { merge, partial } from 'ramda'
@@ -30,7 +30,7 @@ const browsers: Detectors = {
   chromium: detectChromium
 }
 
-export function detectBrowserDarwin(browser: Browser) {
+export function detectBrowserDarwin(browser: Browser): Promise<FoundBrowser> {
   let fn = browsers[browser.name]
 
   if (!fn) {

packages/launcher/lib/detect.ts

@@ -1,28 +1,28 @@
 import * as Bluebird from 'bluebird'
-import * as _ from 'lodash'
+import { extend, compact } from 'lodash'
 import * as os from 'os'
-import { merge, pick, props, tap, uniqBy } from 'ramda'
+import { merge, pick, props, tap, uniqBy, flatten } from 'ramda'
 import { browsers } from './browsers'
 import { detectBrowserDarwin } from './darwin'
 import { detectBrowserLinux } from './linux'
 import { log } from './log'
-import { Browser, NotInstalledError } from './types'
+import { FoundBrowser, Browser, NotInstalledError } from './types'
 import { detectBrowserWindows } from './windows'
 
-const setMajorVersion = (obj: Browser) => {
-  if (obj.version) {
-    obj.majorVersion = obj.version.split('.')[0]
+const setMajorVersion = (browser: FoundBrowser) => {
+  if (browser.version) {
+    browser.majorVersion = browser.version.split('.')[0]
     log(
       'browser %s version %s major version %s',
-      obj.name,
-      obj.version,
-      obj.majorVersion
+      browser.name,
+      browser.version,
+      browser.majorVersion
     )
   }
-  return obj
+  return browser
 }
 
-type BrowserDetector = (browser: Browser) => Promise<Object>
+type BrowserDetector = (browser: Browser) => Promise<FoundBrowser>
 type Detectors = {
   [index: string]: BrowserDetector
 }
@@ -32,19 +32,37 @@ const detectors: Detectors = {
   win32: detectBrowserWindows
 }
 
-function lookup(platform: NodeJS.Platform, obj: Browser): Promise<Object> {
-  log('looking up %s on %s platform', obj.name, platform)
+function lookup(
+  platform: NodeJS.Platform,
+  browser: Browser
+): Promise<FoundBrowser> {
+  log('looking up %s on %s platform', browser.name, platform)
   const detector = detectors[platform]
   if (!detector) {
-    throw new Error(`Cannot lookup browser ${obj.name} on ${platform}`)
+    throw new Error(`Cannot lookup browser ${browser.name} on ${platform}`)
   }
-  return detector(obj)
+  return detector(browser)
 }
 
-function checkOneBrowser(browser: Browser) {
+/**
+ * Try to detect a single browser definition, which may dispatch multiple `checkOneBrowser` calls,
+ * one for each binary. If Windows is detected, only one `checkOneBrowser` will be called, because
+ * we don't use the `binary` field on Windows.
+ */
+function checkBrowser(browser: Browser): Promise<(boolean | FoundBrowser)[]> {
+  if (Array.isArray(browser.binary) && os.platform() !== 'win32') {
+    return Bluebird.map(browser.binary, (binary: string) => {
+      return checkOneBrowser(extend({}, browser, { binary }))
+    })
+  }
+  return Bluebird.map([browser], checkOneBrowser)
+}
+
+function checkOneBrowser(browser: Browser): Promise<boolean | FoundBrowser> {
   const platform = os.platform()
   const pickBrowserProps = pick([
     'name',
+    'family',
     'displayName',
     'type',
     'version',
@@ -73,22 +91,20 @@ function checkOneBrowser(browser: Browser) {
 }
 
 /** returns list of detected browsers */
-function detectBrowsers(goalBrowsers?: Browser[]): Bluebird<Browser[]> {
+export const detect = (goalBrowsers?: Browser[]): Bluebird<FoundBrowser[]> => {
   // we can detect same browser under different aliases
   // tell them apart by the name and the version property
-  // @ts-ignore
   if (!goalBrowsers) {
     goalBrowsers = browsers
   }
 
-  // for some reason the type system does not understand that after _.compact
-  // the remaining list only contains valid Browser objects
-  // and we can pick "name" and "version" fields from each object
-  // @ts-ignore
-  const removeDuplicates = uniqBy(props(['name', 'version']))
-  return Bluebird.mapSeries(goalBrowsers, checkOneBrowser)
-    .then(_.compact)
-    .then(removeDuplicates) as Bluebird<Browser[]>
-}
+  const removeDuplicates = uniqBy((browser: FoundBrowser) =>
+    props(['name', 'version'], browser)
+  )
+  const compactFalse = (browsers: any[]) => compact(browsers) as FoundBrowser[]
 
-export default detectBrowsers
+  return Bluebird.mapSeries(goalBrowsers, checkBrowser)
+    .then(flatten)
+    .then(compactFalse)
+    .then(removeDuplicates)
+}

packages/launcher/lib/launcher.ts

@@ -1,36 +1,7 @@
-import { writeJson } from 'fs-extra'
 import { launch } from './browsers'
-import detect from './detect'
-import { Browser, LauncherApi } from './types'
+import { detect } from './detect'
 
-const Promise = require('bluebird')
-
-const missingConfig = () =>
-  Promise.reject(new Error('You must provide a path to a config file.'))
-
-const wrap = (all: Browser[]) => ({
-  launch: (name: string, url: string, args = []) => launch(all, name, url, args)
-})
-
-const init = (browsers: Browser[]) =>
-  browsers ? wrap(browsers) : detect().then(wrap)
-
-const api: LauncherApi = (init as any) as LauncherApi
-
-const update = (pathToConfig?: string) => {
-  if (!pathToConfig) {
-    return missingConfig()
-  }
-
-  // detect the browsers and set the config
-  const saveBrowsers = (browers: Browser[]) =>
-    writeJson(pathToConfig, browers, { spaces: 2 })
-
-  return detect().then(saveBrowsers)
+module.exports = {
+  detect,
+  launch
 }
-
-// extend "api" with a few utility methods for convenience
-api.update = update
-api.detect = detect
-
-module.exports = api