feat: split puppeteer/puppeteer-core

Author: pimlie

package.json

@@ -70,6 +70,7 @@
     "browserstack-local": "^1.3.7",
     "chromedriver": "^2.46.0",
     "geckodriver": "^1.16.0",
+    "puppeteer": "^1.13.0",
     "puppeteer-core": "^1.13.0",
     "selenium-webdriver": "^4.0.0-alpha.1"
   }

src/puppeteer/core.js

@@ -0,0 +1,87 @@
+import ChromeDetector from '../utils/detectors/chrome'
+import Browser from '../browser'
+import BrowserError from '../utils/error'
+import Webpage from './webpage'
+
+export default class PuppeteerCoreBrowser extends Browser {
+  async _loadDependencies() {
+    super._loadDependencies()
+
+    if (!PuppeteerCoreBrowser.core) {
+      PuppeteerCoreBrowser.core = await this.loadDependency('puppeteer-core')
+    }
+  }
+
+  setHeadless() {
+    super.setHeadless()
+    this.config.browserArguments.push('--headless')
+  }
+
+  setLogLevel(types) {
+    const typeMap = {
+      warning: 'warn'
+    }
+
+    if (types && typeof types === 'string') {
+      types = [types]
+    }
+
+    this.hook('page:created', (page) => {
+      /* eslint-disable no-console */
+      page.on('console', (msg) => {
+        const msgType = msg.type()
+        let type = typeMap[msgType] || msgType
+        if (!types || types.includes(msgType) || types.includes(type)) {
+          if (!console[type]) {
+            console.warn(`Unknown console type ${type}`)
+            type = 'log'
+          }
+          console[type](msg.text())
+        }
+      })
+      /* eslint-enable no-console */
+    })
+  }
+
+  async _start(capabilities, ...args) {
+    // https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions
+    const launchOptions = {
+      args: [
+        '--no-sandbox',
+        '--disable-setuid-sandbox',
+        ...args,
+        ...this.config.browserArguments
+      ],
+      ...capabilities
+    }
+
+    if (this.constructor.name === 'PuppeteerCoreBrowser') {
+      let executablePath = process.env.PUPPETEER_EXECUTABLE_PATH
+      if (!executablePath) {
+        const detector = new ChromeDetector()
+        executablePath = detector.detect()
+      }
+
+      if (!executablePath) {
+        throw new BrowserError(this, `Could not find a Chrome executable`)
+      }
+
+      launchOptions.executablePath = executablePath
+    }
+
+    this.driver = await PuppeteerCoreBrowser.core.launch(launchOptions)
+  }
+
+  async _close() {
+    if (!this.driver) {
+      return
+    }
+
+    await this.driver.close()
+  }
+
+  _page(url, readyCondition) {
+    const page = new Webpage(this)
+    return page.open(url, readyCondition)
+  }
+}

src/puppeteer/index.js

@@ -1,79 +1,12 @@
-import ChromeDetector from '../utils/detectors/chrome'
-import Browser from '../browser'
-import BrowserError from '../utils/error'
-import Webpage from './webpage'
+import PuppeteerCoreBrowser from './core'
 
-export default class PuppeteerBrowser extends Browser {
+export default class PuppeteerBrowser extends PuppeteerCoreBrowser {
   async _loadDependencies() {
-    super._loadDependencies()
-
-    if (!PuppeteerBrowser.core) {
-      PuppeteerBrowser.core = await this.loadDependency('puppeteer-core')
-    }
-  }
-
-  setLogLevel(types) {
-    const typeMap = {
-      warning: 'warn'
-    }
-
-    if (types && typeof types === 'string') {
-      types = [types]
-    }
-
-    this.hook('page:created', (page) => {
-      /* eslint-disable no-console */
-      page.on('console', (msg) => {
-        const msgType = msg.type()
-        let type = typeMap[msgType] || msgType
-        if (!types || types.includes(msgType) || types.includes(type)) {
-          if (!console[type]) {
-            console.warn(`Unknown console type ${type}`)
-            type = 'log'
-          }
-          console[type](msg.text())
-        }
-      })
-      /* eslint-enable no-console */
-    })
-  }
-
-  async _start(capabilities, ...args) {
-    let executablePath = process.env.PUPPETEER_EXECUTABLE_PATH
-    if (!executablePath) {
-      const detector = new ChromeDetector()
-      executablePath = detector.detect()
+    if (!PuppeteerCoreBrowser.core) {
+      PuppeteerCoreBrowser.core = await this.loadDependency('puppeteer')
     }
 
-    if (!executablePath) {
-      throw new BrowserError(this, `Could not find a chrome executable`)
-    }
-
-    // https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions
-    const launchOptions = {
-      args: [
-        '--no-sandbox',
-        '--disable-setuid-sandbox',
-        '--disable-dev-shm-usage',
-        ...args
-      ],
-      executablePath,
-      ...capabilities
-    }
-
-    this.driver = await PuppeteerBrowser.core.launch(launchOptions)
-  }
-
-  async _close() {
-    if (!this.driver) {
-      return
-    }
-
-    await this.driver.close()
-  }
-
-  _page(url, readyCondition) {
-    const page = new Webpage(this)
-    return page.open(url, readyCondition)
+    // call super after setting core
+    super._loadDependencies()
   }
 }

yarn.lock

@@ -4764,6 +4764,20 @@ puppeteer-core@^1.13.0:
     rimraf "^2.6.1"
     ws "^6.1.0"
 
+puppeteer@^1.13.0:
+  version "1.13.0"
+  resolved "https://registry.yarnpkg.com/puppeteer/-/puppeteer-1.13.0.tgz#187ccf5ed5caf08ed1291b262d033cc364bf88ab"
+  integrity sha512-LUXgvhjfB/P6IOUDAKxOcbCz9ISwBLL9UpKghYrcBDwrOGx1m60y0iN2M64mdAUbT4+7oZM5DTxOW7equa2fxQ==
+  dependencies:
+    debug "^4.1.0"
+    extract-zip "^1.6.6"
+    https-proxy-agent "^2.2.1"
+    mime "^2.0.3"
+    progress "^2.0.1"
+    proxy-from-env "^1.0.0"
+    rimraf "^2.6.1"
+    ws "^6.1.0"
+
 q@^1.5.1:
   version "1.5.1"
   resolved "https://registry.yarnpkg.com/q/-/q-1.5.1.tgz#7e32f75b41381291d04611f1bf14109ac00651d7"