Expose .create method

Author: Kikobeats

src/browserless.js

@@ -0,0 +1,212 @@
+'use strict'
+
+const createTempFile = require('create-temp-file2')
+const extractDomain = require('extract-domain')
+const puppeteer = require('puppeteer')
+const debug = require('debug')('browserless')
+
+const { getDevice } = require('./devices')
+const isTracker = require('./is-tracker')
+
+const WAIT_UNTIL = ['networkidle2', 'load', 'domcontentloaded']
+
+const EVALUATE_TEXT = page => page.evaluate(() => document.body.innerText)
+
+const EVALUATE_HTML = page => page.content()
+
+const isEmpty = val => val == null || !(Object.keys(val) || val).length
+
+const isExternalUrl = (domainOne, domainTwo) => domainOne !== domainTwo
+
+module.exports = launchOpts => {
+  let browser = puppeteer.launch(launchOpts)
+
+  const newPage = () =>
+    Promise.resolve(browser).then(browser => browser.newPage())
+
+  const goto = async (
+    page,
+    {
+      url,
+      abortTrackers,
+      abortTypes,
+      waitFor,
+      waitUntil,
+      userAgent,
+      viewport,
+      args
+    }
+  ) => {
+    await page.setRequestInterception(true)
+    let reqCount = { abort: 0, continue: 0 }
+
+    page.on('request', req => {
+      const resourceUrl = req.url()
+
+      const resourceType = req.resourceType()
+
+      if (abortTypes.includes(resourceType)) {
+        debug(`abort:${resourceType}:${++reqCount.abort}`, resourceUrl)
+        return req.abort()
+      }
+
+      const urlDomain = extractDomain(url)
+      const resourceDomain = extractDomain(resourceUrl)
+      const isExternal = isExternalUrl(urlDomain, resourceDomain)
+
+      if (abortTrackers && isExternal && isTracker(resourceDomain)) {
+        debug(`abort:tracker:${++reqCount.abort}`, resourceUrl)
+        return req.abort()
+      }
+
+      debug(`continue:${resourceType}:${++reqCount.continue}`, resourceUrl)
+      return req.continue()
+    })
+
+    if (userAgent) await page.setUserAgent(userAgent)
+    if (viewport) await page.setViewport(viewport)
+    const response = await page.goto(url, Object.assign({ waitUntil }, args))
+    if (waitFor) await page.waitFor(waitFor)
+    debug(reqCount)
+    return response
+  }
+
+  const evaluate = fn => async (url, opts = {}) => {
+    const {
+      abortTrackers = true,
+      abortTypes = ['image', 'media', 'stylesheet', 'font'],
+      waitFor = 0,
+      waitUntil = WAIT_UNTIL,
+      userAgent,
+      viewport,
+      ...args
+    } = opts
+
+    const page = await newPage()
+    const response = await goto(page, {
+      url,
+      abortTrackers,
+      abortTypes,
+      waitFor,
+      waitUntil,
+      userAgent,
+      viewport,
+      args
+    })
+
+    const content = await fn(page, response)
+    await page.close()
+    return content
+  }
+
+  const screenshot = async (url, opts = {}) => {
+    const {
+      abortTypes = [],
+      device: deviceName = 'macbook pro 13',
+      tmpOpts,
+      type = 'png',
+      userAgent,
+      viewport,
+      waitFor = 0,
+      waitUntil = WAIT_UNTIL,
+      ...args
+    } = opts
+
+    const tempFile = createTempFile(Object.assign({ ext: `.${type}` }, tmpOpts))
+    const { path } = tempFile
+
+    const { userAgent: deviceUserAgent, viewport: deviceViewport } = getDevice(
+      deviceName
+    )
+
+    const page = await newPage()
+
+    await goto(page, {
+      userAgent: isEmpty(userAgent) ? deviceUserAgent : userAgent,
+      viewport: Object.assign({}, deviceViewport, viewport),
+      url,
+      abortTypes,
+      waitFor,
+      waitUntil,
+      args
+    })
+
+    await page.screenshot(Object.assign({ path, type }, args))
+
+    await page.close()
+    return Promise.resolve(tempFile)
+  }
+
+  const pdf = async (url, opts = {}) => {
+    const {
+      abortTrackers = false,
+      abortTypes = [],
+      device: deviceName = 'macbook pro 13',
+      format = 'A4',
+      margin = {
+        top: '0.25cm',
+        right: '0.25cm',
+        bottom: '0.25cm',
+        left: '0.25cm'
+      },
+      media = 'screen',
+      printBackground = true,
+      scale = 0.65,
+      tmpOpts,
+      userAgent,
+      viewport,
+      waitFor = 0,
+      waitUntil = WAIT_UNTIL,
+      ...args
+    } = opts
+
+    const tempFile = createTempFile(Object.assign({ ext: `.pdf` }, tmpOpts))
+    const { path } = tempFile
+
+    const { userAgent: deviceUserAgent, viewport: deviceViewport } = getDevice(
+      deviceName
+    )
+
+    const page = await newPage()
+
+    await page.emulateMedia(media)
+
+    await goto(page, {
+      userAgent: isEmpty(userAgent) ? deviceUserAgent : userAgent,
+      viewport: Object.assign({}, deviceViewport, viewport),
+      url,
+      abortTrackers,
+      abortTypes,
+      waitFor,
+      waitUntil,
+      args
+    })
+
+    await page.pdf(
+      Object.assign(
+        {
+          margin,
+          path,
+          format,
+          printBackground,
+          scale
+        },
+        args
+      )
+    )
+
+    await page.close()
+    return Promise.resolve(tempFile)
+  }
+
+  return {
+    browser,
+    html: evaluate(EVALUATE_HTML),
+    text: evaluate(EVALUATE_TEXT),
+    evaluate,
+    pdf,
+    screenshot,
+    page: newPage,
+    goto
+  }
+}

src/create.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const browserless = require('.')
+
+module.exports = opts =>
+  browserless({
+    ignoreHTTPSErrors: true,
+    args: [
+      '--disable-notifications',
+      '--disable-offer-store-unmasked-wallet-cards',
+      '--disable-offer-upload-credit-cards',
+      '--disable-setuid-sandbox',
+      '--enable-async-dns',
+      '--enable-simple-cache-backend',
+      '--enable-tcp-fast-open',
+      '--media-cache-size=33554432',
+      '--no-default-browser-check',
+      '--no-pings',
+      '--no-sandbox',
+      '--no-zygote',
+      '--prerender-from-omnibox=disabled',
+      '--single-process'
+    ],
+    ...opts
+  })

src/devices/index.js

@@ -8,5 +8,5 @@ const devices = puppeteerDevices.concat(customDevices)
 const getDevice = deviceName =>
   devices.find(device => device.name.toLowerCase() === deviceName.toLowerCase())
 
-module.exports.devices = devices
+module.exports = devices
 module.exports.getDevice = getDevice