🔥 replace browserOverride with customBrowser

🔥 removed the browserOverride option
🔥 removed the debug option
💎 added the customBrowser option

closes #4

Author: bartveneman

readme.md

@@ -41,8 +41,7 @@ the relevant
 
 ```sh
 npm install extract-css-core
-
-# Or with Yarn
+# or
 yarn add extract-css-core
 ```
 
@@ -51,7 +50,7 @@ yarn add extract-css-core
 ```js
 const extractCss = require('extract-css-core')
 
-extractCss('http://www.projectwallace.com').then(css => console.log(css))
+const css = await extractCss('http://www.projectwallace.com')
 ```
 
 ## API
@@ -67,15 +66,6 @@ Type: `Object`
 
 Default: `null`
 
-#### debug
-
-Type: `Boolean`
-
-Default: `false`
-
-Set to `true` if you want a Chromium window to open as it works to get all the
-CSS from the page.
-
 #### waitUntil
 
 Type: `String`
@@ -85,24 +75,21 @@ Default: `networkidle2`
 Can be any value as provided by the
 [Puppeteer docs](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagegotourl-options).
 
-#### browserOverride
+#### customBrowser
 
-Type: `Object`
+Type: `Browser`
 
 Default: `null`
 
-An object consisting of the following fields:
-
-- `executablePath`: the path to a Chromium binary
-- `puppeteer`: a Puppeteer instance
-- `args`: arguments to start Chromium with
-
-See the `test` directory for implementation examples. This option exists
-primarily for use with [extract-css.now.sh](https://extract-css.now.sh)
+A
+[Puppeteer Browser](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-browser)
+instance. See the `test` directory for implementation examples. This option
+exists primarily for use with
+[extract-css](https://github.com/bartveneman/extract-css)
 
 ## Related
 
-- [extract-css lambda](https://github.com/bartveneman/extract-css) - Extract CSS
+- [extract-css](https://github.com/bartveneman/extract-css) - Extract CSS
   running as a serverless function
 - [get-css](https://github.com/cssstats/cssstats/tree/master/packages/get-css) -
   The original get-css

src/index.js

@@ -1,5 +1,4 @@
 const puppeteer = require('puppeteer')
-const {validateBrowserOverride} = require('./validate')
 
 function InvalidUrlError({url, statusCode, statusText}) {
 	this.name = 'InvalidUrlError'
@@ -10,27 +9,19 @@ InvalidUrlError.prototype = Error.prototype
 
 module.exports = async (
 	url,
-	{debug = false, waitUntil = 'networkidle2', browserOverride = null} = {}
+	{waitUntil = 'networkidle2', customBrowser = null} = {}
 ) => {
-	// Basic validation for browserOverride
-	if (browserOverride !== null) {
-		validateBrowserOverride(browserOverride)
-	}
-
-	// Setup the minimal browser options that we need to launch
-	const browserOptions = {
-		headless: debug !== true,
-		executablePath: browserOverride
-			? browserOverride.executablePath
-			: puppeteer.executablePath(),
-		args: browserOverride ? browserOverride.args : []
+	if (
+		customBrowser !== null &&
+		(!customBrowser.isConnected || !customBrowser.isConnected())
+	) {
+		return Promise.reject(
+			new TypeError('The `customBrowser` option is invalid')
+		)
 	}
 
 	// Setup a browser instance
-	const browser = await (
-		(browserOverride && browserOverride.puppeteer) ||
-		puppeteer
-	).launch(browserOptions)
+	const browser = customBrowser || (await puppeteer.launch())
 
 	// Create a new page and navigate to it
 	const page = await browser.newPage()

src/validate.js

@@ -103,6 +103,7 @@ test('it combines server generated <link> and <style> tags with client side crea
 	const actual = await extractCss(server.url + path)
 
 	t.snapshot(actual)
+	t.true(actual.includes('counter-increment: 2;'))
 })
 
 test('it rejects if the url has an HTTP error status', async t => {
@@ -125,13 +126,18 @@ test('it accepts a browser override for usage with other browsers', async t => {
 	server.get(path, (req, res) => {
 		res.send(kitchenSinkExample)
 	})
-	const actual = await extractCss(server.url + path, {
-		browserOverride: {
-			executablePath: chromium.path,
-			puppeteer: puppeteerCore,
-			args: []
-		}
+	const customBrowser = await puppeteerCore.launch({
+		executablePath: chromium.path
 	})
+	const actual = await extractCss(server.url + path, {customBrowser})
 
 	t.snapshot(actual)
+	t.true(actual.includes('counter-increment: 2;'))
+})
+
+test('it rejects on an invalid customBrowser option', async t => {
+	const path = '/browser-override'
+	await t.throwsAsync(extractCss(server.url + path, {customBrowser: {}}), {
+		message: 'The `customBrowser` option is invalid'
+	})
 })